Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
feat: add comprehensive documentation to proto files (#17694)
Danny Xubc3b418572bf
diff --git a/backend/generated-go/v1/actuator_service.pb.go b/backend/generated-go/v1/actuator_service.pb.goindex c1546617f2..0dbd47104e 100644--- a/backend/generated-go/v1/actuator_service.pb.go+++ b/backend/generated-go/v1/actuator_service.pb.go@@ -25,7 +25,7 @@ const (_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20))-// The request message for getting the theme resource.+// Request message for getting branding resources.type GetResourcePackageRequest struct {state protoimpl.MessageState `protogen:"open.v1"`unknownFields protoimpl.UnknownFields@@ -62,7 +62,7 @@ func (*GetResourcePackageRequest) Descriptor() ([]byte, []int) {return file_v1_actuator_service_proto_rawDescGZIP(), []int{0}}-// The theme resources.+// Custom branding resources for the Bytebase instance.type ResourcePackage struct {state protoimpl.MessageState `protogen:"open.v1"`// The branding logo.@@ -108,6 +108,7 @@ func (x *ResourcePackage) GetLogo() []byte {return nil}+// Request message for setting up sample data.type SetupSampleRequest struct {state protoimpl.MessageState `protogen:"open.v1"`unknownFields protoimpl.UnknownFields@@ -144,6 +145,7 @@ func (*SetupSampleRequest) Descriptor() ([]byte, []int) {return file_v1_actuator_service_proto_rawDescGZIP(), []int{2}}+// Request message for getting actuator information.type GetActuatorInfoRequest struct {state protoimpl.MessageState `protogen:"open.v1"`unknownFields protoimpl.UnknownFields@@ -180,6 +182,7 @@ func (*GetActuatorInfoRequest) Descriptor() ([]byte, []int) {return file_v1_actuator_service_proto_rawDescGZIP(), []int{3}}+// Request message for updating actuator information.type UpdateActuatorInfoRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The actuator to update.@@ -244,6 +247,7 @@ func (x *UpdateActuatorInfoRequest) GetAllowMissing() bool {return false}+// Request message for deleting cache.type DeleteCacheRequest struct {state protoimpl.MessageState `protogen:"open.v1"`unknownFields protoimpl.UnknownFields@@ -280,50 +284,56 @@ func (*DeleteCacheRequest) Descriptor() ([]byte, []int) {return file_v1_actuator_service_proto_rawDescGZIP(), []int{5}}-// ServerInfo is the API message for server info.+// System information and configuration for the Bytebase instance.// Actuator concept is similar to the Spring Boot Actuator.type ActuatorInfo struct {state protoimpl.MessageState `protogen:"open.v1"`- // version is the bytebase's server version+ // The Bytebase server version.Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`- // git_commit is the git commit hash of the build+ // The git commit hash of the build.GitCommit string `protobuf:"bytes,2,opt,name=git_commit,json=gitCommit,proto3" json:"git_commit,omitempty"`- // readonly flag means if the Bytebase is running in readonly mode.+ // Whether the Bytebase instance is running in read-only mode.Readonly bool `protobuf:"varint,3,opt,name=readonly,proto3" json:"readonly,omitempty"`- // saas flag means if the Bytebase is running in SaaS mode, some features are not allowed to edit by users.+ // Whether the Bytebase instance is running in SaaS mode where some features cannot be edited by users.Saas bool `protobuf:"varint,4,opt,name=saas,proto3" json:"saas,omitempty"`- // demo flag means if the Bytebase is running in demo mode.+ // Whether the Bytebase instance is running in demo mode.Demo bool `protobuf:"varint,5,opt,name=demo,proto3" json:"demo,omitempty"`- // host is the Bytebase instance host.+ // The host address of the Bytebase instance.Host string `protobuf:"bytes,6,opt,name=host,proto3" json:"host,omitempty"`- // port is the Bytebase instance port.+ // The port number of the Bytebase instance.Port string `protobuf:"bytes,7,opt,name=port,proto3" json:"port,omitempty"`- // external_url is the URL where user or webhook callback visits Bytebase.+ // The external URL where users or webhook callbacks access Bytebase.ExternalUrl string `protobuf:"bytes,8,opt,name=external_url,json=externalUrl,proto3" json:"external_url,omitempty"`- // need_admin_setup flag means the Bytebase instance doesn't have any end users.+ // Whether the Bytebase instance requires initial admin setup.NeedAdminSetup bool `protobuf:"varint,9,opt,name=need_admin_setup,json=needAdminSetup,proto3" json:"need_admin_setup,omitempty"`- // disallow_signup is the flag to disable self-service signup.+ // Whether self-service user signup is disabled.DisallowSignup bool `protobuf:"varint,10,opt,name=disallow_signup,json=disallowSignup,proto3" json:"disallow_signup,omitempty"`- // last_active_time is the service last active time in UTC Time Format, any API calls will refresh this value.+ // The last time any API call was made, refreshed on each request.LastActiveTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=last_active_time,json=lastActiveTime,proto3" json:"last_active_time,omitempty"`- // require_2fa is the flag to require 2FA for all users.+ // Whether two-factor authentication is required for all users.Require_2Fa bool `protobuf:"varint,12,opt,name=require_2fa,json=require2fa,proto3" json:"require_2fa,omitempty"`- // workspace_id is the identifier for the workspace.+ // The unique identifier for the workspace.WorkspaceId string `protobuf:"bytes,13,opt,name=workspace_id,json=workspaceId,proto3" json:"workspace_id,omitempty"`- // debug flag means if the debug mode is enabled.- Debug bool `protobuf:"varint,15,opt,name=debug,proto3" json:"debug,omitempty"`+ // Whether debug mode is enabled.+ Debug bool `protobuf:"varint,15,opt,name=debug,proto3" json:"debug,omitempty"`+ // List of features that are not licensed.UnlicensedFeatures []string `protobuf:"bytes,19,rep,name=unlicensed_features,json=unlicensedFeatures,proto3" json:"unlicensed_features,omitempty"`- // disallow_password_signin is the flag to disallow user signin with email&password. (except workspace admins)- DisallowPasswordSignin bool `protobuf:"varint,20,opt,name=disallow_password_signin,json=disallowPasswordSignin,proto3" json:"disallow_password_signin,omitempty"`- PasswordRestriction *PasswordRestrictionSetting `protobuf:"bytes,21,opt,name=password_restriction,json=passwordRestriction,proto3" json:"password_restriction,omitempty"`- // docker flag means if the Bytebase instance is running in docker.- Docker bool `protobuf:"varint,22,opt,name=docker,proto3" json:"docker,omitempty"`- UserStats []*ActuatorInfo_StatUser `protobuf:"bytes,23,rep,name=user_stats,json=userStats,proto3" json:"user_stats,omitempty"`- ActivatedInstanceCount int32 `protobuf:"varint,24,opt,name=activated_instance_count,json=activatedInstanceCount,proto3" json:"activated_instance_count,omitempty"`- TotalInstanceCount int32 `protobuf:"varint,25,opt,name=total_instance_count,json=totalInstanceCount,proto3" json:"total_instance_count,omitempty"`- EnableSample bool `protobuf:"varint,26,opt,name=enable_sample,json=enableSample,proto3" json:"enable_sample,omitempty"`- unknownFields protoimpl.UnknownFields- sizeCache protoimpl.SizeCache+ // Whether password-based signin is disabled (except for workspace admins).+ DisallowPasswordSignin bool `protobuf:"varint,20,opt,name=disallow_password_signin,json=disallowPasswordSignin,proto3" json:"disallow_password_signin,omitempty"`+ // Password complexity and restriction requirements.+ PasswordRestriction *PasswordRestrictionSetting `protobuf:"bytes,21,opt,name=password_restriction,json=passwordRestriction,proto3" json:"password_restriction,omitempty"`+ // Whether the Bytebase instance is running in Docker.+ Docker bool `protobuf:"varint,22,opt,name=docker,proto3" json:"docker,omitempty"`+ // Statistics about users in the system.+ UserStats []*ActuatorInfo_StatUser `protobuf:"bytes,23,rep,name=user_stats,json=userStats,proto3" json:"user_stats,omitempty"`+ // The number of activated database instances.+ ActivatedInstanceCount int32 `protobuf:"varint,24,opt,name=activated_instance_count,json=activatedInstanceCount,proto3" json:"activated_instance_count,omitempty"`+ // The total number of database instances.+ TotalInstanceCount int32 `protobuf:"varint,25,opt,name=total_instance_count,json=totalInstanceCount,proto3" json:"total_instance_count,omitempty"`+ // Whether sample data setup is enabled.+ EnableSample bool `protobuf:"varint,26,opt,name=enable_sample,json=enableSample,proto3" json:"enable_sample,omitempty"`+ unknownFields protoimpl.UnknownFields+ sizeCache protoimpl.SizeCache}func (x *ActuatorInfo) Reset() {@@ -510,11 +520,15 @@ func (x *ActuatorInfo) GetEnableSample() bool {return false}+// User statistics by type and state.type ActuatorInfo_StatUser struct {- state protoimpl.MessageState `protogen:"open.v1"`- UserType UserType `protobuf:"varint,1,opt,name=user_type,json=userType,proto3,enum=bytebase.v1.UserType" json:"user_type,omitempty"`- State State `protobuf:"varint,2,opt,name=state,proto3,enum=bytebase.v1.State" json:"state,omitempty"`- Count int32 `protobuf:"varint,3,opt,name=count,proto3" json:"count,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The type of user.+ UserType UserType `protobuf:"varint,1,opt,name=user_type,json=userType,proto3,enum=bytebase.v1.UserType" json:"user_type,omitempty"`+ // The state of the user.+ State State `protobuf:"varint,2,opt,name=state,proto3,enum=bytebase.v1.State" json:"state,omitempty"`+ // The count of users matching this type and state.+ Count int32 `protobuf:"varint,3,opt,name=count,proto3" json:"count,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}diff --git a/backend/generated-go/v1/actuator_service_grpc.pb.go b/backend/generated-go/v1/actuator_service_grpc.pb.goindex 3ed4697310..2fca5e9707 100644--- a/backend/generated-go/v1/actuator_service_grpc.pb.go+++ b/backend/generated-go/v1/actuator_service_grpc.pb.go@@ -30,15 +30,22 @@ const (// ActuatorServiceClient is the client API for ActuatorService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// ActuatorService manages system health and operational information.type ActuatorServiceClient interface {+ // Gets system information and health status of the Bytebase instance.// Permissions required: NoneGetActuatorInfo(ctx context.Context, in *GetActuatorInfoRequest, opts ...grpc.CallOption) (*ActuatorInfo, error)+ // Updates system configuration settings for the Bytebase instance.// Permissions required: bb.settings.setUpdateActuatorInfo(ctx context.Context, in *UpdateActuatorInfoRequest, opts ...grpc.CallOption) (*ActuatorInfo, error)+ // Sets up sample data for demonstration and testing purposes.// Permissions required: bb.projects.createSetupSample(ctx context.Context, in *SetupSampleRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)+ // Clears the system cache to force data refresh.// Permissions required: NoneDeleteCache(ctx context.Context, in *DeleteCacheRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)+ // Gets custom branding resources such as logos.// Permissions required: NoneGetResourcePackage(ctx context.Context, in *GetResourcePackageRequest, opts ...grpc.CallOption) (*ResourcePackage, error)}@@ -104,15 +111,22 @@ func (c *actuatorServiceClient) GetResourcePackage(ctx context.Context, in *GetR// ActuatorServiceServer is the server API for ActuatorService service.// All implementations must embed UnimplementedActuatorServiceServer// for forward compatibility.+//+// ActuatorService manages system health and operational information.type ActuatorServiceServer interface {+ // Gets system information and health status of the Bytebase instance.// Permissions required: NoneGetActuatorInfo(context.Context, *GetActuatorInfoRequest) (*ActuatorInfo, error)+ // Updates system configuration settings for the Bytebase instance.// Permissions required: bb.settings.setUpdateActuatorInfo(context.Context, *UpdateActuatorInfoRequest) (*ActuatorInfo, error)+ // Sets up sample data for demonstration and testing purposes.// Permissions required: bb.projects.createSetupSample(context.Context, *SetupSampleRequest) (*emptypb.Empty, error)+ // Clears the system cache to force data refresh.// Permissions required: NoneDeleteCache(context.Context, *DeleteCacheRequest) (*emptypb.Empty, error)+ // Gets custom branding resources such as logos.// Permissions required: NoneGetResourcePackage(context.Context, *GetResourcePackageRequest) (*ResourcePackage, error)mustEmbedUnimplementedActuatorServiceServer()diff --git a/backend/generated-go/v1/annotation.pb.go b/backend/generated-go/v1/annotation.pb.goindex c6db0aa9c4..fd23086be5 100644--- a/backend/generated-go/v1/annotation.pb.go+++ b/backend/generated-go/v1/annotation.pb.go@@ -22,13 +22,15 @@ const (_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20))+// Authorization method for RPC calls.type AuthMethod int32const (+ // Unspecified authorization method.AuthMethod_AUTH_METHOD_UNSPECIFIED AuthMethod = 0- // IAM uses the standard IAM authorization check on the organizational resources.+ // Standard IAM authorization check on organizational resources.AuthMethod_IAM AuthMethod = 1- // Custom authorization method.+ // Custom authorization logic.AuthMethod_CUSTOM AuthMethod = 2)@@ -110,12 +112,20 @@ var file_v1_annotation_proto_extTypes = []protoimpl.ExtensionInfo{// Extension fields to descriptorpb.MethodOptions.var (+ // Whether the method allows access without authentication credentials.+ //// optional bool allow_without_credential = 100000;E_AllowWithoutCredential = &file_v1_annotation_proto_extTypes[0]+ // The permission required to call this method.+ //// optional string permission = 100001;E_Permission = &file_v1_annotation_proto_extTypes[1]+ // The authorization method to use for this RPC.+ //// optional bytebase.v1.AuthMethod auth_method = 100002;E_AuthMethod = &file_v1_annotation_proto_extTypes[2]+ // Whether to audit calls to this method.+ //// optional bool audit = 100003;E_Audit = &file_v1_annotation_proto_extTypes[3])diff --git a/backend/generated-go/v1/audit_log_service.pb.go b/backend/generated-go/v1/audit_log_service.pb.goindex df2a1f07a2..b42373abac 100644--- a/backend/generated-go/v1/audit_log_service.pb.go+++ b/backend/generated-go/v1/audit_log_service.pb.go@@ -26,17 +26,27 @@ const (_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20))+// Severity level for audit log entries.type AuditLog_Severity int32const (- AuditLog_DEFAULT AuditLog_Severity = 0- AuditLog_DEBUG AuditLog_Severity = 1- AuditLog_INFO AuditLog_Severity = 2- AuditLog_NOTICE AuditLog_Severity = 3- AuditLog_WARNING AuditLog_Severity = 4- AuditLog_ERROR AuditLog_Severity = 5- AuditLog_CRITICAL AuditLog_Severity = 6- AuditLog_ALERT AuditLog_Severity = 7+ // Default severity level.+ AuditLog_DEFAULT AuditLog_Severity = 0+ // Debug-level information.+ AuditLog_DEBUG AuditLog_Severity = 1+ // Informational messages.+ AuditLog_INFO AuditLog_Severity = 2+ // Notable events.+ AuditLog_NOTICE AuditLog_Severity = 3+ // Warning conditions.+ AuditLog_WARNING AuditLog_Severity = 4+ // Error conditions.+ AuditLog_ERROR AuditLog_Severity = 5+ // Critical conditions.+ AuditLog_CRITICAL AuditLog_Severity = 6+ // Action must be taken immediately.+ AuditLog_ALERT AuditLog_Severity = 7+ // System is unusable.AuditLog_EMERGENCY AuditLog_Severity = 8)@@ -93,6 +103,7 @@ func (AuditLog_Severity) EnumDescriptor() ([]byte, []int) {return file_v1_audit_log_service_proto_rawDescGZIP(), []int{4, 0}}+// Request message for searching audit logs.type SearchAuditLogsRequest struct {state protoimpl.MessageState `protogen:"open.v1"`Parent string `protobuf:"bytes,5,opt,name=parent,proto3" json:"parent,omitempty"`@@ -194,6 +205,7 @@ func (x *SearchAuditLogsRequest) GetPageToken() string {return ""}+// Response message for searching audit logs.type SearchAuditLogsResponse struct {state protoimpl.MessageState `protogen:"open.v1"`AuditLogs []*AuditLog `protobuf:"bytes,1,rep,name=audit_logs,json=auditLogs,proto3" json:"audit_logs,omitempty"`@@ -249,6 +261,7 @@ func (x *SearchAuditLogsResponse) GetNextPageToken() string {return ""}+// Request message for exporting audit logs.type ExportAuditLogsRequest struct {state protoimpl.MessageState `protogen:"open.v1"`Parent string `protobuf:"bytes,4,opt,name=parent,proto3" json:"parent,omitempty"`@@ -347,9 +360,11 @@ func (x *ExportAuditLogsRequest) GetPageToken() string {return ""}+// Response message for exporting audit logs.type ExportAuditLogsResponse struct {- state protoimpl.MessageState `protogen:"open.v1"`- Content []byte `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The exported audit log content in the requested format.+ Content []byte `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`// A token to retrieve next page of log entities.// Pass this value in the page_token field in the subsequent call// to retrieve the next page of log entities.@@ -402,32 +417,38 @@ func (x *ExportAuditLogsResponse) GetNextPageToken() string {return ""}+// Audit log entry recording system activity or API call.type AuditLog struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the log.// Formats:// - projects/{project}/auditLogs/{uid}// - workspaces/{workspace}/auditLogs/{uid}- 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 timestamp when the audit log was created.CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`- // Format: users/[email protected]+ // The user who performed the action.+ // Format: users/{email}User string `protobuf:"bytes,3,opt,name=user,proto3" json:"user,omitempty"`- // e.g. `/bytebase.v1.SQLService/Query`, `bb.project.repository.push`- Method string `protobuf:"bytes,4,opt,name=method,proto3" json:"method,omitempty"`+ // The method or action being audited.+ // For example: /bytebase.v1.SQLService/Query or bb.project.repository.push+ Method string `protobuf:"bytes,4,opt,name=method,proto3" json:"method,omitempty"`+ // The severity level of this audit log entry.Severity AuditLog_Severity `protobuf:"varint,5,opt,name=severity,proto3,enum=bytebase.v1.AuditLog_Severity" json:"severity,omitempty"`- // The associated resource.+ // The resource associated with this audit log.Resource string `protobuf:"bytes,6,opt,name=resource,proto3" json:"resource,omitempty"`- // JSON-encoded request.+ // The request payload in JSON format.Request string `protobuf:"bytes,7,opt,name=request,proto3" json:"request,omitempty"`- // JSON-encoded response.- // Some fields are omitted because they are too large or contain sensitive information.- Response string `protobuf:"bytes,8,opt,name=response,proto3" json:"response,omitempty"`- Status *status.Status `protobuf:"bytes,9,opt,name=status,proto3" json:"status,omitempty"`- // The latency of the RPC.+ // The response payload in JSON format.+ // Some fields may be omitted if they are too large or contain sensitive information.+ Response string `protobuf:"bytes,8,opt,name=response,proto3" json:"response,omitempty"`+ // The status of the operation.+ Status *status.Status `protobuf:"bytes,9,opt,name=status,proto3" json:"status,omitempty"`+ // The duration of the operation.Latency *durationpb.Duration `protobuf:"bytes,10,opt,name=latency,proto3" json:"latency,omitempty"`- // service-specific data about the request, response, and other activities.+ // Service-specific metadata about the request, response, and activities.ServiceData *anypb.Any `protobuf:"bytes,11,opt,name=service_data,json=serviceData,proto3" json:"service_data,omitempty"`- // Metadata about the operation.+ // Metadata about the request context.RequestMetadata *RequestMetadata `protobuf:"bytes,12,opt,name=request_metadata,json=requestMetadata,proto3" json:"request_metadata,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -547,9 +568,11 @@ func (x *AuditLog) GetRequestMetadata() *RequestMetadata {return nil}+// Additional audit data specific to certain operations.type AuditData struct {- state protoimpl.MessageState `protogen:"open.v1"`- PolicyDelta *PolicyDelta `protobuf:"bytes,1,opt,name=policy_delta,json=policyDelta,proto3" json:"policy_delta,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // Changes to IAM policies.+ PolicyDelta *PolicyDelta `protobuf:"bytes,1,opt,name=policy_delta,json=policyDelta,proto3" json:"policy_delta,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -591,13 +614,13 @@ func (x *AuditData) GetPolicyDelta() *PolicyDelta {return nil}-// Metadata about the request.+// Metadata about the incoming request.type RequestMetadata struct {state protoimpl.MessageState `protogen:"open.v1"`- // The IP address of the caller.+ // The IP address of the request originator.CallerIp string `protobuf:"bytes,1,opt,name=caller_ip,json=callerIp,proto3" json:"caller_ip,omitempty"`- // The user agent of the caller.- // This information is not authenticated and should be treated accordingly.+ // The user agent string provided by the caller.+ // This is supplied by the client and is not authenticated.CallerSuppliedUserAgent string `protobuf:"bytes,2,opt,name=caller_supplied_user_agent,json=callerSuppliedUserAgent,proto3" json:"caller_supplied_user_agent,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCachediff --git a/backend/generated-go/v1/audit_log_service_grpc.pb.go b/backend/generated-go/v1/audit_log_service_grpc.pb.goindex 4266b7589e..b610d5e1f7 100644--- a/backend/generated-go/v1/audit_log_service_grpc.pb.go+++ b/backend/generated-go/v1/audit_log_service_grpc.pb.go@@ -26,9 +26,13 @@ const (// AuditLogServiceClient is the client API for AuditLogService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// AuditLogService manages audit logs for system activities and API calls.type AuditLogServiceClient interface {- // Permissions required: None+ // Searches audit logs with optional filtering and pagination.+ // Permissions required: bb.auditLogs.searchSearchAuditLogs(ctx context.Context, in *SearchAuditLogsRequest, opts ...grpc.CallOption) (*SearchAuditLogsResponse, error)+ // Exports audit logs in a specified format for external analysis.// Permissions required: bb.auditLogs.exportExportAuditLogs(ctx context.Context, in *ExportAuditLogsRequest, opts ...grpc.CallOption) (*ExportAuditLogsResponse, error)}@@ -64,9 +68,13 @@ func (c *auditLogServiceClient) ExportAuditLogs(ctx context.Context, in *ExportA// AuditLogServiceServer is the server API for AuditLogService service.// All implementations must embed UnimplementedAuditLogServiceServer// for forward compatibility.+//+// AuditLogService manages audit logs for system activities and API calls.type AuditLogServiceServer interface {- // Permissions required: None+ // Searches audit logs with optional filtering and pagination.+ // Permissions required: bb.auditLogs.searchSearchAuditLogs(context.Context, *SearchAuditLogsRequest) (*SearchAuditLogsResponse, error)+ // Exports audit logs in a specified format for external analysis.// Permissions required: bb.auditLogs.exportExportAuditLogs(context.Context, *ExportAuditLogsRequest) (*ExportAuditLogsResponse, error)mustEmbedUnimplementedAuditLogServiceServer()diff --git a/backend/generated-go/v1/auth_service.pb.go b/backend/generated-go/v1/auth_service.pb.goindex 3c670bb76f..84f98c14b8 100644--- a/backend/generated-go/v1/auth_service.pb.go+++ b/backend/generated-go/v1/auth_service.pb.go@@ -24,9 +24,11 @@ const ()type LoginRequest struct {- state protoimpl.MessageState `protogen:"open.v1"`- Email string `protobuf:"bytes,1,opt,name=email,proto3" json:"email,omitempty"`- Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // User's email address.+ Email string `protobuf:"bytes,1,opt,name=email,proto3" json:"email,omitempty"`+ // User's password for authentication.+ Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`// If web is set, we will set access token, refresh token, and user to the cookie.Web bool `protobuf:"varint,3,opt,name=web,proto3" json:"web,omitempty"`// The name of the identity provider.@@ -130,6 +132,7 @@ func (x *LoginRequest) GetMfaTempToken() string {return ""}+// Context for identity provider authentication.type IdentityProviderContext struct {state protoimpl.MessageState `protogen:"open.v1"`// Types that are valid to be assigned to Context:@@ -201,10 +204,12 @@ type isIdentityProviderContext_Context interface {}type IdentityProviderContext_Oauth2Context struct {+ // OAuth2 authentication context.Oauth2Context *OAuth2IdentityProviderContext `protobuf:"bytes,1,opt,name=oauth2_context,json=oauth2Context,proto3,oneof"`}type IdentityProviderContext_OidcContext struct {+ // OpenID Connect authentication context.OidcContext *OIDCIdentityProviderContext `protobuf:"bytes,2,opt,name=oidc_context,json=oidcContext,proto3,oneof"`}@@ -212,9 +217,11 @@ func (*IdentityProviderContext_Oauth2Context) isIdentityProviderContext_Context(func (*IdentityProviderContext_OidcContext) isIdentityProviderContext_Context() {}+// OAuth2 authentication context.type OAuth2IdentityProviderContext struct {- state protoimpl.MessageState `protogen:"open.v1"`- Code string `protobuf:"bytes,1,opt,name=code,proto3" json:"code,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // Authorization code from OAuth2 provider.+ Code string `protobuf:"bytes,1,opt,name=code,proto3" json:"code,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -256,6 +263,7 @@ func (x *OAuth2IdentityProviderContext) GetCode() string {return ""}+// OpenID Connect authentication context.type OIDCIdentityProviderContext struct {state protoimpl.MessageState `protogen:"open.v1"`unknownFields protoimpl.UnknownFields@@ -293,10 +301,13 @@ func (*OIDCIdentityProviderContext) Descriptor() ([]byte, []int) {}type LoginResponse struct {- state protoimpl.MessageState `protogen:"open.v1"`- Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"`- MfaTempToken *string `protobuf:"bytes,2,opt,name=mfa_temp_token,json=mfaTempToken,proto3,oneof" json:"mfa_temp_token,omitempty"`- RequireResetPassword bool `protobuf:"varint,3,opt,name=require_reset_password,json=requireResetPassword,proto3" json:"require_reset_password,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // Access token for authenticated requests.+ Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"`+ // Temporary token for MFA verification.+ 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.User *User `protobuf:"bytes,4,opt,name=user,proto3" json:"user,omitempty"`unknownFields protoimpl.UnknownFields@@ -361,6 +372,7 @@ func (x *LoginResponse) GetUser() *User {return nil}+// Request to logout current user session.type LogoutRequest struct {state protoimpl.MessageState `protogen:"open.v1"`unknownFields protoimpl.UnknownFieldsdiff --git a/backend/generated-go/v1/auth_service_grpc.pb.go b/backend/generated-go/v1/auth_service_grpc.pb.goindex b73d423a7f..095b4ec522 100644--- a/backend/generated-go/v1/auth_service_grpc.pb.go+++ b/backend/generated-go/v1/auth_service_grpc.pb.go@@ -27,9 +27,13 @@ const (// AuthServiceClient is the client API for AuthService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// AuthService handles user authentication operations.type AuthServiceClient interface {+ // Authenticates a user and returns access tokens.// Permissions required: NoneLogin(ctx context.Context, in *LoginRequest, opts ...grpc.CallOption) (*LoginResponse, error)+ // Logs out the current user session.// Permissions required: NoneLogout(ctx context.Context, in *LogoutRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)}@@ -65,9 +69,13 @@ func (c *authServiceClient) Logout(ctx context.Context, in *LogoutRequest, opts// AuthServiceServer is the server API for AuthService service.// All implementations must embed UnimplementedAuthServiceServer// for forward compatibility.+//+// AuthService handles user authentication operations.type AuthServiceServer interface {+ // Authenticates a user and returns access tokens.// Permissions required: NoneLogin(context.Context, *LoginRequest) (*LoginResponse, error)+ // Logs out the current user session.// Permissions required: NoneLogout(context.Context, *LogoutRequest) (*emptypb.Empty, error)mustEmbedUnimplementedAuthServiceServer()diff --git a/backend/generated-go/v1/cel_service.pb.go b/backend/generated-go/v1/cel_service.pb.goindex 9ae5dd5fb9..badf012bb3 100644--- a/backend/generated-go/v1/cel_service.pb.go+++ b/backend/generated-go/v1/cel_service.pb.go@@ -23,9 +23,11 @@ const (_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20))+// Request message for batch parsing CEL expressions.type BatchParseRequest struct {- state protoimpl.MessageState `protogen:"open.v1"`- Expressions []string `protobuf:"bytes,1,rep,name=expressions,proto3" json:"expressions,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The CEL expression strings to parse.+ Expressions []string `protobuf:"bytes,1,rep,name=expressions,proto3" json:"expressions,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -67,9 +69,11 @@ func (x *BatchParseRequest) GetExpressions() []string {return nil}+// Response message for batch parsing CEL expressions.type BatchParseResponse struct {- state protoimpl.MessageState `protogen:"open.v1"`- Expressions []*v1alpha1.Expr `protobuf:"bytes,1,rep,name=expressions,proto3" json:"expressions,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The parsed CEL expressions as AST.+ Expressions []*v1alpha1.Expr `protobuf:"bytes,1,rep,name=expressions,proto3" json:"expressions,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -111,9 +115,11 @@ func (x *BatchParseResponse) GetExpressions() []*v1alpha1.Expr {return nil}+// Request message for batch deparsing CEL expressions.type BatchDeparseRequest struct {- state protoimpl.MessageState `protogen:"open.v1"`- Expressions []*v1alpha1.Expr `protobuf:"bytes,1,rep,name=expressions,proto3" json:"expressions,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The CEL expression ASTs to deparse.+ Expressions []*v1alpha1.Expr `protobuf:"bytes,1,rep,name=expressions,proto3" json:"expressions,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -155,9 +161,11 @@ func (x *BatchDeparseRequest) GetExpressions() []*v1alpha1.Expr {return nil}+// Response message for batch deparsing CEL expressions.type BatchDeparseResponse struct {- state protoimpl.MessageState `protogen:"open.v1"`- Expressions []string `protobuf:"bytes,1,rep,name=expressions,proto3" json:"expressions,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The deparsed CEL expressions as strings.+ Expressions []string `protobuf:"bytes,1,rep,name=expressions,proto3" json:"expressions,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}diff --git a/backend/generated-go/v1/cel_service_grpc.pb.go b/backend/generated-go/v1/cel_service_grpc.pb.goindex d635c952c0..c7b2447ba0 100644--- a/backend/generated-go/v1/cel_service_grpc.pb.go+++ b/backend/generated-go/v1/cel_service_grpc.pb.go@@ -26,9 +26,13 @@ const (// CelServiceClient is the client API for CelService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// CelService manages CEL (Common Expression Language) parsing and formatting operations.type CelServiceClient interface {+ // Parses multiple CEL expression strings into AST representations.// Permissions required: NoneBatchParse(ctx context.Context, in *BatchParseRequest, opts ...grpc.CallOption) (*BatchParseResponse, error)+ // Converts multiple CEL AST representations back into expression strings.// Permissions required: NoneBatchDeparse(ctx context.Context, in *BatchDeparseRequest, opts ...grpc.CallOption) (*BatchDeparseResponse, error)}@@ -64,9 +68,13 @@ func (c *celServiceClient) BatchDeparse(ctx context.Context, in *BatchDeparseReq// CelServiceServer is the server API for CelService service.// All implementations must embed UnimplementedCelServiceServer// for forward compatibility.+//+// CelService manages CEL (Common Expression Language) parsing and formatting operations.type CelServiceServer interface {+ // Parses multiple CEL expression strings into AST representations.// Permissions required: NoneBatchParse(context.Context, *BatchParseRequest) (*BatchParseResponse, error)+ // Converts multiple CEL AST representations back into expression strings.// Permissions required: NoneBatchDeparse(context.Context, *BatchDeparseRequest) (*BatchDeparseResponse, error)mustEmbedUnimplementedCelServiceServer()diff --git a/backend/generated-go/v1/changelist_service.pb.go b/backend/generated-go/v1/changelist_service.pb.goindex 28ba928499..dc343fd303 100644--- a/backend/generated-go/v1/changelist_service.pb.go+++ b/backend/generated-go/v1/changelist_service.pb.go@@ -25,6 +25,7 @@ const (_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20))+// Request message for creating a changelist.type CreateChangelistRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The parent resource where this changelist will be created.@@ -93,6 +94,7 @@ func (x *CreateChangelistRequest) GetChangelistId() string {return ""}+// Request message for getting a changelist.type GetChangelistRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the changelist to retrieve.@@ -139,18 +141,19 @@ func (x *GetChangelistRequest) GetName() string {return ""}+// Request message for listing changelists.type ListChangelistsRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The parent, which owns this collection of changelists.// Format: projects/{project}Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`- // Not used.+ // 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.PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`- // Not used.+ // 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.//@@ -212,6 +215,7 @@ func (x *ListChangelistsRequest) GetPageToken() string {return ""}+// Response message for listing changelists.type ListChangelistsResponse struct {state protoimpl.MessageState `protogen:"open.v1"`// The changelists from the specified request.@@ -267,6 +271,7 @@ func (x *ListChangelistsResponse) GetNextPageToken() string {return ""}+// Request message for updating a changelist.type UpdateChangelistRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The changelist to update.@@ -334,6 +339,7 @@ func (x *UpdateChangelistRequest) GetAllowMissing() bool {return false}+// Request message for deleting a changelist.type DeleteChangelistRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the changelist to delete.@@ -380,19 +386,22 @@ func (x *DeleteChangelistRequest) GetName() string {return ""}+// A changelist groups multiple database changes together.type Changelist struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the changelist resource.// Canonical parent is project.// Format: projects/{project}/changelists/{changelist}- 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 description of the changelist.Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`// The creator of the changelist.// Format: users/{email}Creator string `protobuf:"bytes,3,opt,name=creator,proto3" json:"creator,omitempty"`- // The last update time of the changelist.- UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`- Changes []*Changelist_Change `protobuf:"bytes,7,rep,name=changes,proto3" json:"changes,omitempty"`+ // The last time the changelist was updated.+ UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`+ // The list of changes in this changelist.+ Changes []*Changelist_Change `protobuf:"bytes,7,rep,name=changes,proto3" json:"changes,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -462,13 +471,14 @@ func (x *Changelist) GetChanges() []*Changelist_Change {return nil}+// A single change in a changelist.type Changelist_Change struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name of a sheet.+ // The sheet containing the SQL statement.Sheet string `protobuf:"bytes,1,opt,name=sheet,proto3" json:"sheet,omitempty"`- // The source of origin.- // 1) changelog: instances/{instance}/databases/{database}/changelogs/{changelog}.- // 2) raw SQL if empty.+ // The source of this change.+ // Format: instances/{instance}/databases/{database}/changelogs/{changelog}+ // If empty, the change is from raw SQL.Source string `protobuf:"bytes,2,opt,name=source,proto3" json:"source,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCachediff --git a/backend/generated-go/v1/changelist_service_grpc.pb.go b/backend/generated-go/v1/changelist_service_grpc.pb.goindex 87ea5c0b36..388379cd31 100644--- a/backend/generated-go/v1/changelist_service_grpc.pb.go+++ b/backend/generated-go/v1/changelist_service_grpc.pb.go@@ -30,15 +30,22 @@ const (// ChangelistServiceClient is the client API for ChangelistService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// ChangelistService manages changelists for grouping and organizing database changes.type ChangelistServiceClient interface {+ // Creates a new changelist in a project.// Permissions required: bb.changelists.createCreateChangelist(ctx context.Context, in *CreateChangelistRequest, opts ...grpc.CallOption) (*Changelist, error)+ // Gets a changelist by name.// Permissions required: bb.changelists.getGetChangelist(ctx context.Context, in *GetChangelistRequest, opts ...grpc.CallOption) (*Changelist, error)+ // Lists changelists in a project.// Permissions required: bb.changelists.listListChangelists(ctx context.Context, in *ListChangelistsRequest, opts ...grpc.CallOption) (*ListChangelistsResponse, error)+ // Updates a changelist.// Permissions required: bb.changelists.updateUpdateChangelist(ctx context.Context, in *UpdateChangelistRequest, opts ...grpc.CallOption) (*Changelist, error)+ // Deletes a changelist.// Permissions required: bb.changelists.deleteDeleteChangelist(ctx context.Context, in *DeleteChangelistRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)}@@ -104,15 +111,22 @@ func (c *changelistServiceClient) DeleteChangelist(ctx context.Context, in *Dele// ChangelistServiceServer is the server API for ChangelistService service.// All implementations must embed UnimplementedChangelistServiceServer// for forward compatibility.+//+// ChangelistService manages changelists for grouping and organizing database changes.type ChangelistServiceServer interface {+ // Creates a new changelist in a project.// Permissions required: bb.changelists.createCreateChangelist(context.Context, *CreateChangelistRequest) (*Changelist, error)+ // Gets a changelist by name.// Permissions required: bb.changelists.getGetChangelist(context.Context, *GetChangelistRequest) (*Changelist, error)+ // Lists changelists in a project.// Permissions required: bb.changelists.listListChangelists(context.Context, *ListChangelistsRequest) (*ListChangelistsResponse, error)+ // Updates a changelist.// Permissions required: bb.changelists.updateUpdateChangelist(context.Context, *UpdateChangelistRequest) (*Changelist, error)+ // Deletes a changelist.// Permissions required: bb.changelists.deleteDeleteChangelist(context.Context, *DeleteChangelistRequest) (*emptypb.Empty, error)mustEmbedUnimplementedChangelistServiceServer()diff --git a/backend/generated-go/v1/common.pb.go b/backend/generated-go/v1/common.pb.goindex 9c3774516c..d177e4c5d2 100644--- a/backend/generated-go/v1/common.pb.go+++ b/backend/generated-go/v1/common.pb.go@@ -21,12 +21,15 @@ const (_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20))+// Resource lifecycle state.type State int32const (State_STATE_UNSPECIFIED State = 0- State_ACTIVE State = 1- State_DELETED State = 2+ // Resource is active and operational.+ State_ACTIVE State = 1+ // Resource is soft-deleted but may be recoverable.+ State_DELETED State = 2)// Enum value maps for State.@@ -70,35 +73,62 @@ func (State) EnumDescriptor() ([]byte, []int) {return file_v1_common_proto_rawDescGZIP(), []int{0}}+// Database engine type.type Engine int32const (+ // Unspecified database engine.Engine_ENGINE_UNSPECIFIED Engine = 0- Engine_CLICKHOUSE Engine = 1- Engine_MYSQL Engine = 2- Engine_POSTGRES Engine = 3- Engine_SNOWFLAKE Engine = 4- Engine_SQLITE Engine = 5- Engine_TIDB Engine = 6- Engine_MONGODB Engine = 7- Engine_REDIS Engine = 8- Engine_ORACLE Engine = 9- Engine_SPANNER Engine = 10- Engine_MSSQL Engine = 11- Engine_REDSHIFT Engine = 12- Engine_MARIADB Engine = 13- Engine_OCEANBASE Engine = 14- Engine_STARROCKS Engine = 18- Engine_DORIS Engine = 19- Engine_HIVE Engine = 20- Engine_ELASTICSEARCH Engine = 21- Engine_BIGQUERY Engine = 22- Engine_DYNAMODB Engine = 23- Engine_DATABRICKS Engine = 24- Engine_COCKROACHDB Engine = 25- Engine_COSMOSDB Engine = 26- Engine_TRINO Engine = 27- Engine_CASSANDRA Engine = 28+ // ClickHouse columnar database.+ Engine_CLICKHOUSE Engine = 1+ // MySQL relational database.+ Engine_MYSQL Engine = 2+ // PostgreSQL relational database.+ Engine_POSTGRES Engine = 3+ // Snowflake cloud data warehouse.+ Engine_SNOWFLAKE Engine = 4+ // SQLite embedded database.+ Engine_SQLITE Engine = 5+ // TiDB distributed SQL database.+ Engine_TIDB Engine = 6+ // MongoDB document database.+ Engine_MONGODB Engine = 7+ // Redis key-value store.+ Engine_REDIS Engine = 8+ // Oracle relational database.+ Engine_ORACLE Engine = 9+ // Google Cloud Spanner distributed database.+ Engine_SPANNER Engine = 10+ // Microsoft SQL Server relational database.+ Engine_MSSQL Engine = 11+ // Amazon Redshift data warehouse.+ Engine_REDSHIFT Engine = 12+ // MariaDB relational database.+ Engine_MARIADB Engine = 13+ // OceanBase distributed database.+ Engine_OCEANBASE Engine = 14+ // StarRocks analytics database.+ Engine_STARROCKS Engine = 18+ // Apache Doris analytics database.+ Engine_DORIS Engine = 19+ // Apache Hive data warehouse.+ Engine_HIVE Engine = 20+ // Elasticsearch search engine.+ Engine_ELASTICSEARCH Engine = 21+ // Google BigQuery data warehouse.+ Engine_BIGQUERY Engine = 22+ // Amazon DynamoDB NoSQL database.+ Engine_DYNAMODB Engine = 23+ // Databricks lakehouse platform.+ Engine_DATABRICKS Engine = 24+ // CockroachDB distributed SQL database.+ Engine_COCKROACHDB Engine = 25+ // Azure Cosmos DB multi-model database.+ Engine_COSMOSDB Engine = 26+ // Trino distributed SQL query engine.+ Engine_TRINO Engine = 27+ // Apache Cassandra NoSQL database.+ Engine_CASSANDRA Engine = 28)// Enum value maps for Engine.@@ -188,14 +218,20 @@ func (Engine) EnumDescriptor() ([]byte, []int) {return file_v1_common_proto_rawDescGZIP(), []int{1}}+// Version control system type.type VCSType int32const (+ // Unspecified VCS type.VCSType_VCS_TYPE_UNSPECIFIED VCSType = 0- VCSType_GITHUB VCSType = 1- VCSType_GITLAB VCSType = 2- VCSType_BITBUCKET VCSType = 3- VCSType_AZURE_DEVOPS VCSType = 4+ // GitHub version control platform.+ VCSType_GITHUB VCSType = 1+ // GitLab version control platform.+ VCSType_GITLAB VCSType = 2+ // Bitbucket version control platform.+ VCSType_BITBUCKET VCSType = 3+ // Azure DevOps version control platform.+ VCSType_AZURE_DEVOPS VCSType = 4)// Enum value maps for VCSType.@@ -243,14 +279,20 @@ func (VCSType) EnumDescriptor() ([]byte, []int) {return file_v1_common_proto_rawDescGZIP(), []int{2}}+// Data export format.type ExportFormat int32const (+ // Unspecified export format.ExportFormat_FORMAT_UNSPECIFIED ExportFormat = 0- ExportFormat_CSV ExportFormat = 1- ExportFormat_JSON ExportFormat = 2- ExportFormat_SQL ExportFormat = 3- ExportFormat_XLSX ExportFormat = 4+ // Comma-separated values format.+ ExportFormat_CSV ExportFormat = 1+ // JavaScript Object Notation format.+ ExportFormat_JSON ExportFormat = 2+ // SQL statements format.+ ExportFormat_SQL ExportFormat = 3+ // Microsoft Excel spreadsheet format.+ ExportFormat_XLSX ExportFormat = 4)// Enum value maps for ExportFormat.@@ -410,10 +452,14 @@ func (MigrationType) EnumDescriptor() ([]byte, []int) {type RiskLevel int32const (+ // Unspecified risk level.RiskLevel_RISK_LEVEL_UNSPECIFIED RiskLevel = 0- RiskLevel_LOW RiskLevel = 1- RiskLevel_MODERATE RiskLevel = 2- RiskLevel_HIGH RiskLevel = 3+ // Low risk operation.+ RiskLevel_LOW RiskLevel = 1+ // Moderate risk operation.+ RiskLevel_MODERATE RiskLevel = 2+ // High risk operation.+ RiskLevel_HIGH RiskLevel = 3)// Enum value maps for RiskLevel.@@ -515,10 +561,13 @@ func (x *Position) GetColumn() int32 {return 0}+// Range of positions in 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 position (inclusive).+ Start int32 `protobuf:"varint,1,opt,name=start,proto3" json:"start,omitempty"`+ // End position (exclusive).+ End int32 `protobuf:"varint,2,opt,name=end,proto3" json:"end,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}diff --git a/backend/generated-go/v1/database_catalog_service.pb.go b/backend/generated-go/v1/database_catalog_service.pb.goindex 111e55c594..46302f4426 100644--- a/backend/generated-go/v1/database_catalog_service.pb.go+++ b/backend/generated-go/v1/database_catalog_service.pb.go@@ -22,15 +22,22 @@ const (_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20))+// Object schema data types.type ObjectSchema_Type int32const (+ // Unspecified type.ObjectSchema_TYPE_UNSPECIFIED ObjectSchema_Type = 0- ObjectSchema_STRING ObjectSchema_Type = 1- ObjectSchema_NUMBER ObjectSchema_Type = 2- ObjectSchema_BOOLEAN ObjectSchema_Type = 3- ObjectSchema_OBJECT ObjectSchema_Type = 4- ObjectSchema_ARRAY ObjectSchema_Type = 5+ // String type.+ ObjectSchema_STRING ObjectSchema_Type = 1+ // Number type.+ ObjectSchema_NUMBER ObjectSchema_Type = 2+ // Boolean type.+ ObjectSchema_BOOLEAN ObjectSchema_Type = 3+ // Object/struct type.+ ObjectSchema_OBJECT ObjectSchema_Type = 4+ // Array type.+ ObjectSchema_ARRAY ObjectSchema_Type = 5)// Enum value maps for ObjectSchema_Type.@@ -80,6 +87,7 @@ func (ObjectSchema_Type) EnumDescriptor() ([]byte, []int) {return file_v1_database_catalog_service_proto_rawDescGZIP(), []int{6, 0}}+// Request message for getting a database catalog.type GetDatabaseCatalogRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the database catalog to retrieve.@@ -126,6 +134,7 @@ func (x *GetDatabaseCatalogRequest) GetName() string {return ""}+// Request message for updating a database catalog.type UpdateDatabaseCatalogRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The database catalog to update.@@ -184,11 +193,13 @@ func (x *UpdateDatabaseCatalogRequest) GetAllowMissing() bool {return false}+// Catalog metadata for a database including schemas, tables, and columns.type DatabaseCatalog struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the database catalog.// Format: instances/{instance}/databases/{database}/catalog- 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 schemas in the database.Schemas []*SchemaCatalog `protobuf:"bytes,2,rep,name=schemas,proto3" json:"schemas,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -238,10 +249,13 @@ func (x *DatabaseCatalog) GetSchemas() []*SchemaCatalog {return nil}+// Schema metadata within a database.type SchemaCatalog struct {- state protoimpl.MessageState `protogen:"open.v1"`- Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`- Tables []*TableCatalog `protobuf:"bytes,2,rep,name=tables,proto3" json:"tables,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The schema name.+ Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`+ // The tables in the schema.+ Tables []*TableCatalog `protobuf:"bytes,2,rep,name=tables,proto3" json:"tables,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -290,15 +304,18 @@ func (x *SchemaCatalog) GetTables() []*TableCatalog {return nil}+// Table metadata within a schema.type TableCatalog struct {state protoimpl.MessageState `protogen:"open.v1"`- Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`+ // The table name.+ Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// Types that are valid to be assigned to Kind://// *TableCatalog_Columns_// *TableCatalog_ObjectSchema- Kind isTableCatalog_Kind `protobuf_oneof:"kind"`- Classification string `protobuf:"bytes,4,opt,name=classification,proto3" json:"classification,omitempty"`+ Kind isTableCatalog_Kind `protobuf_oneof:"kind"`+ // The data classification level for this table.+ Classification string `protobuf:"bytes,4,opt,name=classification,proto3" json:"classification,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -377,10 +394,12 @@ type isTableCatalog_Kind interface {}type TableCatalog_Columns_ struct {+ // Regular table columns.Columns *TableCatalog_Columns `protobuf:"bytes,2,opt,name=columns,proto3,oneof"`}type TableCatalog_ObjectSchema struct {+ // Object schema for JSON/XML columns.ObjectSchema *ObjectSchema `protobuf:"bytes,3,opt,name=object_schema,json=objectSchema,proto3,oneof"`}@@ -388,16 +407,21 @@ func (*TableCatalog_Columns_) isTableCatalog_Kind() {}func (*TableCatalog_ObjectSchema) isTableCatalog_Kind() {}+// Column metadata within a table.type ColumnCatalog struct {- state protoimpl.MessageState `protogen:"open.v1"`- 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.- Labels map[string]string `protobuf:"bytes,3,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`- Classification string `protobuf:"bytes,4,opt,name=classification,proto3" json:"classification,omitempty"`- ObjectSchema *ObjectSchema `protobuf:"bytes,5,opt,name=object_schema,json=objectSchema,proto3,oneof" json:"object_schema,omitempty"`- unknownFields protoimpl.UnknownFields- sizeCache protoimpl.SizeCache+ state protoimpl.MessageState `protogen:"open.v1"`+ // The column name.+ Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`+ // The semantic type describing the data purpose.+ SemanticType string `protobuf:"bytes,2,opt,name=semantic_type,json=semanticType,proto3" json:"semantic_type,omitempty"`+ // User-defined labels for this column.+ Labels map[string]string `protobuf:"bytes,3,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`+ // The data classification level for this column.+ Classification string `protobuf:"bytes,4,opt,name=classification,proto3" json:"classification,omitempty"`+ // Object schema for complex column types like JSON.+ ObjectSchema *ObjectSchema `protobuf:"bytes,5,opt,name=object_schema,json=objectSchema,proto3,oneof" json:"object_schema,omitempty"`+ unknownFields protoimpl.UnknownFields+ sizeCache protoimpl.SizeCache}func (x *ColumnCatalog) Reset() {@@ -465,15 +489,18 @@ func (x *ColumnCatalog) GetObjectSchema() *ObjectSchema {return nil}+// Schema definition for object-type columns.type ObjectSchema struct {state protoimpl.MessageState `protogen:"open.v1"`- Type ObjectSchema_Type `protobuf:"varint,1,opt,name=type,proto3,enum=bytebase.v1.ObjectSchema_Type" json:"type,omitempty"`+ // The data type of this object.+ Type ObjectSchema_Type `protobuf:"varint,1,opt,name=type,proto3,enum=bytebase.v1.ObjectSchema_Type" json:"type,omitempty"`// Types that are valid to be assigned to Kind://// *ObjectSchema_StructKind_// *ObjectSchema_ArrayKind_- Kind isObjectSchema_Kind `protobuf_oneof:"kind"`- SemanticType string `protobuf:"bytes,4,opt,name=semantic_type,json=semanticType,proto3" json:"semantic_type,omitempty"`+ Kind isObjectSchema_Kind `protobuf_oneof:"kind"`+ // The semantic type of this object.+ SemanticType string `protobuf:"bytes,4,opt,name=semantic_type,json=semanticType,proto3" json:"semantic_type,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -552,10 +579,12 @@ type isObjectSchema_Kind interface {}type ObjectSchema_StructKind_ struct {+ // Struct schema.StructKind *ObjectSchema_StructKind `protobuf:"bytes,2,opt,name=struct_kind,json=structKind,proto3,oneof"`}type ObjectSchema_ArrayKind_ struct {+ // Array schema.ArrayKind *ObjectSchema_ArrayKind `protobuf:"bytes,3,opt,name=array_kind,json=arrayKind,proto3,oneof"`}@@ -563,9 +592,11 @@ func (*ObjectSchema_StructKind_) isObjectSchema_Kind() {}func (*ObjectSchema_ArrayKind_) isObjectSchema_Kind() {}+// Column list for regular tables.type TableCatalog_Columns struct {- state protoimpl.MessageState `protogen:"open.v1"`- Columns []*ColumnCatalog `protobuf:"bytes,1,rep,name=columns,proto3" json:"columns,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The columns in the table.+ Columns []*ColumnCatalog `protobuf:"bytes,1,rep,name=columns,proto3" json:"columns,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -607,8 +638,10 @@ func (x *TableCatalog_Columns) GetColumns() []*ColumnCatalog {return nil}+// Structure type with named properties.type ObjectSchema_StructKind struct {- state protoimpl.MessageState `protogen:"open.v1"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // Properties of the struct.Properties map[string]*ObjectSchema `protobuf:"bytes,1,rep,name=properties,proto3" json:"properties,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -651,9 +684,11 @@ func (x *ObjectSchema_StructKind) GetProperties() map[string]*ObjectSchema {return nil}+// Array type with element schema.type ObjectSchema_ArrayKind struct {- state protoimpl.MessageState `protogen:"open.v1"`- Kind *ObjectSchema `protobuf:"bytes,1,opt,name=kind,proto3" json:"kind,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The schema of array elements.+ Kind *ObjectSchema `protobuf:"bytes,1,opt,name=kind,proto3" json:"kind,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}diff --git a/backend/generated-go/v1/database_catalog_service_grpc.pb.go b/backend/generated-go/v1/database_catalog_service_grpc.pb.goindex 2ba03d89ed..ce916fb228 100644--- a/backend/generated-go/v1/database_catalog_service_grpc.pb.go+++ b/backend/generated-go/v1/database_catalog_service_grpc.pb.go@@ -26,9 +26,13 @@ const (// DatabaseCatalogServiceClient is the client API for DatabaseCatalogService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// DatabaseCatalogService manages database schema metadata and classification.type DatabaseCatalogServiceClient interface {+ // Gets the catalog metadata for a database.// Permissions required: bb.databaseCatalogs.getGetDatabaseCatalog(ctx context.Context, in *GetDatabaseCatalogRequest, opts ...grpc.CallOption) (*DatabaseCatalog, error)+ // Updates catalog metadata such as classifications and labels.// Permissions required: bb.databaseCatalogs.updateUpdateDatabaseCatalog(ctx context.Context, in *UpdateDatabaseCatalogRequest, opts ...grpc.CallOption) (*DatabaseCatalog, error)}@@ -64,9 +68,13 @@ func (c *databaseCatalogServiceClient) UpdateDatabaseCatalog(ctx context.Context// DatabaseCatalogServiceServer is the server API for DatabaseCatalogService service.// All implementations must embed UnimplementedDatabaseCatalogServiceServer// for forward compatibility.+//+// DatabaseCatalogService manages database schema metadata and classification.type DatabaseCatalogServiceServer interface {+ // Gets the catalog metadata for a database.// Permissions required: bb.databaseCatalogs.getGetDatabaseCatalog(context.Context, *GetDatabaseCatalogRequest) (*DatabaseCatalog, error)+ // Updates catalog metadata such as classifications and labels.// Permissions required: bb.databaseCatalogs.updateUpdateDatabaseCatalog(context.Context, *UpdateDatabaseCatalogRequest) (*DatabaseCatalog, error)mustEmbedUnimplementedDatabaseCatalogServiceServer()diff --git a/backend/generated-go/v1/database_group_service.pb.go b/backend/generated-go/v1/database_group_service.pb.goindex fa1724b44c..c9a457b980 100644--- a/backend/generated-go/v1/database_group_service.pb.go+++ b/backend/generated-go/v1/database_group_service.pb.go@@ -25,6 +25,7 @@ const (_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20))+// View options for database group responses.type DatabaseGroupView int32const (@@ -78,18 +79,19 @@ func (DatabaseGroupView) EnumDescriptor() ([]byte, []int) {return file_v1_database_group_service_proto_rawDescGZIP(), []int{0}}+// Request message for listing database groups.type ListDatabaseGroupsRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The parent resource whose database groups are to be listed.// Format: projects/{project}Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// The maximum number of database groups to return. The service may return fewer than// this value.// If unspecified, at most 50 database groups 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"`- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// A page token, received from a previous `ListDatabaseGroups` call.// Provide this to retrieve the subsequent page.//@@ -160,11 +162,13 @@ func (x *ListDatabaseGroupsRequest) GetView() DatabaseGroupView {return DatabaseGroupView_DATABASE_GROUP_VIEW_UNSPECIFIED}+// Response message for listing database groups.type ListDatabaseGroupsResponse struct {state protoimpl.MessageState `protogen:"open.v1"`- // database_groups is the list of database groups.+ // The database groups from the specified request.DatabaseGroups []*DatabaseGroup `protobuf:"bytes,1,rep,name=database_groups,json=databaseGroups,proto3" json:"database_groups,omitempty"`- // Not used. A token, which can be sent as `page_token` to retrieve the next page.+ // Pagination is not currently implemented. This field is reserved for future use.+ // A token, which can be sent as `page_token` to retrieve the next page.// If this field is omitted, there are no subsequent pages.NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`unknownFields protoimpl.UnknownFields@@ -215,6 +219,7 @@ func (x *ListDatabaseGroupsResponse) GetNextPageToken() string {return ""}+// Request message for getting a database group.type GetDatabaseGroupRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the database group to retrieve.@@ -270,6 +275,7 @@ func (x *GetDatabaseGroupRequest) GetView() DatabaseGroupView {return DatabaseGroupView_DATABASE_GROUP_VIEW_UNSPECIFIED}+// Request message for creating a database group.type CreateDatabaseGroupRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The parent resource where this database group will be created.@@ -347,6 +353,7 @@ func (x *CreateDatabaseGroupRequest) GetValidateOnly() bool {return false}+// Request message for updating a database group.type UpdateDatabaseGroupRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The database group to update.@@ -414,6 +421,7 @@ func (x *UpdateDatabaseGroupRequest) GetAllowMissing() bool {return false}+// Request message for deleting a database group.type DeleteDatabaseGroupRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the database group to delete.@@ -460,6 +468,7 @@ func (x *DeleteDatabaseGroupRequest) GetName() string {return ""}+// A group of databases matched by expressions.type DatabaseGroup struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the database group.@@ -545,6 +554,7 @@ func (x *DatabaseGroup) GetMatchedDatabases() []*DatabaseGroup_Database {return nil}+// A database within a database group.type DatabaseGroup_Database struct {state protoimpl.MessageState `protogen:"open.v1"`// The resource name of the database.diff --git a/backend/generated-go/v1/database_group_service_grpc.pb.go b/backend/generated-go/v1/database_group_service_grpc.pb.goindex 5e3a6be0f6..482ccd1961 100644--- a/backend/generated-go/v1/database_group_service_grpc.pb.go+++ b/backend/generated-go/v1/database_group_service_grpc.pb.go@@ -30,15 +30,22 @@ const (// DatabaseGroupServiceClient is the client API for DatabaseGroupService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// DatabaseGroupService manages database groups for organizing databases by criteria.type DatabaseGroupServiceClient interface {+ // Lists database groups in a project.// Permissions required: bb.projects.getListDatabaseGroups(ctx context.Context, in *ListDatabaseGroupsRequest, opts ...grpc.CallOption) (*ListDatabaseGroupsResponse, error)+ // Gets a database group by name.// Permissions required: bb.projects.getGetDatabaseGroup(ctx context.Context, in *GetDatabaseGroupRequest, opts ...grpc.CallOption) (*DatabaseGroup, error)+ // Creates a new database group.// Permissions required: bb.projects.updateCreateDatabaseGroup(ctx context.Context, in *CreateDatabaseGroupRequest, opts ...grpc.CallOption) (*DatabaseGroup, error)+ // Updates a database group.// Permissions required: bb.projects.updateUpdateDatabaseGroup(ctx context.Context, in *UpdateDatabaseGroupRequest, opts ...grpc.CallOption) (*DatabaseGroup, error)+ // Deletes a database group.// Permissions required: bb.projects.updateDeleteDatabaseGroup(ctx context.Context, in *DeleteDatabaseGroupRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)}@@ -104,15 +111,22 @@ func (c *databaseGroupServiceClient) DeleteDatabaseGroup(ctx context.Context, in// DatabaseGroupServiceServer is the server API for DatabaseGroupService service.// All implementations must embed UnimplementedDatabaseGroupServiceServer// for forward compatibility.+//+// DatabaseGroupService manages database groups for organizing databases by criteria.type DatabaseGroupServiceServer interface {+ // Lists database groups in a project.// Permissions required: bb.projects.getListDatabaseGroups(context.Context, *ListDatabaseGroupsRequest) (*ListDatabaseGroupsResponse, error)+ // Gets a database group by name.// Permissions required: bb.projects.getGetDatabaseGroup(context.Context, *GetDatabaseGroupRequest) (*DatabaseGroup, error)+ // Creates a new database group.// Permissions required: bb.projects.updateCreateDatabaseGroup(context.Context, *CreateDatabaseGroupRequest) (*DatabaseGroup, error)+ // Updates a database group.// Permissions required: bb.projects.updateUpdateDatabaseGroup(context.Context, *UpdateDatabaseGroupRequest) (*DatabaseGroup, error)+ // Deletes a database group.// Permissions required: bb.projects.updateDeleteDatabaseGroup(context.Context, *DeleteDatabaseGroupRequest) (*emptypb.Empty, error)mustEmbedUnimplementedDatabaseGroupServiceServer()diff --git a/backend/generated-go/v1/database_service.pb.go b/backend/generated-go/v1/database_service.pb.goindex f30938c6b0..57ae854bea 100644--- a/backend/generated-go/v1/database_service.pb.go+++ b/backend/generated-go/v1/database_service.pb.go@@ -1732,7 +1732,8 @@ type DatabaseMetadata struct {Collation string `protobuf:"bytes,4,opt,name=collation,proto3" json:"collation,omitempty"`// The extensions is the list of extensions in a database.Extensions []*ExtensionMetadata `protobuf:"bytes,5,rep,name=extensions,proto3" json:"extensions,omitempty"`- Owner string `protobuf:"bytes,7,opt,name=owner,proto3" json:"owner,omitempty"`+ // The owner of the database.+ Owner string `protobuf:"bytes,7,opt,name=owner,proto3" json:"owner,omitempty"`// The search_path is the search path of a PostgreSQL database.SearchPath string `protobuf:"bytes,8,opt,name=search_path,json=searchPath,proto3" json:"search_path,omitempty"`unknownFields protoimpl.UnknownFields@@ -1845,12 +1846,16 @@ type SchemaMetadata struct {MaterializedViews []*MaterializedViewMetadata `protobuf:"bytes,9,rep,name=materialized_views,json=materializedViews,proto3" json:"materialized_views,omitempty"`// The packages is the list of packages in a schema.Packages []*PackageMetadata `protobuf:"bytes,10,rep,name=packages,proto3" json:"packages,omitempty"`- Owner string `protobuf:"bytes,11,opt,name=owner,proto3" json:"owner,omitempty"`+ // The owner of the schema.+ Owner string `protobuf:"bytes,11,opt,name=owner,proto3" json:"owner,omitempty"`// The sequences is the list of sequences in a schema, sorted by name.Sequences []*SequenceMetadata `protobuf:"bytes,13,rep,name=sequences,proto3" json:"sequences,omitempty"`- Events []*EventMetadata `protobuf:"bytes,14,rep,name=events,proto3" json:"events,omitempty"`+ // The events is the list of scheduled events in a schema.+ Events []*EventMetadata `protobuf:"bytes,14,rep,name=events,proto3" json:"events,omitempty"`+ // The enum_types is the list of user-defined enum types in a schema.EnumTypes []*EnumTypeMetadata `protobuf:"bytes,15,rep,name=enum_types,json=enumTypes,proto3" json:"enum_types,omitempty"`- SkipDump bool `protobuf:"varint,16,opt,name=skip_dump,json=skipDump,proto3" json:"skip_dump,omitempty"`+ // Whether to skip this schema during schema dump operations.+ SkipDump bool `protobuf:"varint,16,opt,name=skip_dump,json=skipDump,proto3" json:"skip_dump,omitempty"`// The comment is the comment of a schema.Comment string `protobuf:"bytes,17,opt,name=comment,proto3" json:"comment,omitempty"`unknownFields protoimpl.UnknownFields@@ -2004,9 +2009,11 @@ type EnumTypeMetadata struct {// The name of a type.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// The enum values of a 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"`+ Values []string `protobuf:"bytes,2,rep,name=values,proto3" json:"values,omitempty"`+ // The comment describing the enum type.+ Comment string `protobuf:"bytes,3,opt,name=comment,proto3" json:"comment,omitempty"`+ // Whether to skip this enum type during schema dump operations.+ SkipDump bool `protobuf:"varint,4,opt,name=skip_dump,json=skipDump,proto3" json:"skip_dump,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -2076,9 +2083,12 @@ type EventMetadata struct {// The schedule of the event.Definition string `protobuf:"bytes,2,opt,name=definition,proto3" json:"definition,omitempty"`// The time zone of the event.- TimeZone string `protobuf:"bytes,3,opt,name=time_zone,json=timeZone,proto3" json:"time_zone,omitempty"`- SqlMode string `protobuf:"bytes,4,opt,name=sql_mode,json=sqlMode,proto3" json:"sql_mode,omitempty"`- CharacterSetClient string `protobuf:"bytes,5,opt,name=character_set_client,json=characterSetClient,proto3" json:"character_set_client,omitempty"`+ TimeZone string `protobuf:"bytes,3,opt,name=time_zone,json=timeZone,proto3" json:"time_zone,omitempty"`+ // The SQL mode setting for the event.+ SqlMode string `protobuf:"bytes,4,opt,name=sql_mode,json=sqlMode,proto3" json:"sql_mode,omitempty"`+ // The character set used by the client creating the event.+ CharacterSetClient string `protobuf:"bytes,5,opt,name=character_set_client,json=characterSetClient,proto3" json:"character_set_client,omitempty"`+ // The collation used for the connection when creating the event.CollationConnection string `protobuf:"bytes,6,opt,name=collation_connection,json=collationConnection,proto3" json:"collation_connection,omitempty"`// The comment is the comment of an event.Comment string `protobuf:"bytes,7,opt,name=comment,proto3" json:"comment,omitempty"`@@ -2188,9 +2198,11 @@ type SequenceMetadata struct {// The owner table of the sequence.OwnerTable string `protobuf:"bytes,10,opt,name=owner_table,json=ownerTable,proto3" json:"owner_table,omitempty"`// The owner column of 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"`+ OwnerColumn string `protobuf:"bytes,11,opt,name=owner_column,json=ownerColumn,proto3" json:"owner_column,omitempty"`+ // The comment describing the sequence.+ Comment string `protobuf:"bytes,12,opt,name=comment,proto3" json:"comment,omitempty"`+ // Whether to skip this sequence during schema dump operations.+ SkipDump bool `protobuf:"varint,13,opt,name=skip_dump,json=skipDump,proto3" json:"skip_dump,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -2326,14 +2338,19 @@ type TriggerMetadata struct {// The timing is the timing of the trigger, such as BEFORE, AFTER.Timing string `protobuf:"bytes,4,opt,name=timing,proto3" json:"timing,omitempty"`// The body is 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"`+ Body string `protobuf:"bytes,5,opt,name=body,proto3" json:"body,omitempty"`+ // The SQL mode setting for the trigger.+ SqlMode string `protobuf:"bytes,6,opt,name=sql_mode,json=sqlMode,proto3" json:"sql_mode,omitempty"`+ // The character set used by the client creating the trigger.+ CharacterSetClient string `protobuf:"bytes,7,opt,name=character_set_client,json=characterSetClient,proto3" json:"character_set_client,omitempty"`+ // The collation used for the connection when creating the trigger.CollationConnection string `protobuf:"bytes,8,opt,name=collation_connection,json=collationConnection,proto3" json:"collation_connection,omitempty"`- Comment string `protobuf:"bytes,9,opt,name=comment,proto3" json:"comment,omitempty"`- SkipDump bool `protobuf:"varint,10,opt,name=skip_dump,json=skipDump,proto3" json:"skip_dump,omitempty"`- unknownFields protoimpl.UnknownFields- sizeCache protoimpl.SizeCache+ // The comment describing the trigger.+ Comment string `protobuf:"bytes,9,opt,name=comment,proto3" json:"comment,omitempty"`+ // Whether to skip this trigger during schema dump operations.+ SkipDump bool `protobuf:"varint,10,opt,name=skip_dump,json=skipDump,proto3" json:"skip_dump,omitempty"`+ unknownFields protoimpl.UnknownFields+ sizeCache protoimpl.SizeCache}func (x *TriggerMetadata) Reset() {@@ -2537,12 +2554,15 @@ type TableMetadata struct {Partitions []*TablePartitionMetadata `protobuf:"bytes,15,rep,name=partitions,proto3" json:"partitions,omitempty"`// The check_constraints is the list of check constraints in a table.CheckConstraints []*CheckConstraintMetadata `protobuf:"bytes,16,rep,name=check_constraints,json=checkConstraints,proto3" json:"check_constraints,omitempty"`- Owner string `protobuf:"bytes,18,opt,name=owner,proto3" json:"owner,omitempty"`+ // The owner of the table.+ Owner string `protobuf:"bytes,18,opt,name=owner,proto3" json:"owner,omitempty"`// The sorting_keys is a tuple of column names or arbitrary expressions. ClickHouse specific field.// Reference: https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/mergetree#order_by- SortingKeys []string `protobuf:"bytes,19,rep,name=sorting_keys,json=sortingKeys,proto3" json:"sorting_keys,omitempty"`- Triggers []*TriggerMetadata `protobuf:"bytes,20,rep,name=triggers,proto3" json:"triggers,omitempty"`- SkipDump bool `protobuf:"varint,21,opt,name=skip_dump,json=skipDump,proto3" json:"skip_dump,omitempty"`+ SortingKeys []string `protobuf:"bytes,19,rep,name=sorting_keys,json=sortingKeys,proto3" json:"sorting_keys,omitempty"`+ // The triggers is the list of triggers associated with the table.+ Triggers []*TriggerMetadata `protobuf:"bytes,20,rep,name=triggers,proto3" json:"triggers,omitempty"`+ // Whether to skip this table during schema dump operations.+ SkipDump bool `protobuf:"varint,21,opt,name=skip_dump,json=skipDump,proto3" json:"skip_dump,omitempty"`// https://docs.pingcap.com/tidb/stable/information-schema-tables/ShardingInfo string `protobuf:"bytes,22,opt,name=sharding_info,json=shardingInfo,proto3" json:"sharding_info,omitempty"`// https://docs.pingcap.com/tidb/stable/clustered-indexes/#clustered-indexesdiff --git a/backend/generated-go/v1/database_service_grpc.pb.go b/backend/generated-go/v1/database_service_grpc.pb.goindex 7d8c33fc81..b517960090 100644--- a/backend/generated-go/v1/database_service_grpc.pb.go+++ b/backend/generated-go/v1/database_service_grpc.pb.go@@ -37,32 +37,47 @@ const (// DatabaseServiceClient is the client API for DatabaseService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// DatabaseService manages databases and their schemas.type DatabaseServiceClient interface {+ // Retrieves a database by name.// Permissions required: bb.databases.getGetDatabase(ctx context.Context, in *GetDatabaseRequest, opts ...grpc.CallOption) (*Database, error)+ // Retrieves multiple databases by their names.// Permissions required: bb.databases.getBatchGetDatabases(ctx context.Context, in *BatchGetDatabasesRequest, opts ...grpc.CallOption) (*BatchGetDatabasesResponse, error)- // Permissions required: bb.databases.list+ // Lists databases in a project, instance, or workspace.+ // Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)ListDatabases(ctx context.Context, in *ListDatabasesRequest, opts ...grpc.CallOption) (*ListDatabasesResponse, error)+ // Updates database properties such as labels and project assignment.// Permissions required: bb.databases.updateUpdateDatabase(ctx context.Context, in *UpdateDatabaseRequest, opts ...grpc.CallOption) (*Database, error)+ // Updates multiple databases in a single batch operation.// Permissions required: bb.databases.updateBatchUpdateDatabases(ctx context.Context, in *BatchUpdateDatabasesRequest, opts ...grpc.CallOption) (*BatchUpdateDatabasesResponse, error)+ // Synchronizes database schema from the instance.// Permissions required: bb.databases.syncSyncDatabase(ctx context.Context, in *SyncDatabaseRequest, opts ...grpc.CallOption) (*SyncDatabaseResponse, error)+ // Synchronizes multiple databases in a single batch operation.// Permissions required: bb.databases.syncBatchSyncDatabases(ctx context.Context, in *BatchSyncDatabasesRequest, opts ...grpc.CallOption) (*BatchSyncDatabasesResponse, error)+ // Retrieves database metadata including tables, columns, and indexes.// Permissions required: bb.databases.getSchemaGetDatabaseMetadata(ctx context.Context, in *GetDatabaseMetadataRequest, opts ...grpc.CallOption) (*DatabaseMetadata, error)+ // Retrieves database schema as DDL statements.// Permissions required: bb.databases.getSchemaGetDatabaseSchema(ctx context.Context, in *GetDatabaseSchemaRequest, opts ...grpc.CallOption) (*DatabaseSchema, error)+ // Compares and generates migration statements between two schemas.// Permissions required: bb.databases.getDiffSchema(ctx context.Context, in *DiffSchemaRequest, opts ...grpc.CallOption) (*DiffSchemaResponse, error)+ // Lists migration history for a database.// Permissions required: bb.changelogs.listListChangelogs(ctx context.Context, in *ListChangelogsRequest, opts ...grpc.CallOption) (*ListChangelogsResponse, error)- // Permissions required: changelogs.get+ // Retrieves a specific changelog entry.+ // Permissions required: bb.changelogs.getGetChangelog(ctx context.Context, in *GetChangelogRequest, opts ...grpc.CallOption) (*Changelog, error)- // Permissions required: databases.getSchema+ // Generates schema DDL for a database object.+ // Permissions required: bb.databases.getSchemaGetSchemaString(ctx context.Context, in *GetSchemaStringRequest, opts ...grpc.CallOption) (*GetSchemaStringResponse, error)}@@ -207,32 +222,47 @@ func (c *databaseServiceClient) GetSchemaString(ctx context.Context, in *GetSche// DatabaseServiceServer is the server API for DatabaseService service.// All implementations must embed UnimplementedDatabaseServiceServer// for forward compatibility.+//+// DatabaseService manages databases and their schemas.type DatabaseServiceServer interface {+ // Retrieves a database by name.// Permissions required: bb.databases.getGetDatabase(context.Context, *GetDatabaseRequest) (*Database, error)+ // Retrieves multiple databases by their names.// Permissions required: bb.databases.getBatchGetDatabases(context.Context, *BatchGetDatabasesRequest) (*BatchGetDatabasesResponse, error)- // Permissions required: bb.databases.list+ // Lists databases in a project, instance, or workspace.+ // Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)ListDatabases(context.Context, *ListDatabasesRequest) (*ListDatabasesResponse, error)+ // Updates database properties such as labels and project assignment.// Permissions required: bb.databases.updateUpdateDatabase(context.Context, *UpdateDatabaseRequest) (*Database, error)+ // Updates multiple databases in a single batch operation.// Permissions required: bb.databases.updateBatchUpdateDatabases(context.Context, *BatchUpdateDatabasesRequest) (*BatchUpdateDatabasesResponse, error)+ // Synchronizes database schema from the instance.// Permissions required: bb.databases.syncSyncDatabase(context.Context, *SyncDatabaseRequest) (*SyncDatabaseResponse, error)+ // Synchronizes multiple databases in a single batch operation.// Permissions required: bb.databases.syncBatchSyncDatabases(context.Context, *BatchSyncDatabasesRequest) (*BatchSyncDatabasesResponse, error)+ // Retrieves database metadata including tables, columns, and indexes.// Permissions required: bb.databases.getSchemaGetDatabaseMetadata(context.Context, *GetDatabaseMetadataRequest) (*DatabaseMetadata, error)+ // Retrieves database schema as DDL statements.// Permissions required: bb.databases.getSchemaGetDatabaseSchema(context.Context, *GetDatabaseSchemaRequest) (*DatabaseSchema, error)+ // Compares and generates migration statements between two schemas.// Permissions required: bb.databases.getDiffSchema(context.Context, *DiffSchemaRequest) (*DiffSchemaResponse, error)+ // Lists migration history for a database.// Permissions required: bb.changelogs.listListChangelogs(context.Context, *ListChangelogsRequest) (*ListChangelogsResponse, error)- // Permissions required: changelogs.get+ // Retrieves a specific changelog entry.+ // Permissions required: bb.changelogs.getGetChangelog(context.Context, *GetChangelogRequest) (*Changelog, error)- // Permissions required: databases.getSchema+ // Generates schema DDL for a database object.+ // Permissions required: bb.databases.getSchemaGetSchemaString(context.Context, *GetSchemaStringRequest) (*GetSchemaStringResponse, error)mustEmbedUnimplementedDatabaseServiceServer()}diff --git a/backend/generated-go/v1/group_service.pb.go b/backend/generated-go/v1/group_service.pb.goindex aa9160a5db..b6e80c9080 100644--- a/backend/generated-go/v1/group_service.pb.go+++ b/backend/generated-go/v1/group_service.pb.go@@ -24,12 +24,16 @@ const (_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20))+// The role of a group member.type GroupMember_Role int32const (+ // Unspecified role.GroupMember_ROLE_UNSPECIFIED GroupMember_Role = 0- GroupMember_OWNER GroupMember_Role = 1- GroupMember_MEMBER GroupMember_Role = 2+ // Group owner.+ GroupMember_OWNER GroupMember_Role = 1+ // Group member.+ GroupMember_MEMBER GroupMember_Role = 2)// Enum value maps for GroupMember_Role.@@ -73,6 +77,7 @@ func (GroupMember_Role) EnumDescriptor() ([]byte, []int) {return file_v1_group_service_proto_rawDescGZIP(), []int{8, 0}}+// Request message for getting a group.type GetGroupRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the group to retrieve.@@ -119,6 +124,7 @@ func (x *GetGroupRequest) GetName() string {return ""}+// Request message for batch getting groups.type BatchGetGroupsRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The group names to retrieve.@@ -165,6 +171,7 @@ func (x *BatchGetGroupsRequest) GetNames() []string {return nil}+// Response message for batch getting groups.type BatchGetGroupsResponse struct {state protoimpl.MessageState `protogen:"open.v1"`// The groups from the specified request.@@ -210,6 +217,7 @@ func (x *BatchGetGroupsResponse) GetGroups() []*Group {return nil}+// Request message for listing groups.type ListGroupsRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The maximum number of groups to return. The service may return fewer than@@ -295,6 +303,7 @@ func (x *ListGroupsRequest) GetFilter() string {return ""}+// Response message for listing groups.type ListGroupsResponse struct {state protoimpl.MessageState `protogen:"open.v1"`// The groups from the specified request.@@ -350,6 +359,7 @@ func (x *ListGroupsResponse) GetNextPageToken() string {return ""}+// Request message for creating a group.type CreateGroupRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The group to create.@@ -405,6 +415,7 @@ func (x *CreateGroupRequest) GetGroupEmail() string {return ""}+// Request message for updating a group.type UpdateGroupRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The group to update.@@ -472,6 +483,7 @@ func (x *UpdateGroupRequest) GetAllowMissing() bool {return false}+// Request message for deleting a group.type DeleteGroupRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the group to delete.@@ -518,12 +530,14 @@ func (x *DeleteGroupRequest) GetName() string {return ""}+// A member of a group with a role.type GroupMember struct {state protoimpl.MessageState `protogen:"open.v1"`// Member is the principal who belong to this group.//// Format: users/[email protected]- Member string `protobuf:"bytes,1,opt,name=member,proto3" json:"member,omitempty"`+ Member string `protobuf:"bytes,1,opt,name=member,proto3" json:"member,omitempty"`+ // The member's role in the group.Role GroupMember_Role `protobuf:"varint,2,opt,name=role,proto3,enum=bytebase.v1.GroupMember_Role" json:"role,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -573,15 +587,19 @@ func (x *GroupMember) GetRole() GroupMember_Role {return GroupMember_ROLE_UNSPECIFIED}+// A group of users within the workspace.type Group struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the group to retrieve.// Format: groups/{group}, group is an email.- Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,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"`- Members []*GroupMember `protobuf:"bytes,5,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.+ Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`+ // The display title of the group.+ Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`+ // The description of the group.+ Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`+ // The members of the group.+ Members []*GroupMember `protobuf:"bytes,5,rep,name=members,proto3" json:"members,omitempty"`+ // The source system where the group originated (e.g., Entra ID for SCIM sync).Source string `protobuf:"bytes,7,opt,name=source,proto3" json:"source,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCachediff --git a/backend/generated-go/v1/group_service_grpc.pb.go b/backend/generated-go/v1/group_service_grpc.pb.goindex adeae38942..9f0fcdd6d3 100644--- a/backend/generated-go/v1/group_service_grpc.pb.go+++ b/backend/generated-go/v1/group_service_grpc.pb.go@@ -31,21 +31,26 @@ const (// GroupServiceClient is the client API for GroupService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// GroupService manages user groups for organizing users and permissions.type GroupServiceClient interface {+ // Gets a group by name.// Permissions required: bb.groups.getGetGroup(ctx context.Context, in *GetGroupRequest, opts ...grpc.CallOption) (*Group, error)- // Get the groups in batch.+ // Gets multiple groups in a single request.// Permissions required: bb.groups.getBatchGetGroups(ctx context.Context, in *BatchGetGroupsRequest, opts ...grpc.CallOption) (*BatchGetGroupsResponse, error)+ // Lists all groups in the workspace.// Permissions required: bb.groups.listListGroups(ctx context.Context, in *ListGroupsRequest, opts ...grpc.CallOption) (*ListGroupsResponse, error)+ // Creates a new group.// Permissions required: bb.groups.createCreateGroup(ctx context.Context, in *CreateGroupRequest, opts ...grpc.CallOption) (*Group, error)- // UpdateGroup updates the group.- // Users with "bb.groups.update" permission on the workspace or the group owner can access this method.- // Permissions required: bb.groups.update+ // Updates a group. Group owners or users with bb.groups.update permission can update.+ // Permissions required: bb.groups.update OR caller is group ownerUpdateGroup(ctx context.Context, in *UpdateGroupRequest, opts ...grpc.CallOption) (*Group, error)- // Permissions required: bb.groups.delete+ // Deletes a group. Group owners or users with bb.groups.delete permission can delete.+ // Permissions required: bb.groups.delete OR caller is group ownerDeleteGroup(ctx context.Context, in *DeleteGroupRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)}@@ -120,21 +125,26 @@ func (c *groupServiceClient) DeleteGroup(ctx context.Context, in *DeleteGroupReq// GroupServiceServer is the server API for GroupService service.// All implementations must embed UnimplementedGroupServiceServer// for forward compatibility.+//+// GroupService manages user groups for organizing users and permissions.type GroupServiceServer interface {+ // Gets a group by name.// Permissions required: bb.groups.getGetGroup(context.Context, *GetGroupRequest) (*Group, error)- // Get the groups in batch.+ // Gets multiple groups in a single request.// Permissions required: bb.groups.getBatchGetGroups(context.Context, *BatchGetGroupsRequest) (*BatchGetGroupsResponse, error)+ // Lists all groups in the workspace.// Permissions required: bb.groups.listListGroups(context.Context, *ListGroupsRequest) (*ListGroupsResponse, error)+ // Creates a new group.// Permissions required: bb.groups.createCreateGroup(context.Context, *CreateGroupRequest) (*Group, error)- // UpdateGroup updates the group.- // Users with "bb.groups.update" permission on the workspace or the group owner can access this method.- // Permissions required: bb.groups.update+ // Updates a group. Group owners or users with bb.groups.update permission can update.+ // Permissions required: bb.groups.update OR caller is group ownerUpdateGroup(context.Context, *UpdateGroupRequest) (*Group, error)- // Permissions required: bb.groups.delete+ // Deletes a group. Group owners or users with bb.groups.delete permission can delete.+ // Permissions required: bb.groups.delete OR caller is group ownerDeleteGroup(context.Context, *DeleteGroupRequest) (*emptypb.Empty, error)mustEmbedUnimplementedGroupServiceServer()}diff --git a/backend/generated-go/v1/iam_policy.pb.go b/backend/generated-go/v1/iam_policy.pb.goindex 7067c39db7..aea63385d2 100644--- a/backend/generated-go/v1/iam_policy.pb.go+++ b/backend/generated-go/v1/iam_policy.pb.go@@ -24,13 +24,16 @@ const (_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20))-// The type of action performed on a Binding in a policy.+// Type of action performed on a binding.type BindingDelta_Action int32const (+ // Unspecified action.BindingDelta_ACTION_UNSPECIFIED BindingDelta_Action = 0- BindingDelta_ADD BindingDelta_Action = 1- BindingDelta_REMOVE BindingDelta_Action = 2+ // Add a binding.+ BindingDelta_ADD BindingDelta_Action = 1+ // Remove a binding.+ BindingDelta_REMOVE BindingDelta_Action = 2)// Enum value maps for BindingDelta_Action.@@ -74,6 +77,7 @@ func (BindingDelta_Action) EnumDescriptor() ([]byte, []int) {return file_v1_iam_policy_proto_rawDescGZIP(), []int{5, 0}}+// Request message for getting an IAM policy.type GetIamPolicyRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the resource to get the IAM policy.@@ -121,6 +125,7 @@ func (x *GetIamPolicyRequest) GetResource() string {return ""}+// Request message for setting an IAM policy.type SetIamPolicyRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the resource to set the IAM policy.@@ -185,6 +190,7 @@ func (x *SetIamPolicyRequest) GetEtag() string {return ""}+// IAM policy that binds members to roles.type IamPolicy struct {state protoimpl.MessageState `protogen:"open.v1"`// Collection of binding.@@ -242,6 +248,7 @@ func (x *IamPolicy) GetEtag() string {return ""}+// Binding associates members with a role and optional conditions.type Binding struct {state protoimpl.MessageState `protogen:"open.v1"`// The role that is assigned to the members.@@ -331,7 +338,7 @@ func (x *Binding) GetParsedExpr() *v1alpha1.Expr {return nil}-// The difference delta between two policies.+// Describes changes between two IAM policies.type PolicyDelta struct {state protoimpl.MessageState `protogen:"open.v1"`// The delta for Bindings between two policies.@@ -377,8 +384,7 @@ func (x *PolicyDelta) GetBindingDeltas() []*BindingDelta {return nil}-// One delta entry for Binding. Each individual change (only one member in each-// entry) to a binding will be a separate entry.+// A single change to a binding.type BindingDelta struct {state protoimpl.MessageState `protogen:"open.v1"`// The action that was performed on a Binding.diff --git a/backend/generated-go/v1/idp_service.pb.go b/backend/generated-go/v1/idp_service.pb.goindex 708a3da441..af0a56433e 100644--- a/backend/generated-go/v1/idp_service.pb.go+++ b/backend/generated-go/v1/idp_service.pb.go@@ -27,10 +27,14 @@ const (type IdentityProviderType int32const (+ // Unspecified identity provider type.IdentityProviderType_IDENTITY_PROVIDER_TYPE_UNSPECIFIED IdentityProviderType = 0- IdentityProviderType_OAUTH2 IdentityProviderType = 1- IdentityProviderType_OIDC IdentityProviderType = 2- IdentityProviderType_LDAP IdentityProviderType = 3+ // OAuth 2.0 authentication protocol.+ IdentityProviderType_OAUTH2 IdentityProviderType = 1+ // OpenID Connect authentication protocol.+ IdentityProviderType_OIDC IdentityProviderType = 2+ // LDAP directory service authentication.+ IdentityProviderType_LDAP IdentityProviderType = 3)// Enum value maps for IdentityProviderType.@@ -179,8 +183,10 @@ func (LDAPIdentityProviderConfig_SecurityProtocol) EnumDescriptor() ([]byte, []i}type GetIdentityProviderRequest struct {- state protoimpl.MessageState `protogen:"open.v1"`- Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The name of the identity provider to retrieve.+ // Format: idps/{idp}+ Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -224,13 +230,13 @@ func (x *GetIdentityProviderRequest) GetName() string {type ListIdentityProvidersRequest struct {state protoimpl.MessageState `protogen:"open.v1"`- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// The maximum number of identity providers to return. The service may return fewer than// this value.// If unspecified, at most 10 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"`- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// A page token, received from a previous `ListIdentityProviders` call.// Provide this to retrieve the subsequent page.//@@ -698,10 +704,14 @@ type IdentityProvider struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the identity provider.// Format: idps/{idp}- Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`- Title string `protobuf:"bytes,4,opt,name=title,proto3" json:"title,omitempty"`- Domain string `protobuf:"bytes,5,opt,name=domain,proto3" json:"domain,omitempty"`- Type IdentityProviderType `protobuf:"varint,6,opt,name=type,proto3,enum=bytebase.v1.IdentityProviderType" json:"type,omitempty"`+ Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`+ // The display title of the identity provider.+ Title string `protobuf:"bytes,4,opt,name=title,proto3" json:"title,omitempty"`+ // The domain for email matching when using this identity provider.+ Domain string `protobuf:"bytes,5,opt,name=domain,proto3" json:"domain,omitempty"`+ // The type of identity provider protocol.+ Type IdentityProviderType `protobuf:"varint,6,opt,name=type,proto3,enum=bytebase.v1.IdentityProviderType" json:"type,omitempty"`+ // The configuration details for the identity provider.Config *IdentityProviderConfig `protobuf:"bytes,7,opt,name=config,proto3" json:"config,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -853,14 +863,17 @@ type isIdentityProviderConfig_Config interface {}type IdentityProviderConfig_Oauth2Config struct {+ // OAuth2 protocol configuration.Oauth2Config *OAuth2IdentityProviderConfig `protobuf:"bytes,1,opt,name=oauth2_config,json=oauth2Config,proto3,oneof"`}type IdentityProviderConfig_OidcConfig struct {+ // OIDC protocol configuration.OidcConfig *OIDCIdentityProviderConfig `protobuf:"bytes,2,opt,name=oidc_config,json=oidcConfig,proto3,oneof"`}type IdentityProviderConfig_LdapConfig struct {+ // LDAP protocol configuration.LdapConfig *LDAPIdentityProviderConfig `protobuf:"bytes,3,opt,name=ldap_config,json=ldapConfig,proto3,oneof"`}@@ -872,16 +885,25 @@ func (*IdentityProviderConfig_LdapConfig) isIdentityProviderConfig_Config() {}// OAuth2IdentityProviderConfig is the structure for OAuth2 identity provider config.type OAuth2IdentityProviderConfig struct {- state protoimpl.MessageState `protogen:"open.v1"`- AuthUrl string `protobuf:"bytes,1,opt,name=auth_url,json=authUrl,proto3" json:"auth_url,omitempty"`- TokenUrl string `protobuf:"bytes,2,opt,name=token_url,json=tokenUrl,proto3" json:"token_url,omitempty"`- UserInfoUrl string `protobuf:"bytes,3,opt,name=user_info_url,json=userInfoUrl,proto3" json:"user_info_url,omitempty"`- ClientId string `protobuf:"bytes,4,opt,name=client_id,json=clientId,proto3" json:"client_id,omitempty"`- ClientSecret string `protobuf:"bytes,5,opt,name=client_secret,json=clientSecret,proto3" json:"client_secret,omitempty"`- Scopes []string `protobuf:"bytes,6,rep,name=scopes,proto3" json:"scopes,omitempty"`- FieldMapping *FieldMapping `protobuf:"bytes,7,opt,name=field_mapping,json=fieldMapping,proto3" json:"field_mapping,omitempty"`- SkipTlsVerify bool `protobuf:"varint,8,opt,name=skip_tls_verify,json=skipTlsVerify,proto3" json:"skip_tls_verify,omitempty"`- AuthStyle OAuth2AuthStyle `protobuf:"varint,9,opt,name=auth_style,json=authStyle,proto3,enum=bytebase.v1.OAuth2AuthStyle" json:"auth_style,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The authorization endpoint URL for OAuth2 flow.+ AuthUrl string `protobuf:"bytes,1,opt,name=auth_url,json=authUrl,proto3" json:"auth_url,omitempty"`+ // The token endpoint URL for exchanging authorization code.+ TokenUrl string `protobuf:"bytes,2,opt,name=token_url,json=tokenUrl,proto3" json:"token_url,omitempty"`+ // The user information endpoint URL.+ UserInfoUrl string `protobuf:"bytes,3,opt,name=user_info_url,json=userInfoUrl,proto3" json:"user_info_url,omitempty"`+ // The OAuth2 client identifier.+ ClientId string `protobuf:"bytes,4,opt,name=client_id,json=clientId,proto3" json:"client_id,omitempty"`+ // The OAuth2 client secret for authentication.+ ClientSecret string `protobuf:"bytes,5,opt,name=client_secret,json=clientSecret,proto3" json:"client_secret,omitempty"`+ // The list of OAuth2 scopes to request.+ Scopes []string `protobuf:"bytes,6,rep,name=scopes,proto3" json:"scopes,omitempty"`+ // Mapping configuration for user attributes from OAuth2 response.+ FieldMapping *FieldMapping `protobuf:"bytes,7,opt,name=field_mapping,json=fieldMapping,proto3" json:"field_mapping,omitempty"`+ // Whether to skip TLS certificate verification.+ SkipTlsVerify bool `protobuf:"varint,8,opt,name=skip_tls_verify,json=skipTlsVerify,proto3" json:"skip_tls_verify,omitempty"`+ // The authentication style for client credentials.+ AuthStyle OAuth2AuthStyle `protobuf:"varint,9,opt,name=auth_style,json=authStyle,proto3,enum=bytebase.v1.OAuth2AuthStyle" json:"auth_style,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -981,16 +1003,22 @@ func (x *OAuth2IdentityProviderConfig) GetAuthStyle() OAuth2AuthStyle {// OIDCIdentityProviderConfig is the structure for OIDC identity provider config.type OIDCIdentityProviderConfig struct {- state protoimpl.MessageState `protogen:"open.v1"`- Issuer string `protobuf:"bytes,1,opt,name=issuer,proto3" json:"issuer,omitempty"`- ClientId string `protobuf:"bytes,2,opt,name=client_id,json=clientId,proto3" json:"client_id,omitempty"`- ClientSecret string `protobuf:"bytes,3,opt,name=client_secret,json=clientSecret,proto3" json:"client_secret,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The OIDC issuer URL for the identity provider.+ Issuer string `protobuf:"bytes,1,opt,name=issuer,proto3" json:"issuer,omitempty"`+ // The OIDC client identifier.+ ClientId string `protobuf:"bytes,2,opt,name=client_id,json=clientId,proto3" json:"client_id,omitempty"`+ // The OIDC client secret for authentication.+ ClientSecret string `protobuf:"bytes,3,opt,name=client_secret,json=clientSecret,proto3" json:"client_secret,omitempty"`// The scopes that the OIDC provider supports.// Should be fetched from the well-known configuration file of the OIDC provider.- Scopes []string `protobuf:"bytes,4,rep,name=scopes,proto3" json:"scopes,omitempty"`- FieldMapping *FieldMapping `protobuf:"bytes,5,opt,name=field_mapping,json=fieldMapping,proto3" json:"field_mapping,omitempty"`- SkipTlsVerify bool `protobuf:"varint,6,opt,name=skip_tls_verify,json=skipTlsVerify,proto3" json:"skip_tls_verify,omitempty"`- AuthStyle OAuth2AuthStyle `protobuf:"varint,7,opt,name=auth_style,json=authStyle,proto3,enum=bytebase.v1.OAuth2AuthStyle" json:"auth_style,omitempty"`+ Scopes []string `protobuf:"bytes,4,rep,name=scopes,proto3" json:"scopes,omitempty"`+ // Mapping configuration for user attributes from OIDC claims.+ FieldMapping *FieldMapping `protobuf:"bytes,5,opt,name=field_mapping,json=fieldMapping,proto3" json:"field_mapping,omitempty"`+ // Whether to skip TLS certificate verification.+ SkipTlsVerify bool `protobuf:"varint,6,opt,name=skip_tls_verify,json=skipTlsVerify,proto3" json:"skip_tls_verify,omitempty"`+ // The authentication style for client credentials.+ AuthStyle OAuth2AuthStyle `protobuf:"varint,7,opt,name=auth_style,json=authStyle,proto3,enum=bytebase.v1.OAuth2AuthStyle" json:"auth_style,omitempty"`// The authorization endpoint of the OIDC provider.// Should be fetched from the well-known configuration file of the OIDC provider.AuthEndpoint string `protobuf:"bytes,8,opt,name=auth_endpoint,json=authEndpoint,proto3" json:"auth_endpoint,omitempty"`diff --git a/backend/generated-go/v1/idp_service_grpc.pb.go b/backend/generated-go/v1/idp_service_grpc.pb.goindex 8f2d86d6b1..06168748bc 100644--- a/backend/generated-go/v1/idp_service_grpc.pb.go+++ b/backend/generated-go/v1/idp_service_grpc.pb.go@@ -31,17 +31,25 @@ const (// IdentityProviderServiceClient is the client API for IdentityProviderService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// IdentityProviderService manages external identity providers for SSO authentication.type IdentityProviderServiceClient interface {+ // Gets an identity provider by name.// Permissions required: bb.identityProviders.getGetIdentityProvider(ctx context.Context, in *GetIdentityProviderRequest, opts ...grpc.CallOption) (*IdentityProvider, error)+ // Lists all configured identity providers (public endpoint for login page).// Permissions required: NoneListIdentityProviders(ctx context.Context, in *ListIdentityProvidersRequest, opts ...grpc.CallOption) (*ListIdentityProvidersResponse, error)+ // Creates a new identity provider.// Permissions required: bb.identityProviders.createCreateIdentityProvider(ctx context.Context, in *CreateIdentityProviderRequest, opts ...grpc.CallOption) (*IdentityProvider, error)+ // Updates an identity provider.// Permissions required: bb.identityProviders.updateUpdateIdentityProvider(ctx context.Context, in *UpdateIdentityProviderRequest, opts ...grpc.CallOption) (*IdentityProvider, error)+ // Deletes an identity provider.// Permissions required: bb.identityProviders.deleteDeleteIdentityProvider(ctx context.Context, in *DeleteIdentityProviderRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)+ // Tests the connection and configuration of an identity provider.// Permissions required: bb.identityProviders.updateTestIdentityProvider(ctx context.Context, in *TestIdentityProviderRequest, opts ...grpc.CallOption) (*TestIdentityProviderResponse, error)}@@ -117,17 +125,25 @@ func (c *identityProviderServiceClient) TestIdentityProvider(ctx context.Context// IdentityProviderServiceServer is the server API for IdentityProviderService service.// All implementations must embed UnimplementedIdentityProviderServiceServer// for forward compatibility.+//+// IdentityProviderService manages external identity providers for SSO authentication.type IdentityProviderServiceServer interface {+ // Gets an identity provider by name.// Permissions required: bb.identityProviders.getGetIdentityProvider(context.Context, *GetIdentityProviderRequest) (*IdentityProvider, error)+ // Lists all configured identity providers (public endpoint for login page).// Permissions required: NoneListIdentityProviders(context.Context, *ListIdentityProvidersRequest) (*ListIdentityProvidersResponse, error)+ // Creates a new identity provider.// Permissions required: bb.identityProviders.createCreateIdentityProvider(context.Context, *CreateIdentityProviderRequest) (*IdentityProvider, error)+ // Updates an identity provider.// Permissions required: bb.identityProviders.updateUpdateIdentityProvider(context.Context, *UpdateIdentityProviderRequest) (*IdentityProvider, error)+ // Deletes an identity provider.// Permissions required: bb.identityProviders.deleteDeleteIdentityProvider(context.Context, *DeleteIdentityProviderRequest) (*emptypb.Empty, error)+ // Tests the connection and configuration of an identity provider.// Permissions required: bb.identityProviders.updateTestIdentityProvider(context.Context, *TestIdentityProviderRequest) (*TestIdentityProviderResponse, error)mustEmbedUnimplementedIdentityProviderServiceServer()diff --git a/backend/generated-go/v1/instance_role_service_grpc.pb.go b/backend/generated-go/v1/instance_role_service_grpc.pb.goindex 986337b87c..35e2f22c77 100644--- a/backend/generated-go/v1/instance_role_service_grpc.pb.go+++ b/backend/generated-go/v1/instance_role_service_grpc.pb.go@@ -26,9 +26,13 @@ const (// InstanceRoleServiceClient is the client API for InstanceRoleService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// InstanceRoleService manages database roles within instances.type InstanceRoleServiceClient interface {+ // Gets a database role from an instance.// Permissions required: bb.instanceRoles.getGetInstanceRole(ctx context.Context, in *GetInstanceRoleRequest, opts ...grpc.CallOption) (*InstanceRole, error)+ // Lists all database roles in an instance.// Permissions required: bb.instanceRoles.listListInstanceRoles(ctx context.Context, in *ListInstanceRolesRequest, opts ...grpc.CallOption) (*ListInstanceRolesResponse, error)}@@ -64,9 +68,13 @@ func (c *instanceRoleServiceClient) ListInstanceRoles(ctx context.Context, in *L// InstanceRoleServiceServer is the server API for InstanceRoleService service.// All implementations must embed UnimplementedInstanceRoleServiceServer// for forward compatibility.+//+// InstanceRoleService manages database roles within instances.type InstanceRoleServiceServer interface {+ // Gets a database role from an instance.// Permissions required: bb.instanceRoles.getGetInstanceRole(context.Context, *GetInstanceRoleRequest) (*InstanceRole, error)+ // Lists all database roles in an instance.// Permissions required: bb.instanceRoles.listListInstanceRoles(context.Context, *ListInstanceRolesRequest) (*ListInstanceRolesResponse, error)mustEmbedUnimplementedInstanceRoleServiceServer()diff --git a/backend/generated-go/v1/instance_service.pb.go b/backend/generated-go/v1/instance_service.pb.goindex a53cb8952d..9c67e4b217 100644--- a/backend/generated-go/v1/instance_service.pb.go+++ b/backend/generated-go/v1/instance_service.pb.go@@ -29,9 +29,12 @@ const (type DataSourceType int32const (+ // Unspecified data source type.DataSourceType_DATA_SOURCE_UNSPECIFIED DataSourceType = 0- DataSourceType_ADMIN DataSourceType = 1- DataSourceType_READ_ONLY DataSourceType = 2+ // Admin data source with write permissions.+ DataSourceType_ADMIN DataSourceType = 1+ // Read-only data source for query operations.+ DataSourceType_READ_ONLY DataSourceType = 2)// Enum value maps for DataSourceType.@@ -78,6 +81,7 @@ func (DataSourceType) EnumDescriptor() ([]byte, []int) {type DataSourceExternalSecret_SecretType int32const (+ // Unspecified secret type.DataSourceExternalSecret_SAECRET_TYPE_UNSPECIFIED DataSourceExternalSecret_SecretType = 0// ref: https://developer.hashicorp.com/vault/api-docs/secret/kv/kv-v2DataSourceExternalSecret_VAULT_KV_V2 DataSourceExternalSecret_SecretType = 1@@ -133,6 +137,7 @@ func (DataSourceExternalSecret_SecretType) EnumDescriptor() ([]byte, []int) {type DataSourceExternalSecret_AuthType int32const (+ // Unspecified authentication type.DataSourceExternalSecret_AUTH_TYPE_UNSPECIFIED DataSourceExternalSecret_AuthType = 0// ref: https://developer.hashicorp.com/vault/docs/auth/tokenDataSourceExternalSecret_TOKEN DataSourceExternalSecret_AuthType = 1@@ -184,9 +189,12 @@ func (DataSourceExternalSecret_AuthType) EnumDescriptor() ([]byte, []int) {type DataSourceExternalSecret_AppRoleAuthOption_SecretType int32const (+ // Unspecified secret type.DataSourceExternalSecret_AppRoleAuthOption_SECRET_TYPE_UNSPECIFIED DataSourceExternalSecret_AppRoleAuthOption_SecretType = 0- DataSourceExternalSecret_AppRoleAuthOption_PLAIN DataSourceExternalSecret_AppRoleAuthOption_SecretType = 1- DataSourceExternalSecret_AppRoleAuthOption_ENVIRONMENT DataSourceExternalSecret_AppRoleAuthOption_SecretType = 2+ // Plain text secret.+ DataSourceExternalSecret_AppRoleAuthOption_PLAIN DataSourceExternalSecret_AppRoleAuthOption_SecretType = 1+ // Secret from environment variable.+ DataSourceExternalSecret_AppRoleAuthOption_ENVIRONMENT DataSourceExternalSecret_AppRoleAuthOption_SecretType = 2)// Enum value maps for DataSourceExternalSecret_AppRoleAuthOption_SecretType.@@ -1378,18 +1386,26 @@ type Instance struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the instance.// Format: instances/{instance}- Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`- State State `protobuf:"varint,3,opt,name=state,proto3,enum=bytebase.v1.State" json:"state,omitempty"`- Title string `protobuf:"bytes,4,opt,name=title,proto3" json:"title,omitempty"`- Engine Engine `protobuf:"varint,5,opt,name=engine,proto3,enum=bytebase.v1.Engine" json:"engine,omitempty"`- EngineVersion string `protobuf:"bytes,6,opt,name=engine_version,json=engineVersion,proto3" json:"engine_version,omitempty"`- ExternalLink string `protobuf:"bytes,7,opt,name=external_link,json=externalLink,proto3" json:"external_link,omitempty"`- DataSources []*DataSource `protobuf:"bytes,8,rep,name=data_sources,json=dataSources,proto3" json:"data_sources,omitempty"`+ Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`+ // The lifecycle state of the instance.+ State State `protobuf:"varint,3,opt,name=state,proto3,enum=bytebase.v1.State" json:"state,omitempty"`+ // The display title of the instance.+ Title string `protobuf:"bytes,4,opt,name=title,proto3" json:"title,omitempty"`+ // The database engine type.+ Engine Engine `protobuf:"varint,5,opt,name=engine,proto3,enum=bytebase.v1.Engine" json:"engine,omitempty"`+ // The version of the database engine.+ EngineVersion string `protobuf:"bytes,6,opt,name=engine_version,json=engineVersion,proto3" json:"engine_version,omitempty"`+ // External URL to the database instance console.+ ExternalLink string `protobuf:"bytes,7,opt,name=external_link,json=externalLink,proto3" json:"external_link,omitempty"`+ // Data source configurations for connecting to the instance.+ DataSources []*DataSource `protobuf:"bytes,8,rep,name=data_sources,json=dataSources,proto3" json:"data_sources,omitempty"`// The environment resource.// Format: environments/prod where prod is the environment resource ID.- Environment *string `protobuf:"bytes,9,opt,name=environment,proto3,oneof" json:"environment,omitempty"`- Activation bool `protobuf:"varint,10,opt,name=activation,proto3" json:"activation,omitempty"`- Roles []*InstanceRole `protobuf:"bytes,12,rep,name=roles,proto3" json:"roles,omitempty"`+ Environment *string `protobuf:"bytes,9,opt,name=environment,proto3,oneof" json:"environment,omitempty"`+ // Whether the instance is activated for use.+ Activation bool `protobuf:"varint,10,opt,name=activation,proto3" json:"activation,omitempty"`+ // Database roles available in this instance.+ Roles []*InstanceRole `protobuf:"bytes,12,rep,name=roles,proto3" json:"roles,omitempty"`// How often the instance is synced.SyncInterval *durationpb.Duration `protobuf:"bytes,13,opt,name=sync_interval,json=syncInterval,proto3" json:"sync_interval,omitempty"`// The maximum number of connections.@@ -1543,10 +1559,13 @@ func (x *Instance) GetLabels() map[string]string {}type DataSourceExternalSecret struct {- state protoimpl.MessageState `protogen:"open.v1"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The type of external secret store.SecretType DataSourceExternalSecret_SecretType `protobuf:"varint,1,opt,name=secret_type,json=secretType,proto3,enum=bytebase.v1.DataSourceExternalSecret_SecretType" json:"secret_type,omitempty"`- Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`- AuthType DataSourceExternalSecret_AuthType `protobuf:"varint,3,opt,name=auth_type,json=authType,proto3,enum=bytebase.v1.DataSourceExternalSecret_AuthType" json:"auth_type,omitempty"`+ // The URL of the external secret store.+ Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`+ // The authentication method for accessing the secret store.+ AuthType DataSourceExternalSecret_AuthType `protobuf:"varint,3,opt,name=auth_type,json=authType,proto3,enum=bytebase.v1.DataSourceExternalSecret_AuthType" json:"auth_type,omitempty"`// Types that are valid to be assigned to AuthOption://// *DataSourceExternalSecret_AppRole@@ -1664,10 +1683,12 @@ type isDataSourceExternalSecret_AuthOption interface {}type DataSourceExternalSecret_AppRole struct {+ // AppRole authentication configuration.AppRole *DataSourceExternalSecret_AppRoleAuthOption `protobuf:"bytes,4,opt,name=app_role,json=appRole,proto3,oneof"`}type DataSourceExternalSecret_Token struct {+ // Token for direct authentication.Token string `protobuf:"bytes,5,opt,name=token,proto3,oneof"`}@@ -1676,25 +1697,35 @@ func (*DataSourceExternalSecret_AppRole) isDataSourceExternalSecret_AuthOption()func (*DataSourceExternalSecret_Token) isDataSourceExternalSecret_AuthOption() {}type DataSource struct {- state protoimpl.MessageState `protogen:"open.v1"`- Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`- Type DataSourceType `protobuf:"varint,2,opt,name=type,proto3,enum=bytebase.v1.DataSourceType" json:"type,omitempty"`- Username string `protobuf:"bytes,3,opt,name=username,proto3" json:"username,omitempty"`- Password string `protobuf:"bytes,4,opt,name=password,proto3" json:"password,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The unique identifier for this data source.+ Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`+ // The type of data source (ADMIN or READ_ONLY).+ Type DataSourceType `protobuf:"varint,2,opt,name=type,proto3,enum=bytebase.v1.DataSourceType" json:"type,omitempty"`+ // The username for database authentication.+ Username string `protobuf:"bytes,3,opt,name=username,proto3" json:"username,omitempty"`+ // The password for database authentication.+ Password string `protobuf:"bytes,4,opt,name=password,proto3" json:"password,omitempty"`// Use SSL to connect to the data source. By default, we use system default SSL configuration.- UseSsl bool `protobuf:"varint,30,opt,name=use_ssl,json=useSsl,proto3" json:"use_ssl,omitempty"`- SslCa string `protobuf:"bytes,5,opt,name=ssl_ca,json=sslCa,proto3" json:"ssl_ca,omitempty"`+ UseSsl bool `protobuf:"varint,30,opt,name=use_ssl,json=useSsl,proto3" json:"use_ssl,omitempty"`+ // The SSL certificate authority certificate.+ SslCa string `protobuf:"bytes,5,opt,name=ssl_ca,json=sslCa,proto3" json:"ssl_ca,omitempty"`+ // The SSL client certificate.SslCert string `protobuf:"bytes,6,opt,name=ssl_cert,json=sslCert,proto3" json:"ssl_cert,omitempty"`- SslKey string `protobuf:"bytes,7,opt,name=ssl_key,json=sslKey,proto3" json:"ssl_key,omitempty"`+ // The SSL client private key.+ SslKey string `protobuf:"bytes,7,opt,name=ssl_key,json=sslKey,proto3" json:"ssl_key,omitempty"`// verify_tls_certificate enables TLS certificate verification for SSL connections.// Default is false (no verification) for backward compatibility.// Set to true for secure connections (recommended for production).// Only set to false for development or when certificates cannot be properly// validated (e.g., self-signed certs, VPN environments).- VerifyTlsCertificate bool `protobuf:"varint,39,opt,name=verify_tls_certificate,json=verifyTlsCertificate,proto3" json:"verify_tls_certificate,omitempty"`- 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"`+ VerifyTlsCertificate bool `protobuf:"varint,39,opt,name=verify_tls_certificate,json=verifyTlsCertificate,proto3" json:"verify_tls_certificate,omitempty"`+ // The hostname or IP address of the database server.+ Host string `protobuf:"bytes,8,opt,name=host,proto3" json:"host,omitempty"`+ // The port number of the database server.+ Port string `protobuf:"bytes,9,opt,name=port,proto3" json:"port,omitempty"`+ // The name of the database to connect to.+ Database string `protobuf:"bytes,10,opt,name=database,proto3" json:"database,omitempty"`// 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"`@@ -2093,12 +2124,17 @@ func (*DataSource_AwsCredential) isDataSource_IamExtension() {}func (*DataSource_GcpCredential) isDataSource_IamExtension() {}type InstanceResource struct {- state protoimpl.MessageState `protogen:"open.v1"`- Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`- Engine Engine `protobuf:"varint,2,opt,name=engine,proto3,enum=bytebase.v1.Engine" json:"engine,omitempty"`- EngineVersion string `protobuf:"bytes,3,opt,name=engine_version,json=engineVersion,proto3" json:"engine_version,omitempty"`- DataSources []*DataSource `protobuf:"bytes,4,rep,name=data_sources,json=dataSources,proto3" json:"data_sources,omitempty"`- Activation bool `protobuf:"varint,5,opt,name=activation,proto3" json:"activation,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The display title of the instance.+ Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`+ // The database engine type.+ Engine Engine `protobuf:"varint,2,opt,name=engine,proto3,enum=bytebase.v1.Engine" json:"engine,omitempty"`+ // The version of the database engine.+ EngineVersion string `protobuf:"bytes,3,opt,name=engine_version,json=engineVersion,proto3" json:"engine_version,omitempty"`+ // Data source configurations for the instance.+ DataSources []*DataSource `protobuf:"bytes,4,rep,name=data_sources,json=dataSources,proto3" json:"data_sources,omitempty"`+ // Whether the instance is activated.+ Activation bool `protobuf:"varint,5,opt,name=activation,proto3" json:"activation,omitempty"`// The name of the instance.// Format: instances/{instance}Name string `protobuf:"bytes,6,opt,name=name,proto3" json:"name,omitempty"`@@ -2249,20 +2285,28 @@ type isSASLConfig_Mechanism interface {}type SASLConfig_KrbConfig struct {+ // Kerberos authentication configuration.KrbConfig *KerberosConfig `protobuf:"bytes,1,opt,name=krb_config,json=krbConfig,proto3,oneof"`}func (*SASLConfig_KrbConfig) isSASLConfig_Mechanism() {}type KerberosConfig struct {- state protoimpl.MessageState `protogen:"open.v1"`- Primary string `protobuf:"bytes,1,opt,name=primary,proto3" json:"primary,omitempty"`- Instance string `protobuf:"bytes,2,opt,name=instance,proto3" json:"instance,omitempty"`- Realm string `protobuf:"bytes,3,opt,name=realm,proto3" json:"realm,omitempty"`- Keytab []byte `protobuf:"bytes,4,opt,name=keytab,proto3" json:"keytab,omitempty"`- KdcHost string `protobuf:"bytes,5,opt,name=kdc_host,json=kdcHost,proto3" json:"kdc_host,omitempty"`- KdcPort string `protobuf:"bytes,6,opt,name=kdc_port,json=kdcPort,proto3" json:"kdc_port,omitempty"`- KdcTransportProtocol string `protobuf:"bytes,7,opt,name=kdc_transport_protocol,json=kdcTransportProtocol,proto3" json:"kdc_transport_protocol,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The primary component of the Kerberos principal.+ Primary string `protobuf:"bytes,1,opt,name=primary,proto3" json:"primary,omitempty"`+ // The instance component of the Kerberos principal.+ Instance string `protobuf:"bytes,2,opt,name=instance,proto3" json:"instance,omitempty"`+ // The Kerberos realm.+ Realm string `protobuf:"bytes,3,opt,name=realm,proto3" json:"realm,omitempty"`+ // The keytab file contents for authentication.+ Keytab []byte `protobuf:"bytes,4,opt,name=keytab,proto3" json:"keytab,omitempty"`+ // The hostname of the Key Distribution Center (KDC).+ KdcHost string `protobuf:"bytes,5,opt,name=kdc_host,json=kdcHost,proto3" json:"kdc_host,omitempty"`+ // The port of the Key Distribution Center (KDC).+ KdcPort string `protobuf:"bytes,6,opt,name=kdc_port,json=kdcPort,proto3" json:"kdc_port,omitempty"`+ // The transport protocol for KDC communication (tcp or udp).+ KdcTransportProtocol string `protobuf:"bytes,7,opt,name=kdc_transport_protocol,json=kdcTransportProtocol,proto3" json:"kdc_transport_protocol,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -2347,11 +2391,13 @@ func (x *KerberosConfig) GetKdcTransportProtocol() 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"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The role ID for Vault AppRole authentication.+ RoleId string `protobuf:"bytes,1,opt,name=role_id,json=roleId,proto3" json:"role_id,omitempty"`// 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.v1.DataSourceExternalSecret_AppRoleAuthOption_SecretType" json:"type,omitempty"`+ SecretId string `protobuf:"bytes,2,opt,name=secret_id,json=secretId,proto3" json:"secret_id,omitempty"`+ // The type of secret for AppRole authentication.+ Type DataSourceExternalSecret_AppRoleAuthOption_SecretType `protobuf:"varint,3,opt,name=type,proto3,enum=bytebase.v1.DataSourceExternalSecret_AppRoleAuthOption_SecretType" json:"type,omitempty"`// The path where the approle auth method is mounted.MountPath string `protobuf:"bytes,4,opt,name=mount_path,json=mountPath,proto3" json:"mount_path,omitempty"`unknownFields protoimpl.UnknownFieldsdiff --git a/backend/generated-go/v1/instance_service_grpc.pb.go b/backend/generated-go/v1/instance_service_grpc.pb.goindex bf51229a09..adb5cc4637 100644--- a/backend/generated-go/v1/instance_service_grpc.pb.go+++ b/backend/generated-go/v1/instance_service_grpc.pb.go@@ -38,31 +38,46 @@ const (// InstanceServiceClient is the client API for InstanceService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// InstanceService manages database instances and their connections.type InstanceServiceClient interface {+ // Gets a database instance by name.// Permissions required: bb.instances.getGetInstance(ctx context.Context, in *GetInstanceRequest, opts ...grpc.CallOption) (*Instance, error)+ // Lists all database instances.// Permissions required: bb.instances.listListInstances(ctx context.Context, in *ListInstancesRequest, opts ...grpc.CallOption) (*ListInstancesResponse, error)+ // Creates a new database instance.// Permissions required: bb.instances.createCreateInstance(ctx context.Context, in *CreateInstanceRequest, opts ...grpc.CallOption) (*Instance, error)+ // Updates a database instance.// Permissions required: bb.instances.updateUpdateInstance(ctx context.Context, in *UpdateInstanceRequest, opts ...grpc.CallOption) (*Instance, error)+ // Deletes or soft-deletes a database instance.// Permissions required: bb.instances.deleteDeleteInstance(ctx context.Context, in *DeleteInstanceRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)+ // Restores a soft-deleted database instance.// Permissions required: bb.instances.undeleteUndeleteInstance(ctx context.Context, in *UndeleteInstanceRequest, opts ...grpc.CallOption) (*Instance, error)+ // Syncs database schemas and metadata from an instance.// Permissions required: bb.instances.syncSyncInstance(ctx context.Context, in *SyncInstanceRequest, opts ...grpc.CallOption) (*SyncInstanceResponse, error)+ // Lists all databases within an instance without creating them.// Permissions required: bb.instances.getListInstanceDatabase(ctx context.Context, in *ListInstanceDatabaseRequest, opts ...grpc.CallOption) (*ListInstanceDatabaseResponse, error)+ // Syncs multiple instances in a single request.// Permissions required: bb.instances.syncBatchSyncInstances(ctx context.Context, in *BatchSyncInstancesRequest, opts ...grpc.CallOption) (*BatchSyncInstancesResponse, error)+ // Updates multiple instances in a single request.// Permissions required: bb.instances.updateBatchUpdateInstances(ctx context.Context, in *BatchUpdateInstancesRequest, opts ...grpc.CallOption) (*BatchUpdateInstancesResponse, error)+ // Adds a read-only data source to an instance.// Permissions required: bb.instances.updateAddDataSource(ctx context.Context, in *AddDataSourceRequest, opts ...grpc.CallOption) (*Instance, error)+ // Removes a read-only data source from an instance.// Permissions required: bb.instances.updateRemoveDataSource(ctx context.Context, in *RemoveDataSourceRequest, opts ...grpc.CallOption) (*Instance, error)+ // Updates a data source configuration.// Permissions required: bb.instances.updateUpdateDataSource(ctx context.Context, in *UpdateDataSourceRequest, opts ...grpc.CallOption) (*Instance, error)}@@ -208,31 +223,46 @@ func (c *instanceServiceClient) UpdateDataSource(ctx context.Context, in *Update// InstanceServiceServer is the server API for InstanceService service.// All implementations must embed UnimplementedInstanceServiceServer// for forward compatibility.+//+// InstanceService manages database instances and their connections.type InstanceServiceServer interface {+ // Gets a database instance by name.// Permissions required: bb.instances.getGetInstance(context.Context, *GetInstanceRequest) (*Instance, error)+ // Lists all database instances.// Permissions required: bb.instances.listListInstances(context.Context, *ListInstancesRequest) (*ListInstancesResponse, error)+ // Creates a new database instance.// Permissions required: bb.instances.createCreateInstance(context.Context, *CreateInstanceRequest) (*Instance, error)+ // Updates a database instance.// Permissions required: bb.instances.updateUpdateInstance(context.Context, *UpdateInstanceRequest) (*Instance, error)+ // Deletes or soft-deletes a database instance.// Permissions required: bb.instances.deleteDeleteInstance(context.Context, *DeleteInstanceRequest) (*emptypb.Empty, error)+ // Restores a soft-deleted database instance.// Permissions required: bb.instances.undeleteUndeleteInstance(context.Context, *UndeleteInstanceRequest) (*Instance, error)+ // Syncs database schemas and metadata from an instance.// Permissions required: bb.instances.syncSyncInstance(context.Context, *SyncInstanceRequest) (*SyncInstanceResponse, error)+ // Lists all databases within an instance without creating them.// Permissions required: bb.instances.getListInstanceDatabase(context.Context, *ListInstanceDatabaseRequest) (*ListInstanceDatabaseResponse, error)+ // Syncs multiple instances in a single request.// Permissions required: bb.instances.syncBatchSyncInstances(context.Context, *BatchSyncInstancesRequest) (*BatchSyncInstancesResponse, error)+ // Updates multiple instances in a single request.// Permissions required: bb.instances.updateBatchUpdateInstances(context.Context, *BatchUpdateInstancesRequest) (*BatchUpdateInstancesResponse, error)+ // Adds a read-only data source to an instance.// Permissions required: bb.instances.updateAddDataSource(context.Context, *AddDataSourceRequest) (*Instance, error)+ // Removes a read-only data source from an instance.// Permissions required: bb.instances.updateRemoveDataSource(context.Context, *RemoveDataSourceRequest) (*Instance, error)+ // Updates a data source configuration.// Permissions required: bb.instances.updateUpdateDataSource(context.Context, *UpdateDataSourceRequest) (*Instance, error)mustEmbedUnimplementedInstanceServiceServer()diff --git a/backend/generated-go/v1/issue_service.pb.go b/backend/generated-go/v1/issue_service.pb.goindex a389ffea9d..52c5cb94f0 100644--- a/backend/generated-go/v1/issue_service.pb.go+++ b/backend/generated-go/v1/issue_service.pb.go@@ -26,13 +26,18 @@ const (_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20))+// The status of an issue.type IssueStatus int32const (+ // Unspecified status.IssueStatus_ISSUE_STATUS_UNSPECIFIED IssueStatus = 0- IssueStatus_OPEN IssueStatus = 1- IssueStatus_DONE IssueStatus = 2- IssueStatus_CANCELED IssueStatus = 3+ // Issue is open and active.+ IssueStatus_OPEN IssueStatus = 1+ // Issue is completed.+ IssueStatus_DONE IssueStatus = 2+ // Issue is canceled.+ IssueStatus_CANCELED IssueStatus = 3)// Enum value maps for IssueStatus.@@ -78,13 +83,18 @@ func (IssueStatus) EnumDescriptor() ([]byte, []int) {return file_v1_issue_service_proto_rawDescGZIP(), []int{0}}+// The type of issue.type Issue_Type int32const (+ // Unspecified issue type.Issue_TYPE_UNSPECIFIED Issue_Type = 0- Issue_DATABASE_CHANGE Issue_Type = 1- Issue_GRANT_REQUEST Issue_Type = 2- Issue_DATABASE_EXPORT Issue_Type = 3+ // Database schema or data change.+ Issue_DATABASE_CHANGE Issue_Type = 1+ // Database access grant request.+ Issue_GRANT_REQUEST Issue_Type = 2+ // Database data export request.+ Issue_DATABASE_EXPORT Issue_Type = 3)// Enum value maps for Issue_Type.@@ -130,16 +140,24 @@ func (Issue_Type) EnumDescriptor() ([]byte, []int) {return file_v1_issue_service_proto_rawDescGZIP(), []int{12, 0}}+// The overall approval status for the issue.type Issue_ApprovalStatus int32const (+ // Unspecified approval status.Issue_APPROVAL_STATUS_UNSPECIFIED Issue_ApprovalStatus = 0- Issue_CHECKING Issue_ApprovalStatus = 1- Issue_PENDING Issue_ApprovalStatus = 2- Issue_APPROVED Issue_ApprovalStatus = 3- Issue_REJECTED Issue_ApprovalStatus = 4- Issue_SKIPPED Issue_ApprovalStatus = 5- Issue_ERROR Issue_ApprovalStatus = 6+ // Approval checks are being evaluated.+ Issue_CHECKING Issue_ApprovalStatus = 1+ // Approval is pending.+ Issue_PENDING Issue_ApprovalStatus = 2+ // Issue has been approved.+ Issue_APPROVED Issue_ApprovalStatus = 3+ // Issue has been rejected.+ Issue_REJECTED Issue_ApprovalStatus = 4+ // Approval was skipped.+ Issue_SKIPPED Issue_ApprovalStatus = 5+ // Error occurred during approval evaluation.+ Issue_ERROR Issue_ApprovalStatus = 6)// Enum value maps for Issue_ApprovalStatus.@@ -191,13 +209,18 @@ func (Issue_ApprovalStatus) EnumDescriptor() ([]byte, []int) {return file_v1_issue_service_proto_rawDescGZIP(), []int{12, 1}}+// The approval status of an approver.type Issue_Approver_Status int32const (+ // Unspecified status.Issue_Approver_STATUS_UNSPECIFIED Issue_Approver_Status = 0- Issue_Approver_PENDING Issue_Approver_Status = 1- Issue_Approver_APPROVED Issue_Approver_Status = 2- Issue_Approver_REJECTED Issue_Approver_Status = 3+ // Awaiting approval.+ Issue_Approver_PENDING Issue_Approver_Status = 1+ // Approved.+ Issue_Approver_APPROVED Issue_Approver_Status = 2+ // Rejected.+ Issue_Approver_REJECTED Issue_Approver_Status = 3)// Enum value maps for Issue_Approver_Status.@@ -243,13 +266,18 @@ func (Issue_Approver_Status) EnumDescriptor() ([]byte, []int) {return file_v1_issue_service_proto_rawDescGZIP(), []int{12, 0, 0}}+// Approval status values.type IssueComment_Approval_Status int32const (+ // Unspecified status.IssueComment_Approval_STATUS_UNSPECIFIED IssueComment_Approval_Status = 0- IssueComment_Approval_PENDING IssueComment_Approval_Status = 1- IssueComment_Approval_APPROVED IssueComment_Approval_Status = 2- IssueComment_Approval_REJECTED IssueComment_Approval_Status = 3+ // Approval pending.+ IssueComment_Approval_PENDING IssueComment_Approval_Status = 1+ // Approved.+ IssueComment_Approval_APPROVED IssueComment_Approval_Status = 2+ // Rejected.+ IssueComment_Approval_REJECTED IssueComment_Approval_Status = 3)// Enum value maps for IssueComment_Approval_Status.@@ -295,16 +323,24 @@ func (IssueComment_Approval_Status) EnumDescriptor() ([]byte, []int) {return file_v1_issue_service_proto_rawDescGZIP(), []int{20, 0, 0}}+// Task status values.type IssueComment_TaskUpdate_Status int32const (+ // Unspecified status.IssueComment_TaskUpdate_STATUS_UNSPECIFIED IssueComment_TaskUpdate_Status = 0- IssueComment_TaskUpdate_PENDING IssueComment_TaskUpdate_Status = 1- IssueComment_TaskUpdate_RUNNING IssueComment_TaskUpdate_Status = 2- IssueComment_TaskUpdate_DONE IssueComment_TaskUpdate_Status = 3- IssueComment_TaskUpdate_FAILED IssueComment_TaskUpdate_Status = 4- IssueComment_TaskUpdate_SKIPPED IssueComment_TaskUpdate_Status = 5- IssueComment_TaskUpdate_CANCELED IssueComment_TaskUpdate_Status = 6+ // Task is pending.+ IssueComment_TaskUpdate_PENDING IssueComment_TaskUpdate_Status = 1+ // Task is running.+ IssueComment_TaskUpdate_RUNNING IssueComment_TaskUpdate_Status = 2+ // Task is done.+ IssueComment_TaskUpdate_DONE IssueComment_TaskUpdate_Status = 3+ // Task failed.+ IssueComment_TaskUpdate_FAILED IssueComment_TaskUpdate_Status = 4+ // Task was skipped.+ IssueComment_TaskUpdate_SKIPPED IssueComment_TaskUpdate_Status = 5+ // Task was canceled.+ IssueComment_TaskUpdate_CANCELED IssueComment_TaskUpdate_Status = 6)// Enum value maps for IssueComment_TaskUpdate_Status.@@ -360,8 +396,9 @@ type GetIssueRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the issue to retrieve.// Format: projects/{project}/issues/{issue}- Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`- Force bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`+ Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`+ // If set to true, bypass cache and fetch the latest data.+ Force bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -852,8 +889,9 @@ type BatchUpdateIssuesStatusRequest struct {// Format: projects/{project}/issues/{issue}Issues []string `protobuf:"bytes,2,rep,name=issues,proto3" json:"issues,omitempty"`// The new status.- Status IssueStatus `protobuf:"varint,3,opt,name=status,proto3,enum=bytebase.v1.IssueStatus" json:"status,omitempty"`- Reason string `protobuf:"bytes,4,opt,name=reason,proto3" json:"reason,omitempty"`+ Status IssueStatus `protobuf:"varint,3,opt,name=status,proto3,enum=bytebase.v1.IssueStatus" json:"status,omitempty"`+ // The reason for the status change.+ Reason string `protobuf:"bytes,4,opt,name=reason,proto3" json:"reason,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -956,7 +994,8 @@ type ApproveIssueRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the issue to add an approver.// Format: projects/{project}/issues/{issue}- 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 comment explaining the approval decision.Comment string `protobuf:"bytes,2,opt,name=comment,proto3" json:"comment,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -1010,7 +1049,8 @@ type RejectIssueRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the issue to add an rejection.// Format: projects/{project}/issues/{issue}- 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 comment explaining the rejection decision.Comment string `protobuf:"bytes,2,opt,name=comment,proto3" json:"comment,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -1064,7 +1104,8 @@ type RequestIssueRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the issue to request a issue.// Format: projects/{project}/issues/{issue}- 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 comment explaining the request.Comment string `protobuf:"bytes,2,opt,name=comment,proto3" json:"comment,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -1118,12 +1159,16 @@ type Issue struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the issue.// Format: projects/{project}/issues/{issue}- Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`- Title string `protobuf:"bytes,3,opt,name=title,proto3" json:"title,omitempty"`- Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`- Type Issue_Type `protobuf:"varint,5,opt,name=type,proto3,enum=bytebase.v1.Issue_Type" json:"type,omitempty"`- Status IssueStatus `protobuf:"varint,6,opt,name=status,proto3,enum=bytebase.v1.IssueStatus" json:"status,omitempty"`- Approvers []*Issue_Approver `protobuf:"bytes,9,rep,name=approvers,proto3" json:"approvers,omitempty"`+ Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`+ // The title of the issue.+ Title string `protobuf:"bytes,3,opt,name=title,proto3" json:"title,omitempty"`+ // The description of the issue.+ Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`+ Type Issue_Type `protobuf:"varint,5,opt,name=type,proto3,enum=bytebase.v1.Issue_Type" json:"type,omitempty"`+ // The status of the issue.+ Status IssueStatus `protobuf:"varint,6,opt,name=status,proto3,enum=bytebase.v1.IssueStatus" json:"status,omitempty"`+ Approvers []*Issue_Approver `protobuf:"bytes,9,rep,name=approvers,proto3" json:"approvers,omitempty"`+ // The approval template for the issue.ApprovalTemplate *ApprovalTemplate `protobuf:"bytes,10,opt,name=approval_template,json=approvalTemplate,proto3" json:"approval_template,omitempty"`// Format: users/[email protected]Creator string `protobuf:"bytes,14,opt,name=creator,proto3" json:"creator,omitempty"`@@ -1147,7 +1192,8 @@ type Issue struct {// - roles/projectOwner// - roles/projectReleaser// - users/{email}- Releasers []string `protobuf:"bytes,20,rep,name=releasers,proto3" json:"releasers,omitempty"`+ Releasers []string `protobuf:"bytes,20,rep,name=releasers,proto3" json:"releasers,omitempty"`+ // The risk level of the issue.RiskLevel RiskLevel `protobuf:"varint,21,opt,name=risk_level,json=riskLevel,proto3,enum=bytebase.v1.RiskLevel" json:"risk_level,omitempty"`// The status count of the issue.// Keys are the following:@@ -1158,9 +1204,10 @@ type Issue struct {// - DONE// - FAILED// - CANCELED- TaskStatusCount map[string]int32 `protobuf:"bytes,22,rep,name=task_status_count,json=taskStatusCount,proto3" json:"task_status_count,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"varint,2,opt,name=value"`- Labels []string `protobuf:"bytes,23,rep,name=labels,proto3" json:"labels,omitempty"`- ApprovalStatus Issue_ApprovalStatus `protobuf:"varint,24,opt,name=approval_status,json=approvalStatus,proto3,enum=bytebase.v1.Issue_ApprovalStatus" json:"approval_status,omitempty"`+ TaskStatusCount map[string]int32 `protobuf:"bytes,22,rep,name=task_status_count,json=taskStatusCount,proto3" json:"task_status_count,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"varint,2,opt,name=value"`+ // Labels attached to the issue for categorization and filtering.+ Labels []string `protobuf:"bytes,23,rep,name=labels,proto3" json:"labels,omitempty"`+ ApprovalStatus Issue_ApprovalStatus `protobuf:"varint,24,opt,name=approval_status,json=approvalStatus,proto3,enum=bytebase.v1.Issue_ApprovalStatus" json:"approval_status,omitempty"`// Only populated when approval_status == ERRORApprovalStatusError string `protobuf:"bytes,25,opt,name=approval_status_error,json=approvalStatusError,proto3" json:"approval_status_error,omitempty"`unknownFields protoimpl.UnknownFields@@ -1339,7 +1386,8 @@ type GrantRequest struct {// 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.- Condition *expr.Expr `protobuf:"bytes,3,opt,name=condition,proto3" json:"condition,omitempty"`+ 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"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -1408,10 +1456,13 @@ type ApprovalTemplate struct {// 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"`+ Id string `protobuf:"bytes,4,opt,name=id,proto3" json:"id,omitempty"`+ // The approval flow definition.+ Flow *ApprovalFlow `protobuf:"bytes,1,opt,name=flow,proto3" json:"flow,omitempty"`+ // The title of the approval template.+ Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`+ // The description of the approval template.+ Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -1475,8 +1526,9 @@ func (x *ApprovalTemplate) GetDescription() string {}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"`+ // The roles required for approval in order.+ Roles []string `protobuf:"bytes,1,rep,name=roles,proto3" json:"roles,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -1589,8 +1641,9 @@ func (x *ListIssueCommentsRequest) GetPageToken() string {}type ListIssueCommentsResponse struct {- state protoimpl.MessageState `protogen:"open.v1"`- IssueComments []*IssueComment `protobuf:"bytes,1,rep,name=issue_comments,json=issueComments,proto3" json:"issue_comments,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The issue comments from the specified request.+ IssueComments []*IssueComment `protobuf:"bytes,1,rep,name=issue_comments,json=issueComments,proto3" json:"issue_comments,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.NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`@@ -1646,7 +1699,8 @@ type CreateIssueCommentRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The issue name// Format: projects/{project}/issues/{issue}- Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`+ Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`+ // The comment to create.IssueComment *IssueComment `protobuf:"bytes,2,opt,name=issue_comment,json=issueComment,proto3" json:"issue_comment,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -1700,7 +1754,8 @@ type UpdateIssueCommentRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The issue name// Format: projects/{project}/issues/{issue}- Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`+ Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`+ // The comment to update.IssueComment *IssueComment `protobuf:"bytes,2,opt,name=issue_comment,json=issueComment,proto3" json:"issue_comment,omitempty"`// The list of fields to update.UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`@@ -1769,10 +1824,12 @@ func (x *UpdateIssueCommentRequest) GetAllowMissing() bool {return false}+// A comment on an issue.type IssueComment struct {state protoimpl.MessageState `protogen:"open.v1"`// Format: projects/{project}/issues/{issue}/issueComments/{issueComment-uid}- 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 text content of the comment.Comment string `protobuf:"bytes,2,opt,name=comment,proto3" json:"comment,omitempty"`// TODO: use struct message instead.Payload string `protobuf:"bytes,3,opt,name=payload,proto3" json:"payload,omitempty"`@@ -1780,6 +1837,8 @@ type IssueComment struct {UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`// Format: users/{email}Creator string `protobuf:"bytes,7,opt,name=creator,proto3" json:"creator,omitempty"`+ // The event associated with this comment.+ //// Types that are valid to be assigned to Event://// *IssueComment_Approval_@@ -1921,22 +1980,27 @@ type isIssueComment_Event interface {}type IssueComment_Approval_ struct {+ // Approval event.Approval *IssueComment_Approval `protobuf:"bytes,8,opt,name=approval,proto3,oneof"`}type IssueComment_IssueUpdate_ struct {+ // Issue update event.IssueUpdate *IssueComment_IssueUpdate `protobuf:"bytes,9,opt,name=issue_update,json=issueUpdate,proto3,oneof"`}type IssueComment_StageEnd_ struct {+ // Stage end event.StageEnd *IssueComment_StageEnd `protobuf:"bytes,10,opt,name=stage_end,json=stageEnd,proto3,oneof"`}type IssueComment_TaskUpdate_ struct {+ // Task update event.TaskUpdate *IssueComment_TaskUpdate `protobuf:"bytes,11,opt,name=task_update,json=taskUpdate,proto3,oneof"`}type IssueComment_TaskPriorBackup_ struct {+ // Task prior backup event.TaskPriorBackup *IssueComment_TaskPriorBackup `protobuf:"bytes,12,opt,name=task_prior_backup,json=taskPriorBackup,proto3,oneof"`}@@ -1950,6 +2014,7 @@ func (*IssueComment_TaskUpdate_) isIssueComment_Event() {}func (*IssueComment_TaskPriorBackup_) isIssueComment_Event() {}+// Approvers and their approval status for the issue.type Issue_Approver struct {state protoimpl.MessageState `protogen:"open.v1"`// The new status.@@ -2004,8 +2069,10 @@ func (x *Issue_Approver) GetPrincipal() string {return ""}+// Approval event information.type IssueComment_Approval struct {- state protoimpl.MessageState `protogen:"open.v1"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The approval status.Status IssueComment_Approval_Status `protobuf:"varint,1,opt,name=status,proto3,enum=bytebase.v1.IssueComment_Approval_Status" json:"status,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -2048,6 +2115,7 @@ func (x *IssueComment_Approval) GetStatus() IssueComment_Approval_Status {return IssueComment_Approval_STATUS_UNSPECIFIED}+// Issue update event information.type IssueComment_IssueUpdate struct {state protoimpl.MessageState `protogen:"open.v1"`FromTitle *string `protobuf:"bytes,1,opt,name=from_title,json=fromTitle,proto3,oneof" json:"from_title,omitempty"`@@ -2148,9 +2216,11 @@ func (x *IssueComment_IssueUpdate) GetToLabels() []string {return nil}+// Stage end event information.type IssueComment_StageEnd struct {- state protoimpl.MessageState `protogen:"open.v1"`- Stage string `protobuf:"bytes,1,opt,name=stage,proto3" json:"stage,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The stage that ended.+ Stage string `protobuf:"bytes,1,opt,name=stage,proto3" json:"stage,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -2192,9 +2262,11 @@ func (x *IssueComment_StageEnd) GetStage() string {return ""}+// Task update event information.type IssueComment_TaskUpdate struct {state protoimpl.MessageState `protogen:"open.v1"`- Tasks []string `protobuf:"bytes,1,rep,name=tasks,proto3" json:"tasks,omitempty"`+ // The tasks that were updated.+ Tasks []string `protobuf:"bytes,1,rep,name=tasks,proto3" json:"tasks,omitempty"`// Format: projects/{project}/sheets/{sheet}FromSheet *string `protobuf:"bytes,2,opt,name=from_sheet,json=fromSheet,proto3,oneof" json:"from_sheet,omitempty"`// Format: projects/{project}/sheets/{sheet}@@ -2262,13 +2334,19 @@ func (x *IssueComment_TaskUpdate) GetToStatus() IssueComment_TaskUpdate_Status {return IssueComment_TaskUpdate_STATUS_UNSPECIFIED}+// Task prior backup event information.type IssueComment_TaskPriorBackup struct {- state protoimpl.MessageState `protogen:"open.v1"`- Task string `protobuf:"bytes,1,opt,name=task,proto3" json:"task,omitempty"`- Tables []*IssueComment_TaskPriorBackup_Table `protobuf:"bytes,2,rep,name=tables,proto3" json:"tables,omitempty"`- OriginalLine *int32 `protobuf:"varint,3,opt,name=original_line,json=originalLine,proto3,oneof" json:"original_line,omitempty"`- Database string `protobuf:"bytes,4,opt,name=database,proto3" json:"database,omitempty"`- Error string `protobuf:"bytes,5,opt,name=error,proto3" json:"error,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The task for which backup was performed.+ Task string `protobuf:"bytes,1,opt,name=task,proto3" json:"task,omitempty"`+ // The tables that were backed up.+ Tables []*IssueComment_TaskPriorBackup_Table `protobuf:"bytes,2,rep,name=tables,proto3" json:"tables,omitempty"`+ // The original line number in the statement.+ OriginalLine *int32 `protobuf:"varint,3,opt,name=original_line,json=originalLine,proto3,oneof" json:"original_line,omitempty"`+ // The database that was backed up.+ Database string `protobuf:"bytes,4,opt,name=database,proto3" json:"database,omitempty"`+ // Error message if backup failed.+ Error string `protobuf:"bytes,5,opt,name=error,proto3" json:"error,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -2338,10 +2416,13 @@ func (x *IssueComment_TaskPriorBackup) GetError() string {return ""}+// Table identification.type IssueComment_TaskPriorBackup_Table struct {- state protoimpl.MessageState `protogen:"open.v1"`- Schema string `protobuf:"bytes,1,opt,name=schema,proto3" json:"schema,omitempty"`- Table string `protobuf:"bytes,2,opt,name=table,proto3" json:"table,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The schema name.+ Schema string `protobuf:"bytes,1,opt,name=schema,proto3" json:"schema,omitempty"`+ // The table name.+ Table string `protobuf:"bytes,2,opt,name=table,proto3" json:"table,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}diff --git a/backend/generated-go/v1/issue_service_grpc.pb.go b/backend/generated-go/v1/issue_service_grpc.pb.goindex 04b6753520..3191d63a69 100644--- a/backend/generated-go/v1/issue_service_grpc.pb.go+++ b/backend/generated-go/v1/issue_service_grpc.pb.go@@ -36,37 +36,44 @@ const (// IssueServiceClient is the client API for IssueService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// IssueService manages issues for tracking database changes and tasks.type IssueServiceClient interface {+ // Retrieves an issue by name.// Permissions required: bb.issues.getGetIssue(ctx context.Context, in *GetIssueRequest, opts ...grpc.CallOption) (*Issue, error)+ // Creates a new issue for database changes or tasks.// Permissions required: bb.issues.createCreateIssue(ctx context.Context, in *CreateIssueRequest, opts ...grpc.CallOption) (*Issue, error)+ // Lists issues in a project.// Permissions required: bb.issues.listListIssues(ctx context.Context, in *ListIssuesRequest, opts ...grpc.CallOption) (*ListIssuesResponse, error)// Search for issues that the caller has the bb.issues.get permission on and also satisfy the specified filter & query.// Permissions required: bb.issues.getSearchIssues(ctx context.Context, in *SearchIssuesRequest, opts ...grpc.CallOption) (*SearchIssuesResponse, error)+ // Updates an issue's properties such as title, description, or labels.// Permissions required: bb.issues.updateUpdateIssue(ctx context.Context, in *UpdateIssueRequest, opts ...grpc.CallOption) (*Issue, error)+ // Lists comments on an issue.// Permissions required: bb.issueComments.listListIssueComments(ctx context.Context, in *ListIssueCommentsRequest, opts ...grpc.CallOption) (*ListIssueCommentsResponse, error)+ // Adds a comment to an issue.// Permissions required: bb.issueComments.createCreateIssueComment(ctx context.Context, in *CreateIssueCommentRequest, opts ...grpc.CallOption) (*IssueComment, error)+ // Updates an existing issue comment.// Permissions required: bb.issueComments.updateUpdateIssueComment(ctx context.Context, in *UpdateIssueCommentRequest, opts ...grpc.CallOption) (*IssueComment, error)+ // Updates the status of multiple issues in a single operation.// Permissions required: bb.issues.updateBatchUpdateIssuesStatus(ctx context.Context, in *BatchUpdateIssuesStatusRequest, opts ...grpc.CallOption) (*BatchUpdateIssuesStatusResponse, error)- // ApproveIssue approves the issue.- // The access is based on approval flow.- // Permissions required: None+ // Approves an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+ // Permissions required: None (determined by approval flow)ApproveIssue(ctx context.Context, in *ApproveIssueRequest, opts ...grpc.CallOption) (*Issue, error)- // RejectIssue rejects the issue.- // The access is based on approval flow.- // Permissions required: None+ // Rejects an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+ // Permissions required: None (determined by approval flow)RejectIssue(ctx context.Context, in *RejectIssueRequest, opts ...grpc.CallOption) (*Issue, error)- // RequestIssue requests the issue.- // The access is based on approval flow.- // Permissions required: None+ // Requests changes on an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+ // Permissions required: None (determined by approval flow)RequestIssue(ctx context.Context, in *RequestIssueRequest, opts ...grpc.CallOption) (*Issue, error)}@@ -201,37 +208,44 @@ func (c *issueServiceClient) RequestIssue(ctx context.Context, in *RequestIssueR// IssueServiceServer is the server API for IssueService service.// All implementations must embed UnimplementedIssueServiceServer// for forward compatibility.+//+// IssueService manages issues for tracking database changes and tasks.type IssueServiceServer interface {+ // Retrieves an issue by name.// Permissions required: bb.issues.getGetIssue(context.Context, *GetIssueRequest) (*Issue, error)+ // Creates a new issue for database changes or tasks.// Permissions required: bb.issues.createCreateIssue(context.Context, *CreateIssueRequest) (*Issue, error)+ // Lists issues in a project.// Permissions required: bb.issues.listListIssues(context.Context, *ListIssuesRequest) (*ListIssuesResponse, error)// Search for issues that the caller has the bb.issues.get permission on and also satisfy the specified filter & query.// Permissions required: bb.issues.getSearchIssues(context.Context, *SearchIssuesRequest) (*SearchIssuesResponse, error)+ // Updates an issue's properties such as title, description, or labels.// Permissions required: bb.issues.updateUpdateIssue(context.Context, *UpdateIssueRequest) (*Issue, error)+ // Lists comments on an issue.// Permissions required: bb.issueComments.listListIssueComments(context.Context, *ListIssueCommentsRequest) (*ListIssueCommentsResponse, error)+ // Adds a comment to an issue.// Permissions required: bb.issueComments.createCreateIssueComment(context.Context, *CreateIssueCommentRequest) (*IssueComment, error)+ // Updates an existing issue comment.// Permissions required: bb.issueComments.updateUpdateIssueComment(context.Context, *UpdateIssueCommentRequest) (*IssueComment, error)+ // Updates the status of multiple issues in a single operation.// Permissions required: bb.issues.updateBatchUpdateIssuesStatus(context.Context, *BatchUpdateIssuesStatusRequest) (*BatchUpdateIssuesStatusResponse, error)- // ApproveIssue approves the issue.- // The access is based on approval flow.- // Permissions required: None+ // Approves an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+ // Permissions required: None (determined by approval flow)ApproveIssue(context.Context, *ApproveIssueRequest) (*Issue, error)- // RejectIssue rejects the issue.- // The access is based on approval flow.- // Permissions required: None+ // Rejects an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+ // Permissions required: None (determined by approval flow)RejectIssue(context.Context, *RejectIssueRequest) (*Issue, error)- // RequestIssue requests the issue.- // The access is based on approval flow.- // Permissions required: None+ // Requests changes on an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+ // Permissions required: None (determined by approval flow)RequestIssue(context.Context, *RequestIssueRequest) (*Issue, error)mustEmbedUnimplementedIssueServiceServer()}diff --git a/backend/generated-go/v1/org_policy_service.pb.go b/backend/generated-go/v1/org_policy_service.pb.goindex 87cd6450be..349c793609 100644--- a/backend/generated-go/v1/org_policy_service.pb.go+++ b/backend/generated-go/v1/org_policy_service.pb.go@@ -26,16 +26,24 @@ const (_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20))+// The type of organizational policy.type PolicyType int32const (+ // Unspecified policy type.PolicyType_POLICY_TYPE_UNSPECIFIED PolicyType = 0- PolicyType_ROLLOUT_POLICY PolicyType = 11- PolicyType_MASKING_RULE PolicyType = 9- PolicyType_MASKING_EXCEPTION PolicyType = 10- PolicyType_TAG PolicyType = 13- PolicyType_DATA_SOURCE_QUERY PolicyType = 14- PolicyType_DATA_QUERY PolicyType = 16+ // Rollout deployment policy.+ PolicyType_ROLLOUT_POLICY PolicyType = 11+ // Data masking rule policy.+ PolicyType_MASKING_RULE PolicyType = 9+ // Data masking exception policy.+ PolicyType_MASKING_EXCEPTION PolicyType = 10+ // Resource tag policy.+ PolicyType_TAG PolicyType = 13+ // Data source query restrictions policy.+ PolicyType_DATA_SOURCE_QUERY PolicyType = 14+ // Query data access policy.+ PolicyType_DATA_QUERY PolicyType = 16)// Enum value maps for PolicyType.@@ -87,13 +95,18 @@ func (PolicyType) EnumDescriptor() ([]byte, []int) {return file_v1_org_policy_service_proto_rawDescGZIP(), []int{0}}+// The resource type that a policy can be attached to.type PolicyResourceType int32const (+ // Unspecified resource type.PolicyResourceType_RESOURCE_TYPE_UNSPECIFIED PolicyResourceType = 0- PolicyResourceType_WORKSPACE PolicyResourceType = 1- PolicyResourceType_ENVIRONMENT PolicyResourceType = 2- PolicyResourceType_PROJECT PolicyResourceType = 3+ // Workspace-level policy.+ PolicyResourceType_WORKSPACE PolicyResourceType = 1+ // Environment-level policy.+ PolicyResourceType_ENVIRONMENT PolicyResourceType = 2+ // Project-level policy.+ PolicyResourceType_PROJECT PolicyResourceType = 3)// Enum value maps for PolicyResourceType.@@ -139,13 +152,18 @@ func (PolicyResourceType) EnumDescriptor() ([]byte, []int) {return file_v1_org_policy_service_proto_rawDescGZIP(), []int{1}}+// The severity level for SQL review rules.type SQLReviewRuleLevel int32const (+ // Unspecified level.SQLReviewRuleLevel_LEVEL_UNSPECIFIED SQLReviewRuleLevel = 0- SQLReviewRuleLevel_ERROR SQLReviewRuleLevel = 1- SQLReviewRuleLevel_WARNING SQLReviewRuleLevel = 2- SQLReviewRuleLevel_DISABLED SQLReviewRuleLevel = 3+ // Rule violation is an error.+ SQLReviewRuleLevel_ERROR SQLReviewRuleLevel = 1+ // Rule violation is a warning.+ SQLReviewRuleLevel_WARNING SQLReviewRuleLevel = 2+ // Rule is disabled.+ SQLReviewRuleLevel_DISABLED SQLReviewRuleLevel = 3)// Enum value maps for SQLReviewRuleLevel.@@ -243,12 +261,16 @@ func (RolloutPolicy_Checkers_PlanCheckEnforcement) EnumDescriptor() ([]byte, []ireturn file_v1_org_policy_service_proto_rawDescGZIP(), []int{7, 0, 0}}+// The action that the exception permits.type MaskingExceptionPolicy_MaskingException_Action int32const (+ // Unspecified action.MaskingExceptionPolicy_MaskingException_ACTION_UNSPECIFIED MaskingExceptionPolicy_MaskingException_Action = 0- MaskingExceptionPolicy_MaskingException_QUERY MaskingExceptionPolicy_MaskingException_Action = 1- MaskingExceptionPolicy_MaskingException_EXPORT MaskingExceptionPolicy_MaskingException_Action = 2+ // Allow querying sensitive data.+ MaskingExceptionPolicy_MaskingException_QUERY MaskingExceptionPolicy_MaskingException_Action = 1+ // Allow exporting sensitive data.+ MaskingExceptionPolicy_MaskingException_EXPORT MaskingExceptionPolicy_MaskingException_Action = 2)// Enum value maps for MaskingExceptionPolicy_MaskingException_Action.@@ -292,13 +314,15 @@ func (MaskingExceptionPolicy_MaskingException_Action) EnumDescriptor() ([]byte,return file_v1_org_policy_service_proto_rawDescGZIP(), []int{10, 0, 0}}+// Restriction level for admin data source access.type DataSourceQueryPolicy_Restriction int32const (+ // Unspecified restriction.DataSourceQueryPolicy_RESTRICTION_UNSPECIFIED DataSourceQueryPolicy_Restriction = 0- // Allow to query admin data sources when there is no read-only data source.+ // Allow querying admin data sources when there is no read-only data source.DataSourceQueryPolicy_FALLBACK DataSourceQueryPolicy_Restriction = 1- // Disallow to query admin data sources.+ // Disallow querying admin data sources.DataSourceQueryPolicy_DISALLOW DataSourceQueryPolicy_Restriction = 2)@@ -352,7 +376,8 @@ type CreatePolicyRequest struct {// Database resource name: instances/instance-id/databases/database-name.Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`// The policy to create.- Policy *Policy `protobuf:"bytes,2,opt,name=policy,proto3" json:"policy,omitempty"`+ Policy *Policy `protobuf:"bytes,2,opt,name=policy,proto3" json:"policy,omitempty"`+ // The type of policy to create.Type PolicyType `protobuf:"varint,3,opt,name=type,proto3,enum=bytebase.v1.PolicyType" json:"type,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -580,15 +605,16 @@ type ListPoliciesRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The parent, which owns this collection of policies.// Format: {resource type}/{resource id}- Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`+ Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`+ // Filter by specific policy type.PolicyType *PolicyType `protobuf:"varint,2,opt,name=policy_type,json=policyType,proto3,enum=bytebase.v1.PolicyType,oneof" json:"policy_type,omitempty"`- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// The maximum number of policies to return. The service may return fewer than// this value.// If unspecified, at most 10 policies will be returned.// The maximum value is 1000; values above 1000 will be coerced to 1000.PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// A page token, received from a previous `ListPolicies` call.// Provide this to retrieve the subsequent page.//@@ -729,9 +755,13 @@ type Policy struct {// Environment resource name: environments/environment-id.// Instance resource name: instances/instance-id.// Database resource name: instances/instance-id/databases/database-name.- Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`- InheritFromParent bool `protobuf:"varint,4,opt,name=inherit_from_parent,json=inheritFromParent,proto3" json:"inherit_from_parent,omitempty"`- Type PolicyType `protobuf:"varint,5,opt,name=type,proto3,enum=bytebase.v1.PolicyType" json:"type,omitempty"`+ Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`+ // Whether this policy inherits from its parent resource.+ InheritFromParent bool `protobuf:"varint,4,opt,name=inherit_from_parent,json=inheritFromParent,proto3" json:"inherit_from_parent,omitempty"`+ // The type of policy.+ Type PolicyType `protobuf:"varint,5,opt,name=type,proto3,enum=bytebase.v1.PolicyType" json:"type,omitempty"`+ // The policy configuration.+ //// Types that are valid to be assigned to Policy://// *Policy_RolloutPolicy@@ -740,8 +770,9 @@ type Policy struct {// *Policy_TagPolicy// *Policy_DataSourceQueryPolicy// *Policy_QueryDataPolicy- Policy isPolicy_Policy `protobuf_oneof:"policy"`- Enforce bool `protobuf:"varint,13,opt,name=enforce,proto3" json:"enforce,omitempty"`+ Policy isPolicy_Policy `protobuf_oneof:"policy"`+ // Whether the policy is enforced.+ Enforce bool `protobuf:"varint,13,opt,name=enforce,proto3" json:"enforce,omitempty"`// The resource type for the policy.ResourceType PolicyResourceType `protobuf:"varint,14,opt,name=resource_type,json=resourceType,proto3,enum=bytebase.v1.PolicyResourceType" json:"resource_type,omitempty"`unknownFields protoimpl.UnknownFields@@ -914,10 +945,13 @@ func (*Policy_DataSourceQueryPolicy) isPolicy_Policy() {}func (*Policy_QueryDataPolicy) isPolicy_Policy() {}+// Rollout policy configuration.type RolloutPolicy struct {- state protoimpl.MessageState `protogen:"open.v1"`- Automatic bool `protobuf:"varint,1,opt,name=automatic,proto3" json:"automatic,omitempty"`- Roles []string `protobuf:"bytes,2,rep,name=roles,proto3" json:"roles,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // Whether rollout is automatic without manual approval.+ Automatic bool `protobuf:"varint,1,opt,name=automatic,proto3" json:"automatic,omitempty"`+ // The roles that can approve rollout execution.+ Roles []string `protobuf:"bytes,2,rep,name=roles,proto3" json:"roles,omitempty"`// Checkers that must pass before rollout execution.// These checks are performed in UI workflows only.Checkers *RolloutPolicy_Checkers `protobuf:"bytes,4,opt,name=checkers,proto3" json:"checkers,omitempty"`@@ -981,15 +1015,15 @@ 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 data export 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 maximum result size limit in bytes.// The default value is 100MB, we will use the default value if the setting not exists, or the limit <= 0.MaximumResultSize int64 `protobuf:"varint,3,opt,name=maximum_result_size,json=maximumResultSize,proto3" json:"maximum_result_size,omitempty"`- // The return rows limit.+ // The maximum number of rows to return.// The default value is -1, means no limit.MaximumResultRows int32 `protobuf:"varint,4,opt,name=maximum_result_rows,json=maximumResultRows,proto3" json:"maximum_result_rows,omitempty"`- // Disable copying data.+ // Disable copying query results.DisableCopyData bool `protobuf:"varint,5,opt,name=disable_copy_data,json=disableCopyData,proto3" json:"disable_copy_data,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -1060,14 +1094,18 @@ func (x *QueryDataPolicy) GetDisableCopyData() bool {return false}-// The SQL review rules. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.+// SQL review rule configuration. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.type SQLReviewRule struct {state protoimpl.MessageState `protogen:"open.v1"`- Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`- Level SQLReviewRuleLevel `protobuf:"varint,2,opt,name=level,proto3,enum=bytebase.v1.SQLReviewRuleLevel" json:"level,omitempty"`+ // The type of SQL review rule.+ Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`+ // The severity level of the rule.+ Level SQLReviewRuleLevel `protobuf:"varint,2,opt,name=level,proto3,enum=bytebase.v1.SQLReviewRuleLevel" json:"level,omitempty"`// The payload is a JSON string that varies by rule type.- Payload string `protobuf:"bytes,3,opt,name=payload,proto3" json:"payload,omitempty"`- Engine Engine `protobuf:"varint,4,opt,name=engine,proto3,enum=bytebase.v1.Engine" json:"engine,omitempty"`+ Payload string `protobuf:"bytes,3,opt,name=payload,proto3" json:"payload,omitempty"`+ // The database engine this rule applies to.+ Engine Engine `protobuf:"varint,4,opt,name=engine,proto3,enum=bytebase.v1.Engine" json:"engine,omitempty"`+ // Additional comment for the rule.Comment string `protobuf:"bytes,5,opt,name=comment,proto3" json:"comment,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -1140,7 +1178,8 @@ func (x *SQLReviewRule) GetComment() string {// MaskingExceptionPolicy is the allowlist of users who can access sensitive data.type MaskingExceptionPolicy struct {- state protoimpl.MessageState `protogen:"open.v1"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The list of masking exceptions.MaskingExceptions []*MaskingExceptionPolicy_MaskingException `protobuf:"bytes,1,rep,name=masking_exceptions,json=maskingExceptions,proto3" json:"masking_exceptions,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -1183,8 +1222,10 @@ func (x *MaskingExceptionPolicy) GetMaskingExceptions() []*MaskingExceptionPolicreturn nil}+// Policy for configuring data masking rules.type MaskingRulePolicy struct {- state protoimpl.MessageState `protogen:"open.v1"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The list of masking rules.Rules []*MaskingRulePolicy_MaskingRule `protobuf:"bytes,1,rep,name=rules,proto3" json:"rules,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -1227,6 +1268,7 @@ func (x *MaskingRulePolicy) GetRules() []*MaskingRulePolicy_MaskingRule {return nil}+// Policy for tagging resources with metadata.type TagPolicy struct {state protoimpl.MessageState `protogen:"open.v1"`// tags is the key - value map for resources.@@ -1273,9 +1315,10 @@ func (x *TagPolicy) GetTags() map[string]string {return nil}-// DataSourceQueryPolicy is the policy configuration for running statements in the SQL editor.+// Policy for controlling which data sources can be queried in the SQL editor.type DataSourceQueryPolicy struct {- state protoimpl.MessageState `protogen:"open.v1"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // Restriction for admin data source queries.AdminDataSourceRestriction DataSourceQueryPolicy_Restriction `protobuf:"varint,1,opt,name=admin_data_source_restriction,json=adminDataSourceRestriction,proto3,enum=bytebase.v1.DataSourceQueryPolicy_Restriction" json:"admin_data_source_restriction,omitempty"`// Disallow running DDL statements in the SQL editor.DisallowDdl bool `protobuf:"varint,2,opt,name=disallow_ddl,json=disallowDdl,proto3" json:"disallow_ddl,omitempty"`@@ -1435,9 +1478,10 @@ func (x *RolloutPolicy_Checkers_RequiredStatusChecks) GetPlanCheckEnforcement()return RolloutPolicy_Checkers_PLAN_CHECK_ENFORCEMENT_UNSPECIFIED}+// An exception allowing specific users to access masked data.type MaskingExceptionPolicy_MaskingException struct {state protoimpl.MessageState `protogen:"open.v1"`- // action is the action that the user can access sensitive data.+ // The action that the user can perform on sensitive data.Action MaskingExceptionPolicy_MaskingException_Action `protobuf:"varint,1,opt,name=action,proto3,enum=bytebase.v1.MaskingExceptionPolicy_MaskingException_Action" json:"action,omitempty"`// Member is the principal who bind to this exception policy instance.//@@ -1516,9 +1560,10 @@ func (x *MaskingExceptionPolicy_MaskingException) GetCondition() *expr.Expr {return nil}+// A rule that defines when and how to mask data.type MaskingRulePolicy_MaskingRule struct {state protoimpl.MessageState `protogen:"open.v1"`- // A unique identifier for a node in UUID format.+ // A unique identifier for the rule in UUID format.Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`// The condition for the masking rule.// The syntax and semantics of CEL are documented at https://github.com/google/cel-spec@@ -1543,8 +1588,9 @@ type MaskingRulePolicy_MaskingRule struct {// resource.instance_id == "sample-instance" && resource.database_name == "employee" && resource.table_name in ["table1", "table2"]// resource.environment_id != "test" || !(resource.project_id in ["poject1", "prject2"])// resource.instance_id == "sample-instance" && (resource.database_name == "db1" || resource.database_name == "db2")- Condition *expr.Expr `protobuf:"bytes,2,opt,name=condition,proto3" json:"condition,omitempty"`- SemanticType string `protobuf:"bytes,3,opt,name=semantic_type,json=semanticType,proto3" json:"semantic_type,omitempty"`+ Condition *expr.Expr `protobuf:"bytes,2,opt,name=condition,proto3" json:"condition,omitempty"`+ // The semantic type of data to mask (e.g., "SSN", "EMAIL").+ SemanticType string `protobuf:"bytes,3,opt,name=semantic_type,json=semanticType,proto3" json:"semantic_type,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}diff --git a/backend/generated-go/v1/org_policy_service_grpc.pb.go b/backend/generated-go/v1/org_policy_service_grpc.pb.goindex 729c34db4d..bd0627fe42 100644--- a/backend/generated-go/v1/org_policy_service_grpc.pb.go+++ b/backend/generated-go/v1/org_policy_service_grpc.pb.go@@ -30,15 +30,22 @@ const (// OrgPolicyServiceClient is the client API for OrgPolicyService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// OrgPolicyService manages organizational policies at various resource levels.type OrgPolicyServiceClient interface {+ // Retrieves a policy by name.// Permissions required: bb.policies.getGetPolicy(ctx context.Context, in *GetPolicyRequest, opts ...grpc.CallOption) (*Policy, error)+ // Lists policies at a specified resource level.// Permissions required: bb.policies.listListPolicies(ctx context.Context, in *ListPoliciesRequest, opts ...grpc.CallOption) (*ListPoliciesResponse, error)+ // Creates a new organizational policy.// Permissions required: bb.policies.createCreatePolicy(ctx context.Context, in *CreatePolicyRequest, opts ...grpc.CallOption) (*Policy, error)+ // Updates an existing organizational policy.// Permissions required: bb.policies.updateUpdatePolicy(ctx context.Context, in *UpdatePolicyRequest, opts ...grpc.CallOption) (*Policy, error)+ // Deletes an organizational policy.// Permissions required: bb.policies.deleteDeletePolicy(ctx context.Context, in *DeletePolicyRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)}@@ -104,15 +111,22 @@ func (c *orgPolicyServiceClient) DeletePolicy(ctx context.Context, in *DeletePol// OrgPolicyServiceServer is the server API for OrgPolicyService service.// All implementations must embed UnimplementedOrgPolicyServiceServer// for forward compatibility.+//+// OrgPolicyService manages organizational policies at various resource levels.type OrgPolicyServiceServer interface {+ // Retrieves a policy by name.// Permissions required: bb.policies.getGetPolicy(context.Context, *GetPolicyRequest) (*Policy, error)+ // Lists policies at a specified resource level.// Permissions required: bb.policies.listListPolicies(context.Context, *ListPoliciesRequest) (*ListPoliciesResponse, error)+ // Creates a new organizational policy.// Permissions required: bb.policies.createCreatePolicy(context.Context, *CreatePolicyRequest) (*Policy, error)+ // Updates an existing organizational policy.// Permissions required: bb.policies.updateUpdatePolicy(context.Context, *UpdatePolicyRequest) (*Policy, error)+ // Deletes an organizational policy.// Permissions required: bb.policies.deleteDeletePolicy(context.Context, *DeletePolicyRequest) (*emptypb.Empty, error)mustEmbedUnimplementedOrgPolicyServiceServer()diff --git a/backend/generated-go/v1/plan_service.pb.go b/backend/generated-go/v1/plan_service.pb.goindex 45ebe4604a..0374223fd0 100644--- a/backend/generated-go/v1/plan_service.pb.go+++ b/backend/generated-go/v1/plan_service.pb.go@@ -27,12 +27,18 @@ const (type PlanCheckRun_Type int32const (- PlanCheckRun_TYPE_UNSPECIFIED PlanCheckRun_Type = 0- PlanCheckRun_DATABASE_STATEMENT_FAKE_ADVISE PlanCheckRun_Type = 1- PlanCheckRun_DATABASE_STATEMENT_ADVISE PlanCheckRun_Type = 3+ // Unspecified check type.+ PlanCheckRun_TYPE_UNSPECIFIED PlanCheckRun_Type = 0+ // Fake advise check for testing purposes without executing against database.+ PlanCheckRun_DATABASE_STATEMENT_FAKE_ADVISE PlanCheckRun_Type = 1+ // SQL review check that analyzes statements against configured SQL review rules.+ PlanCheckRun_DATABASE_STATEMENT_ADVISE PlanCheckRun_Type = 3+ // Summary report check that generates impact analysis for the statements.PlanCheckRun_DATABASE_STATEMENT_SUMMARY_REPORT PlanCheckRun_Type = 5- PlanCheckRun_DATABASE_CONNECT PlanCheckRun_Type = 6- PlanCheckRun_DATABASE_GHOST_SYNC PlanCheckRun_Type = 7+ // Connection check that verifies database connectivity.+ PlanCheckRun_DATABASE_CONNECT PlanCheckRun_Type = 6+ // Ghost sync check that validates gh-ost online schema change compatibility.+ PlanCheckRun_DATABASE_GHOST_SYNC PlanCheckRun_Type = 7)// Enum value maps for PlanCheckRun_Type.@@ -653,10 +659,13 @@ type Plan struct {// The rollout associated with the plan.// Can be empty.// Format: projects/{project}/rollouts/{rollout}- Rollout string `protobuf:"bytes,15,opt,name=rollout,proto3" json:"rollout,omitempty"`- Title string `protobuf:"bytes,4,opt,name=title,proto3" json:"title,omitempty"`- Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`- Specs []*Plan_Spec `protobuf:"bytes,14,rep,name=specs,proto3" json:"specs,omitempty"`+ Rollout string `protobuf:"bytes,15,opt,name=rollout,proto3" json:"rollout,omitempty"`+ // The title of the plan.+ Title string `protobuf:"bytes,4,opt,name=title,proto3" json:"title,omitempty"`+ // The description of the plan.+ Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`+ // The deployment specs for the plan.+ Specs []*Plan_Spec `protobuf:"bytes,14,rep,name=specs,proto3" json:"specs,omitempty"`// Format: users/[email protected]Creator string `protobuf:"bytes,8,opt,name=creator,proto3" json:"creator,omitempty"`CreateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`@@ -792,13 +801,13 @@ type ListPlanCheckRunsRequest struct {// The parent, which owns this collection of plan check runs.// Format: projects/{project}/plans/{plan}Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// The maximum number of plan check runs to return. The service may return fewer than// this value.// If unspecified, at most 10 plan check runs 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"`- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// A page token, received from a previous `ListPlanCheckRuns` call.// Provide this to retrieve the subsequent page.//diff --git a/backend/generated-go/v1/plan_service_grpc.pb.go b/backend/generated-go/v1/plan_service_grpc.pb.goindex 5cc469a3f8..55429dd494 100644--- a/backend/generated-go/v1/plan_service_grpc.pb.go+++ b/backend/generated-go/v1/plan_service_grpc.pb.go@@ -32,24 +32,32 @@ const (// PlanServiceClient is the client API for PlanService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// PlanService manages deployment plans for database changes.type PlanServiceClient interface {+ // Retrieves a deployment plan by name.// Permissions required: bb.plans.getGetPlan(ctx context.Context, in *GetPlanRequest, opts ...grpc.CallOption) (*Plan, error)+ // Lists deployment plans in a project.// Permissions required: bb.plans.listListPlans(ctx context.Context, in *ListPlansRequest, opts ...grpc.CallOption) (*ListPlansResponse, error)// Search for plans that the caller has the bb.plans.get permission on and also satisfy the specified filter & query.// Permissions required: bb.plans.getSearchPlans(ctx context.Context, in *SearchPlansRequest, opts ...grpc.CallOption) (*SearchPlansResponse, error)+ // Creates a new deployment plan.// Permissions required: bb.plans.createCreatePlan(ctx context.Context, in *CreatePlanRequest, opts ...grpc.CallOption) (*Plan, error)// UpdatePlan updates the plan.// The plan creator and the user with bb.plans.update permission on the project can update the plan.- // Permissions required: bb.plans.update+ // Permissions required: bb.plans.update (or creator)UpdatePlan(ctx context.Context, in *UpdatePlanRequest, opts ...grpc.CallOption) (*Plan, error)+ // Lists plan check runs for a deployment plan.// Permissions required: bb.planCheckRuns.listListPlanCheckRuns(ctx context.Context, in *ListPlanCheckRunsRequest, opts ...grpc.CallOption) (*ListPlanCheckRunsResponse, error)+ // Executes validation checks on a deployment plan.// Permissions required: bb.planCheckRuns.runRunPlanChecks(ctx context.Context, in *RunPlanChecksRequest, opts ...grpc.CallOption) (*RunPlanChecksResponse, error)+ // Cancels multiple plan check runs.// Permissions required: bb.planCheckRuns.runBatchCancelPlanCheckRuns(ctx context.Context, in *BatchCancelPlanCheckRunsRequest, opts ...grpc.CallOption) (*BatchCancelPlanCheckRunsResponse, error)}@@ -145,24 +153,32 @@ func (c *planServiceClient) BatchCancelPlanCheckRuns(ctx context.Context, in *Ba// PlanServiceServer is the server API for PlanService service.// All implementations must embed UnimplementedPlanServiceServer// for forward compatibility.+//+// PlanService manages deployment plans for database changes.type PlanServiceServer interface {+ // Retrieves a deployment plan by name.// Permissions required: bb.plans.getGetPlan(context.Context, *GetPlanRequest) (*Plan, error)+ // Lists deployment plans in a project.// Permissions required: bb.plans.listListPlans(context.Context, *ListPlansRequest) (*ListPlansResponse, error)// Search for plans that the caller has the bb.plans.get permission on and also satisfy the specified filter & query.// Permissions required: bb.plans.getSearchPlans(context.Context, *SearchPlansRequest) (*SearchPlansResponse, error)+ // Creates a new deployment plan.// Permissions required: bb.plans.createCreatePlan(context.Context, *CreatePlanRequest) (*Plan, error)// UpdatePlan updates the plan.// The plan creator and the user with bb.plans.update permission on the project can update the plan.- // Permissions required: bb.plans.update+ // Permissions required: bb.plans.update (or creator)UpdatePlan(context.Context, *UpdatePlanRequest) (*Plan, error)+ // Lists plan check runs for a deployment plan.// Permissions required: bb.planCheckRuns.listListPlanCheckRuns(context.Context, *ListPlanCheckRunsRequest) (*ListPlanCheckRunsResponse, error)+ // Executes validation checks on a deployment plan.// Permissions required: bb.planCheckRuns.runRunPlanChecks(context.Context, *RunPlanChecksRequest) (*RunPlanChecksResponse, error)+ // Cancels multiple plan check runs.// Permissions required: bb.planCheckRuns.runBatchCancelPlanCheckRuns(context.Context, *BatchCancelPlanCheckRunsRequest) (*BatchCancelPlanCheckRunsResponse, error)mustEmbedUnimplementedPlanServiceServer()diff --git a/backend/generated-go/v1/project_service.pb.go b/backend/generated-go/v1/project_service.pb.goindex d2204f9043..e0ed4374ef 100644--- a/backend/generated-go/v1/project_service.pb.go+++ b/backend/generated-go/v1/project_service.pb.go@@ -24,17 +24,26 @@ const (_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20))+// Webhook integration type.type Webhook_Type int32const (+ // Unspecified type.Webhook_TYPE_UNSPECIFIED Webhook_Type = 0- Webhook_SLACK Webhook_Type = 1- Webhook_DISCORD Webhook_Type = 2- Webhook_TEAMS Webhook_Type = 3- Webhook_DINGTALK Webhook_Type = 4- Webhook_FEISHU Webhook_Type = 5- Webhook_WECOM Webhook_Type = 6- Webhook_LARK Webhook_Type = 8+ // Slack integration.+ Webhook_SLACK Webhook_Type = 1+ // Discord integration.+ Webhook_DISCORD Webhook_Type = 2+ // Microsoft Teams integration.+ Webhook_TEAMS Webhook_Type = 3+ // DingTalk integration.+ Webhook_DINGTALK Webhook_Type = 4+ // Feishu integration.+ Webhook_FEISHU Webhook_Type = 5+ // WeCom (WeChat Work) integration.+ Webhook_WECOM Webhook_Type = 6+ // Lark integration.+ Webhook_LARK Webhook_Type = 8)// Enum value maps for Webhook_Type.@@ -88,9 +97,11 @@ func (Webhook_Type) EnumDescriptor() ([]byte, []int) {return file_v1_project_service_proto_rawDescGZIP(), []int{19, 0}}+// Activity type enumeration.type Activity_Type int32const (+ // Unspecified type.Activity_TYPE_UNSPECIFIED Activity_Type = 0// Notifications via webhooks.//@@ -863,7 +874,8 @@ func (x *BatchGetIamPolicyRequest) GetNames() []string {}type BatchGetIamPolicyResponse struct {- state protoimpl.MessageState `protogen:"open.v1"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The policy results for each requested project.PolicyResults []*BatchGetIamPolicyResponse_PolicyResult `protobuf:"bytes,1,rep,name=policy_results,json=policyResults,proto3" json:"policy_results,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -906,11 +918,15 @@ func (x *BatchGetIamPolicyResponse) GetPolicyResults() []*BatchGetIamPolicyResporeturn nil}+// A label for categorizing and organizing 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 label value/name.+ Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`+ // The color code for the label (e.g., hex color).+ Color string `protobuf:"bytes,2,opt,name=color,proto3" json:"color,omitempty"`+ // The group this label belongs to.+ Group string `protobuf:"bytes,3,opt,name=group,proto3" json:"group,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -970,36 +986,40 @@ type Project struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the project.// Format: projects/{project}- Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`- State State `protobuf:"varint,3,opt,name=state,proto3,enum=bytebase.v1.State" json:"state,omitempty"`+ Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`+ // The lifecycle state of the project.+ State State `protobuf:"varint,3,opt,name=state,proto3,enum=bytebase.v1.State" json:"state,omitempty"`// The title or name of a project. It's not unique within the workspace.- Title string `protobuf:"bytes,4,opt,name=title,proto3" json:"title,omitempty"`- Webhooks []*Webhook `protobuf:"bytes,11,rep,name=webhooks,proto3" json:"webhooks,omitempty"`- DataClassificationConfigId string `protobuf:"bytes,12,opt,name=data_classification_config_id,json=dataClassificationConfigId,proto3" json:"data_classification_config_id,omitempty"`- IssueLabels []*Label `protobuf:"bytes,13,rep,name=issue_labels,json=issueLabels,proto3" json:"issue_labels,omitempty"`+ Title string `protobuf:"bytes,4,opt,name=title,proto3" json:"title,omitempty"`+ // The list of webhooks configured for the project.+ Webhooks []*Webhook `protobuf:"bytes,11,rep,name=webhooks,proto3" json:"webhooks,omitempty"`+ // The data classification configuration ID for the project.+ DataClassificationConfigId string `protobuf:"bytes,12,opt,name=data_classification_config_id,json=dataClassificationConfigId,proto3" json:"data_classification_config_id,omitempty"`+ // Labels available for tagging issues in this project.+ IssueLabels []*Label `protobuf:"bytes,13,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,14,opt,name=force_issue_labels,json=forceIssueLabels,proto3" json:"force_issue_labels,omitempty"`- // Allow modifying statement after issue is created.+ // Allow modifying SQL statements after issue is created.AllowModifyStatement bool `protobuf:"varint,15,opt,name=allow_modify_statement,json=allowModifyStatement,proto3" json:"allow_modify_statement,omitempty"`- // Enable auto resolve issue.+ // Enable automatic issue resolution when tasks complete.AutoResolveIssue bool `protobuf:"varint,16,opt,name=auto_resolve_issue,json=autoResolveIssue,proto3" json:"auto_resolve_issue,omitempty"`- // Enforce issue title created by user instead of generated by Bytebase.+ // Enforce issue title to be created by user instead of generated by Bytebase.EnforceIssueTitle bool `protobuf:"varint,17,opt,name=enforce_issue_title,json=enforceIssueTitle,proto3" json:"enforce_issue_title,omitempty"`- // Whether to automatically enable backup.+ // Whether to automatically enable backup for database changes.AutoEnableBackup bool `protobuf:"varint,18,opt,name=auto_enable_backup,json=autoEnableBackup,proto3" json:"auto_enable_backup,omitempty"`- // Whether to skip backup errors and continue the data migration.+ // Whether to skip backup errors and continue with data migration.SkipBackupErrors bool `protobuf:"varint,19,opt,name=skip_backup_errors,json=skipBackupErrors,proto3" json:"skip_backup_errors,omitempty"`- // Whether to enable the database tenant mode for PostgreSQL.- // If enabled, the issue will be created with the prepend "set role <db_owner>" statement.+ // Whether to enable database tenant mode for PostgreSQL.+ // If enabled, issues will include "set role <db_owner>" statement.PostgresDatabaseTenantMode bool `protobuf:"varint,20,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.+ // Whether to allow issue creators to self-approve their own issues.AllowSelfApproval bool `protobuf:"varint,21,opt,name=allow_self_approval,json=allowSelfApproval,proto3" json:"allow_self_approval,omitempty"`- // Execution retry policy for the task run.+ // Execution retry policy for task runs.ExecutionRetryPolicy *Project_ExecutionRetryPolicy `protobuf:"bytes,22,opt,name=execution_retry_policy,json=executionRetryPolicy,proto3" json:"execution_retry_policy,omitempty"`- // The maximum databases of rows to sample during CI data validation.- // Without specification, sampling is disabled, resulting in a full validation.+ // The maximum number of database rows to sample during CI data validation.+ // Without specification, sampling is disabled, resulting in full validation.CiSamplingSize int32 `protobuf:"varint,23,opt,name=ci_sampling_size,json=ciSamplingSize,proto3" json:"ci_sampling_size,omitempty"`- // The maximum number of parallel tasks to run during the rollout.+ // The maximum number of parallel tasks allowed during rollout execution.ParallelTasksPerRollout int32 `protobuf:"varint,24,opt,name=parallel_tasks_per_rollout,json=parallelTasksPerRollout,proto3" json:"parallel_tasks_per_rollout,omitempty"`// Labels are key-value pairs that can be attached to the project.// For example, { "environment": "production", "team": "backend" }@@ -1539,6 +1559,7 @@ func (x *Webhook) GetNotificationTypes() []Activity_Type {return nil}+// Activity types for webhook notifications.// TODO(zp): move to activity later.type Activity struct {state protoimpl.MessageState `protogen:"open.v1"`@@ -1576,10 +1597,13 @@ func (*Activity) Descriptor() ([]byte, []int) {return file_v1_project_service_proto_rawDescGZIP(), []int{20}}+// Result for a single project's IAM policy.type BatchGetIamPolicyResponse_PolicyResult struct {- state protoimpl.MessageState `protogen:"open.v1"`- Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`- Policy *IamPolicy `protobuf:"bytes,2,opt,name=policy,proto3" json:"policy,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The project resource name.+ Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`+ // The IAM policy for the project.+ Policy *IamPolicy `protobuf:"bytes,2,opt,name=policy,proto3" json:"policy,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -1628,9 +1652,10 @@ func (x *BatchGetIamPolicyResponse_PolicyResult) GetPolicy() *IamPolicy {return nil}+// Execution retry policy configuration.type Project_ExecutionRetryPolicy struct {state protoimpl.MessageState `protogen:"open.v1"`- // The maximum number of retries for the lock timeout issue.+ // The maximum number of retries 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/v1/project_service_grpc.pb.go b/backend/generated-go/v1/project_service_grpc.pb.goindex 67dcd33f0d..a28a3039a8 100644--- a/backend/generated-go/v1/project_service_grpc.pb.go+++ b/backend/generated-go/v1/project_service_grpc.pb.go@@ -40,38 +40,53 @@ const (// ProjectServiceClient is the client API for ProjectService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// ProjectService manages projects that group databases and changes.type ProjectServiceClient interface {// GetProject retrieves a project by name.// Users with "bb.projects.get" permission on the workspace or the project owner can access this method.// Permissions required: bb.projects.getGetProject(ctx context.Context, in *GetProjectRequest, opts ...grpc.CallOption) (*Project, error)+ // Lists all projects in the workspace with optional filtering.// Permissions required: bb.projects.listListProjects(ctx context.Context, in *ListProjectsRequest, opts ...grpc.CallOption) (*ListProjectsResponse, error)- // Permissions required: None+ // Searches for projects with advanced filtering capabilities.+ // Permissions required: bb.projects.get (or project-level bb.projects.get for specific projects)SearchProjects(ctx context.Context, in *SearchProjectsRequest, opts ...grpc.CallOption) (*SearchProjectsResponse, error)+ // Creates a new project in the workspace.// Permissions required: bb.projects.createCreateProject(ctx context.Context, in *CreateProjectRequest, opts ...grpc.CallOption) (*Project, error)+ // Updates an existing project's properties.// Permissions required: bb.projects.updateUpdateProject(ctx context.Context, in *UpdateProjectRequest, opts ...grpc.CallOption) (*Project, error)+ // Deletes (soft-delete or purge) a project.// Permissions required: bb.projects.deleteDeleteProject(ctx context.Context, in *DeleteProjectRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)+ // Restores a soft-deleted project.// Permissions required: bb.projects.undeleteUndeleteProject(ctx context.Context, in *UndeleteProjectRequest, opts ...grpc.CallOption) (*Project, error)+ // Deletes multiple projects in a single operation.// Permissions required: bb.projects.deleteBatchDeleteProjects(ctx context.Context, in *BatchDeleteProjectsRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)+ // Retrieves the IAM policy for a project.// Permissions required: bb.projects.getIamPolicyGetIamPolicy(ctx context.Context, in *GetIamPolicyRequest, opts ...grpc.CallOption) (*IamPolicy, error)- // Deprecated.- // Permissions required: bb.projects.getIamPolicy+ // Deprecated. No permission check implemented.+ // Permissions required: NoneBatchGetIamPolicy(ctx context.Context, in *BatchGetIamPolicyRequest, opts ...grpc.CallOption) (*BatchGetIamPolicyResponse, error)+ // Sets the IAM policy for a project.// Permissions required: bb.projects.setIamPolicySetIamPolicy(ctx context.Context, in *SetIamPolicyRequest, opts ...grpc.CallOption) (*IamPolicy, error)+ // Adds a webhook to a project for notifications.// Permissions required: bb.projects.updateAddWebhook(ctx context.Context, in *AddWebhookRequest, opts ...grpc.CallOption) (*Project, error)+ // Updates an existing webhook configuration.// Permissions required: bb.projects.updateUpdateWebhook(ctx context.Context, in *UpdateWebhookRequest, opts ...grpc.CallOption) (*Project, error)+ // Removes a webhook from a project.// Permissions required: bb.projects.updateRemoveWebhook(ctx context.Context, in *RemoveWebhookRequest, opts ...grpc.CallOption) (*Project, error)+ // Tests a webhook by sending a test notification.// Permissions required: bb.projects.updateTestWebhook(ctx context.Context, in *TestWebhookRequest, opts ...grpc.CallOption) (*TestWebhookResponse, error)}@@ -237,38 +252,53 @@ func (c *projectServiceClient) TestWebhook(ctx context.Context, in *TestWebhookR// ProjectServiceServer is the server API for ProjectService service.// All implementations must embed UnimplementedProjectServiceServer// for forward compatibility.+//+// ProjectService manages projects that group databases and changes.type ProjectServiceServer interface {// GetProject retrieves a project by name.// Users with "bb.projects.get" permission on the workspace or the project owner can access this method.// Permissions required: bb.projects.getGetProject(context.Context, *GetProjectRequest) (*Project, error)+ // Lists all projects in the workspace with optional filtering.// Permissions required: bb.projects.listListProjects(context.Context, *ListProjectsRequest) (*ListProjectsResponse, error)- // Permissions required: None+ // Searches for projects with advanced filtering capabilities.+ // Permissions required: bb.projects.get (or project-level bb.projects.get for specific projects)SearchProjects(context.Context, *SearchProjectsRequest) (*SearchProjectsResponse, error)+ // Creates a new project in the workspace.// Permissions required: bb.projects.createCreateProject(context.Context, *CreateProjectRequest) (*Project, error)+ // Updates an existing project's properties.// Permissions required: bb.projects.updateUpdateProject(context.Context, *UpdateProjectRequest) (*Project, error)+ // Deletes (soft-delete or purge) a project.// Permissions required: bb.projects.deleteDeleteProject(context.Context, *DeleteProjectRequest) (*emptypb.Empty, error)+ // Restores a soft-deleted project.// Permissions required: bb.projects.undeleteUndeleteProject(context.Context, *UndeleteProjectRequest) (*Project, error)+ // Deletes multiple projects in a single operation.// Permissions required: bb.projects.deleteBatchDeleteProjects(context.Context, *BatchDeleteProjectsRequest) (*emptypb.Empty, error)+ // Retrieves the IAM policy for a project.// Permissions required: bb.projects.getIamPolicyGetIamPolicy(context.Context, *GetIamPolicyRequest) (*IamPolicy, error)- // Deprecated.- // Permissions required: bb.projects.getIamPolicy+ // Deprecated. No permission check implemented.+ // Permissions required: NoneBatchGetIamPolicy(context.Context, *BatchGetIamPolicyRequest) (*BatchGetIamPolicyResponse, error)+ // Sets the IAM policy for a project.// Permissions required: bb.projects.setIamPolicySetIamPolicy(context.Context, *SetIamPolicyRequest) (*IamPolicy, error)+ // Adds a webhook to a project for notifications.// Permissions required: bb.projects.updateAddWebhook(context.Context, *AddWebhookRequest) (*Project, error)+ // Updates an existing webhook configuration.// Permissions required: bb.projects.updateUpdateWebhook(context.Context, *UpdateWebhookRequest) (*Project, error)+ // Removes a webhook from a project.// Permissions required: bb.projects.updateRemoveWebhook(context.Context, *RemoveWebhookRequest) (*Project, error)+ // Tests a webhook by sending a test notification.// Permissions required: bb.projects.updateTestWebhook(context.Context, *TestWebhookRequest) (*TestWebhookResponse, error)mustEmbedUnimplementedProjectServiceServer()diff --git a/backend/generated-go/v1/release_service.pb.go b/backend/generated-go/v1/release_service.pb.goindex 196912743c..e304c13849 100644--- a/backend/generated-go/v1/release_service.pb.go+++ b/backend/generated-go/v1/release_service.pb.go@@ -25,12 +25,16 @@ const (_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20))+// The type of migration file.type Release_File_Type int32const (+ // Unspecified type.Release_File_TYPE_UNSPECIFIED Release_File_Type = 0- Release_File_VERSIONED Release_File_Type = 1- Release_File_DECLARATIVE Release_File_Type = 2+ // Versioned migration file with sequential version numbers.+ Release_File_VERSIONED Release_File_Type = 1+ // Declarative schema definition file describing desired state.+ Release_File_DECLARATIVE Release_File_Type = 2)// Enum value maps for Release_File_Type.@@ -74,13 +78,18 @@ func (Release_File_Type) EnumDescriptor() ([]byte, []int) {return file_v1_release_service_proto_rawDescGZIP(), []int{11, 0, 0}}+// The migration type for versioned files.type Release_File_MigrationType int32const (+ // Unspecified migration type.Release_File_MIGRATION_TYPE_UNSPECIFIED Release_File_MigrationType = 0- Release_File_DDL Release_File_MigrationType = 1- Release_File_DDL_GHOST Release_File_MigrationType = 2- Release_File_DML Release_File_MigrationType = 3+ // DDL (Data Definition Language) migration.+ Release_File_DDL Release_File_MigrationType = 1+ // DDL migration using gh-ost for online schema changes.+ Release_File_DDL_GHOST Release_File_MigrationType = 2+ // DML (Data Manipulation Language) migration.+ Release_File_DML Release_File_MigrationType = 3)// Enum value maps for Release_File_MigrationType.@@ -250,8 +259,9 @@ func (x *ListReleasesRequest) GetShowDeleted() bool {}type ListReleasesResponse struct {- state protoimpl.MessageState `protogen:"open.v1"`- Releases []*Release `protobuf:"bytes,1,rep,name=releases,proto3" json:"releases,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The releases from the specified request.+ Releases []*Release `protobuf:"bytes,1,rep,name=releases,proto3" json:"releases,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.NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`@@ -382,8 +392,9 @@ func (x *SearchReleasesRequest) GetDigest() string {}type SearchReleasesResponse struct {- state protoimpl.MessageState `protogen:"open.v1"`- Releases []*Release `protobuf:"bytes,1,rep,name=releases,proto3" json:"releases,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The releases matching the search criteria.+ Releases []*Release `protobuf:"bytes,1,rep,name=releases,proto3" json:"releases,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.NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`@@ -713,9 +724,10 @@ func (x *CheckReleaseRequest) GetTargets() []string {}type CheckReleaseResponse struct {- state protoimpl.MessageState `protogen:"open.v1"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The check results for each file and target combination.Results []*CheckReleaseResponse_CheckResult `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`- // The affected rows of the check.+ // The total affected rows across all checks.AffectedRows int64 `protobuf:"varint,2,opt,name=affected_rows,json=affectedRows,proto3" json:"affected_rows,omitempty"`// The aggregated risk level of the check.RiskLevel RiskLevel `protobuf:"varint,3,opt,name=risk_level,json=riskLevel,proto3,enum=bytebase.v1.RiskLevel" json:"risk_level,omitempty"`@@ -777,14 +789,18 @@ func (x *CheckReleaseResponse) GetRiskLevel() RiskLevel {type Release struct {state protoimpl.MessageState `protogen:"open.v1"`// Format: projects/{project}/releases/{release}- Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`- Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`- Files []*Release_File `protobuf:"bytes,3,rep,name=files,proto3" json:"files,omitempty"`+ Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`+ // The title of the release.+ Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`+ // The SQL files included in the release.+ Files []*Release_File `protobuf:"bytes,3,rep,name=files,proto3" json:"files,omitempty"`+ // The version control source of the release.VcsSource *Release_VCSSource `protobuf:"bytes,4,opt,name=vcs_source,json=vcsSource,proto3" json:"vcs_source,omitempty"`// Format: users/[email protected]Creator string `protobuf:"bytes,5,opt,name=creator,proto3" json:"creator,omitempty"`CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`- State State `protobuf:"varint,7,opt,name=state,proto3,enum=bytebase.v1.State" json:"state,omitempty"`+ // The lifecycle state of the release.+ State State `protobuf:"varint,7,opt,name=state,proto3,enum=bytebase.v1.State" json:"state,omitempty"`// The digest of the release.// The user can provide the digest of the release. It can be used later to retrieve the release in GetRelease.// Whether to provide digest and how to generate it is up to the user.@@ -880,6 +896,7 @@ func (x *Release) GetDigest() string {return ""}+// Check result for a single release file on a target database.type CheckReleaseResponse_CheckResult struct {state protoimpl.MessageState `protogen:"open.v1"`// The file path that is being checked.@@ -962,6 +979,7 @@ func (x *CheckReleaseResponse_CheckResult) GetRiskLevel() RiskLevel {return RiskLevel_RISK_LEVEL_UNSPECIFIED}+// A SQL file in a release.type Release_File struct {state protoimpl.MessageState `protogen:"open.v1"`// The unique identifier for the file.@@ -969,8 +987,9 @@ type Release_File struct {// 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"`- Version string `protobuf:"bytes,6,opt,name=version,proto3" json:"version,omitempty"`+ Type Release_File_Type `protobuf:"varint,5,opt,name=type,proto3,enum=bytebase.v1.Release_File_Type" json:"type,omitempty"`+ // The version identifier for the file.+ Version string `protobuf:"bytes,6,opt,name=version,proto3" json:"version,omitempty"`// 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.@@ -1084,9 +1103,11 @@ func (x *Release_File) GetStatementSize() int64 {return 0}+// Version control system source information.type Release_VCSSource struct {- state protoimpl.MessageState `protogen:"open.v1"`- VcsType VCSType `protobuf:"varint,1,opt,name=vcs_type,json=vcsType,proto3,enum=bytebase.v1.VCSType" json:"vcs_type,omitempty"`+ 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.Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`unknownFields protoimpl.UnknownFieldsdiff --git a/backend/generated-go/v1/release_service_grpc.pb.go b/backend/generated-go/v1/release_service_grpc.pb.goindex da793a2fa8..63229a035c 100644--- a/backend/generated-go/v1/release_service_grpc.pb.go+++ b/backend/generated-go/v1/release_service_grpc.pb.go@@ -33,21 +33,31 @@ const (// ReleaseServiceClient is the client API for ReleaseService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// ReleaseService manages releases for coordinating deployments.type ReleaseServiceClient interface {+ // Retrieves a release by name.// Permissions required: bb.releases.getGetRelease(ctx context.Context, in *GetReleaseRequest, opts ...grpc.CallOption) (*Release, error)+ // Lists releases in a project.// Permissions required: bb.releases.listListReleases(ctx context.Context, in *ListReleasesRequest, opts ...grpc.CallOption) (*ListReleasesResponse, error)+ // Searches releases by digest or other criteria.// Permissions required: bb.releases.getSearchReleases(ctx context.Context, in *SearchReleasesRequest, opts ...grpc.CallOption) (*SearchReleasesResponse, error)+ // Creates a new release with SQL files.// Permissions required: bb.releases.createCreateRelease(ctx context.Context, in *CreateReleaseRequest, opts ...grpc.CallOption) (*Release, error)+ // Updates an existing release.// Permissions required: bb.releases.updateUpdateRelease(ctx context.Context, in *UpdateReleaseRequest, opts ...grpc.CallOption) (*Release, error)+ // Deletes a release.// Permissions required: bb.releases.deleteDeleteRelease(ctx context.Context, in *DeleteReleaseRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)+ // Restores a deleted release.// Permissions required: bb.releases.undeleteUndeleteRelease(ctx context.Context, in *UndeleteReleaseRequest, opts ...grpc.CallOption) (*Release, error)+ // Validates a release by dry-running checks on target databases.// Permissions required: bb.releases.checkCheckRelease(ctx context.Context, in *CheckReleaseRequest, opts ...grpc.CallOption) (*CheckReleaseResponse, error)}@@ -143,21 +153,31 @@ func (c *releaseServiceClient) CheckRelease(ctx context.Context, in *CheckReleas// ReleaseServiceServer is the server API for ReleaseService service.// All implementations must embed UnimplementedReleaseServiceServer// for forward compatibility.+//+// ReleaseService manages releases for coordinating deployments.type ReleaseServiceServer interface {+ // Retrieves a release by name.// Permissions required: bb.releases.getGetRelease(context.Context, *GetReleaseRequest) (*Release, error)+ // Lists releases in a project.// Permissions required: bb.releases.listListReleases(context.Context, *ListReleasesRequest) (*ListReleasesResponse, error)+ // Searches releases by digest or other criteria.// Permissions required: bb.releases.getSearchReleases(context.Context, *SearchReleasesRequest) (*SearchReleasesResponse, error)+ // Creates a new release with SQL files.// Permissions required: bb.releases.createCreateRelease(context.Context, *CreateReleaseRequest) (*Release, error)+ // Updates an existing release.// Permissions required: bb.releases.updateUpdateRelease(context.Context, *UpdateReleaseRequest) (*Release, error)+ // Deletes a release.// Permissions required: bb.releases.deleteDeleteRelease(context.Context, *DeleteReleaseRequest) (*emptypb.Empty, error)+ // Restores a deleted release.// Permissions required: bb.releases.undeleteUndeleteRelease(context.Context, *UndeleteReleaseRequest) (*Release, error)+ // Validates a release by dry-running checks on target databases.// Permissions required: bb.releases.checkCheckRelease(context.Context, *CheckReleaseRequest) (*CheckReleaseResponse, error)mustEmbedUnimplementedReleaseServiceServer()diff --git a/backend/generated-go/v1/review_config_service.pb.go b/backend/generated-go/v1/review_config_service.pb.goindex 99b2fd3bf4..a2ff3edf70 100644--- a/backend/generated-go/v1/review_config_service.pb.go+++ b/backend/generated-go/v1/review_config_service.pb.go@@ -26,13 +26,13 @@ const (type ListReviewConfigsRequest struct {state protoimpl.MessageState `protogen:"open.v1"`- // Not used.+ // 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.PageSize int32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`- // Not used.+ // 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@@ -348,12 +348,15 @@ type ReviewConfig struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the sql review to retrieve.// Format: reviewConfigs/{reviewConfig}- Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`- Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`- Enabled bool `protobuf:"varint,3,opt,name=enabled,proto3" json:"enabled,omitempty"`- Rules []*SQLReviewRule `protobuf:"bytes,7,rep,name=rules,proto3" json:"rules,omitempty"`+ Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`+ // The title of the review configuration.+ Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`+ // Whether the review configuration is enabled.+ 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: {resurce}/{resource id}, for example, environments/test.+ // Format: {resource}/{resource id}, for example, 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/review_config_service_grpc.pb.go b/backend/generated-go/v1/review_config_service_grpc.pb.goindex a6e34b8e60..30acb345fb 100644--- a/backend/generated-go/v1/review_config_service_grpc.pb.go+++ b/backend/generated-go/v1/review_config_service_grpc.pb.go@@ -30,15 +30,22 @@ const (// ReviewConfigServiceClient is the client API for ReviewConfigService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// ReviewConfigService manages approval flow configurations.type ReviewConfigServiceClient interface {+ // Creates a new SQL review configuration.// Permissions required: bb.reviewConfigs.createCreateReviewConfig(ctx context.Context, in *CreateReviewConfigRequest, opts ...grpc.CallOption) (*ReviewConfig, error)+ // Lists all SQL review configurations.// Permissions required: bb.reviewConfigs.listListReviewConfigs(ctx context.Context, in *ListReviewConfigsRequest, opts ...grpc.CallOption) (*ListReviewConfigsResponse, error)+ // Retrieves a SQL review configuration by name.// Permissions required: bb.reviewConfigs.getGetReviewConfig(ctx context.Context, in *GetReviewConfigRequest, opts ...grpc.CallOption) (*ReviewConfig, error)+ // Updates a SQL review configuration.// Permissions required: bb.reviewConfigs.updateUpdateReviewConfig(ctx context.Context, in *UpdateReviewConfigRequest, opts ...grpc.CallOption) (*ReviewConfig, error)+ // Deletes a SQL review configuration.// Permissions required: bb.reviewConfigs.deleteDeleteReviewConfig(ctx context.Context, in *DeleteReviewConfigRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)}@@ -104,15 +111,22 @@ func (c *reviewConfigServiceClient) DeleteReviewConfig(ctx context.Context, in *// ReviewConfigServiceServer is the server API for ReviewConfigService service.// All implementations must embed UnimplementedReviewConfigServiceServer// for forward compatibility.+//+// ReviewConfigService manages approval flow configurations.type ReviewConfigServiceServer interface {+ // Creates a new SQL review configuration.// Permissions required: bb.reviewConfigs.createCreateReviewConfig(context.Context, *CreateReviewConfigRequest) (*ReviewConfig, error)+ // Lists all SQL review configurations.// Permissions required: bb.reviewConfigs.listListReviewConfigs(context.Context, *ListReviewConfigsRequest) (*ListReviewConfigsResponse, error)+ // Retrieves a SQL review configuration by name.// Permissions required: bb.reviewConfigs.getGetReviewConfig(context.Context, *GetReviewConfigRequest) (*ReviewConfig, error)+ // Updates a SQL review configuration.// Permissions required: bb.reviewConfigs.updateUpdateReviewConfig(context.Context, *UpdateReviewConfigRequest) (*ReviewConfig, error)+ // Deletes a SQL review configuration.// Permissions required: bb.reviewConfigs.deleteDeleteReviewConfig(context.Context, *DeleteReviewConfigRequest) (*emptypb.Empty, error)mustEmbedUnimplementedReviewConfigServiceServer()diff --git a/backend/generated-go/v1/revision_service.pb.go b/backend/generated-go/v1/revision_service.pb.goindex 59541cae60..3f97bd681c 100644--- a/backend/generated-go/v1/revision_service.pb.go+++ b/backend/generated-go/v1/revision_service.pb.go@@ -24,12 +24,16 @@ const (_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20))+// The type of schema revision.type Revision_Type int32const (+ // Unspecified type.Revision_TYPE_UNSPECIFIED Revision_Type = 0- Revision_VERSIONED Revision_Type = 1- Revision_DECLARATIVE Revision_Type = 2+ // Versioned schema migration.+ Revision_VERSIONED Revision_Type = 1+ // Declarative schema definition.+ Revision_DECLARATIVE Revision_Type = 2)// Enum value maps for Revision_Type.@@ -87,8 +91,9 @@ type ListRevisionsRequest struct {//// When paginating, all other parameters provided to `ListRevisions` 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"`- ShowDeleted bool `protobuf:"varint,4,opt,name=show_deleted,json=showDeleted,proto3" json:"show_deleted,omitempty"`+ PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`+ // Whether to include deleted revisions in the results.+ ShowDeleted bool `protobuf:"varint,4,opt,name=show_deleted,json=showDeleted,proto3" json:"show_deleted,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -152,8 +157,9 @@ func (x *ListRevisionsRequest) GetShowDeleted() bool {}type ListRevisionsResponse struct {- state protoimpl.MessageState `protogen:"open.v1"`- Revisions []*Revision `protobuf:"bytes,1,rep,name=revisions,proto3" json:"revisions,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The revisions from the specified request.+ Revisions []*Revision `protobuf:"bytes,1,rep,name=revisions,proto3" json:"revisions,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.NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`@@ -467,7 +473,8 @@ type Revision struct {DeleteTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=delete_time,json=deleteTime,proto3" json:"delete_time,omitempty"`// Format: projects/{project}/releases/{release}/files/{id}// Can be empty.- File string `protobuf:"bytes,7,opt,name=file,proto3" json:"file,omitempty"`+ File string `protobuf:"bytes,7,opt,name=file,proto3" json:"file,omitempty"`+ // The schema version string for this revision.Version string `protobuf:"bytes,8,opt,name=version,proto3" json:"version,omitempty"`// The sheet that holds the content.// Format: projects/{project}/sheets/{sheet}@@ -475,8 +482,9 @@ type Revision struct {// The SHA256 hash value of the sheet.SheetSha256 string `protobuf:"bytes,10,opt,name=sheet_sha256,json=sheetSha256,proto3" json:"sheet_sha256,omitempty"`// The statement is used for preview purpose.- Statement string `protobuf:"bytes,11,opt,name=statement,proto3" json:"statement,omitempty"`- StatementSize int64 `protobuf:"varint,12,opt,name=statement_size,json=statementSize,proto3" json:"statement_size,omitempty"`+ Statement string `protobuf:"bytes,11,opt,name=statement,proto3" json:"statement,omitempty"`+ // The size of the statement in bytes.+ StatementSize int64 `protobuf:"varint,12,opt,name=statement_size,json=statementSize,proto3" json:"statement_size,omitempty"`// The issue associated with the revision.// Can be empty.// Format: projects/{project}/issues/{issue}diff --git a/backend/generated-go/v1/revision_service_grpc.pb.go b/backend/generated-go/v1/revision_service_grpc.pb.goindex f6bfdec5e2..7d257477d2 100644--- a/backend/generated-go/v1/revision_service_grpc.pb.go+++ b/backend/generated-go/v1/revision_service_grpc.pb.go@@ -30,15 +30,22 @@ const (// RevisionServiceClient is the client API for RevisionService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// RevisionService manages schema revision history.type RevisionServiceClient interface {+ // Lists schema revisions for a database.// Permissions required: bb.revisions.listListRevisions(ctx context.Context, in *ListRevisionsRequest, opts ...grpc.CallOption) (*ListRevisionsResponse, error)+ // Retrieves a schema revision by name.// Permissions required: bb.revisions.getGetRevision(ctx context.Context, in *GetRevisionRequest, opts ...grpc.CallOption) (*Revision, error)+ // Creates a new schema revision.// Permissions required: bb.revisions.createCreateRevision(ctx context.Context, in *CreateRevisionRequest, opts ...grpc.CallOption) (*Revision, error)+ // Creates multiple schema revisions in a single operation.// Permissions required: bb.revisions.createBatchCreateRevisions(ctx context.Context, in *BatchCreateRevisionsRequest, opts ...grpc.CallOption) (*BatchCreateRevisionsResponse, error)+ // Deletes a schema revision.// Permissions required: bb.revisions.deleteDeleteRevision(ctx context.Context, in *DeleteRevisionRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)}@@ -104,15 +111,22 @@ func (c *revisionServiceClient) DeleteRevision(ctx context.Context, in *DeleteRe// RevisionServiceServer is the server API for RevisionService service.// All implementations must embed UnimplementedRevisionServiceServer// for forward compatibility.+//+// RevisionService manages schema revision history.type RevisionServiceServer interface {+ // Lists schema revisions for a database.// Permissions required: bb.revisions.listListRevisions(context.Context, *ListRevisionsRequest) (*ListRevisionsResponse, error)+ // Retrieves a schema revision by name.// Permissions required: bb.revisions.getGetRevision(context.Context, *GetRevisionRequest) (*Revision, error)+ // Creates a new schema revision.// Permissions required: bb.revisions.createCreateRevision(context.Context, *CreateRevisionRequest) (*Revision, error)+ // Creates multiple schema revisions in a single operation.// Permissions required: bb.revisions.createBatchCreateRevisions(context.Context, *BatchCreateRevisionsRequest) (*BatchCreateRevisionsResponse, error)+ // Deletes a schema revision.// Permissions required: bb.revisions.deleteDeleteRevision(context.Context, *DeleteRevisionRequest) (*emptypb.Empty, error)mustEmbedUnimplementedRevisionServiceServer()diff --git a/backend/generated-go/v1/risk_service.pb.go b/backend/generated-go/v1/risk_service.pb.goindex 1cc34e7610..142754b597 100644--- a/backend/generated-go/v1/risk_service.pb.go+++ b/backend/generated-go/v1/risk_service.pb.go@@ -85,17 +85,17 @@ func (Risk_Source) EnumDescriptor() ([]byte, []int) {type ListRisksRequest struct {state protoimpl.MessageState `protogen:"open.v1"`- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// The maximum number of risks to return. The service may return fewer than// this value.// If unspecified, at most 10 risks 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"`- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// A page token, received from a previous `ListRisks` call.// Provide this to retrieve the subsequent page.//- // When paginating, all other parameters provided to `LiskRisks` must match+ // When paginating, all other parameters provided to `ListRisks` must match// the call that provided the page token.PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`unknownFields protoimpl.UnknownFields@@ -409,9 +409,12 @@ type Risk struct {// Format: risks/{risk}Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`Source Risk_Source `protobuf:"varint,3,opt,name=source,proto3,enum=bytebase.v1.Risk_Source" json:"source,omitempty"`- Title string `protobuf:"bytes,4,opt,name=title,proto3" json:"title,omitempty"`- Level RiskLevel `protobuf:"varint,5,opt,name=level,proto3,enum=bytebase.v1.RiskLevel" json:"level,omitempty"`- Active bool `protobuf:"varint,7,opt,name=active,proto3" json:"active,omitempty"`+ // The title of the risk rule.+ Title string `protobuf:"bytes,4,opt,name=title,proto3" json:"title,omitempty"`+ // The risk level assigned when this rule matches.+ Level RiskLevel `protobuf:"varint,5,opt,name=level,proto3,enum=bytebase.v1.RiskLevel" json:"level,omitempty"`+ // Whether the risk rule is active.+ Active bool `protobuf:"varint,7,opt,name=active,proto3" json:"active,omitempty"`// The condition that is associated with the risk.// The syntax and semantics of CEL are documented at https://github.com/google/cel-spec//diff --git a/backend/generated-go/v1/risk_service_grpc.pb.go b/backend/generated-go/v1/risk_service_grpc.pb.goindex 1455bc51a0..1671653dc8 100644--- a/backend/generated-go/v1/risk_service_grpc.pb.go+++ b/backend/generated-go/v1/risk_service_grpc.pb.go@@ -30,15 +30,22 @@ const (// RiskServiceClient is the client API for RiskService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// RiskService manages risk assessment rules for database changes.type RiskServiceClient interface {+ // Lists all risk assessment rules.// Permissions required: bb.risks.listListRisks(ctx context.Context, in *ListRisksRequest, opts ...grpc.CallOption) (*ListRisksResponse, error)+ // Creates a new risk assessment rule.// Permissions required: bb.risks.createCreateRisk(ctx context.Context, in *CreateRiskRequest, opts ...grpc.CallOption) (*Risk, error)+ // Retrieves a risk assessment rule by name.// Permissions required: bb.risks.listGetRisk(ctx context.Context, in *GetRiskRequest, opts ...grpc.CallOption) (*Risk, error)+ // Updates an existing risk assessment rule.// Permissions required: bb.risks.updateUpdateRisk(ctx context.Context, in *UpdateRiskRequest, opts ...grpc.CallOption) (*Risk, error)+ // Deletes a risk assessment rule.// Permissions required: bb.risks.deleteDeleteRisk(ctx context.Context, in *DeleteRiskRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)}@@ -104,15 +111,22 @@ func (c *riskServiceClient) DeleteRisk(ctx context.Context, in *DeleteRiskReques// RiskServiceServer is the server API for RiskService service.// All implementations must embed UnimplementedRiskServiceServer// for forward compatibility.+//+// RiskService manages risk assessment rules for database changes.type RiskServiceServer interface {+ // Lists all risk assessment rules.// Permissions required: bb.risks.listListRisks(context.Context, *ListRisksRequest) (*ListRisksResponse, error)+ // Creates a new risk assessment rule.// Permissions required: bb.risks.createCreateRisk(context.Context, *CreateRiskRequest) (*Risk, error)+ // Retrieves a risk assessment rule by name.// Permissions required: bb.risks.listGetRisk(context.Context, *GetRiskRequest) (*Risk, error)+ // Updates an existing risk assessment rule.// Permissions required: bb.risks.updateUpdateRisk(context.Context, *UpdateRiskRequest) (*Risk, error)+ // Deletes a risk assessment rule.// Permissions required: bb.risks.deleteDeleteRisk(context.Context, *DeleteRiskRequest) (*emptypb.Empty, error)mustEmbedUnimplementedRiskServiceServer()diff --git a/backend/generated-go/v1/role_service.pb.go b/backend/generated-go/v1/role_service.pb.goindex b9a2dcd745..77ecf77cfd 100644--- a/backend/generated-go/v1/role_service.pb.go+++ b/backend/generated-go/v1/role_service.pb.go@@ -28,8 +28,10 @@ type Role_Type int32const (Role_TYPE_UNSPECIFIED Role_Type = 0- Role_BUILT_IN Role_Type = 1- Role_CUSTOM Role_Type = 2+ // System-defined role that cannot be modified.+ Role_BUILT_IN Role_Type = 1+ // User-defined role that can be modified.+ Role_CUSTOM Role_Type = 2)// Enum value maps for Role_Type.@@ -75,13 +77,13 @@ func (Role_Type) EnumDescriptor() ([]byte, []int) {type ListRolesRequest struct {state protoimpl.MessageState `protogen:"open.v1"`- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// The maximum number of roles to return. The service may return fewer than// this value.// If unspecified, at most 10 reviews 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"`- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// A page token, received from a previous `ListRoles` call.// Provide this to retrieve the subsequent page.//@@ -138,7 +140,8 @@ func (x *ListRolesRequest) GetPageToken() string {type ListRolesResponse struct {state protoimpl.MessageState `protogen:"open.v1"`- Roles []*Role `protobuf:"bytes,1,rep,name=roles,proto3" json:"roles,omitempty"`+ // The roles from the specified request.+ Roles []*Role `protobuf:"bytes,1,rep,name=roles,proto3" json:"roles,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.NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`@@ -192,7 +195,8 @@ func (x *ListRolesResponse) GetNextPageToken() string {type CreateRoleRequest struct {state protoimpl.MessageState `protogen:"open.v1"`- Role *Role `protobuf:"bytes,1,opt,name=role,proto3" json:"role,omitempty"`+ // The role to create.+ Role *Role `protobuf:"bytes,1,opt,name=role,proto3" json:"role,omitempty"`// The ID to use for the role, which will become the final component// of the role's resource name.//@@ -294,10 +298,13 @@ func (x *GetRoleRequest) GetName() string {}type UpdateRoleRequest struct {- state protoimpl.MessageState `protogen:"open.v1"`- Role *Role `protobuf:"bytes,1,opt,name=role,proto3" json:"role,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The role to update.+ Role *Role `protobuf:"bytes,1,opt,name=role,proto3" json:"role,omitempty"`+ // The list of fields to update.UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`// If set to true, and the role is not found, a new role will be created.+ // In this situation, `update_mask` is ignored.AllowMissing bool `protobuf:"varint,3,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -356,6 +363,7 @@ func (x *UpdateRoleRequest) GetAllowMissing() bool {type DeleteRoleRequest struct {state protoimpl.MessageState `protogen:"open.v1"`+ // The name of the role to delete.// Format: roles/{role}Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`unknownFields protoimpl.UnknownFields@@ -399,13 +407,18 @@ func (x *DeleteRoleRequest) GetName() string {return ""}+// Role defines a set of permissions that can be assigned to users.type Role struct {state protoimpl.MessageState `protogen:"open.v1"`- // Format: roles/{role}- Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,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"`- Permissions []string `protobuf:"bytes,4,rep,name=permissions,proto3" json:"permissions,omitempty"`+ // Resource name. Format: roles/{role}+ Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`+ // Human-readable title.+ Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`+ // Optional description of the role.+ Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`+ // List of permission identifiers granted by this role.+ Permissions []string `protobuf:"bytes,4,rep,name=permissions,proto3" json:"permissions,omitempty"`+ // Role type indicating if it's built-in or custom.Type Role_Type `protobuf:"varint,5,opt,name=type,proto3,enum=bytebase.v1.Role_Type" json:"type,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -493,9 +506,9 @@ const file_v1_role_service_proto_rawDesc = "" +"\arole_id\x18\x02 \x01(\tB\x03\xe0A\x02R\x06roleId\"?\n" +"\x0eGetRoleRequest\x12-\n" +"\x04name\x18\x01 \x01(\tB\x19\xe0A\x02\xfaA\x13\n" +- "\x11bytebase.com/RoleR\x04name\"\x9c\x01\n" +- "\x11UpdateRoleRequest\x12%\n" +- "\x04role\x18\x01 \x01(\v2\x11.bytebase.v1.RoleR\x04role\x12;\n" ++ "\x11bytebase.com/RoleR\x04name\"\xa1\x01\n" ++ "\x11UpdateRoleRequest\x12*\n" ++ "\x04role\x18\x01 \x01(\v2\x11.bytebase.v1.RoleB\x03\xe0A\x02R\x04role\x12;\n" +"\vupdate_mask\x18\x02 \x01(\v2\x1a.google.protobuf.FieldMaskR\n" +"updateMask\x12#\n" +"\rallow_missing\x18\x03 \x01(\bR\fallowMissing\"B\n" +diff --git a/backend/generated-go/v1/role_service_grpc.pb.go b/backend/generated-go/v1/role_service_grpc.pb.goindex eb55922d61..cb9ba7ded8 100644--- a/backend/generated-go/v1/role_service_grpc.pb.go+++ b/backend/generated-go/v1/role_service_grpc.pb.go@@ -30,15 +30,22 @@ const (// RoleServiceClient is the client API for RoleService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// RoleService manages workspace roles and permissions.type RoleServiceClient interface {+ // Lists roles in the workspace.// Permissions required: bb.roles.listListRoles(ctx context.Context, in *ListRolesRequest, opts ...grpc.CallOption) (*ListRolesResponse, error)+ // Retrieves a role by name.// Permissions required: bb.roles.getGetRole(ctx context.Context, in *GetRoleRequest, opts ...grpc.CallOption) (*Role, error)+ // Creates a new custom role.// Permissions required: bb.roles.createCreateRole(ctx context.Context, in *CreateRoleRequest, opts ...grpc.CallOption) (*Role, error)+ // Updates a role's properties.// Permissions required: bb.roles.updateUpdateRole(ctx context.Context, in *UpdateRoleRequest, opts ...grpc.CallOption) (*Role, error)+ // Deletes a custom role.// Permissions required: bb.roles.deleteDeleteRole(ctx context.Context, in *DeleteRoleRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)}@@ -104,15 +111,22 @@ func (c *roleServiceClient) DeleteRole(ctx context.Context, in *DeleteRoleReques// RoleServiceServer is the server API for RoleService service.// All implementations must embed UnimplementedRoleServiceServer// for forward compatibility.+//+// RoleService manages workspace roles and permissions.type RoleServiceServer interface {+ // Lists roles in the workspace.// Permissions required: bb.roles.listListRoles(context.Context, *ListRolesRequest) (*ListRolesResponse, error)+ // Retrieves a role by name.// Permissions required: bb.roles.getGetRole(context.Context, *GetRoleRequest) (*Role, error)+ // Creates a new custom role.// Permissions required: bb.roles.createCreateRole(context.Context, *CreateRoleRequest) (*Role, error)+ // Updates a role's properties.// Permissions required: bb.roles.updateUpdateRole(context.Context, *UpdateRoleRequest) (*Role, error)+ // Deletes a custom role.// Permissions required: bb.roles.deleteDeleteRole(context.Context, *DeleteRoleRequest) (*emptypb.Empty, error)mustEmbedUnimplementedRoleServiceServer()diff --git a/backend/generated-go/v1/rollout_service.pb.go b/backend/generated-go/v1/rollout_service.pb.goindex 68d3b98c9b..b60a1015d5 100644--- a/backend/generated-go/v1/rollout_service.pb.go+++ b/backend/generated-go/v1/rollout_service.pb.go@@ -26,14 +26,22 @@ const (type Task_Status int32const (+ // Unspecified status.Task_STATUS_UNSPECIFIED Task_Status = 0- Task_NOT_STARTED Task_Status = 1- Task_PENDING Task_Status = 2- Task_RUNNING Task_Status = 3- Task_DONE Task_Status = 4- Task_FAILED Task_Status = 5- Task_CANCELED Task_Status = 6- Task_SKIPPED Task_Status = 7+ // Task has not started and is awaiting its turn in the deployment sequence.+ Task_NOT_STARTED Task_Status = 1+ // Task is ready to run and waiting for approval or scheduled time.+ Task_PENDING Task_Status = 2+ // Task is currently executing.+ Task_RUNNING Task_Status = 3+ // Task completed successfully.+ Task_DONE Task_Status = 4+ // Task execution failed with errors.+ Task_FAILED Task_Status = 5+ // Task execution was canceled by a user.+ Task_CANCELED Task_Status = 6+ // Task was skipped and will not be executed.+ Task_SKIPPED Task_Status = 7)// Enum value maps for Task_Status.@@ -90,15 +98,21 @@ func (Task_Status) EnumDescriptor() ([]byte, []int) {type Task_Type int32const (+ // Unspecified task type.Task_TYPE_UNSPECIFIED Task_Type = 0- Task_GENERAL Task_Type = 1- // use payload DatabaseCreate+ // General task for miscellaneous operations.+ Task_GENERAL Task_Type = 1+ // Database creation task that creates a new database.+ // Use payload DatabaseCreate.Task_DATABASE_CREATE Task_Type = 2- // use payload DatabaseUpdate+ // Database migration task that applies versioned schema changes.+ // Use payload DatabaseUpdate.Task_DATABASE_MIGRATE Task_Type = 3- // use payload DatabaseUpdate+ // Database SDL (Schema Definition Language) task that synchronizes declarative schema.+ // Use payload DatabaseUpdate.Task_DATABASE_SDL Task_Type = 6- // use payload DatabaseDataExport+ // Database export task that exports query results or table data.+ // Use payload DatabaseDataExport.Task_DATABASE_EXPORT Task_Type = 5)@@ -152,12 +166,18 @@ func (Task_Type) EnumDescriptor() ([]byte, []int) {type TaskRun_Status int32const (+ // Unspecified status.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+ // Task run is queued and waiting to start execution.+ 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 execution failed with errors.+ TaskRun_FAILED TaskRun_Status = 4+ // Task run execution was canceled by a user.+ TaskRun_CANCELED TaskRun_Status = 5)// Enum value maps for TaskRun_Status.@@ -210,9 +230,12 @@ func (TaskRun_Status) EnumDescriptor() ([]byte, []int) {type TaskRun_ExportArchiveStatus int32const (+ // Unspecified export archive status.TaskRun_EXPORT_ARCHIVE_STATUS_UNSPECIFIED TaskRun_ExportArchiveStatus = 0- TaskRun_READY TaskRun_ExportArchiveStatus = 1- TaskRun_EXPORTED TaskRun_ExportArchiveStatus = 2+ // Export archive is ready for download.+ TaskRun_READY TaskRun_ExportArchiveStatus = 1+ // Export archive has been downloaded by the user.+ TaskRun_EXPORTED TaskRun_ExportArchiveStatus = 2)// Enum value maps for TaskRun_ExportArchiveStatus.@@ -256,18 +279,28 @@ func (TaskRun_ExportArchiveStatus) EnumDescriptor() ([]byte, []int) {return file_v1_rollout_service_proto_rawDescGZIP(), []int{18, 1}}+// The type of log entry.type TaskRunLogEntry_Type int32const (- TaskRunLogEntry_TYPE_UNSPECIFIED TaskRunLogEntry_Type = 0- TaskRunLogEntry_SCHEMA_DUMP TaskRunLogEntry_Type = 1- TaskRunLogEntry_COMMAND_EXECUTE TaskRunLogEntry_Type = 2- TaskRunLogEntry_DATABASE_SYNC TaskRunLogEntry_Type = 3+ // Unspecified type.+ TaskRunLogEntry_TYPE_UNSPECIFIED TaskRunLogEntry_Type = 0+ // Schema dump operation.+ TaskRunLogEntry_SCHEMA_DUMP TaskRunLogEntry_Type = 1+ // Command execution.+ TaskRunLogEntry_COMMAND_EXECUTE TaskRunLogEntry_Type = 2+ // Database synchronization.+ TaskRunLogEntry_DATABASE_SYNC TaskRunLogEntry_Type = 3+ // Task run status update.TaskRunLogEntry_TASK_RUN_STATUS_UPDATE TaskRunLogEntry_Type = 4- TaskRunLogEntry_TRANSACTION_CONTROL TaskRunLogEntry_Type = 5- TaskRunLogEntry_PRIOR_BACKUP TaskRunLogEntry_Type = 6- TaskRunLogEntry_RETRY_INFO TaskRunLogEntry_Type = 7- TaskRunLogEntry_COMPUTE_DIFF TaskRunLogEntry_Type = 8+ // Transaction control (BEGIN, COMMIT, ROLLBACK).+ TaskRunLogEntry_TRANSACTION_CONTROL TaskRunLogEntry_Type = 5+ // Prior backup operation.+ TaskRunLogEntry_PRIOR_BACKUP TaskRunLogEntry_Type = 6+ // Retry information.+ TaskRunLogEntry_RETRY_INFO TaskRunLogEntry_Type = 7+ // Schema diff computation.+ TaskRunLogEntry_COMPUTE_DIFF TaskRunLogEntry_Type = 8)// Enum value maps for TaskRunLogEntry_Type.@@ -323,9 +356,11 @@ func (TaskRunLogEntry_Type) EnumDescriptor() ([]byte, []int) {return file_v1_rollout_service_proto_rawDescGZIP(), []int{20, 0}}+// Internal status for task run execution.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 schedulerTaskRunLogEntry_TaskRunStatusUpdate_RUNNING_WAITING TaskRunLogEntry_TaskRunStatusUpdate_Status = 1@@ -374,13 +409,18 @@ func (TaskRunLogEntry_TaskRunStatusUpdate_Status) EnumDescriptor() ([]byte, []inreturn file_v1_rollout_service_proto_rawDescGZIP(), []int{20, 3, 0}}+// Transaction control type.type TaskRunLogEntry_TransactionControl_Type int32const (+ // Unspecified type.TaskRunLogEntry_TransactionControl_TYPE_UNSPECIFIED TaskRunLogEntry_TransactionControl_Type = 0- TaskRunLogEntry_TransactionControl_BEGIN TaskRunLogEntry_TransactionControl_Type = 1- TaskRunLogEntry_TransactionControl_COMMIT TaskRunLogEntry_TransactionControl_Type = 2- TaskRunLogEntry_TransactionControl_ROLLBACK TaskRunLogEntry_TransactionControl_Type = 3+ // Begin transaction.+ TaskRunLogEntry_TransactionControl_BEGIN TaskRunLogEntry_TransactionControl_Type = 1+ // Commit transaction.+ TaskRunLogEntry_TransactionControl_COMMIT TaskRunLogEntry_TransactionControl_Type = 2+ // Rollback transaction.+ TaskRunLogEntry_TransactionControl_ROLLBACK TaskRunLogEntry_TransactionControl_Type = 3)// Enum value maps for TaskRunLogEntry_TransactionControl_Type.@@ -433,8 +473,9 @@ type BatchRunTasksRequest struct {Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`// The tasks to run.// Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}- Tasks []string `protobuf:"bytes,2,rep,name=tasks,proto3" json:"tasks,omitempty"`- Reason string `protobuf:"bytes,3,opt,name=reason,proto3" json:"reason,omitempty"`+ Tasks []string `protobuf:"bytes,2,rep,name=tasks,proto3" json:"tasks,omitempty"`+ // The reason for running the tasks.+ Reason string `protobuf:"bytes,3,opt,name=reason,proto3" json:"reason,omitempty"`// The task run should run after run_time.RunTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=run_time,json=runTime,proto3,oneof" json:"run_time,omitempty"`unknownFields protoimpl.UnknownFields@@ -542,8 +583,9 @@ type BatchSkipTasksRequest struct {Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`// The tasks to skip.// Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}- Tasks []string `protobuf:"bytes,2,rep,name=tasks,proto3" json:"tasks,omitempty"`- Reason string `protobuf:"bytes,3,opt,name=reason,proto3" json:"reason,omitempty"`+ Tasks []string `protobuf:"bytes,2,rep,name=tasks,proto3" json:"tasks,omitempty"`+ // The reason for skipping the tasks.+ Reason string `protobuf:"bytes,3,opt,name=reason,proto3" json:"reason,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -643,8 +685,9 @@ type BatchCancelTaskRunsRequest struct {Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`// The taskRuns to cancel.// Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{taskRun}- TaskRuns []string `protobuf:"bytes,2,rep,name=task_runs,json=taskRuns,proto3" json:"task_runs,omitempty"`- Reason string `protobuf:"bytes,3,opt,name=reason,proto3" json:"reason,omitempty"`+ TaskRuns []string `protobuf:"bytes,2,rep,name=task_runs,json=taskRuns,proto3" json:"task_runs,omitempty"`+ // The reason for canceling the task runs.+ Reason string `protobuf:"bytes,3,opt,name=reason,proto3" json:"reason,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -1067,13 +1110,13 @@ type ListTaskRunsRequest struct {// Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}// Use "projects/{project}/rollouts/{rollout}/stages/-/tasks/-" to list all taskRuns from a rollout.Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// The maximum number of taskRuns to return. The service may return fewer than// this value.// If unspecified, at most 10 taskRuns 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"`- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// A page token, received from a previous `ListTaskRuns` call.// Provide this to retrieve the subsequent page.//@@ -1402,7 +1445,8 @@ type Stage struct {Id string `protobuf:"bytes,3,opt,name=id,proto3" json:"id,omitempty"`// environment is the environment of the stage.// Format: environments/{environment} for valid environments, or "environments/-" for stages without environment or with deleted environments.- Environment string `protobuf:"bytes,4,opt,name=environment,proto3" json:"environment,omitempty"`+ Environment string `protobuf:"bytes,4,opt,name=environment,proto3" json:"environment,omitempty"`+ // The tasks within this stage.Tasks []*Task `protobuf:"bytes,5,rep,name=tasks,proto3" json:"tasks,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -1474,9 +1518,10 @@ type Task struct {// Could be empty if the rollout of the task does not have an associating plan.SpecId string `protobuf:"bytes,4,opt,name=spec_id,json=specId,proto3" json:"spec_id,omitempty"`// Status is the status of the task.- Status Task_Status `protobuf:"varint,5,opt,name=status,proto3,enum=bytebase.v1.Task_Status" json:"status,omitempty"`- SkippedReason string `protobuf:"bytes,15,opt,name=skipped_reason,json=skippedReason,proto3" json:"skipped_reason,omitempty"`- Type Task_Type `protobuf:"varint,6,opt,name=type,proto3,enum=bytebase.v1.Task_Type" json:"type,omitempty"`+ Status Task_Status `protobuf:"varint,5,opt,name=status,proto3,enum=bytebase.v1.Task_Status" json:"status,omitempty"`+ // The reason why the task was skipped.+ SkippedReason string `protobuf:"bytes,15,opt,name=skipped_reason,json=skippedReason,proto3" json:"skipped_reason,omitempty"`+ Type Task_Type `protobuf:"varint,6,opt,name=type,proto3,enum=bytebase.v1.Task_Type" json:"type,omitempty"`// Format: instances/{instance} if the task is DatabaseCreate.// Format: instances/{instance}/databases/{database}Target string `protobuf:"bytes,8,opt,name=target,proto3" json:"target,omitempty"`@@ -1642,22 +1687,28 @@ type TaskRun struct {state protoimpl.MessageState `protogen:"open.v1"`// Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{taskRun}Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`- // Format: user/[email protected]+ // Format: users/[email protected]Creator string `protobuf:"bytes,3,opt,name=creator,proto3" json:"creator,omitempty"`CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`- Status TaskRun_Status `protobuf:"varint,8,opt,name=status,proto3,enum=bytebase.v1.TaskRun_Status" json:"status,omitempty"`+ // The current execution status of the task run.+ Status TaskRun_Status `protobuf:"varint,8,opt,name=status,proto3,enum=bytebase.v1.TaskRun_Status" json:"status,omitempty"`// Below are the results of a task run.+ // Detailed information about the task run result.Detail string `protobuf:"bytes,9,opt,name=detail,proto3" json:"detail,omitempty"`// The resource name of the changelog.// Format: instances/{instance}/databases/{database}/changelogs/{changelog}- Changelog string `protobuf:"bytes,20,opt,name=changelog,proto3" json:"changelog,omitempty"`- SchemaVersion string `protobuf:"bytes,11,opt,name=schema_version,json=schemaVersion,proto3" json:"schema_version,omitempty"`- StartTime *timestamppb.Timestamp `protobuf:"bytes,14,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`+ Changelog string `protobuf:"bytes,20,opt,name=changelog,proto3" json:"changelog,omitempty"`+ // The schema version after this task run completes.+ SchemaVersion string `protobuf:"bytes,11,opt,name=schema_version,json=schemaVersion,proto3" json:"schema_version,omitempty"`+ // The time when the task run started execution.+ StartTime *timestamppb.Timestamp `protobuf:"bytes,14,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`+ // The export archive status for data export tasks.ExportArchiveStatus TaskRun_ExportArchiveStatus `protobuf:"varint,16,opt,name=export_archive_status,json=exportArchiveStatus,proto3,enum=bytebase.v1.TaskRun_ExportArchiveStatus" json:"export_archive_status,omitempty"`// The prior backup detail that will be used to rollback the task run.PriorBackupDetail *TaskRun_PriorBackupDetail `protobuf:"bytes,17,opt,name=prior_backup_detail,json=priorBackupDetail,proto3" json:"prior_backup_detail,omitempty"`- SchedulerInfo *TaskRun_SchedulerInfo `protobuf:"bytes,18,opt,name=scheduler_info,json=schedulerInfo,proto3" json:"scheduler_info,omitempty"`+ // Scheduling information about the task run.+ SchedulerInfo *TaskRun_SchedulerInfo `protobuf:"bytes,18,opt,name=scheduler_info,json=schedulerInfo,proto3" json:"scheduler_info,omitempty"`// Format: projects/{project}/sheets/{sheet}Sheet string `protobuf:"bytes,19,opt,name=sheet,proto3" json:"sheet,omitempty"`// The task run should run after run_time.@@ -1798,7 +1849,8 @@ func (x *TaskRun) GetRunTime() *timestamppb.Timestamp {type TaskRunLog struct {state protoimpl.MessageState `protogen:"open.v1"`// Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/log- 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 log entries for this task run.Entries []*TaskRunLogEntry `protobuf:"bytes,2,rep,name=entries,proto3" json:"entries,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -1849,20 +1901,31 @@ func (x *TaskRunLog) GetEntries() []*TaskRunLogEntry {}type TaskRunLogEntry struct {- state protoimpl.MessageState `protogen:"open.v1"`- Type TaskRunLogEntry_Type `protobuf:"varint,1,opt,name=type,proto3,enum=bytebase.v1.TaskRunLogEntry_Type" json:"type,omitempty"`- LogTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=log_time,json=logTime,proto3" json:"log_time,omitempty"`- DeployId string `protobuf:"bytes,12,opt,name=deploy_id,json=deployId,proto3" json:"deploy_id,omitempty"`- SchemaDump *TaskRunLogEntry_SchemaDump `protobuf:"bytes,2,opt,name=schema_dump,json=schemaDump,proto3" json:"schema_dump,omitempty"`- CommandExecute *TaskRunLogEntry_CommandExecute `protobuf:"bytes,3,opt,name=command_execute,json=commandExecute,proto3" json:"command_execute,omitempty"`- DatabaseSync *TaskRunLogEntry_DatabaseSync `protobuf:"bytes,4,opt,name=database_sync,json=databaseSync,proto3" json:"database_sync,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The type of this log entry.+ Type TaskRunLogEntry_Type `protobuf:"varint,1,opt,name=type,proto3,enum=bytebase.v1.TaskRunLogEntry_Type" json:"type,omitempty"`+ // The time when the log was recorded.+ LogTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=log_time,json=logTime,proto3" json:"log_time,omitempty"`+ // The deployment ID for this log entry.+ DeployId string `protobuf:"bytes,12,opt,name=deploy_id,json=deployId,proto3" json:"deploy_id,omitempty"`+ // Schema dump details (if type is SCHEMA_DUMP).+ SchemaDump *TaskRunLogEntry_SchemaDump `protobuf:"bytes,2,opt,name=schema_dump,json=schemaDump,proto3" json:"schema_dump,omitempty"`+ // Command execution details (if type is COMMAND_EXECUTE).+ CommandExecute *TaskRunLogEntry_CommandExecute `protobuf:"bytes,3,opt,name=command_execute,json=commandExecute,proto3" json:"command_execute,omitempty"`+ // Database sync details (if type is DATABASE_SYNC).+ DatabaseSync *TaskRunLogEntry_DatabaseSync `protobuf:"bytes,4,opt,name=database_sync,json=databaseSync,proto3" json:"database_sync,omitempty"`+ // Task run status update details (if type is TASK_RUN_STATUS_UPDATE).TaskRunStatusUpdate *TaskRunLogEntry_TaskRunStatusUpdate `protobuf:"bytes,5,opt,name=task_run_status_update,json=taskRunStatusUpdate,proto3" json:"task_run_status_update,omitempty"`- TransactionControl *TaskRunLogEntry_TransactionControl `protobuf:"bytes,7,opt,name=transaction_control,json=transactionControl,proto3" json:"transaction_control,omitempty"`- PriorBackup *TaskRunLogEntry_PriorBackup `protobuf:"bytes,8,opt,name=prior_backup,json=priorBackup,proto3" json:"prior_backup,omitempty"`- RetryInfo *TaskRunLogEntry_RetryInfo `protobuf:"bytes,9,opt,name=retry_info,json=retryInfo,proto3" json:"retry_info,omitempty"`- ComputeDiff *TaskRunLogEntry_ComputeDiff `protobuf:"bytes,10,opt,name=compute_diff,json=computeDiff,proto3" json:"compute_diff,omitempty"`- unknownFields protoimpl.UnknownFields- sizeCache protoimpl.SizeCache+ // Transaction control details (if type is TRANSACTION_CONTROL).+ TransactionControl *TaskRunLogEntry_TransactionControl `protobuf:"bytes,7,opt,name=transaction_control,json=transactionControl,proto3" json:"transaction_control,omitempty"`+ // Prior backup details (if type is PRIOR_BACKUP).+ PriorBackup *TaskRunLogEntry_PriorBackup `protobuf:"bytes,8,opt,name=prior_backup,json=priorBackup,proto3" json:"prior_backup,omitempty"`+ // Retry information details (if type is RETRY_INFO).+ RetryInfo *TaskRunLogEntry_RetryInfo `protobuf:"bytes,9,opt,name=retry_info,json=retryInfo,proto3" json:"retry_info,omitempty"`+ // Compute diff details (if type is COMPUTE_DIFF).+ ComputeDiff *TaskRunLogEntry_ComputeDiff `protobuf:"bytes,10,opt,name=compute_diff,json=computeDiff,proto3" json:"compute_diff,omitempty"`+ unknownFields protoimpl.UnknownFields+ sizeCache protoimpl.SizeCache}func (x *TaskRunLogEntry) Reset() {@@ -2021,6 +2084,8 @@ type TaskRunSession struct {state protoimpl.MessageState `protogen:"open.v1"`// Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/sessionName string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`+ // Database-specific session information.+ //// Types that are valid to be assigned to Session://// *TaskRunSession_Postgres_@@ -2087,6 +2152,7 @@ type isTaskRunSession_Session interface {}type TaskRunSession_Postgres_ struct {+ // PostgreSQL session information.Postgres *TaskRunSession_Postgres `protobuf:"bytes,2,opt,name=postgres,proto3,oneof"`}@@ -2138,8 +2204,9 @@ func (x *PreviewTaskRunRollbackRequest) GetName() string {}type PreviewTaskRunRollbackResponse struct {- state protoimpl.MessageState `protogen:"open.v1"`- Statement string `protobuf:"bytes,1,opt,name=statement,proto3" json:"statement,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The rollback SQL statement that would undo the task run.+ Statement string `protobuf:"bytes,1,opt,name=statement,proto3" json:"statement,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -2181,6 +2248,7 @@ func (x *PreviewTaskRunRollbackResponse) GetStatement() string {return ""}+// Payload for creating a new database.type Task_DatabaseCreate struct {state protoimpl.MessageState `protogen:"open.v1"`// The project owning the database.@@ -2191,9 +2259,12 @@ type Task_DatabaseCreate struct {// table nameTable 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"`- CharacterSet string `protobuf:"bytes,5,opt,name=character_set,json=characterSet,proto3" json:"character_set,omitempty"`- Collation string `protobuf:"bytes,6,opt,name=collation,proto3" json:"collation,omitempty"`+ Sheet string `protobuf:"bytes,4,opt,name=sheet,proto3" json:"sheet,omitempty"`+ // The character set for the database.+ CharacterSet string `protobuf:"bytes,5,opt,name=character_set,json=characterSet,proto3" json:"character_set,omitempty"`+ // The collation for the database.+ Collation string `protobuf:"bytes,6,opt,name=collation,proto3" json:"collation,omitempty"`+ // The environment the database belongs to.Environment string `protobuf:"bytes,7,opt,name=environment,proto3" json:"environment,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -2278,11 +2349,14 @@ func (x *Task_DatabaseCreate) GetEnvironment() string {return ""}+// Payload for updating a database schema.type Task_DatabaseUpdate struct {state protoimpl.MessageState `protogen:"open.v1"`// Format: projects/{project}/sheets/{sheet}- Sheet string `protobuf:"bytes,1,opt,name=sheet,proto3" json:"sheet,omitempty"`- SchemaVersion string `protobuf:"bytes,2,opt,name=schema_version,json=schemaVersion,proto3" json:"schema_version,omitempty"`+ Sheet string `protobuf:"bytes,1,opt,name=sheet,proto3" json:"sheet,omitempty"`+ // The target schema version after this update.+ SchemaVersion string `protobuf:"bytes,2,opt,name=schema_version,json=schemaVersion,proto3" json:"schema_version,omitempty"`+ // The type of database change (MIGRATE or SDL).DatabaseChangeType DatabaseChangeType `protobuf:"varint,3,opt,name=database_change_type,json=databaseChangeType,proto3,enum=bytebase.v1.DatabaseChangeType" json:"database_change_type,omitempty"`// migration_type is only set when database_change_type is MIGRATE.MigrationType MigrationType `protobuf:"varint,4,opt,name=migration_type,json=migrationType,proto3,enum=bytebase.v1.MigrationType" json:"migration_type,omitempty"`@@ -2348,6 +2422,7 @@ func (x *Task_DatabaseUpdate) GetMigrationType() MigrationType {return MigrationType_MIGRATION_TYPE_UNSPECIFIED}+// Payload for exporting database data.type Task_DatabaseDataExport struct {state protoimpl.MessageState `protogen:"open.v1"`// The resource name of the target.@@ -2358,7 +2433,7 @@ type Task_DatabaseDataExport 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.v1.ExportFormat" json:"format,omitempty"`- // The zip password provide by users.+ // The zip password provided by users.// Leave it empty if no needs to encrypt the zip file.Password *string `protobuf:"bytes,4,opt,name=password,proto3,oneof" json:"password,omitempty"`unknownFields protoimpl.UnknownFields@@ -2423,8 +2498,10 @@ func (x *Task_DatabaseDataExport) GetPassword() string {return ""}+// Prior backup detail for rollback purposes.type TaskRun_PriorBackupDetail struct {- state protoimpl.MessageState `protogen:"open.v1"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The list of backed up tables.Items []*TaskRun_PriorBackupDetail_Item `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -2467,9 +2544,12 @@ func (x *TaskRun_PriorBackupDetail) GetItems() []*TaskRun_PriorBackupDetail_Itemreturn nil}+// Information about task run scheduling.type TaskRun_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"`+ // The time when the scheduling info was reported.+ ReportTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=report_time,json=reportTime,proto3" json:"report_time,omitempty"`+ // The cause for the task run waiting.WaitingCause *TaskRun_SchedulerInfo_WaitingCause `protobuf:"bytes,2,opt,name=waiting_cause,json=waitingCause,proto3" json:"waiting_cause,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -2519,14 +2599,17 @@ func (x *TaskRun_SchedulerInfo) GetWaitingCause() *TaskRun_SchedulerInfo_Waitingreturn nil}+// A single backup table mapping.type TaskRun_PriorBackupDetail_Item struct {state protoimpl.MessageState `protogen:"open.v1"`// The original table information.SourceTable *TaskRun_PriorBackupDetail_Item_Table `protobuf:"bytes,1,opt,name=source_table,json=sourceTable,proto3" json:"source_table,omitempty"`// The target backup table information.- TargetTable *TaskRun_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"`+ TargetTable *TaskRun_PriorBackupDetail_Item_Table `protobuf:"bytes,2,opt,name=target_table,json=targetTable,proto3" json:"target_table,omitempty"`+ // The start position in the SQL statement.+ StartPosition *Position `protobuf:"bytes,3,opt,name=start_position,json=startPosition,proto3" json:"start_position,omitempty"`+ // The end position in the SQL statement.+ EndPosition *Position `protobuf:"bytes,4,opt,name=end_position,json=endPosition,proto3" json:"end_position,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -2589,12 +2672,15 @@ func (x *TaskRun_PriorBackupDetail_Item) GetEndPosition() *Position {return nil}+// Table information.type TaskRun_PriorBackupDetail_Item_Table struct {state protoimpl.MessageState `protogen:"open.v1"`// The database information.// 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"`+ // The schema name.+ Schema string `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"`+ // The table name.Table string `protobuf:"bytes,3,opt,name=table,proto3" json:"table,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -2651,8 +2737,11 @@ func (x *TaskRun_PriorBackupDetail_Item_Table) GetTable() string {return ""}+// Information about why a task run is waiting.type TaskRun_SchedulerInfo_WaitingCause struct {state protoimpl.MessageState `protogen:"open.v1"`+ // The reason the task run is waiting.+ //// Types that are valid to be assigned to Cause://// *TaskRun_SchedulerInfo_WaitingCause_ConnectionLimit@@ -2732,14 +2821,17 @@ type isTaskRun_SchedulerInfo_WaitingCause_Cause interface {}type TaskRun_SchedulerInfo_WaitingCause_ConnectionLimit struct {+ // Waiting due to connection limit reached.ConnectionLimit bool `protobuf:"varint,1,opt,name=connection_limit,json=connectionLimit,proto3,oneof"`}type TaskRun_SchedulerInfo_WaitingCause_Task_ struct {+ // Waiting for another task to complete.Task *TaskRun_SchedulerInfo_WaitingCause_Task `protobuf:"bytes,2,opt,name=task,proto3,oneof"`}type TaskRun_SchedulerInfo_WaitingCause_ParallelTasksLimit struct {+ // Waiting due to parallel tasks limit.ParallelTasksLimit bool `protobuf:"varint,3,opt,name=parallel_tasks_limit,json=parallelTasksLimit,proto3,oneof"`}@@ -2751,6 +2843,7 @@ func (*TaskRun_SchedulerInfo_WaitingCause_Task_) isTaskRun_SchedulerInfo_Waitingfunc (*TaskRun_SchedulerInfo_WaitingCause_ParallelTasksLimit) isTaskRun_SchedulerInfo_WaitingCause_Cause() {}+// Information about a blocking task.type TaskRun_SchedulerInfo_WaitingCause_Task struct {state protoimpl.MessageState `protogen:"open.v1"`// Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}@@ -2805,11 +2898,15 @@ func (x *TaskRun_SchedulerInfo_WaitingCause_Task) GetIssue() string {return ""}+// Schema dump operation details.type TaskRunLogEntry_SchemaDump struct {- state protoimpl.MessageState `protogen:"open.v1"`- StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`- EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`- Error string `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // When the schema dump started.+ StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`+ // When the schema dump ended.+ EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`+ // Error message if the schema dump failed.+ Error string `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -2865,14 +2962,17 @@ func (x *TaskRunLogEntry_SchemaDump) GetError() string {return ""}+// Command execution details.type TaskRunLogEntry_CommandExecute struct {- state protoimpl.MessageState `protogen:"open.v1"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // When the command was logged.LogTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=log_time,json=logTime,proto3" json:"log_time,omitempty"`// Either `command_indexes` or `statement` is set.// The indexes of the executed commands.CommandIndexes []int32 `protobuf:"varint,2,rep,packed,name=command_indexes,json=commandIndexes,proto3" json:"command_indexes,omitempty"`// The executed statement.- Statement string `protobuf:"bytes,4,opt,name=statement,proto3" json:"statement,omitempty"`+ Statement string `protobuf:"bytes,4,opt,name=statement,proto3" json:"statement,omitempty"`+ // The response from executing the command.Response *TaskRunLogEntry_CommandExecute_CommandResponse `protobuf:"bytes,3,opt,name=response,proto3" json:"response,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -2936,11 +3036,15 @@ func (x *TaskRunLogEntry_CommandExecute) GetResponse() *TaskRunLogEntry_CommandEreturn nil}+// Database synchronization details.type TaskRunLogEntry_DatabaseSync struct {- state protoimpl.MessageState `protogen:"open.v1"`- StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`- EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`- Error string `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // When the database sync started.+ StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`+ // When the database sync ended.+ EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`+ // Error message if sync failed.+ Error string `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -2996,8 +3100,10 @@ func (x *TaskRunLogEntry_DatabaseSync) GetError() string {return ""}+// Task run status update details.type TaskRunLogEntry_TaskRunStatusUpdate struct {- state protoimpl.MessageState `protogen:"open.v1"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The new status.Status TaskRunLogEntry_TaskRunStatusUpdate_Status `protobuf:"varint,1,opt,name=status,proto3,enum=bytebase.v1.TaskRunLogEntry_TaskRunStatusUpdate_Status" json:"status,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -3040,10 +3146,13 @@ func (x *TaskRunLogEntry_TaskRunStatusUpdate) GetStatus() TaskRunLogEntry_TaskRureturn TaskRunLogEntry_TaskRunStatusUpdate_STATUS_UNSPECIFIED}+// Transaction control operation details.type TaskRunLogEntry_TransactionControl struct {- state protoimpl.MessageState `protogen:"open.v1"`- Type TaskRunLogEntry_TransactionControl_Type `protobuf:"varint,1,opt,name=type,proto3,enum=bytebase.v1.TaskRunLogEntry_TransactionControl_Type" json:"type,omitempty"`- Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The type of transaction control.+ Type TaskRunLogEntry_TransactionControl_Type `protobuf:"varint,1,opt,name=type,proto3,enum=bytebase.v1.TaskRunLogEntry_TransactionControl_Type" json:"type,omitempty"`+ // Error message if the operation failed.+ Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -3092,14 +3201,19 @@ func (x *TaskRunLogEntry_TransactionControl) GetError() string {return ""}+// Prior backup operation details.type TaskRunLogEntry_PriorBackup struct {- state protoimpl.MessageState `protogen:"open.v1"`- StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`- EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // When the backup started.+ StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`+ // When the backup ended.+ EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`+ // The backup details.PriorBackupDetail *TaskRun_PriorBackupDetail `protobuf:"bytes,3,opt,name=prior_backup_detail,json=priorBackupDetail,proto3" json:"prior_backup_detail,omitempty"`- Error string `protobuf:"bytes,4,opt,name=error,proto3" json:"error,omitempty"`- unknownFields protoimpl.UnknownFields- sizeCache protoimpl.SizeCache+ // Error message if the backup failed.+ Error string `protobuf:"bytes,4,opt,name=error,proto3" json:"error,omitempty"`+ unknownFields protoimpl.UnknownFields+ sizeCache protoimpl.SizeCache}func (x *TaskRunLogEntry_PriorBackup) Reset() {@@ -3160,11 +3274,15 @@ func (x *TaskRunLogEntry_PriorBackup) GetError() string {return ""}+// Retry information for failed operations.type TaskRunLogEntry_RetryInfo struct {- state protoimpl.MessageState `protogen:"open.v1"`- Error string `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"`- RetryCount int32 `protobuf:"varint,2,opt,name=retry_count,json=retryCount,proto3" json:"retry_count,omitempty"`- MaximumRetries int32 `protobuf:"varint,3,opt,name=maximum_retries,json=maximumRetries,proto3" json:"maximum_retries,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The error that triggered the retry.+ Error string `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"`+ // Current retry attempt number.+ RetryCount int32 `protobuf:"varint,2,opt,name=retry_count,json=retryCount,proto3" json:"retry_count,omitempty"`+ // Maximum number of retries allowed.+ MaximumRetries int32 `protobuf:"varint,3,opt,name=maximum_retries,json=maximumRetries,proto3" json:"maximum_retries,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -3220,11 +3338,15 @@ func (x *TaskRunLogEntry_RetryInfo) GetMaximumRetries() int32 {return 0}+// Schema diff computation details.type TaskRunLogEntry_ComputeDiff struct {- state protoimpl.MessageState `protogen:"open.v1"`- StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`- EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`- Error string `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // When diff computation started.+ StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`+ // When diff computation ended.+ EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`+ // Error message if computation failed.+ Error string `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -3280,11 +3402,15 @@ func (x *TaskRunLogEntry_ComputeDiff) GetError() string {return ""}+// Command execution response.type TaskRunLogEntry_CommandExecute_CommandResponse struct {- state protoimpl.MessageState `protogen:"open.v1"`- LogTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=log_time,json=logTime,proto3" json:"log_time,omitempty"`- Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`- AffectedRows int64 `protobuf:"varint,3,opt,name=affected_rows,json=affectedRows,proto3" json:"affected_rows,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // When the response was logged.+ LogTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=log_time,json=logTime,proto3" json:"log_time,omitempty"`+ // Error message if command execution failed.+ Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`+ // Total affected rows.+ AffectedRows int64 `protobuf:"varint,3,opt,name=affected_rows,json=affectedRows,proto3" json:"affected_rows,omitempty"`// `all_affected_rows` is the affected rows of each command.// `all_affected_rows` may be unavailable if the database driver doesn't support it. Caller should fallback to `affected_rows` in that case.AllAffectedRows []int64 `protobuf:"varint,4,rep,packed,name=all_affected_rows,json=allAffectedRows,proto3" json:"all_affected_rows,omitempty"`@@ -3350,6 +3476,7 @@ func (x *TaskRunLogEntry_CommandExecute_CommandResponse) GetAllAffectedRows() []return nil}+// PostgreSQL session information.type TaskRunSession_Postgres struct {state protoimpl.MessageState `protogen:"open.v1"`// `session` is the session of the task run executing commands.@@ -3413,25 +3540,39 @@ func (x *TaskRunSession_Postgres) GetBlockedSessions() []*TaskRunSession_Postgrereturn nil}-// Read from `pg_stat_activity`+// PostgreSQL session information read from `pg_stat_activity`.type TaskRunSession_Postgres_Session struct {- state protoimpl.MessageState `protogen:"open.v1"`- Pid string `protobuf:"bytes,1,opt,name=pid,proto3" json:"pid,omitempty"`- BlockedByPids []string `protobuf:"bytes,2,rep,name=blocked_by_pids,json=blockedByPids,proto3" json:"blocked_by_pids,omitempty"`- Query string `protobuf:"bytes,3,opt,name=query,proto3" json:"query,omitempty"`- State *string `protobuf:"bytes,4,opt,name=state,proto3,oneof" json:"state,omitempty"`- WaitEventType *string `protobuf:"bytes,5,opt,name=wait_event_type,json=waitEventType,proto3,oneof" json:"wait_event_type,omitempty"`- WaitEvent *string `protobuf:"bytes,6,opt,name=wait_event,json=waitEvent,proto3,oneof" json:"wait_event,omitempty"`- Datname *string `protobuf:"bytes,7,opt,name=datname,proto3,oneof" json:"datname,omitempty"`- Usename *string `protobuf:"bytes,8,opt,name=usename,proto3,oneof" json:"usename,omitempty"`- ApplicationName string `protobuf:"bytes,9,opt,name=application_name,json=applicationName,proto3" json:"application_name,omitempty"`- ClientAddr *string `protobuf:"bytes,10,opt,name=client_addr,json=clientAddr,proto3,oneof" json:"client_addr,omitempty"`- ClientPort *string `protobuf:"bytes,11,opt,name=client_port,json=clientPort,proto3,oneof" json:"client_port,omitempty"`- BackendStart *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=backend_start,json=backendStart,proto3" json:"backend_start,omitempty"`- XactStart *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=xact_start,json=xactStart,proto3,oneof" json:"xact_start,omitempty"`- QueryStart *timestamppb.Timestamp `protobuf:"bytes,14,opt,name=query_start,json=queryStart,proto3,oneof" json:"query_start,omitempty"`- unknownFields protoimpl.UnknownFields- sizeCache protoimpl.SizeCache+ state protoimpl.MessageState `protogen:"open.v1"`+ // Process ID of the session.+ Pid string `protobuf:"bytes,1,opt,name=pid,proto3" json:"pid,omitempty"`+ // PIDs of sessions blocking this session.+ BlockedByPids []string `protobuf:"bytes,2,rep,name=blocked_by_pids,json=blockedByPids,proto3" json:"blocked_by_pids,omitempty"`+ // Current query being executed.+ Query string `protobuf:"bytes,3,opt,name=query,proto3" json:"query,omitempty"`+ // Session state (active, idle, etc.).+ State *string `protobuf:"bytes,4,opt,name=state,proto3,oneof" json:"state,omitempty"`+ // Wait event type if session is waiting.+ WaitEventType *string `protobuf:"bytes,5,opt,name=wait_event_type,json=waitEventType,proto3,oneof" json:"wait_event_type,omitempty"`+ // Specific wait event if session is waiting.+ WaitEvent *string `protobuf:"bytes,6,opt,name=wait_event,json=waitEvent,proto3,oneof" json:"wait_event,omitempty"`+ // Database name.+ Datname *string `protobuf:"bytes,7,opt,name=datname,proto3,oneof" json:"datname,omitempty"`+ // User name.+ Usename *string `protobuf:"bytes,8,opt,name=usename,proto3,oneof" json:"usename,omitempty"`+ // Application name.+ ApplicationName string `protobuf:"bytes,9,opt,name=application_name,json=applicationName,proto3" json:"application_name,omitempty"`+ // Client IP address.+ ClientAddr *string `protobuf:"bytes,10,opt,name=client_addr,json=clientAddr,proto3,oneof" json:"client_addr,omitempty"`+ // Client port number.+ ClientPort *string `protobuf:"bytes,11,opt,name=client_port,json=clientPort,proto3,oneof" json:"client_port,omitempty"`+ // When the backend process started.+ BackendStart *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=backend_start,json=backendStart,proto3" json:"backend_start,omitempty"`+ // When the current transaction started.+ XactStart *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=xact_start,json=xactStart,proto3,oneof" json:"xact_start,omitempty"`+ // When the current query started.+ QueryStart *timestamppb.Timestamp `protobuf:"bytes,14,opt,name=query_start,json=queryStart,proto3,oneof" json:"query_start,omitempty"`+ unknownFields protoimpl.UnknownFields+ sizeCache protoimpl.SizeCache}func (x *TaskRunSession_Postgres_Session) Reset() {diff --git a/backend/generated-go/v1/rollout_service_grpc.pb.go b/backend/generated-go/v1/rollout_service_grpc.pb.goindex 5e05336972..834d47b597 100644--- a/backend/generated-go/v1/rollout_service_grpc.pb.go+++ b/backend/generated-go/v1/rollout_service_grpc.pb.go@@ -36,29 +36,43 @@ const (// RolloutServiceClient is the client API for RolloutService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// RolloutService manages the execution of deployment plans.type RolloutServiceClient interface {+ // Retrieves a rollout by name.// Permissions required: bb.rollouts.getGetRollout(ctx context.Context, in *GetRolloutRequest, opts ...grpc.CallOption) (*Rollout, error)+ // Lists rollouts in a project.// Permissions required: bb.rollouts.listListRollouts(ctx context.Context, in *ListRolloutsRequest, opts ...grpc.CallOption) (*ListRolloutsResponse, error)+ // Creates a new rollout from a plan.// Permissions required: bb.rollouts.createCreateRollout(ctx context.Context, in *CreateRolloutRequest, opts ...grpc.CallOption) (*Rollout, error)+ // Previews the rollout that would be created from a plan.// Permissions required: bb.rollouts.previewPreviewRollout(ctx context.Context, in *PreviewRolloutRequest, opts ...grpc.CallOption) (*Rollout, error)+ // Lists task run executions for a task.// Permissions required: bb.taskRuns.listListTaskRuns(ctx context.Context, in *ListTaskRunsRequest, opts ...grpc.CallOption) (*ListTaskRunsResponse, error)+ // Retrieves a task run by name.// Permissions required: bb.taskRuns.listGetTaskRun(ctx context.Context, in *GetTaskRunRequest, opts ...grpc.CallOption) (*TaskRun, error)+ // Retrieves execution logs for a task run.// Permissions required: bb.taskRuns.listGetTaskRunLog(ctx context.Context, in *GetTaskRunLogRequest, opts ...grpc.CallOption) (*TaskRunLog, error)+ // Retrieves database session information for a running task.// Permissions required: bb.taskRuns.listGetTaskRunSession(ctx context.Context, in *GetTaskRunSessionRequest, opts ...grpc.CallOption) (*TaskRunSession, error)- // Permissions required: None+ // Executes multiple tasks in a rollout stage.+ // Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)BatchRunTasks(ctx context.Context, in *BatchRunTasksRequest, opts ...grpc.CallOption) (*BatchRunTasksResponse, error)- // Permissions required: None+ // Skips multiple tasks in a rollout stage.+ // Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)BatchSkipTasks(ctx context.Context, in *BatchSkipTasksRequest, opts ...grpc.CallOption) (*BatchSkipTasksResponse, error)- // Permissions required: None+ // Cancels multiple running task executions.+ // Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)BatchCancelTaskRuns(ctx context.Context, in *BatchCancelTaskRunsRequest, opts ...grpc.CallOption) (*BatchCancelTaskRunsResponse, error)+ // Generates rollback SQL for a completed task run.// Permissions required: bb.taskRuns.listPreviewTaskRunRollback(ctx context.Context, in *PreviewTaskRunRollbackRequest, opts ...grpc.CallOption) (*PreviewTaskRunRollbackResponse, error)}@@ -194,29 +208,43 @@ func (c *rolloutServiceClient) PreviewTaskRunRollback(ctx context.Context, in *P// RolloutServiceServer is the server API for RolloutService service.// All implementations must embed UnimplementedRolloutServiceServer// for forward compatibility.+//+// RolloutService manages the execution of deployment plans.type RolloutServiceServer interface {+ // Retrieves a rollout by name.// Permissions required: bb.rollouts.getGetRollout(context.Context, *GetRolloutRequest) (*Rollout, error)+ // Lists rollouts in a project.// Permissions required: bb.rollouts.listListRollouts(context.Context, *ListRolloutsRequest) (*ListRolloutsResponse, error)+ // Creates a new rollout from a plan.// Permissions required: bb.rollouts.createCreateRollout(context.Context, *CreateRolloutRequest) (*Rollout, error)+ // Previews the rollout that would be created from a plan.// Permissions required: bb.rollouts.previewPreviewRollout(context.Context, *PreviewRolloutRequest) (*Rollout, error)+ // Lists task run executions for a task.// Permissions required: bb.taskRuns.listListTaskRuns(context.Context, *ListTaskRunsRequest) (*ListTaskRunsResponse, error)+ // Retrieves a task run by name.// Permissions required: bb.taskRuns.listGetTaskRun(context.Context, *GetTaskRunRequest) (*TaskRun, error)+ // Retrieves execution logs for a task run.// Permissions required: bb.taskRuns.listGetTaskRunLog(context.Context, *GetTaskRunLogRequest) (*TaskRunLog, error)+ // Retrieves database session information for a running task.// Permissions required: bb.taskRuns.listGetTaskRunSession(context.Context, *GetTaskRunSessionRequest) (*TaskRunSession, error)- // Permissions required: None+ // Executes multiple tasks in a rollout stage.+ // Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)BatchRunTasks(context.Context, *BatchRunTasksRequest) (*BatchRunTasksResponse, error)- // Permissions required: None+ // Skips multiple tasks in a rollout stage.+ // Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)BatchSkipTasks(context.Context, *BatchSkipTasksRequest) (*BatchSkipTasksResponse, error)- // Permissions required: None+ // Cancels multiple running task executions.+ // Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)BatchCancelTaskRuns(context.Context, *BatchCancelTaskRunsRequest) (*BatchCancelTaskRunsResponse, error)+ // Generates rollback SQL for a completed task run.// Permissions required: bb.taskRuns.listPreviewTaskRunRollback(context.Context, *PreviewTaskRunRollbackRequest) (*PreviewTaskRunRollbackResponse, error)mustEmbedUnimplementedRolloutServiceServer()diff --git a/backend/generated-go/v1/setting_service.pb.go b/backend/generated-go/v1/setting_service.pb.goindex ad927bc385..81aa61f891 100644--- a/backend/generated-go/v1/setting_service.pb.go+++ b/backend/generated-go/v1/setting_service.pb.go@@ -327,13 +327,13 @@ func (AISetting_Provider) EnumDescriptor() ([]byte, []int) {type ListSettingsRequest struct {state protoimpl.MessageState `protogen:"open.v1"`- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// The maximum number of settings to return. The service may return fewer than// this value.// If unspecified, at most 10 settings 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"`- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// A page token, received from a previous `ListSettings` call.// Provide this to retrieve the subsequent page.//@@ -614,7 +614,7 @@ type Setting struct {// - `setting/{setting}`// For example, "settings/bb.branding.logo"Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`- // The value of the setting.+ // The configuration value of the setting.Value *Value `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -1108,9 +1108,9 @@ func (x *WorkspaceProfileSetting) GetEnableMetricCollection() bool {type Announcement struct {state protoimpl.MessageState `protogen:"open.v1"`- // The alert level of announcemnt+ // The alert level of announcementLevel Announcement_AlertLevel `protobuf:"varint,1,opt,name=level,proto3,enum=bytebase.v1.Announcement_AlertLevel" json:"level,omitempty"`- // The text of announcemnt+ // The text of announcementText 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"`diff --git a/backend/generated-go/v1/setting_service_grpc.pb.go b/backend/generated-go/v1/setting_service_grpc.pb.goindex 87e07c08b9..3bb5907c6f 100644--- a/backend/generated-go/v1/setting_service_grpc.pb.go+++ b/backend/generated-go/v1/setting_service_grpc.pb.go@@ -27,11 +27,16 @@ const (// SettingServiceClient is the client API for SettingService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// SettingService manages workspace-level settings and configurations.type SettingServiceClient interface {+ // Lists all workspace settings.// Permissions required: bb.settings.listListSettings(ctx context.Context, in *ListSettingsRequest, opts ...grpc.CallOption) (*ListSettingsResponse, error)+ // Retrieves a workspace setting by name.// Permissions required: bb.settings.getGetSetting(ctx context.Context, in *GetSettingRequest, opts ...grpc.CallOption) (*Setting, error)+ // Updates a workspace setting.// Permissions required: bb.settings.setUpdateSetting(ctx context.Context, in *UpdateSettingRequest, opts ...grpc.CallOption) (*Setting, error)}@@ -77,11 +82,16 @@ func (c *settingServiceClient) UpdateSetting(ctx context.Context, in *UpdateSett// SettingServiceServer is the server API for SettingService service.// All implementations must embed UnimplementedSettingServiceServer// for forward compatibility.+//+// SettingService manages workspace-level settings and configurations.type SettingServiceServer interface {+ // Lists all workspace settings.// Permissions required: bb.settings.listListSettings(context.Context, *ListSettingsRequest) (*ListSettingsResponse, error)+ // Retrieves a workspace setting by name.// Permissions required: bb.settings.getGetSetting(context.Context, *GetSettingRequest) (*Setting, error)+ // Updates a workspace setting.// Permissions required: bb.settings.setUpdateSetting(context.Context, *UpdateSettingRequest) (*Setting, error)mustEmbedUnimplementedSettingServiceServer()diff --git a/backend/generated-go/v1/sheet_service.pb.go b/backend/generated-go/v1/sheet_service.pb.goindex 020b19e5ba..cac942e80f 100644--- a/backend/generated-go/v1/sheet_service.pb.go+++ b/backend/generated-go/v1/sheet_service.pb.go@@ -353,9 +353,9 @@ func (x *UpdateSheetRequest) GetAllowMissing() bool {type Sheet struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name of the sheet resource, generated by the server.- // Canonical parent is project.+ // The name of the sheet resource.// Format: projects/{project}/sheets/{sheet}+ // The sheet ID is generated by the server on creation and cannot be changed.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// The title of the sheet.Title string `protobuf:"bytes,3,opt,name=title,proto3" json:"title,omitempty"`@@ -369,8 +369,9 @@ type Sheet struct {// set the `raw` to true in GetSheet request to retrieve the full content.Content []byte `protobuf:"bytes,7,opt,name=content,proto3" json:"content,omitempty"`// content_size is the full size of the content, may not match the size of the `content` field.- ContentSize int64 `protobuf:"varint,8,opt,name=content_size,json=contentSize,proto3" json:"content_size,omitempty"`- Payload *SheetPayload `protobuf:"bytes,13,opt,name=payload,proto3" json:"payload,omitempty"`+ ContentSize int64 `protobuf:"varint,8,opt,name=content_size,json=contentSize,proto3" json:"content_size,omitempty"`+ // Additional metadata and configuration for the sheet.+ Payload *SheetPayload `protobuf:"bytes,13,opt,name=payload,proto3" json:"payload,omitempty"`// The SQL dialect.Engine Engine `protobuf:"varint,14,opt,name=engine,proto3,enum=bytebase.v1.Engine" json:"engine,omitempty"`unknownFields protoimpl.UnknownFieldsdiff --git a/backend/generated-go/v1/sheet_service_grpc.pb.go b/backend/generated-go/v1/sheet_service_grpc.pb.goindex 110fc9937e..9d33adec68 100644--- a/backend/generated-go/v1/sheet_service_grpc.pb.go+++ b/backend/generated-go/v1/sheet_service_grpc.pb.go@@ -28,13 +28,19 @@ const (// SheetServiceClient is the client API for SheetService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// SheetService manages SQL scripts and saved queries.type SheetServiceClient interface {+ // Creates a new SQL sheet.// Permissions required: bb.sheets.createCreateSheet(ctx context.Context, in *CreateSheetRequest, opts ...grpc.CallOption) (*Sheet, error)+ // Creates multiple SQL sheets in a single operation.// Permissions required: bb.sheets.createBatchCreateSheets(ctx context.Context, in *BatchCreateSheetsRequest, opts ...grpc.CallOption) (*BatchCreateSheetsResponse, error)+ // Retrieves a SQL sheet by name.// Permissions required: bb.sheets.getGetSheet(ctx context.Context, in *GetSheetRequest, opts ...grpc.CallOption) (*Sheet, error)+ // Updates a SQL sheet's title or content.// Permissions required: bb.sheets.updateUpdateSheet(ctx context.Context, in *UpdateSheetRequest, opts ...grpc.CallOption) (*Sheet, error)}@@ -90,13 +96,19 @@ func (c *sheetServiceClient) UpdateSheet(ctx context.Context, in *UpdateSheetReq// SheetServiceServer is the server API for SheetService service.// All implementations must embed UnimplementedSheetServiceServer// for forward compatibility.+//+// SheetService manages SQL scripts and saved queries.type SheetServiceServer interface {+ // Creates a new SQL sheet.// Permissions required: bb.sheets.createCreateSheet(context.Context, *CreateSheetRequest) (*Sheet, error)+ // Creates multiple SQL sheets in a single operation.// Permissions required: bb.sheets.createBatchCreateSheets(context.Context, *BatchCreateSheetsRequest) (*BatchCreateSheetsResponse, error)+ // Retrieves a SQL sheet by name.// Permissions required: bb.sheets.getGetSheet(context.Context, *GetSheetRequest) (*Sheet, error)+ // Updates a SQL sheet's title or content.// Permissions required: bb.sheets.updateUpdateSheet(context.Context, *UpdateSheetRequest) (*Sheet, error)mustEmbedUnimplementedSheetServiceServer()diff --git a/backend/generated-go/v1/sql_service.pb.go b/backend/generated-go/v1/sql_service.pb.goindex 4a1eef4bec..419aaa4e34 100644--- a/backend/generated-go/v1/sql_service.pb.go+++ b/backend/generated-go/v1/sql_service.pb.go@@ -30,8 +30,10 @@ type QueryOption_RedisRunCommandsOn int32const (// UNSPECIFIED defaults to SINGLE_NODE.QueryOption_REDIS_RUN_COMMANDS_ON_UNSPECIFIED QueryOption_RedisRunCommandsOn = 0- QueryOption_SINGLE_NODE QueryOption_RedisRunCommandsOn = 1- QueryOption_ALL_NODES QueryOption_RedisRunCommandsOn = 2+ // Execute Redis commands on a single node in the cluster.+ QueryOption_SINGLE_NODE QueryOption_RedisRunCommandsOn = 1+ // Execute Redis commands on all nodes in the cluster for cluster-wide operations.+ QueryOption_ALL_NODES QueryOption_RedisRunCommandsOn = 2)// Enum value maps for QueryOption_RedisRunCommandsOn.@@ -78,14 +80,20 @@ func (QueryOption_RedisRunCommandsOn) EnumDescriptor() ([]byte, []int) {type QueryResult_Message_Level int32const (- // Unspecified.+ // Unspecified message level.QueryResult_Message_LEVEL_UNSPECIFIED QueryResult_Message_Level = 0- QueryResult_Message_INFO QueryResult_Message_Level = 1- QueryResult_Message_WARNING QueryResult_Message_Level = 2- QueryResult_Message_DEBUG QueryResult_Message_Level = 3- QueryResult_Message_LOG QueryResult_Message_Level = 4- QueryResult_Message_NOTICE QueryResult_Message_Level = 5- QueryResult_Message_EXCEPTION QueryResult_Message_Level = 6+ // Informational message.+ QueryResult_Message_INFO QueryResult_Message_Level = 1+ // Warning message indicating potential issues.+ QueryResult_Message_WARNING QueryResult_Message_Level = 2+ // Debug message for development and troubleshooting.+ QueryResult_Message_DEBUG QueryResult_Message_Level = 3+ // General log message.+ QueryResult_Message_LOG QueryResult_Message_Level = 4+ // Notice message for important information.+ QueryResult_Message_NOTICE QueryResult_Message_Level = 5+ // Exception message indicating error conditions.+ QueryResult_Message_EXCEPTION QueryResult_Message_Level = 6)// Enum value maps for QueryResult_Message_Level.@@ -248,9 +256,12 @@ func (CheckRequest_ChangeType) EnumDescriptor() ([]byte, []int) {type QueryHistory_Type int32const (+ // Unspecified query history type.QueryHistory_TYPE_UNSPECIFIED QueryHistory_Type = 0- QueryHistory_QUERY QueryHistory_Type = 1- QueryHistory_EXPORT QueryHistory_Type = 2+ // Query execution for data retrieval.+ QueryHistory_QUERY QueryHistory_Type = 1+ // Data export operation to file.+ QueryHistory_EXPORT QueryHistory_Type = 2)// Enum value maps for QueryHistory_Type.@@ -1829,7 +1840,7 @@ type SearchQueryHistoriesRequest struct {// - database: the database full name in "instances/{id}/databases/{name}" format, support "==" operator.// - instance: the instance full name in "instances/{id}" format, support "==" operator.// - type: the type, should be "QUERY" or "EXPORT", support "==" operator.- // - statement: the SQL statemnt, support ".matches()" operator.+ // - statement: the SQL statement, support ".matches()" operator.//// For example:// project == "projects/{project}"diff --git a/backend/generated-go/v1/sql_service_grpc.pb.go b/backend/generated-go/v1/sql_service_grpc.pb.goindex 03bff42adc..ba612530c9 100644--- a/backend/generated-go/v1/sql_service_grpc.pb.go+++ b/backend/generated-go/v1/sql_service_grpc.pb.go@@ -32,23 +32,32 @@ const (// SQLServiceClient is the client API for SQLService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// SQLService executes SQL queries and manages query operations.type SQLServiceClient interface {+ // Executes a read-only SQL query against a database.// Permissions required: bb.databases.getQuery(ctx context.Context, in *QueryRequest, opts ...grpc.CallOption) (*QueryResponse, error)+ // Executes SQL with admin privileges via streaming connection.// Permissions required: bb.sql.adminAdminExecute(ctx context.Context, opts ...grpc.CallOption) (grpc.BidiStreamingClient[AdminExecuteRequest, AdminExecuteResponse], error)// SearchQueryHistories searches query histories for the caller.- // Permissions required: None+ // Permissions required: None (only returns caller's own query histories)SearchQueryHistories(ctx context.Context, in *SearchQueryHistoriesRequest, opts ...grpc.CallOption) (*SearchQueryHistoriesResponse, error)+ // Exports query results to a file format.// Permissions required: bb.databases.getExport(ctx context.Context, in *ExportRequest, opts ...grpc.CallOption) (*ExportResponse, error)+ // Validates SQL statements against review rules.// Permissions required: bb.databases.checkCheck(ctx context.Context, in *CheckRequest, opts ...grpc.CallOption) (*CheckResponse, error)+ // Formats and normalizes SQL schema definitions.// Permissions required: NonePretty(ctx context.Context, in *PrettyRequest, opts ...grpc.CallOption) (*PrettyResponse, error)+ // Computes schema differences between two database metadata.// Permissions required: NoneDiffMetadata(ctx context.Context, in *DiffMetadataRequest, opts ...grpc.CallOption) (*DiffMetadataResponse, error)- // Permissions required: None+ // Provides AI-powered SQL completion and generation.+ // Permissions required: None (authenticated users only, requires AI to be enabled)AICompletion(ctx context.Context, in *AICompletionRequest, opts ...grpc.CallOption) (*AICompletionResponse, error)}@@ -146,23 +155,32 @@ func (c *sQLServiceClient) AICompletion(ctx context.Context, in *AICompletionReq// SQLServiceServer is the server API for SQLService service.// All implementations must embed UnimplementedSQLServiceServer// for forward compatibility.+//+// SQLService executes SQL queries and manages query operations.type SQLServiceServer interface {+ // Executes a read-only SQL query against a database.// Permissions required: bb.databases.getQuery(context.Context, *QueryRequest) (*QueryResponse, error)+ // Executes SQL with admin privileges via streaming connection.// Permissions required: bb.sql.adminAdminExecute(grpc.BidiStreamingServer[AdminExecuteRequest, AdminExecuteResponse]) error// SearchQueryHistories searches query histories for the caller.- // Permissions required: None+ // Permissions required: None (only returns caller's own query histories)SearchQueryHistories(context.Context, *SearchQueryHistoriesRequest) (*SearchQueryHistoriesResponse, error)+ // Exports query results to a file format.// Permissions required: bb.databases.getExport(context.Context, *ExportRequest) (*ExportResponse, error)+ // Validates SQL statements against review rules.// Permissions required: bb.databases.checkCheck(context.Context, *CheckRequest) (*CheckResponse, error)+ // Formats and normalizes SQL schema definitions.// Permissions required: NonePretty(context.Context, *PrettyRequest) (*PrettyResponse, error)+ // Computes schema differences between two database metadata.// Permissions required: NoneDiffMetadata(context.Context, *DiffMetadataRequest) (*DiffMetadataResponse, error)- // Permissions required: None+ // Provides AI-powered SQL completion and generation.+ // Permissions required: None (authenticated users only, requires AI to be enabled)AICompletion(context.Context, *AICompletionRequest) (*AICompletionResponse, error)mustEmbedUnimplementedSQLServiceServer()}diff --git a/backend/generated-go/v1/subscription_service.pb.go b/backend/generated-go/v1/subscription_service.pb.goindex 763c642d9b..b160b35c44 100644--- a/backend/generated-go/v1/subscription_service.pb.go+++ b/backend/generated-go/v1/subscription_service.pb.go@@ -26,10 +26,14 @@ const (type PlanType int32const (+ // Unspecified plan type.PlanType_PLAN_TYPE_UNSPECIFIED PlanType = 0- PlanType_FREE PlanType = 1- PlanType_TEAM PlanType = 2- PlanType_ENTERPRISE PlanType = 3+ // Free plan with basic features and no cost.+ PlanType_FREE PlanType = 1+ // Team plan with collaboration features for small to medium teams.+ PlanType_TEAM PlanType = 2+ // Enterprise plan with advanced features and dedicated support.+ PlanType_ENTERPRISE PlanType = 3)// Enum value maps for PlanType.diff --git a/backend/generated-go/v1/subscription_service_grpc.pb.go b/backend/generated-go/v1/subscription_service_grpc.pb.goindex a322c10e0c..26e7f9bb89 100644--- a/backend/generated-go/v1/subscription_service_grpc.pb.go+++ b/backend/generated-go/v1/subscription_service_grpc.pb.go@@ -26,12 +26,15 @@ const (// SubscriptionServiceClient is the client API for SubscriptionService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// SubscriptionService manages enterprise subscriptions and licensing.type SubscriptionServiceClient interface {// GetSubscription returns the current subscription.// If there is no license, we will return a free plan subscription without expiration time.// If there is expired license, we will return a free plan subscription with the expiration time of the expired license.// Permissions required: NoneGetSubscription(ctx context.Context, in *GetSubscriptionRequest, opts ...grpc.CallOption) (*Subscription, error)+ // Updates the enterprise license subscription.// Permissions required: bb.settings.setUpdateSubscription(ctx context.Context, in *UpdateSubscriptionRequest, opts ...grpc.CallOption) (*Subscription, error)}@@ -67,12 +70,15 @@ func (c *subscriptionServiceClient) UpdateSubscription(ctx context.Context, in *// SubscriptionServiceServer is the server API for SubscriptionService service.// All implementations must embed UnimplementedSubscriptionServiceServer// for forward compatibility.+//+// SubscriptionService manages enterprise subscriptions and licensing.type SubscriptionServiceServer interface {// GetSubscription returns the current subscription.// If there is no license, we will return a free plan subscription without expiration time.// If there is expired license, we will return a free plan subscription with the expiration time of the expired license.// Permissions required: NoneGetSubscription(context.Context, *GetSubscriptionRequest) (*Subscription, error)+ // Updates the enterprise license subscription.// Permissions required: bb.settings.setUpdateSubscription(context.Context, *UpdateSubscriptionRequest) (*Subscription, error)mustEmbedUnimplementedSubscriptionServiceServer()diff --git a/backend/generated-go/v1/user_service.pb.go b/backend/generated-go/v1/user_service.pb.goindex 1b5b00e319..6e7b2ea668 100644--- a/backend/generated-go/v1/user_service.pb.go+++ b/backend/generated-go/v1/user_service.pb.go@@ -28,10 +28,14 @@ const (type UserType int32const (+ // Unspecified user type.UserType_USER_TYPE_UNSPECIFIED UserType = 0- UserType_USER UserType = 1- UserType_SYSTEM_BOT UserType = 2- UserType_SERVICE_ACCOUNT UserType = 3+ // Regular human user account.+ UserType_USER UserType = 1+ // System-managed bot account for automated operations.+ UserType_SYSTEM_BOT UserType = 2+ // Service account for API integrations.+ UserType_SERVICE_ACCOUNT UserType = 3)// Enum value maps for UserType.@@ -606,13 +610,19 @@ type User struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the user.// Format: users/{user}. {user} is a system-generated unique ID.- Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`- State State `protobuf:"varint,2,opt,name=state,proto3,enum=bytebase.v1.State" json:"state,omitempty"`- Email string `protobuf:"bytes,3,opt,name=email,proto3" json:"email,omitempty"`- Title string `protobuf:"bytes,4,opt,name=title,proto3" json:"title,omitempty"`- UserType UserType `protobuf:"varint,5,opt,name=user_type,json=userType,proto3,enum=bytebase.v1.UserType" json:"user_type,omitempty"`- Password string `protobuf:"bytes,7,opt,name=password,proto3" json:"password,omitempty"`- ServiceKey string `protobuf:"bytes,8,opt,name=service_key,json=serviceKey,proto3" json:"service_key,omitempty"`+ Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`+ // The lifecycle state of the user account.+ State State `protobuf:"varint,2,opt,name=state,proto3,enum=bytebase.v1.State" json:"state,omitempty"`+ // The email address of the user, used for login and notifications.+ Email string `protobuf:"bytes,3,opt,name=email,proto3" json:"email,omitempty"`+ // The display title or full name of the user.+ Title string `protobuf:"bytes,4,opt,name=title,proto3" json:"title,omitempty"`+ // The type of user account.+ UserType UserType `protobuf:"varint,5,opt,name=user_type,json=userType,proto3,enum=bytebase.v1.UserType" json:"user_type,omitempty"`+ // The password for authentication. Only used during user creation or password updates.+ Password string `protobuf:"bytes,7,opt,name=password,proto3" json:"password,omitempty"`+ // The service key for service account authentication. Only used for service accounts.+ ServiceKey string `protobuf:"bytes,8,opt,name=service_key,json=serviceKey,proto3" json:"service_key,omitempty"`// The mfa_enabled flag means if the user has enabled MFA.MfaEnabled bool `protobuf:"varint,9,opt,name=mfa_enabled,json=mfaEnabled,proto3" json:"mfa_enabled,omitempty"`// The mfa_secret is the temporary secret using in two phase verification.@@ -621,7 +631,8 @@ type User struct {RecoveryCodes []string `protobuf:"bytes,11,rep,name=recovery_codes,json=recoveryCodes,proto3" json:"recovery_codes,omitempty"`// Should be a valid E.164 compliant phone number.// Could be empty.- Phone string `protobuf:"bytes,12,opt,name=phone,proto3" json:"phone,omitempty"`+ Phone string `protobuf:"bytes,12,opt,name=phone,proto3" json:"phone,omitempty"`+ // User profile metadata.Profile *User_Profile `protobuf:"bytes,13,opt,name=profile,proto3" json:"profile,omitempty"`// The groups for the user.// Format: groups/{email}@@ -752,8 +763,10 @@ func (x *User) GetGroups() []string {}type User_Profile 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"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The last time the user successfully logged in.+ LastLoginTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=last_login_time,json=lastLoginTime,proto3" json:"last_login_time,omitempty"`+ // The last time the user changed their password.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.Source string `protobuf:"bytes,3,opt,name=source,proto3" json:"source,omitempty"`diff --git a/backend/generated-go/v1/user_service_grpc.pb.go b/backend/generated-go/v1/user_service_grpc.pb.goindex 85b5a3fc5b..e1e56e1439 100644--- a/backend/generated-go/v1/user_service_grpc.pb.go+++ b/backend/generated-go/v1/user_service_grpc.pb.go@@ -33,6 +33,8 @@ const (// UserServiceClient is the client API for UserService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// UserService manages user accounts and authentication.type UserServiceClient interface {// Get the user.// Any authenticated user can get the user.@@ -49,19 +51,16 @@ type UserServiceClient interface {// Any authenticated user can list users.// Permissions required: bb.users.listListUsers(ctx context.Context, in *ListUsersRequest, opts ...grpc.CallOption) (*ListUsersResponse, error)- // Create a user.- // When Disallow Signup is enabled, only the caller with bb.users.create on the workspace can create a user.- // Otherwise, any unauthenticated user can create a user.- // Permissions required: bb.users.create+ // Creates a user. When Disallow Signup is enabled, requires bb.users.create permission; otherwise any user can sign up.+ // Permissions required: bb.users.create (only when Disallow Signup is enabled)CreateUser(ctx context.Context, in *CreateUserRequest, opts ...grpc.CallOption) (*User, error)- // Only the user itself and the user with bb.users.update permission on the workspace can update the user.- // Permissions required: bb.users.update+ // Updates a user. Users can update their own profile, or users with bb.users.update permission can update any user.+ // Permissions required: bb.users.update (or self)UpdateUser(ctx context.Context, in *UpdateUserRequest, opts ...grpc.CallOption) (*User, error)- // Only the user with bb.users.delete permission on the workspace can delete the user.- // The last remaining workspace admin cannot be deleted.+ // Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted.// Permissions required: bb.users.deleteDeleteUser(ctx context.Context, in *DeleteUserRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)- // Only the user with bb.users.undelete permission on the workspace can undelete the user.+ // Restores a deleted user.// Permissions required: bb.users.undeleteUndeleteUser(ctx context.Context, in *UndeleteUserRequest, opts ...grpc.CallOption) (*User, error)}@@ -157,6 +156,8 @@ func (c *userServiceClient) UndeleteUser(ctx context.Context, in *UndeleteUserRe// UserServiceServer is the server API for UserService service.// All implementations must embed UnimplementedUserServiceServer// for forward compatibility.+//+// UserService manages user accounts and authentication.type UserServiceServer interface {// Get the user.// Any authenticated user can get the user.@@ -173,19 +174,16 @@ type UserServiceServer interface {// Any authenticated user can list users.// Permissions required: bb.users.listListUsers(context.Context, *ListUsersRequest) (*ListUsersResponse, error)- // Create a user.- // When Disallow Signup is enabled, only the caller with bb.users.create on the workspace can create a user.- // Otherwise, any unauthenticated user can create a user.- // Permissions required: bb.users.create+ // Creates a user. When Disallow Signup is enabled, requires bb.users.create permission; otherwise any user can sign up.+ // Permissions required: bb.users.create (only when Disallow Signup is enabled)CreateUser(context.Context, *CreateUserRequest) (*User, error)- // Only the user itself and the user with bb.users.update permission on the workspace can update the user.- // Permissions required: bb.users.update+ // Updates a user. Users can update their own profile, or users with bb.users.update permission can update any user.+ // Permissions required: bb.users.update (or self)UpdateUser(context.Context, *UpdateUserRequest) (*User, error)- // Only the user with bb.users.delete permission on the workspace can delete the user.- // The last remaining workspace admin cannot be deleted.+ // Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted.// Permissions required: bb.users.deleteDeleteUser(context.Context, *DeleteUserRequest) (*emptypb.Empty, error)- // Only the user with bb.users.undelete permission on the workspace can undelete the user.+ // Restores a deleted user.// Permissions required: bb.users.undeleteUndeleteUser(context.Context, *UndeleteUserRequest) (*User, error)mustEmbedUnimplementedUserServiceServer()diff --git a/backend/generated-go/v1/v1connect/actuator_service.connect.go b/backend/generated-go/v1/v1connect/actuator_service.connect.goindex f795d1002c..4d972c6ff3 100644--- a/backend/generated-go/v1/v1connect/actuator_service.connect.go+++ b/backend/generated-go/v1/v1connect/actuator_service.connect.go@@ -53,14 +53,19 @@ const (// ActuatorServiceClient is a client for the bytebase.v1.ActuatorService service.type ActuatorServiceClient interface {+ // Gets system information and health status of the Bytebase instance.// Permissions required: NoneGetActuatorInfo(context.Context, *connect.Request[v1.GetActuatorInfoRequest]) (*connect.Response[v1.ActuatorInfo], error)+ // Updates system configuration settings for the Bytebase instance.// Permissions required: bb.settings.setUpdateActuatorInfo(context.Context, *connect.Request[v1.UpdateActuatorInfoRequest]) (*connect.Response[v1.ActuatorInfo], error)+ // Sets up sample data for demonstration and testing purposes.// Permissions required: bb.projects.createSetupSample(context.Context, *connect.Request[v1.SetupSampleRequest]) (*connect.Response[emptypb.Empty], error)+ // Clears the system cache to force data refresh.// Permissions required: NoneDeleteCache(context.Context, *connect.Request[v1.DeleteCacheRequest]) (*connect.Response[emptypb.Empty], error)+ // Gets custom branding resources such as logos.// Permissions required: NoneGetResourcePackage(context.Context, *connect.Request[v1.GetResourcePackageRequest]) (*connect.Response[v1.ResourcePackage], error)}@@ -145,14 +150,19 @@ func (c *actuatorServiceClient) GetResourcePackage(ctx context.Context, req *con// ActuatorServiceHandler is an implementation of the bytebase.v1.ActuatorService service.type ActuatorServiceHandler interface {+ // Gets system information and health status of the Bytebase instance.// Permissions required: NoneGetActuatorInfo(context.Context, *connect.Request[v1.GetActuatorInfoRequest]) (*connect.Response[v1.ActuatorInfo], error)+ // Updates system configuration settings for the Bytebase instance.// Permissions required: bb.settings.setUpdateActuatorInfo(context.Context, *connect.Request[v1.UpdateActuatorInfoRequest]) (*connect.Response[v1.ActuatorInfo], error)+ // Sets up sample data for demonstration and testing purposes.// Permissions required: bb.projects.createSetupSample(context.Context, *connect.Request[v1.SetupSampleRequest]) (*connect.Response[emptypb.Empty], error)+ // Clears the system cache to force data refresh.// Permissions required: NoneDeleteCache(context.Context, *connect.Request[v1.DeleteCacheRequest]) (*connect.Response[emptypb.Empty], error)+ // Gets custom branding resources such as logos.// Permissions required: NoneGetResourcePackage(context.Context, *connect.Request[v1.GetResourcePackageRequest]) (*connect.Response[v1.ResourcePackage], error)}diff --git a/backend/generated-go/v1/v1connect/audit_log_service.connect.go b/backend/generated-go/v1/v1connect/audit_log_service.connect.goindex 1a2be532ee..9a78766fb9 100644--- a/backend/generated-go/v1/v1connect/audit_log_service.connect.go+++ b/backend/generated-go/v1/v1connect/audit_log_service.connect.go@@ -43,8 +43,10 @@ const (// AuditLogServiceClient is a client for the bytebase.v1.AuditLogService service.type AuditLogServiceClient interface {- // Permissions required: None+ // Searches audit logs with optional filtering and pagination.+ // Permissions required: bb.auditLogs.searchSearchAuditLogs(context.Context, *connect.Request[v1.SearchAuditLogsRequest]) (*connect.Response[v1.SearchAuditLogsResponse], error)+ // Exports audit logs in a specified format for external analysis.// Permissions required: bb.auditLogs.exportExportAuditLogs(context.Context, *connect.Request[v1.ExportAuditLogsRequest]) (*connect.Response[v1.ExportAuditLogsResponse], error)}@@ -93,8 +95,10 @@ func (c *auditLogServiceClient) ExportAuditLogs(ctx context.Context, req *connec// AuditLogServiceHandler is an implementation of the bytebase.v1.AuditLogService service.type AuditLogServiceHandler interface {- // Permissions required: None+ // Searches audit logs with optional filtering and pagination.+ // Permissions required: bb.auditLogs.searchSearchAuditLogs(context.Context, *connect.Request[v1.SearchAuditLogsRequest]) (*connect.Response[v1.SearchAuditLogsResponse], error)+ // Exports audit logs in a specified format for external analysis.// Permissions required: bb.auditLogs.exportExportAuditLogs(context.Context, *connect.Request[v1.ExportAuditLogsRequest]) (*connect.Response[v1.ExportAuditLogsResponse], error)}diff --git a/backend/generated-go/v1/v1connect/auth_service.connect.go b/backend/generated-go/v1/v1connect/auth_service.connect.goindex 842660e4a3..9175248c25 100644--- a/backend/generated-go/v1/v1connect/auth_service.connect.go+++ b/backend/generated-go/v1/v1connect/auth_service.connect.go@@ -42,8 +42,10 @@ const (// AuthServiceClient is a client for the bytebase.v1.AuthService service.type AuthServiceClient interface {+ // Authenticates a user and returns access tokens.// Permissions required: NoneLogin(context.Context, *connect.Request[v1.LoginRequest]) (*connect.Response[v1.LoginResponse], error)+ // Logs out the current user session.// Permissions required: NoneLogout(context.Context, *connect.Request[v1.LogoutRequest]) (*connect.Response[emptypb.Empty], error)}@@ -92,8 +94,10 @@ func (c *authServiceClient) Logout(ctx context.Context, req *connect.Request[v1.// AuthServiceHandler is an implementation of the bytebase.v1.AuthService service.type AuthServiceHandler interface {+ // Authenticates a user and returns access tokens.// Permissions required: NoneLogin(context.Context, *connect.Request[v1.LoginRequest]) (*connect.Response[v1.LoginResponse], error)+ // Logs out the current user session.// Permissions required: NoneLogout(context.Context, *connect.Request[v1.LogoutRequest]) (*connect.Response[emptypb.Empty], error)}diff --git a/backend/generated-go/v1/v1connect/cel_service.connect.go b/backend/generated-go/v1/v1connect/cel_service.connect.goindex fe551d09d2..fd9427beef 100644--- a/backend/generated-go/v1/v1connect/cel_service.connect.go+++ b/backend/generated-go/v1/v1connect/cel_service.connect.go@@ -41,8 +41,10 @@ const (// CelServiceClient is a client for the bytebase.v1.CelService service.type CelServiceClient interface {+ // Parses multiple CEL expression strings into AST representations.// Permissions required: NoneBatchParse(context.Context, *connect.Request[v1.BatchParseRequest]) (*connect.Response[v1.BatchParseResponse], error)+ // Converts multiple CEL AST representations back into expression strings.// Permissions required: NoneBatchDeparse(context.Context, *connect.Request[v1.BatchDeparseRequest]) (*connect.Response[v1.BatchDeparseResponse], error)}@@ -91,8 +93,10 @@ func (c *celServiceClient) BatchDeparse(ctx context.Context, req *connect.Reques// CelServiceHandler is an implementation of the bytebase.v1.CelService service.type CelServiceHandler interface {+ // Parses multiple CEL expression strings into AST representations.// Permissions required: NoneBatchParse(context.Context, *connect.Request[v1.BatchParseRequest]) (*connect.Response[v1.BatchParseResponse], error)+ // Converts multiple CEL AST representations back into expression strings.// Permissions required: NoneBatchDeparse(context.Context, *connect.Request[v1.BatchDeparseRequest]) (*connect.Response[v1.BatchDeparseResponse], error)}diff --git a/backend/generated-go/v1/v1connect/changelist_service.connect.go b/backend/generated-go/v1/v1connect/changelist_service.connect.goindex 08a263e398..3a6029eb03 100644--- a/backend/generated-go/v1/v1connect/changelist_service.connect.go+++ b/backend/generated-go/v1/v1connect/changelist_service.connect.go@@ -53,14 +53,19 @@ const (// ChangelistServiceClient is a client for the bytebase.v1.ChangelistService service.type ChangelistServiceClient interface {+ // Creates a new changelist in a project.// Permissions required: bb.changelists.createCreateChangelist(context.Context, *connect.Request[v1.CreateChangelistRequest]) (*connect.Response[v1.Changelist], error)+ // Gets a changelist by name.// Permissions required: bb.changelists.getGetChangelist(context.Context, *connect.Request[v1.GetChangelistRequest]) (*connect.Response[v1.Changelist], error)+ // Lists changelists in a project.// Permissions required: bb.changelists.listListChangelists(context.Context, *connect.Request[v1.ListChangelistsRequest]) (*connect.Response[v1.ListChangelistsResponse], error)+ // Updates a changelist.// Permissions required: bb.changelists.updateUpdateChangelist(context.Context, *connect.Request[v1.UpdateChangelistRequest]) (*connect.Response[v1.Changelist], error)+ // Deletes a changelist.// Permissions required: bb.changelists.deleteDeleteChangelist(context.Context, *connect.Request[v1.DeleteChangelistRequest]) (*connect.Response[emptypb.Empty], error)}@@ -145,14 +150,19 @@ func (c *changelistServiceClient) DeleteChangelist(ctx context.Context, req *con// ChangelistServiceHandler is an implementation of the bytebase.v1.ChangelistService service.type ChangelistServiceHandler interface {+ // Creates a new changelist in a project.// Permissions required: bb.changelists.createCreateChangelist(context.Context, *connect.Request[v1.CreateChangelistRequest]) (*connect.Response[v1.Changelist], error)+ // Gets a changelist by name.// Permissions required: bb.changelists.getGetChangelist(context.Context, *connect.Request[v1.GetChangelistRequest]) (*connect.Response[v1.Changelist], error)+ // Lists changelists in a project.// Permissions required: bb.changelists.listListChangelists(context.Context, *connect.Request[v1.ListChangelistsRequest]) (*connect.Response[v1.ListChangelistsResponse], error)+ // Updates a changelist.// Permissions required: bb.changelists.updateUpdateChangelist(context.Context, *connect.Request[v1.UpdateChangelistRequest]) (*connect.Response[v1.Changelist], error)+ // Deletes a changelist.// Permissions required: bb.changelists.deleteDeleteChangelist(context.Context, *connect.Request[v1.DeleteChangelistRequest]) (*connect.Response[emptypb.Empty], error)}diff --git a/backend/generated-go/v1/v1connect/database_catalog_service.connect.go b/backend/generated-go/v1/v1connect/database_catalog_service.connect.goindex 44631b46a0..8d6adb39c3 100644--- a/backend/generated-go/v1/v1connect/database_catalog_service.connect.go+++ b/backend/generated-go/v1/v1connect/database_catalog_service.connect.go@@ -43,8 +43,10 @@ const (// DatabaseCatalogServiceClient is a client for the bytebase.v1.DatabaseCatalogService service.type DatabaseCatalogServiceClient interface {+ // Gets the catalog metadata for a database.// Permissions required: bb.databaseCatalogs.getGetDatabaseCatalog(context.Context, *connect.Request[v1.GetDatabaseCatalogRequest]) (*connect.Response[v1.DatabaseCatalog], error)+ // Updates catalog metadata such as classifications and labels.// Permissions required: bb.databaseCatalogs.updateUpdateDatabaseCatalog(context.Context, *connect.Request[v1.UpdateDatabaseCatalogRequest]) (*connect.Response[v1.DatabaseCatalog], error)}@@ -94,8 +96,10 @@ func (c *databaseCatalogServiceClient) UpdateDatabaseCatalog(ctx context.Context// DatabaseCatalogServiceHandler is an implementation of the bytebase.v1.DatabaseCatalogService// service.type DatabaseCatalogServiceHandler interface {+ // Gets the catalog metadata for a database.// Permissions required: bb.databaseCatalogs.getGetDatabaseCatalog(context.Context, *connect.Request[v1.GetDatabaseCatalogRequest]) (*connect.Response[v1.DatabaseCatalog], error)+ // Updates catalog metadata such as classifications and labels.// Permissions required: bb.databaseCatalogs.updateUpdateDatabaseCatalog(context.Context, *connect.Request[v1.UpdateDatabaseCatalogRequest]) (*connect.Response[v1.DatabaseCatalog], error)}diff --git a/backend/generated-go/v1/v1connect/database_group_service.connect.go b/backend/generated-go/v1/v1connect/database_group_service.connect.goindex 8324bfd16f..3bc10b0aa0 100644--- a/backend/generated-go/v1/v1connect/database_group_service.connect.go+++ b/backend/generated-go/v1/v1connect/database_group_service.connect.go@@ -53,14 +53,19 @@ const (// DatabaseGroupServiceClient is a client for the bytebase.v1.DatabaseGroupService service.type DatabaseGroupServiceClient interface {+ // Lists database groups in a project.// Permissions required: bb.projects.getListDatabaseGroups(context.Context, *connect.Request[v1.ListDatabaseGroupsRequest]) (*connect.Response[v1.ListDatabaseGroupsResponse], error)+ // Gets a database group by name.// Permissions required: bb.projects.getGetDatabaseGroup(context.Context, *connect.Request[v1.GetDatabaseGroupRequest]) (*connect.Response[v1.DatabaseGroup], error)+ // Creates a new database group.// Permissions required: bb.projects.updateCreateDatabaseGroup(context.Context, *connect.Request[v1.CreateDatabaseGroupRequest]) (*connect.Response[v1.DatabaseGroup], error)+ // Updates a database group.// Permissions required: bb.projects.updateUpdateDatabaseGroup(context.Context, *connect.Request[v1.UpdateDatabaseGroupRequest]) (*connect.Response[v1.DatabaseGroup], error)+ // Deletes a database group.// Permissions required: bb.projects.updateDeleteDatabaseGroup(context.Context, *connect.Request[v1.DeleteDatabaseGroupRequest]) (*connect.Response[emptypb.Empty], error)}@@ -145,14 +150,19 @@ func (c *databaseGroupServiceClient) DeleteDatabaseGroup(ctx context.Context, re// DatabaseGroupServiceHandler is an implementation of the bytebase.v1.DatabaseGroupService service.type DatabaseGroupServiceHandler interface {+ // Lists database groups in a project.// Permissions required: bb.projects.getListDatabaseGroups(context.Context, *connect.Request[v1.ListDatabaseGroupsRequest]) (*connect.Response[v1.ListDatabaseGroupsResponse], error)+ // Gets a database group by name.// Permissions required: bb.projects.getGetDatabaseGroup(context.Context, *connect.Request[v1.GetDatabaseGroupRequest]) (*connect.Response[v1.DatabaseGroup], error)+ // Creates a new database group.// Permissions required: bb.projects.updateCreateDatabaseGroup(context.Context, *connect.Request[v1.CreateDatabaseGroupRequest]) (*connect.Response[v1.DatabaseGroup], error)+ // Updates a database group.// Permissions required: bb.projects.updateUpdateDatabaseGroup(context.Context, *connect.Request[v1.UpdateDatabaseGroupRequest]) (*connect.Response[v1.DatabaseGroup], error)+ // Deletes a database group.// Permissions required: bb.projects.updateDeleteDatabaseGroup(context.Context, *connect.Request[v1.DeleteDatabaseGroupRequest]) (*connect.Response[emptypb.Empty], error)}diff --git a/backend/generated-go/v1/v1connect/database_service.connect.go b/backend/generated-go/v1/v1connect/database_service.connect.goindex 90e17c6ea1..83949ddbf8 100644--- a/backend/generated-go/v1/v1connect/database_service.connect.go+++ b/backend/generated-go/v1/v1connect/database_service.connect.go@@ -76,31 +76,44 @@ const (// DatabaseServiceClient is a client for the bytebase.v1.DatabaseService service.type DatabaseServiceClient interface {+ // Retrieves a database by name.// Permissions required: bb.databases.getGetDatabase(context.Context, *connect.Request[v1.GetDatabaseRequest]) (*connect.Response[v1.Database], error)+ // Retrieves multiple databases by their names.// Permissions required: bb.databases.getBatchGetDatabases(context.Context, *connect.Request[v1.BatchGetDatabasesRequest]) (*connect.Response[v1.BatchGetDatabasesResponse], error)- // Permissions required: bb.databases.list+ // Lists databases in a project, instance, or workspace.+ // Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)ListDatabases(context.Context, *connect.Request[v1.ListDatabasesRequest]) (*connect.Response[v1.ListDatabasesResponse], error)+ // Updates database properties such as labels and project assignment.// Permissions required: bb.databases.updateUpdateDatabase(context.Context, *connect.Request[v1.UpdateDatabaseRequest]) (*connect.Response[v1.Database], error)+ // Updates multiple databases in a single batch operation.// Permissions required: bb.databases.updateBatchUpdateDatabases(context.Context, *connect.Request[v1.BatchUpdateDatabasesRequest]) (*connect.Response[v1.BatchUpdateDatabasesResponse], error)+ // Synchronizes database schema from the instance.// Permissions required: bb.databases.syncSyncDatabase(context.Context, *connect.Request[v1.SyncDatabaseRequest]) (*connect.Response[v1.SyncDatabaseResponse], error)+ // Synchronizes multiple databases in a single batch operation.// Permissions required: bb.databases.syncBatchSyncDatabases(context.Context, *connect.Request[v1.BatchSyncDatabasesRequest]) (*connect.Response[v1.BatchSyncDatabasesResponse], error)+ // Retrieves database metadata including tables, columns, and indexes.// Permissions required: bb.databases.getSchemaGetDatabaseMetadata(context.Context, *connect.Request[v1.GetDatabaseMetadataRequest]) (*connect.Response[v1.DatabaseMetadata], error)+ // Retrieves database schema as DDL statements.// Permissions required: bb.databases.getSchemaGetDatabaseSchema(context.Context, *connect.Request[v1.GetDatabaseSchemaRequest]) (*connect.Response[v1.DatabaseSchema], error)+ // Compares and generates migration statements between two schemas.// Permissions required: bb.databases.getDiffSchema(context.Context, *connect.Request[v1.DiffSchemaRequest]) (*connect.Response[v1.DiffSchemaResponse], error)+ // Lists migration history for a database.// Permissions required: bb.changelogs.listListChangelogs(context.Context, *connect.Request[v1.ListChangelogsRequest]) (*connect.Response[v1.ListChangelogsResponse], error)- // Permissions required: changelogs.get+ // Retrieves a specific changelog entry.+ // Permissions required: bb.changelogs.getGetChangelog(context.Context, *connect.Request[v1.GetChangelogRequest]) (*connect.Response[v1.Changelog], error)- // Permissions required: databases.getSchema+ // Generates schema DDL for a database object.+ // Permissions required: bb.databases.getSchemaGetSchemaString(context.Context, *connect.Request[v1.GetSchemaStringRequest]) (*connect.Response[v1.GetSchemaStringResponse], error)}@@ -280,31 +293,44 @@ func (c *databaseServiceClient) GetSchemaString(ctx context.Context, req *connec// DatabaseServiceHandler is an implementation of the bytebase.v1.DatabaseService service.type DatabaseServiceHandler interface {+ // Retrieves a database by name.// Permissions required: bb.databases.getGetDatabase(context.Context, *connect.Request[v1.GetDatabaseRequest]) (*connect.Response[v1.Database], error)+ // Retrieves multiple databases by their names.// Permissions required: bb.databases.getBatchGetDatabases(context.Context, *connect.Request[v1.BatchGetDatabasesRequest]) (*connect.Response[v1.BatchGetDatabasesResponse], error)- // Permissions required: bb.databases.list+ // Lists databases in a project, instance, or workspace.+ // Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)ListDatabases(context.Context, *connect.Request[v1.ListDatabasesRequest]) (*connect.Response[v1.ListDatabasesResponse], error)+ // Updates database properties such as labels and project assignment.// Permissions required: bb.databases.updateUpdateDatabase(context.Context, *connect.Request[v1.UpdateDatabaseRequest]) (*connect.Response[v1.Database], error)+ // Updates multiple databases in a single batch operation.// Permissions required: bb.databases.updateBatchUpdateDatabases(context.Context, *connect.Request[v1.BatchUpdateDatabasesRequest]) (*connect.Response[v1.BatchUpdateDatabasesResponse], error)+ // Synchronizes database schema from the instance.// Permissions required: bb.databases.syncSyncDatabase(context.Context, *connect.Request[v1.SyncDatabaseRequest]) (*connect.Response[v1.SyncDatabaseResponse], error)+ // Synchronizes multiple databases in a single batch operation.// Permissions required: bb.databases.syncBatchSyncDatabases(context.Context, *connect.Request[v1.BatchSyncDatabasesRequest]) (*connect.Response[v1.BatchSyncDatabasesResponse], error)+ // Retrieves database metadata including tables, columns, and indexes.// Permissions required: bb.databases.getSchemaGetDatabaseMetadata(context.Context, *connect.Request[v1.GetDatabaseMetadataRequest]) (*connect.Response[v1.DatabaseMetadata], error)+ // Retrieves database schema as DDL statements.// Permissions required: bb.databases.getSchemaGetDatabaseSchema(context.Context, *connect.Request[v1.GetDatabaseSchemaRequest]) (*connect.Response[v1.DatabaseSchema], error)+ // Compares and generates migration statements between two schemas.// Permissions required: bb.databases.getDiffSchema(context.Context, *connect.Request[v1.DiffSchemaRequest]) (*connect.Response[v1.DiffSchemaResponse], error)+ // Lists migration history for a database.// Permissions required: bb.changelogs.listListChangelogs(context.Context, *connect.Request[v1.ListChangelogsRequest]) (*connect.Response[v1.ListChangelogsResponse], error)- // Permissions required: changelogs.get+ // Retrieves a specific changelog entry.+ // Permissions required: bb.changelogs.getGetChangelog(context.Context, *connect.Request[v1.GetChangelogRequest]) (*connect.Response[v1.Changelog], error)- // Permissions required: databases.getSchema+ // Generates schema DDL for a database object.+ // Permissions required: bb.databases.getSchemaGetSchemaString(context.Context, *connect.Request[v1.GetSchemaStringRequest]) (*connect.Response[v1.GetSchemaStringResponse], error)}diff --git a/backend/generated-go/v1/v1connect/group_service.connect.go b/backend/generated-go/v1/v1connect/group_service.connect.goindex 6abed89bf4..966cb91715 100644--- a/backend/generated-go/v1/v1connect/group_service.connect.go+++ b/backend/generated-go/v1/v1connect/group_service.connect.go@@ -54,20 +54,23 @@ const (// GroupServiceClient is a client for the bytebase.v1.GroupService service.type GroupServiceClient interface {+ // Gets a group by name.// Permissions required: bb.groups.getGetGroup(context.Context, *connect.Request[v1.GetGroupRequest]) (*connect.Response[v1.Group], error)- // Get the groups in batch.+ // Gets multiple groups in a single request.// Permissions required: bb.groups.getBatchGetGroups(context.Context, *connect.Request[v1.BatchGetGroupsRequest]) (*connect.Response[v1.BatchGetGroupsResponse], error)+ // Lists all groups in the workspace.// Permissions required: bb.groups.listListGroups(context.Context, *connect.Request[v1.ListGroupsRequest]) (*connect.Response[v1.ListGroupsResponse], error)+ // Creates a new group.// Permissions required: bb.groups.createCreateGroup(context.Context, *connect.Request[v1.CreateGroupRequest]) (*connect.Response[v1.Group], error)- // UpdateGroup updates the group.- // Users with "bb.groups.update" permission on the workspace or the group owner can access this method.- // Permissions required: bb.groups.update+ // Updates a group. Group owners or users with bb.groups.update permission can update.+ // Permissions required: bb.groups.update OR caller is group ownerUpdateGroup(context.Context, *connect.Request[v1.UpdateGroupRequest]) (*connect.Response[v1.Group], error)- // Permissions required: bb.groups.delete+ // Deletes a group. Group owners or users with bb.groups.delete permission can delete.+ // Permissions required: bb.groups.delete OR caller is group ownerDeleteGroup(context.Context, *connect.Request[v1.DeleteGroupRequest]) (*connect.Response[emptypb.Empty], error)}@@ -163,20 +166,23 @@ func (c *groupServiceClient) DeleteGroup(ctx context.Context, req *connect.Reque// GroupServiceHandler is an implementation of the bytebase.v1.GroupService service.type GroupServiceHandler interface {+ // Gets a group by name.// Permissions required: bb.groups.getGetGroup(context.Context, *connect.Request[v1.GetGroupRequest]) (*connect.Response[v1.Group], error)- // Get the groups in batch.+ // Gets multiple groups in a single request.// Permissions required: bb.groups.getBatchGetGroups(context.Context, *connect.Request[v1.BatchGetGroupsRequest]) (*connect.Response[v1.BatchGetGroupsResponse], error)+ // Lists all groups in the workspace.// Permissions required: bb.groups.listListGroups(context.Context, *connect.Request[v1.ListGroupsRequest]) (*connect.Response[v1.ListGroupsResponse], error)+ // Creates a new group.// Permissions required: bb.groups.createCreateGroup(context.Context, *connect.Request[v1.CreateGroupRequest]) (*connect.Response[v1.Group], error)- // UpdateGroup updates the group.- // Users with "bb.groups.update" permission on the workspace or the group owner can access this method.- // Permissions required: bb.groups.update+ // Updates a group. Group owners or users with bb.groups.update permission can update.+ // Permissions required: bb.groups.update OR caller is group ownerUpdateGroup(context.Context, *connect.Request[v1.UpdateGroupRequest]) (*connect.Response[v1.Group], error)- // Permissions required: bb.groups.delete+ // Deletes a group. Group owners or users with bb.groups.delete permission can delete.+ // Permissions required: bb.groups.delete OR caller is group ownerDeleteGroup(context.Context, *connect.Request[v1.DeleteGroupRequest]) (*connect.Response[emptypb.Empty], error)}diff --git a/backend/generated-go/v1/v1connect/idp_service.connect.go b/backend/generated-go/v1/v1connect/idp_service.connect.goindex 5304aa83a2..e0c10571c3 100644--- a/backend/generated-go/v1/v1connect/idp_service.connect.go+++ b/backend/generated-go/v1/v1connect/idp_service.connect.go@@ -56,16 +56,22 @@ const (// IdentityProviderServiceClient is a client for the bytebase.v1.IdentityProviderService service.type IdentityProviderServiceClient interface {+ // Gets an identity provider by name.// Permissions required: bb.identityProviders.getGetIdentityProvider(context.Context, *connect.Request[v1.GetIdentityProviderRequest]) (*connect.Response[v1.IdentityProvider], error)+ // Lists all configured identity providers (public endpoint for login page).// Permissions required: NoneListIdentityProviders(context.Context, *connect.Request[v1.ListIdentityProvidersRequest]) (*connect.Response[v1.ListIdentityProvidersResponse], error)+ // Creates a new identity provider.// Permissions required: bb.identityProviders.createCreateIdentityProvider(context.Context, *connect.Request[v1.CreateIdentityProviderRequest]) (*connect.Response[v1.IdentityProvider], error)+ // Updates an identity provider.// Permissions required: bb.identityProviders.updateUpdateIdentityProvider(context.Context, *connect.Request[v1.UpdateIdentityProviderRequest]) (*connect.Response[v1.IdentityProvider], error)+ // Deletes an identity provider.// Permissions required: bb.identityProviders.deleteDeleteIdentityProvider(context.Context, *connect.Request[v1.DeleteIdentityProviderRequest]) (*connect.Response[emptypb.Empty], error)+ // Tests the connection and configuration of an identity provider.// Permissions required: bb.identityProviders.updateTestIdentityProvider(context.Context, *connect.Request[v1.TestIdentityProviderRequest]) (*connect.Response[v1.TestIdentityProviderResponse], error)}@@ -163,16 +169,22 @@ func (c *identityProviderServiceClient) TestIdentityProvider(ctx context.Context// IdentityProviderServiceHandler is an implementation of the bytebase.v1.IdentityProviderService// service.type IdentityProviderServiceHandler interface {+ // Gets an identity provider by name.// Permissions required: bb.identityProviders.getGetIdentityProvider(context.Context, *connect.Request[v1.GetIdentityProviderRequest]) (*connect.Response[v1.IdentityProvider], error)+ // Lists all configured identity providers (public endpoint for login page).// Permissions required: NoneListIdentityProviders(context.Context, *connect.Request[v1.ListIdentityProvidersRequest]) (*connect.Response[v1.ListIdentityProvidersResponse], error)+ // Creates a new identity provider.// Permissions required: bb.identityProviders.createCreateIdentityProvider(context.Context, *connect.Request[v1.CreateIdentityProviderRequest]) (*connect.Response[v1.IdentityProvider], error)+ // Updates an identity provider.// Permissions required: bb.identityProviders.updateUpdateIdentityProvider(context.Context, *connect.Request[v1.UpdateIdentityProviderRequest]) (*connect.Response[v1.IdentityProvider], error)+ // Deletes an identity provider.// Permissions required: bb.identityProviders.deleteDeleteIdentityProvider(context.Context, *connect.Request[v1.DeleteIdentityProviderRequest]) (*connect.Response[emptypb.Empty], error)+ // Tests the connection and configuration of an identity provider.// Permissions required: bb.identityProviders.updateTestIdentityProvider(context.Context, *connect.Request[v1.TestIdentityProviderRequest]) (*connect.Response[v1.TestIdentityProviderResponse], error)}diff --git a/backend/generated-go/v1/v1connect/instance_role_service.connect.go b/backend/generated-go/v1/v1connect/instance_role_service.connect.goindex 34e5b38098..d9f3c8e8b5 100644--- a/backend/generated-go/v1/v1connect/instance_role_service.connect.go+++ b/backend/generated-go/v1/v1connect/instance_role_service.connect.go@@ -43,8 +43,10 @@ const (// InstanceRoleServiceClient is a client for the bytebase.v1.InstanceRoleService service.type InstanceRoleServiceClient interface {+ // Gets a database role from an instance.// Permissions required: bb.instanceRoles.getGetInstanceRole(context.Context, *connect.Request[v1.GetInstanceRoleRequest]) (*connect.Response[v1.InstanceRole], error)+ // Lists all database roles in an instance.// Permissions required: bb.instanceRoles.listListInstanceRoles(context.Context, *connect.Request[v1.ListInstanceRolesRequest]) (*connect.Response[v1.ListInstanceRolesResponse], error)}@@ -93,8 +95,10 @@ func (c *instanceRoleServiceClient) ListInstanceRoles(ctx context.Context, req *// InstanceRoleServiceHandler is an implementation of the bytebase.v1.InstanceRoleService service.type InstanceRoleServiceHandler interface {+ // Gets a database role from an instance.// Permissions required: bb.instanceRoles.getGetInstanceRole(context.Context, *connect.Request[v1.GetInstanceRoleRequest]) (*connect.Response[v1.InstanceRole], error)+ // Lists all database roles in an instance.// Permissions required: bb.instanceRoles.listListInstanceRoles(context.Context, *connect.Request[v1.ListInstanceRolesRequest]) (*connect.Response[v1.ListInstanceRolesResponse], error)}diff --git a/backend/generated-go/v1/v1connect/instance_service.connect.go b/backend/generated-go/v1/v1connect/instance_service.connect.goindex f762e9fba1..b6733eccbc 100644--- a/backend/generated-go/v1/v1connect/instance_service.connect.go+++ b/backend/generated-go/v1/v1connect/instance_service.connect.go@@ -77,30 +77,43 @@ const (// InstanceServiceClient is a client for the bytebase.v1.InstanceService service.type InstanceServiceClient interface {+ // Gets a database instance by name.// Permissions required: bb.instances.getGetInstance(context.Context, *connect.Request[v1.GetInstanceRequest]) (*connect.Response[v1.Instance], error)+ // Lists all database instances.// Permissions required: bb.instances.listListInstances(context.Context, *connect.Request[v1.ListInstancesRequest]) (*connect.Response[v1.ListInstancesResponse], error)+ // Creates a new database instance.// Permissions required: bb.instances.createCreateInstance(context.Context, *connect.Request[v1.CreateInstanceRequest]) (*connect.Response[v1.Instance], error)+ // Updates a database instance.// Permissions required: bb.instances.updateUpdateInstance(context.Context, *connect.Request[v1.UpdateInstanceRequest]) (*connect.Response[v1.Instance], error)+ // Deletes or soft-deletes a database instance.// Permissions required: bb.instances.deleteDeleteInstance(context.Context, *connect.Request[v1.DeleteInstanceRequest]) (*connect.Response[emptypb.Empty], error)+ // Restores a soft-deleted database instance.// Permissions required: bb.instances.undeleteUndeleteInstance(context.Context, *connect.Request[v1.UndeleteInstanceRequest]) (*connect.Response[v1.Instance], error)+ // Syncs database schemas and metadata from an instance.// Permissions required: bb.instances.syncSyncInstance(context.Context, *connect.Request[v1.SyncInstanceRequest]) (*connect.Response[v1.SyncInstanceResponse], error)+ // Lists all databases within an instance without creating them.// Permissions required: bb.instances.getListInstanceDatabase(context.Context, *connect.Request[v1.ListInstanceDatabaseRequest]) (*connect.Response[v1.ListInstanceDatabaseResponse], error)+ // Syncs multiple instances in a single request.// Permissions required: bb.instances.syncBatchSyncInstances(context.Context, *connect.Request[v1.BatchSyncInstancesRequest]) (*connect.Response[v1.BatchSyncInstancesResponse], error)+ // Updates multiple instances in a single request.// Permissions required: bb.instances.updateBatchUpdateInstances(context.Context, *connect.Request[v1.BatchUpdateInstancesRequest]) (*connect.Response[v1.BatchUpdateInstancesResponse], error)+ // Adds a read-only data source to an instance.// Permissions required: bb.instances.updateAddDataSource(context.Context, *connect.Request[v1.AddDataSourceRequest]) (*connect.Response[v1.Instance], error)+ // Removes a read-only data source from an instance.// Permissions required: bb.instances.updateRemoveDataSource(context.Context, *connect.Request[v1.RemoveDataSourceRequest]) (*connect.Response[v1.Instance], error)+ // Updates a data source configuration.// Permissions required: bb.instances.updateUpdateDataSource(context.Context, *connect.Request[v1.UpdateDataSourceRequest]) (*connect.Response[v1.Instance], error)}@@ -281,30 +294,43 @@ func (c *instanceServiceClient) UpdateDataSource(ctx context.Context, req *conne// InstanceServiceHandler is an implementation of the bytebase.v1.InstanceService service.type InstanceServiceHandler interface {+ // Gets a database instance by name.// Permissions required: bb.instances.getGetInstance(context.Context, *connect.Request[v1.GetInstanceRequest]) (*connect.Response[v1.Instance], error)+ // Lists all database instances.// Permissions required: bb.instances.listListInstances(context.Context, *connect.Request[v1.ListInstancesRequest]) (*connect.Response[v1.ListInstancesResponse], error)+ // Creates a new database instance.// Permissions required: bb.instances.createCreateInstance(context.Context, *connect.Request[v1.CreateInstanceRequest]) (*connect.Response[v1.Instance], error)+ // Updates a database instance.// Permissions required: bb.instances.updateUpdateInstance(context.Context, *connect.Request[v1.UpdateInstanceRequest]) (*connect.Response[v1.Instance], error)+ // Deletes or soft-deletes a database instance.// Permissions required: bb.instances.deleteDeleteInstance(context.Context, *connect.Request[v1.DeleteInstanceRequest]) (*connect.Response[emptypb.Empty], error)+ // Restores a soft-deleted database instance.// Permissions required: bb.instances.undeleteUndeleteInstance(context.Context, *connect.Request[v1.UndeleteInstanceRequest]) (*connect.Response[v1.Instance], error)+ // Syncs database schemas and metadata from an instance.// Permissions required: bb.instances.syncSyncInstance(context.Context, *connect.Request[v1.SyncInstanceRequest]) (*connect.Response[v1.SyncInstanceResponse], error)+ // Lists all databases within an instance without creating them.// Permissions required: bb.instances.getListInstanceDatabase(context.Context, *connect.Request[v1.ListInstanceDatabaseRequest]) (*connect.Response[v1.ListInstanceDatabaseResponse], error)+ // Syncs multiple instances in a single request.// Permissions required: bb.instances.syncBatchSyncInstances(context.Context, *connect.Request[v1.BatchSyncInstancesRequest]) (*connect.Response[v1.BatchSyncInstancesResponse], error)+ // Updates multiple instances in a single request.// Permissions required: bb.instances.updateBatchUpdateInstances(context.Context, *connect.Request[v1.BatchUpdateInstancesRequest]) (*connect.Response[v1.BatchUpdateInstancesResponse], error)+ // Adds a read-only data source to an instance.// Permissions required: bb.instances.updateAddDataSource(context.Context, *connect.Request[v1.AddDataSourceRequest]) (*connect.Response[v1.Instance], error)+ // Removes a read-only data source from an instance.// Permissions required: bb.instances.updateRemoveDataSource(context.Context, *connect.Request[v1.RemoveDataSourceRequest]) (*connect.Response[v1.Instance], error)+ // Updates a data source configuration.// Permissions required: bb.instances.updateUpdateDataSource(context.Context, *connect.Request[v1.UpdateDataSourceRequest]) (*connect.Response[v1.Instance], error)}diff --git a/backend/generated-go/v1/v1connect/issue_service.connect.go b/backend/generated-go/v1/v1connect/issue_service.connect.goindex 8ededc904a..d3b8db5f13 100644--- a/backend/generated-go/v1/v1connect/issue_service.connect.go+++ b/backend/generated-go/v1/v1connect/issue_service.connect.go@@ -71,36 +71,41 @@ const (// IssueServiceClient is a client for the bytebase.v1.IssueService service.type IssueServiceClient interface {+ // Retrieves an issue by name.// Permissions required: bb.issues.getGetIssue(context.Context, *connect.Request[v1.GetIssueRequest]) (*connect.Response[v1.Issue], error)+ // Creates a new issue for database changes or tasks.// Permissions required: bb.issues.createCreateIssue(context.Context, *connect.Request[v1.CreateIssueRequest]) (*connect.Response[v1.Issue], error)+ // Lists issues in a project.// Permissions required: bb.issues.listListIssues(context.Context, *connect.Request[v1.ListIssuesRequest]) (*connect.Response[v1.ListIssuesResponse], error)// Search for issues that the caller has the bb.issues.get permission on and also satisfy the specified filter & query.// Permissions required: bb.issues.getSearchIssues(context.Context, *connect.Request[v1.SearchIssuesRequest]) (*connect.Response[v1.SearchIssuesResponse], error)+ // Updates an issue's properties such as title, description, or labels.// Permissions required: bb.issues.updateUpdateIssue(context.Context, *connect.Request[v1.UpdateIssueRequest]) (*connect.Response[v1.Issue], error)+ // Lists comments on an issue.// Permissions required: bb.issueComments.listListIssueComments(context.Context, *connect.Request[v1.ListIssueCommentsRequest]) (*connect.Response[v1.ListIssueCommentsResponse], error)+ // Adds a comment to an issue.// Permissions required: bb.issueComments.createCreateIssueComment(context.Context, *connect.Request[v1.CreateIssueCommentRequest]) (*connect.Response[v1.IssueComment], error)+ // Updates an existing issue comment.// Permissions required: bb.issueComments.updateUpdateIssueComment(context.Context, *connect.Request[v1.UpdateIssueCommentRequest]) (*connect.Response[v1.IssueComment], error)+ // Updates the status of multiple issues in a single operation.// Permissions required: bb.issues.updateBatchUpdateIssuesStatus(context.Context, *connect.Request[v1.BatchUpdateIssuesStatusRequest]) (*connect.Response[v1.BatchUpdateIssuesStatusResponse], error)- // ApproveIssue approves the issue.- // The access is based on approval flow.- // Permissions required: None+ // Approves an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+ // Permissions required: None (determined by approval flow)ApproveIssue(context.Context, *connect.Request[v1.ApproveIssueRequest]) (*connect.Response[v1.Issue], error)- // RejectIssue rejects the issue.- // The access is based on approval flow.- // Permissions required: None+ // Rejects an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+ // Permissions required: None (determined by approval flow)RejectIssue(context.Context, *connect.Request[v1.RejectIssueRequest]) (*connect.Response[v1.Issue], error)- // RequestIssue requests the issue.- // The access is based on approval flow.- // Permissions required: None+ // Requests changes on an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+ // Permissions required: None (determined by approval flow)RequestIssue(context.Context, *connect.Request[v1.RequestIssueRequest]) (*connect.Response[v1.Issue], error)}@@ -268,36 +273,41 @@ func (c *issueServiceClient) RequestIssue(ctx context.Context, req *connect.Requ// IssueServiceHandler is an implementation of the bytebase.v1.IssueService service.type IssueServiceHandler interface {+ // Retrieves an issue by name.// Permissions required: bb.issues.getGetIssue(context.Context, *connect.Request[v1.GetIssueRequest]) (*connect.Response[v1.Issue], error)+ // Creates a new issue for database changes or tasks.// Permissions required: bb.issues.createCreateIssue(context.Context, *connect.Request[v1.CreateIssueRequest]) (*connect.Response[v1.Issue], error)+ // Lists issues in a project.// Permissions required: bb.issues.listListIssues(context.Context, *connect.Request[v1.ListIssuesRequest]) (*connect.Response[v1.ListIssuesResponse], error)// Search for issues that the caller has the bb.issues.get permission on and also satisfy the specified filter & query.// Permissions required: bb.issues.getSearchIssues(context.Context, *connect.Request[v1.SearchIssuesRequest]) (*connect.Response[v1.SearchIssuesResponse], error)+ // Updates an issue's properties such as title, description, or labels.// Permissions required: bb.issues.updateUpdateIssue(context.Context, *connect.Request[v1.UpdateIssueRequest]) (*connect.Response[v1.Issue], error)+ // Lists comments on an issue.// Permissions required: bb.issueComments.listListIssueComments(context.Context, *connect.Request[v1.ListIssueCommentsRequest]) (*connect.Response[v1.ListIssueCommentsResponse], error)+ // Adds a comment to an issue.// Permissions required: bb.issueComments.createCreateIssueComment(context.Context, *connect.Request[v1.CreateIssueCommentRequest]) (*connect.Response[v1.IssueComment], error)+ // Updates an existing issue comment.// Permissions required: bb.issueComments.updateUpdateIssueComment(context.Context, *connect.Request[v1.UpdateIssueCommentRequest]) (*connect.Response[v1.IssueComment], error)+ // Updates the status of multiple issues in a single operation.// Permissions required: bb.issues.updateBatchUpdateIssuesStatus(context.Context, *connect.Request[v1.BatchUpdateIssuesStatusRequest]) (*connect.Response[v1.BatchUpdateIssuesStatusResponse], error)- // ApproveIssue approves the issue.- // The access is based on approval flow.- // Permissions required: None+ // Approves an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+ // Permissions required: None (determined by approval flow)ApproveIssue(context.Context, *connect.Request[v1.ApproveIssueRequest]) (*connect.Response[v1.Issue], error)- // RejectIssue rejects the issue.- // The access is based on approval flow.- // Permissions required: None+ // Rejects an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+ // Permissions required: None (determined by approval flow)RejectIssue(context.Context, *connect.Request[v1.RejectIssueRequest]) (*connect.Response[v1.Issue], error)- // RequestIssue requests the issue.- // The access is based on approval flow.- // Permissions required: None+ // Requests changes on an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+ // Permissions required: None (determined by approval flow)RequestIssue(context.Context, *connect.Request[v1.RequestIssueRequest]) (*connect.Response[v1.Issue], error)}diff --git a/backend/generated-go/v1/v1connect/org_policy_service.connect.go b/backend/generated-go/v1/v1connect/org_policy_service.connect.goindex 6057152aa7..37ebfd6336 100644--- a/backend/generated-go/v1/v1connect/org_policy_service.connect.go+++ b/backend/generated-go/v1/v1connect/org_policy_service.connect.go@@ -53,14 +53,19 @@ const (// OrgPolicyServiceClient is a client for the bytebase.v1.OrgPolicyService service.type OrgPolicyServiceClient interface {+ // Retrieves a policy by name.// Permissions required: bb.policies.getGetPolicy(context.Context, *connect.Request[v1.GetPolicyRequest]) (*connect.Response[v1.Policy], error)+ // Lists policies at a specified resource level.// Permissions required: bb.policies.listListPolicies(context.Context, *connect.Request[v1.ListPoliciesRequest]) (*connect.Response[v1.ListPoliciesResponse], error)+ // Creates a new organizational policy.// Permissions required: bb.policies.createCreatePolicy(context.Context, *connect.Request[v1.CreatePolicyRequest]) (*connect.Response[v1.Policy], error)+ // Updates an existing organizational policy.// Permissions required: bb.policies.updateUpdatePolicy(context.Context, *connect.Request[v1.UpdatePolicyRequest]) (*connect.Response[v1.Policy], error)+ // Deletes an organizational policy.// Permissions required: bb.policies.deleteDeletePolicy(context.Context, *connect.Request[v1.DeletePolicyRequest]) (*connect.Response[emptypb.Empty], error)}@@ -145,14 +150,19 @@ func (c *orgPolicyServiceClient) DeletePolicy(ctx context.Context, req *connect.// OrgPolicyServiceHandler is an implementation of the bytebase.v1.OrgPolicyService service.type OrgPolicyServiceHandler interface {+ // Retrieves a policy by name.// Permissions required: bb.policies.getGetPolicy(context.Context, *connect.Request[v1.GetPolicyRequest]) (*connect.Response[v1.Policy], error)+ // Lists policies at a specified resource level.// Permissions required: bb.policies.listListPolicies(context.Context, *connect.Request[v1.ListPoliciesRequest]) (*connect.Response[v1.ListPoliciesResponse], error)+ // Creates a new organizational policy.// Permissions required: bb.policies.createCreatePolicy(context.Context, *connect.Request[v1.CreatePolicyRequest]) (*connect.Response[v1.Policy], error)+ // Updates an existing organizational policy.// Permissions required: bb.policies.updateUpdatePolicy(context.Context, *connect.Request[v1.UpdatePolicyRequest]) (*connect.Response[v1.Policy], error)+ // Deletes an organizational policy.// Permissions required: bb.policies.deleteDeletePolicy(context.Context, *connect.Request[v1.DeletePolicyRequest]) (*connect.Response[emptypb.Empty], error)}diff --git a/backend/generated-go/v1/v1connect/plan_service.connect.go b/backend/generated-go/v1/v1connect/plan_service.connect.goindex 2cb8b0c16b..9683cebbcb 100644--- a/backend/generated-go/v1/v1connect/plan_service.connect.go+++ b/backend/generated-go/v1/v1connect/plan_service.connect.go@@ -56,23 +56,29 @@ const (// PlanServiceClient is a client for the bytebase.v1.PlanService service.type PlanServiceClient interface {+ // Retrieves a deployment plan by name.// Permissions required: bb.plans.getGetPlan(context.Context, *connect.Request[v1.GetPlanRequest]) (*connect.Response[v1.Plan], error)+ // Lists deployment plans in a project.// Permissions required: bb.plans.listListPlans(context.Context, *connect.Request[v1.ListPlansRequest]) (*connect.Response[v1.ListPlansResponse], error)// Search for plans that the caller has the bb.plans.get permission on and also satisfy the specified filter & query.// Permissions required: bb.plans.getSearchPlans(context.Context, *connect.Request[v1.SearchPlansRequest]) (*connect.Response[v1.SearchPlansResponse], error)+ // Creates a new deployment plan.// Permissions required: bb.plans.createCreatePlan(context.Context, *connect.Request[v1.CreatePlanRequest]) (*connect.Response[v1.Plan], error)// UpdatePlan updates the plan.// The plan creator and the user with bb.plans.update permission on the project can update the plan.- // Permissions required: bb.plans.update+ // Permissions required: bb.plans.update (or creator)UpdatePlan(context.Context, *connect.Request[v1.UpdatePlanRequest]) (*connect.Response[v1.Plan], error)+ // Lists plan check runs for a deployment plan.// Permissions required: bb.planCheckRuns.listListPlanCheckRuns(context.Context, *connect.Request[v1.ListPlanCheckRunsRequest]) (*connect.Response[v1.ListPlanCheckRunsResponse], error)+ // Executes validation checks on a deployment plan.// Permissions required: bb.planCheckRuns.runRunPlanChecks(context.Context, *connect.Request[v1.RunPlanChecksRequest]) (*connect.Response[v1.RunPlanChecksResponse], error)+ // Cancels multiple plan check runs.// Permissions required: bb.planCheckRuns.runBatchCancelPlanCheckRuns(context.Context, *connect.Request[v1.BatchCancelPlanCheckRunsRequest]) (*connect.Response[v1.BatchCancelPlanCheckRunsResponse], error)}@@ -193,23 +199,29 @@ func (c *planServiceClient) BatchCancelPlanCheckRuns(ctx context.Context, req *c// PlanServiceHandler is an implementation of the bytebase.v1.PlanService service.type PlanServiceHandler interface {+ // Retrieves a deployment plan by name.// Permissions required: bb.plans.getGetPlan(context.Context, *connect.Request[v1.GetPlanRequest]) (*connect.Response[v1.Plan], error)+ // Lists deployment plans in a project.// Permissions required: bb.plans.listListPlans(context.Context, *connect.Request[v1.ListPlansRequest]) (*connect.Response[v1.ListPlansResponse], error)// Search for plans that the caller has the bb.plans.get permission on and also satisfy the specified filter & query.// Permissions required: bb.plans.getSearchPlans(context.Context, *connect.Request[v1.SearchPlansRequest]) (*connect.Response[v1.SearchPlansResponse], error)+ // Creates a new deployment plan.// Permissions required: bb.plans.createCreatePlan(context.Context, *connect.Request[v1.CreatePlanRequest]) (*connect.Response[v1.Plan], error)// UpdatePlan updates the plan.// The plan creator and the user with bb.plans.update permission on the project can update the plan.- // Permissions required: bb.plans.update+ // Permissions required: bb.plans.update (or creator)UpdatePlan(context.Context, *connect.Request[v1.UpdatePlanRequest]) (*connect.Response[v1.Plan], error)+ // Lists plan check runs for a deployment plan.// Permissions required: bb.planCheckRuns.listListPlanCheckRuns(context.Context, *connect.Request[v1.ListPlanCheckRunsRequest]) (*connect.Response[v1.ListPlanCheckRunsResponse], error)+ // Executes validation checks on a deployment plan.// Permissions required: bb.planCheckRuns.runRunPlanChecks(context.Context, *connect.Request[v1.RunPlanChecksRequest]) (*connect.Response[v1.RunPlanChecksResponse], error)+ // Cancels multiple plan check runs.// Permissions required: bb.planCheckRuns.runBatchCancelPlanCheckRuns(context.Context, *connect.Request[v1.BatchCancelPlanCheckRunsRequest]) (*connect.Response[v1.BatchCancelPlanCheckRunsResponse], error)}diff --git a/backend/generated-go/v1/v1connect/project_service.connect.go b/backend/generated-go/v1/v1connect/project_service.connect.goindex 5947225f3a..071da18c16 100644--- a/backend/generated-go/v1/v1connect/project_service.connect.go+++ b/backend/generated-go/v1/v1connect/project_service.connect.go@@ -87,33 +87,46 @@ type ProjectServiceClient interface {// Users with "bb.projects.get" permission on the workspace or the project owner can access this method.// Permissions required: bb.projects.getGetProject(context.Context, *connect.Request[v1.GetProjectRequest]) (*connect.Response[v1.Project], error)+ // Lists all projects in the workspace with optional filtering.// Permissions required: bb.projects.listListProjects(context.Context, *connect.Request[v1.ListProjectsRequest]) (*connect.Response[v1.ListProjectsResponse], error)- // Permissions required: None+ // Searches for projects with advanced filtering capabilities.+ // Permissions required: bb.projects.get (or project-level bb.projects.get for specific projects)SearchProjects(context.Context, *connect.Request[v1.SearchProjectsRequest]) (*connect.Response[v1.SearchProjectsResponse], error)+ // Creates a new project in the workspace.// Permissions required: bb.projects.createCreateProject(context.Context, *connect.Request[v1.CreateProjectRequest]) (*connect.Response[v1.Project], error)+ // Updates an existing project's properties.// Permissions required: bb.projects.updateUpdateProject(context.Context, *connect.Request[v1.UpdateProjectRequest]) (*connect.Response[v1.Project], error)+ // Deletes (soft-delete or purge) a project.// Permissions required: bb.projects.deleteDeleteProject(context.Context, *connect.Request[v1.DeleteProjectRequest]) (*connect.Response[emptypb.Empty], error)+ // Restores a soft-deleted project.// Permissions required: bb.projects.undeleteUndeleteProject(context.Context, *connect.Request[v1.UndeleteProjectRequest]) (*connect.Response[v1.Project], error)+ // Deletes multiple projects in a single operation.// Permissions required: bb.projects.deleteBatchDeleteProjects(context.Context, *connect.Request[v1.BatchDeleteProjectsRequest]) (*connect.Response[emptypb.Empty], error)+ // Retrieves the IAM policy for a project.// Permissions required: bb.projects.getIamPolicyGetIamPolicy(context.Context, *connect.Request[v1.GetIamPolicyRequest]) (*connect.Response[v1.IamPolicy], error)- // Deprecated.- // Permissions required: bb.projects.getIamPolicy+ // Deprecated. No permission check implemented.+ // Permissions required: NoneBatchGetIamPolicy(context.Context, *connect.Request[v1.BatchGetIamPolicyRequest]) (*connect.Response[v1.BatchGetIamPolicyResponse], error)+ // Sets the IAM policy for a project.// Permissions required: bb.projects.setIamPolicySetIamPolicy(context.Context, *connect.Request[v1.SetIamPolicyRequest]) (*connect.Response[v1.IamPolicy], error)+ // Adds a webhook to a project for notifications.// Permissions required: bb.projects.updateAddWebhook(context.Context, *connect.Request[v1.AddWebhookRequest]) (*connect.Response[v1.Project], error)+ // Updates an existing webhook configuration.// Permissions required: bb.projects.updateUpdateWebhook(context.Context, *connect.Request[v1.UpdateWebhookRequest]) (*connect.Response[v1.Project], error)+ // Removes a webhook from a project.// Permissions required: bb.projects.updateRemoveWebhook(context.Context, *connect.Request[v1.RemoveWebhookRequest]) (*connect.Response[v1.Project], error)+ // Tests a webhook by sending a test notification.// Permissions required: bb.projects.updateTestWebhook(context.Context, *connect.Request[v1.TestWebhookRequest]) (*connect.Response[v1.TestWebhookResponse], error)}@@ -322,33 +335,46 @@ type ProjectServiceHandler interface {// Users with "bb.projects.get" permission on the workspace or the project owner can access this method.// Permissions required: bb.projects.getGetProject(context.Context, *connect.Request[v1.GetProjectRequest]) (*connect.Response[v1.Project], error)+ // Lists all projects in the workspace with optional filtering.// Permissions required: bb.projects.listListProjects(context.Context, *connect.Request[v1.ListProjectsRequest]) (*connect.Response[v1.ListProjectsResponse], error)- // Permissions required: None+ // Searches for projects with advanced filtering capabilities.+ // Permissions required: bb.projects.get (or project-level bb.projects.get for specific projects)SearchProjects(context.Context, *connect.Request[v1.SearchProjectsRequest]) (*connect.Response[v1.SearchProjectsResponse], error)+ // Creates a new project in the workspace.// Permissions required: bb.projects.createCreateProject(context.Context, *connect.Request[v1.CreateProjectRequest]) (*connect.Response[v1.Project], error)+ // Updates an existing project's properties.// Permissions required: bb.projects.updateUpdateProject(context.Context, *connect.Request[v1.UpdateProjectRequest]) (*connect.Response[v1.Project], error)+ // Deletes (soft-delete or purge) a project.// Permissions required: bb.projects.deleteDeleteProject(context.Context, *connect.Request[v1.DeleteProjectRequest]) (*connect.Response[emptypb.Empty], error)+ // Restores a soft-deleted project.// Permissions required: bb.projects.undeleteUndeleteProject(context.Context, *connect.Request[v1.UndeleteProjectRequest]) (*connect.Response[v1.Project], error)+ // Deletes multiple projects in a single operation.// Permissions required: bb.projects.deleteBatchDeleteProjects(context.Context, *connect.Request[v1.BatchDeleteProjectsRequest]) (*connect.Response[emptypb.Empty], error)+ // Retrieves the IAM policy for a project.// Permissions required: bb.projects.getIamPolicyGetIamPolicy(context.Context, *connect.Request[v1.GetIamPolicyRequest]) (*connect.Response[v1.IamPolicy], error)- // Deprecated.- // Permissions required: bb.projects.getIamPolicy+ // Deprecated. No permission check implemented.+ // Permissions required: NoneBatchGetIamPolicy(context.Context, *connect.Request[v1.BatchGetIamPolicyRequest]) (*connect.Response[v1.BatchGetIamPolicyResponse], error)+ // Sets the IAM policy for a project.// Permissions required: bb.projects.setIamPolicySetIamPolicy(context.Context, *connect.Request[v1.SetIamPolicyRequest]) (*connect.Response[v1.IamPolicy], error)+ // Adds a webhook to a project for notifications.// Permissions required: bb.projects.updateAddWebhook(context.Context, *connect.Request[v1.AddWebhookRequest]) (*connect.Response[v1.Project], error)+ // Updates an existing webhook configuration.// Permissions required: bb.projects.updateUpdateWebhook(context.Context, *connect.Request[v1.UpdateWebhookRequest]) (*connect.Response[v1.Project], error)+ // Removes a webhook from a project.// Permissions required: bb.projects.updateRemoveWebhook(context.Context, *connect.Request[v1.RemoveWebhookRequest]) (*connect.Response[v1.Project], error)+ // Tests a webhook by sending a test notification.// Permissions required: bb.projects.updateTestWebhook(context.Context, *connect.Request[v1.TestWebhookRequest]) (*connect.Response[v1.TestWebhookResponse], error)}diff --git a/backend/generated-go/v1/v1connect/release_service.connect.go b/backend/generated-go/v1/v1connect/release_service.connect.goindex 8f11765079..8f4e6cefe9 100644--- a/backend/generated-go/v1/v1connect/release_service.connect.go+++ b/backend/generated-go/v1/v1connect/release_service.connect.go@@ -62,20 +62,28 @@ const (// ReleaseServiceClient is a client for the bytebase.v1.ReleaseService service.type ReleaseServiceClient interface {+ // Retrieves a release by name.// Permissions required: bb.releases.getGetRelease(context.Context, *connect.Request[v1.GetReleaseRequest]) (*connect.Response[v1.Release], error)+ // Lists releases in a project.// Permissions required: bb.releases.listListReleases(context.Context, *connect.Request[v1.ListReleasesRequest]) (*connect.Response[v1.ListReleasesResponse], error)+ // Searches releases by digest or other criteria.// Permissions required: bb.releases.getSearchReleases(context.Context, *connect.Request[v1.SearchReleasesRequest]) (*connect.Response[v1.SearchReleasesResponse], error)+ // Creates a new release with SQL files.// Permissions required: bb.releases.createCreateRelease(context.Context, *connect.Request[v1.CreateReleaseRequest]) (*connect.Response[v1.Release], error)+ // Updates an existing release.// Permissions required: bb.releases.updateUpdateRelease(context.Context, *connect.Request[v1.UpdateReleaseRequest]) (*connect.Response[v1.Release], error)+ // Deletes a release.// Permissions required: bb.releases.deleteDeleteRelease(context.Context, *connect.Request[v1.DeleteReleaseRequest]) (*connect.Response[emptypb.Empty], error)+ // Restores a deleted release.// Permissions required: bb.releases.undeleteUndeleteRelease(context.Context, *connect.Request[v1.UndeleteReleaseRequest]) (*connect.Response[v1.Release], error)+ // Validates a release by dry-running checks on target databases.// Permissions required: bb.releases.checkCheckRelease(context.Context, *connect.Request[v1.CheckReleaseRequest]) (*connect.Response[v1.CheckReleaseResponse], error)}@@ -196,20 +204,28 @@ func (c *releaseServiceClient) CheckRelease(ctx context.Context, req *connect.Re// ReleaseServiceHandler is an implementation of the bytebase.v1.ReleaseService service.type ReleaseServiceHandler interface {+ // Retrieves a release by name.// Permissions required: bb.releases.getGetRelease(context.Context, *connect.Request[v1.GetReleaseRequest]) (*connect.Response[v1.Release], error)+ // Lists releases in a project.// Permissions required: bb.releases.listListReleases(context.Context, *connect.Request[v1.ListReleasesRequest]) (*connect.Response[v1.ListReleasesResponse], error)+ // Searches releases by digest or other criteria.// Permissions required: bb.releases.getSearchReleases(context.Context, *connect.Request[v1.SearchReleasesRequest]) (*connect.Response[v1.SearchReleasesResponse], error)+ // Creates a new release with SQL files.// Permissions required: bb.releases.createCreateRelease(context.Context, *connect.Request[v1.CreateReleaseRequest]) (*connect.Response[v1.Release], error)+ // Updates an existing release.// Permissions required: bb.releases.updateUpdateRelease(context.Context, *connect.Request[v1.UpdateReleaseRequest]) (*connect.Response[v1.Release], error)+ // Deletes a release.// Permissions required: bb.releases.deleteDeleteRelease(context.Context, *connect.Request[v1.DeleteReleaseRequest]) (*connect.Response[emptypb.Empty], error)+ // Restores a deleted release.// Permissions required: bb.releases.undeleteUndeleteRelease(context.Context, *connect.Request[v1.UndeleteReleaseRequest]) (*connect.Response[v1.Release], error)+ // Validates a release by dry-running checks on target databases.// Permissions required: bb.releases.checkCheckRelease(context.Context, *connect.Request[v1.CheckReleaseRequest]) (*connect.Response[v1.CheckReleaseResponse], error)}diff --git a/backend/generated-go/v1/v1connect/review_config_service.connect.go b/backend/generated-go/v1/v1connect/review_config_service.connect.goindex b70db2f4e5..a437ccd164 100644--- a/backend/generated-go/v1/v1connect/review_config_service.connect.go+++ b/backend/generated-go/v1/v1connect/review_config_service.connect.go@@ -53,14 +53,19 @@ const (// ReviewConfigServiceClient is a client for the bytebase.v1.ReviewConfigService service.type ReviewConfigServiceClient interface {+ // Creates a new SQL review configuration.// Permissions required: bb.reviewConfigs.createCreateReviewConfig(context.Context, *connect.Request[v1.CreateReviewConfigRequest]) (*connect.Response[v1.ReviewConfig], error)+ // Lists all SQL review configurations.// Permissions required: bb.reviewConfigs.listListReviewConfigs(context.Context, *connect.Request[v1.ListReviewConfigsRequest]) (*connect.Response[v1.ListReviewConfigsResponse], error)+ // Retrieves a SQL review configuration by name.// Permissions required: bb.reviewConfigs.getGetReviewConfig(context.Context, *connect.Request[v1.GetReviewConfigRequest]) (*connect.Response[v1.ReviewConfig], error)+ // Updates a SQL review configuration.// Permissions required: bb.reviewConfigs.updateUpdateReviewConfig(context.Context, *connect.Request[v1.UpdateReviewConfigRequest]) (*connect.Response[v1.ReviewConfig], error)+ // Deletes a SQL review configuration.// Permissions required: bb.reviewConfigs.deleteDeleteReviewConfig(context.Context, *connect.Request[v1.DeleteReviewConfigRequest]) (*connect.Response[emptypb.Empty], error)}@@ -145,14 +150,19 @@ func (c *reviewConfigServiceClient) DeleteReviewConfig(ctx context.Context, req// ReviewConfigServiceHandler is an implementation of the bytebase.v1.ReviewConfigService service.type ReviewConfigServiceHandler interface {+ // Creates a new SQL review configuration.// Permissions required: bb.reviewConfigs.createCreateReviewConfig(context.Context, *connect.Request[v1.CreateReviewConfigRequest]) (*connect.Response[v1.ReviewConfig], error)+ // Lists all SQL review configurations.// Permissions required: bb.reviewConfigs.listListReviewConfigs(context.Context, *connect.Request[v1.ListReviewConfigsRequest]) (*connect.Response[v1.ListReviewConfigsResponse], error)+ // Retrieves a SQL review configuration by name.// Permissions required: bb.reviewConfigs.getGetReviewConfig(context.Context, *connect.Request[v1.GetReviewConfigRequest]) (*connect.Response[v1.ReviewConfig], error)+ // Updates a SQL review configuration.// Permissions required: bb.reviewConfigs.updateUpdateReviewConfig(context.Context, *connect.Request[v1.UpdateReviewConfigRequest]) (*connect.Response[v1.ReviewConfig], error)+ // Deletes a SQL review configuration.// Permissions required: bb.reviewConfigs.deleteDeleteReviewConfig(context.Context, *connect.Request[v1.DeleteReviewConfigRequest]) (*connect.Response[emptypb.Empty], error)}diff --git a/backend/generated-go/v1/v1connect/revision_service.connect.go b/backend/generated-go/v1/v1connect/revision_service.connect.goindex ca28324550..b0a6916e29 100644--- a/backend/generated-go/v1/v1connect/revision_service.connect.go+++ b/backend/generated-go/v1/v1connect/revision_service.connect.go@@ -53,14 +53,19 @@ const (// RevisionServiceClient is a client for the bytebase.v1.RevisionService service.type RevisionServiceClient interface {+ // Lists schema revisions for a database.// Permissions required: bb.revisions.listListRevisions(context.Context, *connect.Request[v1.ListRevisionsRequest]) (*connect.Response[v1.ListRevisionsResponse], error)+ // Retrieves a schema revision by name.// Permissions required: bb.revisions.getGetRevision(context.Context, *connect.Request[v1.GetRevisionRequest]) (*connect.Response[v1.Revision], error)+ // Creates a new schema revision.// Permissions required: bb.revisions.createCreateRevision(context.Context, *connect.Request[v1.CreateRevisionRequest]) (*connect.Response[v1.Revision], error)+ // Creates multiple schema revisions in a single operation.// Permissions required: bb.revisions.createBatchCreateRevisions(context.Context, *connect.Request[v1.BatchCreateRevisionsRequest]) (*connect.Response[v1.BatchCreateRevisionsResponse], error)+ // Deletes a schema revision.// Permissions required: bb.revisions.deleteDeleteRevision(context.Context, *connect.Request[v1.DeleteRevisionRequest]) (*connect.Response[emptypb.Empty], error)}@@ -145,14 +150,19 @@ func (c *revisionServiceClient) DeleteRevision(ctx context.Context, req *connect// RevisionServiceHandler is an implementation of the bytebase.v1.RevisionService service.type RevisionServiceHandler interface {+ // Lists schema revisions for a database.// Permissions required: bb.revisions.listListRevisions(context.Context, *connect.Request[v1.ListRevisionsRequest]) (*connect.Response[v1.ListRevisionsResponse], error)+ // Retrieves a schema revision by name.// Permissions required: bb.revisions.getGetRevision(context.Context, *connect.Request[v1.GetRevisionRequest]) (*connect.Response[v1.Revision], error)+ // Creates a new schema revision.// Permissions required: bb.revisions.createCreateRevision(context.Context, *connect.Request[v1.CreateRevisionRequest]) (*connect.Response[v1.Revision], error)+ // Creates multiple schema revisions in a single operation.// Permissions required: bb.revisions.createBatchCreateRevisions(context.Context, *connect.Request[v1.BatchCreateRevisionsRequest]) (*connect.Response[v1.BatchCreateRevisionsResponse], error)+ // Deletes a schema revision.// Permissions required: bb.revisions.deleteDeleteRevision(context.Context, *connect.Request[v1.DeleteRevisionRequest]) (*connect.Response[emptypb.Empty], error)}diff --git a/backend/generated-go/v1/v1connect/risk_service.connect.go b/backend/generated-go/v1/v1connect/risk_service.connect.goindex ef99900f8f..4e07edb604 100644--- a/backend/generated-go/v1/v1connect/risk_service.connect.go+++ b/backend/generated-go/v1/v1connect/risk_service.connect.go@@ -48,14 +48,19 @@ const (// RiskServiceClient is a client for the bytebase.v1.RiskService service.type RiskServiceClient interface {+ // Lists all risk assessment rules.// Permissions required: bb.risks.listListRisks(context.Context, *connect.Request[v1.ListRisksRequest]) (*connect.Response[v1.ListRisksResponse], error)+ // Creates a new risk assessment rule.// Permissions required: bb.risks.createCreateRisk(context.Context, *connect.Request[v1.CreateRiskRequest]) (*connect.Response[v1.Risk], error)+ // Retrieves a risk assessment rule by name.// Permissions required: bb.risks.listGetRisk(context.Context, *connect.Request[v1.GetRiskRequest]) (*connect.Response[v1.Risk], error)+ // Updates an existing risk assessment rule.// Permissions required: bb.risks.updateUpdateRisk(context.Context, *connect.Request[v1.UpdateRiskRequest]) (*connect.Response[v1.Risk], error)+ // Deletes a risk assessment rule.// Permissions required: bb.risks.deleteDeleteRisk(context.Context, *connect.Request[v1.DeleteRiskRequest]) (*connect.Response[emptypb.Empty], error)}@@ -140,14 +145,19 @@ func (c *riskServiceClient) DeleteRisk(ctx context.Context, req *connect.Request// RiskServiceHandler is an implementation of the bytebase.v1.RiskService service.type RiskServiceHandler interface {+ // Lists all risk assessment rules.// Permissions required: bb.risks.listListRisks(context.Context, *connect.Request[v1.ListRisksRequest]) (*connect.Response[v1.ListRisksResponse], error)+ // Creates a new risk assessment rule.// Permissions required: bb.risks.createCreateRisk(context.Context, *connect.Request[v1.CreateRiskRequest]) (*connect.Response[v1.Risk], error)+ // Retrieves a risk assessment rule by name.// Permissions required: bb.risks.listGetRisk(context.Context, *connect.Request[v1.GetRiskRequest]) (*connect.Response[v1.Risk], error)+ // Updates an existing risk assessment rule.// Permissions required: bb.risks.updateUpdateRisk(context.Context, *connect.Request[v1.UpdateRiskRequest]) (*connect.Response[v1.Risk], error)+ // Deletes a risk assessment rule.// Permissions required: bb.risks.deleteDeleteRisk(context.Context, *connect.Request[v1.DeleteRiskRequest]) (*connect.Response[emptypb.Empty], error)}diff --git a/backend/generated-go/v1/v1connect/role_service.connect.go b/backend/generated-go/v1/v1connect/role_service.connect.goindex bb08da6029..efa8f9df10 100644--- a/backend/generated-go/v1/v1connect/role_service.connect.go+++ b/backend/generated-go/v1/v1connect/role_service.connect.go@@ -48,14 +48,19 @@ const (// RoleServiceClient is a client for the bytebase.v1.RoleService service.type RoleServiceClient interface {+ // Lists roles in the workspace.// Permissions required: bb.roles.listListRoles(context.Context, *connect.Request[v1.ListRolesRequest]) (*connect.Response[v1.ListRolesResponse], error)+ // Retrieves a role by name.// Permissions required: bb.roles.getGetRole(context.Context, *connect.Request[v1.GetRoleRequest]) (*connect.Response[v1.Role], error)+ // Creates a new custom role.// Permissions required: bb.roles.createCreateRole(context.Context, *connect.Request[v1.CreateRoleRequest]) (*connect.Response[v1.Role], error)+ // Updates a role's properties.// Permissions required: bb.roles.updateUpdateRole(context.Context, *connect.Request[v1.UpdateRoleRequest]) (*connect.Response[v1.Role], error)+ // Deletes a custom role.// Permissions required: bb.roles.deleteDeleteRole(context.Context, *connect.Request[v1.DeleteRoleRequest]) (*connect.Response[emptypb.Empty], error)}@@ -140,14 +145,19 @@ func (c *roleServiceClient) DeleteRole(ctx context.Context, req *connect.Request// RoleServiceHandler is an implementation of the bytebase.v1.RoleService service.type RoleServiceHandler interface {+ // Lists roles in the workspace.// Permissions required: bb.roles.listListRoles(context.Context, *connect.Request[v1.ListRolesRequest]) (*connect.Response[v1.ListRolesResponse], error)+ // Retrieves a role by name.// Permissions required: bb.roles.getGetRole(context.Context, *connect.Request[v1.GetRoleRequest]) (*connect.Response[v1.Role], error)+ // Creates a new custom role.// Permissions required: bb.roles.createCreateRole(context.Context, *connect.Request[v1.CreateRoleRequest]) (*connect.Response[v1.Role], error)+ // Updates a role's properties.// Permissions required: bb.roles.updateUpdateRole(context.Context, *connect.Request[v1.UpdateRoleRequest]) (*connect.Response[v1.Role], error)+ // Deletes a custom role.// Permissions required: bb.roles.deleteDeleteRole(context.Context, *connect.Request[v1.DeleteRoleRequest]) (*connect.Response[emptypb.Empty], error)}diff --git a/backend/generated-go/v1/v1connect/rollout_service.connect.go b/backend/generated-go/v1/v1connect/rollout_service.connect.goindex cb7723238a..92c8e7aaf6 100644--- a/backend/generated-go/v1/v1connect/rollout_service.connect.go+++ b/backend/generated-go/v1/v1connect/rollout_service.connect.go@@ -73,28 +73,40 @@ const (// RolloutServiceClient is a client for the bytebase.v1.RolloutService service.type RolloutServiceClient interface {+ // Retrieves a rollout by name.// Permissions required: bb.rollouts.getGetRollout(context.Context, *connect.Request[v1.GetRolloutRequest]) (*connect.Response[v1.Rollout], error)+ // Lists rollouts in a project.// Permissions required: bb.rollouts.listListRollouts(context.Context, *connect.Request[v1.ListRolloutsRequest]) (*connect.Response[v1.ListRolloutsResponse], error)+ // Creates a new rollout from a plan.// Permissions required: bb.rollouts.createCreateRollout(context.Context, *connect.Request[v1.CreateRolloutRequest]) (*connect.Response[v1.Rollout], error)+ // Previews the rollout that would be created from a plan.// Permissions required: bb.rollouts.previewPreviewRollout(context.Context, *connect.Request[v1.PreviewRolloutRequest]) (*connect.Response[v1.Rollout], error)+ // Lists task run executions for a task.// Permissions required: bb.taskRuns.listListTaskRuns(context.Context, *connect.Request[v1.ListTaskRunsRequest]) (*connect.Response[v1.ListTaskRunsResponse], error)+ // Retrieves a task run by name.// Permissions required: bb.taskRuns.listGetTaskRun(context.Context, *connect.Request[v1.GetTaskRunRequest]) (*connect.Response[v1.TaskRun], error)+ // Retrieves execution logs for a task run.// Permissions required: bb.taskRuns.listGetTaskRunLog(context.Context, *connect.Request[v1.GetTaskRunLogRequest]) (*connect.Response[v1.TaskRunLog], error)+ // Retrieves database session information for a running task.// Permissions required: bb.taskRuns.listGetTaskRunSession(context.Context, *connect.Request[v1.GetTaskRunSessionRequest]) (*connect.Response[v1.TaskRunSession], error)- // Permissions required: None+ // Executes multiple tasks in a rollout stage.+ // Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)BatchRunTasks(context.Context, *connect.Request[v1.BatchRunTasksRequest]) (*connect.Response[v1.BatchRunTasksResponse], error)- // Permissions required: None+ // Skips multiple tasks in a rollout stage.+ // Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)BatchSkipTasks(context.Context, *connect.Request[v1.BatchSkipTasksRequest]) (*connect.Response[v1.BatchSkipTasksResponse], error)- // Permissions required: None+ // Cancels multiple running task executions.+ // Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)BatchCancelTaskRuns(context.Context, *connect.Request[v1.BatchCancelTaskRunsRequest]) (*connect.Response[v1.BatchCancelTaskRunsResponse], error)+ // Generates rollback SQL for a completed task run.// Permissions required: bb.taskRuns.listPreviewTaskRunRollback(context.Context, *connect.Request[v1.PreviewTaskRunRollbackRequest]) (*connect.Response[v1.PreviewTaskRunRollbackResponse], error)}@@ -263,28 +275,40 @@ func (c *rolloutServiceClient) PreviewTaskRunRollback(ctx context.Context, req *// RolloutServiceHandler is an implementation of the bytebase.v1.RolloutService service.type RolloutServiceHandler interface {+ // Retrieves a rollout by name.// Permissions required: bb.rollouts.getGetRollout(context.Context, *connect.Request[v1.GetRolloutRequest]) (*connect.Response[v1.Rollout], error)+ // Lists rollouts in a project.// Permissions required: bb.rollouts.listListRollouts(context.Context, *connect.Request[v1.ListRolloutsRequest]) (*connect.Response[v1.ListRolloutsResponse], error)+ // Creates a new rollout from a plan.// Permissions required: bb.rollouts.createCreateRollout(context.Context, *connect.Request[v1.CreateRolloutRequest]) (*connect.Response[v1.Rollout], error)+ // Previews the rollout that would be created from a plan.// Permissions required: bb.rollouts.previewPreviewRollout(context.Context, *connect.Request[v1.PreviewRolloutRequest]) (*connect.Response[v1.Rollout], error)+ // Lists task run executions for a task.// Permissions required: bb.taskRuns.listListTaskRuns(context.Context, *connect.Request[v1.ListTaskRunsRequest]) (*connect.Response[v1.ListTaskRunsResponse], error)+ // Retrieves a task run by name.// Permissions required: bb.taskRuns.listGetTaskRun(context.Context, *connect.Request[v1.GetTaskRunRequest]) (*connect.Response[v1.TaskRun], error)+ // Retrieves execution logs for a task run.// Permissions required: bb.taskRuns.listGetTaskRunLog(context.Context, *connect.Request[v1.GetTaskRunLogRequest]) (*connect.Response[v1.TaskRunLog], error)+ // Retrieves database session information for a running task.// Permissions required: bb.taskRuns.listGetTaskRunSession(context.Context, *connect.Request[v1.GetTaskRunSessionRequest]) (*connect.Response[v1.TaskRunSession], error)- // Permissions required: None+ // Executes multiple tasks in a rollout stage.+ // Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)BatchRunTasks(context.Context, *connect.Request[v1.BatchRunTasksRequest]) (*connect.Response[v1.BatchRunTasksResponse], error)- // Permissions required: None+ // Skips multiple tasks in a rollout stage.+ // Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)BatchSkipTasks(context.Context, *connect.Request[v1.BatchSkipTasksRequest]) (*connect.Response[v1.BatchSkipTasksResponse], error)- // Permissions required: None+ // Cancels multiple running task executions.+ // Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)BatchCancelTaskRuns(context.Context, *connect.Request[v1.BatchCancelTaskRunsRequest]) (*connect.Response[v1.BatchCancelTaskRunsResponse], error)+ // Generates rollback SQL for a completed task run.// Permissions required: bb.taskRuns.listPreviewTaskRunRollback(context.Context, *connect.Request[v1.PreviewTaskRunRollbackRequest]) (*connect.Response[v1.PreviewTaskRunRollbackResponse], error)}diff --git a/backend/generated-go/v1/v1connect/setting_service.connect.go b/backend/generated-go/v1/v1connect/setting_service.connect.goindex 33c5fbb292..082eff3766 100644--- a/backend/generated-go/v1/v1connect/setting_service.connect.go+++ b/backend/generated-go/v1/v1connect/setting_service.connect.go@@ -46,10 +46,13 @@ const (// SettingServiceClient is a client for the bytebase.v1.SettingService service.type SettingServiceClient interface {+ // Lists all workspace settings.// Permissions required: bb.settings.listListSettings(context.Context, *connect.Request[v1.ListSettingsRequest]) (*connect.Response[v1.ListSettingsResponse], error)+ // Retrieves a workspace setting by name.// Permissions required: bb.settings.getGetSetting(context.Context, *connect.Request[v1.GetSettingRequest]) (*connect.Response[v1.Setting], error)+ // Updates a workspace setting.// Permissions required: bb.settings.setUpdateSetting(context.Context, *connect.Request[v1.UpdateSettingRequest]) (*connect.Response[v1.Setting], error)}@@ -110,10 +113,13 @@ func (c *settingServiceClient) UpdateSetting(ctx context.Context, req *connect.R// SettingServiceHandler is an implementation of the bytebase.v1.SettingService service.type SettingServiceHandler interface {+ // Lists all workspace settings.// Permissions required: bb.settings.listListSettings(context.Context, *connect.Request[v1.ListSettingsRequest]) (*connect.Response[v1.ListSettingsResponse], error)+ // Retrieves a workspace setting by name.// Permissions required: bb.settings.getGetSetting(context.Context, *connect.Request[v1.GetSettingRequest]) (*connect.Response[v1.Setting], error)+ // Updates a workspace setting.// Permissions required: bb.settings.setUpdateSetting(context.Context, *connect.Request[v1.UpdateSettingRequest]) (*connect.Response[v1.Setting], error)}diff --git a/backend/generated-go/v1/v1connect/sheet_service.connect.go b/backend/generated-go/v1/v1connect/sheet_service.connect.goindex 9ce856160a..ebf8972ad9 100644--- a/backend/generated-go/v1/v1connect/sheet_service.connect.go+++ b/backend/generated-go/v1/v1connect/sheet_service.connect.go@@ -48,12 +48,16 @@ const (// SheetServiceClient is a client for the bytebase.v1.SheetService service.type SheetServiceClient interface {+ // Creates a new SQL sheet.// Permissions required: bb.sheets.createCreateSheet(context.Context, *connect.Request[v1.CreateSheetRequest]) (*connect.Response[v1.Sheet], error)+ // Creates multiple SQL sheets in a single operation.// Permissions required: bb.sheets.createBatchCreateSheets(context.Context, *connect.Request[v1.BatchCreateSheetsRequest]) (*connect.Response[v1.BatchCreateSheetsResponse], error)+ // Retrieves a SQL sheet by name.// Permissions required: bb.sheets.getGetSheet(context.Context, *connect.Request[v1.GetSheetRequest]) (*connect.Response[v1.Sheet], error)+ // Updates a SQL sheet's title or content.// Permissions required: bb.sheets.updateUpdateSheet(context.Context, *connect.Request[v1.UpdateSheetRequest]) (*connect.Response[v1.Sheet], error)}@@ -126,12 +130,16 @@ func (c *sheetServiceClient) UpdateSheet(ctx context.Context, req *connect.Reque// SheetServiceHandler is an implementation of the bytebase.v1.SheetService service.type SheetServiceHandler interface {+ // Creates a new SQL sheet.// Permissions required: bb.sheets.createCreateSheet(context.Context, *connect.Request[v1.CreateSheetRequest]) (*connect.Response[v1.Sheet], error)+ // Creates multiple SQL sheets in a single operation.// Permissions required: bb.sheets.createBatchCreateSheets(context.Context, *connect.Request[v1.BatchCreateSheetsRequest]) (*connect.Response[v1.BatchCreateSheetsResponse], error)+ // Retrieves a SQL sheet by name.// Permissions required: bb.sheets.getGetSheet(context.Context, *connect.Request[v1.GetSheetRequest]) (*connect.Response[v1.Sheet], error)+ // Updates a SQL sheet's title or content.// Permissions required: bb.sheets.updateUpdateSheet(context.Context, *connect.Request[v1.UpdateSheetRequest]) (*connect.Response[v1.Sheet], error)}diff --git a/backend/generated-go/v1/v1connect/sql_service.connect.go b/backend/generated-go/v1/v1connect/sql_service.connect.goindex 8cb1a5bf2f..f2027d11e3 100644--- a/backend/generated-go/v1/v1connect/sql_service.connect.go+++ b/backend/generated-go/v1/v1connect/sql_service.connect.go@@ -54,22 +54,29 @@ const (// SQLServiceClient is a client for the bytebase.v1.SQLService service.type SQLServiceClient interface {+ // Executes a read-only SQL query against a database.// Permissions required: bb.databases.getQuery(context.Context, *connect.Request[v1.QueryRequest]) (*connect.Response[v1.QueryResponse], error)+ // Executes SQL with admin privileges via streaming connection.// Permissions required: bb.sql.adminAdminExecute(context.Context) *connect.BidiStreamForClient[v1.AdminExecuteRequest, v1.AdminExecuteResponse]// SearchQueryHistories searches query histories for the caller.- // Permissions required: None+ // Permissions required: None (only returns caller's own query histories)SearchQueryHistories(context.Context, *connect.Request[v1.SearchQueryHistoriesRequest]) (*connect.Response[v1.SearchQueryHistoriesResponse], error)+ // Exports query results to a file format.// Permissions required: bb.databases.getExport(context.Context, *connect.Request[v1.ExportRequest]) (*connect.Response[v1.ExportResponse], error)+ // Validates SQL statements against review rules.// Permissions required: bb.databases.checkCheck(context.Context, *connect.Request[v1.CheckRequest]) (*connect.Response[v1.CheckResponse], error)+ // Formats and normalizes SQL schema definitions.// Permissions required: NonePretty(context.Context, *connect.Request[v1.PrettyRequest]) (*connect.Response[v1.PrettyResponse], error)+ // Computes schema differences between two database metadata.// Permissions required: NoneDiffMetadata(context.Context, *connect.Request[v1.DiffMetadataRequest]) (*connect.Response[v1.DiffMetadataResponse], error)- // Permissions required: None+ // Provides AI-powered SQL completion and generation.+ // Permissions required: None (authenticated users only, requires AI to be enabled)AICompletion(context.Context, *connect.Request[v1.AICompletionRequest]) (*connect.Response[v1.AICompletionResponse], error)}@@ -189,22 +196,29 @@ func (c *sQLServiceClient) AICompletion(ctx context.Context, req *connect.Reques// SQLServiceHandler is an implementation of the bytebase.v1.SQLService service.type SQLServiceHandler interface {+ // Executes a read-only SQL query against a database.// Permissions required: bb.databases.getQuery(context.Context, *connect.Request[v1.QueryRequest]) (*connect.Response[v1.QueryResponse], error)+ // Executes SQL with admin privileges via streaming connection.// Permissions required: bb.sql.adminAdminExecute(context.Context, *connect.BidiStream[v1.AdminExecuteRequest, v1.AdminExecuteResponse]) error// SearchQueryHistories searches query histories for the caller.- // Permissions required: None+ // Permissions required: None (only returns caller's own query histories)SearchQueryHistories(context.Context, *connect.Request[v1.SearchQueryHistoriesRequest]) (*connect.Response[v1.SearchQueryHistoriesResponse], error)+ // Exports query results to a file format.// Permissions required: bb.databases.getExport(context.Context, *connect.Request[v1.ExportRequest]) (*connect.Response[v1.ExportResponse], error)+ // Validates SQL statements against review rules.// Permissions required: bb.databases.checkCheck(context.Context, *connect.Request[v1.CheckRequest]) (*connect.Response[v1.CheckResponse], error)+ // Formats and normalizes SQL schema definitions.// Permissions required: NonePretty(context.Context, *connect.Request[v1.PrettyRequest]) (*connect.Response[v1.PrettyResponse], error)+ // Computes schema differences between two database metadata.// Permissions required: NoneDiffMetadata(context.Context, *connect.Request[v1.DiffMetadataRequest]) (*connect.Response[v1.DiffMetadataResponse], error)- // Permissions required: None+ // Provides AI-powered SQL completion and generation.+ // Permissions required: None (authenticated users only, requires AI to be enabled)AICompletion(context.Context, *connect.Request[v1.AICompletionRequest]) (*connect.Response[v1.AICompletionResponse], error)}diff --git a/backend/generated-go/v1/v1connect/subscription_service.connect.go b/backend/generated-go/v1/v1connect/subscription_service.connect.goindex a63e86ba17..43d9463bbd 100644--- a/backend/generated-go/v1/v1connect/subscription_service.connect.go+++ b/backend/generated-go/v1/v1connect/subscription_service.connect.go@@ -48,6 +48,7 @@ type SubscriptionServiceClient interface {// If there is expired license, we will return a free plan subscription with the expiration time of the expired license.// Permissions required: NoneGetSubscription(context.Context, *connect.Request[v1.GetSubscriptionRequest]) (*connect.Response[v1.Subscription], error)+ // Updates the enterprise license subscription.// Permissions required: bb.settings.setUpdateSubscription(context.Context, *connect.Request[v1.UpdateSubscriptionRequest]) (*connect.Response[v1.Subscription], error)}@@ -101,6 +102,7 @@ type SubscriptionServiceHandler interface {// If there is expired license, we will return a free plan subscription with the expiration time of the expired license.// Permissions required: NoneGetSubscription(context.Context, *connect.Request[v1.GetSubscriptionRequest]) (*connect.Response[v1.Subscription], error)+ // Updates the enterprise license subscription.// Permissions required: bb.settings.setUpdateSubscription(context.Context, *connect.Request[v1.UpdateSubscriptionRequest]) (*connect.Response[v1.Subscription], error)}diff --git a/backend/generated-go/v1/v1connect/user_service.connect.go b/backend/generated-go/v1/v1connect/user_service.connect.goindex 3c74237176..29b8d66db1 100644--- a/backend/generated-go/v1/v1connect/user_service.connect.go+++ b/backend/generated-go/v1/v1connect/user_service.connect.go@@ -72,19 +72,16 @@ type UserServiceClient interface {// Any authenticated user can list users.// Permissions required: bb.users.listListUsers(context.Context, *connect.Request[v1.ListUsersRequest]) (*connect.Response[v1.ListUsersResponse], error)- // Create a user.- // When Disallow Signup is enabled, only the caller with bb.users.create on the workspace can create a user.- // Otherwise, any unauthenticated user can create a user.- // Permissions required: bb.users.create+ // Creates a user. When Disallow Signup is enabled, requires bb.users.create permission; otherwise any user can sign up.+ // Permissions required: bb.users.create (only when Disallow Signup is enabled)CreateUser(context.Context, *connect.Request[v1.CreateUserRequest]) (*connect.Response[v1.User], error)- // Only the user itself and the user with bb.users.update permission on the workspace can update the user.- // Permissions required: bb.users.update+ // Updates a user. Users can update their own profile, or users with bb.users.update permission can update any user.+ // Permissions required: bb.users.update (or self)UpdateUser(context.Context, *connect.Request[v1.UpdateUserRequest]) (*connect.Response[v1.User], error)- // Only the user with bb.users.delete permission on the workspace can delete the user.- // The last remaining workspace admin cannot be deleted.+ // Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted.// Permissions required: bb.users.deleteDeleteUser(context.Context, *connect.Request[v1.DeleteUserRequest]) (*connect.Response[emptypb.Empty], error)- // Only the user with bb.users.undelete permission on the workspace can undelete the user.+ // Restores a deleted user.// Permissions required: bb.users.undeleteUndeleteUser(context.Context, *connect.Request[v1.UndeleteUserRequest]) (*connect.Response[v1.User], error)}@@ -220,19 +217,16 @@ type UserServiceHandler interface {// Any authenticated user can list users.// Permissions required: bb.users.listListUsers(context.Context, *connect.Request[v1.ListUsersRequest]) (*connect.Response[v1.ListUsersResponse], error)- // Create a user.- // When Disallow Signup is enabled, only the caller with bb.users.create on the workspace can create a user.- // Otherwise, any unauthenticated user can create a user.- // Permissions required: bb.users.create+ // Creates a user. When Disallow Signup is enabled, requires bb.users.create permission; otherwise any user can sign up.+ // Permissions required: bb.users.create (only when Disallow Signup is enabled)CreateUser(context.Context, *connect.Request[v1.CreateUserRequest]) (*connect.Response[v1.User], error)- // Only the user itself and the user with bb.users.update permission on the workspace can update the user.- // Permissions required: bb.users.update+ // Updates a user. Users can update their own profile, or users with bb.users.update permission can update any user.+ // Permissions required: bb.users.update (or self)UpdateUser(context.Context, *connect.Request[v1.UpdateUserRequest]) (*connect.Response[v1.User], error)- // Only the user with bb.users.delete permission on the workspace can delete the user.- // The last remaining workspace admin cannot be deleted.+ // Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted.// Permissions required: bb.users.deleteDeleteUser(context.Context, *connect.Request[v1.DeleteUserRequest]) (*connect.Response[emptypb.Empty], error)- // Only the user with bb.users.undelete permission on the workspace can undelete the user.+ // Restores a deleted user.// Permissions required: bb.users.undeleteUndeleteUser(context.Context, *connect.Request[v1.UndeleteUserRequest]) (*connect.Response[v1.User], error)}diff --git a/backend/generated-go/v1/v1connect/worksheet_service.connect.go b/backend/generated-go/v1/v1connect/worksheet_service.connect.goindex 7f67e352fc..0b496e6929 100644--- a/backend/generated-go/v1/v1connect/worksheet_service.connect.go+++ b/backend/generated-go/v1/v1connect/worksheet_service.connect.go@@ -56,35 +56,35 @@ const (// WorksheetServiceClient is a client for the bytebase.v1.WorksheetService service.type WorksheetServiceClient interface {- // Create a personal worksheet used in SQL Editor.- // Permissions required: None+ // Creates a personal worksheet used in SQL Editor. Any authenticated user can create their own worksheets.+ // Permissions required: None (authenticated users only)CreateWorksheet(context.Context, *connect.Request[v1.CreateWorksheetRequest]) (*connect.Response[v1.Worksheet], error)// Get a worksheet by name.// The users can access this method if,// - they are the creator of the worksheet;// - they have bb.worksheets.get permission on the workspace;// - the sheet is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.- // Permissions required: None+ // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)GetWorksheet(context.Context, *connect.Request[v1.GetWorksheetRequest]) (*connect.Response[v1.Worksheet], error)// Search for worksheets.// This is used for finding my worksheets or worksheets shared by other people.// The sheet accessibility is the same as GetWorksheet().- // Permissions required: None+ // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)SearchWorksheets(context.Context, *connect.Request[v1.SearchWorksheetsRequest]) (*connect.Response[v1.SearchWorksheetsResponse], error)// Update a worksheet.// The users can access this method if,// - they are the creator of the worksheet;// - they have bb.worksheets.manage permission on the workspace;// - the sheet is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.- // Permissions required: None+ // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)UpdateWorksheet(context.Context, *connect.Request[v1.UpdateWorksheetRequest]) (*connect.Response[v1.Worksheet], error)// Update the organizer of a worksheet.// The access is the same as UpdateWorksheet method.- // Permissions required: None+ // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)UpdateWorksheetOrganizer(context.Context, *connect.Request[v1.UpdateWorksheetOrganizerRequest]) (*connect.Response[v1.WorksheetOrganizer], error)// Delete a worksheet.// The access is the same as UpdateWorksheet method.- // Permissions required: None+ // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)DeleteWorksheet(context.Context, *connect.Request[v1.DeleteWorksheetRequest]) (*connect.Response[emptypb.Empty], error)}@@ -180,35 +180,35 @@ func (c *worksheetServiceClient) DeleteWorksheet(ctx context.Context, req *conne// WorksheetServiceHandler is an implementation of the bytebase.v1.WorksheetService service.type WorksheetServiceHandler interface {- // Create a personal worksheet used in SQL Editor.- // Permissions required: None+ // Creates a personal worksheet used in SQL Editor. Any authenticated user can create their own worksheets.+ // Permissions required: None (authenticated users only)CreateWorksheet(context.Context, *connect.Request[v1.CreateWorksheetRequest]) (*connect.Response[v1.Worksheet], error)// Get a worksheet by name.// The users can access this method if,// - they are the creator of the worksheet;// - they have bb.worksheets.get permission on the workspace;// - the sheet is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.- // Permissions required: None+ // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)GetWorksheet(context.Context, *connect.Request[v1.GetWorksheetRequest]) (*connect.Response[v1.Worksheet], error)// Search for worksheets.// This is used for finding my worksheets or worksheets shared by other people.// The sheet accessibility is the same as GetWorksheet().- // Permissions required: None+ // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)SearchWorksheets(context.Context, *connect.Request[v1.SearchWorksheetsRequest]) (*connect.Response[v1.SearchWorksheetsResponse], error)// Update a worksheet.// The users can access this method if,// - they are the creator of the worksheet;// - they have bb.worksheets.manage permission on the workspace;// - the sheet is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.- // Permissions required: None+ // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)UpdateWorksheet(context.Context, *connect.Request[v1.UpdateWorksheetRequest]) (*connect.Response[v1.Worksheet], error)// Update the organizer of a worksheet.// The access is the same as UpdateWorksheet method.- // Permissions required: None+ // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)UpdateWorksheetOrganizer(context.Context, *connect.Request[v1.UpdateWorksheetOrganizerRequest]) (*connect.Response[v1.WorksheetOrganizer], error)// Delete a worksheet.// The access is the same as UpdateWorksheet method.- // Permissions required: None+ // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)DeleteWorksheet(context.Context, *connect.Request[v1.DeleteWorksheetRequest]) (*connect.Response[emptypb.Empty], error)}diff --git a/backend/generated-go/v1/v1connect/workspace_service.connect.go b/backend/generated-go/v1/v1connect/workspace_service.connect.goindex 2935cb2ddf..0dcedd1d2f 100644--- a/backend/generated-go/v1/v1connect/workspace_service.connect.go+++ b/backend/generated-go/v1/v1connect/workspace_service.connect.go@@ -43,8 +43,10 @@ const (// WorkspaceServiceClient is a client for the bytebase.v1.WorkspaceService service.type WorkspaceServiceClient interface {+ // Retrieves IAM policy for the workspace.// Permissions required: bb.workspaces.getIamPolicyGetIamPolicy(context.Context, *connect.Request[v1.GetIamPolicyRequest]) (*connect.Response[v1.IamPolicy], error)+ // Sets IAM policy for the workspace.// Permissions required: bb.workspaces.setIamPolicySetIamPolicy(context.Context, *connect.Request[v1.SetIamPolicyRequest]) (*connect.Response[v1.IamPolicy], error)}@@ -93,8 +95,10 @@ func (c *workspaceServiceClient) SetIamPolicy(ctx context.Context, req *connect.// WorkspaceServiceHandler is an implementation of the bytebase.v1.WorkspaceService service.type WorkspaceServiceHandler interface {+ // Retrieves IAM policy for the workspace.// Permissions required: bb.workspaces.getIamPolicyGetIamPolicy(context.Context, *connect.Request[v1.GetIamPolicyRequest]) (*connect.Response[v1.IamPolicy], error)+ // Sets IAM policy for the workspace.// Permissions required: bb.workspaces.setIamPolicySetIamPolicy(context.Context, *connect.Request[v1.SetIamPolicyRequest]) (*connect.Response[v1.IamPolicy], error)}diff --git a/backend/generated-go/v1/worksheet_service.pb.go b/backend/generated-go/v1/worksheet_service.pb.goindex 371629dc76..7a5c070538 100644--- a/backend/generated-go/v1/worksheet_service.pb.go+++ b/backend/generated-go/v1/worksheet_service.pb.go@@ -424,13 +424,13 @@ type SearchWorksheetsRequest struct {// visibility in ["PRIVATE", "PROJECT_READ", "PROJECT_WRITE"]// visibility == "PRIVATE"Filter string `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// The maximum number of worksheets to return. The service may return fewer than// this value.// If unspecified, at most 10 worksheets 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"`- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// A page token, received from a previous `SearchWorksheets` call.// Provide this to retrieve the subsequent page.//@@ -496,7 +496,8 @@ type SearchWorksheetsResponse struct {state protoimpl.MessageState `protogen:"open.v1"`// The worksheets that matched the search criteria.Worksheets []*Worksheet `protobuf:"bytes,1,rep,name=worksheets,proto3" json:"worksheets,omitempty"`- // Not used. A token, which can be sent as `page_token` to retrieve the next page.+ // Pagination is not currently implemented. This field is reserved for future use.+ // A token, which can be sent as `page_token` to retrieve the next page.// If this field is omitted, there are no subsequent pages.NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`unknownFields protoimpl.UnknownFieldsdiff --git a/backend/generated-go/v1/worksheet_service_grpc.pb.go b/backend/generated-go/v1/worksheet_service_grpc.pb.goindex ab25ad9257..3f77fb49e6 100644--- a/backend/generated-go/v1/worksheet_service_grpc.pb.go+++ b/backend/generated-go/v1/worksheet_service_grpc.pb.go@@ -31,36 +31,38 @@ const (// WorksheetServiceClient is the client API for WorksheetService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// WorksheetService manages SQL worksheets for query development.type WorksheetServiceClient interface {- // Create a personal worksheet used in SQL Editor.- // Permissions required: None+ // Creates a personal worksheet used in SQL Editor. Any authenticated user can create their own worksheets.+ // Permissions required: None (authenticated users only)CreateWorksheet(ctx context.Context, in *CreateWorksheetRequest, opts ...grpc.CallOption) (*Worksheet, error)// Get a worksheet by name.// The users can access this method if,// - they are the creator of the worksheet;// - they have bb.worksheets.get permission on the workspace;// - the sheet is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.- // Permissions required: None+ // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)GetWorksheet(ctx context.Context, in *GetWorksheetRequest, opts ...grpc.CallOption) (*Worksheet, error)// Search for worksheets.// This is used for finding my worksheets or worksheets shared by other people.// The sheet accessibility is the same as GetWorksheet().- // Permissions required: None+ // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)SearchWorksheets(ctx context.Context, in *SearchWorksheetsRequest, opts ...grpc.CallOption) (*SearchWorksheetsResponse, error)// Update a worksheet.// The users can access this method if,// - they are the creator of the worksheet;// - they have bb.worksheets.manage permission on the workspace;// - the sheet is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.- // Permissions required: None+ // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)UpdateWorksheet(ctx context.Context, in *UpdateWorksheetRequest, opts ...grpc.CallOption) (*Worksheet, error)// Update the organizer of a worksheet.// The access is the same as UpdateWorksheet method.- // Permissions required: None+ // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)UpdateWorksheetOrganizer(ctx context.Context, in *UpdateWorksheetOrganizerRequest, opts ...grpc.CallOption) (*WorksheetOrganizer, error)// Delete a worksheet.// The access is the same as UpdateWorksheet method.- // Permissions required: None+ // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)DeleteWorksheet(ctx context.Context, in *DeleteWorksheetRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)}@@ -135,36 +137,38 @@ func (c *worksheetServiceClient) DeleteWorksheet(ctx context.Context, in *Delete// WorksheetServiceServer is the server API for WorksheetService service.// All implementations must embed UnimplementedWorksheetServiceServer// for forward compatibility.+//+// WorksheetService manages SQL worksheets for query development.type WorksheetServiceServer interface {- // Create a personal worksheet used in SQL Editor.- // Permissions required: None+ // Creates a personal worksheet used in SQL Editor. Any authenticated user can create their own worksheets.+ // Permissions required: None (authenticated users only)CreateWorksheet(context.Context, *CreateWorksheetRequest) (*Worksheet, error)// Get a worksheet by name.// The users can access this method if,// - they are the creator of the worksheet;// - they have bb.worksheets.get permission on the workspace;// - the sheet is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.- // Permissions required: None+ // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)GetWorksheet(context.Context, *GetWorksheetRequest) (*Worksheet, error)// Search for worksheets.// This is used for finding my worksheets or worksheets shared by other people.// The sheet accessibility is the same as GetWorksheet().- // Permissions required: None+ // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)SearchWorksheets(context.Context, *SearchWorksheetsRequest) (*SearchWorksheetsResponse, error)// Update a worksheet.// The users can access this method if,// - they are the creator of the worksheet;// - they have bb.worksheets.manage permission on the workspace;// - the sheet is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.- // Permissions required: None+ // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)UpdateWorksheet(context.Context, *UpdateWorksheetRequest) (*Worksheet, error)// Update the organizer of a worksheet.// The access is the same as UpdateWorksheet method.- // Permissions required: None+ // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)UpdateWorksheetOrganizer(context.Context, *UpdateWorksheetOrganizerRequest) (*WorksheetOrganizer, error)// Delete a worksheet.// The access is the same as UpdateWorksheet method.- // Permissions required: None+ // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)DeleteWorksheet(context.Context, *DeleteWorksheetRequest) (*emptypb.Empty, error)mustEmbedUnimplementedWorksheetServiceServer()}diff --git a/backend/generated-go/v1/workspace_service_grpc.pb.go b/backend/generated-go/v1/workspace_service_grpc.pb.goindex 6e5f141f3c..5e19d5ab8d 100644--- a/backend/generated-go/v1/workspace_service_grpc.pb.go+++ b/backend/generated-go/v1/workspace_service_grpc.pb.go@@ -26,9 +26,13 @@ const (// WorkspaceServiceClient is the client API for WorkspaceService service.//// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.+//+// WorkspaceService manages workspace-level operations and profile.type WorkspaceServiceClient interface {+ // Retrieves IAM policy for the workspace.// Permissions required: bb.workspaces.getIamPolicyGetIamPolicy(ctx context.Context, in *GetIamPolicyRequest, opts ...grpc.CallOption) (*IamPolicy, error)+ // Sets IAM policy for the workspace.// Permissions required: bb.workspaces.setIamPolicySetIamPolicy(ctx context.Context, in *SetIamPolicyRequest, opts ...grpc.CallOption) (*IamPolicy, error)}@@ -64,9 +68,13 @@ func (c *workspaceServiceClient) SetIamPolicy(ctx context.Context, in *SetIamPol// WorkspaceServiceServer is the server API for WorkspaceService service.// All implementations must embed UnimplementedWorkspaceServiceServer// for forward compatibility.+//+// WorkspaceService manages workspace-level operations and profile.type WorkspaceServiceServer interface {+ // Retrieves IAM policy for the workspace.// Permissions required: bb.workspaces.getIamPolicyGetIamPolicy(context.Context, *GetIamPolicyRequest) (*IamPolicy, error)+ // Sets IAM policy for the workspace.// Permissions required: bb.workspaces.setIamPolicySetIamPolicy(context.Context, *SetIamPolicyRequest) (*IamPolicy, error)mustEmbedUnimplementedWorkspaceServiceServer()diff --git a/frontend/src/types/proto-es/v1/actuator_service_pb.d.ts b/frontend/src/types/proto-es/v1/actuator_service_pb.d.tsindex bfbba79301..99fd33a5ea 100644--- a/frontend/src/types/proto-es/v1/actuator_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/actuator_service_pb.d.ts@@ -15,7 +15,7 @@ import type { State } from "./common_pb";export declare const file_v1_actuator_service: GenFile;/**- * The request message for getting the theme resource.+ * Request message for getting branding resources.** @generated from message bytebase.v1.GetResourcePackageRequest*/@@ -29,7 +29,7 @@ export declare type GetResourcePackageRequest = Message<"bytebase.v1.GetResourceexport declare const GetResourcePackageRequestSchema: GenMessage<GetResourcePackageRequest>;/**- * The theme resources.+ * Custom branding resources for the Bytebase instance.** @generated from message bytebase.v1.ResourcePackage*/@@ -49,6 +49,8 @@ export declare type ResourcePackage = Message<"bytebase.v1.ResourcePackage"> & {export declare const ResourcePackageSchema: GenMessage<ResourcePackage>;/**+ * Request message for setting up sample data.+ ** @generated from message bytebase.v1.SetupSampleRequest*/export declare type SetupSampleRequest = Message<"bytebase.v1.SetupSampleRequest"> & {@@ -61,6 +63,8 @@ export declare type SetupSampleRequest = Message<"bytebase.v1.SetupSampleRequestexport declare const SetupSampleRequestSchema: GenMessage<SetupSampleRequest>;/**+ * Request message for getting actuator information.+ ** @generated from message bytebase.v1.GetActuatorInfoRequest*/export declare type GetActuatorInfoRequest = Message<"bytebase.v1.GetActuatorInfoRequest"> & {@@ -73,6 +77,8 @@ export declare type GetActuatorInfoRequest = Message<"bytebase.v1.GetActuatorInfexport declare const GetActuatorInfoRequestSchema: GenMessage<GetActuatorInfoRequest>;/**+ * Request message for updating actuator information.+ ** @generated from message bytebase.v1.UpdateActuatorInfoRequest*/export declare type UpdateActuatorInfoRequest = Message<"bytebase.v1.UpdateActuatorInfoRequest"> & {@@ -106,6 +112,8 @@ export declare type UpdateActuatorInfoRequest = Message<"bytebase.v1.UpdateActuaexport declare const UpdateActuatorInfoRequestSchema: GenMessage<UpdateActuatorInfoRequest>;/**+ * Request message for deleting cache.+ ** @generated from message bytebase.v1.DeleteCacheRequest*/export declare type DeleteCacheRequest = Message<"bytebase.v1.DeleteCacheRequest"> & {@@ -118,150 +126,162 @@ export declare type DeleteCacheRequest = Message<"bytebase.v1.DeleteCacheRequestexport declare const DeleteCacheRequestSchema: GenMessage<DeleteCacheRequest>;/**- * ServerInfo is the API message for server info.+ * System information and configuration for the Bytebase instance.* Actuator concept is similar to the Spring Boot Actuator.** @generated from message bytebase.v1.ActuatorInfo*/export declare type ActuatorInfo = Message<"bytebase.v1.ActuatorInfo"> & {/**- * version is the bytebase's server version+ * The Bytebase server version.** @generated from field: string version = 1;*/version: string;/**- * git_commit is the git commit hash of the build+ * The git commit hash of the build.** @generated from field: string git_commit = 2;*/gitCommit: string;/**- * readonly flag means if the Bytebase is running in readonly mode.+ * Whether the Bytebase instance is running in read-only mode.** @generated from field: bool readonly = 3;*/readonly: boolean;/**- * saas flag means if the Bytebase is running in SaaS mode, some features are not allowed to edit by users.+ * Whether the Bytebase instance is running in SaaS mode where some features cannot be edited by users.** @generated from field: bool saas = 4;*/saas: boolean;/**- * demo flag means if the Bytebase is running in demo mode.+ * Whether the Bytebase instance is running in demo mode.** @generated from field: bool demo = 5;*/demo: boolean;/**- * host is the Bytebase instance host.+ * The host address of the Bytebase instance.** @generated from field: string host = 6;*/host: string;/**- * port is the Bytebase instance port.+ * The port number of the Bytebase instance.** @generated from field: string port = 7;*/port: string;/**- * external_url is the URL where user or webhook callback visits Bytebase.+ * The external URL where users or webhook callbacks access Bytebase.** @generated from field: string external_url = 8;*/externalUrl: string;/**- * need_admin_setup flag means the Bytebase instance doesn't have any end users.+ * Whether the Bytebase instance requires initial admin setup.** @generated from field: bool need_admin_setup = 9;*/needAdminSetup: boolean;/**- * disallow_signup is the flag to disable self-service signup.+ * Whether self-service user signup is disabled.** @generated from field: bool disallow_signup = 10;*/disallowSignup: boolean;/**- * last_active_time is the service last active time in UTC Time Format, any API calls will refresh this value.+ * The last time any API call was made, refreshed on each request.** @generated from field: google.protobuf.Timestamp last_active_time = 11;*/lastActiveTime?: Timestamp;/**- * require_2fa is the flag to require 2FA for all users.+ * Whether two-factor authentication is required for all users.** @generated from field: bool require_2fa = 12;*/require2fa: boolean;/**- * workspace_id is the identifier for the workspace.+ * The unique identifier for the workspace.** @generated from field: string workspace_id = 13;*/workspaceId: string;/**- * debug flag means if the debug mode is enabled.+ * Whether debug mode is enabled.** @generated from field: bool debug = 15;*/debug: boolean;/**+ * List of features that are not licensed.+ ** @generated from field: repeated string unlicensed_features = 19;*/unlicensedFeatures: string[];/**- * disallow_password_signin is the flag to disallow user signin with email&password. (except workspace admins)+ * Whether password-based signin is disabled (except for workspace admins).** @generated from field: bool disallow_password_signin = 20;*/disallowPasswordSignin: boolean;/**+ * Password complexity and restriction requirements.+ ** @generated from field: bytebase.v1.PasswordRestrictionSetting password_restriction = 21;*/passwordRestriction?: PasswordRestrictionSetting;/**- * docker flag means if the Bytebase instance is running in docker.+ * Whether the Bytebase instance is running in Docker.** @generated from field: bool docker = 22;*/docker: boolean;/**+ * Statistics about users in the system.+ ** @generated from field: repeated bytebase.v1.ActuatorInfo.StatUser user_stats = 23;*/userStats: ActuatorInfo_StatUser[];/**+ * The number of activated database instances.+ ** @generated from field: int32 activated_instance_count = 24;*/activatedInstanceCount: number;/**+ * The total number of database instances.+ ** @generated from field: int32 total_instance_count = 25;*/totalInstanceCount: number;/**+ * Whether sample data setup is enabled.+ ** @generated from field: bool enable_sample = 26;*/enableSample: boolean;@@ -274,20 +294,28 @@ export declare type ActuatorInfo = Message<"bytebase.v1.ActuatorInfo"> & {export declare const ActuatorInfoSchema: GenMessage<ActuatorInfo>;/**+ * User statistics by type and state.+ ** @generated from message bytebase.v1.ActuatorInfo.StatUser*/export declare type ActuatorInfo_StatUser = Message<"bytebase.v1.ActuatorInfo.StatUser"> & {/**+ * The type of user.+ ** @generated from field: bytebase.v1.UserType user_type = 1;*/userType: UserType;/**+ * The state of the user.+ ** @generated from field: bytebase.v1.State state = 2;*/state: State;/**+ * The count of users matching this type and state.+ ** @generated from field: int32 count = 3;*/count: number;@@ -300,10 +328,13 @@ export declare type ActuatorInfo_StatUser = Message<"bytebase.v1.ActuatorInfo.Stexport declare const ActuatorInfo_StatUserSchema: GenMessage<ActuatorInfo_StatUser>;/**+ * ActuatorService manages system health and operational information.+ ** @generated from service bytebase.v1.ActuatorService*/export declare const ActuatorService: GenService<{/**+ * Gets system information and health status of the Bytebase instance.* Permissions required: None** @generated from rpc bytebase.v1.ActuatorService.GetActuatorInfo@@ -314,6 +345,7 @@ export declare const ActuatorService: GenService<{output: typeof ActuatorInfoSchema;},/**+ * Updates system configuration settings for the Bytebase instance.* Permissions required: bb.settings.set** @generated from rpc bytebase.v1.ActuatorService.UpdateActuatorInfo@@ -324,6 +356,7 @@ export declare const ActuatorService: GenService<{output: typeof ActuatorInfoSchema;},/**+ * Sets up sample data for demonstration and testing purposes.* Permissions required: bb.projects.create** @generated from rpc bytebase.v1.ActuatorService.SetupSample@@ -334,6 +367,7 @@ export declare const ActuatorService: GenService<{output: typeof EmptySchema;},/**+ * Clears the system cache to force data refresh.* Permissions required: None** @generated from rpc bytebase.v1.ActuatorService.DeleteCache@@ -344,6 +378,7 @@ export declare const ActuatorService: GenService<{output: typeof EmptySchema;},/**+ * Gets custom branding resources such as logos.* Permissions required: None** @generated from rpc bytebase.v1.ActuatorService.GetResourcePackagediff --git a/frontend/src/types/proto-es/v1/actuator_service_pb.js b/frontend/src/types/proto-es/v1/actuator_service_pb.jsindex 6b3293f217..df75d75ab9 100644--- a/frontend/src/types/proto-es/v1/actuator_service_pb.js+++ b/frontend/src/types/proto-es/v1/actuator_service_pb.js@@ -75,6 +75,8 @@ export const ActuatorInfo_StatUserSchema = /*@__PURE__*/messageDesc(file_v1_actuator_service, 6, 0);/**+ * ActuatorService manages system health and operational information.+ ** @generated from service bytebase.v1.ActuatorService*/export const ActuatorService = /*@__PURE__*/diff --git a/frontend/src/types/proto-es/v1/annotation_pb.d.ts b/frontend/src/types/proto-es/v1/annotation_pb.d.tsindex 28caed83ad..860cd58f88 100644--- a/frontend/src/types/proto-es/v1/annotation_pb.d.ts+++ b/frontend/src/types/proto-es/v1/annotation_pb.d.ts@@ -11,23 +11,27 @@ import type { MethodOptions } from "@bufbuild/protobuf/wkt";export declare const file_v1_annotation: GenFile;/**+ * Authorization method for RPC calls.+ ** @generated from enum bytebase.v1.AuthMethod*/export enum AuthMethod {/**+ * Unspecified authorization method.+ ** @generated from enum value: AUTH_METHOD_UNSPECIFIED = 0;*/AUTH_METHOD_UNSPECIFIED = 0,/**- * IAM uses the standard IAM authorization check on the organizational resources.+ * Standard IAM authorization check on organizational resources.** @generated from enum value: IAM = 1;*/IAM = 1,/**- * Custom authorization method.+ * Custom authorization logic.** @generated from enum value: CUSTOM = 2;*/@@ -40,21 +44,29 @@ export enum AuthMethod {export declare const AuthMethodSchema: GenEnum<AuthMethod>;/**+ * Whether the method allows access without authentication credentials.+ ** @generated from extension: bool allow_without_credential = 100000;*/export declare const allow_without_credential: GenExtension<MethodOptions, boolean>;/**+ * The permission required to call this method.+ ** @generated from extension: string permission = 100001;*/export declare const permission: GenExtension<MethodOptions, string>;/**+ * The authorization method to use for this RPC.+ ** @generated from extension: bytebase.v1.AuthMethod auth_method = 100002;*/export declare const auth_method: GenExtension<MethodOptions, AuthMethod>;/**+ * Whether to audit calls to this method.+ ** @generated from extension: bool audit = 100003;*/export declare const audit: GenExtension<MethodOptions, boolean>;diff --git a/frontend/src/types/proto-es/v1/annotation_pb.js b/frontend/src/types/proto-es/v1/annotation_pb.jsindex 42a212894f..f4b8fe4728 100644--- a/frontend/src/types/proto-es/v1/annotation_pb.js+++ b/frontend/src/types/proto-es/v1/annotation_pb.js@@ -18,30 +18,40 @@ export const AuthMethodSchema = /*@__PURE__*/enumDesc(file_v1_annotation, 0);/**+ * Authorization method for RPC calls.+ ** @generated from enum bytebase.v1.AuthMethod*/export const AuthMethod = /*@__PURE__*/tsEnum(AuthMethodSchema);/**+ * Whether the method allows access without authentication credentials.+ ** @generated from extension: bool allow_without_credential = 100000;*/export const allow_without_credential = /*@__PURE__*/extDesc(file_v1_annotation, 0);/**+ * The permission required to call this method.+ ** @generated from extension: string permission = 100001;*/export const permission = /*@__PURE__*/extDesc(file_v1_annotation, 1);/**+ * The authorization method to use for this RPC.+ ** @generated from extension: bytebase.v1.AuthMethod auth_method = 100002;*/export const auth_method = /*@__PURE__*/extDesc(file_v1_annotation, 2);/**+ * Whether to audit calls to this method.+ ** @generated from extension: bool audit = 100003;*/export const audit = /*@__PURE__*/diff --git a/frontend/src/types/proto-es/v1/audit_log_service_pb.d.ts b/frontend/src/types/proto-es/v1/audit_log_service_pb.d.tsindex 52a81f8439..0951ebf08e 100644--- a/frontend/src/types/proto-es/v1/audit_log_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/audit_log_service_pb.d.ts@@ -15,6 +15,8 @@ import type { PolicyDelta } from "./iam_policy_pb";export declare const file_v1_audit_log_service: GenFile;/**+ * Request message for searching audit logs.+ ** @generated from message bytebase.v1.SearchAuditLogsRequest*/export declare type SearchAuditLogsRequest = Message<"bytebase.v1.SearchAuditLogsRequest"> & {@@ -80,6 +82,8 @@ export declare type SearchAuditLogsRequest = Message<"bytebase.v1.SearchAuditLogexport declare const SearchAuditLogsRequestSchema: GenMessage<SearchAuditLogsRequest>;/**+ * Response message for searching audit logs.+ ** @generated from message bytebase.v1.SearchAuditLogsResponse*/export declare type SearchAuditLogsResponse = Message<"bytebase.v1.SearchAuditLogsResponse"> & {@@ -105,6 +109,8 @@ export declare type SearchAuditLogsResponse = Message<"bytebase.v1.SearchAuditLoexport declare const SearchAuditLogsResponseSchema: GenMessage<SearchAuditLogsResponse>;/**+ * Request message for exporting audit logs.+ ** @generated from message bytebase.v1.ExportAuditLogsRequest*/export declare type ExportAuditLogsRequest = Message<"bytebase.v1.ExportAuditLogsRequest"> & {@@ -165,10 +171,14 @@ export declare type ExportAuditLogsRequest = Message<"bytebase.v1.ExportAuditLogexport declare const ExportAuditLogsRequestSchema: GenMessage<ExportAuditLogsRequest>;/**+ * Response message for exporting audit logs.+ ** @generated from message bytebase.v1.ExportAuditLogsResponse*/export declare type ExportAuditLogsResponse = Message<"bytebase.v1.ExportAuditLogsResponse"> & {/**+ * The exported audit log content in the requested format.+ ** @generated from field: bytes content = 1;*/content: Uint8Array;@@ -190,6 +200,8 @@ export declare type ExportAuditLogsResponse = Message<"bytebase.v1.ExportAuditLoexport declare const ExportAuditLogsResponseSchema: GenMessage<ExportAuditLogsResponse>;/**+ * Audit log entry recording system activity or API call.+ ** @generated from message bytebase.v1.AuditLog*/export declare type AuditLog = Message<"bytebase.v1.AuditLog"> & {@@ -204,72 +216,80 @@ export declare type AuditLog = Message<"bytebase.v1.AuditLog"> & {name: string;/**+ * The timestamp when the audit log was created.+ ** @generated from field: google.protobuf.Timestamp create_time = 2;*/createTime?: Timestamp;/**- * Format: users/[email protected]+ * The user who performed the action.+ * Format: users/{email}** @generated from field: string user = 3;*/user: string;/**- * e.g. `/bytebase.v1.SQLService/Query`, `bb.project.repository.push`+ * The method or action being audited.+ * For example: /bytebase.v1.SQLService/Query or bb.project.repository.push** @generated from field: string method = 4;*/method: string;/**+ * The severity level of this audit log entry.+ ** @generated from field: bytebase.v1.AuditLog.Severity severity = 5;*/severity: AuditLog_Severity;/**- * The associated resource.+ * The resource associated with this audit log.** @generated from field: string resource = 6;*/resource: string;/**- * JSON-encoded request.+ * The request payload in JSON format.** @generated from field: string request = 7;*/request: string;/**- * JSON-encoded response.- * Some fields are omitted because they are too large or contain sensitive information.+ * The response payload in JSON format.+ * Some fields may be omitted if they are too large or contain sensitive information.** @generated from field: string response = 8;*/response: string;/**+ * The status of the operation.+ ** @generated from field: google.rpc.Status status = 9;*/status?: Status;/**- * The latency of the RPC.+ * The duration of the operation.** @generated from field: google.protobuf.Duration latency = 10;*/latency?: Duration;/**- * service-specific data about the request, response, and other activities.+ * Service-specific metadata about the request, response, and activities.** @generated from field: google.protobuf.Any service_data = 11;*/serviceData?: Any;/**- * Metadata about the operation.+ * Metadata about the request context.** @generated from field: bytebase.v1.RequestMetadata request_metadata = 12;*/@@ -283,50 +303,70 @@ export declare type AuditLog = Message<"bytebase.v1.AuditLog"> & {export declare const AuditLogSchema: GenMessage<AuditLog>;/**+ * Severity level for audit log entries.+ ** @generated from enum bytebase.v1.AuditLog.Severity*/export enum AuditLog_Severity {/**+ * Default severity level.+ ** @generated from enum value: DEFAULT = 0;*/DEFAULT = 0,/**+ * Debug-level information.+ ** @generated from enum value: DEBUG = 1;*/DEBUG = 1,/**+ * Informational messages.+ ** @generated from enum value: INFO = 2;*/INFO = 2,/**+ * Notable events.+ ** @generated from enum value: NOTICE = 3;*/NOTICE = 3,/**+ * Warning conditions.+ ** @generated from enum value: WARNING = 4;*/WARNING = 4,/**+ * Error conditions.+ ** @generated from enum value: ERROR = 5;*/ERROR = 5,/**+ * Critical conditions.+ ** @generated from enum value: CRITICAL = 6;*/CRITICAL = 6,/**+ * Action must be taken immediately.+ ** @generated from enum value: ALERT = 7;*/ALERT = 7,/**+ * System is unusable.+ ** @generated from enum value: EMERGENCY = 8;*/EMERGENCY = 8,@@ -338,10 +378,14 @@ export enum AuditLog_Severity {export declare const AuditLog_SeveritySchema: GenEnum<AuditLog_Severity>;/**+ * Additional audit data specific to certain operations.+ ** @generated from message bytebase.v1.AuditData*/export declare type AuditData = Message<"bytebase.v1.AuditData"> & {/**+ * Changes to IAM policies.+ ** @generated from field: bytebase.v1.PolicyDelta policy_delta = 1;*/policyDelta?: PolicyDelta;@@ -354,21 +398,21 @@ export declare type AuditData = Message<"bytebase.v1.AuditData"> & {export declare const AuditDataSchema: GenMessage<AuditData>;/**- * Metadata about the request.+ * Metadata about the incoming request.** @generated from message bytebase.v1.RequestMetadata*/export declare type RequestMetadata = Message<"bytebase.v1.RequestMetadata"> & {/**- * The IP address of the caller.+ * The IP address of the request originator.** @generated from field: string caller_ip = 1;*/callerIp: string;/**- * The user agent of the caller.- * This information is not authenticated and should be treated accordingly.+ * The user agent string provided by the caller.+ * This is supplied by the client and is not authenticated.** @generated from field: string caller_supplied_user_agent = 2;*/@@ -382,11 +426,14 @@ export declare type RequestMetadata = Message<"bytebase.v1.RequestMetadata"> & {export declare const RequestMetadataSchema: GenMessage<RequestMetadata>;/**+ * AuditLogService manages audit logs for system activities and API calls.+ ** @generated from service bytebase.v1.AuditLogService*/export declare const AuditLogService: GenService<{/**- * Permissions required: None+ * Searches audit logs with optional filtering and pagination.+ * Permissions required: bb.auditLogs.search** @generated from rpc bytebase.v1.AuditLogService.SearchAuditLogs*/@@ -396,6 +443,7 @@ export declare const AuditLogService: GenService<{output: typeof SearchAuditLogsResponseSchema;},/**+ * Exports audit logs in a specified format for external analysis.* Permissions required: bb.auditLogs.export** @generated from rpc bytebase.v1.AuditLogService.ExportAuditLogsdiff --git a/frontend/src/types/proto-es/v1/audit_log_service_pb.js b/frontend/src/types/proto-es/v1/audit_log_service_pb.jsindex c05ef3ab54..ac2e98d674 100644--- a/frontend/src/types/proto-es/v1/audit_log_service_pb.js+++ b/frontend/src/types/proto-es/v1/audit_log_service_pb.js@@ -60,6 +60,8 @@ export const AuditLog_SeveritySchema = /*@__PURE__*/enumDesc(file_v1_audit_log_service, 4, 0);/**+ * Severity level for audit log entries.+ ** @generated from enum bytebase.v1.AuditLog.Severity*/export const AuditLog_Severity = /*@__PURE__*/@@ -80,6 +82,8 @@ export const RequestMetadataSchema = /*@__PURE__*/messageDesc(file_v1_audit_log_service, 6);/**+ * AuditLogService manages audit logs for system activities and API calls.+ ** @generated from service bytebase.v1.AuditLogService*/export const AuditLogService = /*@__PURE__*/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 d8846a9bf4..db55957c6c 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@@ -17,11 +17,15 @@ export declare const file_v1_auth_service: GenFile;*/export declare type LoginRequest = Message<"bytebase.v1.LoginRequest"> & {/**+ * User's email address.+ ** @generated from field: string email = 1;*/email: string;/**+ * User's password for authentication.+ ** @generated from field: string password = 2;*/password: string;@@ -77,6 +81,8 @@ export declare type LoginRequest = Message<"bytebase.v1.LoginRequest"> & {export declare const LoginRequestSchema: GenMessage<LoginRequest>;/**+ * Context for identity provider authentication.+ ** @generated from message bytebase.v1.IdentityProviderContext*/export declare type IdentityProviderContext = Message<"bytebase.v1.IdentityProviderContext"> & {@@ -85,12 +91,16 @@ export declare type IdentityProviderContext = Message<"bytebase.v1.IdentityProvi*/context: {/**+ * OAuth2 authentication context.+ ** @generated from field: bytebase.v1.OAuth2IdentityProviderContext oauth2_context = 1;*/value: OAuth2IdentityProviderContext;case: "oauth2Context";} | {/**+ * OpenID Connect authentication context.+ ** @generated from field: bytebase.v1.OIDCIdentityProviderContext oidc_context = 2;*/value: OIDCIdentityProviderContext;@@ -105,10 +115,14 @@ export declare type IdentityProviderContext = Message<"bytebase.v1.IdentityProviexport declare const IdentityProviderContextSchema: GenMessage<IdentityProviderContext>;/**+ * OAuth2 authentication context.+ ** @generated from message bytebase.v1.OAuth2IdentityProviderContext*/export declare type OAuth2IdentityProviderContext = Message<"bytebase.v1.OAuth2IdentityProviderContext"> & {/**+ * Authorization code from OAuth2 provider.+ ** @generated from field: string code = 1;*/code: string;@@ -121,6 +135,8 @@ export declare type OAuth2IdentityProviderContext = Message<"bytebase.v1.OAuth2Iexport declare const OAuth2IdentityProviderContextSchema: GenMessage<OAuth2IdentityProviderContext>;/**+ * OpenID Connect authentication context.+ ** @generated from message bytebase.v1.OIDCIdentityProviderContext*/export declare type OIDCIdentityProviderContext = Message<"bytebase.v1.OIDCIdentityProviderContext"> & {@@ -137,16 +153,22 @@ export declare const OIDCIdentityProviderContextSchema: GenMessage<OIDCIdentityP*/export declare type LoginResponse = Message<"bytebase.v1.LoginResponse"> & {/**+ * Access token for authenticated requests.+ ** @generated from field: string token = 1;*/token: string;/**+ * Temporary token for MFA verification.+ ** @generated from field: optional string mfa_temp_token = 2;*/mfaTempToken?: string;/**+ * Whether user must reset password before continuing.+ ** @generated from field: bool require_reset_password = 3;*/requireResetPassword: boolean;@@ -166,6 +188,8 @@ export declare type LoginResponse = Message<"bytebase.v1.LoginResponse"> & {export declare const LoginResponseSchema: GenMessage<LoginResponse>;/**+ * Request to logout current user session.+ ** @generated from message bytebase.v1.LogoutRequest*/export declare type LogoutRequest = Message<"bytebase.v1.LogoutRequest"> & {@@ -178,10 +202,13 @@ export declare type LogoutRequest = Message<"bytebase.v1.LogoutRequest"> & {export declare const LogoutRequestSchema: GenMessage<LogoutRequest>;/**+ * AuthService handles user authentication operations.+ ** @generated from service bytebase.v1.AuthService*/export declare const AuthService: GenService<{/**+ * Authenticates a user and returns access tokens.* Permissions required: None** @generated from rpc bytebase.v1.AuthService.Login@@ -192,6 +219,7 @@ export declare const AuthService: GenService<{output: typeof LoginResponseSchema;},/**+ * Logs out the current user session.* Permissions required: None** @generated from rpc bytebase.v1.AuthService.Logoutdiff --git a/frontend/src/types/proto-es/v1/auth_service_pb.js b/frontend/src/types/proto-es/v1/auth_service_pb.jsindex bc4960f0d1..8ff9e66294 100644--- a/frontend/src/types/proto-es/v1/auth_service_pb.js+++ b/frontend/src/types/proto-es/v1/auth_service_pb.js@@ -57,6 +57,8 @@ export const LogoutRequestSchema = /*@__PURE__*/messageDesc(file_v1_auth_service, 5);/**+ * AuthService handles user authentication operations.+ ** @generated from service bytebase.v1.AuthService*/export const AuthService = /*@__PURE__*/diff --git a/frontend/src/types/proto-es/v1/cel_service_pb.d.ts b/frontend/src/types/proto-es/v1/cel_service_pb.d.tsindex ec3b560ec4..8cbd84b82a 100644--- a/frontend/src/types/proto-es/v1/cel_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/cel_service_pb.d.ts@@ -12,10 +12,14 @@ import type { Expr } from "../google/api/expr/v1alpha1/syntax_pb";export declare const file_v1_cel_service: GenFile;/**+ * Request message for batch parsing CEL expressions.+ ** @generated from message bytebase.v1.BatchParseRequest*/export declare type BatchParseRequest = Message<"bytebase.v1.BatchParseRequest"> & {/**+ * The CEL expression strings to parse.+ ** @generated from field: repeated string expressions = 1;*/expressions: string[];@@ -28,10 +32,14 @@ export declare type BatchParseRequest = Message<"bytebase.v1.BatchParseRequest">export declare const BatchParseRequestSchema: GenMessage<BatchParseRequest>;/**+ * Response message for batch parsing CEL expressions.+ ** @generated from message bytebase.v1.BatchParseResponse*/export declare type BatchParseResponse = Message<"bytebase.v1.BatchParseResponse"> & {/**+ * The parsed CEL expressions as AST.+ ** @generated from field: repeated google.api.expr.v1alpha1.Expr expressions = 1;*/expressions: Expr[];@@ -44,10 +52,14 @@ export declare type BatchParseResponse = Message<"bytebase.v1.BatchParseResponseexport declare const BatchParseResponseSchema: GenMessage<BatchParseResponse>;/**+ * Request message for batch deparsing CEL expressions.+ ** @generated from message bytebase.v1.BatchDeparseRequest*/export declare type BatchDeparseRequest = Message<"bytebase.v1.BatchDeparseRequest"> & {/**+ * The CEL expression ASTs to deparse.+ ** @generated from field: repeated google.api.expr.v1alpha1.Expr expressions = 1;*/expressions: Expr[];@@ -60,10 +72,14 @@ export declare type BatchDeparseRequest = Message<"bytebase.v1.BatchDeparseRequeexport declare const BatchDeparseRequestSchema: GenMessage<BatchDeparseRequest>;/**+ * Response message for batch deparsing CEL expressions.+ ** @generated from message bytebase.v1.BatchDeparseResponse*/export declare type BatchDeparseResponse = Message<"bytebase.v1.BatchDeparseResponse"> & {/**+ * The deparsed CEL expressions as strings.+ ** @generated from field: repeated string expressions = 1;*/expressions: string[];@@ -76,10 +92,13 @@ export declare type BatchDeparseResponse = Message<"bytebase.v1.BatchDeparseRespexport declare const BatchDeparseResponseSchema: GenMessage<BatchDeparseResponse>;/**+ * CelService manages CEL (Common Expression Language) parsing and formatting operations.+ ** @generated from service bytebase.v1.CelService*/export declare const CelService: GenService<{/**+ * Parses multiple CEL expression strings into AST representations.* Permissions required: None** @generated from rpc bytebase.v1.CelService.BatchParse@@ -90,6 +109,7 @@ export declare const CelService: GenService<{output: typeof BatchParseResponseSchema;},/**+ * Converts multiple CEL AST representations back into expression strings.* Permissions required: None** @generated from rpc bytebase.v1.CelService.BatchDeparsediff --git a/frontend/src/types/proto-es/v1/cel_service_pb.js b/frontend/src/types/proto-es/v1/cel_service_pb.jsindex c570800347..05eb4418c5 100644--- a/frontend/src/types/proto-es/v1/cel_service_pb.js+++ b/frontend/src/types/proto-es/v1/cel_service_pb.js@@ -42,6 +42,8 @@ export const BatchDeparseResponseSchema = /*@__PURE__*/messageDesc(file_v1_cel_service, 3);/**+ * CelService manages CEL (Common Expression Language) parsing and formatting operations.+ ** @generated from service bytebase.v1.CelService*/export const CelService = /*@__PURE__*/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 8f65805822..adf2391ebe 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@@ -12,6 +12,8 @@ import type { EmptySchema, FieldMask, Timestamp } from "@bufbuild/protobuf/wkt";export declare const file_v1_changelist_service: GenFile;/**+ * Request message for creating a changelist.+ ** @generated from message bytebase.v1.CreateChangelistRequest*/export declare type CreateChangelistRequest = Message<"bytebase.v1.CreateChangelistRequest"> & {@@ -49,6 +51,8 @@ export declare type CreateChangelistRequest = Message<"bytebase.v1.CreateChangelexport declare const CreateChangelistRequestSchema: GenMessage<CreateChangelistRequest>;/**+ * Request message for getting a changelist.+ ** @generated from message bytebase.v1.GetChangelistRequest*/export declare type GetChangelistRequest = Message<"bytebase.v1.GetChangelistRequest"> & {@@ -68,6 +72,8 @@ export declare type GetChangelistRequest = Message<"bytebase.v1.GetChangelistReqexport declare const GetChangelistRequestSchema: GenMessage<GetChangelistRequest>;/**+ * Request message for listing changelists.+ ** @generated from message bytebase.v1.ListChangelistsRequest*/export declare type ListChangelistsRequest = Message<"bytebase.v1.ListChangelistsRequest"> & {@@ -80,7 +86,7 @@ export declare type ListChangelistsRequest = Message<"bytebase.v1.ListChangelistparent: string;/**- * Not used.+ * 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.@@ -91,7 +97,7 @@ export declare type ListChangelistsRequest = Message<"bytebase.v1.ListChangelistpageSize: number;/**- * Not used.+ * 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.*@@ -110,6 +116,8 @@ export declare type ListChangelistsRequest = Message<"bytebase.v1.ListChangelistexport declare const ListChangelistsRequestSchema: GenMessage<ListChangelistsRequest>;/**+ * Response message for listing changelists.+ ** @generated from message bytebase.v1.ListChangelistsResponse*/export declare type ListChangelistsResponse = Message<"bytebase.v1.ListChangelistsResponse"> & {@@ -136,6 +144,8 @@ export declare type ListChangelistsResponse = Message<"bytebase.v1.ListChangelisexport declare const ListChangelistsResponseSchema: GenMessage<ListChangelistsResponse>;/**+ * Request message for updating a changelist.+ ** @generated from message bytebase.v1.UpdateChangelistRequest*/export declare type UpdateChangelistRequest = Message<"bytebase.v1.UpdateChangelistRequest"> & {@@ -172,6 +182,8 @@ export declare type UpdateChangelistRequest = Message<"bytebase.v1.UpdateChangelexport declare const UpdateChangelistRequestSchema: GenMessage<UpdateChangelistRequest>;/**+ * Request message for deleting a changelist.+ ** @generated from message bytebase.v1.DeleteChangelistRequest*/export declare type DeleteChangelistRequest = Message<"bytebase.v1.DeleteChangelistRequest"> & {@@ -191,6 +203,8 @@ export declare type DeleteChangelistRequest = Message<"bytebase.v1.DeleteChangelexport declare const DeleteChangelistRequestSchema: GenMessage<DeleteChangelistRequest>;/**+ * A changelist groups multiple database changes together.+ ** @generated from message bytebase.v1.Changelist*/export declare type Changelist = Message<"bytebase.v1.Changelist"> & {@@ -204,6 +218,8 @@ export declare type Changelist = Message<"bytebase.v1.Changelist"> & {name: string;/**+ * The description of the changelist.+ ** @generated from field: string description = 2;*/description: string;@@ -217,13 +233,15 @@ export declare type Changelist = Message<"bytebase.v1.Changelist"> & {creator: string;/**- * The last update time of the changelist.+ * The last time the changelist was updated.** @generated from field: google.protobuf.Timestamp update_time = 6;*/updateTime?: Timestamp;/**+ * The list of changes in this changelist.+ ** @generated from field: repeated bytebase.v1.Changelist.Change changes = 7;*/changes: Changelist_Change[];@@ -236,20 +254,22 @@ export declare type Changelist = Message<"bytebase.v1.Changelist"> & {export declare const ChangelistSchema: GenMessage<Changelist>;/**+ * A single change in a changelist.+ ** @generated from message bytebase.v1.Changelist.Change*/export declare type Changelist_Change = Message<"bytebase.v1.Changelist.Change"> & {/**- * The name of a sheet.+ * The sheet containing the SQL statement.** @generated from field: string sheet = 1;*/sheet: string;/**- * The source of origin.- * 1) changelog: instances/{instance}/databases/{database}/changelogs/{changelog}.- * 2) raw SQL if empty.+ * The source of this change.+ * Format: instances/{instance}/databases/{database}/changelogs/{changelog}+ * If empty, the change is from raw SQL.** @generated from field: string source = 2;*/@@ -263,10 +283,13 @@ export declare type Changelist_Change = Message<"bytebase.v1.Changelist.Change">export declare const Changelist_ChangeSchema: GenMessage<Changelist_Change>;/**+ * ChangelistService manages changelists for grouping and organizing database changes.+ ** @generated from service bytebase.v1.ChangelistService*/export declare const ChangelistService: GenService<{/**+ * Creates a new changelist in a project.* Permissions required: bb.changelists.create** @generated from rpc bytebase.v1.ChangelistService.CreateChangelist@@ -277,6 +300,7 @@ export declare const ChangelistService: GenService<{output: typeof ChangelistSchema;},/**+ * Gets a changelist by name.* Permissions required: bb.changelists.get** @generated from rpc bytebase.v1.ChangelistService.GetChangelist@@ -287,6 +311,7 @@ export declare const ChangelistService: GenService<{output: typeof ChangelistSchema;},/**+ * Lists changelists in a project.* Permissions required: bb.changelists.list** @generated from rpc bytebase.v1.ChangelistService.ListChangelists@@ -297,6 +322,7 @@ export declare const ChangelistService: GenService<{output: typeof ListChangelistsResponseSchema;},/**+ * Updates a changelist.* Permissions required: bb.changelists.update** @generated from rpc bytebase.v1.ChangelistService.UpdateChangelist@@ -307,6 +333,7 @@ export declare const ChangelistService: GenService<{output: typeof ChangelistSchema;},/**+ * Deletes a changelist.* Permissions required: bb.changelists.delete** @generated from rpc bytebase.v1.ChangelistService.DeleteChangelistdiff --git a/frontend/src/types/proto-es/v1/changelist_service_pb.js b/frontend/src/types/proto-es/v1/changelist_service_pb.jsindex 7126da5b75..395d59843e 100644--- a/frontend/src/types/proto-es/v1/changelist_service_pb.js+++ b/frontend/src/types/proto-es/v1/changelist_service_pb.js@@ -73,6 +73,8 @@ export const Changelist_ChangeSchema = /*@__PURE__*/messageDesc(file_v1_changelist_service, 6, 0);/**+ * ChangelistService manages changelists for grouping and organizing database changes.+ ** @generated from service bytebase.v1.ChangelistService*/export const ChangelistService = /*@__PURE__*/diff --git a/frontend/src/types/proto-es/v1/common_pb.d.ts b/frontend/src/types/proto-es/v1/common_pb.d.tsindex f11779a071..ed0189267a 100644--- a/frontend/src/types/proto-es/v1/common_pb.d.ts+++ b/frontend/src/types/proto-es/v1/common_pb.d.ts@@ -39,15 +39,21 @@ export declare type Position = Message<"bytebase.v1.Position"> & {export declare const PositionSchema: GenMessage<Position>;/**+ * Range of positions in text or sequence.+ ** @generated from message bytebase.v1.Range*/export declare type Range = Message<"bytebase.v1.Range"> & {/**+ * Start position (inclusive).+ ** @generated from field: int32 start = 1;*/start: number;/**+ * End position (exclusive).+ ** @generated from field: int32 end = 2;*/end: number;@@ -60,6 +66,8 @@ export declare type Range = Message<"bytebase.v1.Range"> & {export declare const RangeSchema: GenMessage<Range>;/**+ * Resource lifecycle state.+ ** @generated from enum bytebase.v1.State*/export enum State {@@ -69,11 +77,15 @@ export enum State {STATE_UNSPECIFIED = 0,/**+ * Resource is active and operational.+ ** @generated from enum value: ACTIVE = 1;*/ACTIVE = 1,/**+ * Resource is soft-deleted but may be recoverable.+ ** @generated from enum value: DELETED = 2;*/DELETED = 2,@@ -85,135 +97,189 @@ export enum State {export declare const StateSchema: GenEnum<State>;/**+ * Database engine type.+ ** @generated from enum bytebase.v1.Engine*/export enum Engine {/**+ * Unspecified database engine.+ ** @generated from enum value: ENGINE_UNSPECIFIED = 0;*/ENGINE_UNSPECIFIED = 0,/**+ * ClickHouse columnar database.+ ** @generated from enum value: CLICKHOUSE = 1;*/CLICKHOUSE = 1,/**+ * MySQL relational database.+ ** @generated from enum value: MYSQL = 2;*/MYSQL = 2,/**+ * PostgreSQL relational database.+ ** @generated from enum value: POSTGRES = 3;*/POSTGRES = 3,/**+ * Snowflake cloud data warehouse.+ ** @generated from enum value: SNOWFLAKE = 4;*/SNOWFLAKE = 4,/**+ * SQLite embedded database.+ ** @generated from enum value: SQLITE = 5;*/SQLITE = 5,/**+ * TiDB distributed SQL database.+ ** @generated from enum value: TIDB = 6;*/TIDB = 6,/**+ * MongoDB document database.+ ** @generated from enum value: MONGODB = 7;*/MONGODB = 7,/**+ * Redis key-value store.+ ** @generated from enum value: REDIS = 8;*/REDIS = 8,/**+ * Oracle relational database.+ ** @generated from enum value: ORACLE = 9;*/ORACLE = 9,/**+ * Google Cloud Spanner distributed database.+ ** @generated from enum value: SPANNER = 10;*/SPANNER = 10,/**+ * Microsoft SQL Server relational database.+ ** @generated from enum value: MSSQL = 11;*/MSSQL = 11,/**+ * Amazon Redshift data warehouse.+ ** @generated from enum value: REDSHIFT = 12;*/REDSHIFT = 12,/**+ * MariaDB relational database.+ ** @generated from enum value: MARIADB = 13;*/MARIADB = 13,/**+ * OceanBase distributed database.+ ** @generated from enum value: OCEANBASE = 14;*/OCEANBASE = 14,/**+ * StarRocks analytics database.+ ** @generated from enum value: STARROCKS = 18;*/STARROCKS = 18,/**+ * Apache Doris analytics database.+ ** @generated from enum value: DORIS = 19;*/DORIS = 19,/**+ * Apache Hive data warehouse.+ ** @generated from enum value: HIVE = 20;*/HIVE = 20,/**+ * Elasticsearch search engine.+ ** @generated from enum value: ELASTICSEARCH = 21;*/ELASTICSEARCH = 21,/**+ * Google BigQuery data warehouse.+ ** @generated from enum value: BIGQUERY = 22;*/BIGQUERY = 22,/**+ * Amazon DynamoDB NoSQL database.+ ** @generated from enum value: DYNAMODB = 23;*/DYNAMODB = 23,/**+ * Databricks lakehouse platform.+ ** @generated from enum value: DATABRICKS = 24;*/DATABRICKS = 24,/**+ * CockroachDB distributed SQL database.+ ** @generated from enum value: COCKROACHDB = 25;*/COCKROACHDB = 25,/**+ * Azure Cosmos DB multi-model database.+ ** @generated from enum value: COSMOSDB = 26;*/COSMOSDB = 26,/**+ * Trino distributed SQL query engine.+ ** @generated from enum value: TRINO = 27;*/TRINO = 27,/**+ * Apache Cassandra NoSQL database.+ ** @generated from enum value: CASSANDRA = 28;*/CASSANDRA = 28,@@ -225,30 +291,42 @@ export enum Engine {export declare const EngineSchema: GenEnum<Engine>;/**+ * Version control system type.+ ** @generated from enum bytebase.v1.VCSType*/export enum VCSType {/**+ * Unspecified VCS type.+ ** @generated from enum value: VCS_TYPE_UNSPECIFIED = 0;*/VCS_TYPE_UNSPECIFIED = 0,/**+ * GitHub version control platform.+ ** @generated from enum value: GITHUB = 1;*/GITHUB = 1,/**+ * GitLab version control platform.+ ** @generated from enum value: GITLAB = 2;*/GITLAB = 2,/**+ * Bitbucket version control platform.+ ** @generated from enum value: BITBUCKET = 3;*/BITBUCKET = 3,/**+ * Azure DevOps version control platform.+ ** @generated from enum value: AZURE_DEVOPS = 4;*/AZURE_DEVOPS = 4,@@ -260,30 +338,42 @@ export enum VCSType {export declare const VCSTypeSchema: GenEnum<VCSType>;/**+ * Data export format.+ ** @generated from enum bytebase.v1.ExportFormat*/export enum ExportFormat {/**+ * Unspecified export format.+ ** @generated from enum value: FORMAT_UNSPECIFIED = 0;*/FORMAT_UNSPECIFIED = 0,/**+ * Comma-separated values format.+ ** @generated from enum value: CSV = 1;*/CSV = 1,/**+ * JavaScript Object Notation format.+ ** @generated from enum value: JSON = 2;*/JSON = 2,/**+ * SQL statements format.+ ** @generated from enum value: SQL = 3;*/SQL = 3,/**+ * Microsoft Excel spreadsheet format.+ ** @generated from enum value: XLSX = 4;*/XLSX = 4,@@ -370,21 +460,29 @@ export declare const MigrationTypeSchema: GenEnum<MigrationType>;*/export enum RiskLevel {/**+ * Unspecified risk level.+ ** @generated from enum value: RISK_LEVEL_UNSPECIFIED = 0;*/RISK_LEVEL_UNSPECIFIED = 0,/**+ * Low risk operation.+ ** @generated from enum value: LOW = 1;*/LOW = 1,/**+ * Moderate risk operation.+ ** @generated from enum value: MODERATE = 2;*/MODERATE = 2,/**+ * High risk operation.+ ** @generated from enum value: HIGH = 3;*/HIGH = 3,diff --git a/frontend/src/types/proto-es/v1/common_pb.js b/frontend/src/types/proto-es/v1/common_pb.jsindex 82faf87e14..bb0a83c1fc 100644--- a/frontend/src/types/proto-es/v1/common_pb.js+++ b/frontend/src/types/proto-es/v1/common_pb.js@@ -31,6 +31,8 @@ export const StateSchema = /*@__PURE__*/enumDesc(file_v1_common, 0);/**+ * Resource lifecycle state.+ ** @generated from enum bytebase.v1.State*/export const State = /*@__PURE__*/@@ -43,6 +45,8 @@ export const EngineSchema = /*@__PURE__*/enumDesc(file_v1_common, 1);/**+ * Database engine type.+ ** @generated from enum bytebase.v1.Engine*/export const Engine = /*@__PURE__*/@@ -55,6 +59,8 @@ export const VCSTypeSchema = /*@__PURE__*/enumDesc(file_v1_common, 2);/**+ * Version control system type.+ ** @generated from enum bytebase.v1.VCSType*/export const VCSType = /*@__PURE__*/@@ -67,6 +73,8 @@ export const ExportFormatSchema = /*@__PURE__*/enumDesc(file_v1_common, 3);/**+ * Data export format.+ ** @generated from enum bytebase.v1.ExportFormat*/export const ExportFormat = /*@__PURE__*/diff --git a/frontend/src/types/proto-es/v1/database_catalog_service_pb.d.ts b/frontend/src/types/proto-es/v1/database_catalog_service_pb.d.tsindex f339a8a6d1..0b6d8e1714 100644--- a/frontend/src/types/proto-es/v1/database_catalog_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/database_catalog_service_pb.d.ts@@ -11,6 +11,8 @@ import type { Message } from "@bufbuild/protobuf";export declare const file_v1_database_catalog_service: GenFile;/**+ * Request message for getting a database catalog.+ ** @generated from message bytebase.v1.GetDatabaseCatalogRequest*/export declare type GetDatabaseCatalogRequest = Message<"bytebase.v1.GetDatabaseCatalogRequest"> & {@@ -30,6 +32,8 @@ export declare type GetDatabaseCatalogRequest = Message<"bytebase.v1.GetDatabaseexport declare const GetDatabaseCatalogRequestSchema: GenMessage<GetDatabaseCatalogRequest>;/**+ * Request message for updating a database catalog.+ ** @generated from message bytebase.v1.UpdateDatabaseCatalogRequest*/export declare type UpdateDatabaseCatalogRequest = Message<"bytebase.v1.UpdateDatabaseCatalogRequest"> & {@@ -59,6 +63,8 @@ export declare type UpdateDatabaseCatalogRequest = Message<"bytebase.v1.UpdateDaexport declare const UpdateDatabaseCatalogRequestSchema: GenMessage<UpdateDatabaseCatalogRequest>;/**+ * Catalog metadata for a database including schemas, tables, and columns.+ ** @generated from message bytebase.v1.DatabaseCatalog*/export declare type DatabaseCatalog = Message<"bytebase.v1.DatabaseCatalog"> & {@@ -71,6 +77,8 @@ export declare type DatabaseCatalog = Message<"bytebase.v1.DatabaseCatalog"> & {name: string;/**+ * The schemas in the database.+ ** @generated from field: repeated bytebase.v1.SchemaCatalog schemas = 2;*/schemas: SchemaCatalog[];@@ -83,15 +91,21 @@ export declare type DatabaseCatalog = Message<"bytebase.v1.DatabaseCatalog"> & {export declare const DatabaseCatalogSchema: GenMessage<DatabaseCatalog>;/**+ * Schema metadata within a database.+ ** @generated from message bytebase.v1.SchemaCatalog*/export declare type SchemaCatalog = Message<"bytebase.v1.SchemaCatalog"> & {/**+ * The schema name.+ ** @generated from field: string name = 1;*/name: string;/**+ * The tables in the schema.+ ** @generated from field: repeated bytebase.v1.TableCatalog tables = 2;*/tables: TableCatalog[];@@ -104,10 +118,14 @@ export declare type SchemaCatalog = Message<"bytebase.v1.SchemaCatalog"> & {export declare const SchemaCatalogSchema: GenMessage<SchemaCatalog>;/**+ * Table metadata within a schema.+ ** @generated from message bytebase.v1.TableCatalog*/export declare type TableCatalog = Message<"bytebase.v1.TableCatalog"> & {/**+ * The table name.+ ** @generated from field: string name = 1;*/name: string;@@ -117,12 +135,16 @@ export declare type TableCatalog = Message<"bytebase.v1.TableCatalog"> & {*/kind: {/**+ * Regular table columns.+ ** @generated from field: bytebase.v1.TableCatalog.Columns columns = 2;*/value: TableCatalog_Columns;case: "columns";} | {/**+ * Object schema for JSON/XML columns.+ ** @generated from field: bytebase.v1.ObjectSchema object_schema = 3;*/value: ObjectSchema;@@ -130,6 +152,8 @@ export declare type TableCatalog = Message<"bytebase.v1.TableCatalog"> & {} | { case: undefined; value?: undefined };/**+ * The data classification level for this table.+ ** @generated from field: string classification = 4;*/classification: string;@@ -142,10 +166,14 @@ export declare type TableCatalog = Message<"bytebase.v1.TableCatalog"> & {export declare const TableCatalogSchema: GenMessage<TableCatalog>;/**+ * Column list for regular tables.+ ** @generated from message bytebase.v1.TableCatalog.Columns*/export declare type TableCatalog_Columns = Message<"bytebase.v1.TableCatalog.Columns"> & {/**+ * The columns in the table.+ ** @generated from field: repeated bytebase.v1.ColumnCatalog columns = 1;*/columns: ColumnCatalog[];@@ -158,32 +186,42 @@ export declare type TableCatalog_Columns = Message<"bytebase.v1.TableCatalog.Colexport declare const TableCatalog_ColumnsSchema: GenMessage<TableCatalog_Columns>;/**+ * Column metadata within a table.+ ** @generated from message bytebase.v1.ColumnCatalog*/export declare type ColumnCatalog = Message<"bytebase.v1.ColumnCatalog"> & {/**+ * The column name.+ ** @generated from field: string name = 1;*/name: string;/**+ * The semantic type describing the data purpose.+ ** @generated from field: string semantic_type = 2;*/semanticType: string;/**- * The user labels for a column.+ * User-defined labels for this column.** @generated from field: map<string, string> labels = 3;*/labels: { [key: string]: string };/**+ * The data classification level for this column.+ ** @generated from field: string classification = 4;*/classification: string;/**+ * Object schema for complex column types like JSON.+ ** @generated from field: optional bytebase.v1.ObjectSchema object_schema = 5;*/objectSchema?: ObjectSchema;@@ -196,10 +234,14 @@ export declare type ColumnCatalog = Message<"bytebase.v1.ColumnCatalog"> & {export declare const ColumnCatalogSchema: GenMessage<ColumnCatalog>;/**+ * Schema definition for object-type columns.+ ** @generated from message bytebase.v1.ObjectSchema*/export declare type ObjectSchema = Message<"bytebase.v1.ObjectSchema"> & {/**+ * The data type of this object.+ ** @generated from field: bytebase.v1.ObjectSchema.Type type = 1;*/type: ObjectSchema_Type;@@ -209,12 +251,16 @@ export declare type ObjectSchema = Message<"bytebase.v1.ObjectSchema"> & {*/kind: {/**+ * Struct schema.+ ** @generated from field: bytebase.v1.ObjectSchema.StructKind struct_kind = 2;*/value: ObjectSchema_StructKind;case: "structKind";} | {/**+ * Array schema.+ ** @generated from field: bytebase.v1.ObjectSchema.ArrayKind array_kind = 3;*/value: ObjectSchema_ArrayKind;@@ -222,6 +268,8 @@ export declare type ObjectSchema = Message<"bytebase.v1.ObjectSchema"> & {} | { case: undefined; value?: undefined };/**+ * The semantic type of this object.+ ** @generated from field: string semantic_type = 4;*/semanticType: string;@@ -234,10 +282,14 @@ export declare type ObjectSchema = Message<"bytebase.v1.ObjectSchema"> & {export declare const ObjectSchemaSchema: GenMessage<ObjectSchema>;/**+ * Structure type with named properties.+ ** @generated from message bytebase.v1.ObjectSchema.StructKind*/export declare type ObjectSchema_StructKind = Message<"bytebase.v1.ObjectSchema.StructKind"> & {/**+ * Properties of the struct.+ ** @generated from field: map<string, bytebase.v1.ObjectSchema> properties = 1;*/properties: { [key: string]: ObjectSchema };@@ -250,10 +302,14 @@ export declare type ObjectSchema_StructKind = Message<"bytebase.v1.ObjectSchema.export declare const ObjectSchema_StructKindSchema: GenMessage<ObjectSchema_StructKind>;/**+ * Array type with element schema.+ ** @generated from message bytebase.v1.ObjectSchema.ArrayKind*/export declare type ObjectSchema_ArrayKind = Message<"bytebase.v1.ObjectSchema.ArrayKind"> & {/**+ * The schema of array elements.+ ** @generated from field: bytebase.v1.ObjectSchema kind = 1;*/kind?: ObjectSchema;@@ -266,35 +322,49 @@ export declare type ObjectSchema_ArrayKind = Message<"bytebase.v1.ObjectSchema.Aexport declare const ObjectSchema_ArrayKindSchema: GenMessage<ObjectSchema_ArrayKind>;/**+ * Object schema data types.+ ** @generated from enum bytebase.v1.ObjectSchema.Type*/export enum ObjectSchema_Type {/**+ * Unspecified type.+ ** @generated from enum value: TYPE_UNSPECIFIED = 0;*/TYPE_UNSPECIFIED = 0,/**+ * String type.+ ** @generated from enum value: STRING = 1;*/STRING = 1,/**+ * Number type.+ ** @generated from enum value: NUMBER = 2;*/NUMBER = 2,/**+ * Boolean type.+ ** @generated from enum value: BOOLEAN = 3;*/BOOLEAN = 3,/**+ * Object/struct type.+ ** @generated from enum value: OBJECT = 4;*/OBJECT = 4,/**+ * Array type.+ ** @generated from enum value: ARRAY = 5;*/ARRAY = 5,@@ -306,10 +376,13 @@ export enum ObjectSchema_Type {export declare const ObjectSchema_TypeSchema: GenEnum<ObjectSchema_Type>;/**+ * DatabaseCatalogService manages database schema metadata and classification.+ ** @generated from service bytebase.v1.DatabaseCatalogService*/export declare const DatabaseCatalogService: GenService<{/**+ * Gets the catalog metadata for a database.* Permissions required: bb.databaseCatalogs.get** @generated from rpc bytebase.v1.DatabaseCatalogService.GetDatabaseCatalog@@ -320,6 +393,7 @@ export declare const DatabaseCatalogService: GenService<{output: typeof DatabaseCatalogSchema;},/**+ * Updates catalog metadata such as classifications and labels.* Permissions required: bb.databaseCatalogs.update** @generated from rpc bytebase.v1.DatabaseCatalogService.UpdateDatabaseCatalogdiff --git a/frontend/src/types/proto-es/v1/database_catalog_service_pb.js b/frontend/src/types/proto-es/v1/database_catalog_service_pb.jsindex 701a72afbc..b88afcee56 100644--- a/frontend/src/types/proto-es/v1/database_catalog_service_pb.js+++ b/frontend/src/types/proto-es/v1/database_catalog_service_pb.js@@ -92,12 +92,16 @@ export const ObjectSchema_TypeSchema = /*@__PURE__*/enumDesc(file_v1_database_catalog_service, 6, 0);/**+ * Object schema data types.+ ** @generated from enum bytebase.v1.ObjectSchema.Type*/export const ObjectSchema_Type = /*@__PURE__*/tsEnum(ObjectSchema_TypeSchema);/**+ * DatabaseCatalogService manages database schema metadata and classification.+ ** @generated from service bytebase.v1.DatabaseCatalogService*/export const DatabaseCatalogService = /*@__PURE__*/diff --git a/frontend/src/types/proto-es/v1/database_group_service_pb.d.ts b/frontend/src/types/proto-es/v1/database_group_service_pb.d.tsindex 8295fe6b6f..2763e13b9b 100644--- a/frontend/src/types/proto-es/v1/database_group_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/database_group_service_pb.d.ts@@ -13,6 +13,8 @@ import type { Expr } from "../google/type/expr_pb";export declare const file_v1_database_group_service: GenFile;/**+ * Request message for listing database groups.+ ** @generated from message bytebase.v1.ListDatabaseGroupsRequest*/export declare type ListDatabaseGroupsRequest = Message<"bytebase.v1.ListDatabaseGroupsRequest"> & {@@ -25,7 +27,7 @@ export declare type ListDatabaseGroupsRequest = Message<"bytebase.v1.ListDatabasparent: string;/**- * Not used.+ * Pagination is not currently implemented. This field is reserved for future use.* The maximum number of database groups to return. The service may return fewer than* this value.* If unspecified, at most 50 database groups will be returned.@@ -36,7 +38,7 @@ export declare type ListDatabaseGroupsRequest = Message<"bytebase.v1.ListDatabaspageSize: number;/**- * Not used.+ * Pagination is not currently implemented. This field is reserved for future use.* A page token, received from a previous `ListDatabaseGroups` call.* Provide this to retrieve the subsequent page.*@@ -62,18 +64,21 @@ export declare type ListDatabaseGroupsRequest = Message<"bytebase.v1.ListDatabasexport declare const ListDatabaseGroupsRequestSchema: GenMessage<ListDatabaseGroupsRequest>;/**+ * Response message for listing database groups.+ ** @generated from message bytebase.v1.ListDatabaseGroupsResponse*/export declare type ListDatabaseGroupsResponse = Message<"bytebase.v1.ListDatabaseGroupsResponse"> & {/**- * database_groups is the list of database groups.+ * The database groups from the specified request.** @generated from field: repeated bytebase.v1.DatabaseGroup database_groups = 1;*/databaseGroups: DatabaseGroup[];/**- * Not used. A token, which can be sent as `page_token` to retrieve the next page.+ * Pagination is not currently implemented. This field is reserved for future use.+ * A token, which can be sent as `page_token` to retrieve the next page.* If this field is omitted, there are no subsequent pages.** @generated from field: string next_page_token = 2;@@ -88,6 +93,8 @@ export declare type ListDatabaseGroupsResponse = Message<"bytebase.v1.ListDatabaexport declare const ListDatabaseGroupsResponseSchema: GenMessage<ListDatabaseGroupsResponse>;/**+ * Request message for getting a database group.+ ** @generated from message bytebase.v1.GetDatabaseGroupRequest*/export declare type GetDatabaseGroupRequest = Message<"bytebase.v1.GetDatabaseGroupRequest"> & {@@ -114,6 +121,8 @@ export declare type GetDatabaseGroupRequest = Message<"bytebase.v1.GetDatabaseGrexport declare const GetDatabaseGroupRequestSchema: GenMessage<GetDatabaseGroupRequest>;/**+ * Request message for creating a database group.+ ** @generated from message bytebase.v1.CreateDatabaseGroupRequest*/export declare type CreateDatabaseGroupRequest = Message<"bytebase.v1.CreateDatabaseGroupRequest"> & {@@ -158,6 +167,8 @@ export declare type CreateDatabaseGroupRequest = Message<"bytebase.v1.CreateDataexport declare const CreateDatabaseGroupRequestSchema: GenMessage<CreateDatabaseGroupRequest>;/**+ * Request message for updating a database group.+ ** @generated from message bytebase.v1.UpdateDatabaseGroupRequest*/export declare type UpdateDatabaseGroupRequest = Message<"bytebase.v1.UpdateDatabaseGroupRequest"> & {@@ -194,6 +205,8 @@ export declare type UpdateDatabaseGroupRequest = Message<"bytebase.v1.UpdateDataexport declare const UpdateDatabaseGroupRequestSchema: GenMessage<UpdateDatabaseGroupRequest>;/**+ * Request message for deleting a database group.+ ** @generated from message bytebase.v1.DeleteDatabaseGroupRequest*/export declare type DeleteDatabaseGroupRequest = Message<"bytebase.v1.DeleteDatabaseGroupRequest"> & {@@ -213,6 +226,8 @@ export declare type DeleteDatabaseGroupRequest = Message<"bytebase.v1.DeleteDataexport declare const DeleteDatabaseGroupRequestSchema: GenMessage<DeleteDatabaseGroupRequest>;/**+ * A group of databases matched by expressions.+ ** @generated from message bytebase.v1.DatabaseGroup*/export declare type DatabaseGroup = Message<"bytebase.v1.DatabaseGroup"> & {@@ -265,6 +280,8 @@ export declare type DatabaseGroup = Message<"bytebase.v1.DatabaseGroup"> & {export declare const DatabaseGroupSchema: GenMessage<DatabaseGroup>;/**+ * A database within a database group.+ ** @generated from message bytebase.v1.DatabaseGroup.Database*/export declare type DatabaseGroup_Database = Message<"bytebase.v1.DatabaseGroup.Database"> & {@@ -284,6 +301,8 @@ export declare type DatabaseGroup_Database = Message<"bytebase.v1.DatabaseGroup.export declare const DatabaseGroup_DatabaseSchema: GenMessage<DatabaseGroup_Database>;/**+ * View options for database group responses.+ ** @generated from enum bytebase.v1.DatabaseGroupView*/export enum DatabaseGroupView {@@ -316,10 +335,13 @@ export enum DatabaseGroupView {export declare const DatabaseGroupViewSchema: GenEnum<DatabaseGroupView>;/**+ * DatabaseGroupService manages database groups for organizing databases by criteria.+ ** @generated from service bytebase.v1.DatabaseGroupService*/export declare const DatabaseGroupService: GenService<{/**+ * Lists database groups in a project.* Permissions required: bb.projects.get** @generated from rpc bytebase.v1.DatabaseGroupService.ListDatabaseGroups@@ -330,6 +352,7 @@ export declare const DatabaseGroupService: GenService<{output: typeof ListDatabaseGroupsResponseSchema;},/**+ * Gets a database group by name.* Permissions required: bb.projects.get** @generated from rpc bytebase.v1.DatabaseGroupService.GetDatabaseGroup@@ -340,6 +363,7 @@ export declare const DatabaseGroupService: GenService<{output: typeof DatabaseGroupSchema;},/**+ * Creates a new database group.* Permissions required: bb.projects.update** @generated from rpc bytebase.v1.DatabaseGroupService.CreateDatabaseGroup@@ -350,6 +374,7 @@ export declare const DatabaseGroupService: GenService<{output: typeof DatabaseGroupSchema;},/**+ * Updates a database group.* Permissions required: bb.projects.update** @generated from rpc bytebase.v1.DatabaseGroupService.UpdateDatabaseGroup@@ -360,6 +385,7 @@ export declare const DatabaseGroupService: GenService<{output: typeof DatabaseGroupSchema;},/**+ * Deletes a database group.* Permissions required: bb.projects.update** @generated from rpc bytebase.v1.DatabaseGroupService.DeleteDatabaseGroupdiff --git a/frontend/src/types/proto-es/v1/database_group_service_pb.js b/frontend/src/types/proto-es/v1/database_group_service_pb.jsindex fddb8bb106..92b472b10d 100644--- a/frontend/src/types/proto-es/v1/database_group_service_pb.js+++ b/frontend/src/types/proto-es/v1/database_group_service_pb.js@@ -80,12 +80,16 @@ export const DatabaseGroupViewSchema = /*@__PURE__*/enumDesc(file_v1_database_group_service, 0);/**+ * View options for database group responses.+ ** @generated from enum bytebase.v1.DatabaseGroupView*/export const DatabaseGroupView = /*@__PURE__*/tsEnum(DatabaseGroupViewSchema);/**+ * DatabaseGroupService manages database groups for organizing databases by criteria.+ ** @generated from service bytebase.v1.DatabaseGroupService*/export const DatabaseGroupService = /*@__PURE__*/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 513b578ec3..10128c7194 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@@ -624,6 +624,8 @@ export declare type DatabaseMetadata = Message<"bytebase.v1.DatabaseMetadata"> &extensions: ExtensionMetadata[];/**+ * The owner of the database.+ ** @generated from field: string owner = 7;*/owner: string;@@ -723,6 +725,8 @@ export declare type SchemaMetadata = Message<"bytebase.v1.SchemaMetadata"> & {packages: PackageMetadata[];/**+ * The owner of the schema.+ ** @generated from field: string owner = 11;*/owner: string;@@ -735,16 +739,22 @@ export declare type SchemaMetadata = Message<"bytebase.v1.SchemaMetadata"> & {sequences: SequenceMetadata[];/**+ * The events is the list of scheduled events in a schema.+ ** @generated from field: repeated bytebase.v1.EventMetadata events = 14;*/events: EventMetadata[];/**+ * The enum_types is the list of user-defined enum types in a schema.+ ** @generated from field: repeated bytebase.v1.EnumTypeMetadata enum_types = 15;*/enumTypes: EnumTypeMetadata[];/**+ * Whether to skip this schema during schema dump operations.+ ** @generated from field: bool skip_dump = 16;*/skipDump: boolean;@@ -782,11 +792,15 @@ export declare type EnumTypeMetadata = Message<"bytebase.v1.EnumTypeMetadata"> &values: string[];/**+ * The comment describing the enum type.+ ** @generated from field: string comment = 3;*/comment: string;/**+ * Whether to skip this enum type during schema dump operations.+ ** @generated from field: bool skip_dump = 4;*/skipDump: boolean;@@ -824,16 +838,22 @@ export declare type EventMetadata = Message<"bytebase.v1.EventMetadata"> & {timeZone: string;/**+ * The SQL mode setting for the event.+ ** @generated from field: string sql_mode = 4;*/sqlMode: string;/**+ * The character set used by the client creating the event.+ ** @generated from field: string character_set_client = 5;*/characterSetClient: string;/**+ * The collation used for the connection when creating the event.+ ** @generated from field: string collation_connection = 6;*/collationConnection: string;@@ -934,11 +954,15 @@ export declare type SequenceMetadata = Message<"bytebase.v1.SequenceMetadata"> &ownerColumn: string;/**+ * The comment describing the sequence.+ ** @generated from field: string comment = 12;*/comment: string;/**+ * Whether to skip this sequence during schema dump operations.+ ** @generated from field: bool skip_dump = 13;*/skipDump: boolean;@@ -984,26 +1008,36 @@ export declare type TriggerMetadata = Message<"bytebase.v1.TriggerMetadata"> & {body: string;/**+ * The SQL mode setting for the trigger.+ ** @generated from field: string sql_mode = 6;*/sqlMode: string;/**+ * The character set used by the client creating the trigger.+ ** @generated from field: string character_set_client = 7;*/characterSetClient: string;/**+ * The collation used for the connection when creating the trigger.+ ** @generated from field: string collation_connection = 8;*/collationConnection: string;/**+ * The comment describing the trigger.+ ** @generated from field: string comment = 9;*/comment: string;/**+ * Whether to skip this trigger during schema dump operations.+ ** @generated from field: bool skip_dump = 10;*/skipDump: boolean;@@ -1174,6 +1208,8 @@ export declare type TableMetadata = Message<"bytebase.v1.TableMetadata"> & {checkConstraints: CheckConstraintMetadata[];/**+ * The owner of the table.+ ** @generated from field: string owner = 18;*/owner: string;@@ -1187,11 +1223,15 @@ export declare type TableMetadata = Message<"bytebase.v1.TableMetadata"> & {sortingKeys: string[];/**+ * The triggers is the list of triggers associated with the table.+ ** @generated from field: repeated bytebase.v1.TriggerMetadata triggers = 20;*/triggers: TriggerMetadata[];/**+ * Whether to skip this table during schema dump operations.+ ** @generated from field: bool skip_dump = 21;*/skipDump: boolean;@@ -3451,10 +3491,13 @@ export enum ChangelogView {export declare const ChangelogViewSchema: GenEnum<ChangelogView>;/**+ * DatabaseService manages databases and their schemas.+ ** @generated from service bytebase.v1.DatabaseService*/export declare const DatabaseService: GenService<{/**+ * Retrieves a database by name.* Permissions required: bb.databases.get** @generated from rpc bytebase.v1.DatabaseService.GetDatabase@@ -3465,6 +3508,7 @@ export declare const DatabaseService: GenService<{output: typeof DatabaseSchema$;},/**+ * Retrieves multiple databases by their names.* Permissions required: bb.databases.get** @generated from rpc bytebase.v1.DatabaseService.BatchGetDatabases@@ -3475,7 +3519,8 @@ export declare const DatabaseService: GenService<{output: typeof BatchGetDatabasesResponseSchema;},/**- * Permissions required: bb.databases.list+ * Lists databases in a project, instance, or workspace.+ * Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)** @generated from rpc bytebase.v1.DatabaseService.ListDatabases*/@@ -3485,6 +3530,7 @@ export declare const DatabaseService: GenService<{output: typeof ListDatabasesResponseSchema;},/**+ * Updates database properties such as labels and project assignment.* Permissions required: bb.databases.update** @generated from rpc bytebase.v1.DatabaseService.UpdateDatabase@@ -3495,6 +3541,7 @@ export declare const DatabaseService: GenService<{output: typeof DatabaseSchema$;},/**+ * Updates multiple databases in a single batch operation.* Permissions required: bb.databases.update** @generated from rpc bytebase.v1.DatabaseService.BatchUpdateDatabases@@ -3505,6 +3552,7 @@ export declare const DatabaseService: GenService<{output: typeof BatchUpdateDatabasesResponseSchema;},/**+ * Synchronizes database schema from the instance.* Permissions required: bb.databases.sync** @generated from rpc bytebase.v1.DatabaseService.SyncDatabase@@ -3515,6 +3563,7 @@ export declare const DatabaseService: GenService<{output: typeof SyncDatabaseResponseSchema;},/**+ * Synchronizes multiple databases in a single batch operation.* Permissions required: bb.databases.sync** @generated from rpc bytebase.v1.DatabaseService.BatchSyncDatabases@@ -3525,6 +3574,7 @@ export declare const DatabaseService: GenService<{output: typeof BatchSyncDatabasesResponseSchema;},/**+ * Retrieves database metadata including tables, columns, and indexes.* Permissions required: bb.databases.getSchema** @generated from rpc bytebase.v1.DatabaseService.GetDatabaseMetadata@@ -3535,6 +3585,7 @@ export declare const DatabaseService: GenService<{output: typeof DatabaseMetadataSchema;},/**+ * Retrieves database schema as DDL statements.* Permissions required: bb.databases.getSchema** @generated from rpc bytebase.v1.DatabaseService.GetDatabaseSchema@@ -3545,6 +3596,7 @@ export declare const DatabaseService: GenService<{output: typeof DatabaseSchemaSchema;},/**+ * Compares and generates migration statements between two schemas.* Permissions required: bb.databases.get** @generated from rpc bytebase.v1.DatabaseService.DiffSchema@@ -3555,6 +3607,7 @@ export declare const DatabaseService: GenService<{output: typeof DiffSchemaResponseSchema;},/**+ * Lists migration history for a database.* Permissions required: bb.changelogs.list** @generated from rpc bytebase.v1.DatabaseService.ListChangelogs@@ -3565,7 +3618,8 @@ export declare const DatabaseService: GenService<{output: typeof ListChangelogsResponseSchema;},/**- * Permissions required: changelogs.get+ * Retrieves a specific changelog entry.+ * Permissions required: bb.changelogs.get** @generated from rpc bytebase.v1.DatabaseService.GetChangelog*/@@ -3575,7 +3629,8 @@ export declare const DatabaseService: GenService<{output: typeof ChangelogSchema;},/**- * Permissions required: databases.getSchema+ * Generates schema DDL for a database object.+ * Permissions required: bb.databases.getSchema** @generated from rpc bytebase.v1.DatabaseService.GetSchemaString*/diff --git a/frontend/src/types/proto-es/v1/database_service_pb.js b/frontend/src/types/proto-es/v1/database_service_pb.jsindex 4e0f6498bd..e318450828 100644--- a/frontend/src/types/proto-es/v1/database_service_pb.js+++ b/frontend/src/types/proto-es/v1/database_service_pb.js@@ -595,6 +595,8 @@ export const ChangelogView = /*@__PURE__*/tsEnum(ChangelogViewSchema);/**+ * DatabaseService manages databases and their schemas.+ ** @generated from service bytebase.v1.DatabaseService*/export const DatabaseService = /*@__PURE__*/diff --git a/frontend/src/types/proto-es/v1/group_service_pb.d.ts b/frontend/src/types/proto-es/v1/group_service_pb.d.tsindex b702c23a5f..ac17737629 100644--- a/frontend/src/types/proto-es/v1/group_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/group_service_pb.d.ts@@ -12,6 +12,8 @@ import type { EmptySchema, FieldMask } from "@bufbuild/protobuf/wkt";export declare const file_v1_group_service: GenFile;/**+ * Request message for getting a group.+ ** @generated from message bytebase.v1.GetGroupRequest*/export declare type GetGroupRequest = Message<"bytebase.v1.GetGroupRequest"> & {@@ -31,6 +33,8 @@ export declare type GetGroupRequest = Message<"bytebase.v1.GetGroupRequest"> & {export declare const GetGroupRequestSchema: GenMessage<GetGroupRequest>;/**+ * Request message for batch getting groups.+ ** @generated from message bytebase.v1.BatchGetGroupsRequest*/export declare type BatchGetGroupsRequest = Message<"bytebase.v1.BatchGetGroupsRequest"> & {@@ -50,6 +54,8 @@ export declare type BatchGetGroupsRequest = Message<"bytebase.v1.BatchGetGroupsRexport declare const BatchGetGroupsRequestSchema: GenMessage<BatchGetGroupsRequest>;/**+ * Response message for batch getting groups.+ ** @generated from message bytebase.v1.BatchGetGroupsResponse*/export declare type BatchGetGroupsResponse = Message<"bytebase.v1.BatchGetGroupsResponse"> & {@@ -68,6 +74,8 @@ export declare type BatchGetGroupsResponse = Message<"bytebase.v1.BatchGetGroupsexport declare const BatchGetGroupsResponseSchema: GenMessage<BatchGetGroupsResponse>;/**+ * Request message for listing groups.+ ** @generated from message bytebase.v1.ListGroupsRequest*/export declare type ListGroupsRequest = Message<"bytebase.v1.ListGroupsRequest"> & {@@ -122,6 +130,8 @@ export declare type ListGroupsRequest = Message<"bytebase.v1.ListGroupsRequest">export declare const ListGroupsRequestSchema: GenMessage<ListGroupsRequest>;/**+ * Response message for listing groups.+ ** @generated from message bytebase.v1.ListGroupsResponse*/export declare type ListGroupsResponse = Message<"bytebase.v1.ListGroupsResponse"> & {@@ -148,6 +158,8 @@ export declare type ListGroupsResponse = Message<"bytebase.v1.ListGroupsResponseexport declare const ListGroupsResponseSchema: GenMessage<ListGroupsResponse>;/**+ * Request message for creating a group.+ ** @generated from message bytebase.v1.CreateGroupRequest*/export declare type CreateGroupRequest = Message<"bytebase.v1.CreateGroupRequest"> & {@@ -174,6 +186,8 @@ export declare type CreateGroupRequest = Message<"bytebase.v1.CreateGroupRequestexport declare const CreateGroupRequestSchema: GenMessage<CreateGroupRequest>;/**+ * Request message for updating a group.+ ** @generated from message bytebase.v1.UpdateGroupRequest*/export declare type UpdateGroupRequest = Message<"bytebase.v1.UpdateGroupRequest"> & {@@ -210,6 +224,8 @@ export declare type UpdateGroupRequest = Message<"bytebase.v1.UpdateGroupRequestexport declare const UpdateGroupRequestSchema: GenMessage<UpdateGroupRequest>;/**+ * Request message for deleting a group.+ ** @generated from message bytebase.v1.DeleteGroupRequest*/export declare type DeleteGroupRequest = Message<"bytebase.v1.DeleteGroupRequest"> & {@@ -229,6 +245,8 @@ export declare type DeleteGroupRequest = Message<"bytebase.v1.DeleteGroupRequestexport declare const DeleteGroupRequestSchema: GenMessage<DeleteGroupRequest>;/**+ * A member of a group with a role.+ ** @generated from message bytebase.v1.GroupMember*/export declare type GroupMember = Message<"bytebase.v1.GroupMember"> & {@@ -242,6 +260,8 @@ export declare type GroupMember = Message<"bytebase.v1.GroupMember"> & {member: string;/**+ * The member's role in the group.+ ** @generated from field: bytebase.v1.GroupMember.Role role = 2;*/role: GroupMember_Role;@@ -254,20 +274,28 @@ export declare type GroupMember = Message<"bytebase.v1.GroupMember"> & {export declare const GroupMemberSchema: GenMessage<GroupMember>;/**+ * The role of a group member.+ ** @generated from enum bytebase.v1.GroupMember.Role*/export enum GroupMember_Role {/**+ * Unspecified role.+ ** @generated from enum value: ROLE_UNSPECIFIED = 0;*/ROLE_UNSPECIFIED = 0,/**+ * Group owner.+ ** @generated from enum value: OWNER = 1;*/OWNER = 1,/**+ * Group member.+ ** @generated from enum value: MEMBER = 2;*/MEMBER = 2,@@ -279,6 +307,8 @@ export enum GroupMember_Role {export declare const GroupMember_RoleSchema: GenEnum<GroupMember_Role>;/**+ * A group of users within the workspace.+ ** @generated from message bytebase.v1.Group*/export declare type Group = Message<"bytebase.v1.Group"> & {@@ -291,22 +321,28 @@ export declare type Group = Message<"bytebase.v1.Group"> & {name: string;/**+ * The display title of the group.+ ** @generated from field: string title = 2;*/title: string;/**+ * The description of the group.+ ** @generated from field: string description = 3;*/description: string;/**+ * The members of the group.+ ** @generated from field: repeated bytebase.v1.GroupMember members = 5;*/members: GroupMember[];/**- * source means where the group comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID.+ * The source system where the group originated (e.g., Entra ID for SCIM sync).** @generated from field: string source = 7;*/@@ -320,10 +356,13 @@ export declare type Group = Message<"bytebase.v1.Group"> & {export declare const GroupSchema: GenMessage<Group>;/**+ * GroupService manages user groups for organizing users and permissions.+ ** @generated from service bytebase.v1.GroupService*/export declare const GroupService: GenService<{/**+ * Gets a group by name.* Permissions required: bb.groups.get** @generated from rpc bytebase.v1.GroupService.GetGroup@@ -334,7 +373,7 @@ export declare const GroupService: GenService<{output: typeof GroupSchema;},/**- * Get the groups in batch.+ * Gets multiple groups in a single request.* Permissions required: bb.groups.get** @generated from rpc bytebase.v1.GroupService.BatchGetGroups@@ -345,6 +384,7 @@ export declare const GroupService: GenService<{output: typeof BatchGetGroupsResponseSchema;},/**+ * Lists all groups in the workspace.* Permissions required: bb.groups.list** @generated from rpc bytebase.v1.GroupService.ListGroups@@ -355,6 +395,7 @@ export declare const GroupService: GenService<{output: typeof ListGroupsResponseSchema;},/**+ * Creates a new group.* Permissions required: bb.groups.create** @generated from rpc bytebase.v1.GroupService.CreateGroup@@ -365,9 +406,8 @@ export declare const GroupService: GenService<{output: typeof GroupSchema;},/**- * UpdateGroup updates the group.- * Users with "bb.groups.update" permission on the workspace or the group owner can access this method.- * Permissions required: bb.groups.update+ * Updates a group. Group owners or users with bb.groups.update permission can update.+ * Permissions required: bb.groups.update OR caller is group owner** @generated from rpc bytebase.v1.GroupService.UpdateGroup*/@@ -377,7 +417,8 @@ export declare const GroupService: GenService<{output: typeof GroupSchema;},/**- * Permissions required: bb.groups.delete+ * Deletes a group. Group owners or users with bb.groups.delete permission can delete.+ * Permissions required: bb.groups.delete OR caller is group owner** @generated from rpc bytebase.v1.GroupService.DeleteGroup*/diff --git a/frontend/src/types/proto-es/v1/group_service_pb.js b/frontend/src/types/proto-es/v1/group_service_pb.jsindex 09829471f6..9223638e48 100644--- a/frontend/src/types/proto-es/v1/group_service_pb.js+++ b/frontend/src/types/proto-es/v1/group_service_pb.js@@ -86,6 +86,8 @@ export const GroupMember_RoleSchema = /*@__PURE__*/enumDesc(file_v1_group_service, 8, 0);/**+ * The role of a group member.+ ** @generated from enum bytebase.v1.GroupMember.Role*/export const GroupMember_Role = /*@__PURE__*/@@ -99,6 +101,8 @@ export const GroupSchema = /*@__PURE__*/messageDesc(file_v1_group_service, 9);/**+ * GroupService manages user groups for organizing users and permissions.+ ** @generated from service bytebase.v1.GroupService*/export const GroupService = /*@__PURE__*/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 71e2b82bc8..9d1f559e7c 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@@ -13,6 +13,8 @@ import type { Expr as Expr$1 } from "../google/api/expr/v1alpha1/syntax_pb";export declare const file_v1_iam_policy: GenFile;/**+ * Request message for getting an IAM policy.+ ** @generated from message bytebase.v1.GetIamPolicyRequest*/export declare type GetIamPolicyRequest = Message<"bytebase.v1.GetIamPolicyRequest"> & {@@ -33,6 +35,8 @@ export declare type GetIamPolicyRequest = Message<"bytebase.v1.GetIamPolicyRequeexport declare const GetIamPolicyRequestSchema: GenMessage<GetIamPolicyRequest>;/**+ * Request message for setting an IAM policy.+ ** @generated from message bytebase.v1.SetIamPolicyRequest*/export declare type SetIamPolicyRequest = Message<"bytebase.v1.SetIamPolicyRequest"> & {@@ -65,6 +69,8 @@ export declare type SetIamPolicyRequest = Message<"bytebase.v1.SetIamPolicyRequeexport declare const SetIamPolicyRequestSchema: GenMessage<SetIamPolicyRequest>;/**+ * IAM policy that binds members to roles.+ ** @generated from message bytebase.v1.IamPolicy*/export declare type IamPolicy = Message<"bytebase.v1.IamPolicy"> & {@@ -93,6 +99,8 @@ export declare type IamPolicy = Message<"bytebase.v1.IamPolicy"> & {export declare const IamPolicySchema: GenMessage<IamPolicy>;/**+ * Binding associates members with a role and optional conditions.+ ** @generated from message bytebase.v1.Binding*/export declare type Binding = Message<"bytebase.v1.Binding"> & {@@ -149,7 +157,7 @@ export declare type Binding = Message<"bytebase.v1.Binding"> & {export declare const BindingSchema: GenMessage<Binding>;/**- * The difference delta between two policies.+ * Describes changes between two IAM policies.** @generated from message bytebase.v1.PolicyDelta*/@@ -169,8 +177,7 @@ export declare type PolicyDelta = Message<"bytebase.v1.PolicyDelta"> & {export declare const PolicyDeltaSchema: GenMessage<PolicyDelta>;/**- * One delta entry for Binding. Each individual change (only one member in each- * entry) to a binding will be a separate entry.+ * A single change to a binding.** @generated from message bytebase.v1.BindingDelta*/@@ -212,22 +219,28 @@ export declare type BindingDelta = Message<"bytebase.v1.BindingDelta"> & {export declare const BindingDeltaSchema: GenMessage<BindingDelta>;/**- * The type of action performed on a Binding in a policy.+ * Type of action performed on a binding.** @generated from enum bytebase.v1.BindingDelta.Action*/export enum BindingDelta_Action {/**+ * Unspecified action.+ ** @generated from enum value: ACTION_UNSPECIFIED = 0;*/ACTION_UNSPECIFIED = 0,/**+ * Add a binding.+ ** @generated from enum value: ADD = 1;*/ADD = 1,/**+ * Remove a binding.+ ** @generated from enum value: REMOVE = 2;*/REMOVE = 2,diff --git a/frontend/src/types/proto-es/v1/iam_policy_pb.js b/frontend/src/types/proto-es/v1/iam_policy_pb.jsindex 3c3681e1c6..1b1d8e8626 100644--- a/frontend/src/types/proto-es/v1/iam_policy_pb.js+++ b/frontend/src/types/proto-es/v1/iam_policy_pb.js@@ -63,7 +63,7 @@ export const BindingDelta_ActionSchema = /*@__PURE__*/enumDesc(file_v1_iam_policy, 5, 0);/**- * The type of action performed on a Binding in a policy.+ * Type of action performed on a binding.** @generated from enum bytebase.v1.BindingDelta.Action*/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 586cf9307e..fe4cc089ca 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@@ -16,6 +16,9 @@ export declare const file_v1_idp_service: GenFile;*/export declare type GetIdentityProviderRequest = Message<"bytebase.v1.GetIdentityProviderRequest"> & {/**+ * The name of the identity provider to retrieve.+ * Format: idps/{idp}+ ** @generated from field: string name = 1;*/name: string;@@ -32,7 +35,7 @@ export declare const GetIdentityProviderRequestSchema: GenMessage<GetIdentityPro*/export declare type ListIdentityProvidersRequest = Message<"bytebase.v1.ListIdentityProvidersRequest"> & {/**- * Not used.+ * Pagination is not currently implemented. This field is reserved for future use.* The maximum number of identity providers to return. The service may return fewer than* this value.* If unspecified, at most 10 will be returned.@@ -43,7 +46,7 @@ export declare type ListIdentityProvidersRequest = Message<"bytebase.v1.ListIdenpageSize: number;/**- * Not used.+ * Pagination is not currently implemented. This field is reserved for future use.* A page token, received from a previous `ListIdentityProviders` call.* Provide this to retrieve the subsequent page.*@@ -263,21 +266,29 @@ export declare type IdentityProvider = Message<"bytebase.v1.IdentityProvider"> &name: string;/**+ * The display title of the identity provider.+ ** @generated from field: string title = 4;*/title: string;/**+ * The domain for email matching when using this identity provider.+ ** @generated from field: string domain = 5;*/domain: string;/**+ * The type of identity provider protocol.+ ** @generated from field: bytebase.v1.IdentityProviderType type = 6;*/type: IdentityProviderType;/**+ * The configuration details for the identity provider.+ ** @generated from field: bytebase.v1.IdentityProviderConfig config = 7;*/config?: IdentityProviderConfig;@@ -298,18 +309,24 @@ export declare type IdentityProviderConfig = Message<"bytebase.v1.IdentityProvid*/config: {/**+ * OAuth2 protocol configuration.+ ** @generated from field: bytebase.v1.OAuth2IdentityProviderConfig oauth2_config = 1;*/value: OAuth2IdentityProviderConfig;case: "oauth2Config";} | {/**+ * OIDC protocol configuration.+ ** @generated from field: bytebase.v1.OIDCIdentityProviderConfig oidc_config = 2;*/value: OIDCIdentityProviderConfig;case: "oidcConfig";} | {/**+ * LDAP protocol configuration.+ ** @generated from field: bytebase.v1.LDAPIdentityProviderConfig ldap_config = 3;*/value: LDAPIdentityProviderConfig;@@ -330,46 +347,64 @@ export declare const IdentityProviderConfigSchema: GenMessage<IdentityProviderCo*/export declare type OAuth2IdentityProviderConfig = Message<"bytebase.v1.OAuth2IdentityProviderConfig"> & {/**+ * The authorization endpoint URL for OAuth2 flow.+ ** @generated from field: string auth_url = 1;*/authUrl: string;/**+ * The token endpoint URL for exchanging authorization code.+ ** @generated from field: string token_url = 2;*/tokenUrl: string;/**+ * The user information endpoint URL.+ ** @generated from field: string user_info_url = 3;*/userInfoUrl: string;/**+ * The OAuth2 client identifier.+ ** @generated from field: string client_id = 4;*/clientId: string;/**+ * The OAuth2 client secret for authentication.+ ** @generated from field: string client_secret = 5;*/clientSecret: string;/**+ * The list of OAuth2 scopes to request.+ ** @generated from field: repeated string scopes = 6;*/scopes: string[];/**+ * Mapping configuration for user attributes from OAuth2 response.+ ** @generated from field: bytebase.v1.FieldMapping field_mapping = 7;*/fieldMapping?: FieldMapping;/**+ * Whether to skip TLS certificate verification.+ ** @generated from field: bool skip_tls_verify = 8;*/skipTlsVerify: boolean;/**+ * The authentication style for client credentials.+ ** @generated from field: bytebase.v1.OAuth2AuthStyle auth_style = 9;*/authStyle: OAuth2AuthStyle;@@ -388,16 +423,22 @@ export declare const OAuth2IdentityProviderConfigSchema: GenMessage<OAuth2Identi*/export declare type OIDCIdentityProviderConfig = Message<"bytebase.v1.OIDCIdentityProviderConfig"> & {/**+ * The OIDC issuer URL for the identity provider.+ ** @generated from field: string issuer = 1;*/issuer: string;/**+ * The OIDC client identifier.+ ** @generated from field: string client_id = 2;*/clientId: string;/**+ * The OIDC client secret for authentication.+ ** @generated from field: string client_secret = 3;*/clientSecret: string;@@ -411,16 +452,22 @@ export declare type OIDCIdentityProviderConfig = Message<"bytebase.v1.OIDCIdentiscopes: string[];/**+ * Mapping configuration for user attributes from OIDC claims.+ ** @generated from field: bytebase.v1.FieldMapping field_mapping = 5;*/fieldMapping?: FieldMapping;/**+ * Whether to skip TLS certificate verification.+ ** @generated from field: bool skip_tls_verify = 6;*/skipTlsVerify: boolean;/**+ * The authentication style for client credentials.+ ** @generated from field: bytebase.v1.OAuth2AuthStyle auth_style = 7;*/authStyle: OAuth2AuthStyle;@@ -600,21 +647,29 @@ export declare const FieldMappingSchema: GenMessage<FieldMapping>;*/export enum IdentityProviderType {/**+ * Unspecified identity provider type.+ ** @generated from enum value: IDENTITY_PROVIDER_TYPE_UNSPECIFIED = 0;*/IDENTITY_PROVIDER_TYPE_UNSPECIFIED = 0,/**+ * OAuth 2.0 authentication protocol.+ ** @generated from enum value: OAUTH2 = 1;*/OAUTH2 = 1,/**+ * OpenID Connect authentication protocol.+ ** @generated from enum value: OIDC = 2;*/OIDC = 2,/**+ * LDAP directory service authentication.+ ** @generated from enum value: LDAP = 3;*/LDAP = 3,@@ -657,10 +712,13 @@ export enum OAuth2AuthStyle {export declare const OAuth2AuthStyleSchema: GenEnum<OAuth2AuthStyle>;/**+ * IdentityProviderService manages external identity providers for SSO authentication.+ ** @generated from service bytebase.v1.IdentityProviderService*/export declare const IdentityProviderService: GenService<{/**+ * Gets an identity provider by name.* Permissions required: bb.identityProviders.get** @generated from rpc bytebase.v1.IdentityProviderService.GetIdentityProvider@@ -671,6 +729,7 @@ export declare const IdentityProviderService: GenService<{output: typeof IdentityProviderSchema;},/**+ * Lists all configured identity providers (public endpoint for login page).* Permissions required: None** @generated from rpc bytebase.v1.IdentityProviderService.ListIdentityProviders@@ -681,6 +740,7 @@ export declare const IdentityProviderService: GenService<{output: typeof ListIdentityProvidersResponseSchema;},/**+ * Creates a new identity provider.* Permissions required: bb.identityProviders.create** @generated from rpc bytebase.v1.IdentityProviderService.CreateIdentityProvider@@ -691,6 +751,7 @@ export declare const IdentityProviderService: GenService<{output: typeof IdentityProviderSchema;},/**+ * Updates an identity provider.* Permissions required: bb.identityProviders.update** @generated from rpc bytebase.v1.IdentityProviderService.UpdateIdentityProvider@@ -701,6 +762,7 @@ export declare const IdentityProviderService: GenService<{output: typeof IdentityProviderSchema;},/**+ * Deletes an identity provider.* Permissions required: bb.identityProviders.delete** @generated from rpc bytebase.v1.IdentityProviderService.DeleteIdentityProvider@@ -711,6 +773,7 @@ export declare const IdentityProviderService: GenService<{output: typeof EmptySchema;},/**+ * Tests the connection and configuration of an identity provider.* Permissions required: bb.identityProviders.update** @generated from rpc bytebase.v1.IdentityProviderService.TestIdentityProviderdiff --git a/frontend/src/types/proto-es/v1/idp_service_pb.js b/frontend/src/types/proto-es/v1/idp_service_pb.jsindex 70e357239b..883da02832 100644--- a/frontend/src/types/proto-es/v1/idp_service_pb.js+++ b/frontend/src/types/proto-es/v1/idp_service_pb.js@@ -158,6 +158,8 @@ export const OAuth2AuthStyle = /*@__PURE__*/tsEnum(OAuth2AuthStyleSchema);/**+ * IdentityProviderService manages external identity providers for SSO authentication.+ ** @generated from service bytebase.v1.IdentityProviderService*/export const IdentityProviderService = /*@__PURE__*/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 426b7e789c..80df4e137b 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@@ -165,10 +165,13 @@ export declare type InstanceRole = Message<"bytebase.v1.InstanceRole"> & {export declare const InstanceRoleSchema: GenMessage<InstanceRole>;/**+ * InstanceRoleService manages database roles within instances.+ ** @generated from service bytebase.v1.InstanceRoleService*/export declare const InstanceRoleService: GenService<{/**+ * Gets a database role from an instance.* Permissions required: bb.instanceRoles.get** @generated from rpc bytebase.v1.InstanceRoleService.GetInstanceRole@@ -179,6 +182,7 @@ export declare const InstanceRoleService: GenService<{output: typeof InstanceRoleSchema;},/**+ * Lists all database roles in an instance.* Permissions required: bb.instanceRoles.list** @generated from rpc bytebase.v1.InstanceRoleService.ListInstanceRolesdiff --git a/frontend/src/types/proto-es/v1/instance_role_service_pb.js b/frontend/src/types/proto-es/v1/instance_role_service_pb.jsindex 809cfeecdb..5e2f55f1ac 100644--- a/frontend/src/types/proto-es/v1/instance_role_service_pb.js+++ b/frontend/src/types/proto-es/v1/instance_role_service_pb.js@@ -44,6 +44,8 @@ export const InstanceRoleSchema = /*@__PURE__*/messageDesc(file_v1_instance_role_service, 3);/**+ * InstanceRoleService manages database roles within instances.+ ** @generated from service bytebase.v1.InstanceRoleService*/export const InstanceRoleService = /*@__PURE__*/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 2419decf1a..fe0d644571 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@@ -541,31 +541,43 @@ export declare type Instance = Message<"bytebase.v1.Instance"> & {name: string;/**+ * The lifecycle state of the instance.+ ** @generated from field: bytebase.v1.State state = 3;*/state: State;/**+ * The display title of the instance.+ ** @generated from field: string title = 4;*/title: string;/**+ * The database engine type.+ ** @generated from field: bytebase.v1.Engine engine = 5;*/engine: Engine;/**+ * The version of the database engine.+ ** @generated from field: string engine_version = 6;*/engineVersion: string;/**+ * External URL to the database instance console.+ ** @generated from field: string external_link = 7;*/externalLink: string;/**+ * Data source configurations for connecting to the instance.+ ** @generated from field: repeated bytebase.v1.DataSource data_sources = 8;*/dataSources: DataSource[];@@ -579,11 +591,15 @@ export declare type Instance = Message<"bytebase.v1.Instance"> & {environment?: string;/**+ * Whether the instance is activated for use.+ ** @generated from field: bool activation = 10;*/activation: boolean;/**+ * Database roles available in this instance.+ ** @generated from field: repeated bytebase.v1.InstanceRole roles = 12;*/roles: InstanceRole[];@@ -638,16 +654,22 @@ export declare const InstanceSchema: GenMessage<Instance>;*/export declare type DataSourceExternalSecret = Message<"bytebase.v1.DataSourceExternalSecret"> & {/**+ * The type of external secret store.+ ** @generated from field: bytebase.v1.DataSourceExternalSecret.SecretType secret_type = 1;*/secretType: DataSourceExternalSecret_SecretType;/**+ * The URL of the external secret store.+ ** @generated from field: string url = 2;*/url: string;/**+ * The authentication method for accessing the secret store.+ ** @generated from field: bytebase.v1.DataSourceExternalSecret.AuthType auth_type = 3;*/authType: DataSourceExternalSecret_AuthType;@@ -657,12 +679,16 @@ export declare type DataSourceExternalSecret = Message<"bytebase.v1.DataSourceEx*/authOption: {/**+ * AppRole authentication configuration.+ ** @generated from field: bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption app_role = 4;*/value: DataSourceExternalSecret_AppRoleAuthOption;case: "appRole";} | {/**+ * Token for direct authentication.+ ** @generated from field: string token = 5;*/value: string;@@ -702,6 +728,8 @@ export declare const DataSourceExternalSecretSchema: GenMessage<DataSourceExtern*/export declare type DataSourceExternalSecret_AppRoleAuthOption = Message<"bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption"> & {/**+ * The role ID for Vault AppRole authentication.+ ** @generated from field: string role_id = 1;*/roleId: string;@@ -714,6 +742,8 @@ export declare type DataSourceExternalSecret_AppRoleAuthOption = Message<"bytebasecretId: string;/**+ * The type of secret for AppRole authentication.+ ** @generated from field: bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption.SecretType type = 3;*/type: DataSourceExternalSecret_AppRoleAuthOption_SecretType;@@ -737,16 +767,22 @@ export declare const DataSourceExternalSecret_AppRoleAuthOptionSchema: GenMessag*/export enum DataSourceExternalSecret_AppRoleAuthOption_SecretType {/**+ * Unspecified secret type.+ ** @generated from enum value: SECRET_TYPE_UNSPECIFIED = 0;*/SECRET_TYPE_UNSPECIFIED = 0,/**+ * Plain text secret.+ ** @generated from enum value: PLAIN = 1;*/PLAIN = 1,/**+ * Secret from environment variable.+ ** @generated from enum value: ENVIRONMENT = 2;*/ENVIRONMENT = 2,@@ -762,6 +798,8 @@ export declare const DataSourceExternalSecret_AppRoleAuthOption_SecretTypeSchema*/export enum DataSourceExternalSecret_SecretType {/**+ * Unspecified secret type.+ ** @generated from enum value: SAECRET_TYPE_UNSPECIFIED = 0;*/SAECRET_TYPE_UNSPECIFIED = 0,@@ -798,6 +836,8 @@ export declare const DataSourceExternalSecret_SecretTypeSchema: GenEnum<DataSour*/export enum DataSourceExternalSecret_AuthType {/**+ * Unspecified authentication type.+ ** @generated from enum value: AUTH_TYPE_UNSPECIFIED = 0;*/AUTH_TYPE_UNSPECIFIED = 0,@@ -827,21 +867,29 @@ export declare const DataSourceExternalSecret_AuthTypeSchema: GenEnum<DataSource*/export declare type DataSource = Message<"bytebase.v1.DataSource"> & {/**+ * The unique identifier for this data source.+ ** @generated from field: string id = 1;*/id: string;/**+ * The type of data source (ADMIN or READ_ONLY).+ ** @generated from field: bytebase.v1.DataSourceType type = 2;*/type: DataSourceType;/**+ * The username for database authentication.+ ** @generated from field: string username = 3;*/username: string;/**+ * The password for database authentication.+ ** @generated from field: string password = 4;*/password: string;@@ -854,16 +902,22 @@ export declare type DataSource = Message<"bytebase.v1.DataSource"> & {useSsl: boolean;/**+ * The SSL certificate authority certificate.+ ** @generated from field: string ssl_ca = 5;*/sslCa: string;/**+ * The SSL client certificate.+ ** @generated from field: string ssl_cert = 6;*/sslCert: string;/**+ * The SSL client private key.+ ** @generated from field: string ssl_key = 7;*/sslKey: string;@@ -880,16 +934,22 @@ export declare type DataSource = Message<"bytebase.v1.DataSource"> & {verifyTlsCertificate: boolean;/**+ * The hostname or IP address of the database server.+ ** @generated from field: string host = 8;*/host: string;/**+ * The port number of the database server.+ ** @generated from field: string port = 9;*/port: string;/**+ * The name of the database to connect to.+ ** @generated from field: string database = 10;*/database: string;@@ -1262,26 +1322,36 @@ export declare const DataSource_RedisTypeSchema: GenEnum<DataSource_RedisType>;*/export declare type InstanceResource = Message<"bytebase.v1.InstanceResource"> & {/**+ * The display title of the instance.+ ** @generated from field: string title = 1;*/title: string;/**+ * The database engine type.+ ** @generated from field: bytebase.v1.Engine engine = 2;*/engine: Engine;/**+ * The version of the database engine.+ ** @generated from field: string engine_version = 3;*/engineVersion: string;/**+ * Data source configurations for the instance.+ ** @generated from field: repeated bytebase.v1.DataSource data_sources = 4;*/dataSources: DataSource[];/**+ * Whether the instance is activated.+ ** @generated from field: bool activation = 5;*/activation: boolean;@@ -1318,6 +1388,8 @@ export declare type SASLConfig = Message<"bytebase.v1.SASLConfig"> & {*/mechanism: {/**+ * Kerberos authentication configuration.+ ** @generated from field: bytebase.v1.KerberosConfig krb_config = 1;*/value: KerberosConfig;@@ -1336,36 +1408,50 @@ export declare const SASLConfigSchema: GenMessage<SASLConfig>;*/export declare type KerberosConfig = Message<"bytebase.v1.KerberosConfig"> & {/**+ * The primary component of the Kerberos principal.+ ** @generated from field: string primary = 1;*/primary: string;/**+ * The instance component of the Kerberos principal.+ ** @generated from field: string instance = 2;*/instance: string;/**+ * The Kerberos realm.+ ** @generated from field: string realm = 3;*/realm: string;/**+ * The keytab file contents for authentication.+ ** @generated from field: bytes keytab = 4;*/keytab: Uint8Array;/**+ * The hostname of the Key Distribution Center (KDC).+ ** @generated from field: string kdc_host = 5;*/kdcHost: string;/**+ * The port of the Key Distribution Center (KDC).+ ** @generated from field: string kdc_port = 6;*/kdcPort: string;/**+ * The transport protocol for KDC communication (tcp or udp).+ ** @generated from field: string kdc_transport_protocol = 7;*/kdcTransportProtocol: string;@@ -1382,16 +1468,22 @@ export declare const KerberosConfigSchema: GenMessage<KerberosConfig>;*/export enum DataSourceType {/**+ * Unspecified data source type.+ ** @generated from enum value: DATA_SOURCE_UNSPECIFIED = 0;*/DATA_SOURCE_UNSPECIFIED = 0,/**+ * Admin data source with write permissions.+ ** @generated from enum value: ADMIN = 1;*/ADMIN = 1,/**+ * Read-only data source for query operations.+ ** @generated from enum value: READ_ONLY = 2;*/READ_ONLY = 2,@@ -1403,10 +1495,13 @@ export enum DataSourceType {export declare const DataSourceTypeSchema: GenEnum<DataSourceType>;/**+ * InstanceService manages database instances and their connections.+ ** @generated from service bytebase.v1.InstanceService*/export declare const InstanceService: GenService<{/**+ * Gets a database instance by name.* Permissions required: bb.instances.get** @generated from rpc bytebase.v1.InstanceService.GetInstance@@ -1417,6 +1512,7 @@ export declare const InstanceService: GenService<{output: typeof InstanceSchema;},/**+ * Lists all database instances.* Permissions required: bb.instances.list** @generated from rpc bytebase.v1.InstanceService.ListInstances@@ -1427,6 +1523,7 @@ export declare const InstanceService: GenService<{output: typeof ListInstancesResponseSchema;},/**+ * Creates a new database instance.* Permissions required: bb.instances.create** @generated from rpc bytebase.v1.InstanceService.CreateInstance@@ -1437,6 +1534,7 @@ export declare const InstanceService: GenService<{output: typeof InstanceSchema;},/**+ * Updates a database instance.* Permissions required: bb.instances.update** @generated from rpc bytebase.v1.InstanceService.UpdateInstance@@ -1447,6 +1545,7 @@ export declare const InstanceService: GenService<{output: typeof InstanceSchema;},/**+ * Deletes or soft-deletes a database instance.* Permissions required: bb.instances.delete** @generated from rpc bytebase.v1.InstanceService.DeleteInstance@@ -1457,6 +1556,7 @@ export declare const InstanceService: GenService<{output: typeof EmptySchema;},/**+ * Restores a soft-deleted database instance.* Permissions required: bb.instances.undelete** @generated from rpc bytebase.v1.InstanceService.UndeleteInstance@@ -1467,6 +1567,7 @@ export declare const InstanceService: GenService<{output: typeof InstanceSchema;},/**+ * Syncs database schemas and metadata from an instance.* Permissions required: bb.instances.sync** @generated from rpc bytebase.v1.InstanceService.SyncInstance@@ -1477,6 +1578,7 @@ export declare const InstanceService: GenService<{output: typeof SyncInstanceResponseSchema;},/**+ * Lists all databases within an instance without creating them.* Permissions required: bb.instances.get** @generated from rpc bytebase.v1.InstanceService.ListInstanceDatabase@@ -1487,6 +1589,7 @@ export declare const InstanceService: GenService<{output: typeof ListInstanceDatabaseResponseSchema;},/**+ * Syncs multiple instances in a single request.* Permissions required: bb.instances.sync** @generated from rpc bytebase.v1.InstanceService.BatchSyncInstances@@ -1497,6 +1600,7 @@ export declare const InstanceService: GenService<{output: typeof BatchSyncInstancesResponseSchema;},/**+ * Updates multiple instances in a single request.* Permissions required: bb.instances.update** @generated from rpc bytebase.v1.InstanceService.BatchUpdateInstances@@ -1507,6 +1611,7 @@ export declare const InstanceService: GenService<{output: typeof BatchUpdateInstancesResponseSchema;},/**+ * Adds a read-only data source to an instance.* Permissions required: bb.instances.update** @generated from rpc bytebase.v1.InstanceService.AddDataSource@@ -1517,6 +1622,7 @@ export declare const InstanceService: GenService<{output: typeof InstanceSchema;},/**+ * Removes a read-only data source from an instance.* Permissions required: bb.instances.update** @generated from rpc bytebase.v1.InstanceService.RemoveDataSource@@ -1527,6 +1633,7 @@ export declare const InstanceService: GenService<{output: typeof InstanceSchema;},/**+ * Updates a data source configuration.* Permissions required: bb.instances.update** @generated from rpc bytebase.v1.InstanceService.UpdateDataSourcediff --git a/frontend/src/types/proto-es/v1/instance_service_pb.js b/frontend/src/types/proto-es/v1/instance_service_pb.jsindex 349f6c6c4b..254203aab6 100644--- a/frontend/src/types/proto-es/v1/instance_service_pb.js+++ b/frontend/src/types/proto-es/v1/instance_service_pb.js@@ -294,6 +294,8 @@ export const DataSourceType = /*@__PURE__*/tsEnum(DataSourceTypeSchema);/**+ * InstanceService manages database instances and their connections.+ ** @generated from service bytebase.v1.InstanceService*/export const InstanceService = /*@__PURE__*/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 1a13539569..0ecc6ef804 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@@ -26,6 +26,8 @@ export declare type GetIssueRequest = Message<"bytebase.v1.GetIssueRequest"> & {name: string;/**+ * If set to true, bypass cache and fetch the latest data.+ ** @generated from field: bool force = 2;*/force: boolean;@@ -310,6 +312,8 @@ export declare type BatchUpdateIssuesStatusRequest = Message<"bytebase.v1.BatchUstatus: IssueStatus;/**+ * The reason for the status change.+ ** @generated from field: string reason = 4;*/reason: string;@@ -346,6 +350,8 @@ export declare type ApproveIssueRequest = Message<"bytebase.v1.ApproveIssueRequename: string;/**+ * The comment explaining the approval decision.+ ** @generated from field: string comment = 2;*/comment: string;@@ -370,6 +376,8 @@ export declare type RejectIssueRequest = Message<"bytebase.v1.RejectIssueRequestname: string;/**+ * The comment explaining the rejection decision.+ ** @generated from field: string comment = 2;*/comment: string;@@ -394,6 +402,8 @@ export declare type RequestIssueRequest = Message<"bytebase.v1.RequestIssueRequename: string;/**+ * The comment explaining the request.+ ** @generated from field: string comment = 2;*/comment: string;@@ -418,11 +428,15 @@ export declare type Issue = Message<"bytebase.v1.Issue"> & {name: string;/**+ * The title of the issue.+ ** @generated from field: string title = 3;*/title: string;/**+ * The description of the issue.+ ** @generated from field: string description = 4;*/description: string;@@ -433,6 +447,8 @@ export declare type Issue = Message<"bytebase.v1.Issue"> & {type: Issue_Type;/**+ * The status of the issue.+ ** @generated from field: bytebase.v1.IssueStatus status = 6;*/status: IssueStatus;@@ -443,6 +459,8 @@ export declare type Issue = Message<"bytebase.v1.Issue"> & {approvers: Issue_Approver[];/**+ * The approval template for the issue.+ ** @generated from field: bytebase.v1.ApprovalTemplate approval_template = 10;*/approvalTemplate?: ApprovalTemplate;@@ -504,6 +522,8 @@ export declare type Issue = Message<"bytebase.v1.Issue"> & {releasers: string[];/**+ * The risk level of the issue.+ ** @generated from field: bytebase.v1.RiskLevel risk_level = 21;*/riskLevel: RiskLevel;@@ -524,6 +544,8 @@ export declare type Issue = Message<"bytebase.v1.Issue"> & {taskStatusCount: { [key: string]: number };/**+ * Labels attached to the issue for categorization and filtering.+ ** @generated from field: repeated string labels = 23;*/labels: string[];@@ -548,6 +570,8 @@ export declare type Issue = Message<"bytebase.v1.Issue"> & {export declare const IssueSchema: GenMessage<Issue>;/**+ * Approvers and their approval status for the issue.+ ** @generated from message bytebase.v1.Issue.Approver*/export declare type Issue_Approver = Message<"bytebase.v1.Issue.Approver"> & {@@ -573,25 +597,35 @@ export declare type Issue_Approver = Message<"bytebase.v1.Issue.Approver"> & {export declare const Issue_ApproverSchema: GenMessage<Issue_Approver>;/**+ * The approval status of an approver.+ ** @generated from enum bytebase.v1.Issue.Approver.Status*/export enum Issue_Approver_Status {/**+ * Unspecified status.+ ** @generated from enum value: STATUS_UNSPECIFIED = 0;*/STATUS_UNSPECIFIED = 0,/**+ * Awaiting approval.+ ** @generated from enum value: PENDING = 1;*/PENDING = 1,/**+ * Approved.+ ** @generated from enum value: APPROVED = 2;*/APPROVED = 2,/**+ * Rejected.+ ** @generated from enum value: REJECTED = 3;*/REJECTED = 3,@@ -603,25 +637,35 @@ export enum Issue_Approver_Status {export declare const Issue_Approver_StatusSchema: GenEnum<Issue_Approver_Status>;/**+ * The type of issue.+ ** @generated from enum bytebase.v1.Issue.Type*/export enum Issue_Type {/**+ * Unspecified issue type.+ ** @generated from enum value: TYPE_UNSPECIFIED = 0;*/TYPE_UNSPECIFIED = 0,/**+ * Database schema or data change.+ ** @generated from enum value: DATABASE_CHANGE = 1;*/DATABASE_CHANGE = 1,/**+ * Database access grant request.+ ** @generated from enum value: GRANT_REQUEST = 2;*/GRANT_REQUEST = 2,/**+ * Database data export request.+ ** @generated from enum value: DATABASE_EXPORT = 3;*/DATABASE_EXPORT = 3,@@ -633,40 +677,56 @@ export enum Issue_Type {export declare const Issue_TypeSchema: GenEnum<Issue_Type>;/**+ * The overall approval status for the issue.+ ** @generated from enum bytebase.v1.Issue.ApprovalStatus*/export enum Issue_ApprovalStatus {/**+ * Unspecified approval status.+ ** @generated from enum value: APPROVAL_STATUS_UNSPECIFIED = 0;*/APPROVAL_STATUS_UNSPECIFIED = 0,/**+ * Approval checks are being evaluated.+ ** @generated from enum value: CHECKING = 1;*/CHECKING = 1,/**+ * Approval is pending.+ ** @generated from enum value: PENDING = 2;*/PENDING = 2,/**+ * Issue has been approved.+ ** @generated from enum value: APPROVED = 3;*/APPROVED = 3,/**+ * Issue has been rejected.+ ** @generated from enum value: REJECTED = 4;*/REJECTED = 4,/**+ * Approval was skipped.+ ** @generated from enum value: SKIPPED = 5;*/SKIPPED = 5,/**+ * Error occurred during approval evaluation.+ ** @generated from enum value: ERROR = 6;*/ERROR = 6,@@ -705,6 +765,8 @@ export declare type GrantRequest = Message<"bytebase.v1.GrantRequest"> & {condition?: Expr;/**+ * The duration for which the grant is valid.+ ** @generated from field: google.protobuf.Duration expiration = 4;*/expiration?: Duration;@@ -730,16 +792,22 @@ export declare type ApprovalTemplate = Message<"bytebase.v1.ApprovalTemplate"> &id: string;/**+ * The approval flow definition.+ ** @generated from field: bytebase.v1.ApprovalFlow flow = 1;*/flow?: ApprovalFlow;/**+ * The title of the approval template.+ ** @generated from field: string title = 2;*/title: string;/**+ * The description of the approval template.+ ** @generated from field: string description = 3;*/description: string;@@ -756,6 +824,8 @@ export declare const ApprovalTemplateSchema: GenMessage<ApprovalTemplate>;*/export declare type ApprovalFlow = Message<"bytebase.v1.ApprovalFlow"> & {/**+ * The roles required for approval in order.+ ** @generated from field: repeated string roles = 1;*/roles: string[];@@ -811,6 +881,8 @@ export declare const ListIssueCommentsRequestSchema: GenMessage<ListIssueComment*/export declare type ListIssueCommentsResponse = Message<"bytebase.v1.ListIssueCommentsResponse"> & {/**+ * The issue comments from the specified request.+ ** @generated from field: repeated bytebase.v1.IssueComment issue_comments = 1;*/issueComments: IssueComment[];@@ -843,6 +915,8 @@ export declare type CreateIssueCommentRequest = Message<"bytebase.v1.CreateIssueparent: string;/**+ * The comment to create.+ ** @generated from field: bytebase.v1.IssueComment issue_comment = 2;*/issueComment?: IssueComment;@@ -867,6 +941,8 @@ export declare type UpdateIssueCommentRequest = Message<"bytebase.v1.UpdateIssueparent: string;/**+ * The comment to update.+ ** @generated from field: bytebase.v1.IssueComment issue_comment = 2;*/issueComment?: IssueComment;@@ -894,6 +970,8 @@ export declare type UpdateIssueCommentRequest = Message<"bytebase.v1.UpdateIssueexport declare const UpdateIssueCommentRequestSchema: GenMessage<UpdateIssueCommentRequest>;/**+ * A comment on an issue.+ ** @generated from message bytebase.v1.IssueComment*/export declare type IssueComment = Message<"bytebase.v1.IssueComment"> & {@@ -905,6 +983,8 @@ export declare type IssueComment = Message<"bytebase.v1.IssueComment"> & {name: string;/**+ * The text content of the comment.+ ** @generated from field: string comment = 2;*/comment: string;@@ -934,34 +1014,46 @@ export declare type IssueComment = Message<"bytebase.v1.IssueComment"> & {creator: string;/**+ * The event associated with this comment.+ ** @generated from oneof bytebase.v1.IssueComment.event*/event: {/**+ * Approval event.+ ** @generated from field: bytebase.v1.IssueComment.Approval approval = 8;*/value: IssueComment_Approval;case: "approval";} | {/**+ * Issue update event.+ ** @generated from field: bytebase.v1.IssueComment.IssueUpdate issue_update = 9;*/value: IssueComment_IssueUpdate;case: "issueUpdate";} | {/**+ * Stage end event.+ ** @generated from field: bytebase.v1.IssueComment.StageEnd stage_end = 10;*/value: IssueComment_StageEnd;case: "stageEnd";} | {/**+ * Task update event.+ ** @generated from field: bytebase.v1.IssueComment.TaskUpdate task_update = 11;*/value: IssueComment_TaskUpdate;case: "taskUpdate";} | {/**+ * Task prior backup event.+ ** @generated from field: bytebase.v1.IssueComment.TaskPriorBackup task_prior_backup = 12;*/value: IssueComment_TaskPriorBackup;@@ -976,10 +1068,14 @@ export declare type IssueComment = Message<"bytebase.v1.IssueComment"> & {export declare const IssueCommentSchema: GenMessage<IssueComment>;/**+ * Approval event information.+ ** @generated from message bytebase.v1.IssueComment.Approval*/export declare type IssueComment_Approval = Message<"bytebase.v1.IssueComment.Approval"> & {/**+ * The approval status.+ ** @generated from field: bytebase.v1.IssueComment.Approval.Status status = 1;*/status: IssueComment_Approval_Status;@@ -992,25 +1088,35 @@ export declare type IssueComment_Approval = Message<"bytebase.v1.IssueComment.Apexport declare const IssueComment_ApprovalSchema: GenMessage<IssueComment_Approval>;/**+ * Approval status values.+ ** @generated from enum bytebase.v1.IssueComment.Approval.Status*/export enum IssueComment_Approval_Status {/**+ * Unspecified status.+ ** @generated from enum value: STATUS_UNSPECIFIED = 0;*/STATUS_UNSPECIFIED = 0,/**+ * Approval pending.+ ** @generated from enum value: PENDING = 1;*/PENDING = 1,/**+ * Approved.+ ** @generated from enum value: APPROVED = 2;*/APPROVED = 2,/**+ * Rejected.+ ** @generated from enum value: REJECTED = 3;*/REJECTED = 3,@@ -1022,6 +1128,8 @@ export enum IssueComment_Approval_Status {export declare const IssueComment_Approval_StatusSchema: GenEnum<IssueComment_Approval_Status>;/**+ * Issue update event information.+ ** @generated from message bytebase.v1.IssueComment.IssueUpdate*/export declare type IssueComment_IssueUpdate = Message<"bytebase.v1.IssueComment.IssueUpdate"> & {@@ -1073,10 +1181,14 @@ export declare type IssueComment_IssueUpdate = Message<"bytebase.v1.IssueCommentexport declare const IssueComment_IssueUpdateSchema: GenMessage<IssueComment_IssueUpdate>;/**+ * Stage end event information.+ ** @generated from message bytebase.v1.IssueComment.StageEnd*/export declare type IssueComment_StageEnd = Message<"bytebase.v1.IssueComment.StageEnd"> & {/**+ * The stage that ended.+ ** @generated from field: string stage = 1;*/stage: string;@@ -1089,10 +1201,14 @@ export declare type IssueComment_StageEnd = Message<"bytebase.v1.IssueComment.Stexport declare const IssueComment_StageEndSchema: GenMessage<IssueComment_StageEnd>;/**+ * Task update event information.+ ** @generated from message bytebase.v1.IssueComment.TaskUpdate*/export declare type IssueComment_TaskUpdate = Message<"bytebase.v1.IssueComment.TaskUpdate"> & {/**+ * The tasks that were updated.+ ** @generated from field: repeated string tasks = 1;*/tasks: string[];@@ -1124,40 +1240,56 @@ export declare type IssueComment_TaskUpdate = Message<"bytebase.v1.IssueComment.export declare const IssueComment_TaskUpdateSchema: GenMessage<IssueComment_TaskUpdate>;/**+ * Task status values.+ ** @generated from enum bytebase.v1.IssueComment.TaskUpdate.Status*/export enum IssueComment_TaskUpdate_Status {/**+ * Unspecified status.+ ** @generated from enum value: STATUS_UNSPECIFIED = 0;*/STATUS_UNSPECIFIED = 0,/**+ * Task is pending.+ ** @generated from enum value: PENDING = 1;*/PENDING = 1,/**+ * Task is running.+ ** @generated from enum value: RUNNING = 2;*/RUNNING = 2,/**+ * Task is done.+ ** @generated from enum value: DONE = 3;*/DONE = 3,/**+ * Task failed.+ ** @generated from enum value: FAILED = 4;*/FAILED = 4,/**+ * Task was skipped.+ ** @generated from enum value: SKIPPED = 5;*/SKIPPED = 5,/**+ * Task was canceled.+ ** @generated from enum value: CANCELED = 6;*/CANCELED = 6,@@ -1169,30 +1301,42 @@ export enum IssueComment_TaskUpdate_Status {export declare const IssueComment_TaskUpdate_StatusSchema: GenEnum<IssueComment_TaskUpdate_Status>;/**+ * Task prior backup event information.+ ** @generated from message bytebase.v1.IssueComment.TaskPriorBackup*/export declare type IssueComment_TaskPriorBackup = Message<"bytebase.v1.IssueComment.TaskPriorBackup"> & {/**+ * The task for which backup was performed.+ ** @generated from field: string task = 1;*/task: string;/**+ * The tables that were backed up.+ ** @generated from field: repeated bytebase.v1.IssueComment.TaskPriorBackup.Table tables = 2;*/tables: IssueComment_TaskPriorBackup_Table[];/**+ * The original line number in the statement.+ ** @generated from field: optional int32 original_line = 3;*/originalLine?: number;/**+ * The database that was backed up.+ ** @generated from field: string database = 4;*/database: string;/**+ * Error message if backup failed.+ ** @generated from field: string error = 5;*/error: string;@@ -1205,15 +1349,21 @@ export declare type IssueComment_TaskPriorBackup = Message<"bytebase.v1.IssueComexport declare const IssueComment_TaskPriorBackupSchema: GenMessage<IssueComment_TaskPriorBackup>;/**+ * Table identification.+ ** @generated from message bytebase.v1.IssueComment.TaskPriorBackup.Table*/export declare type IssueComment_TaskPriorBackup_Table = Message<"bytebase.v1.IssueComment.TaskPriorBackup.Table"> & {/**+ * The schema name.+ ** @generated from field: string schema = 1;*/schema: string;/**+ * The table name.+ ** @generated from field: string table = 2;*/table: string;@@ -1226,25 +1376,35 @@ export declare type IssueComment_TaskPriorBackup_Table = Message<"bytebase.v1.Isexport declare const IssueComment_TaskPriorBackup_TableSchema: GenMessage<IssueComment_TaskPriorBackup_Table>;/**+ * The status of an issue.+ ** @generated from enum bytebase.v1.IssueStatus*/export enum IssueStatus {/**+ * Unspecified status.+ ** @generated from enum value: ISSUE_STATUS_UNSPECIFIED = 0;*/ISSUE_STATUS_UNSPECIFIED = 0,/**+ * Issue is open and active.+ ** @generated from enum value: OPEN = 1;*/OPEN = 1,/**+ * Issue is completed.+ ** @generated from enum value: DONE = 2;*/DONE = 2,/**+ * Issue is canceled.+ ** @generated from enum value: CANCELED = 3;*/CANCELED = 3,@@ -1256,10 +1416,13 @@ export enum IssueStatus {export declare const IssueStatusSchema: GenEnum<IssueStatus>;/**+ * IssueService manages issues for tracking database changes and tasks.+ ** @generated from service bytebase.v1.IssueService*/export declare const IssueService: GenService<{/**+ * Retrieves an issue by name.* Permissions required: bb.issues.get** @generated from rpc bytebase.v1.IssueService.GetIssue@@ -1270,6 +1433,7 @@ export declare const IssueService: GenService<{output: typeof IssueSchema;},/**+ * Creates a new issue for database changes or tasks.* Permissions required: bb.issues.create** @generated from rpc bytebase.v1.IssueService.CreateIssue@@ -1280,6 +1444,7 @@ export declare const IssueService: GenService<{output: typeof IssueSchema;},/**+ * Lists issues in a project.* Permissions required: bb.issues.list** @generated from rpc bytebase.v1.IssueService.ListIssues@@ -1301,6 +1466,7 @@ export declare const IssueService: GenService<{output: typeof SearchIssuesResponseSchema;},/**+ * Updates an issue's properties such as title, description, or labels.* Permissions required: bb.issues.update** @generated from rpc bytebase.v1.IssueService.UpdateIssue@@ -1311,6 +1477,7 @@ export declare const IssueService: GenService<{output: typeof IssueSchema;},/**+ * Lists comments on an issue.* Permissions required: bb.issueComments.list** @generated from rpc bytebase.v1.IssueService.ListIssueComments@@ -1321,6 +1488,7 @@ export declare const IssueService: GenService<{output: typeof ListIssueCommentsResponseSchema;},/**+ * Adds a comment to an issue.* Permissions required: bb.issueComments.create** @generated from rpc bytebase.v1.IssueService.CreateIssueComment@@ -1331,6 +1499,7 @@ export declare const IssueService: GenService<{output: typeof IssueCommentSchema;},/**+ * Updates an existing issue comment.* Permissions required: bb.issueComments.update** @generated from rpc bytebase.v1.IssueService.UpdateIssueComment@@ -1341,6 +1510,7 @@ export declare const IssueService: GenService<{output: typeof IssueCommentSchema;},/**+ * Updates the status of multiple issues in a single operation.* Permissions required: bb.issues.update** @generated from rpc bytebase.v1.IssueService.BatchUpdateIssuesStatus@@ -1351,9 +1521,8 @@ export declare const IssueService: GenService<{output: typeof BatchUpdateIssuesStatusResponseSchema;},/**- * ApproveIssue approves the issue.- * The access is based on approval flow.- * Permissions required: None+ * Approves an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+ * Permissions required: None (determined by approval flow)** @generated from rpc bytebase.v1.IssueService.ApproveIssue*/@@ -1363,9 +1532,8 @@ export declare const IssueService: GenService<{output: typeof IssueSchema;},/**- * RejectIssue rejects the issue.- * The access is based on approval flow.- * Permissions required: None+ * Rejects an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+ * Permissions required: None (determined by approval flow)** @generated from rpc bytebase.v1.IssueService.RejectIssue*/@@ -1375,9 +1543,8 @@ export declare const IssueService: GenService<{output: typeof IssueSchema;},/**- * RequestIssue requests the issue.- * The access is based on approval flow.- * Permissions required: None+ * Requests changes on an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+ * Permissions required: None (determined by approval flow)** @generated from rpc bytebase.v1.IssueService.RequestIssue*/diff --git a/frontend/src/types/proto-es/v1/issue_service_pb.js b/frontend/src/types/proto-es/v1/issue_service_pb.jsindex c7ef041fce..b261c75b2d 100644--- a/frontend/src/types/proto-es/v1/issue_service_pb.js+++ b/frontend/src/types/proto-es/v1/issue_service_pb.js@@ -123,6 +123,8 @@ export const Issue_Approver_StatusSchema = /*@__PURE__*/enumDesc(file_v1_issue_service, 12, 0, 0);/**+ * The approval status of an approver.+ ** @generated from enum bytebase.v1.Issue.Approver.Status*/export const Issue_Approver_Status = /*@__PURE__*/@@ -135,6 +137,8 @@ export const Issue_TypeSchema = /*@__PURE__*/enumDesc(file_v1_issue_service, 12, 0);/**+ * The type of issue.+ ** @generated from enum bytebase.v1.Issue.Type*/export const Issue_Type = /*@__PURE__*/@@ -147,6 +151,8 @@ export const Issue_ApprovalStatusSchema = /*@__PURE__*/enumDesc(file_v1_issue_service, 12, 1);/**+ * The overall approval status for the issue.+ ** @generated from enum bytebase.v1.Issue.ApprovalStatus*/export const Issue_ApprovalStatus = /*@__PURE__*/@@ -222,6 +228,8 @@ export const IssueComment_Approval_StatusSchema = /*@__PURE__*/enumDesc(file_v1_issue_service, 20, 0, 0);/**+ * Approval status values.+ ** @generated from enum bytebase.v1.IssueComment.Approval.Status*/export const IssueComment_Approval_Status = /*@__PURE__*/@@ -255,6 +263,8 @@ export const IssueComment_TaskUpdate_StatusSchema = /*@__PURE__*/enumDesc(file_v1_issue_service, 20, 3, 0);/**+ * Task status values.+ ** @generated from enum bytebase.v1.IssueComment.TaskUpdate.Status*/export const IssueComment_TaskUpdate_Status = /*@__PURE__*/@@ -281,12 +291,16 @@ export const IssueStatusSchema = /*@__PURE__*/enumDesc(file_v1_issue_service, 0);/**+ * The status of an issue.+ ** @generated from enum bytebase.v1.IssueStatus*/export const IssueStatus = /*@__PURE__*/tsEnum(IssueStatusSchema);/**+ * IssueService manages issues for tracking database changes and tasks.+ ** @generated from service bytebase.v1.IssueService*/export const IssueService = /*@__PURE__*/diff --git a/frontend/src/types/proto-es/v1/org_policy_service_pb.d.ts b/frontend/src/types/proto-es/v1/org_policy_service_pb.d.tsindex 67fca61622..862096ae2e 100644--- a/frontend/src/types/proto-es/v1/org_policy_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/org_policy_service_pb.d.ts@@ -36,6 +36,8 @@ export declare type CreatePolicyRequest = Message<"bytebase.v1.CreatePolicyRequepolicy?: Policy;/**+ * The type of policy to create.+ ** @generated from field: bytebase.v1.PolicyType type = 3;*/type: PolicyType;@@ -142,12 +144,14 @@ export declare type ListPoliciesRequest = Message<"bytebase.v1.ListPoliciesRequeparent: string;/**+ * Filter by specific policy type.+ ** @generated from field: optional bytebase.v1.PolicyType policy_type = 2;*/policyType?: PolicyType;/**- * Not used.+ * Pagination is not currently implemented. This field is reserved for future use.* The maximum number of policies to return. The service may return fewer than* this value.* If unspecified, at most 10 policies will be returned.@@ -158,7 +162,7 @@ export declare type ListPoliciesRequest = Message<"bytebase.v1.ListPoliciesRequepageSize: number;/**- * Not used.+ * Pagination is not currently implemented. This field is reserved for future use.* A page token, received from a previous `ListPolicies` call.* Provide this to retrieve the subsequent page.*@@ -226,16 +230,22 @@ export declare type Policy = Message<"bytebase.v1.Policy"> & {name: string;/**+ * Whether this policy inherits from its parent resource.+ ** @generated from field: bool inherit_from_parent = 4;*/inheritFromParent: boolean;/**+ * The type of policy.+ ** @generated from field: bytebase.v1.PolicyType type = 5;*/type: PolicyType;/**+ * The policy configuration.+ ** @generated from oneof bytebase.v1.Policy.policy*/policy: {@@ -277,6 +287,8 @@ export declare type Policy = Message<"bytebase.v1.Policy"> & {} | { case: undefined; value?: undefined };/**+ * Whether the policy is enforced.+ ** @generated from field: bool enforce = 13;*/enforce: boolean;@@ -296,15 +308,21 @@ export declare type Policy = Message<"bytebase.v1.Policy"> & {export declare const PolicySchema: GenMessage<Policy>;/**+ * Rollout policy configuration.+ ** @generated from message bytebase.v1.RolloutPolicy*/export declare type RolloutPolicy = Message<"bytebase.v1.RolloutPolicy"> & {/**+ * Whether rollout is automatic without manual approval.+ ** @generated from field: bool automatic = 1;*/automatic: boolean;/**+ * The roles that can approve rollout execution.+ ** @generated from field: repeated string roles = 2;*/roles: string[];@@ -412,14 +430,14 @@ export declare type QueryDataPolicy = Message<"bytebase.v1.QueryDataPolicy"> & {timeout?: Duration;/**- * Disable export data in the SQL editor+ * Disable data export in the SQL editor.** @generated from field: bool disable_export = 2;*/disableExport: boolean;/**- * The size limit in bytes.+ * The maximum result size limit in bytes.* The default value is 100MB, we will use the default value if the setting not exists, or the limit <= 0.** @generated from field: int64 maximum_result_size = 3;@@ -427,7 +445,7 @@ export declare type QueryDataPolicy = Message<"bytebase.v1.QueryDataPolicy"> & {maximumResultSize: bigint;/**- * The return rows limit.+ * The maximum number of rows to return.* The default value is -1, means no limit.** @generated from field: int32 maximum_result_rows = 4;@@ -435,7 +453,7 @@ export declare type QueryDataPolicy = Message<"bytebase.v1.QueryDataPolicy"> & {maximumResultRows: number;/**- * Disable copying data.+ * Disable copying query results.** @generated from field: bool disable_copy_data = 5;*/@@ -449,17 +467,21 @@ export declare type QueryDataPolicy = Message<"bytebase.v1.QueryDataPolicy"> & {export declare const QueryDataPolicySchema: GenMessage<QueryDataPolicy>;/**- * The SQL review rules. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.+ * SQL review rule configuration. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.** @generated from message bytebase.v1.SQLReviewRule*/export declare type SQLReviewRule = Message<"bytebase.v1.SQLReviewRule"> & {/**+ * The type of SQL review rule.+ ** @generated from field: string type = 1;*/type: string;/**+ * The severity level of the rule.+ ** @generated from field: bytebase.v1.SQLReviewRuleLevel level = 2;*/level: SQLReviewRuleLevel;@@ -472,11 +494,15 @@ export declare type SQLReviewRule = Message<"bytebase.v1.SQLReviewRule"> & {payload: string;/**+ * The database engine this rule applies to.+ ** @generated from field: bytebase.v1.Engine engine = 4;*/engine: Engine;/**+ * Additional comment for the rule.+ ** @generated from field: string comment = 5;*/comment: string;@@ -495,6 +521,8 @@ export declare const SQLReviewRuleSchema: GenMessage<SQLReviewRule>;*/export declare type MaskingExceptionPolicy = Message<"bytebase.v1.MaskingExceptionPolicy"> & {/**+ * The list of masking exceptions.+ ** @generated from field: repeated bytebase.v1.MaskingExceptionPolicy.MaskingException masking_exceptions = 1;*/maskingExceptions: MaskingExceptionPolicy_MaskingException[];@@ -507,11 +535,13 @@ export declare type MaskingExceptionPolicy = Message<"bytebase.v1.MaskingExceptiexport declare const MaskingExceptionPolicySchema: GenMessage<MaskingExceptionPolicy>;/**+ * An exception allowing specific users to access masked data.+ ** @generated from message bytebase.v1.MaskingExceptionPolicy.MaskingException*/export declare type MaskingExceptionPolicy_MaskingException = Message<"bytebase.v1.MaskingExceptionPolicy.MaskingException"> & {/**- * action is the action that the user can access sensitive data.+ * The action that the user can perform on sensitive data.** @generated from field: bytebase.v1.MaskingExceptionPolicy.MaskingException.Action action = 1;*/@@ -557,20 +587,28 @@ export declare type MaskingExceptionPolicy_MaskingException = Message<"bytebase.export declare const MaskingExceptionPolicy_MaskingExceptionSchema: GenMessage<MaskingExceptionPolicy_MaskingException>;/**+ * The action that the exception permits.+ ** @generated from enum bytebase.v1.MaskingExceptionPolicy.MaskingException.Action*/export enum MaskingExceptionPolicy_MaskingException_Action {/**+ * Unspecified action.+ ** @generated from enum value: ACTION_UNSPECIFIED = 0;*/ACTION_UNSPECIFIED = 0,/**+ * Allow querying sensitive data.+ ** @generated from enum value: QUERY = 1;*/QUERY = 1,/**+ * Allow exporting sensitive data.+ ** @generated from enum value: EXPORT = 2;*/EXPORT = 2,@@ -582,10 +620,14 @@ export enum MaskingExceptionPolicy_MaskingException_Action {export declare const MaskingExceptionPolicy_MaskingException_ActionSchema: GenEnum<MaskingExceptionPolicy_MaskingException_Action>;/**+ * Policy for configuring data masking rules.+ ** @generated from message bytebase.v1.MaskingRulePolicy*/export declare type MaskingRulePolicy = Message<"bytebase.v1.MaskingRulePolicy"> & {/**+ * The list of masking rules.+ ** @generated from field: repeated bytebase.v1.MaskingRulePolicy.MaskingRule rules = 1;*/rules: MaskingRulePolicy_MaskingRule[];@@ -598,11 +640,13 @@ export declare type MaskingRulePolicy = Message<"bytebase.v1.MaskingRulePolicy">export declare const MaskingRulePolicySchema: GenMessage<MaskingRulePolicy>;/**+ * A rule that defines when and how to mask data.+ ** @generated from message bytebase.v1.MaskingRulePolicy.MaskingRule*/export declare type MaskingRulePolicy_MaskingRule = Message<"bytebase.v1.MaskingRulePolicy.MaskingRule"> & {/**- * A unique identifier for a node in UUID format.+ * A unique identifier for the rule in UUID format.** @generated from field: string id = 1;*/@@ -638,6 +682,8 @@ export declare type MaskingRulePolicy_MaskingRule = Message<"bytebase.v1.Maskingcondition?: Expr;/**+ * The semantic type of data to mask (e.g., "SSN", "EMAIL").+ ** @generated from field: string semantic_type = 3;*/semanticType: string;@@ -650,6 +696,8 @@ export declare type MaskingRulePolicy_MaskingRule = Message<"bytebase.v1.Maskingexport declare const MaskingRulePolicy_MaskingRuleSchema: GenMessage<MaskingRulePolicy_MaskingRule>;/**+ * Policy for tagging resources with metadata.+ ** @generated from message bytebase.v1.TagPolicy*/export declare type TagPolicy = Message<"bytebase.v1.TagPolicy"> & {@@ -669,12 +717,14 @@ export declare type TagPolicy = Message<"bytebase.v1.TagPolicy"> & {export declare const TagPolicySchema: GenMessage<TagPolicy>;/**- * DataSourceQueryPolicy is the policy configuration for running statements in the SQL editor.+ * Policy for controlling which data sources can be queried in the SQL editor.** @generated from message bytebase.v1.DataSourceQueryPolicy*/export declare type DataSourceQueryPolicy = Message<"bytebase.v1.DataSourceQueryPolicy"> & {/**+ * Restriction for admin data source queries.+ ** @generated from field: bytebase.v1.DataSourceQueryPolicy.Restriction admin_data_source_restriction = 1;*/adminDataSourceRestriction: DataSourceQueryPolicy_Restriction;@@ -701,23 +751,27 @@ export declare type DataSourceQueryPolicy = Message<"bytebase.v1.DataSourceQueryexport declare const DataSourceQueryPolicySchema: GenMessage<DataSourceQueryPolicy>;/**+ * Restriction level for admin data source access.+ ** @generated from enum bytebase.v1.DataSourceQueryPolicy.Restriction*/export enum DataSourceQueryPolicy_Restriction {/**+ * Unspecified restriction.+ ** @generated from enum value: RESTRICTION_UNSPECIFIED = 0;*/RESTRICTION_UNSPECIFIED = 0,/**- * Allow to query admin data sources when there is no read-only data source.+ * Allow querying admin data sources when there is no read-only data source.** @generated from enum value: FALLBACK = 1;*/FALLBACK = 1,/**- * Disallow to query admin data sources.+ * Disallow querying admin data sources.** @generated from enum value: DISALLOW = 2;*/@@ -730,40 +784,56 @@ export enum DataSourceQueryPolicy_Restriction {export declare const DataSourceQueryPolicy_RestrictionSchema: GenEnum<DataSourceQueryPolicy_Restriction>;/**+ * The type of organizational policy.+ ** @generated from enum bytebase.v1.PolicyType*/export enum PolicyType {/**+ * Unspecified policy type.+ ** @generated from enum value: POLICY_TYPE_UNSPECIFIED = 0;*/POLICY_TYPE_UNSPECIFIED = 0,/**+ * Rollout deployment policy.+ ** @generated from enum value: ROLLOUT_POLICY = 11;*/ROLLOUT_POLICY = 11,/**+ * Data masking rule policy.+ ** @generated from enum value: MASKING_RULE = 9;*/MASKING_RULE = 9,/**+ * Data masking exception policy.+ ** @generated from enum value: MASKING_EXCEPTION = 10;*/MASKING_EXCEPTION = 10,/**+ * Resource tag policy.+ ** @generated from enum value: TAG = 13;*/TAG = 13,/**+ * Data source query restrictions policy.+ ** @generated from enum value: DATA_SOURCE_QUERY = 14;*/DATA_SOURCE_QUERY = 14,/**+ * Query data access policy.+ ** @generated from enum value: DATA_QUERY = 16;*/DATA_QUERY = 16,@@ -775,25 +845,35 @@ export enum PolicyType {export declare const PolicyTypeSchema: GenEnum<PolicyType>;/**+ * The resource type that a policy can be attached to.+ ** @generated from enum bytebase.v1.PolicyResourceType*/export enum PolicyResourceType {/**+ * Unspecified resource type.+ ** @generated from enum value: RESOURCE_TYPE_UNSPECIFIED = 0;*/RESOURCE_TYPE_UNSPECIFIED = 0,/**+ * Workspace-level policy.+ ** @generated from enum value: WORKSPACE = 1;*/WORKSPACE = 1,/**+ * Environment-level policy.+ ** @generated from enum value: ENVIRONMENT = 2;*/ENVIRONMENT = 2,/**+ * Project-level policy.+ ** @generated from enum value: PROJECT = 3;*/PROJECT = 3,@@ -805,25 +885,35 @@ export enum PolicyResourceType {export declare const PolicyResourceTypeSchema: GenEnum<PolicyResourceType>;/**+ * The severity level for SQL review rules.+ ** @generated from enum bytebase.v1.SQLReviewRuleLevel*/export enum SQLReviewRuleLevel {/**+ * Unspecified level.+ ** @generated from enum value: LEVEL_UNSPECIFIED = 0;*/LEVEL_UNSPECIFIED = 0,/**+ * Rule violation is an error.+ ** @generated from enum value: ERROR = 1;*/ERROR = 1,/**+ * Rule violation is a warning.+ ** @generated from enum value: WARNING = 2;*/WARNING = 2,/**+ * Rule is disabled.+ ** @generated from enum value: DISABLED = 3;*/DISABLED = 3,@@ -835,10 +925,13 @@ export enum SQLReviewRuleLevel {export declare const SQLReviewRuleLevelSchema: GenEnum<SQLReviewRuleLevel>;/**+ * OrgPolicyService manages organizational policies at various resource levels.+ ** @generated from service bytebase.v1.OrgPolicyService*/export declare const OrgPolicyService: GenService<{/**+ * Retrieves a policy by name.* Permissions required: bb.policies.get** @generated from rpc bytebase.v1.OrgPolicyService.GetPolicy@@ -849,6 +942,7 @@ export declare const OrgPolicyService: GenService<{output: typeof PolicySchema;},/**+ * Lists policies at a specified resource level.* Permissions required: bb.policies.list** @generated from rpc bytebase.v1.OrgPolicyService.ListPolicies@@ -859,6 +953,7 @@ export declare const OrgPolicyService: GenService<{output: typeof ListPoliciesResponseSchema;},/**+ * Creates a new organizational policy.* Permissions required: bb.policies.create** @generated from rpc bytebase.v1.OrgPolicyService.CreatePolicy@@ -869,6 +964,7 @@ export declare const OrgPolicyService: GenService<{output: typeof PolicySchema;},/**+ * Updates an existing organizational policy.* Permissions required: bb.policies.update** @generated from rpc bytebase.v1.OrgPolicyService.UpdatePolicy@@ -879,6 +975,7 @@ export declare const OrgPolicyService: GenService<{output: typeof PolicySchema;},/**+ * Deletes an organizational policy.* Permissions required: bb.policies.delete** @generated from rpc bytebase.v1.OrgPolicyService.DeletePolicydiff --git a/frontend/src/types/proto-es/v1/org_policy_service_pb.js b/frontend/src/types/proto-es/v1/org_policy_service_pb.jsindex 0fc7b4c091..11b12cdecc 100644--- a/frontend/src/types/proto-es/v1/org_policy_service_pb.js+++ b/frontend/src/types/proto-es/v1/org_policy_service_pb.js@@ -135,6 +135,8 @@ export const MaskingExceptionPolicy_MaskingException_ActionSchema = /*@__PURE__*enumDesc(file_v1_org_policy_service, 10, 0, 0);/**+ * The action that the exception permits.+ ** @generated from enum bytebase.v1.MaskingExceptionPolicy.MaskingException.Action*/export const MaskingExceptionPolicy_MaskingException_Action = /*@__PURE__*/@@ -175,6 +177,8 @@ export const DataSourceQueryPolicy_RestrictionSchema = /*@__PURE__*/enumDesc(file_v1_org_policy_service, 13, 0);/**+ * Restriction level for admin data source access.+ ** @generated from enum bytebase.v1.DataSourceQueryPolicy.Restriction*/export const DataSourceQueryPolicy_Restriction = /*@__PURE__*/@@ -187,6 +191,8 @@ export const PolicyTypeSchema = /*@__PURE__*/enumDesc(file_v1_org_policy_service, 0);/**+ * The type of organizational policy.+ ** @generated from enum bytebase.v1.PolicyType*/export const PolicyType = /*@__PURE__*/@@ -199,6 +205,8 @@ export const PolicyResourceTypeSchema = /*@__PURE__*/enumDesc(file_v1_org_policy_service, 1);/**+ * The resource type that a policy can be attached to.+ ** @generated from enum bytebase.v1.PolicyResourceType*/export const PolicyResourceType = /*@__PURE__*/@@ -211,12 +219,16 @@ export const SQLReviewRuleLevelSchema = /*@__PURE__*/enumDesc(file_v1_org_policy_service, 2);/**+ * The severity level for SQL review rules.+ ** @generated from enum bytebase.v1.SQLReviewRuleLevel*/export const SQLReviewRuleLevel = /*@__PURE__*/tsEnum(SQLReviewRuleLevelSchema);/**+ * OrgPolicyService manages organizational policies at various resource levels.+ ** @generated from service bytebase.v1.OrgPolicyService*/export const OrgPolicyService = /*@__PURE__*/diff --git a/frontend/src/types/proto-es/v1/plan_service_pb.d.ts b/frontend/src/types/proto-es/v1/plan_service_pb.d.tsindex d8de776ba7..41a75d76ea 100644--- a/frontend/src/types/proto-es/v1/plan_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/plan_service_pb.d.ts@@ -292,16 +292,22 @@ export declare type Plan = Message<"bytebase.v1.Plan"> & {rollout: string;/**+ * The title of the plan.+ ** @generated from field: string title = 4;*/title: string;/**+ * The description of the plan.+ ** @generated from field: string description = 5;*/description: string;/**+ * The deployment specs for the plan.+ ** @generated from field: repeated bytebase.v1.Plan.Spec specs = 14;*/specs: Plan_Spec[];@@ -627,7 +633,7 @@ export declare type ListPlanCheckRunsRequest = Message<"bytebase.v1.ListPlanChecparent: string;/**- * Not used.+ * Pagination is not currently implemented. This field is reserved for future use.* The maximum number of plan check runs to return. The service may return fewer than* this value.* If unspecified, at most 10 plan check runs will be returned.@@ -638,7 +644,7 @@ export declare type ListPlanCheckRunsRequest = Message<"bytebase.v1.ListPlanChecpageSize: number;/**- * Not used.+ * Pagination is not currently implemented. This field is reserved for future use.* A page token, received from a previous `ListPlanCheckRuns` call.* Provide this to retrieve the subsequent page.*@@ -991,31 +997,43 @@ export declare const PlanCheckRun_Result_StatusSchema: GenEnum<PlanCheckRun_Resu*/export enum PlanCheckRun_Type {/**+ * Unspecified check type.+ ** @generated from enum value: TYPE_UNSPECIFIED = 0;*/TYPE_UNSPECIFIED = 0,/**+ * Fake advise check for testing purposes without executing against database.+ ** @generated from enum value: DATABASE_STATEMENT_FAKE_ADVISE = 1;*/DATABASE_STATEMENT_FAKE_ADVISE = 1,/**+ * SQL review check that analyzes statements against configured SQL review rules.+ ** @generated from enum value: DATABASE_STATEMENT_ADVISE = 3;*/DATABASE_STATEMENT_ADVISE = 3,/**+ * Summary report check that generates impact analysis for the statements.+ ** @generated from enum value: DATABASE_STATEMENT_SUMMARY_REPORT = 5;*/DATABASE_STATEMENT_SUMMARY_REPORT = 5,/**+ * Connection check that verifies database connectivity.+ ** @generated from enum value: DATABASE_CONNECT = 6;*/DATABASE_CONNECT = 6,/**+ * Ghost sync check that validates gh-ost online schema change compatibility.+ ** @generated from enum value: DATABASE_GHOST_SYNC = 7;*/DATABASE_GHOST_SYNC = 7,@@ -1062,10 +1080,13 @@ export enum PlanCheckRun_Status {export declare const PlanCheckRun_StatusSchema: GenEnum<PlanCheckRun_Status>;/**+ * PlanService manages deployment plans for database changes.+ ** @generated from service bytebase.v1.PlanService*/export declare const PlanService: GenService<{/**+ * Retrieves a deployment plan by name.* Permissions required: bb.plans.get** @generated from rpc bytebase.v1.PlanService.GetPlan@@ -1076,6 +1097,7 @@ export declare const PlanService: GenService<{output: typeof PlanSchema;},/**+ * Lists deployment plans in a project.* Permissions required: bb.plans.list** @generated from rpc bytebase.v1.PlanService.ListPlans@@ -1097,6 +1119,7 @@ export declare const PlanService: GenService<{output: typeof SearchPlansResponseSchema;},/**+ * Creates a new deployment plan.* Permissions required: bb.plans.create** @generated from rpc bytebase.v1.PlanService.CreatePlan@@ -1109,7 +1132,7 @@ export declare const PlanService: GenService<{/*** UpdatePlan updates the plan.* The plan creator and the user with bb.plans.update permission on the project can update the plan.- * Permissions required: bb.plans.update+ * Permissions required: bb.plans.update (or creator)** @generated from rpc bytebase.v1.PlanService.UpdatePlan*/@@ -1119,6 +1142,7 @@ export declare const PlanService: GenService<{output: typeof PlanSchema;},/**+ * Lists plan check runs for a deployment plan.* Permissions required: bb.planCheckRuns.list** @generated from rpc bytebase.v1.PlanService.ListPlanCheckRuns@@ -1129,6 +1153,7 @@ export declare const PlanService: GenService<{output: typeof ListPlanCheckRunsResponseSchema;},/**+ * Executes validation checks on a deployment plan.* Permissions required: bb.planCheckRuns.run** @generated from rpc bytebase.v1.PlanService.RunPlanChecks@@ -1139,6 +1164,7 @@ export declare const PlanService: GenService<{output: typeof RunPlanChecksResponseSchema;},/**+ * Cancels multiple plan check runs.* Permissions required: bb.planCheckRuns.run** @generated from rpc bytebase.v1.PlanService.BatchCancelPlanCheckRunsdiff --git a/frontend/src/types/proto-es/v1/plan_service_pb.js b/frontend/src/types/proto-es/v1/plan_service_pb.jsindex 462e12efc5..0a9a108416 100644--- a/frontend/src/types/proto-es/v1/plan_service_pb.js+++ b/frontend/src/types/proto-es/v1/plan_service_pb.js@@ -223,6 +223,8 @@ export const PlanCheckRun_Status = /*@__PURE__*/tsEnum(PlanCheckRun_StatusSchema);/**+ * PlanService manages deployment plans for database changes.+ ** @generated from service bytebase.v1.PlanService*/export const PlanService = /*@__PURE__*/diff --git a/frontend/src/types/proto-es/v1/project_service_pb.d.ts b/frontend/src/types/proto-es/v1/project_service_pb.d.tsindex 300222bd99..3ae242fd80 100644--- a/frontend/src/types/proto-es/v1/project_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/project_service_pb.d.ts@@ -381,6 +381,8 @@ export declare const BatchGetIamPolicyRequestSchema: GenMessage<BatchGetIamPolic*/export declare type BatchGetIamPolicyResponse = Message<"bytebase.v1.BatchGetIamPolicyResponse"> & {/**+ * The policy results for each requested project.+ ** @generated from field: repeated bytebase.v1.BatchGetIamPolicyResponse.PolicyResult policy_results = 1;*/policyResults: BatchGetIamPolicyResponse_PolicyResult[];@@ -393,15 +395,21 @@ export declare type BatchGetIamPolicyResponse = Message<"bytebase.v1.BatchGetIamexport declare const BatchGetIamPolicyResponseSchema: GenMessage<BatchGetIamPolicyResponse>;/**+ * Result for a single project's IAM policy.+ ** @generated from message bytebase.v1.BatchGetIamPolicyResponse.PolicyResult*/export declare type BatchGetIamPolicyResponse_PolicyResult = Message<"bytebase.v1.BatchGetIamPolicyResponse.PolicyResult"> & {/**+ * The project resource name.+ ** @generated from field: string project = 1;*/project: string;/**+ * The IAM policy for the project.+ ** @generated from field: bytebase.v1.IamPolicy policy = 2;*/policy?: IamPolicy;@@ -414,20 +422,28 @@ export declare type BatchGetIamPolicyResponse_PolicyResult = Message<"bytebase.vexport declare const BatchGetIamPolicyResponse_PolicyResultSchema: GenMessage<BatchGetIamPolicyResponse_PolicyResult>;/**+ * A label for categorizing and organizing issues.+ ** @generated from message bytebase.v1.Label*/export declare type Label = Message<"bytebase.v1.Label"> & {/**+ * The label value/name.+ ** @generated from field: string value = 1;*/value: string;/**+ * The color code for the label (e.g., hex color).+ ** @generated from field: string color = 2;*/color: string;/**+ * The group this label belongs to.+ ** @generated from field: string group = 3;*/group: string;@@ -452,6 +468,8 @@ export declare type Project = Message<"bytebase.v1.Project"> & {name: string;/**+ * The lifecycle state of the project.+ ** @generated from field: bytebase.v1.State state = 3;*/state: State;@@ -464,16 +482,22 @@ export declare type Project = Message<"bytebase.v1.Project"> & {title: string;/**+ * The list of webhooks configured for the project.+ ** @generated from field: repeated bytebase.v1.Webhook webhooks = 11;*/webhooks: Webhook[];/**+ * The data classification configuration ID for the project.+ ** @generated from field: string data_classification_config_id = 12;*/dataClassificationConfigId: string;/**+ * Labels available for tagging issues in this project.+ ** @generated from field: repeated bytebase.v1.Label issue_labels = 13;*/issueLabels: Label[];@@ -486,72 +510,72 @@ export declare type Project = Message<"bytebase.v1.Project"> & {forceIssueLabels: boolean;/**- * Allow modifying statement after issue is created.+ * Allow modifying SQL statements after issue is created.** @generated from field: bool allow_modify_statement = 15;*/allowModifyStatement: boolean;/**- * Enable auto resolve issue.+ * Enable automatic issue resolution when tasks complete.** @generated from field: bool auto_resolve_issue = 16;*/autoResolveIssue: boolean;/**- * Enforce issue title created by user instead of generated by Bytebase.+ * Enforce issue title to be created by user instead of generated by Bytebase.** @generated from field: bool enforce_issue_title = 17;*/enforceIssueTitle: boolean;/**- * Whether to automatically enable backup.+ * Whether to automatically enable backup for database changes.** @generated from field: bool auto_enable_backup = 18;*/autoEnableBackup: boolean;/**- * Whether to skip backup errors and continue the data migration.+ * Whether to skip backup errors and continue with data migration.** @generated from field: bool skip_backup_errors = 19;*/skipBackupErrors: boolean;/**- * Whether to enable the database tenant mode for PostgreSQL.- * If enabled, the issue will be created with the prepend "set role <db_owner>" statement.+ * Whether to enable database tenant mode for PostgreSQL.+ * If enabled, issues will include "set role <db_owner>" statement.** @generated from field: bool postgres_database_tenant_mode = 20;*/postgresDatabaseTenantMode: boolean;/**- * Whether to allow the issue creator to self-approve the issue.+ * Whether to allow issue creators to self-approve their own issues.** @generated from field: bool allow_self_approval = 21;*/allowSelfApproval: boolean;/**- * Execution retry policy for the task run.+ * Execution retry policy for task runs.** @generated from field: bytebase.v1.Project.ExecutionRetryPolicy execution_retry_policy = 22;*/executionRetryPolicy?: Project_ExecutionRetryPolicy;/**- * The maximum databases of rows to sample during CI data validation.- * Without specification, sampling is disabled, resulting in a full validation.+ * The maximum number of database rows to sample during CI data validation.+ * Without specification, sampling is disabled, resulting in full validation.** @generated from field: int32 ci_sampling_size = 23;*/ciSamplingSize: number;/**- * The maximum number of parallel tasks to run during the rollout.+ * The maximum number of parallel tasks allowed during rollout execution.** @generated from field: int32 parallel_tasks_per_rollout = 24;*/@@ -581,11 +605,13 @@ export declare type Project = Message<"bytebase.v1.Project"> & {export declare const ProjectSchema: GenMessage<Project>;/**+ * Execution retry policy configuration.+ ** @generated from message bytebase.v1.Project.ExecutionRetryPolicy*/export declare type Project_ExecutionRetryPolicy = Message<"bytebase.v1.Project.ExecutionRetryPolicy"> & {/**- * The maximum number of retries for the lock timeout issue.+ * The maximum number of retries for lock timeout errors.** @generated from field: int32 maximum_retries = 1;*/@@ -784,45 +810,63 @@ export declare type Webhook = Message<"bytebase.v1.Webhook"> & {export declare const WebhookSchema: GenMessage<Webhook>;/**+ * Webhook integration type.+ ** @generated from enum bytebase.v1.Webhook.Type*/export enum Webhook_Type {/**+ * Unspecified type.+ ** @generated from enum value: TYPE_UNSPECIFIED = 0;*/TYPE_UNSPECIFIED = 0,/**+ * Slack integration.+ ** @generated from enum value: SLACK = 1;*/SLACK = 1,/**+ * Discord integration.+ ** @generated from enum value: DISCORD = 2;*/DISCORD = 2,/**+ * Microsoft Teams integration.+ ** @generated from enum value: TEAMS = 3;*/TEAMS = 3,/**+ * DingTalk integration.+ ** @generated from enum value: DINGTALK = 4;*/DINGTALK = 4,/**+ * Feishu integration.+ ** @generated from enum value: FEISHU = 5;*/FEISHU = 5,/**+ * WeCom (WeChat Work) integration.+ ** @generated from enum value: WECOM = 6;*/WECOM = 6,/**+ * Lark integration.+ ** @generated from enum value: LARK = 8;*/LARK = 8,@@ -834,6 +878,7 @@ export enum Webhook_Type {export declare const Webhook_TypeSchema: GenEnum<Webhook_Type>;/**+ * Activity types for webhook notifications.* TODO(zp): move to activity later.** @generated from message bytebase.v1.Activity@@ -848,10 +893,14 @@ export declare type Activity = Message<"bytebase.v1.Activity"> & {export declare const ActivitySchema: GenMessage<Activity>;/**+ * Activity type enumeration.+ ** @generated from enum bytebase.v1.Activity.Type*/export enum Activity_Type {/**+ * Unspecified type.+ ** @generated from enum value: TYPE_UNSPECIFIED = 0;*/TYPE_UNSPECIFIED = 0,@@ -930,6 +979,8 @@ export enum Activity_Type {export declare const Activity_TypeSchema: GenEnum<Activity_Type>;/**+ * ProjectService manages projects that group databases and changes.+ ** @generated from service bytebase.v1.ProjectService*/export declare const ProjectService: GenService<{@@ -946,6 +997,7 @@ export declare const ProjectService: GenService<{output: typeof ProjectSchema;},/**+ * Lists all projects in the workspace with optional filtering.* Permissions required: bb.projects.list** @generated from rpc bytebase.v1.ProjectService.ListProjects@@ -956,7 +1008,8 @@ export declare const ProjectService: GenService<{output: typeof ListProjectsResponseSchema;},/**- * Permissions required: None+ * Searches for projects with advanced filtering capabilities.+ * Permissions required: bb.projects.get (or project-level bb.projects.get for specific projects)** @generated from rpc bytebase.v1.ProjectService.SearchProjects*/@@ -966,6 +1019,7 @@ export declare const ProjectService: GenService<{output: typeof SearchProjectsResponseSchema;},/**+ * Creates a new project in the workspace.* Permissions required: bb.projects.create** @generated from rpc bytebase.v1.ProjectService.CreateProject@@ -976,6 +1030,7 @@ export declare const ProjectService: GenService<{output: typeof ProjectSchema;},/**+ * Updates an existing project's properties.* Permissions required: bb.projects.update** @generated from rpc bytebase.v1.ProjectService.UpdateProject@@ -986,6 +1041,7 @@ export declare const ProjectService: GenService<{output: typeof ProjectSchema;},/**+ * Deletes (soft-delete or purge) a project.* Permissions required: bb.projects.delete** @generated from rpc bytebase.v1.ProjectService.DeleteProject@@ -996,6 +1052,7 @@ export declare const ProjectService: GenService<{output: typeof EmptySchema;},/**+ * Restores a soft-deleted project.* Permissions required: bb.projects.undelete** @generated from rpc bytebase.v1.ProjectService.UndeleteProject@@ -1006,6 +1063,7 @@ export declare const ProjectService: GenService<{output: typeof ProjectSchema;},/**+ * Deletes multiple projects in a single operation.* Permissions required: bb.projects.delete** @generated from rpc bytebase.v1.ProjectService.BatchDeleteProjects@@ -1016,6 +1074,7 @@ export declare const ProjectService: GenService<{output: typeof EmptySchema;},/**+ * Retrieves the IAM policy for a project.* Permissions required: bb.projects.getIamPolicy** @generated from rpc bytebase.v1.ProjectService.GetIamPolicy@@ -1026,8 +1085,8 @@ export declare const ProjectService: GenService<{output: typeof IamPolicySchema;},/**- * Deprecated.- * Permissions required: bb.projects.getIamPolicy+ * Deprecated. No permission check implemented.+ * Permissions required: None** @generated from rpc bytebase.v1.ProjectService.BatchGetIamPolicy*/@@ -1037,6 +1096,7 @@ export declare const ProjectService: GenService<{output: typeof BatchGetIamPolicyResponseSchema;},/**+ * Sets the IAM policy for a project.* Permissions required: bb.projects.setIamPolicy** @generated from rpc bytebase.v1.ProjectService.SetIamPolicy@@ -1047,6 +1107,7 @@ export declare const ProjectService: GenService<{output: typeof IamPolicySchema;},/**+ * Adds a webhook to a project for notifications.* Permissions required: bb.projects.update** @generated from rpc bytebase.v1.ProjectService.AddWebhook@@ -1057,6 +1118,7 @@ export declare const ProjectService: GenService<{output: typeof ProjectSchema;},/**+ * Updates an existing webhook configuration.* Permissions required: bb.projects.update** @generated from rpc bytebase.v1.ProjectService.UpdateWebhook@@ -1067,6 +1129,7 @@ export declare const ProjectService: GenService<{output: typeof ProjectSchema;},/**+ * Removes a webhook from a project.* Permissions required: bb.projects.update** @generated from rpc bytebase.v1.ProjectService.RemoveWebhook@@ -1077,6 +1140,7 @@ export declare const ProjectService: GenService<{output: typeof ProjectSchema;},/**+ * Tests a webhook by sending a test notification.* Permissions required: bb.projects.update** @generated from rpc bytebase.v1.ProjectService.TestWebhookdiff --git a/frontend/src/types/proto-es/v1/project_service_pb.js b/frontend/src/types/proto-es/v1/project_service_pb.jsindex a7c9508e3f..c6e55fc389 100644--- a/frontend/src/types/proto-es/v1/project_service_pb.js+++ b/frontend/src/types/proto-es/v1/project_service_pb.js@@ -179,6 +179,8 @@ export const Webhook_TypeSchema = /*@__PURE__*/enumDesc(file_v1_project_service, 19, 0);/**+ * Webhook integration type.+ ** @generated from enum bytebase.v1.Webhook.Type*/export const Webhook_Type = /*@__PURE__*/@@ -198,12 +200,16 @@ export const Activity_TypeSchema = /*@__PURE__*/enumDesc(file_v1_project_service, 20, 0);/**+ * Activity type enumeration.+ ** @generated from enum bytebase.v1.Activity.Type*/export const Activity_Type = /*@__PURE__*/tsEnum(Activity_TypeSchema);/**+ * ProjectService manages projects that group databases and changes.+ ** @generated from service bytebase.v1.ProjectService*/export const ProjectService = /*@__PURE__*/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 238be17913..0c1128ab96 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@@ -81,6 +81,8 @@ export declare const ListReleasesRequestSchema: GenMessage<ListReleasesRequest>;*/export declare type ListReleasesResponse = Message<"bytebase.v1.ListReleasesResponse"> & {/**+ * The releases from the specified request.+ ** @generated from field: repeated bytebase.v1.Release releases = 1;*/releases: Release[];@@ -150,6 +152,8 @@ export declare const SearchReleasesRequestSchema: GenMessage<SearchReleasesReque*/export declare type SearchReleasesResponse = Message<"bytebase.v1.SearchReleasesResponse"> & {/**+ * The releases matching the search criteria.+ ** @generated from field: repeated bytebase.v1.Release releases = 1;*/releases: Release[];@@ -306,12 +310,14 @@ export declare const CheckReleaseRequestSchema: GenMessage<CheckReleaseRequest>;*/export declare type CheckReleaseResponse = Message<"bytebase.v1.CheckReleaseResponse"> & {/**+ * The check results for each file and target combination.+ ** @generated from field: repeated bytebase.v1.CheckReleaseResponse.CheckResult results = 1;*/results: CheckReleaseResponse_CheckResult[];/**- * The affected rows of the check.+ * The total affected rows across all checks.** @generated from field: int64 affected_rows = 2;*/@@ -332,6 +338,8 @@ export declare type CheckReleaseResponse = Message<"bytebase.v1.CheckReleaseRespexport declare const CheckReleaseResponseSchema: GenMessage<CheckReleaseResponse>;/**+ * Check result for a single release file on a target database.+ ** @generated from message bytebase.v1.CheckReleaseResponse.CheckResult*/export declare type CheckReleaseResponse_CheckResult = Message<"bytebase.v1.CheckReleaseResponse.CheckResult"> & {@@ -390,16 +398,22 @@ export declare type Release = Message<"bytebase.v1.Release"> & {name: string;/**+ * The title of the release.+ ** @generated from field: string title = 2;*/title: string;/**+ * The SQL files included in the release.+ ** @generated from field: repeated bytebase.v1.Release.File files = 3;*/files: Release_File[];/**+ * The version control source of the release.+ ** @generated from field: bytebase.v1.Release.VCSSource vcs_source = 4;*/vcsSource?: Release_VCSSource;@@ -417,6 +431,8 @@ export declare type Release = Message<"bytebase.v1.Release"> & {createTime?: Timestamp;/**+ * The lifecycle state of the release.+ ** @generated from field: bytebase.v1.State state = 7;*/state: State;@@ -439,6 +455,8 @@ export declare type Release = Message<"bytebase.v1.Release"> & {export declare const ReleaseSchema: GenMessage<Release>;/**+ * A SQL file in a release.+ ** @generated from message bytebase.v1.Release.File*/export declare type Release_File = Message<"bytebase.v1.Release.File"> & {@@ -464,6 +482,8 @@ export declare type Release_File = Message<"bytebase.v1.Release.File"> & {type: Release_File_Type;/**+ * The version identifier for the file.+ ** @generated from field: string version = 6;*/version: string;@@ -517,20 +537,28 @@ export declare type Release_File = Message<"bytebase.v1.Release.File"> & {export declare const Release_FileSchema: GenMessage<Release_File>;/**+ * The type of migration file.+ ** @generated from enum bytebase.v1.Release.File.Type*/export enum Release_File_Type {/**+ * Unspecified type.+ ** @generated from enum value: TYPE_UNSPECIFIED = 0;*/TYPE_UNSPECIFIED = 0,/**+ * Versioned migration file with sequential version numbers.+ ** @generated from enum value: VERSIONED = 1;*/VERSIONED = 1,/**+ * Declarative schema definition file describing desired state.+ ** @generated from enum value: DECLARATIVE = 2;*/DECLARATIVE = 2,@@ -542,25 +570,35 @@ export enum Release_File_Type {export declare const Release_File_TypeSchema: GenEnum<Release_File_Type>;/**+ * The migration type for versioned files.+ ** @generated from enum bytebase.v1.Release.File.MigrationType*/export enum Release_File_MigrationType {/**+ * Unspecified migration type.+ ** @generated from enum value: MIGRATION_TYPE_UNSPECIFIED = 0;*/MIGRATION_TYPE_UNSPECIFIED = 0,/**+ * DDL (Data Definition Language) migration.+ ** @generated from enum value: DDL = 1;*/DDL = 1,/**+ * DDL migration using gh-ost for online schema changes.+ ** @generated from enum value: DDL_GHOST = 2;*/DDL_GHOST = 2,/**+ * DML (Data Manipulation Language) migration.+ ** @generated from enum value: DML = 3;*/DML = 3,@@ -572,10 +610,14 @@ export enum Release_File_MigrationType {export declare const Release_File_MigrationTypeSchema: GenEnum<Release_File_MigrationType>;/**+ * Version control system source information.+ ** @generated from message bytebase.v1.Release.VCSSource*/export declare type Release_VCSSource = Message<"bytebase.v1.Release.VCSSource"> & {/**+ * The type of VCS.+ ** @generated from field: bytebase.v1.VCSType vcs_type = 1;*/vcsType: VCSType;@@ -595,10 +637,13 @@ export declare type Release_VCSSource = Message<"bytebase.v1.Release.VCSSource">export declare const Release_VCSSourceSchema: GenMessage<Release_VCSSource>;/**+ * ReleaseService manages releases for coordinating deployments.+ ** @generated from service bytebase.v1.ReleaseService*/export declare const ReleaseService: GenService<{/**+ * Retrieves a release by name.* Permissions required: bb.releases.get** @generated from rpc bytebase.v1.ReleaseService.GetRelease@@ -609,6 +654,7 @@ export declare const ReleaseService: GenService<{output: typeof ReleaseSchema;},/**+ * Lists releases in a project.* Permissions required: bb.releases.list** @generated from rpc bytebase.v1.ReleaseService.ListReleases@@ -619,6 +665,7 @@ export declare const ReleaseService: GenService<{output: typeof ListReleasesResponseSchema;},/**+ * Searches releases by digest or other criteria.* Permissions required: bb.releases.get** @generated from rpc bytebase.v1.ReleaseService.SearchReleases@@ -629,6 +676,7 @@ export declare const ReleaseService: GenService<{output: typeof SearchReleasesResponseSchema;},/**+ * Creates a new release with SQL files.* Permissions required: bb.releases.create** @generated from rpc bytebase.v1.ReleaseService.CreateRelease@@ -639,6 +687,7 @@ export declare const ReleaseService: GenService<{output: typeof ReleaseSchema;},/**+ * Updates an existing release.* Permissions required: bb.releases.update** @generated from rpc bytebase.v1.ReleaseService.UpdateRelease@@ -649,6 +698,7 @@ export declare const ReleaseService: GenService<{output: typeof ReleaseSchema;},/**+ * Deletes a release.* Permissions required: bb.releases.delete** @generated from rpc bytebase.v1.ReleaseService.DeleteRelease@@ -659,6 +709,7 @@ export declare const ReleaseService: GenService<{output: typeof EmptySchema;},/**+ * Restores a deleted release.* Permissions required: bb.releases.undelete** @generated from rpc bytebase.v1.ReleaseService.UndeleteRelease@@ -669,6 +720,7 @@ export declare const ReleaseService: GenService<{output: typeof ReleaseSchema;},/**+ * Validates a release by dry-running checks on target databases.* Permissions required: bb.releases.check** @generated from rpc bytebase.v1.ReleaseService.CheckReleasediff --git a/frontend/src/types/proto-es/v1/release_service_pb.js b/frontend/src/types/proto-es/v1/release_service_pb.jsindex afba3d6110..62df69bb05 100644--- a/frontend/src/types/proto-es/v1/release_service_pb.js+++ b/frontend/src/types/proto-es/v1/release_service_pb.js@@ -123,6 +123,8 @@ export const Release_File_TypeSchema = /*@__PURE__*/enumDesc(file_v1_release_service, 11, 0, 0);/**+ * The type of migration file.+ ** @generated from enum bytebase.v1.Release.File.Type*/export const Release_File_Type = /*@__PURE__*/@@ -135,6 +137,8 @@ export const Release_File_MigrationTypeSchema = /*@__PURE__*/enumDesc(file_v1_release_service, 11, 0, 1);/**+ * The migration type for versioned files.+ ** @generated from enum bytebase.v1.Release.File.MigrationType*/export const Release_File_MigrationType = /*@__PURE__*/@@ -148,6 +152,8 @@ export const Release_VCSSourceSchema = /*@__PURE__*/messageDesc(file_v1_release_service, 11, 1);/**+ * ReleaseService manages releases for coordinating deployments.+ ** @generated from service bytebase.v1.ReleaseService*/export const ReleaseService = /*@__PURE__*/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 2f46297937..3f8e3e3180 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@@ -17,7 +17,7 @@ export declare const file_v1_review_config_service: GenFile;*/export declare type ListReviewConfigsRequest = Message<"bytebase.v1.ListReviewConfigsRequest"> & {/**- * Not used.+ * 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.@@ -28,7 +28,7 @@ export declare type ListReviewConfigsRequest = Message<"bytebase.v1.ListReviewCopageSize: number;/**- * Not used.+ * 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@@ -175,23 +175,29 @@ export declare type ReviewConfig = Message<"bytebase.v1.ReviewConfig"> & {name: string;/**+ * The title of the review configuration.+ ** @generated from field: string title = 2;*/title: string;/**+ * Whether the review configuration is enabled.+ ** @generated from field: bool enabled = 3;*/enabled: boolean;/**+ * The SQL review rules to enforce.+ ** @generated from field: repeated bytebase.v1.SQLReviewRule rules = 7;*/rules: SQLReviewRule[];/*** resources using the config.- * Format: {resurce}/{resource id}, for example, environments/test.+ * Format: {resource}/{resource id}, for example, environments/test.** @generated from field: repeated string resources = 8;*/@@ -205,10 +211,13 @@ export declare type ReviewConfig = Message<"bytebase.v1.ReviewConfig"> & {export declare const ReviewConfigSchema: GenMessage<ReviewConfig>;/**+ * ReviewConfigService manages approval flow configurations.+ ** @generated from service bytebase.v1.ReviewConfigService*/export declare const ReviewConfigService: GenService<{/**+ * Creates a new SQL review configuration.* Permissions required: bb.reviewConfigs.create** @generated from rpc bytebase.v1.ReviewConfigService.CreateReviewConfig@@ -219,6 +228,7 @@ export declare const ReviewConfigService: GenService<{output: typeof ReviewConfigSchema;},/**+ * Lists all SQL review configurations.* Permissions required: bb.reviewConfigs.list** @generated from rpc bytebase.v1.ReviewConfigService.ListReviewConfigs@@ -229,6 +239,7 @@ export declare const ReviewConfigService: GenService<{output: typeof ListReviewConfigsResponseSchema;},/**+ * Retrieves a SQL review configuration by name.* Permissions required: bb.reviewConfigs.get** @generated from rpc bytebase.v1.ReviewConfigService.GetReviewConfig@@ -239,6 +250,7 @@ export declare const ReviewConfigService: GenService<{output: typeof ReviewConfigSchema;},/**+ * Updates a SQL review configuration.* Permissions required: bb.reviewConfigs.update** @generated from rpc bytebase.v1.ReviewConfigService.UpdateReviewConfig@@ -249,6 +261,7 @@ export declare const ReviewConfigService: GenService<{output: typeof ReviewConfigSchema;},/**+ * Deletes a SQL review configuration.* Permissions required: bb.reviewConfigs.delete** @generated from rpc bytebase.v1.ReviewConfigService.DeleteReviewConfigdiff --git a/frontend/src/types/proto-es/v1/review_config_service_pb.js b/frontend/src/types/proto-es/v1/review_config_service_pb.jsindex d3e99897ea..7f6fb14c8d 100644--- a/frontend/src/types/proto-es/v1/review_config_service_pb.js+++ b/frontend/src/types/proto-es/v1/review_config_service_pb.js@@ -67,6 +67,8 @@ export const ReviewConfigSchema = /*@__PURE__*/messageDesc(file_v1_review_config_service, 6);/**+ * ReviewConfigService manages approval flow configurations.+ ** @generated from service bytebase.v1.ReviewConfigService*/export const ReviewConfigService = /*@__PURE__*/diff --git a/frontend/src/types/proto-es/v1/revision_service_pb.d.ts b/frontend/src/types/proto-es/v1/revision_service_pb.d.tsindex 4dfcf5a900..f3a1316e43 100644--- a/frontend/src/types/proto-es/v1/revision_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/revision_service_pb.d.ts@@ -44,6 +44,8 @@ export declare type ListRevisionsRequest = Message<"bytebase.v1.ListRevisionsReqpageToken: string;/**+ * Whether to include deleted revisions in the results.+ ** @generated from field: bool show_deleted = 4;*/showDeleted: boolean;@@ -60,6 +62,8 @@ export declare const ListRevisionsRequestSchema: GenMessage<ListRevisionsRequest*/export declare type ListRevisionsResponse = Message<"bytebase.v1.ListRevisionsResponse"> & {/**+ * The revisions from the specified request.+ ** @generated from field: repeated bytebase.v1.Revision revisions = 1;*/revisions: Revision[];@@ -235,6 +239,8 @@ export declare type Revision = Message<"bytebase.v1.Revision"> & {file: string;/**+ * The schema version string for this revision.+ ** @generated from field: string version = 8;*/version: string;@@ -262,6 +268,8 @@ export declare type Revision = Message<"bytebase.v1.Revision"> & {statement: string;/**+ * The size of the statement in bytes.+ ** @generated from field: int64 statement_size = 12;*/statementSize: bigint;@@ -300,20 +308,28 @@ export declare type Revision = Message<"bytebase.v1.Revision"> & {export declare const RevisionSchema: GenMessage<Revision>;/**+ * The type of schema revision.+ ** @generated from enum bytebase.v1.Revision.Type*/export enum Revision_Type {/**+ * Unspecified type.+ ** @generated from enum value: TYPE_UNSPECIFIED = 0;*/TYPE_UNSPECIFIED = 0,/**+ * Versioned schema migration.+ ** @generated from enum value: VERSIONED = 1;*/VERSIONED = 1,/**+ * Declarative schema definition.+ ** @generated from enum value: DECLARATIVE = 2;*/DECLARATIVE = 2,@@ -325,10 +341,13 @@ export enum Revision_Type {export declare const Revision_TypeSchema: GenEnum<Revision_Type>;/**+ * RevisionService manages schema revision history.+ ** @generated from service bytebase.v1.RevisionService*/export declare const RevisionService: GenService<{/**+ * Lists schema revisions for a database.* Permissions required: bb.revisions.list** @generated from rpc bytebase.v1.RevisionService.ListRevisions@@ -339,6 +358,7 @@ export declare const RevisionService: GenService<{output: typeof ListRevisionsResponseSchema;},/**+ * Retrieves a schema revision by name.* Permissions required: bb.revisions.get** @generated from rpc bytebase.v1.RevisionService.GetRevision@@ -349,6 +369,7 @@ export declare const RevisionService: GenService<{output: typeof RevisionSchema;},/**+ * Creates a new schema revision.* Permissions required: bb.revisions.create** @generated from rpc bytebase.v1.RevisionService.CreateRevision@@ -359,6 +380,7 @@ export declare const RevisionService: GenService<{output: typeof RevisionSchema;},/**+ * Creates multiple schema revisions in a single operation.* Permissions required: bb.revisions.create** @generated from rpc bytebase.v1.RevisionService.BatchCreateRevisions@@ -369,6 +391,7 @@ export declare const RevisionService: GenService<{output: typeof BatchCreateRevisionsResponseSchema;},/**+ * Deletes a schema revision.* Permissions required: bb.revisions.delete** @generated from rpc bytebase.v1.RevisionService.DeleteRevisiondiff --git a/frontend/src/types/proto-es/v1/revision_service_pb.js b/frontend/src/types/proto-es/v1/revision_service_pb.jsindex 0a278cf641..eba5faeeeb 100644--- a/frontend/src/types/proto-es/v1/revision_service_pb.js+++ b/frontend/src/types/proto-es/v1/revision_service_pb.js@@ -79,12 +79,16 @@ export const Revision_TypeSchema = /*@__PURE__*/enumDesc(file_v1_revision_service, 7, 0);/**+ * The type of schema revision.+ ** @generated from enum bytebase.v1.Revision.Type*/export const Revision_Type = /*@__PURE__*/tsEnum(Revision_TypeSchema);/**+ * RevisionService manages schema revision history.+ ** @generated from service bytebase.v1.RevisionService*/export const RevisionService = /*@__PURE__*/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 867b3dcb5e..1e407c0fe6 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@@ -18,7 +18,7 @@ export declare const file_v1_risk_service: GenFile;*/export declare type ListRisksRequest = Message<"bytebase.v1.ListRisksRequest"> & {/**- * Not used.+ * Pagination is not currently implemented. This field is reserved for future use.* The maximum number of risks to return. The service may return fewer than* this value.* If unspecified, at most 10 risks will be returned.@@ -29,11 +29,11 @@ export declare type ListRisksRequest = Message<"bytebase.v1.ListRisksRequest"> &pageSize: number;/**- * Not used.+ * Pagination is not currently implemented. This field is reserved for future use.* A page token, received from a previous `ListRisks` call.* Provide this to retrieve the subsequent page.*- * When paginating, all other parameters provided to `LiskRisks` must match+ * When paginating, all other parameters provided to `ListRisks` must match* the call that provided the page token.** @generated from field: string page_token = 2;@@ -180,16 +180,22 @@ export declare type Risk = Message<"bytebase.v1.Risk"> & {source: Risk_Source;/**+ * The title of the risk rule.+ ** @generated from field: string title = 4;*/title: string;/**+ * The risk level assigned when this rule matches.+ ** @generated from field: bytebase.v1.RiskLevel level = 5;*/level: RiskLevel;/**+ * Whether the risk rule is active.+ ** @generated from field: bool active = 7;*/active: boolean;@@ -297,10 +303,13 @@ export enum Risk_Source {export declare const Risk_SourceSchema: GenEnum<Risk_Source>;/**+ * RiskService manages risk assessment rules for database changes.+ ** @generated from service bytebase.v1.RiskService*/export declare const RiskService: GenService<{/**+ * Lists all risk assessment rules.* Permissions required: bb.risks.list** @generated from rpc bytebase.v1.RiskService.ListRisks@@ -311,6 +320,7 @@ export declare const RiskService: GenService<{output: typeof ListRisksResponseSchema;},/**+ * Creates a new risk assessment rule.* Permissions required: bb.risks.create** @generated from rpc bytebase.v1.RiskService.CreateRisk@@ -321,6 +331,7 @@ export declare const RiskService: GenService<{output: typeof RiskSchema;},/**+ * Retrieves a risk assessment rule by name.* Permissions required: bb.risks.list** @generated from rpc bytebase.v1.RiskService.GetRisk@@ -331,6 +342,7 @@ export declare const RiskService: GenService<{output: typeof RiskSchema;},/**+ * Updates an existing risk assessment rule.* Permissions required: bb.risks.update** @generated from rpc bytebase.v1.RiskService.UpdateRisk@@ -341,6 +353,7 @@ export declare const RiskService: GenService<{output: typeof RiskSchema;},/**+ * Deletes a risk assessment rule.* Permissions required: bb.risks.delete** @generated from rpc bytebase.v1.RiskService.DeleteRiskdiff --git a/frontend/src/types/proto-es/v1/risk_service_pb.js b/frontend/src/types/proto-es/v1/risk_service_pb.jsindex b80ced1f88..8a287ff0f7 100644--- a/frontend/src/types/proto-es/v1/risk_service_pb.js+++ b/frontend/src/types/proto-es/v1/risk_service_pb.js@@ -80,6 +80,8 @@ export const Risk_Source = /*@__PURE__*/tsEnum(Risk_SourceSchema);/**+ * RiskService manages risk assessment rules for database changes.+ ** @generated from service bytebase.v1.RiskService*/export const RiskService = /*@__PURE__*/diff --git a/frontend/src/types/proto-es/v1/role_service_pb.d.ts b/frontend/src/types/proto-es/v1/role_service_pb.d.tsindex 6bbdee4b76..87a3c3656b 100644--- a/frontend/src/types/proto-es/v1/role_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/role_service_pb.d.ts@@ -16,7 +16,7 @@ export declare const file_v1_role_service: GenFile;*/export declare type ListRolesRequest = Message<"bytebase.v1.ListRolesRequest"> & {/**- * Not used.+ * Pagination is not currently implemented. This field is reserved for future use.* The maximum number of roles to return. The service may return fewer than* this value.* If unspecified, at most 10 reviews will be returned.@@ -27,7 +27,7 @@ export declare type ListRolesRequest = Message<"bytebase.v1.ListRolesRequest"> &pageSize: number;/**- * Not used.+ * Pagination is not currently implemented. This field is reserved for future use.* A page token, received from a previous `ListRoles` call.* Provide this to retrieve the subsequent page.*@@ -50,6 +50,8 @@ export declare const ListRolesRequestSchema: GenMessage<ListRolesRequest>;*/export declare type ListRolesResponse = Message<"bytebase.v1.ListRolesResponse"> & {/**+ * The roles from the specified request.+ ** @generated from field: repeated bytebase.v1.Role roles = 1;*/roles: Role[];@@ -74,6 +76,8 @@ export declare const ListRolesResponseSchema: GenMessage<ListRolesResponse>;*/export declare type CreateRoleRequest = Message<"bytebase.v1.CreateRoleRequest"> & {/**+ * The role to create.+ ** @generated from field: bytebase.v1.Role role = 1;*/role?: Role;@@ -120,17 +124,22 @@ export declare const GetRoleRequestSchema: GenMessage<GetRoleRequest>;*/export declare type UpdateRoleRequest = Message<"bytebase.v1.UpdateRoleRequest"> & {/**+ * The role to update.+ ** @generated from field: bytebase.v1.Role role = 1;*/role?: Role;/**+ * The list of fields to update.+ ** @generated from field: google.protobuf.FieldMask update_mask = 2;*/updateMask?: FieldMask;/*** If set to true, and the role is not found, a new role will be created.+ * In this situation, `update_mask` is ignored.** @generated from field: bool allow_missing = 3;*/@@ -148,6 +157,7 @@ export declare const UpdateRoleRequestSchema: GenMessage<UpdateRoleRequest>;*/export declare type DeleteRoleRequest = Message<"bytebase.v1.DeleteRoleRequest"> & {/**+ * The name of the role to delete.* Format: roles/{role}** @generated from field: string name = 1;@@ -162,32 +172,42 @@ export declare type DeleteRoleRequest = Message<"bytebase.v1.DeleteRoleRequest">export declare const DeleteRoleRequestSchema: GenMessage<DeleteRoleRequest>;/**+ * Role defines a set of permissions that can be assigned to users.+ ** @generated from message bytebase.v1.Role*/export declare type Role = Message<"bytebase.v1.Role"> & {/**- * Format: roles/{role}+ * Resource name. Format: roles/{role}** @generated from field: string name = 1;*/name: string;/**+ * Human-readable title.+ ** @generated from field: string title = 2;*/title: string;/**+ * Optional description of the role.+ ** @generated from field: string description = 3;*/description: string;/**+ * List of permission identifiers granted by this role.+ ** @generated from field: repeated string permissions = 4;*/permissions: string[];/**+ * Role type indicating if it's built-in or custom.+ ** @generated from field: bytebase.v1.Role.Type type = 5;*/type: Role_Type;@@ -209,11 +229,15 @@ export enum Role_Type {TYPE_UNSPECIFIED = 0,/**+ * System-defined role that cannot be modified.+ ** @generated from enum value: BUILT_IN = 1;*/BUILT_IN = 1,/**+ * User-defined role that can be modified.+ ** @generated from enum value: CUSTOM = 2;*/CUSTOM = 2,@@ -225,10 +249,13 @@ export enum Role_Type {export declare const Role_TypeSchema: GenEnum<Role_Type>;/**+ * RoleService manages workspace roles and permissions.+ ** @generated from service bytebase.v1.RoleService*/export declare const RoleService: GenService<{/**+ * Lists roles in the workspace.* Permissions required: bb.roles.list** @generated from rpc bytebase.v1.RoleService.ListRoles@@ -239,6 +266,7 @@ export declare const RoleService: GenService<{output: typeof ListRolesResponseSchema;},/**+ * Retrieves a role by name.* Permissions required: bb.roles.get** @generated from rpc bytebase.v1.RoleService.GetRole@@ -249,6 +277,7 @@ export declare const RoleService: GenService<{output: typeof RoleSchema;},/**+ * Creates a new custom role.* Permissions required: bb.roles.create** @generated from rpc bytebase.v1.RoleService.CreateRole@@ -259,6 +288,7 @@ export declare const RoleService: GenService<{output: typeof RoleSchema;},/**+ * Updates a role's properties.* Permissions required: bb.roles.update** @generated from rpc bytebase.v1.RoleService.UpdateRole@@ -269,6 +299,7 @@ export declare const RoleService: GenService<{output: typeof RoleSchema;},/**+ * Deletes a custom role.* Permissions required: bb.roles.delete** @generated from rpc bytebase.v1.RoleService.DeleteRolediff --git a/frontend/src/types/proto-es/v1/role_service_pb.js b/frontend/src/types/proto-es/v1/role_service_pb.jsindex 2a23c44c3f..bbfe1798de 100644--- a/frontend/src/types/proto-es/v1/role_service_pb.js+++ b/frontend/src/types/proto-es/v1/role_service_pb.js@@ -14,7 +14,7 @@ import { file_v1_annotation } from "./annotation_pb";* Describes the file v1/role_service.proto.*/export const file_v1_role_service = /*@__PURE__*/- fileDesc("ChV2MS9yb2xlX3NlcnZpY2UucHJvdG8SC2J5dGViYXNlLnYxIjkKEExpc3RSb2xlc1JlcXVlc3QSEQoJcGFnZV9zaXplGAEgASgFEhIKCnBhZ2VfdG9rZW4YAiABKAkiTgoRTGlzdFJvbGVzUmVzcG9uc2USIAoFcm9sZXMYASADKAsyES5ieXRlYmFzZS52MS5Sb2xlEhcKD25leHRfcGFnZV90b2tlbhgCIAEoCSJPChFDcmVhdGVSb2xlUmVxdWVzdBIkCgRyb2xlGAEgASgLMhEuYnl0ZWJhc2UudjEuUm9sZUID4EECEhQKB3JvbGVfaWQYAiABKAlCA+BBAiI5Cg5HZXRSb2xlUmVxdWVzdBInCgRuYW1lGAEgASgJQhngQQL6QRMKEWJ5dGViYXNlLmNvbS9Sb2xlInwKEVVwZGF0ZVJvbGVSZXF1ZXN0Eh8KBHJvbGUYASABKAsyES5ieXRlYmFzZS52MS5Sb2xlEi8KC3VwZGF0ZV9tYXNrGAIgASgLMhouZ29vZ2xlLnByb3RvYnVmLkZpZWxkTWFzaxIVCg1hbGxvd19taXNzaW5nGAMgASgIIjwKEURlbGV0ZVJvbGVSZXF1ZXN0EicKBG5hbWUYASABKAlCGeBBAvpBEwoRYnl0ZWJhc2UuY29tL1JvbGUi0QEKBFJvbGUSDAoEbmFtZRgBIAEoCRINCgV0aXRsZRgCIAEoCRITCgtkZXNjcmlwdGlvbhgDIAEoCRITCgtwZXJtaXNzaW9ucxgEIAMoCRIkCgR0eXBlGAUgASgOMhYuYnl0ZWJhc2UudjEuUm9sZS5UeXBlIjYKBFR5cGUSFAoQVFlQRV9VTlNQRUNJRklFRBAAEgwKCEJVSUxUX0lOEAESCgoGQ1VTVE9NEAI6JOpBIQoRYnl0ZWJhc2UuY29tL1JvbGUSDHJvbGVzL3tyb2xlfTKEBQoLUm9sZVNlcnZpY2UScgoJTGlzdFJvbGVzEh0uYnl0ZWJhc2UudjEuTGlzdFJvbGVzUmVxdWVzdBoeLmJ5dGViYXNlLnYxLkxpc3RSb2xlc1Jlc3BvbnNlIiaK6jANYmIucm9sZXMubGlzdJDqMAGC0+STAgsSCS92MS9yb2xlcxJwCgdHZXRSb2xlEhsuYnl0ZWJhc2UudjEuR2V0Um9sZVJlcXVlc3QaES5ieXRlYmFzZS52MS5Sb2xlIjXaQQRuYW1liuowDGJiLnJvbGVzLmdldJDqMAGC0+STAhQSEi92MS97bmFtZT1yb2xlcy8qfRJzCgpDcmVhdGVSb2xlEh4uYnl0ZWJhc2UudjEuQ3JlYXRlUm9sZVJlcXVlc3QaES5ieXRlYmFzZS52MS5Sb2xlIjKK6jAPYmIucm9sZXMuY3JlYXRlkOowAZjqMAGC0+STAhE6BHJvbGUiCS92MS9yb2xlcxKUAQoKVXBkYXRlUm9sZRIeLmJ5dGViYXNlLnYxLlVwZGF0ZVJvbGVSZXF1ZXN0GhEuYnl0ZWJhc2UudjEuUm9sZSJT2kEQcm9sZSx1cGRhdGVfbWFza4rqMA9iYi5yb2xlcy51cGRhdGWQ6jABmOowAYLT5JMCHzoEcm9sZTIXL3YxL3tyb2xlLm5hbWU9cm9sZXMvKn0SggEKCkRlbGV0ZVJvbGUSHi5ieXRlYmFzZS52MS5EZWxldGVSb2xlUmVxdWVzdBoWLmdvb2dsZS5wcm90b2J1Zi5FbXB0eSI82kEEbmFtZYrqMA9iYi5yb2xlcy5kZWxldGWQ6jABmOowAYLT5JMCFCoSL3YxL3tuYW1lPXJvbGVzLyp9QjZaNGdpdGh1Yi5jb20vYnl0ZWJhc2UvYnl0ZWJhc2UvYmFja2VuZC9nZW5lcmF0ZWQtZ28vdjFiBnByb3RvMw", [file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_api_resource, file_google_protobuf_empty, file_google_protobuf_field_mask, file_v1_annotation]);+ fileDesc("ChV2MS9yb2xlX3NlcnZpY2UucHJvdG8SC2J5dGViYXNlLnYxIjkKEExpc3RSb2xlc1JlcXVlc3QSEQoJcGFnZV9zaXplGAEgASgFEhIKCnBhZ2VfdG9rZW4YAiABKAkiTgoRTGlzdFJvbGVzUmVzcG9uc2USIAoFcm9sZXMYASADKAsyES5ieXRlYmFzZS52MS5Sb2xlEhcKD25leHRfcGFnZV90b2tlbhgCIAEoCSJPChFDcmVhdGVSb2xlUmVxdWVzdBIkCgRyb2xlGAEgASgLMhEuYnl0ZWJhc2UudjEuUm9sZUID4EECEhQKB3JvbGVfaWQYAiABKAlCA+BBAiI5Cg5HZXRSb2xlUmVxdWVzdBInCgRuYW1lGAEgASgJQhngQQL6QRMKEWJ5dGViYXNlLmNvbS9Sb2xlIoEBChFVcGRhdGVSb2xlUmVxdWVzdBIkCgRyb2xlGAEgASgLMhEuYnl0ZWJhc2UudjEuUm9sZUID4EECEi8KC3VwZGF0ZV9tYXNrGAIgASgLMhouZ29vZ2xlLnByb3RvYnVmLkZpZWxkTWFzaxIVCg1hbGxvd19taXNzaW5nGAMgASgIIjwKEURlbGV0ZVJvbGVSZXF1ZXN0EicKBG5hbWUYASABKAlCGeBBAvpBEwoRYnl0ZWJhc2UuY29tL1JvbGUi0QEKBFJvbGUSDAoEbmFtZRgBIAEoCRINCgV0aXRsZRgCIAEoCRITCgtkZXNjcmlwdGlvbhgDIAEoCRITCgtwZXJtaXNzaW9ucxgEIAMoCRIkCgR0eXBlGAUgASgOMhYuYnl0ZWJhc2UudjEuUm9sZS5UeXBlIjYKBFR5cGUSFAoQVFlQRV9VTlNQRUNJRklFRBAAEgwKCEJVSUxUX0lOEAESCgoGQ1VTVE9NEAI6JOpBIQoRYnl0ZWJhc2UuY29tL1JvbGUSDHJvbGVzL3tyb2xlfTKEBQoLUm9sZVNlcnZpY2UScgoJTGlzdFJvbGVzEh0uYnl0ZWJhc2UudjEuTGlzdFJvbGVzUmVxdWVzdBoeLmJ5dGViYXNlLnYxLkxpc3RSb2xlc1Jlc3BvbnNlIiaK6jANYmIucm9sZXMubGlzdJDqMAGC0+STAgsSCS92MS9yb2xlcxJwCgdHZXRSb2xlEhsuYnl0ZWJhc2UudjEuR2V0Um9sZVJlcXVlc3QaES5ieXRlYmFzZS52MS5Sb2xlIjXaQQRuYW1liuowDGJiLnJvbGVzLmdldJDqMAGC0+STAhQSEi92MS97bmFtZT1yb2xlcy8qfRJzCgpDcmVhdGVSb2xlEh4uYnl0ZWJhc2UudjEuQ3JlYXRlUm9sZVJlcXVlc3QaES5ieXRlYmFzZS52MS5Sb2xlIjKK6jAPYmIucm9sZXMuY3JlYXRlkOowAZjqMAGC0+STAhE6BHJvbGUiCS92MS9yb2xlcxKUAQoKVXBkYXRlUm9sZRIeLmJ5dGViYXNlLnYxLlVwZGF0ZVJvbGVSZXF1ZXN0GhEuYnl0ZWJhc2UudjEuUm9sZSJT2kEQcm9sZSx1cGRhdGVfbWFza4rqMA9iYi5yb2xlcy51cGRhdGWQ6jABmOowAYLT5JMCHzoEcm9sZTIXL3YxL3tyb2xlLm5hbWU9cm9sZXMvKn0SggEKCkRlbGV0ZVJvbGUSHi5ieXRlYmFzZS52MS5EZWxldGVSb2xlUmVxdWVzdBoWLmdvb2dsZS5wcm90b2J1Zi5FbXB0eSI82kEEbmFtZYrqMA9iYi5yb2xlcy5kZWxldGWQ6jABmOowAYLT5JMCFCoSL3YxL3tuYW1lPXJvbGVzLyp9QjZaNGdpdGh1Yi5jb20vYnl0ZWJhc2UvYnl0ZWJhc2UvYmFja2VuZC9nZW5lcmF0ZWQtZ28vdjFiBnByb3RvMw", [file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_api_resource, file_google_protobuf_empty, file_google_protobuf_field_mask, file_v1_annotation]);/*** Describes the message bytebase.v1.ListRolesRequest.@@ -78,6 +78,8 @@ export const Role_Type = /*@__PURE__*/tsEnum(Role_TypeSchema);/**+ * RoleService manages workspace roles and permissions.+ ** @generated from service bytebase.v1.RoleService*/export const RoleService = /*@__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 5d7b6f5786..e75ee9c6fd 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@@ -34,6 +34,8 @@ export declare type BatchRunTasksRequest = Message<"bytebase.v1.BatchRunTasksReqtasks: string[];/**+ * The reason for running the tasks.+ ** @generated from field: string reason = 3;*/reason: string;@@ -85,6 +87,8 @@ export declare type BatchSkipTasksRequest = Message<"bytebase.v1.BatchSkipTasksRtasks: string[];/**+ * The reason for skipping the tasks.+ ** @generated from field: string reason = 3;*/reason: string;@@ -130,6 +134,8 @@ export declare type BatchCancelTaskRunsRequest = Message<"bytebase.v1.BatchCancetaskRuns: string[];/**+ * The reason for canceling the task runs.+ ** @generated from field: string reason = 3;*/reason: string;@@ -341,7 +347,7 @@ export declare type ListTaskRunsRequest = Message<"bytebase.v1.ListTaskRunsRequeparent: string;/**- * Not used.+ * Pagination is not currently implemented. This field is reserved for future use.* The maximum number of taskRuns to return. The service may return fewer than* this value.* If unspecified, at most 10 taskRuns will be returned.@@ -352,7 +358,7 @@ export declare type ListTaskRunsRequest = Message<"bytebase.v1.ListTaskRunsRequepageSize: number;/**- * Not used.+ * Pagination is not currently implemented. This field is reserved for future use.* A page token, received from a previous `ListTaskRuns` call.* Provide this to retrieve the subsequent page.*@@ -530,6 +536,8 @@ export declare type Stage = Message<"bytebase.v1.Stage"> & {environment: string;/**+ * The tasks within this stage.+ ** @generated from field: repeated bytebase.v1.Task tasks = 5;*/tasks: Task[];@@ -568,6 +576,8 @@ export declare type Task = Message<"bytebase.v1.Task"> & {status: Task_Status;/**+ * The reason why the task was skipped.+ ** @generated from field: string skipped_reason = 15;*/skippedReason: string;@@ -632,6 +642,8 @@ export declare type Task = Message<"bytebase.v1.Task"> & {export declare const TaskSchema: GenMessage<Task>;/**+ * Payload for creating a new database.+ ** @generated from message bytebase.v1.Task.DatabaseCreate*/export declare type Task_DatabaseCreate = Message<"bytebase.v1.Task.DatabaseCreate"> & {@@ -665,16 +677,22 @@ export declare type Task_DatabaseCreate = Message<"bytebase.v1.Task.DatabaseCreasheet: string;/**+ * The character set for the database.+ ** @generated from field: string character_set = 5;*/characterSet: string;/**+ * The collation for the database.+ ** @generated from field: string collation = 6;*/collation: string;/**+ * The environment the database belongs to.+ ** @generated from field: string environment = 7;*/environment: string;@@ -687,6 +705,8 @@ export declare type Task_DatabaseCreate = Message<"bytebase.v1.Task.DatabaseCreaexport declare const Task_DatabaseCreateSchema: GenMessage<Task_DatabaseCreate>;/**+ * Payload for updating a database schema.+ ** @generated from message bytebase.v1.Task.DatabaseUpdate*/export declare type Task_DatabaseUpdate = Message<"bytebase.v1.Task.DatabaseUpdate"> & {@@ -698,11 +718,15 @@ export declare type Task_DatabaseUpdate = Message<"bytebase.v1.Task.DatabaseUpdasheet: string;/**+ * The target schema version after this update.+ ** @generated from field: string schema_version = 2;*/schemaVersion: string;/**+ * The type of database change (MIGRATE or SDL).+ ** @generated from field: bytebase.v1.DatabaseChangeType database_change_type = 3;*/databaseChangeType: DatabaseChangeType;@@ -722,6 +746,8 @@ export declare type Task_DatabaseUpdate = Message<"bytebase.v1.Task.DatabaseUpdaexport declare const Task_DatabaseUpdateSchema: GenMessage<Task_DatabaseUpdate>;/**+ * Payload for exporting database data.+ ** @generated from message bytebase.v1.Task.DatabaseDataExport*/export declare type Task_DatabaseDataExport = Message<"bytebase.v1.Task.DatabaseDataExport"> & {@@ -749,7 +775,7 @@ export declare type Task_DatabaseDataExport = Message<"bytebase.v1.Task.Databaseformat: ExportFormat;/**- * The zip password provide by users.+ * The zip password provided by users.* Leave it empty if no needs to encrypt the zip file.** @generated from field: optional string password = 4;@@ -768,41 +794,57 @@ export declare const Task_DatabaseDataExportSchema: GenMessage<Task_DatabaseData*/export enum Task_Status {/**+ * Unspecified status.+ ** @generated from enum value: STATUS_UNSPECIFIED = 0;*/STATUS_UNSPECIFIED = 0,/**+ * Task has not started and is awaiting its turn in the deployment sequence.+ ** @generated from enum value: NOT_STARTED = 1;*/NOT_STARTED = 1,/**+ * Task is ready to run and waiting for approval or scheduled time.+ ** @generated from enum value: PENDING = 2;*/PENDING = 2,/**+ * Task is currently executing.+ ** @generated from enum value: RUNNING = 3;*/RUNNING = 3,/**+ * Task completed successfully.+ ** @generated from enum value: DONE = 4;*/DONE = 4,/**+ * Task execution failed with errors.+ ** @generated from enum value: FAILED = 5;*/FAILED = 5,/**+ * Task execution was canceled by a user.+ ** @generated from enum value: CANCELED = 6;*/CANCELED = 6,/**+ * Task was skipped and will not be executed.+ ** @generated from enum value: SKIPPED = 7;*/SKIPPED = 7,@@ -818,38 +860,46 @@ export declare const Task_StatusSchema: GenEnum<Task_Status>;*/export enum Task_Type {/**+ * Unspecified task type.+ ** @generated from enum value: TYPE_UNSPECIFIED = 0;*/TYPE_UNSPECIFIED = 0,/**+ * General task for miscellaneous operations.+ ** @generated from enum value: GENERAL = 1;*/GENERAL = 1,/**- * use payload DatabaseCreate+ * Database creation task that creates a new database.+ * Use payload DatabaseCreate.** @generated from enum value: DATABASE_CREATE = 2;*/DATABASE_CREATE = 2,/**- * use payload DatabaseUpdate+ * Database migration task that applies versioned schema changes.+ * Use payload DatabaseUpdate.** @generated from enum value: DATABASE_MIGRATE = 3;*/DATABASE_MIGRATE = 3,/**- * use payload DatabaseUpdate+ * Database SDL (Schema Definition Language) task that synchronizes declarative schema.+ * Use payload DatabaseUpdate.** @generated from enum value: DATABASE_SDL = 6;*/DATABASE_SDL = 6,/**- * use payload DatabaseDataExport+ * Database export task that exports query results or table data.+ * Use payload DatabaseDataExport.** @generated from enum value: DATABASE_EXPORT = 5;*/@@ -873,7 +923,7 @@ export declare type TaskRun = Message<"bytebase.v1.TaskRun"> & {name: string;/**- * Format: user/[email protected]+ * Format: users/[email protected]** @generated from field: string creator = 3;*/@@ -890,12 +940,15 @@ export declare type TaskRun = Message<"bytebase.v1.TaskRun"> & {updateTime?: Timestamp;/**+ * The current execution status of the task run.+ ** @generated from field: bytebase.v1.TaskRun.Status status = 8;*/status: TaskRun_Status;/*** Below are the results of a task run.+ * Detailed information about the task run result.** @generated from field: string detail = 9;*/@@ -910,16 +963,22 @@ export declare type TaskRun = Message<"bytebase.v1.TaskRun"> & {changelog: string;/**+ * The schema version after this task run completes.+ ** @generated from field: string schema_version = 11;*/schemaVersion: string;/**+ * The time when the task run started execution.+ ** @generated from field: google.protobuf.Timestamp start_time = 14;*/startTime?: Timestamp;/**+ * The export archive status for data export tasks.+ ** @generated from field: bytebase.v1.TaskRun.ExportArchiveStatus export_archive_status = 16;*/exportArchiveStatus: TaskRun_ExportArchiveStatus;@@ -932,6 +991,8 @@ export declare type TaskRun = Message<"bytebase.v1.TaskRun"> & {priorBackupDetail?: TaskRun_PriorBackupDetail;/**+ * Scheduling information about the task run.+ ** @generated from field: bytebase.v1.TaskRun.SchedulerInfo scheduler_info = 18;*/schedulerInfo?: TaskRun_SchedulerInfo;@@ -959,10 +1020,14 @@ export declare type TaskRun = Message<"bytebase.v1.TaskRun"> & {export declare const TaskRunSchema: GenMessage<TaskRun>;/**+ * Prior backup detail for rollback purposes.+ ** @generated from message bytebase.v1.TaskRun.PriorBackupDetail*/export declare type TaskRun_PriorBackupDetail = Message<"bytebase.v1.TaskRun.PriorBackupDetail"> & {/**+ * The list of backed up tables.+ ** @generated from field: repeated bytebase.v1.TaskRun.PriorBackupDetail.Item items = 1;*/items: TaskRun_PriorBackupDetail_Item[];@@ -975,6 +1040,8 @@ export declare type TaskRun_PriorBackupDetail = Message<"bytebase.v1.TaskRun.Priexport declare const TaskRun_PriorBackupDetailSchema: GenMessage<TaskRun_PriorBackupDetail>;/**+ * A single backup table mapping.+ ** @generated from message bytebase.v1.TaskRun.PriorBackupDetail.Item*/export declare type TaskRun_PriorBackupDetail_Item = Message<"bytebase.v1.TaskRun.PriorBackupDetail.Item"> & {@@ -993,11 +1060,15 @@ export declare type TaskRun_PriorBackupDetail_Item = Message<"bytebase.v1.TaskRutargetTable?: TaskRun_PriorBackupDetail_Item_Table;/**+ * The start position in the SQL statement.+ ** @generated from field: bytebase.v1.Position start_position = 3;*/startPosition?: Position;/**+ * The end position in the SQL statement.+ ** @generated from field: bytebase.v1.Position end_position = 4;*/endPosition?: Position;@@ -1010,6 +1081,8 @@ export declare type TaskRun_PriorBackupDetail_Item = Message<"bytebase.v1.TaskRuexport declare const TaskRun_PriorBackupDetail_ItemSchema: GenMessage<TaskRun_PriorBackupDetail_Item>;/**+ * Table information.+ ** @generated from message bytebase.v1.TaskRun.PriorBackupDetail.Item.Table*/export declare type TaskRun_PriorBackupDetail_Item_Table = Message<"bytebase.v1.TaskRun.PriorBackupDetail.Item.Table"> & {@@ -1022,11 +1095,15 @@ export declare type TaskRun_PriorBackupDetail_Item_Table = Message<"bytebase.v1.database: string;/**+ * The schema name.+ ** @generated from field: string schema = 2;*/schema: string;/**+ * The table name.+ ** @generated from field: string table = 3;*/table: string;@@ -1039,15 +1116,21 @@ export declare type TaskRun_PriorBackupDetail_Item_Table = Message<"bytebase.v1.export declare const TaskRun_PriorBackupDetail_Item_TableSchema: GenMessage<TaskRun_PriorBackupDetail_Item_Table>;/**+ * Information about task run scheduling.+ ** @generated from message bytebase.v1.TaskRun.SchedulerInfo*/export declare type TaskRun_SchedulerInfo = Message<"bytebase.v1.TaskRun.SchedulerInfo"> & {/**+ * The time when the scheduling info was reported.+ ** @generated from field: google.protobuf.Timestamp report_time = 1;*/reportTime?: Timestamp;/**+ * The cause for the task run waiting.+ ** @generated from field: bytebase.v1.TaskRun.SchedulerInfo.WaitingCause waiting_cause = 2;*/waitingCause?: TaskRun_SchedulerInfo_WaitingCause;@@ -1060,26 +1143,36 @@ export declare type TaskRun_SchedulerInfo = Message<"bytebase.v1.TaskRun.Schedulexport declare const TaskRun_SchedulerInfoSchema: GenMessage<TaskRun_SchedulerInfo>;/**+ * Information about why a task run is waiting.+ ** @generated from message bytebase.v1.TaskRun.SchedulerInfo.WaitingCause*/export declare type TaskRun_SchedulerInfo_WaitingCause = Message<"bytebase.v1.TaskRun.SchedulerInfo.WaitingCause"> & {/**+ * The reason the task run is waiting.+ ** @generated from oneof bytebase.v1.TaskRun.SchedulerInfo.WaitingCause.cause*/cause: {/**+ * Waiting due to connection limit reached.+ ** @generated from field: bool connection_limit = 1;*/value: boolean;case: "connectionLimit";} | {/**+ * Waiting for another task to complete.+ ** @generated from field: bytebase.v1.TaskRun.SchedulerInfo.WaitingCause.Task task = 2;*/value: TaskRun_SchedulerInfo_WaitingCause_Task;case: "task";} | {/**+ * Waiting due to parallel tasks limit.+ ** @generated from field: bool parallel_tasks_limit = 3;*/value: boolean;@@ -1094,6 +1187,8 @@ export declare type TaskRun_SchedulerInfo_WaitingCause = Message<"bytebase.v1.Taexport declare const TaskRun_SchedulerInfo_WaitingCauseSchema: GenMessage<TaskRun_SchedulerInfo_WaitingCause>;/**+ * Information about a blocking task.+ ** @generated from message bytebase.v1.TaskRun.SchedulerInfo.WaitingCause.Task*/export declare type TaskRun_SchedulerInfo_WaitingCause_Task = Message<"bytebase.v1.TaskRun.SchedulerInfo.WaitingCause.Task"> & {@@ -1123,31 +1218,43 @@ export declare const TaskRun_SchedulerInfo_WaitingCause_TaskSchema: GenMessage<T*/export enum TaskRun_Status {/**+ * Unspecified status.+ ** @generated from enum value: STATUS_UNSPECIFIED = 0;*/STATUS_UNSPECIFIED = 0,/**+ * Task run is queued and waiting to start execution.+ ** @generated from enum value: PENDING = 1;*/PENDING = 1,/**+ * Task run is currently executing.+ ** @generated from enum value: RUNNING = 2;*/RUNNING = 2,/**+ * Task run completed successfully.+ ** @generated from enum value: DONE = 3;*/DONE = 3,/**+ * Task run execution failed with errors.+ ** @generated from enum value: FAILED = 4;*/FAILED = 4,/**+ * Task run execution was canceled by a user.+ ** @generated from enum value: CANCELED = 5;*/CANCELED = 5,@@ -1163,16 +1270,22 @@ export declare const TaskRun_StatusSchema: GenEnum<TaskRun_Status>;*/export enum TaskRun_ExportArchiveStatus {/**+ * Unspecified export archive status.+ ** @generated from enum value: EXPORT_ARCHIVE_STATUS_UNSPECIFIED = 0;*/EXPORT_ARCHIVE_STATUS_UNSPECIFIED = 0,/**+ * Export archive is ready for download.+ ** @generated from enum value: READY = 1;*/READY = 1,/**+ * Export archive has been downloaded by the user.+ ** @generated from enum value: EXPORTED = 2;*/EXPORTED = 2,@@ -1195,6 +1308,8 @@ export declare type TaskRunLog = Message<"bytebase.v1.TaskRunLog"> & {name: string;/**+ * The log entries for this task run.+ ** @generated from field: repeated bytebase.v1.TaskRunLogEntry entries = 2;*/entries: TaskRunLogEntry[];@@ -1211,56 +1326,78 @@ export declare const TaskRunLogSchema: GenMessage<TaskRunLog>;*/export declare type TaskRunLogEntry = Message<"bytebase.v1.TaskRunLogEntry"> & {/**+ * The type of this log entry.+ ** @generated from field: bytebase.v1.TaskRunLogEntry.Type type = 1;*/type: TaskRunLogEntry_Type;/**+ * The time when the log was recorded.+ ** @generated from field: google.protobuf.Timestamp log_time = 6;*/logTime?: Timestamp;/**+ * The deployment ID for this log entry.+ ** @generated from field: string deploy_id = 12;*/deployId: string;/**+ * Schema dump details (if type is SCHEMA_DUMP).+ ** @generated from field: bytebase.v1.TaskRunLogEntry.SchemaDump schema_dump = 2;*/schemaDump?: TaskRunLogEntry_SchemaDump;/**+ * Command execution details (if type is COMMAND_EXECUTE).+ ** @generated from field: bytebase.v1.TaskRunLogEntry.CommandExecute command_execute = 3;*/commandExecute?: TaskRunLogEntry_CommandExecute;/**+ * Database sync details (if type is DATABASE_SYNC).+ ** @generated from field: bytebase.v1.TaskRunLogEntry.DatabaseSync database_sync = 4;*/databaseSync?: TaskRunLogEntry_DatabaseSync;/**+ * Task run status update details (if type is TASK_RUN_STATUS_UPDATE).+ ** @generated from field: bytebase.v1.TaskRunLogEntry.TaskRunStatusUpdate task_run_status_update = 5;*/taskRunStatusUpdate?: TaskRunLogEntry_TaskRunStatusUpdate;/**+ * Transaction control details (if type is TRANSACTION_CONTROL).+ ** @generated from field: bytebase.v1.TaskRunLogEntry.TransactionControl transaction_control = 7;*/transactionControl?: TaskRunLogEntry_TransactionControl;/**+ * Prior backup details (if type is PRIOR_BACKUP).+ ** @generated from field: bytebase.v1.TaskRunLogEntry.PriorBackup prior_backup = 8;*/priorBackup?: TaskRunLogEntry_PriorBackup;/**+ * Retry information details (if type is RETRY_INFO).+ ** @generated from field: bytebase.v1.TaskRunLogEntry.RetryInfo retry_info = 9;*/retryInfo?: TaskRunLogEntry_RetryInfo;/**+ * Compute diff details (if type is COMPUTE_DIFF).+ ** @generated from field: bytebase.v1.TaskRunLogEntry.ComputeDiff compute_diff = 10;*/computeDiff?: TaskRunLogEntry_ComputeDiff;@@ -1273,20 +1410,28 @@ export declare type TaskRunLogEntry = Message<"bytebase.v1.TaskRunLogEntry"> & {export declare const TaskRunLogEntrySchema: GenMessage<TaskRunLogEntry>;/**+ * Schema dump operation details.+ ** @generated from message bytebase.v1.TaskRunLogEntry.SchemaDump*/export declare type TaskRunLogEntry_SchemaDump = Message<"bytebase.v1.TaskRunLogEntry.SchemaDump"> & {/**+ * When the schema dump started.+ ** @generated from field: google.protobuf.Timestamp start_time = 1;*/startTime?: Timestamp;/**+ * When the schema dump ended.+ ** @generated from field: google.protobuf.Timestamp end_time = 2;*/endTime?: Timestamp;/**+ * Error message if the schema dump failed.+ ** @generated from field: string error = 3;*/error: string;@@ -1299,10 +1444,14 @@ export declare type TaskRunLogEntry_SchemaDump = Message<"bytebase.v1.TaskRunLogexport declare const TaskRunLogEntry_SchemaDumpSchema: GenMessage<TaskRunLogEntry_SchemaDump>;/**+ * Command execution details.+ ** @generated from message bytebase.v1.TaskRunLogEntry.CommandExecute*/export declare type TaskRunLogEntry_CommandExecute = Message<"bytebase.v1.TaskRunLogEntry.CommandExecute"> & {/**+ * When the command was logged.+ ** @generated from field: google.protobuf.Timestamp log_time = 1;*/logTime?: Timestamp;@@ -1323,6 +1472,8 @@ export declare type TaskRunLogEntry_CommandExecute = Message<"bytebase.v1.TaskRustatement: string;/**+ * The response from executing the command.+ ** @generated from field: bytebase.v1.TaskRunLogEntry.CommandExecute.CommandResponse response = 3;*/response?: TaskRunLogEntry_CommandExecute_CommandResponse;@@ -1335,20 +1486,28 @@ export declare type TaskRunLogEntry_CommandExecute = Message<"bytebase.v1.TaskRuexport declare const TaskRunLogEntry_CommandExecuteSchema: GenMessage<TaskRunLogEntry_CommandExecute>;/**+ * Command execution response.+ ** @generated from message bytebase.v1.TaskRunLogEntry.CommandExecute.CommandResponse*/export declare type TaskRunLogEntry_CommandExecute_CommandResponse = Message<"bytebase.v1.TaskRunLogEntry.CommandExecute.CommandResponse"> & {/**+ * When the response was logged.+ ** @generated from field: google.protobuf.Timestamp log_time = 1;*/logTime?: Timestamp;/**+ * Error message if command execution failed.+ ** @generated from field: string error = 2;*/error: string;/**+ * Total affected rows.+ ** @generated from field: int64 affected_rows = 3;*/affectedRows: bigint;@@ -1369,20 +1528,28 @@ export declare type TaskRunLogEntry_CommandExecute_CommandResponse = Message<"byexport declare const TaskRunLogEntry_CommandExecute_CommandResponseSchema: GenMessage<TaskRunLogEntry_CommandExecute_CommandResponse>;/**+ * Database synchronization details.+ ** @generated from message bytebase.v1.TaskRunLogEntry.DatabaseSync*/export declare type TaskRunLogEntry_DatabaseSync = Message<"bytebase.v1.TaskRunLogEntry.DatabaseSync"> & {/**+ * When the database sync started.+ ** @generated from field: google.protobuf.Timestamp start_time = 1;*/startTime?: Timestamp;/**+ * When the database sync ended.+ ** @generated from field: google.protobuf.Timestamp end_time = 2;*/endTime?: Timestamp;/**+ * Error message if sync failed.+ ** @generated from field: string error = 3;*/error: string;@@ -1395,10 +1562,14 @@ export declare type TaskRunLogEntry_DatabaseSync = Message<"bytebase.v1.TaskRunLexport declare const TaskRunLogEntry_DatabaseSyncSchema: GenMessage<TaskRunLogEntry_DatabaseSync>;/**+ * Task run status update details.+ ** @generated from message bytebase.v1.TaskRunLogEntry.TaskRunStatusUpdate*/export declare type TaskRunLogEntry_TaskRunStatusUpdate = Message<"bytebase.v1.TaskRunLogEntry.TaskRunStatusUpdate"> & {/**+ * The new status.+ ** @generated from field: bytebase.v1.TaskRunLogEntry.TaskRunStatusUpdate.Status status = 1;*/status: TaskRunLogEntry_TaskRunStatusUpdate_Status;@@ -1411,10 +1582,14 @@ export declare type TaskRunLogEntry_TaskRunStatusUpdate = Message<"bytebase.v1.Texport declare const TaskRunLogEntry_TaskRunStatusUpdateSchema: GenMessage<TaskRunLogEntry_TaskRunStatusUpdate>;/**+ * Internal status for task run execution.+ ** @generated from enum bytebase.v1.TaskRunLogEntry.TaskRunStatusUpdate.Status*/export enum TaskRunLogEntry_TaskRunStatusUpdate_Status {/**+ * Unspecified status.+ ** @generated from enum value: STATUS_UNSPECIFIED = 0;*/STATUS_UNSPECIFIED = 0,@@ -1440,15 +1615,21 @@ export enum TaskRunLogEntry_TaskRunStatusUpdate_Status {export declare const TaskRunLogEntry_TaskRunStatusUpdate_StatusSchema: GenEnum<TaskRunLogEntry_TaskRunStatusUpdate_Status>;/**+ * Transaction control operation details.+ ** @generated from message bytebase.v1.TaskRunLogEntry.TransactionControl*/export declare type TaskRunLogEntry_TransactionControl = Message<"bytebase.v1.TaskRunLogEntry.TransactionControl"> & {/**+ * The type of transaction control.+ ** @generated from field: bytebase.v1.TaskRunLogEntry.TransactionControl.Type type = 1;*/type: TaskRunLogEntry_TransactionControl_Type;/**+ * Error message if the operation failed.+ ** @generated from field: string error = 2;*/error: string;@@ -1461,25 +1642,35 @@ export declare type TaskRunLogEntry_TransactionControl = Message<"bytebase.v1.Taexport declare const TaskRunLogEntry_TransactionControlSchema: GenMessage<TaskRunLogEntry_TransactionControl>;/**+ * Transaction control type.+ ** @generated from enum bytebase.v1.TaskRunLogEntry.TransactionControl.Type*/export enum TaskRunLogEntry_TransactionControl_Type {/**+ * Unspecified type.+ ** @generated from enum value: TYPE_UNSPECIFIED = 0;*/TYPE_UNSPECIFIED = 0,/**+ * Begin transaction.+ ** @generated from enum value: BEGIN = 1;*/BEGIN = 1,/**+ * Commit transaction.+ ** @generated from enum value: COMMIT = 2;*/COMMIT = 2,/**+ * Rollback transaction.+ ** @generated from enum value: ROLLBACK = 3;*/ROLLBACK = 3,@@ -1491,25 +1682,35 @@ export enum TaskRunLogEntry_TransactionControl_Type {export declare const TaskRunLogEntry_TransactionControl_TypeSchema: GenEnum<TaskRunLogEntry_TransactionControl_Type>;/**+ * Prior backup operation details.+ ** @generated from message bytebase.v1.TaskRunLogEntry.PriorBackup*/export declare type TaskRunLogEntry_PriorBackup = Message<"bytebase.v1.TaskRunLogEntry.PriorBackup"> & {/**+ * When the backup started.+ ** @generated from field: google.protobuf.Timestamp start_time = 1;*/startTime?: Timestamp;/**+ * When the backup ended.+ ** @generated from field: google.protobuf.Timestamp end_time = 2;*/endTime?: Timestamp;/**+ * The backup details.+ ** @generated from field: bytebase.v1.TaskRun.PriorBackupDetail prior_backup_detail = 3;*/priorBackupDetail?: TaskRun_PriorBackupDetail;/**+ * Error message if the backup failed.+ ** @generated from field: string error = 4;*/error: string;@@ -1522,20 +1723,28 @@ export declare type TaskRunLogEntry_PriorBackup = Message<"bytebase.v1.TaskRunLoexport declare const TaskRunLogEntry_PriorBackupSchema: GenMessage<TaskRunLogEntry_PriorBackup>;/**+ * Retry information for failed operations.+ ** @generated from message bytebase.v1.TaskRunLogEntry.RetryInfo*/export declare type TaskRunLogEntry_RetryInfo = Message<"bytebase.v1.TaskRunLogEntry.RetryInfo"> & {/**+ * The error that triggered the retry.+ ** @generated from field: string error = 1;*/error: string;/**+ * Current retry attempt number.+ ** @generated from field: int32 retry_count = 2;*/retryCount: number;/**+ * Maximum number of retries allowed.+ ** @generated from field: int32 maximum_retries = 3;*/maximumRetries: number;@@ -1548,20 +1757,28 @@ export declare type TaskRunLogEntry_RetryInfo = Message<"bytebase.v1.TaskRunLogEexport declare const TaskRunLogEntry_RetryInfoSchema: GenMessage<TaskRunLogEntry_RetryInfo>;/**+ * Schema diff computation details.+ ** @generated from message bytebase.v1.TaskRunLogEntry.ComputeDiff*/export declare type TaskRunLogEntry_ComputeDiff = Message<"bytebase.v1.TaskRunLogEntry.ComputeDiff"> & {/**+ * When diff computation started.+ ** @generated from field: google.protobuf.Timestamp start_time = 1;*/startTime?: Timestamp;/**+ * When diff computation ended.+ ** @generated from field: google.protobuf.Timestamp end_time = 2;*/endTime?: Timestamp;/**+ * Error message if computation failed.+ ** @generated from field: string error = 3;*/error: string;@@ -1574,50 +1791,70 @@ export declare type TaskRunLogEntry_ComputeDiff = Message<"bytebase.v1.TaskRunLoexport declare const TaskRunLogEntry_ComputeDiffSchema: GenMessage<TaskRunLogEntry_ComputeDiff>;/**+ * The type of log entry.+ ** @generated from enum bytebase.v1.TaskRunLogEntry.Type*/export enum TaskRunLogEntry_Type {/**+ * Unspecified type.+ ** @generated from enum value: TYPE_UNSPECIFIED = 0;*/TYPE_UNSPECIFIED = 0,/**+ * Schema dump operation.+ ** @generated from enum value: SCHEMA_DUMP = 1;*/SCHEMA_DUMP = 1,/**+ * Command execution.+ ** @generated from enum value: COMMAND_EXECUTE = 2;*/COMMAND_EXECUTE = 2,/**+ * Database synchronization.+ ** @generated from enum value: DATABASE_SYNC = 3;*/DATABASE_SYNC = 3,/**+ * Task run status update.+ ** @generated from enum value: TASK_RUN_STATUS_UPDATE = 4;*/TASK_RUN_STATUS_UPDATE = 4,/**+ * Transaction control (BEGIN, COMMIT, ROLLBACK).+ ** @generated from enum value: TRANSACTION_CONTROL = 5;*/TRANSACTION_CONTROL = 5,/**+ * Prior backup operation.+ ** @generated from enum value: PRIOR_BACKUP = 6;*/PRIOR_BACKUP = 6,/**+ * Retry information.+ ** @generated from enum value: RETRY_INFO = 7;*/RETRY_INFO = 7,/**+ * Schema diff computation.+ ** @generated from enum value: COMPUTE_DIFF = 8;*/COMPUTE_DIFF = 8,@@ -1658,10 +1895,14 @@ export declare type TaskRunSession = Message<"bytebase.v1.TaskRunSession"> & {name: string;/**+ * Database-specific session information.+ ** @generated from oneof bytebase.v1.TaskRunSession.session*/session: {/**+ * PostgreSQL session information.+ ** @generated from field: bytebase.v1.TaskRunSession.Postgres postgres = 2;*/value: TaskRunSession_Postgres;@@ -1676,6 +1917,8 @@ export declare type TaskRunSession = Message<"bytebase.v1.TaskRunSession"> & {export declare const TaskRunSessionSchema: GenMessage<TaskRunSession>;/**+ * PostgreSQL session information.+ ** @generated from message bytebase.v1.TaskRunSession.Postgres*/export declare type TaskRunSession_Postgres = Message<"bytebase.v1.TaskRunSession.Postgres"> & {@@ -1708,77 +1951,105 @@ export declare type TaskRunSession_Postgres = Message<"bytebase.v1.TaskRunSessioexport declare const TaskRunSession_PostgresSchema: GenMessage<TaskRunSession_Postgres>;/**- * Read from `pg_stat_activity`+ * PostgreSQL session information read from `pg_stat_activity`.** @generated from message bytebase.v1.TaskRunSession.Postgres.Session*/export declare type TaskRunSession_Postgres_Session = Message<"bytebase.v1.TaskRunSession.Postgres.Session"> & {/**+ * Process ID of the session.+ ** @generated from field: string pid = 1;*/pid: string;/**+ * PIDs of sessions blocking this session.+ ** @generated from field: repeated string blocked_by_pids = 2;*/blockedByPids: string[];/**+ * Current query being executed.+ ** @generated from field: string query = 3;*/query: string;/**+ * Session state (active, idle, etc.).+ ** @generated from field: optional string state = 4;*/state?: string;/**+ * Wait event type if session is waiting.+ ** @generated from field: optional string wait_event_type = 5;*/waitEventType?: string;/**+ * Specific wait event if session is waiting.+ ** @generated from field: optional string wait_event = 6;*/waitEvent?: string;/**+ * Database name.+ ** @generated from field: optional string datname = 7;*/datname?: string;/**+ * User name.+ ** @generated from field: optional string usename = 8;*/usename?: string;/**+ * Application name.+ ** @generated from field: string application_name = 9;*/applicationName: string;/**+ * Client IP address.+ ** @generated from field: optional string client_addr = 10;*/clientAddr?: string;/**+ * Client port number.+ ** @generated from field: optional string client_port = 11;*/clientPort?: string;/**+ * When the backend process started.+ ** @generated from field: google.protobuf.Timestamp backend_start = 12;*/backendStart?: Timestamp;/**+ * When the current transaction started.+ ** @generated from field: optional google.protobuf.Timestamp xact_start = 13;*/xactStart?: Timestamp;/**+ * When the current query started.+ ** @generated from field: optional google.protobuf.Timestamp query_start = 14;*/queryStart?: Timestamp;@@ -1813,6 +2084,8 @@ export declare const PreviewTaskRunRollbackRequestSchema: GenMessage<PreviewTask*/export declare type PreviewTaskRunRollbackResponse = Message<"bytebase.v1.PreviewTaskRunRollbackResponse"> & {/**+ * The rollback SQL statement that would undo the task run.+ ** @generated from field: string statement = 1;*/statement: string;@@ -1825,10 +2098,13 @@ export declare type PreviewTaskRunRollbackResponse = Message<"bytebase.v1.Previeexport declare const PreviewTaskRunRollbackResponseSchema: GenMessage<PreviewTaskRunRollbackResponse>;/**+ * RolloutService manages the execution of deployment plans.+ ** @generated from service bytebase.v1.RolloutService*/export declare const RolloutService: GenService<{/**+ * Retrieves a rollout by name.* Permissions required: bb.rollouts.get** @generated from rpc bytebase.v1.RolloutService.GetRollout@@ -1839,6 +2115,7 @@ export declare const RolloutService: GenService<{output: typeof RolloutSchema;},/**+ * Lists rollouts in a project.* Permissions required: bb.rollouts.list** @generated from rpc bytebase.v1.RolloutService.ListRollouts@@ -1849,6 +2126,7 @@ export declare const RolloutService: GenService<{output: typeof ListRolloutsResponseSchema;},/**+ * Creates a new rollout from a plan.* Permissions required: bb.rollouts.create** @generated from rpc bytebase.v1.RolloutService.CreateRollout@@ -1859,6 +2137,7 @@ export declare const RolloutService: GenService<{output: typeof RolloutSchema;},/**+ * Previews the rollout that would be created from a plan.* Permissions required: bb.rollouts.preview** @generated from rpc bytebase.v1.RolloutService.PreviewRollout@@ -1869,6 +2148,7 @@ export declare const RolloutService: GenService<{output: typeof RolloutSchema;},/**+ * Lists task run executions for a task.* Permissions required: bb.taskRuns.list** @generated from rpc bytebase.v1.RolloutService.ListTaskRuns@@ -1879,6 +2159,7 @@ export declare const RolloutService: GenService<{output: typeof ListTaskRunsResponseSchema;},/**+ * Retrieves a task run by name.* Permissions required: bb.taskRuns.list** @generated from rpc bytebase.v1.RolloutService.GetTaskRun@@ -1889,6 +2170,7 @@ export declare const RolloutService: GenService<{output: typeof TaskRunSchema;},/**+ * Retrieves execution logs for a task run.* Permissions required: bb.taskRuns.list** @generated from rpc bytebase.v1.RolloutService.GetTaskRunLog@@ -1899,6 +2181,7 @@ export declare const RolloutService: GenService<{output: typeof TaskRunLogSchema;},/**+ * Retrieves database session information for a running task.* Permissions required: bb.taskRuns.list** @generated from rpc bytebase.v1.RolloutService.GetTaskRunSession@@ -1909,7 +2192,8 @@ export declare const RolloutService: GenService<{output: typeof TaskRunSessionSchema;},/**- * Permissions required: None+ * Executes multiple tasks in a rollout stage.+ * Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)** @generated from rpc bytebase.v1.RolloutService.BatchRunTasks*/@@ -1919,7 +2203,8 @@ export declare const RolloutService: GenService<{output: typeof BatchRunTasksResponseSchema;},/**- * Permissions required: None+ * Skips multiple tasks in a rollout stage.+ * Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)** @generated from rpc bytebase.v1.RolloutService.BatchSkipTasks*/@@ -1929,7 +2214,8 @@ export declare const RolloutService: GenService<{output: typeof BatchSkipTasksResponseSchema;},/**- * Permissions required: None+ * Cancels multiple running task executions.+ * Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)** @generated from rpc bytebase.v1.RolloutService.BatchCancelTaskRuns*/@@ -1939,6 +2225,7 @@ export declare const RolloutService: GenService<{output: typeof BatchCancelTaskRunsResponseSchema;},/**+ * Generates rollback SQL for a completed task run.* Permissions required: bb.taskRuns.list** @generated from rpc bytebase.v1.RolloutService.PreviewTaskRunRollbackdiff --git a/frontend/src/types/proto-es/v1/rollout_service_pb.js b/frontend/src/types/proto-es/v1/rollout_service_pb.jsindex 47a35eaf13..900b3182dc 100644--- a/frontend/src/types/proto-es/v1/rollout_service_pb.js+++ b/frontend/src/types/proto-es/v1/rollout_service_pb.js@@ -318,6 +318,8 @@ export const TaskRunLogEntry_TaskRunStatusUpdate_StatusSchema = /*@__PURE__*/enumDesc(file_v1_rollout_service, 20, 3, 0);/**+ * Internal status for task run execution.+ ** @generated from enum bytebase.v1.TaskRunLogEntry.TaskRunStatusUpdate.Status*/export const TaskRunLogEntry_TaskRunStatusUpdate_Status = /*@__PURE__*/@@ -337,6 +339,8 @@ export const TaskRunLogEntry_TransactionControl_TypeSchema = /*@__PURE__*/enumDesc(file_v1_rollout_service, 20, 4, 0);/**+ * Transaction control type.+ ** @generated from enum bytebase.v1.TaskRunLogEntry.TransactionControl.Type*/export const TaskRunLogEntry_TransactionControl_Type = /*@__PURE__*/@@ -370,6 +374,8 @@ export const TaskRunLogEntry_TypeSchema = /*@__PURE__*/enumDesc(file_v1_rollout_service, 20, 0);/**+ * The type of log entry.+ ** @generated from enum bytebase.v1.TaskRunLogEntry.Type*/export const TaskRunLogEntry_Type = /*@__PURE__*/@@ -418,6 +424,8 @@ export const PreviewTaskRunRollbackResponseSchema = /*@__PURE__*/messageDesc(file_v1_rollout_service, 24);/**+ * RolloutService manages the execution of deployment plans.+ ** @generated from service bytebase.v1.RolloutService*/export const RolloutService = /*@__PURE__*/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 042c3bdbd5..436d62f1b0 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@@ -21,7 +21,7 @@ export declare const file_v1_setting_service: GenFile;*/export declare type ListSettingsRequest = Message<"bytebase.v1.ListSettingsRequest"> & {/**- * Not used.+ * Pagination is not currently implemented. This field is reserved for future use.* The maximum number of settings to return. The service may return fewer than* this value.* If unspecified, at most 10 settings will be returned.@@ -32,7 +32,7 @@ export declare type ListSettingsRequest = Message<"bytebase.v1.ListSettingsRequepageSize: number;/**- * Not used.+ * Pagination is not currently implemented. This field is reserved for future use.* A page token, received from a previous `ListSettings` call.* Provide this to retrieve the subsequent page.*@@ -169,7 +169,7 @@ export declare type Setting = Message<"bytebase.v1.Setting"> & {name: string;/**- * The value of the setting.+ * The configuration value of the setting.** @generated from field: bytebase.v1.Value value = 2;*/@@ -631,14 +631,14 @@ export declare const WorkspaceProfileSettingSchema: GenMessage<WorkspaceProfileS*/export declare type Announcement = Message<"bytebase.v1.Announcement"> & {/**- * The alert level of announcemnt+ * The alert level of announcement** @generated from field: bytebase.v1.Announcement.AlertLevel level = 1;*/level: Announcement_AlertLevel;/**- * The text of announcemnt+ * The text of announcement** @generated from field: string text = 2;*/@@ -1473,10 +1473,13 @@ export enum DatabaseChangeMode {export declare const DatabaseChangeModeSchema: GenEnum<DatabaseChangeMode>;/**+ * SettingService manages workspace-level settings and configurations.+ ** @generated from service bytebase.v1.SettingService*/export declare const SettingService: GenService<{/**+ * Lists all workspace settings.* Permissions required: bb.settings.list** @generated from rpc bytebase.v1.SettingService.ListSettings@@ -1487,6 +1490,7 @@ export declare const SettingService: GenService<{output: typeof ListSettingsResponseSchema;},/**+ * Retrieves a workspace setting by name.* Permissions required: bb.settings.get** @generated from rpc bytebase.v1.SettingService.GetSetting@@ -1497,6 +1501,7 @@ export declare const SettingService: GenService<{output: typeof SettingSchema;},/**+ * Updates a workspace setting.* Permissions required: bb.settings.set** @generated from rpc bytebase.v1.SettingService.UpdateSettingdiff --git a/frontend/src/types/proto-es/v1/setting_service_pb.js b/frontend/src/types/proto-es/v1/setting_service_pb.jsindex f5dc33e751..162a4f5a47 100644--- a/frontend/src/types/proto-es/v1/setting_service_pb.js+++ b/frontend/src/types/proto-es/v1/setting_service_pb.js@@ -350,6 +350,8 @@ export const DatabaseChangeMode = /*@__PURE__*/tsEnum(DatabaseChangeModeSchema);/**+ * SettingService manages workspace-level settings and configurations.+ ** @generated from service bytebase.v1.SettingService*/export const SettingService = /*@__PURE__*/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 1e2b82467e..a914b32147 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@@ -150,9 +150,9 @@ export declare const UpdateSheetRequestSchema: GenMessage<UpdateSheetRequest>;*/export declare type Sheet = Message<"bytebase.v1.Sheet"> & {/**- * The name of the sheet resource, generated by the server.- * Canonical parent is project.+ * The name of the sheet resource.* Format: projects/{project}/sheets/{sheet}+ * The sheet ID is generated by the server on creation and cannot be changed.** @generated from field: string name = 1;*/@@ -197,6 +197,8 @@ export declare type Sheet = Message<"bytebase.v1.Sheet"> & {contentSize: bigint;/**+ * Additional metadata and configuration for the sheet.+ ** @generated from field: bytebase.v1.SheetPayload payload = 13;*/payload?: SheetPayload;@@ -282,10 +284,13 @@ export declare type SheetCommand = Message<"bytebase.v1.SheetCommand"> & {export declare const SheetCommandSchema: GenMessage<SheetCommand>;/**+ * SheetService manages SQL scripts and saved queries.+ ** @generated from service bytebase.v1.SheetService*/export declare const SheetService: GenService<{/**+ * Creates a new SQL sheet.* Permissions required: bb.sheets.create** @generated from rpc bytebase.v1.SheetService.CreateSheet@@ -296,6 +301,7 @@ export declare const SheetService: GenService<{output: typeof SheetSchema;},/**+ * Creates multiple SQL sheets in a single operation.* Permissions required: bb.sheets.create** @generated from rpc bytebase.v1.SheetService.BatchCreateSheets@@ -306,6 +312,7 @@ export declare const SheetService: GenService<{output: typeof BatchCreateSheetsResponseSchema;},/**+ * Retrieves a SQL sheet by name.* Permissions required: bb.sheets.get** @generated from rpc bytebase.v1.SheetService.GetSheet@@ -316,6 +323,7 @@ export declare const SheetService: GenService<{output: typeof SheetSchema;},/**+ * Updates a SQL sheet's title or content.* Permissions required: bb.sheets.update** @generated from rpc bytebase.v1.SheetService.UpdateSheetdiff --git a/frontend/src/types/proto-es/v1/sheet_service_pb.js b/frontend/src/types/proto-es/v1/sheet_service_pb.jsindex a92bea9973..97e175fcf1 100644--- a/frontend/src/types/proto-es/v1/sheet_service_pb.js+++ b/frontend/src/types/proto-es/v1/sheet_service_pb.js@@ -88,6 +88,8 @@ export const SheetCommandSchema = /*@__PURE__*/messageDesc(file_v1_sheet_service, 7);/**+ * SheetService manages SQL scripts and saved queries.+ ** @generated from service bytebase.v1.SheetService*/export const SheetService = /*@__PURE__*/diff --git a/frontend/src/types/proto-es/v1/sql_service_pb.d.ts b/frontend/src/types/proto-es/v1/sql_service_pb.d.tsindex 32a69d6b39..5f051e0a5e 100644--- a/frontend/src/types/proto-es/v1/sql_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/sql_service_pb.d.ts@@ -198,11 +198,15 @@ export enum QueryOption_RedisRunCommandsOn {REDIS_RUN_COMMANDS_ON_UNSPECIFIED = 0,/**+ * Execute Redis commands on a single node in the cluster.+ ** @generated from enum value: SINGLE_NODE = 1;*/SINGLE_NODE = 1,/**+ * Execute Redis commands on all nodes in the cluster for cluster-wide operations.+ ** @generated from enum value: ALL_NODES = 2;*/ALL_NODES = 2,@@ -430,38 +434,50 @@ export declare const QueryResult_MessageSchema: GenMessage<QueryResult_Message>;*/export enum QueryResult_Message_Level {/**- * Unspecified.+ * Unspecified message level.** @generated from enum value: LEVEL_UNSPECIFIED = 0;*/LEVEL_UNSPECIFIED = 0,/**+ * Informational message.+ ** @generated from enum value: INFO = 1;*/INFO = 1,/**+ * Warning message indicating potential issues.+ ** @generated from enum value: WARNING = 2;*/WARNING = 2,/**+ * Debug message for development and troubleshooting.+ ** @generated from enum value: DEBUG = 3;*/DEBUG = 3,/**+ * General log message.+ ** @generated from enum value: LOG = 4;*/LOG = 4,/**+ * Notice message for important information.+ ** @generated from enum value: NOTICE = 5;*/NOTICE = 5,/**+ * Exception message indicating error conditions.+ ** @generated from enum value: EXCEPTION = 6;*/EXCEPTION = 6,@@ -1139,7 +1155,7 @@ export declare type SearchQueryHistoriesRequest = Message<"bytebase.v1.SearchQue* - database: the database full name in "instances/{id}/databases/{name}" format, support "==" operator.* - instance: the instance full name in "instances/{id}" format, support "==" operator.* - type: the type, should be "QUERY" or "EXPORT", support "==" operator.- * - statement: the SQL statemnt, support ".matches()" operator.+ * - statement: the SQL statement, support ".matches()" operator.** For example:* project == "projects/{project}"@@ -1250,16 +1266,22 @@ export declare const QueryHistorySchema: GenMessage<QueryHistory>;*/export enum QueryHistory_Type {/**+ * Unspecified query history type.+ ** @generated from enum value: TYPE_UNSPECIFIED = 0;*/TYPE_UNSPECIFIED = 0,/**+ * Query execution for data retrieval.+ ** @generated from enum value: QUERY = 1;*/QUERY = 1,/**+ * Data export operation to file.+ ** @generated from enum value: EXPORT = 2;*/EXPORT = 2,@@ -1377,10 +1399,13 @@ export declare type AICompletionResponse_Candidate_Content_Part = Message<"bytebexport declare const AICompletionResponse_Candidate_Content_PartSchema: GenMessage<AICompletionResponse_Candidate_Content_Part>;/**+ * SQLService executes SQL queries and manages query operations.+ ** @generated from service bytebase.v1.SQLService*/export declare const SQLService: GenService<{/**+ * Executes a read-only SQL query against a database.* Permissions required: bb.databases.get** @generated from rpc bytebase.v1.SQLService.Query@@ -1391,6 +1416,7 @@ export declare const SQLService: GenService<{output: typeof QueryResponseSchema;},/**+ * Executes SQL with admin privileges via streaming connection.* Permissions required: bb.sql.admin** @generated from rpc bytebase.v1.SQLService.AdminExecute@@ -1402,7 +1428,7 @@ export declare const SQLService: GenService<{},/*** SearchQueryHistories searches query histories for the caller.- * Permissions required: None+ * Permissions required: None (only returns caller's own query histories)** @generated from rpc bytebase.v1.SQLService.SearchQueryHistories*/@@ -1412,6 +1438,7 @@ export declare const SQLService: GenService<{output: typeof SearchQueryHistoriesResponseSchema;},/**+ * Exports query results to a file format.* Permissions required: bb.databases.get** @generated from rpc bytebase.v1.SQLService.Export@@ -1422,6 +1449,7 @@ export declare const SQLService: GenService<{output: typeof ExportResponseSchema;},/**+ * Validates SQL statements against review rules.* Permissions required: bb.databases.check** @generated from rpc bytebase.v1.SQLService.Check@@ -1432,6 +1460,7 @@ export declare const SQLService: GenService<{output: typeof CheckResponseSchema;},/**+ * Formats and normalizes SQL schema definitions.* Permissions required: None** @generated from rpc bytebase.v1.SQLService.Pretty@@ -1442,6 +1471,7 @@ export declare const SQLService: GenService<{output: typeof PrettyResponseSchema;},/**+ * Computes schema differences between two database metadata.* Permissions required: None** @generated from rpc bytebase.v1.SQLService.DiffMetadata@@ -1452,7 +1482,8 @@ export declare const SQLService: GenService<{output: typeof DiffMetadataResponseSchema;},/**- * Permissions required: None+ * Provides AI-powered SQL completion and generation.+ * Permissions required: None (authenticated users only, requires AI to be enabled)** @generated from rpc bytebase.v1.SQLService.AICompletion*/diff --git a/frontend/src/types/proto-es/v1/sql_service_pb.js b/frontend/src/types/proto-es/v1/sql_service_pb.jsindex e5b09e427d..912219956d 100644--- a/frontend/src/types/proto-es/v1/sql_service_pb.js+++ b/frontend/src/types/proto-es/v1/sql_service_pb.js@@ -296,6 +296,8 @@ export const AICompletionResponse_Candidate_Content_PartSchema = /*@__PURE__*/messageDesc(file_v1_sql_service, 22, 0, 0, 0);/**+ * SQLService executes SQL queries and manages query operations.+ ** @generated from service bytebase.v1.SQLService*/export const SQLService = /*@__PURE__*/diff --git a/frontend/src/types/proto-es/v1/subscription_service_pb.d.ts b/frontend/src/types/proto-es/v1/subscription_service_pb.d.tsindex a6e462d381..331f192ed6 100644--- a/frontend/src/types/proto-es/v1/subscription_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/subscription_service_pb.d.ts@@ -154,21 +154,29 @@ export declare const PlanLimitConfigSchema: GenMessage<PlanLimitConfig>;*/export enum PlanType {/**+ * Unspecified plan type.+ ** @generated from enum value: PLAN_TYPE_UNSPECIFIED = 0;*/PLAN_TYPE_UNSPECIFIED = 0,/**+ * Free plan with basic features and no cost.+ ** @generated from enum value: FREE = 1;*/FREE = 1,/**+ * Team plan with collaboration features for small to medium teams.+ ** @generated from enum value: TEAM = 2;*/TEAM = 2,/**+ * Enterprise plan with advanced features and dedicated support.+ ** @generated from enum value: ENTERPRISE = 3;*/ENTERPRISE = 3,@@ -565,6 +573,8 @@ export enum PlanFeature {export declare const PlanFeatureSchema: GenEnum<PlanFeature>;/**+ * SubscriptionService manages enterprise subscriptions and licensing.+ ** @generated from service bytebase.v1.SubscriptionService*/export declare const SubscriptionService: GenService<{@@ -582,6 +592,7 @@ export declare const SubscriptionService: GenService<{output: typeof SubscriptionSchema;},/**+ * Updates the enterprise license subscription.* Permissions required: bb.settings.set** @generated from rpc bytebase.v1.SubscriptionService.UpdateSubscriptiondiff --git a/frontend/src/types/proto-es/v1/subscription_service_pb.js b/frontend/src/types/proto-es/v1/subscription_service_pb.jsindex 7ca136089d..1b4cd7c32a 100644--- a/frontend/src/types/proto-es/v1/subscription_service_pb.js+++ b/frontend/src/types/proto-es/v1/subscription_service_pb.js@@ -77,6 +77,8 @@ export const PlanFeature = /*@__PURE__*/tsEnum(PlanFeatureSchema);/**+ * SubscriptionService manages enterprise subscriptions and licensing.+ ** @generated from service bytebase.v1.SubscriptionService*/export const SubscriptionService = /*@__PURE__*/diff --git a/frontend/src/types/proto-es/v1/user_service_pb.d.ts b/frontend/src/types/proto-es/v1/user_service_pb.d.tsindex 7448656ca7..0804a5b851 100644--- a/frontend/src/types/proto-es/v1/user_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/user_service_pb.d.ts@@ -289,31 +289,43 @@ export declare type User = Message<"bytebase.v1.User"> & {name: string;/**+ * The lifecycle state of the user account.+ ** @generated from field: bytebase.v1.State state = 2;*/state: State;/**+ * The email address of the user, used for login and notifications.+ ** @generated from field: string email = 3;*/email: string;/**+ * The display title or full name of the user.+ ** @generated from field: string title = 4;*/title: string;/**+ * The type of user account.+ ** @generated from field: bytebase.v1.UserType user_type = 5;*/userType: UserType;/**+ * The password for authentication. Only used during user creation or password updates.+ ** @generated from field: string password = 7;*/password: string;/**+ * The service key for service account authentication. Only used for service accounts.+ ** @generated from field: string service_key = 8;*/serviceKey: string;@@ -348,6 +360,8 @@ export declare type User = Message<"bytebase.v1.User"> & {phone: string;/**+ * User profile metadata.+ ** @generated from field: bytebase.v1.User.Profile profile = 13;*/profile?: User_Profile;@@ -372,11 +386,15 @@ export declare const UserSchema: GenMessage<User>;*/export declare type User_Profile = Message<"bytebase.v1.User.Profile"> & {/**+ * The last time the user successfully logged in.+ ** @generated from field: google.protobuf.Timestamp last_login_time = 1;*/lastLoginTime?: Timestamp;/**+ * The last time the user changed their password.+ ** @generated from field: google.protobuf.Timestamp last_change_password_time = 2;*/lastChangePasswordTime?: Timestamp;@@ -400,21 +418,29 @@ export declare const User_ProfileSchema: GenMessage<User_Profile>;*/export enum UserType {/**+ * Unspecified user type.+ ** @generated from enum value: USER_TYPE_UNSPECIFIED = 0;*/USER_TYPE_UNSPECIFIED = 0,/**+ * Regular human user account.+ ** @generated from enum value: USER = 1;*/USER = 1,/**+ * System-managed bot account for automated operations.+ ** @generated from enum value: SYSTEM_BOT = 2;*/SYSTEM_BOT = 2,/**+ * Service account for API integrations.+ ** @generated from enum value: SERVICE_ACCOUNT = 3;*/SERVICE_ACCOUNT = 3,@@ -426,6 +452,8 @@ export enum UserType {export declare const UserTypeSchema: GenEnum<UserType>;/**+ * UserService manages user accounts and authentication.+ ** @generated from service bytebase.v1.UserService*/export declare const UserService: GenService<{@@ -477,10 +505,8 @@ export declare const UserService: GenService<{output: typeof ListUsersResponseSchema;},/**- * Create a user.- * When Disallow Signup is enabled, only the caller with bb.users.create on the workspace can create a user.- * Otherwise, any unauthenticated user can create a user.- * Permissions required: bb.users.create+ * Creates a user. When Disallow Signup is enabled, requires bb.users.create permission; otherwise any user can sign up.+ * Permissions required: bb.users.create (only when Disallow Signup is enabled)** @generated from rpc bytebase.v1.UserService.CreateUser*/@@ -490,8 +516,8 @@ export declare const UserService: GenService<{output: typeof UserSchema;},/**- * Only the user itself and the user with bb.users.update permission on the workspace can update the user.- * Permissions required: bb.users.update+ * Updates a user. Users can update their own profile, or users with bb.users.update permission can update any user.+ * Permissions required: bb.users.update (or self)** @generated from rpc bytebase.v1.UserService.UpdateUser*/@@ -501,8 +527,7 @@ export declare const UserService: GenService<{output: typeof UserSchema;},/**- * Only the user with bb.users.delete permission on the workspace can delete the user.- * The last remaining workspace admin cannot be deleted.+ * Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted.* Permissions required: bb.users.delete** @generated from rpc bytebase.v1.UserService.DeleteUser@@ -513,7 +538,7 @@ export declare const UserService: GenService<{output: typeof EmptySchema;},/**- * Only the user with bb.users.undelete permission on the workspace can undelete the user.+ * Restores a deleted user.* Permissions required: bb.users.undelete** @generated from rpc bytebase.v1.UserService.UndeleteUserdiff --git a/frontend/src/types/proto-es/v1/user_service_pb.js b/frontend/src/types/proto-es/v1/user_service_pb.jsindex 3b341ff3c1..4f8c7cfc8d 100644--- a/frontend/src/types/proto-es/v1/user_service_pb.js+++ b/frontend/src/types/proto-es/v1/user_service_pb.js@@ -107,6 +107,8 @@ export const UserType = /*@__PURE__*/tsEnum(UserTypeSchema);/**+ * UserService manages user accounts and authentication.+ ** @generated from service bytebase.v1.UserService*/export const UserService = /*@__PURE__*/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 fcd432a6e0..ebc8a90324 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@@ -193,7 +193,7 @@ export declare type SearchWorksheetsRequest = Message<"bytebase.v1.SearchWorkshefilter: string;/**- * Not used.+ * Pagination is not currently implemented. This field is reserved for future use.* The maximum number of worksheets to return. The service may return fewer than* this value.* If unspecified, at most 10 worksheets will be returned.@@ -204,7 +204,7 @@ export declare type SearchWorksheetsRequest = Message<"bytebase.v1.SearchWorkshepageSize: number;/**- * Not used.+ * Pagination is not currently implemented. This field is reserved for future use.* A page token, received from a previous `SearchWorksheets` call.* Provide this to retrieve the subsequent page.*@@ -234,7 +234,8 @@ export declare type SearchWorksheetsResponse = Message<"bytebase.v1.SearchWorkshworksheets: Worksheet[];/**- * Not used. A token, which can be sent as `page_token` to retrieve the next page.+ * Pagination is not currently implemented. This field is reserved for future use.+ * A token, which can be sent as `page_token` to retrieve the next page.* If this field is omitted, there are no subsequent pages.** @generated from field: string next_page_token = 2;@@ -379,12 +380,14 @@ export enum Worksheet_Visibility {export declare const Worksheet_VisibilitySchema: GenEnum<Worksheet_Visibility>;/**+ * WorksheetService manages SQL worksheets for query development.+ ** @generated from service bytebase.v1.WorksheetService*/export declare const WorksheetService: GenService<{/**- * Create a personal worksheet used in SQL Editor.- * Permissions required: None+ * Creates a personal worksheet used in SQL Editor. Any authenticated user can create their own worksheets.+ * Permissions required: None (authenticated users only)** @generated from rpc bytebase.v1.WorksheetService.CreateWorksheet*/@@ -399,7 +402,7 @@ export declare const WorksheetService: GenService<{* - they are the creator of the worksheet;* - they have bb.worksheets.get permission on the workspace;* - the sheet is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.- * Permissions required: None+ * Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)** @generated from rpc bytebase.v1.WorksheetService.GetWorksheet*/@@ -412,7 +415,7 @@ export declare const WorksheetService: GenService<{* Search for worksheets.* This is used for finding my worksheets or worksheets shared by other people.* The sheet accessibility is the same as GetWorksheet().- * Permissions required: None+ * Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)** @generated from rpc bytebase.v1.WorksheetService.SearchWorksheets*/@@ -427,7 +430,7 @@ export declare const WorksheetService: GenService<{* - they are the creator of the worksheet;* - they have bb.worksheets.manage permission on the workspace;* - the sheet is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.- * Permissions required: None+ * Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)** @generated from rpc bytebase.v1.WorksheetService.UpdateWorksheet*/@@ -439,7 +442,7 @@ export declare const WorksheetService: GenService<{/*** Update the organizer of a worksheet.* The access is the same as UpdateWorksheet method.- * Permissions required: None+ * Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)** @generated from rpc bytebase.v1.WorksheetService.UpdateWorksheetOrganizer*/@@ -451,7 +454,7 @@ export declare const WorksheetService: GenService<{/*** Delete a worksheet.* The access is the same as UpdateWorksheet method.- * Permissions required: None+ * Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)** @generated from rpc bytebase.v1.WorksheetService.DeleteWorksheet*/diff --git a/frontend/src/types/proto-es/v1/worksheet_service_pb.js b/frontend/src/types/proto-es/v1/worksheet_service_pb.jsindex 13ff994556..26a71c9c34 100644--- a/frontend/src/types/proto-es/v1/worksheet_service_pb.js+++ b/frontend/src/types/proto-es/v1/worksheet_service_pb.js@@ -91,6 +91,8 @@ export const Worksheet_Visibility = /*@__PURE__*/tsEnum(Worksheet_VisibilitySchema);/**+ * WorksheetService manages SQL worksheets for query development.+ ** @generated from service bytebase.v1.WorksheetService*/export const WorksheetService = /*@__PURE__*/diff --git a/frontend/src/types/proto-es/v1/workspace_service_pb.d.ts b/frontend/src/types/proto-es/v1/workspace_service_pb.d.tsindex 0aad0b8748..b65a130e55 100644--- a/frontend/src/types/proto-es/v1/workspace_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/workspace_service_pb.d.ts@@ -11,10 +11,13 @@ import type { GetIamPolicyRequestSchema, IamPolicySchema, SetIamPolicyRequestSchexport declare const file_v1_workspace_service: GenFile;/**+ * WorkspaceService manages workspace-level operations and profile.+ ** @generated from service bytebase.v1.WorkspaceService*/export declare const WorkspaceService: GenService<{/**+ * Retrieves IAM policy for the workspace.* Permissions required: bb.workspaces.getIamPolicy** @generated from rpc bytebase.v1.WorkspaceService.GetIamPolicy@@ -25,6 +28,7 @@ export declare const WorkspaceService: GenService<{output: typeof IamPolicySchema;},/**+ * Sets IAM policy for the workspace.* Permissions required: bb.workspaces.setIamPolicy** @generated from rpc bytebase.v1.WorkspaceService.SetIamPolicydiff --git a/frontend/src/types/proto-es/v1/workspace_service_pb.js b/frontend/src/types/proto-es/v1/workspace_service_pb.jsindex fa690d1003..9f34c06cb2 100644--- a/frontend/src/types/proto-es/v1/workspace_service_pb.js+++ b/frontend/src/types/proto-es/v1/workspace_service_pb.js@@ -14,6 +14,8 @@ export const file_v1_workspace_service = /*@__PURE__*/fileDesc("Chp2MS93b3Jrc3BhY2Vfc2VydmljZS5wcm90bxILYnl0ZWJhc2UudjEy1wIKEFdvcmtzcGFjZVNlcnZpY2USnAEKDEdldElhbVBvbGljeRIgLmJ5dGViYXNlLnYxLkdldElhbVBvbGljeVJlcXVlc3QaFi5ieXRlYmFzZS52MS5JYW1Qb2xpY3kiUorqMBpiYi53b3Jrc3BhY2VzLmdldElhbVBvbGljeZDqMAGC0+STAioSKC92MS97cmVzb3VyY2U9d29ya3NwYWNlcy8qfTpnZXRJYW1Qb2xpY3kSowEKDFNldElhbVBvbGljeRIgLmJ5dGViYXNlLnYxLlNldElhbVBvbGljeVJlcXVlc3QaFi5ieXRlYmFzZS52MS5JYW1Qb2xpY3kiWYrqMBpiYi53b3Jrc3BhY2VzLnNldElhbVBvbGljeZDqMAGY6jABgtPkkwItOgEqIigvdjEve3Jlc291cmNlPXdvcmtzcGFjZXMvKn06c2V0SWFtUG9saWN5QjZaNGdpdGh1Yi5jb20vYnl0ZWJhc2UvYnl0ZWJhc2UvYmFja2VuZC9nZW5lcmF0ZWQtZ28vdjFiBnByb3RvMw", [file_google_api_annotations, file_v1_annotation, file_v1_iam_policy]);/**+ * WorkspaceService manages workspace-level operations and profile.+ ** @generated from service bytebase.v1.WorkspaceService*/export const WorkspaceService = /*@__PURE__*/diff --git a/proto/gen/grpc-doc/openapi.yaml b/proto/gen/grpc-doc/openapi.yamlindex d4ddbdd37f..103eeceda3 100644--- a/proto/gen/grpc-doc/openapi.yaml+++ b/proto/gen/grpc-doc/openapi.yaml@@ -11,8 +11,8 @@ paths:tags:- ProjectServicedescription: |-- Deprecated.- Permissions required: bb.projects.getIamPolicy+ Deprecated. No permission check implemented.+ Permissions required: NoneoperationId: ProjectService_BatchGetIamPolicyparameters:- name: '*'@@ -44,7 +44,9 @@ paths:delete:tags:- ActuatorService- description: 'Permissions required: None'+ description: |-+ Clears the system cache to force data refresh.+ Permissions required: NoneoperationId: ActuatorService_DeleteCacheresponses:"200":@@ -60,7 +62,9 @@ paths:get:tags:- ActuatorService- description: 'Permissions required: None'+ description: |-+ Gets system information and health status of the Bytebase instance.+ Permissions required: NoneoperationId: ActuatorService_GetActuatorInforesponses:"200":@@ -78,7 +82,9 @@ paths:patch:tags:- ActuatorService- description: 'Permissions required: bb.settings.set'+ description: |-+ Updates system configuration settings for the Bytebase instance.+ Permissions required: bb.settings.setoperationId: ActuatorService_UpdateActuatorInfoparameters:- name: updateMask@@ -117,7 +123,9 @@ paths:get:tags:- ActuatorService- description: 'Permissions required: None'+ description: |-+ Gets custom branding resources such as logos.+ Permissions required: NoneoperationId: ActuatorService_GetResourcePackageresponses:"200":@@ -136,7 +144,9 @@ paths:post:tags:- ActuatorService- description: 'Permissions required: bb.projects.create'+ description: |-+ Sets up sample data for demonstration and testing purposes.+ Permissions required: bb.projects.createoperationId: ActuatorService_SetupSampleresponses:"200":@@ -152,7 +162,9 @@ paths:post:tags:- AuditLogService- description: 'Permissions required: bb.auditLogs.export'+ description: |-+ Exports audit logs in a specified format for external analysis.+ Permissions required: bb.auditLogs.exportoperationId: AuditLogService_ExportAuditLogsrequestBody:content:@@ -177,7 +189,9 @@ paths:post:tags:- AuditLogService- description: 'Permissions required: None'+ description: |-+ Searches audit logs with optional filtering and pagination.+ Permissions required: bb.auditLogs.searchoperationId: AuditLogService_SearchAuditLogsrequestBody:content:@@ -202,7 +216,9 @@ paths:post:tags:- AuthService- description: 'Permissions required: None'+ description: |-+ Authenticates a user and returns access tokens.+ Permissions required: NoneoperationId: AuthService_LoginrequestBody:content:@@ -227,7 +243,9 @@ paths:post:tags:- AuthService- description: 'Permissions required: None'+ description: |-+ Logs out the current user session.+ Permissions required: NoneoperationId: AuthService_LogoutrequestBody:content:@@ -249,7 +267,9 @@ paths:post:tags:- CelService- description: 'Permissions required: None'+ description: |-+ Converts multiple CEL AST representations back into expression strings.+ Permissions required: NoneoperationId: CelService_BatchDeparserequestBody:content:@@ -274,7 +294,9 @@ paths:post:tags:- CelService- description: 'Permissions required: None'+ description: |-+ Parses multiple CEL expression strings into AST representations.+ Permissions required: NoneoperationId: CelService_BatchParserequestBody:content:@@ -299,7 +321,9 @@ paths:get:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.list'+ description: |-+ Lists policies at a specified resource level.+ Permissions required: bb.policies.listoperationId: OrgPolicyService_ListPoliciesparameters:- name: environment@@ -310,6 +334,7 @@ paths:type: string- name: policyTypein: query+ description: Filter by specific policy type.schema:enum:- POLICY_TYPE_UNSPECIFIED@@ -324,7 +349,7 @@ paths:- name: pageSizein: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.The maximum number of policies to return. The service may return fewer thanthis value.If unspecified, at most 10 policies will be returned.@@ -335,7 +360,7 @@ paths:- name: pageTokenin: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.A page token, received from a previous `ListPolicies` call.Provide this to retrieve the subsequent page.@@ -364,7 +389,9 @@ paths:post:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.create'+ description: |-+ Creates a new organizational policy.+ Permissions required: bb.policies.createoperationId: OrgPolicyService_CreatePolicyparameters:- name: environment@@ -375,6 +402,7 @@ paths:type: string- name: typein: query+ description: The type of policy to create.schema:enum:- POLICY_TYPE_UNSPECIFIED@@ -409,7 +437,9 @@ paths:get:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.get'+ description: |-+ Retrieves a policy by name.+ Permissions required: bb.policies.getoperationId: OrgPolicyService_GetPolicyparameters:- name: environment@@ -440,7 +470,9 @@ paths:delete:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.delete'+ description: |-+ Deletes an organizational policy.+ Permissions required: bb.policies.deleteoperationId: OrgPolicyService_DeletePolicyparameters:- name: environment@@ -468,7 +500,9 @@ paths:patch:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.update'+ description: |-+ Updates an existing organizational policy.+ Permissions required: bb.policies.updateoperationId: OrgPolicyService_UpdatePolicyparameters:- name: environment@@ -519,7 +553,9 @@ paths:get:tags:- GroupService- description: 'Permissions required: bb.groups.list'+ description: |-+ Lists all groups in the workspace.+ Permissions required: bb.groups.listoperationId: GroupService_ListGroupsparameters:- name: pageSize@@ -579,7 +615,9 @@ paths:post:tags:- GroupService- description: 'Permissions required: bb.groups.create'+ description: |-+ Creates a new group.+ Permissions required: bb.groups.createoperationId: GroupService_CreateGroupparameters:- name: groupEmail@@ -612,7 +650,9 @@ paths:get:tags:- GroupService- description: 'Permissions required: bb.groups.get'+ description: |-+ Gets a group by name.+ Permissions required: bb.groups.getoperationId: GroupService_GetGroupparameters:- name: group@@ -637,7 +677,9 @@ paths:delete:tags:- GroupService- description: 'Permissions required: bb.groups.delete'+ description: |-+ Deletes a group. Group owners or users with bb.groups.delete permission can delete.+ Permissions required: bb.groups.delete OR caller is group owneroperationId: GroupService_DeleteGroupparameters:- name: group@@ -660,9 +702,8 @@ paths:tags:- GroupServicedescription: |-- UpdateGroup updates the group.- Users with "bb.groups.update" permission on the workspace or the group owner can access this method.- Permissions required: bb.groups.update+ Updates a group. Group owners or users with bb.groups.update permission can update.+ Permissions required: bb.groups.update OR caller is group owneroperationId: GroupService_UpdateGroupparameters:- name: group@@ -708,7 +749,7 @@ paths:tags:- GroupServicedescription: |-- Get the groups in batch.+ Gets multiple groups in a single request.Permissions required: bb.groups.getoperationId: GroupService_BatchGetGroupsparameters:@@ -738,13 +779,15 @@ paths:get:tags:- IdentityProviderService- description: 'Permissions required: None'+ description: |-+ Lists all configured identity providers (public endpoint for login page).+ Permissions required: NoneoperationId: IdentityProviderService_ListIdentityProvidersparameters:- name: pageSizein: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.The maximum number of identity providers to return. The service may return fewer thanthis value.If unspecified, at most 10 will be returned.@@ -755,7 +798,7 @@ paths:- name: pageTokenin: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.A page token, received from a previous `ListIdentityProviders` call.Provide this to retrieve the subsequent page.@@ -779,7 +822,9 @@ paths:post:tags:- IdentityProviderService- description: 'Permissions required: bb.identityProviders.create'+ description: |-+ Creates a new identity provider.+ Permissions required: bb.identityProviders.createoperationId: IdentityProviderService_CreateIdentityProviderparameters:- name: identityProviderId@@ -820,7 +865,9 @@ paths:post:tags:- IdentityProviderService- description: 'Permissions required: bb.identityProviders.update'+ description: |-+ Tests the connection and configuration of an identity provider.+ Permissions required: bb.identityProviders.updateoperationId: IdentityProviderService_TestIdentityProviderrequestBody:content:@@ -845,7 +892,9 @@ paths:get:tags:- IdentityProviderService- description: 'Permissions required: bb.identityProviders.get'+ description: |-+ Gets an identity provider by name.+ Permissions required: bb.identityProviders.getoperationId: IdentityProviderService_GetIdentityProviderparameters:- name: idp@@ -870,7 +919,9 @@ paths:delete:tags:- IdentityProviderService- description: 'Permissions required: bb.identityProviders.delete'+ description: |-+ Deletes an identity provider.+ Permissions required: bb.identityProviders.deleteoperationId: IdentityProviderService_DeleteIdentityProviderparameters:- name: idp@@ -892,7 +943,9 @@ paths:patch:tags:- IdentityProviderService- description: 'Permissions required: bb.identityProviders.update'+ description: |-+ Updates an identity provider.+ Permissions required: bb.identityProviders.updateoperationId: IdentityProviderService_UpdateIdentityProviderparameters:- name: idp@@ -937,7 +990,9 @@ paths:get:tags:- InstanceService- description: 'Permissions required: bb.instances.list'+ description: |-+ Lists all database instances.+ Permissions required: bb.instances.listoperationId: InstanceService_ListInstancesparameters:- name: pageSize@@ -1021,7 +1076,9 @@ paths:post:tags:- InstanceService- description: 'Permissions required: bb.instances.create'+ description: |-+ Creates a new database instance.+ Permissions required: bb.instances.createoperationId: InstanceService_CreateInstanceparameters:- name: instanceId@@ -1062,7 +1119,9 @@ paths:get:tags:- InstanceService- description: 'Permissions required: bb.instances.get'+ description: |-+ Gets a database instance by name.+ Permissions required: bb.instances.getoperationId: InstanceService_GetInstanceparameters:- name: instance@@ -1087,7 +1146,9 @@ paths:delete:tags:- InstanceService- description: 'Permissions required: bb.instances.delete'+ description: |-+ Deletes or soft-deletes a database instance.+ Permissions required: bb.instances.deleteoperationId: InstanceService_DeleteInstanceparameters:- name: instance@@ -1123,7 +1184,9 @@ paths:patch:tags:- InstanceService- description: 'Permissions required: bb.instances.update'+ description: |-+ Updates a database instance.+ Permissions required: bb.instances.updateoperationId: InstanceService_UpdateInstanceparameters:- name: instance@@ -1168,7 +1231,9 @@ paths:get:tags:- DatabaseService- description: 'Permissions required: bb.databases.list'+ description: |-+ Lists databases in a project, instance, or workspace.+ Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)operationId: DatabaseService_ListDatabasesparameters:- name: instance@@ -1257,7 +1322,9 @@ paths:get:tags:- DatabaseService- description: 'Permissions required: bb.databases.get'+ description: |-+ Retrieves a database by name.+ Permissions required: bb.databases.getoperationId: DatabaseService_GetDatabaseparameters:- name: instance@@ -1288,7 +1355,9 @@ paths:patch:tags:- DatabaseService- description: 'Permissions required: bb.databases.update'+ description: |-+ Updates database properties such as labels and project assignment.+ Permissions required: bb.databases.updateoperationId: DatabaseService_UpdateDatabaseparameters:- name: instance@@ -1339,7 +1408,9 @@ paths:get:tags:- DatabaseCatalogService- description: 'Permissions required: bb.databaseCatalogs.get'+ description: |-+ Gets the catalog metadata for a database.+ Permissions required: bb.databaseCatalogs.getoperationId: DatabaseCatalogService_GetDatabaseCatalogparameters:- name: instance@@ -1370,7 +1441,9 @@ paths:patch:tags:- DatabaseCatalogService- description: 'Permissions required: bb.databaseCatalogs.update'+ description: |-+ Updates catalog metadata such as classifications and labels.+ Permissions required: bb.databaseCatalogs.updateoperationId: DatabaseCatalogService_UpdateDatabaseCatalogparameters:- name: instance@@ -1415,7 +1488,9 @@ paths:get:tags:- DatabaseService- description: 'Permissions required: bb.changelogs.list'+ description: |-+ Lists migration history for a database.+ Permissions required: bb.changelogs.listoperationId: DatabaseService_ListChangelogsparameters:- name: instance@@ -1510,7 +1585,9 @@ paths:get:tags:- DatabaseService- description: 'Permissions required: changelogs.get'+ description: |-+ Retrieves a specific changelog entry.+ Permissions required: bb.changelogs.getoperationId: DatabaseService_GetChangelogparameters:- name: instance@@ -1562,7 +1639,9 @@ paths:post:tags:- DatabaseService- description: 'Permissions required: bb.databases.get'+ description: |-+ Compares and generates migration statements between two schemas.+ Permissions required: bb.databases.getoperationId: DatabaseService_DiffSchemaparameters:- name: instance@@ -1606,7 +1685,9 @@ paths:get:tags:- DatabaseService- description: 'Permissions required: bb.databases.getSchema'+ description: |-+ Retrieves database metadata including tables, columns, and indexes.+ Permissions required: bb.databases.getSchemaoperationId: DatabaseService_GetDatabaseMetadataparameters:- name: instance@@ -1667,7 +1748,9 @@ paths:get:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.list'+ description: |-+ Lists policies at a specified resource level.+ Permissions required: bb.policies.listoperationId: OrgPolicyService_ListPoliciesparameters:- name: instance@@ -1684,6 +1767,7 @@ paths:type: string- name: policyTypein: query+ description: Filter by specific policy type.schema:enum:- POLICY_TYPE_UNSPECIFIED@@ -1698,7 +1782,7 @@ paths:- name: pageSizein: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.The maximum number of policies to return. The service may return fewer thanthis value.If unspecified, at most 10 policies will be returned.@@ -1709,7 +1793,7 @@ paths:- name: pageTokenin: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.A page token, received from a previous `ListPolicies` call.Provide this to retrieve the subsequent page.@@ -1738,7 +1822,9 @@ paths:post:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.create'+ description: |-+ Creates a new organizational policy.+ Permissions required: bb.policies.createoperationId: OrgPolicyService_CreatePolicyparameters:- name: instance@@ -1755,6 +1841,7 @@ paths:type: string- name: typein: query+ description: The type of policy to create.schema:enum:- POLICY_TYPE_UNSPECIFIED@@ -1789,7 +1876,9 @@ paths:get:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.get'+ description: |-+ Retrieves a policy by name.+ Permissions required: bb.policies.getoperationId: OrgPolicyService_GetPolicyparameters:- name: instance@@ -1826,7 +1915,9 @@ paths:delete:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.delete'+ description: |-+ Deletes an organizational policy.+ Permissions required: bb.policies.deleteoperationId: OrgPolicyService_DeletePolicyparameters:- name: instance@@ -1860,7 +1951,9 @@ paths:patch:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.update'+ description: |-+ Updates an existing organizational policy.+ Permissions required: bb.policies.updateoperationId: OrgPolicyService_UpdatePolicyparameters:- name: instance@@ -1917,7 +2010,9 @@ paths:get:tags:- RevisionService- description: 'Permissions required: bb.revisions.list'+ description: |-+ Lists schema revisions for a database.+ Permissions required: bb.revisions.listoperationId: RevisionService_ListRevisionsparameters:- name: instance@@ -1953,6 +2048,7 @@ paths:type: string- name: showDeletedin: query+ description: Whether to include deleted revisions in the results.schema:type: booleanresponses:@@ -1971,7 +2067,9 @@ paths:post:tags:- RevisionService- description: 'Permissions required: bb.revisions.create'+ description: |-+ Creates a new schema revision.+ Permissions required: bb.revisions.createoperationId: RevisionService_CreateRevisionparameters:- name: instance@@ -2009,7 +2107,9 @@ paths:get:tags:- RevisionService- description: 'Permissions required: bb.revisions.get'+ description: |-+ Retrieves a schema revision by name.+ Permissions required: bb.revisions.getoperationId: RevisionService_GetRevisionparameters:- name: instance@@ -2046,7 +2146,9 @@ paths:delete:tags:- RevisionService- description: 'Permissions required: bb.revisions.delete'+ description: |-+ Deletes a schema revision.+ Permissions required: bb.revisions.deleteoperationId: RevisionService_DeleteRevisionparameters:- name: instance@@ -2081,7 +2183,9 @@ paths:post:tags:- RevisionService- description: 'Permissions required: bb.revisions.create'+ description: |-+ Creates multiple schema revisions in a single operation.+ Permissions required: bb.revisions.createoperationId: RevisionService_BatchCreateRevisionsparameters:- name: instance@@ -2119,7 +2223,9 @@ paths:get:tags:- DatabaseService- description: 'Permissions required: bb.databases.getSchema'+ description: |-+ Retrieves database schema as DDL statements.+ Permissions required: bb.databases.getSchemaoperationId: DatabaseService_GetDatabaseSchemaparameters:- name: instance@@ -2156,7 +2262,9 @@ paths:get:tags:- DatabaseService- description: 'Permissions required: databases.getSchema'+ description: |-+ Generates schema DDL for a database object.+ Permissions required: bb.databases.getSchemaoperationId: DatabaseService_GetSchemaStringparameters:- name: instance@@ -2216,6 +2324,7 @@ paths:type: string- name: metadata.ownerin: query+ description: The owner of the database.schema:type: string- name: metadata.searchPath@@ -2240,7 +2349,9 @@ paths:post:tags:- DatabaseService- description: 'Permissions required: bb.databases.get'+ description: |-+ Compares and generates migration statements between two schemas.+ Permissions required: bb.databases.getoperationId: DatabaseService_DiffSchemaparameters:- name: instance@@ -2278,7 +2389,9 @@ paths:post:tags:- SQLService- description: 'Permissions required: bb.databases.get'+ description: |-+ Exports query results to a file format.+ Permissions required: bb.databases.getoperationId: SQLService_Exportparameters:- name: instance@@ -2316,7 +2429,9 @@ paths:post:tags:- SQLService- description: 'Permissions required: bb.databases.get'+ description: |-+ Executes a read-only SQL query against a database.+ Permissions required: bb.databases.getoperationId: SQLService_Queryparameters:- name: instance@@ -2354,7 +2469,9 @@ paths:post:tags:- DatabaseService- description: 'Permissions required: bb.databases.sync'+ description: |-+ Synchronizes database schema from the instance.+ Permissions required: bb.databases.syncoperationId: DatabaseService_SyncDatabaseparameters:- name: instance@@ -2392,7 +2509,9 @@ paths:get:tags:- DatabaseService- description: 'Permissions required: bb.databases.get'+ description: |-+ Retrieves multiple databases by their names.+ Permissions required: bb.databases.getoperationId: DatabaseService_BatchGetDatabasesparameters:- name: instance@@ -2425,7 +2544,9 @@ paths:post:tags:- DatabaseService- description: 'Permissions required: bb.databases.sync'+ description: |-+ Synchronizes multiple databases in a single batch operation.+ Permissions required: bb.databases.syncoperationId: DatabaseService_BatchSyncDatabasesparameters:- name: instance@@ -2457,7 +2578,9 @@ paths:post:tags:- DatabaseService- description: 'Permissions required: bb.databases.update'+ description: |-+ Updates multiple databases in a single batch operation.+ Permissions required: bb.databases.updateoperationId: DatabaseService_BatchUpdateDatabasesparameters:- name: instance@@ -2489,7 +2612,9 @@ paths:get:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.list'+ description: |-+ Lists policies at a specified resource level.+ Permissions required: bb.policies.listoperationId: OrgPolicyService_ListPoliciesparameters:- name: instance@@ -2500,6 +2625,7 @@ paths:type: string- name: policyTypein: query+ description: Filter by specific policy type.schema:enum:- POLICY_TYPE_UNSPECIFIED@@ -2514,7 +2640,7 @@ paths:- name: pageSizein: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.The maximum number of policies to return. The service may return fewer thanthis value.If unspecified, at most 10 policies will be returned.@@ -2525,7 +2651,7 @@ paths:- name: pageTokenin: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.A page token, received from a previous `ListPolicies` call.Provide this to retrieve the subsequent page.@@ -2554,7 +2680,9 @@ paths:post:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.create'+ description: |-+ Creates a new organizational policy.+ Permissions required: bb.policies.createoperationId: OrgPolicyService_CreatePolicyparameters:- name: instance@@ -2565,6 +2693,7 @@ paths:type: string- name: typein: query+ description: The type of policy to create.schema:enum:- POLICY_TYPE_UNSPECIFIED@@ -2599,7 +2728,9 @@ paths:get:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.get'+ description: |-+ Retrieves a policy by name.+ Permissions required: bb.policies.getoperationId: OrgPolicyService_GetPolicyparameters:- name: instance@@ -2630,7 +2761,9 @@ paths:delete:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.delete'+ description: |-+ Deletes an organizational policy.+ Permissions required: bb.policies.deleteoperationId: OrgPolicyService_DeletePolicyparameters:- name: instance@@ -2658,7 +2791,9 @@ paths:patch:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.update'+ description: |-+ Updates an existing organizational policy.+ Permissions required: bb.policies.updateoperationId: OrgPolicyService_UpdatePolicyparameters:- name: instance@@ -2709,7 +2844,9 @@ paths:get:tags:- InstanceRoleService- description: 'Permissions required: bb.instanceRoles.list'+ description: |-+ Lists all database roles in an instance.+ Permissions required: bb.instanceRoles.listoperationId: InstanceRoleService_ListInstanceRolesparameters:- name: instance@@ -2762,7 +2899,9 @@ paths:get:tags:- InstanceRoleService- description: 'Permissions required: bb.instanceRoles.get'+ description: |-+ Gets a database role from an instance.+ Permissions required: bb.instanceRoles.getoperationId: InstanceRoleService_GetInstanceRoleparameters:- name: instance@@ -2794,7 +2933,9 @@ paths:post:tags:- InstanceService- description: 'Permissions required: bb.instances.update'+ description: |-+ Adds a read-only data source to an instance.+ Permissions required: bb.instances.updateoperationId: InstanceService_AddDataSourceparameters:- name: instance@@ -2826,7 +2967,9 @@ paths:post:tags:- InstanceService- description: 'Permissions required: bb.instances.get'+ description: |-+ Lists all databases within an instance without creating them.+ Permissions required: bb.instances.getoperationId: InstanceService_ListInstanceDatabaseparameters:- name: instance@@ -2858,7 +3001,9 @@ paths:post:tags:- InstanceService- description: 'Permissions required: bb.instances.update'+ description: |-+ Removes a read-only data source from an instance.+ Permissions required: bb.instances.updateoperationId: InstanceService_RemoveDataSourceparameters:- name: instance@@ -2890,7 +3035,9 @@ paths:post:tags:- InstanceService- description: 'Permissions required: bb.instances.sync'+ description: |-+ Syncs database schemas and metadata from an instance.+ Permissions required: bb.instances.syncoperationId: InstanceService_SyncInstanceparameters:- name: instance@@ -2922,7 +3069,9 @@ paths:post:tags:- InstanceService- description: 'Permissions required: bb.instances.undelete'+ description: |-+ Restores a soft-deleted database instance.+ Permissions required: bb.instances.undeleteoperationId: InstanceService_UndeleteInstanceparameters:- name: instance@@ -2954,7 +3103,9 @@ paths:patch:tags:- InstanceService- description: 'Permissions required: bb.instances.update'+ description: |-+ Updates a data source configuration.+ Permissions required: bb.instances.updateoperationId: InstanceService_UpdateDataSourceparameters:- name: instance@@ -3004,7 +3155,9 @@ paths:post:tags:- InstanceService- description: 'Permissions required: bb.instances.sync'+ description: |-+ Syncs multiple instances in a single request.+ Permissions required: bb.instances.syncoperationId: InstanceService_BatchSyncInstancesrequestBody:content:@@ -3029,7 +3182,9 @@ paths:post:tags:- InstanceService- description: 'Permissions required: bb.instances.update'+ description: |-+ Updates multiple instances in a single request.+ Permissions required: bb.instances.updateoperationId: InstanceService_BatchUpdateInstancesrequestBody:content:@@ -3054,7 +3209,9 @@ paths:get:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.list'+ description: |-+ Lists policies at a specified resource level.+ Permissions required: bb.policies.listoperationId: OrgPolicyService_ListPoliciesparameters:- name: parent@@ -3066,6 +3223,7 @@ paths:type: string- name: policyTypein: query+ description: Filter by specific policy type.schema:enum:- POLICY_TYPE_UNSPECIFIED@@ -3080,7 +3238,7 @@ paths:- name: pageSizein: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.The maximum number of policies to return. The service may return fewer thanthis value.If unspecified, at most 10 policies will be returned.@@ -3091,7 +3249,7 @@ paths:- name: pageTokenin: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.A page token, received from a previous `ListPolicies` call.Provide this to retrieve the subsequent page.@@ -3120,7 +3278,9 @@ paths:post:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.create'+ description: |-+ Creates a new organizational policy.+ Permissions required: bb.policies.createoperationId: OrgPolicyService_CreatePolicyparameters:- name: parent@@ -3135,6 +3295,7 @@ paths:type: string- name: typein: query+ description: The type of policy to create.schema:enum:- POLICY_TYPE_UNSPECIFIED@@ -3169,7 +3330,9 @@ paths:get:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.get'+ description: |-+ Retrieves a policy by name.+ Permissions required: bb.policies.getoperationId: OrgPolicyService_GetPolicyparameters:- name: policy@@ -3194,7 +3357,9 @@ paths:delete:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.delete'+ description: |-+ Deletes an organizational policy.+ Permissions required: bb.policies.deleteoperationId: OrgPolicyService_DeletePolicyparameters:- name: policy@@ -3216,7 +3381,9 @@ paths:patch:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.update'+ description: |-+ Updates an existing organizational policy.+ Permissions required: bb.policies.updateoperationId: OrgPolicyService_UpdatePolicyparameters:- name: policy@@ -3261,7 +3428,9 @@ paths:get:tags:- ProjectService- description: 'Permissions required: bb.projects.list'+ description: |-+ Lists all projects in the workspace with optional filtering.+ Permissions required: bb.projects.listoperationId: ProjectService_ListProjectsparameters:- name: pageSize@@ -3313,7 +3482,9 @@ paths:post:tags:- ProjectService- description: 'Permissions required: bb.projects.create'+ description: |-+ Creates a new project in the workspace.+ Permissions required: bb.projects.createoperationId: ProjectService_CreateProjectparameters:- name: projectId@@ -3377,7 +3548,9 @@ paths:delete:tags:- ProjectService- description: 'Permissions required: bb.projects.delete'+ description: |-+ Deletes (soft-delete or purge) a project.+ Permissions required: bb.projects.deleteoperationId: ProjectService_DeleteProjectparameters:- name: project@@ -3417,7 +3590,9 @@ paths:patch:tags:- ProjectService- description: 'Permissions required: bb.projects.update'+ description: |-+ Updates an existing project's properties.+ Permissions required: bb.projects.updateoperationId: ProjectService_UpdateProjectparameters:- name: project@@ -3462,7 +3637,9 @@ paths:post:tags:- AuditLogService- description: 'Permissions required: bb.auditLogs.export'+ description: |-+ Exports audit logs in a specified format for external analysis.+ Permissions required: bb.auditLogs.exportoperationId: AuditLogService_ExportAuditLogsparameters:- name: project@@ -3494,7 +3671,9 @@ paths:post:tags:- AuditLogService- description: 'Permissions required: None'+ description: |-+ Searches audit logs with optional filtering and pagination.+ Permissions required: bb.auditLogs.searchoperationId: AuditLogService_SearchAuditLogsparameters:- name: project@@ -3526,7 +3705,9 @@ paths:get:tags:- ChangelistService- description: 'Permissions required: bb.changelists.list'+ description: |-+ Lists changelists in a project.+ Permissions required: bb.changelists.listoperationId: ChangelistService_ListChangelistsparameters:- name: project@@ -3538,7 +3719,7 @@ paths:- name: pageSizein: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.The maximum number of databases to return. The service may return fewer thanthis value.If unspecified, at most 50 databases will be returned.@@ -3549,7 +3730,7 @@ paths:- name: pageTokenin: querydescription: |-- Not used.+ 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.@@ -3573,7 +3754,9 @@ paths:post:tags:- ChangelistService- description: 'Permissions required: bb.changelists.create'+ description: |-+ Creates a new changelist in a project.+ Permissions required: bb.changelists.createoperationId: ChangelistService_CreateChangelistparameters:- name: project@@ -3615,7 +3798,9 @@ paths:get:tags:- ChangelistService- description: 'Permissions required: bb.changelists.get'+ description: |-+ Gets a changelist by name.+ Permissions required: bb.changelists.getoperationId: ChangelistService_GetChangelistparameters:- name: project@@ -3646,7 +3831,9 @@ paths:delete:tags:- ChangelistService- description: 'Permissions required: bb.changelists.delete'+ description: |-+ Deletes a changelist.+ Permissions required: bb.changelists.deleteoperationId: ChangelistService_DeleteChangelistparameters:- name: project@@ -3674,7 +3861,9 @@ paths:patch:tags:- ChangelistService- description: 'Permissions required: bb.changelists.update'+ description: |-+ Updates a changelist.+ Permissions required: bb.changelists.updateoperationId: ChangelistService_UpdateChangelistparameters:- name: project@@ -3725,7 +3914,9 @@ paths:get:tags:- DatabaseGroupService- description: 'Permissions required: bb.projects.get'+ description: |-+ Lists database groups in a project.+ Permissions required: bb.projects.getoperationId: DatabaseGroupService_ListDatabaseGroupsparameters:- name: project@@ -3737,7 +3928,7 @@ paths:- name: pageSizein: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.The maximum number of database groups to return. The service may return fewer thanthis value.If unspecified, at most 50 database groups will be returned.@@ -3748,7 +3939,7 @@ paths:- name: pageTokenin: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.A page token, received from a previous `ListDatabaseGroups` call.Provide this to retrieve the subsequent page.@@ -3782,7 +3973,9 @@ paths:post:tags:- DatabaseGroupService- description: 'Permissions required: bb.projects.update'+ description: |-+ Creates a new database group.+ Permissions required: bb.projects.updateoperationId: DatabaseGroupService_CreateDatabaseGroupparameters:- name: project@@ -3829,7 +4022,9 @@ paths:get:tags:- DatabaseGroupService- description: 'Permissions required: bb.projects.get'+ description: |-+ Gets a database group by name.+ Permissions required: bb.projects.getoperationId: DatabaseGroupService_GetDatabaseGroupparameters:- name: project@@ -3870,7 +4065,9 @@ paths:delete:tags:- DatabaseGroupService- description: 'Permissions required: bb.projects.update'+ description: |-+ Deletes a database group.+ Permissions required: bb.projects.updateoperationId: DatabaseGroupService_DeleteDatabaseGroupparameters:- name: project@@ -3898,7 +4095,9 @@ paths:patch:tags:- DatabaseGroupService- description: 'Permissions required: bb.projects.update'+ description: |-+ Updates a database group.+ Permissions required: bb.projects.updateoperationId: DatabaseGroupService_UpdateDatabaseGroupparameters:- name: project@@ -3949,7 +4148,9 @@ paths:get:tags:- DatabaseService- description: 'Permissions required: bb.databases.list'+ description: |-+ Lists databases in a project, instance, or workspace.+ Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)operationId: DatabaseService_ListDatabasesparameters:- name: project@@ -4038,7 +4239,9 @@ paths:get:tags:- DatabaseService- description: 'Permissions required: bb.databases.get'+ description: |-+ Retrieves multiple databases by their names.+ Permissions required: bb.databases.getoperationId: DatabaseService_BatchGetDatabasesparameters:- name: project@@ -4071,7 +4274,9 @@ paths:get:tags:- IssueService- description: 'Permissions required: bb.issues.list'+ description: |-+ Lists issues in a project.+ Permissions required: bb.issues.listoperationId: IssueService_ListIssuesparameters:- name: project@@ -4146,7 +4351,9 @@ paths:post:tags:- IssueService- description: 'Permissions required: bb.issues.create'+ description: |-+ Creates a new issue for database changes or tasks.+ Permissions required: bb.issues.createoperationId: IssueService_CreateIssueparameters:- name: project@@ -4178,7 +4385,9 @@ paths:get:tags:- IssueService- description: 'Permissions required: bb.issues.get'+ description: |-+ Retrieves an issue by name.+ Permissions required: bb.issues.getoperationId: IssueService_GetIssueparameters:- name: project@@ -4195,6 +4404,7 @@ paths:type: string- name: forcein: query+ description: If set to true, bypass cache and fetch the latest data.schema:type: booleanresponses:@@ -4213,7 +4423,9 @@ paths:patch:tags:- IssueService- description: 'Permissions required: bb.issues.update'+ description: |-+ Updates an issue's properties such as title, description, or labels.+ Permissions required: bb.issues.updateoperationId: IssueService_UpdateIssueparameters:- name: project@@ -4264,7 +4476,9 @@ paths:get:tags:- IssueService- description: 'Permissions required: bb.issueComments.list'+ description: |-+ Lists comments on an issue.+ Permissions required: bb.issueComments.listoperationId: IssueService_ListIssueCommentsparameters:- name: project@@ -4317,9 +4531,8 @@ paths:tags:- IssueServicedescription: |-- ApproveIssue approves the issue.- The access is based on approval flow.- Permissions required: None+ Approves an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+ Permissions required: None (determined by approval flow)operationId: IssueService_ApproveIssueparameters:- name: project@@ -4357,7 +4570,9 @@ paths:post:tags:- IssueService- description: 'Permissions required: bb.issueComments.create'+ description: |-+ Adds a comment to an issue.+ Permissions required: bb.issueComments.createoperationId: IssueService_CreateIssueCommentparameters:- name: project@@ -4394,7 +4609,9 @@ paths:patch:tags:- IssueService- description: 'Permissions required: bb.issueComments.update'+ description: |-+ Updates an existing issue comment.+ Permissions required: bb.issueComments.updateoperationId: IssueService_UpdateIssueCommentparameters:- name: project@@ -4446,9 +4663,8 @@ paths:tags:- IssueServicedescription: |-- RejectIssue rejects the issue.- The access is based on approval flow.- Permissions required: None+ Rejects an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+ Permissions required: None (determined by approval flow)operationId: IssueService_RejectIssueparameters:- name: project@@ -4487,9 +4703,8 @@ paths:tags:- IssueServicedescription: |-- RequestIssue requests the issue.- The access is based on approval flow.- Permissions required: None+ Requests changes on an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+ Permissions required: None (determined by approval flow)operationId: IssueService_RequestIssueparameters:- name: project@@ -4527,7 +4742,9 @@ paths:post:tags:- IssueService- description: 'Permissions required: bb.issues.update'+ description: |-+ Updates the status of multiple issues in a single operation.+ Permissions required: bb.issues.updateoperationId: IssueService_BatchUpdateIssuesStatusparameters:- name: project@@ -4593,7 +4810,9 @@ paths:get:tags:- PlanService- description: 'Permissions required: bb.plans.list'+ description: |-+ Lists deployment plans in a project.+ Permissions required: bb.plans.listoperationId: PlanService_ListPlansparameters:- name: project@@ -4638,7 +4857,9 @@ paths:post:tags:- PlanService- description: 'Permissions required: bb.plans.create'+ description: |-+ Creates a new deployment plan.+ Permissions required: bb.plans.createoperationId: PlanService_CreatePlanparameters:- name: project@@ -4670,7 +4891,9 @@ paths:get:tags:- PlanService- description: 'Permissions required: bb.plans.get'+ description: |-+ Retrieves a deployment plan by name.+ Permissions required: bb.plans.getoperationId: PlanService_GetPlanparameters:- name: project@@ -4704,7 +4927,7 @@ paths:description: |-UpdatePlan updates the plan.The plan creator and the user with bb.plans.update permission on the project can update the plan.- Permissions required: bb.plans.update+ Permissions required: bb.plans.update (or creator)operationId: PlanService_UpdatePlanparameters:- name: project@@ -4755,7 +4978,9 @@ paths:get:tags:- PlanService- description: 'Permissions required: bb.planCheckRuns.list'+ description: |-+ Lists plan check runs for a deployment plan.+ Permissions required: bb.planCheckRuns.listoperationId: PlanService_ListPlanCheckRunsparameters:- name: project@@ -4773,7 +4998,7 @@ paths:- name: pageSizein: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.The maximum number of plan check runs to return. The service may return fewer thanthis value.If unspecified, at most 10 plan check runs will be returned.@@ -4784,7 +5009,7 @@ paths:- name: pageTokenin: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.A page token, received from a previous `ListPlanCheckRuns` call.Provide this to retrieve the subsequent page.@@ -4831,7 +5056,9 @@ paths:post:tags:- PlanService- description: 'Permissions required: bb.planCheckRuns.run'+ description: |-+ Cancels multiple plan check runs.+ Permissions required: bb.planCheckRuns.runoperationId: PlanService_BatchCancelPlanCheckRunsparameters:- name: project@@ -4869,7 +5096,9 @@ paths:post:tags:- PlanService- description: 'Permissions required: bb.planCheckRuns.run'+ description: |-+ Executes validation checks on a deployment plan.+ Permissions required: bb.planCheckRuns.runoperationId: PlanService_RunPlanChecksparameters:- name: project@@ -4941,7 +5170,9 @@ paths:get:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.list'+ description: |-+ Lists policies at a specified resource level.+ Permissions required: bb.policies.listoperationId: OrgPolicyService_ListPoliciesparameters:- name: project@@ -4952,6 +5183,7 @@ paths:type: string- name: policyTypein: query+ description: Filter by specific policy type.schema:enum:- POLICY_TYPE_UNSPECIFIED@@ -4966,7 +5198,7 @@ paths:- name: pageSizein: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.The maximum number of policies to return. The service may return fewer thanthis value.If unspecified, at most 10 policies will be returned.@@ -4977,7 +5209,7 @@ paths:- name: pageTokenin: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.A page token, received from a previous `ListPolicies` call.Provide this to retrieve the subsequent page.@@ -5006,7 +5238,9 @@ paths:post:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.create'+ description: |-+ Creates a new organizational policy.+ Permissions required: bb.policies.createoperationId: OrgPolicyService_CreatePolicyparameters:- name: project@@ -5017,6 +5251,7 @@ paths:type: string- name: typein: query+ description: The type of policy to create.schema:enum:- POLICY_TYPE_UNSPECIFIED@@ -5051,7 +5286,9 @@ paths:get:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.get'+ description: |-+ Retrieves a policy by name.+ Permissions required: bb.policies.getoperationId: OrgPolicyService_GetPolicyparameters:- name: project@@ -5082,7 +5319,9 @@ paths:delete:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.delete'+ description: |-+ Deletes an organizational policy.+ Permissions required: bb.policies.deleteoperationId: OrgPolicyService_DeletePolicyparameters:- name: project@@ -5110,7 +5349,9 @@ paths:patch:tags:- OrgPolicyService- description: 'Permissions required: bb.policies.update'+ description: |-+ Updates an existing organizational policy.+ Permissions required: bb.policies.updateoperationId: OrgPolicyService_UpdatePolicyparameters:- name: project@@ -5161,7 +5402,9 @@ paths:get:tags:- ReleaseService- description: 'Permissions required: bb.releases.list'+ description: |-+ Lists releases in a project.+ Permissions required: bb.releases.listoperationId: ReleaseService_ListReleasesparameters:- name: project@@ -5210,7 +5453,9 @@ paths:post:tags:- ReleaseService- description: 'Permissions required: bb.releases.create'+ description: |-+ Creates a new release with SQL files.+ Permissions required: bb.releases.createoperationId: ReleaseService_CreateReleaseparameters:- name: project@@ -5242,7 +5487,9 @@ paths:get:tags:- ReleaseService- description: 'Permissions required: bb.releases.get'+ description: |-+ Retrieves a release by name.+ Permissions required: bb.releases.getoperationId: ReleaseService_GetReleaseparameters:- name: project@@ -5273,7 +5520,9 @@ paths:delete:tags:- ReleaseService- description: 'Permissions required: bb.releases.delete'+ description: |-+ Deletes a release.+ Permissions required: bb.releases.deleteoperationId: ReleaseService_DeleteReleaseparameters:- name: project@@ -5301,7 +5550,9 @@ paths:patch:tags:- ReleaseService- description: 'Permissions required: bb.releases.update'+ description: |-+ Updates an existing release.+ Permissions required: bb.releases.updateoperationId: ReleaseService_UpdateReleaseparameters:- name: project@@ -5352,7 +5603,9 @@ paths:post:tags:- ReleaseService- description: 'Permissions required: bb.releases.undelete'+ description: |-+ Restores a deleted release.+ Permissions required: bb.releases.undeleteoperationId: ReleaseService_UndeleteReleaseparameters:- name: project@@ -5384,7 +5637,9 @@ paths:post:tags:- ReleaseService- description: 'Permissions required: bb.releases.check'+ description: |-+ Validates a release by dry-running checks on target databases.+ Permissions required: bb.releases.checkoperationId: ReleaseService_CheckReleaseparameters:- name: project@@ -5416,7 +5671,9 @@ paths:get:tags:- ReleaseService- description: 'Permissions required: bb.releases.get'+ description: |-+ Searches releases by digest or other criteria.+ Permissions required: bb.releases.getoperationId: ReleaseService_SearchReleasesparameters:- name: project@@ -5466,7 +5723,9 @@ paths:get:tags:- RolloutService- description: 'Permissions required: bb.rollouts.list'+ description: |-+ Lists rollouts in a project.+ Permissions required: bb.rollouts.listoperationId: RolloutService_ListRolloutsparameters:- name: project@@ -5528,7 +5787,9 @@ paths:post:tags:- RolloutService- description: 'Permissions required: bb.rollouts.create'+ description: |-+ Creates a new rollout from a plan.+ Permissions required: bb.rollouts.createoperationId: RolloutService_CreateRolloutparameters:- name: project@@ -5576,7 +5837,9 @@ paths:get:tags:- RolloutService- description: 'Permissions required: bb.rollouts.get'+ description: |-+ Retrieves a rollout by name.+ Permissions required: bb.rollouts.getoperationId: RolloutService_GetRolloutparameters:- name: project@@ -5608,7 +5871,9 @@ paths:get:tags:- RolloutService- description: 'Permissions required: bb.taskRuns.list'+ description: |-+ Lists task run executions for a task.+ Permissions required: bb.taskRuns.listoperationId: RolloutService_ListTaskRunsparameters:- name: project@@ -5638,7 +5903,7 @@ paths:- name: pageSizein: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.The maximum number of taskRuns to return. The service may return fewer thanthis value.If unspecified, at most 10 taskRuns will be returned.@@ -5649,7 +5914,7 @@ paths:- name: pageTokenin: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.A page token, received from a previous `ListTaskRuns` call.Provide this to retrieve the subsequent page.@@ -5674,7 +5939,9 @@ paths:get:tags:- RolloutService- description: 'Permissions required: bb.taskRuns.list'+ description: |-+ Retrieves a task run by name.+ Permissions required: bb.taskRuns.listoperationId: RolloutService_GetTaskRunparameters:- name: project@@ -5724,7 +5991,9 @@ paths:get:tags:- RolloutService- description: 'Permissions required: bb.taskRuns.list'+ description: |-+ Retrieves execution logs for a task run.+ Permissions required: bb.taskRuns.listoperationId: RolloutService_GetTaskRunLogparameters:- name: project@@ -5774,7 +6043,9 @@ paths:get:tags:- RolloutService- description: 'Permissions required: bb.taskRuns.list'+ description: |-+ Retrieves database session information for a running task.+ Permissions required: bb.taskRuns.listoperationId: RolloutService_GetTaskRunSessionparameters:- name: project@@ -5824,7 +6095,9 @@ paths:post:tags:- RolloutService- description: 'Permissions required: bb.taskRuns.list'+ description: |-+ Generates rollback SQL for a completed task run.+ Permissions required: bb.taskRuns.listoperationId: RolloutService_PreviewTaskRunRollbackparameters:- name: project@@ -5880,7 +6153,9 @@ paths:post:tags:- RolloutService- description: 'Permissions required: None'+ description: |-+ Cancels multiple running task executions.+ Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)operationId: RolloutService_BatchCancelTaskRunsparameters:- name: project@@ -5930,7 +6205,9 @@ paths:post:tags:- RolloutService- description: 'Permissions required: None'+ description: |-+ Executes multiple tasks in a rollout stage.+ Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)operationId: RolloutService_BatchRunTasksparameters:- name: project@@ -5974,7 +6251,9 @@ paths:post:tags:- RolloutService- description: 'Permissions required: None'+ description: |-+ Skips multiple tasks in a rollout stage.+ Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)operationId: RolloutService_BatchSkipTasksparameters:- name: project@@ -6018,7 +6297,9 @@ paths:post:tags:- SQLService- description: 'Permissions required: bb.databases.get'+ description: |-+ Exports query results to a file format.+ Permissions required: bb.databases.getoperationId: SQLService_Exportparameters:- name: project@@ -6062,7 +6343,9 @@ paths:post:tags:- SQLService- description: 'Permissions required: bb.databases.get'+ description: |-+ Exports query results to a file format.+ Permissions required: bb.databases.getoperationId: SQLService_Exportparameters:- name: project@@ -6100,7 +6383,9 @@ paths:post:tags:- SheetService- description: 'Permissions required: bb.sheets.create'+ description: |-+ Creates a new SQL sheet.+ Permissions required: bb.sheets.createoperationId: SheetService_CreateSheetparameters:- name: project@@ -6132,7 +6417,9 @@ paths:get:tags:- SheetService- description: 'Permissions required: bb.sheets.get'+ description: |-+ Retrieves a SQL sheet by name.+ Permissions required: bb.sheets.getoperationId: SheetService_GetSheetparameters:- name: project@@ -6168,7 +6455,9 @@ paths:patch:tags:- SheetService- description: 'Permissions required: bb.sheets.update'+ description: |-+ Updates a SQL sheet's title or content.+ Permissions required: bb.sheets.updateoperationId: SheetService_UpdateSheetparameters:- name: project@@ -6225,7 +6514,9 @@ paths:post:tags:- SheetService- description: 'Permissions required: bb.sheets.create'+ description: |-+ Creates multiple SQL sheets in a single operation.+ Permissions required: bb.sheets.createoperationId: SheetService_BatchCreateSheetsparameters:- name: project@@ -6257,7 +6548,9 @@ paths:post:tags:- ProjectService- description: 'Permissions required: bb.projects.update'+ description: |-+ Removes a webhook from a project.+ Permissions required: bb.projects.updateoperationId: ProjectService_RemoveWebhookparameters:- name: project@@ -6295,7 +6588,9 @@ paths:patch:tags:- ProjectService- description: 'Permissions required: bb.projects.update'+ description: |-+ Updates an existing webhook configuration.+ Permissions required: bb.projects.updateoperationId: ProjectService_UpdateWebhookparameters:- name: project@@ -6346,7 +6641,9 @@ paths:post:tags:- ProjectService- description: 'Permissions required: bb.projects.update'+ description: |-+ Adds a webhook to a project for notifications.+ Permissions required: bb.projects.updateoperationId: ProjectService_AddWebhookparameters:- name: project@@ -6378,7 +6675,9 @@ paths:get:tags:- ProjectService- description: 'Permissions required: bb.projects.getIamPolicy'+ description: |-+ Retrieves the IAM policy for a project.+ Permissions required: bb.projects.getIamPolicyoperationId: ProjectService_GetIamPolicyparameters:- name: project@@ -6404,7 +6703,9 @@ paths:post:tags:- RolloutService- description: 'Permissions required: bb.rollouts.preview'+ description: |-+ Previews the rollout that would be created from a plan.+ Permissions required: bb.rollouts.previewoperationId: RolloutService_PreviewRolloutparameters:- name: project@@ -6436,7 +6737,9 @@ paths:post:tags:- ProjectService- description: 'Permissions required: bb.projects.setIamPolicy'+ description: |-+ Sets the IAM policy for a project.+ Permissions required: bb.projects.setIamPolicyoperationId: ProjectService_SetIamPolicyparameters:- name: project@@ -6468,7 +6771,9 @@ paths:post:tags:- ProjectService- description: 'Permissions required: bb.projects.update'+ description: |-+ Tests a webhook by sending a test notification.+ Permissions required: bb.projects.updateoperationId: ProjectService_TestWebhookparameters:- name: project@@ -6500,7 +6805,9 @@ paths:post:tags:- ProjectService- description: 'Permissions required: bb.projects.undelete'+ description: |-+ Restores a soft-deleted project.+ Permissions required: bb.projects.undeleteoperationId: ProjectService_UndeleteProjectparameters:- name: project@@ -6532,7 +6839,9 @@ paths:post:tags:- ProjectService- description: 'Permissions required: bb.projects.delete'+ description: |-+ Deletes multiple projects in a single operation.+ Permissions required: bb.projects.deleteoperationId: ProjectService_BatchDeleteProjectsrequestBody:content:@@ -6554,7 +6863,9 @@ paths:post:tags:- ProjectService- description: 'Permissions required: None'+ description: |-+ Searches for projects with advanced filtering capabilities.+ Permissions required: bb.projects.get (or project-level bb.projects.get for specific projects)operationId: ProjectService_SearchProjectsrequestBody:content:@@ -6581,7 +6892,7 @@ paths:- SQLServicedescription: |-SearchQueryHistories searches query histories for the caller.- Permissions required: None+ Permissions required: None (only returns caller's own query histories)operationId: SQLService_SearchQueryHistoriesrequestBody:content:@@ -6606,13 +6917,15 @@ paths:get:tags:- ReviewConfigService- description: 'Permissions required: bb.reviewConfigs.list'+ description: |-+ Lists all SQL review configurations.+ Permissions required: bb.reviewConfigs.listoperationId: ReviewConfigService_ListReviewConfigsparameters:- name: pageSizein: querydescription: |-- Not used.+ 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 thanthis value.If unspecified, at most 10 sql review will be returned.@@ -6623,7 +6936,7 @@ paths:- name: pageTokenin: querydescription: |-- Not used.+ 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@@ -6646,7 +6959,9 @@ paths:post:tags:- ReviewConfigService- description: 'Permissions required: bb.reviewConfigs.create'+ description: |-+ Creates a new SQL review configuration.+ Permissions required: bb.reviewConfigs.createoperationId: ReviewConfigService_CreateReviewConfigrequestBody:content:@@ -6671,7 +6986,9 @@ paths:get:tags:- ReviewConfigService- description: 'Permissions required: bb.reviewConfigs.get'+ description: |-+ Retrieves a SQL review configuration by name.+ Permissions required: bb.reviewConfigs.getoperationId: ReviewConfigService_GetReviewConfigparameters:- name: reviewConfig@@ -6696,7 +7013,9 @@ paths:delete:tags:- ReviewConfigService- description: 'Permissions required: bb.reviewConfigs.delete'+ description: |-+ Deletes a SQL review configuration.+ Permissions required: bb.reviewConfigs.deleteoperationId: ReviewConfigService_DeleteReviewConfigparameters:- name: reviewConfig@@ -6718,7 +7037,9 @@ paths:patch:tags:- ReviewConfigService- description: 'Permissions required: bb.reviewConfigs.update'+ description: |-+ Updates a SQL review configuration.+ Permissions required: bb.reviewConfigs.updateoperationId: ReviewConfigService_UpdateReviewConfigparameters:- name: reviewConfig@@ -6763,13 +7084,15 @@ paths:get:tags:- RiskService- description: 'Permissions required: bb.risks.list'+ description: |-+ Lists all risk assessment rules.+ Permissions required: bb.risks.listoperationId: RiskService_ListRisksparameters:- name: pageSizein: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.The maximum number of risks to return. The service may return fewer thanthis value.If unspecified, at most 10 risks will be returned.@@ -6780,11 +7103,11 @@ paths:- name: pageTokenin: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.A page token, received from a previous `ListRisks` call.Provide this to retrieve the subsequent page.- When paginating, all other parameters provided to `LiskRisks` must match+ When paginating, all other parameters provided to `ListRisks` must matchthe call that provided the page token.schema:type: string@@ -6804,7 +7127,9 @@ paths:post:tags:- RiskService- description: 'Permissions required: bb.risks.create'+ description: |-+ Creates a new risk assessment rule.+ Permissions required: bb.risks.createoperationId: RiskService_CreateRiskrequestBody:content:@@ -6829,7 +7154,9 @@ paths:get:tags:- RiskService- description: 'Permissions required: bb.risks.list'+ description: |-+ Retrieves a risk assessment rule by name.+ Permissions required: bb.risks.listoperationId: RiskService_GetRiskparameters:- name: risk@@ -6854,7 +7181,9 @@ paths:delete:tags:- RiskService- description: 'Permissions required: bb.risks.delete'+ description: |-+ Deletes a risk assessment rule.+ Permissions required: bb.risks.deleteoperationId: RiskService_DeleteRiskparameters:- name: risk@@ -6876,7 +7205,9 @@ paths:patch:tags:- RiskService- description: 'Permissions required: bb.risks.update'+ description: |-+ Updates an existing risk assessment rule.+ Permissions required: bb.risks.updateoperationId: RiskService_UpdateRiskparameters:- name: risk@@ -6921,13 +7252,15 @@ paths:get:tags:- RoleService- description: 'Permissions required: bb.roles.list'+ description: |-+ Lists roles in the workspace.+ Permissions required: bb.roles.listoperationId: RoleService_ListRolesparameters:- name: pageSizein: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.The maximum number of roles to return. The service may return fewer thanthis value.If unspecified, at most 10 reviews will be returned.@@ -6938,7 +7271,7 @@ paths:- name: pageTokenin: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.A page token, received from a previous `ListRoles` call.Provide this to retrieve the subsequent page.@@ -6962,7 +7295,9 @@ paths:post:tags:- RoleService- description: 'Permissions required: bb.roles.create'+ description: |-+ Creates a new custom role.+ Permissions required: bb.roles.createoperationId: RoleService_CreateRoleparameters:- name: roleId@@ -6998,7 +7333,9 @@ paths:get:tags:- RoleService- description: 'Permissions required: bb.roles.get'+ description: |-+ Retrieves a role by name.+ Permissions required: bb.roles.getoperationId: RoleService_GetRoleparameters:- name: role@@ -7023,7 +7360,9 @@ paths:delete:tags:- RoleService- description: 'Permissions required: bb.roles.delete'+ description: |-+ Deletes a custom role.+ Permissions required: bb.roles.deleteoperationId: RoleService_DeleteRoleparameters:- name: role@@ -7045,7 +7384,9 @@ paths:patch:tags:- RoleService- description: 'Permissions required: bb.roles.update'+ description: |-+ Updates a role's properties.+ Permissions required: bb.roles.updateoperationId: RoleService_UpdateRoleparameters:- name: role@@ -7056,12 +7397,15 @@ paths:type: string- name: updateMaskin: query+ description: The list of fields to update.schema:type: stringformat: field-mask- name: allowMissingin: query- description: If set to true, and the role is not found, a new role will be created.+ description: |-+ If set to true, and the role is not found, a new role will be created.+ In this situation, `update_mask` is ignored.schema:type: booleanrequestBody:@@ -7087,7 +7431,9 @@ paths:post:tags:- SQLService- description: 'Permissions required: None'+ description: |-+ Computes schema differences between two database metadata.+ Permissions required: NoneoperationId: SQLService_DiffMetadatarequestBody:content:@@ -7112,13 +7458,15 @@ paths:get:tags:- SettingService- description: 'Permissions required: bb.settings.list'+ description: |-+ Lists all workspace settings.+ Permissions required: bb.settings.listoperationId: SettingService_ListSettingsparameters:- name: pageSizein: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.The maximum number of settings to return. The service may return fewer thanthis value.If unspecified, at most 10 settings will be returned.@@ -7129,7 +7477,7 @@ paths:- name: pageTokenin: querydescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.A page token, received from a previous `ListSettings` call.Provide this to retrieve the subsequent page.@@ -7154,7 +7502,9 @@ paths:get:tags:- SettingService- description: 'Permissions required: bb.settings.get'+ description: |-+ Retrieves a workspace setting by name.+ Permissions required: bb.settings.getoperationId: SettingService_GetSettingparameters:- name: setting@@ -7179,7 +7529,9 @@ paths:patch:tags:- SettingService- description: 'Permissions required: bb.settings.set'+ description: |-+ Updates a workspace setting.+ Permissions required: bb.settings.setoperationId: SettingService_UpdateSettingparameters:- name: setting@@ -7227,7 +7579,9 @@ paths:post:tags:- SQLService- description: 'Permissions required: None'+ description: |-+ Provides AI-powered SQL completion and generation.+ Permissions required: None (authenticated users only, requires AI to be enabled)operationId: SQLService_AICompletionrequestBody:content:@@ -7252,7 +7606,9 @@ paths:post:tags:- SQLService- description: 'Permissions required: bb.databases.check'+ description: |-+ Validates SQL statements against review rules.+ Permissions required: bb.databases.checkoperationId: SQLService_CheckrequestBody:content:@@ -7277,7 +7633,9 @@ paths:post:tags:- SQLService- description: 'Permissions required: None'+ description: |-+ Formats and normalizes SQL schema definitions.+ Permissions required: NoneoperationId: SQLService_PrettyrequestBody:content:@@ -7324,7 +7682,9 @@ paths:patch:tags:- SubscriptionService- description: 'Permissions required: bb.settings.set'+ description: |-+ Updates the enterprise license subscription.+ Permissions required: bb.settings.setoperationId: SubscriptionService_UpdateSubscriptionparameters:- name: allowMissing@@ -7433,10 +7793,8 @@ paths:tags:- UserServicedescription: |-- Create a user.- When Disallow Signup is enabled, only the caller with bb.users.create on the workspace can create a user.- Otherwise, any unauthenticated user can create a user.- Permissions required: bb.users.create+ Creates a user. When Disallow Signup is enabled, requires bb.users.create permission; otherwise any user can sign up.+ Permissions required: bb.users.create (only when Disallow Signup is enabled)operationId: UserService_CreateUserrequestBody:content:@@ -7511,8 +7869,7 @@ paths:tags:- UserServicedescription: |-- Only the user with bb.users.delete permission on the workspace can delete the user.- The last remaining workspace admin cannot be deleted.+ Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted.Permissions required: bb.users.deleteoperationId: UserService_DeleteUserparameters:@@ -7536,8 +7893,8 @@ paths:tags:- UserServicedescription: |-- Only the user itself and the user with bb.users.update permission on the workspace can update the user.- Permissions required: bb.users.update+ Updates a user. Users can update their own profile, or users with bb.users.update permission can update any user.+ Permissions required: bb.users.update (or self)operationId: UserService_UpdateUserparameters:- name: user@@ -7600,7 +7957,7 @@ paths:tags:- UserServicedescription: |-- Only the user with bb.users.undelete permission on the workspace can undelete the user.+ Restores a deleted user.Permissions required: bb.users.undeleteoperationId: UserService_UndeleteUserparameters:@@ -7666,8 +8023,8 @@ paths:tags:- WorksheetServicedescription: |-- Create a personal worksheet used in SQL Editor.- Permissions required: None+ Creates a personal worksheet used in SQL Editor. Any authenticated user can create their own worksheets.+ Permissions required: None (authenticated users only)operationId: WorksheetService_CreateWorksheetrequestBody:content:@@ -7698,7 +8055,7 @@ paths:- they are the creator of the worksheet;- they have bb.worksheets.get permission on the workspace;- the sheet is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.- Permissions required: None+ Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)operationId: WorksheetService_GetWorksheetparameters:- name: worksheet@@ -7726,7 +8083,7 @@ paths:description: |-Delete a worksheet.The access is the same as UpdateWorksheet method.- Permissions required: None+ Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)operationId: WorksheetService_DeleteWorksheetparameters:- name: worksheet@@ -7754,7 +8111,7 @@ paths:- they are the creator of the worksheet;- they have bb.worksheets.manage permission on the workspace;- the sheet is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.- Permissions required: None+ Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)operationId: WorksheetService_UpdateWorksheetparameters:- name: worksheet@@ -7803,7 +8160,7 @@ paths:description: |-Update the organizer of a worksheet.The access is the same as UpdateWorksheet method.- Permissions required: None+ Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)operationId: WorksheetService_UpdateWorksheetOrganizerparameters:- name: worksheet@@ -7856,7 +8213,7 @@ paths:Search for worksheets.This is used for finding my worksheets or worksheets shared by other people.The sheet accessibility is the same as GetWorksheet().- Permissions required: None+ Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)operationId: WorksheetService_SearchWorksheetsrequestBody:content:@@ -7881,7 +8238,9 @@ paths:get:tags:- DatabaseService- description: 'Permissions required: bb.databases.list'+ description: |-+ Lists databases in a project, instance, or workspace.+ Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)operationId: DatabaseService_ListDatabasesparameters:- name: workspace@@ -7970,7 +8329,9 @@ paths:get:tags:- WorkspaceService- description: 'Permissions required: bb.workspaces.getIamPolicy'+ description: |-+ Retrieves IAM policy for the workspace.+ Permissions required: bb.workspaces.getIamPolicyoperationId: WorkspaceService_GetIamPolicyparameters:- name: workspace@@ -7996,7 +8357,9 @@ paths:post:tags:- WorkspaceService- description: 'Permissions required: bb.workspaces.setIamPolicy'+ description: |-+ Sets IAM policy for the workspace.+ Permissions required: bb.workspaces.setIamPolicyoperationId: WorkspaceService_SetIamPolicyparameters:- name: workspace@@ -8028,7 +8391,9 @@ paths:get:tags:- SQLService- description: 'Permissions required: bb.sql.admin'+ description: |-+ Executes SQL with admin privileges via streaming connection.+ Permissions required: bb.sql.adminoperationId: SQLService_AdminExecuteparameters:- name: name@@ -8135,94 +8500,100 @@ components:version:readOnly: truetype: string- description: version is the bytebase's server version+ description: The Bytebase server version.gitCommit:readOnly: truetype: string- description: git_commit is the git commit hash of the build+ description: The git commit hash of the build.readonly:readOnly: truetype: boolean- description: readonly flag means if the Bytebase is running in readonly mode.+ description: Whether the Bytebase instance is running in read-only mode.saas:readOnly: truetype: boolean- description: saas flag means if the Bytebase is running in SaaS mode, some features are not allowed to edit by users.+ description: Whether the Bytebase instance is running in SaaS mode where some features cannot be edited by users.demo:readOnly: truetype: boolean- description: demo flag means if the Bytebase is running in demo mode.+ description: Whether the Bytebase instance is running in demo mode.host:readOnly: truetype: string- description: host is the Bytebase instance host.+ description: The host address of the Bytebase instance.port:readOnly: truetype: string- description: port is the Bytebase instance port.+ description: The port number of the Bytebase instance.externalUrl:readOnly: truetype: string- description: external_url is the URL where user or webhook callback visits Bytebase.+ description: The external URL where users or webhook callbacks access Bytebase.needAdminSetup:readOnly: truetype: boolean- description: need_admin_setup flag means the Bytebase instance doesn't have any end users.+ description: Whether the Bytebase instance requires initial admin setup.disallowSignup:readOnly: truetype: boolean- description: disallow_signup is the flag to disable self-service signup.+ description: Whether self-service user signup is disabled.lastActiveTime:readOnly: truetype: string- description: last_active_time is the service last active time in UTC Time Format, any API calls will refresh this value.+ description: The last time any API call was made, refreshed on each request.format: date-timerequire2fa:readOnly: truetype: boolean- description: require_2fa is the flag to require 2FA for all users.+ description: Whether two-factor authentication is required for all users.workspaceId:readOnly: truetype: string- description: workspace_id is the identifier for the workspace.+ description: The unique identifier for the workspace.debug:type: boolean- description: debug flag means if the debug mode is enabled.+ description: Whether debug mode is enabled.unlicensedFeatures:readOnly: truetype: arrayitems:type: string+ description: List of features that are not licensed.disallowPasswordSignin:readOnly: truetype: boolean- description: disallow_password_signin is the flag to disallow user signin with email&password. (except workspace admins)+ description: Whether password-based signin is disabled (except for workspace admins).passwordRestriction:readOnly: trueallOf:- $ref: '#/components/schemas/PasswordRestrictionSetting'+ description: Password complexity and restriction requirements.docker:readOnly: truetype: boolean- description: docker flag means if the Bytebase instance is running in docker.+ description: Whether the Bytebase instance is running in Docker.userStats:readOnly: truetype: arrayitems:$ref: '#/components/schemas/ActuatorInfo_StatUser'+ description: Statistics about users in the system.activatedInstanceCount:readOnly: truetype: integer+ description: The number of activated database instances.format: int32totalInstanceCount:readOnly: truetype: integer+ description: The total number of database instances.format: int32enableSample:readOnly: truetype: boolean+ description: Whether sample data setup is enabled.description: |-- ServerInfo is the API message for server info.+ System information and configuration for the Bytebase instance.Actuator concept is similar to the Spring Boot Actuator.ActuatorInfo_StatUser:type: object@@ -8234,6 +8605,7 @@ components:- SYSTEM_BOT- SERVICE_ACCOUNTtype: string+ description: The type of user.format: enumstate:enum:@@ -8241,10 +8613,13 @@ components:- ACTIVE- DELETEDtype: string+ description: The state of the user.format: enumcount:type: integer+ description: The count of users matching this type and state.format: int32+ description: User statistics by type and state.AddDataSourceRequest:required:- name@@ -8381,11 +8756,11 @@ components:- WARNING- CRITICALtype: string- description: The alert level of announcemnt+ description: The alert level of announcementformat: enumtext:type: string- description: The text of announcemnt+ description: The text of announcementlink:type: stringdescription: The optional link, user can follow the link to check extra details@@ -8483,6 +8858,7 @@ components:Format: projects/{project}/issues/{issue}comment:type: string+ description: The comment explaining the approval decision.AuditLog:type: objectproperties:@@ -8497,13 +8873,18 @@ components:createTime:readOnly: truetype: string+ description: The timestamp when the audit log was created.format: date-timeuser:type: string- description: 'Format: users/[email protected]'+ description: |-+ The user who performed the action.+ Format: users/{email}method:type: string- description: e.g. `/bytebase.v1.SQLService/Query`, `bb.project.repository.push`+ description: |-+ The method or action being audited.+ For example: /bytebase.v1.SQLService/Query or bb.project.repository.pushseverity:enum:- DEFAULT@@ -8516,32 +8897,36 @@ components:- ALERT- EMERGENCYtype: string+ description: The severity level of this audit log entry.format: enumresource:type: string- description: The associated resource.+ description: The resource associated with this audit log.request:type: string- description: JSON-encoded request.+ description: The request payload in JSON format.response:type: stringdescription: |-- JSON-encoded response.- Some fields are omitted because they are too large or contain sensitive information.+ The response payload in JSON format.+ Some fields may be omitted if they are too large or contain sensitive information.status:- $ref: '#/components/schemas/Status'+ allOf:+ - $ref: '#/components/schemas/Status'+ description: The status of the operation.latency:pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$type: string- description: The latency of the RPC.+ description: The duration of the operation.serviceData:allOf:- $ref: '#/components/schemas/GoogleProtobufAny'- description: service-specific data about the request, response, and other activities.+ description: Service-specific metadata about the request, response, and activities.requestMetadata:allOf:- $ref: '#/components/schemas/RequestMetadata'- description: Metadata about the operation.+ description: Metadata about the request context.+ description: Audit log entry recording system activity or API call.BatchCancelPlanCheckRunsRequest:required:- parent@@ -8581,6 +8966,7 @@ components:Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{taskRun}reason:type: string+ description: The reason for canceling the task runs.BatchCancelTaskRunsResponse:type: objectproperties: {}@@ -8658,6 +9044,8 @@ components:type: arrayitems:$ref: '#/components/schemas/Expr'+ description: The CEL expression ASTs to deparse.+ description: Request message for batch deparsing CEL expressions.BatchDeparseResponse:type: objectproperties:@@ -8665,6 +9053,8 @@ components:type: arrayitems:type: string+ description: The deparsed CEL expressions as strings.+ description: Response message for batch deparsing CEL expressions.BatchGetDatabasesResponse:type: objectproperties:@@ -8681,6 +9071,7 @@ components:items:$ref: '#/components/schemas/Group'description: The groups from the specified request.+ description: Response message for batch getting groups.BatchGetIamPolicyResponse:type: objectproperties:@@ -8688,13 +9079,18 @@ components:type: arrayitems:$ref: '#/components/schemas/BatchGetIamPolicyResponse_PolicyResult'+ description: The policy results for each requested project.BatchGetIamPolicyResponse_PolicyResult:type: objectproperties:project:type: string+ description: The project resource name.policy:- $ref: '#/components/schemas/IamPolicy'+ allOf:+ - $ref: '#/components/schemas/IamPolicy'+ description: The IAM policy for the project.+ description: Result for a single project's IAM policy.BatchGetUsersResponse:type: objectproperties:@@ -8710,6 +9106,8 @@ components:type: arrayitems:type: string+ description: The CEL expression strings to parse.+ description: Request message for batch parsing CEL expressions.BatchParseResponse:type: objectproperties:@@ -8717,6 +9115,8 @@ components:type: arrayitems:$ref: '#/components/schemas/Expr'+ description: The parsed CEL expressions as AST.+ description: Response message for batch parsing CEL expressions.BatchRunTasksRequest:type: objectproperties:@@ -8734,6 +9134,7 @@ components:Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}reason:type: string+ description: The reason for running the tasks.runTime:type: stringdescription: The task run should run after run_time.@@ -8758,6 +9159,7 @@ components:Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}reason:type: string+ description: The reason for skipping the tasks.BatchSkipTasksResponse:type: objectproperties: {}@@ -8869,6 +9271,7 @@ components:format: enumreason:type: string+ description: The reason for the status change.BatchUpdateIssuesStatusResponse:type: objectproperties: {}@@ -8912,6 +9315,7 @@ components:allOf:- $ref: '#/components/schemas/Expr'description: The parsed expression of the condition.+ description: Binding associates members with a role and optional conditions.BoundingBox:type: objectproperties:@@ -9030,13 +9434,14 @@ components:properties:sheet:type: string- description: The name of a sheet.+ description: The sheet containing the SQL statement.source:type: stringdescription: |-- The source of origin.- 1) changelog: instances/{instance}/databases/{database}/changelogs/{changelog}.- 2) raw SQL if empty.+ The source of this change.+ Format: instances/{instance}/databases/{database}/changelogs/{changelog}+ If empty, the change is from raw SQL.+ description: A single change in a changelist.Changelog:type: objectproperties:@@ -9144,9 +9549,10 @@ components:type: arrayitems:$ref: '#/components/schemas/CheckReleaseResponse_CheckResult'+ description: The check results for each file and target combination.affectedRows:type: string- description: The affected rows of the check.+ description: The total affected rows across all checks.riskLevel:enum:- RISK_LEVEL_UNSPECIFIED@@ -9184,6 +9590,7 @@ components:type: stringdescription: The risk level of the statement on the target.format: enum+ description: Check result for a single release file on a target database.CheckRequest:required:- name@@ -9220,17 +9627,23 @@ components:properties:name:type: string+ description: The column name.semanticType:type: string+ description: The semantic type describing the data purpose.labels:type: objectadditionalProperties:type: string- description: The user labels for a column.+ description: User-defined labels for this column.classification:type: string+ description: The data classification level for this column.objectSchema:- $ref: '#/components/schemas/ObjectSchema'+ allOf:+ - $ref: '#/components/schemas/ObjectSchema'+ description: Object schema for complex column types like JSON.+ description: Column metadata within a table.ColumnMetadata:type: objectproperties:@@ -9690,6 +10103,7 @@ components:roleId:writeOnly: truetype: string+ description: The role ID for Vault AppRole authentication.secretId:writeOnly: truetype: string@@ -9700,6 +10114,7 @@ components:- PLAIN- ENVIRONMENTtype: string+ description: The type of secret for AppRole authentication.format: enummountPath:type: string@@ -9825,6 +10240,8 @@ components:type: arrayitems:$ref: '#/components/schemas/SchemaCatalog'+ description: The schemas in the database.+ description: Catalog metadata for a database including schemas, tables, and columns.DatabaseGroup:type: objectproperties:@@ -9859,6 +10276,7 @@ components:items:$ref: '#/components/schemas/DatabaseGroup_Database'description: The list of databases that match the database group condition.+ description: A group of databases matched by expressions.DatabaseGroup_Database:type: objectproperties:@@ -9867,6 +10285,7 @@ components:description: |-The resource name of the database.Format: instances/{instance}/databases/{database}+ description: A database within a database group.DatabaseMetadata:type: objectproperties:@@ -10089,11 +10508,13 @@ components:description: |-A page token, received from a previous `ExportAuditLogs` call.Provide this to retrieve the subsequent page.+ description: Request message for exporting audit logs.ExportAuditLogsResponse:type: objectproperties:content:type: string+ description: The exported audit log content in the requested format.format: bytesnextPageToken:type: string@@ -10101,6 +10522,7 @@ components:A token to retrieve next page of log entities.Pass this value in the page_token field in the subsequent callto retrieve the next page of log entities.+ description: Response message for exporting audit logs.ExportRequest:required:- name@@ -10544,15 +10966,19 @@ components:Format: groups/{group}, group is an email.title:type: string+ description: The display title of the group.description:type: string+ description: The description of the group.members:type: arrayitems:$ref: '#/components/schemas/GroupMember'+ description: The members of the group.source:type: string- description: source means where the group comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID.+ description: The source system where the group originated (e.g., Entra ID for SCIM sync).+ description: A group of users within the workspace.GroupMember:type: objectproperties:@@ -10589,8 +11015,10 @@ components:Format: idps/{idp}title:type: string+ description: The display title of the identity provider.domain:type: string+ description: The domain for email matching when using this identity provider.type:enum:- IDENTITY_PROVIDER_TYPE_UNSPECIFIED@@ -10598,25 +11026,39 @@ components:- OIDC- LDAPtype: string+ description: The type of identity provider protocol.format: enumconfig:- $ref: '#/components/schemas/IdentityProviderConfig'+ allOf:+ - $ref: '#/components/schemas/IdentityProviderConfig'+ description: The configuration details for the identity provider.IdentityProviderConfig:type: objectproperties:oauth2Config:- $ref: '#/components/schemas/OAuth2IdentityProviderConfig'+ allOf:+ - $ref: '#/components/schemas/OAuth2IdentityProviderConfig'+ description: OAuth2 protocol configuration.oidcConfig:- $ref: '#/components/schemas/OIDCIdentityProviderConfig'+ allOf:+ - $ref: '#/components/schemas/OIDCIdentityProviderConfig'+ description: OIDC protocol configuration.ldapConfig:- $ref: '#/components/schemas/LDAPIdentityProviderConfig'+ allOf:+ - $ref: '#/components/schemas/LDAPIdentityProviderConfig'+ description: LDAP protocol configuration.IdentityProviderContext:type: objectproperties:oauth2Context:- $ref: '#/components/schemas/OAuth2IdentityProviderContext'+ allOf:+ - $ref: '#/components/schemas/OAuth2IdentityProviderContext'+ description: OAuth2 authentication context.oidcContext:- $ref: '#/components/schemas/OIDCIdentityProviderContext'+ allOf:+ - $ref: '#/components/schemas/OIDCIdentityProviderContext'+ description: OpenID Connect authentication context.+ description: Context for identity provider authentication.IndexMetadata:type: objectproperties:@@ -10779,6 +11221,7 @@ components:properties:title:type: string+ description: The display title of the instance.engine:enum:- ENGINE_UNSPECIFIED@@ -10808,16 +11251,20 @@ components:- TRINO- CASSANDRAtype: string+ description: The database engine type.format: enumengineVersion:readOnly: truetype: string+ description: The version of the database engine.dataSources:type: arrayitems:$ref: '#/components/schemas/DataSource'+ description: Data source configurations for the instance.activation:type: boolean+ description: Whether the instance is activated.name:type: stringdescription: |-@@ -10867,6 +11314,7 @@ components:description: 'Format: projects/{project}/issues/{issue}/issueComments/{issueComment-uid}'comment:type: string+ description: The text content of the comment.payload:type: stringdescription: 'TODO: use struct message instead.'@@ -10883,15 +11331,26 @@ components:type: stringdescription: 'Format: users/{email}'approval:- $ref: '#/components/schemas/IssueComment_Approval'+ allOf:+ - $ref: '#/components/schemas/IssueComment_Approval'+ description: Approval event.issueUpdate:- $ref: '#/components/schemas/IssueComment_IssueUpdate'+ allOf:+ - $ref: '#/components/schemas/IssueComment_IssueUpdate'+ description: Issue update event.stageEnd:- $ref: '#/components/schemas/IssueComment_StageEnd'+ allOf:+ - $ref: '#/components/schemas/IssueComment_StageEnd'+ description: Stage end event.taskUpdate:- $ref: '#/components/schemas/IssueComment_TaskUpdate'+ allOf:+ - $ref: '#/components/schemas/IssueComment_TaskUpdate'+ description: Task update event.taskPriorBackup:- $ref: '#/components/schemas/IssueComment_TaskPriorBackup'+ allOf:+ - $ref: '#/components/schemas/IssueComment_TaskPriorBackup'+ description: Task prior backup event.+ description: A comment on an issue.IssueComment_Approval:type: objectproperties:@@ -10902,7 +11361,9 @@ components:- APPROVED- REJECTEDtype: string+ description: The approval status.format: enum+ description: Approval event information.IssueComment_IssueUpdate:type: objectproperties:@@ -10938,27 +11399,36 @@ components:type: arrayitems:type: string+ description: Issue update event information.IssueComment_StageEnd:type: objectproperties:stage:type: string+ description: The stage that ended.+ description: Stage end event information.IssueComment_TaskPriorBackup:type: objectproperties:task:type: string+ description: The task for which backup was performed.tables:type: arrayitems:$ref: '#/components/schemas/TaskPriorBackup_Table'+ description: The tables that were backed up.originalLine:type: integer+ description: The original line number in the statement.format: int32database:type: string+ description: The database that was backed up.error:type: string+ description: Error message if backup failed.+ description: Task prior backup event information.IssueComment_TaskUpdate:type: objectproperties:@@ -10966,6 +11436,7 @@ components:type: arrayitems:type: string+ description: The tasks that were updated.fromSheet:type: stringdescription: 'Format: projects/{project}/sheets/{sheet}'@@ -10983,6 +11454,7 @@ components:- CANCELEDtype: stringformat: enum+ description: Task update event information.IssuePayloadApproval:type: objectproperties:@@ -11110,10 +11582,14 @@ components:properties:value:type: string+ description: The label value/name.color:type: string+ description: The color code for the label (e.g., hex color).group:type: string+ description: The group this label belongs to.+ description: A label for categorizing and organizing issues.ListChangelistsResponse:type: objectproperties:@@ -11127,6 +11603,7 @@ components:description: |-A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages.+ description: Response message for listing changelists.ListChangelogsResponse:type: objectproperties:@@ -11147,12 +11624,14 @@ components:type: arrayitems:$ref: '#/components/schemas/DatabaseGroup'- description: database_groups is the list of database groups.+ description: The database groups from the specified request.nextPageToken:type: stringdescription: |-- Not used. A token, which can be sent as `page_token` to retrieve the next page.+ Pagination is not currently implemented. This field is reserved for future use.+ A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages.+ description: Response message for listing database groups.ListDatabasesResponse:type: objectproperties:@@ -11179,6 +11658,7 @@ components:description: |-A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages.+ description: Response message for listing groups.ListIdentityProvidersResponse:type: objectproperties:@@ -11248,6 +11728,7 @@ components:type: arrayitems:$ref: '#/components/schemas/IssueComment'+ description: The issue comments from the specified request.nextPageToken:type: stringdescription: |-@@ -11325,6 +11806,7 @@ components:type: arrayitems:$ref: '#/components/schemas/Release'+ description: The releases from the specified request.nextPageToken:type: stringdescription: |-@@ -11350,6 +11832,7 @@ components:type: arrayitems:$ref: '#/components/schemas/Revision'+ description: The revisions from the specified request.nextPageToken:type: stringdescription: |-@@ -11374,6 +11857,7 @@ components:type: arrayitems:$ref: '#/components/schemas/Role'+ description: The roles from the specified request.nextPageToken:type: stringdescription: |-@@ -11436,8 +11920,10 @@ components:properties:email:type: string+ description: User's email address.password:type: string+ description: User's password for authentication.web:type: booleandescription: If web is set, we will set access token, refresh token, and user to the cookie.@@ -11464,10 +11950,13 @@ components:properties:token:type: string+ description: Access token for authenticated requests.mfaTempToken:type: string+ description: Temporary token for MFA verification.requireResetPassword:type: boolean+ description: Whether user must reset password before continuing.user:allOf:- $ref: '#/components/schemas/User'@@ -11475,6 +11964,7 @@ components:LogoutRequest:type: objectproperties: {}+ description: Request to logout current user session.MaskingReason:type: objectproperties:@@ -11504,28 +11994,38 @@ components:properties:authUrl:type: string+ description: The authorization endpoint URL for OAuth2 flow.tokenUrl:type: string+ description: The token endpoint URL for exchanging authorization code.userInfoUrl:type: string+ description: The user information endpoint URL.clientId:type: string+ description: The OAuth2 client identifier.clientSecret:type: string+ description: The OAuth2 client secret for authentication.scopes:type: arrayitems:type: string+ description: The list of OAuth2 scopes to request.fieldMapping:- $ref: '#/components/schemas/FieldMapping'+ allOf:+ - $ref: '#/components/schemas/FieldMapping'+ description: Mapping configuration for user attributes from OAuth2 response.skipTlsVerify:type: boolean+ description: Whether to skip TLS certificate verification.authStyle:enum:- OAUTH2_AUTH_STYLE_UNSPECIFIED- IN_PARAMS- IN_HEADERtype: string+ description: The authentication style for client credentials.format: enumdescription: OAuth2IdentityProviderConfig is the structure for OAuth2 identity provider config.OAuth2IdentityProviderContext:@@ -11533,6 +12033,8 @@ components:properties:code:type: string+ description: Authorization code from OAuth2 provider.+ description: OAuth2 authentication context.OAuth2IdentityProviderTestRequestContext:type: objectproperties:@@ -11544,10 +12046,13 @@ components:properties:issuer:type: string+ description: The OIDC issuer URL for the identity provider.clientId:type: string+ description: The OIDC client identifier.clientSecret:type: string+ description: The OIDC client secret for authentication.scopes:type: arrayitems:@@ -11556,15 +12061,19 @@ components:The scopes that the OIDC provider supports.Should be fetched from the well-known configuration file of the OIDC provider.fieldMapping:- $ref: '#/components/schemas/FieldMapping'+ allOf:+ - $ref: '#/components/schemas/FieldMapping'+ description: Mapping configuration for user attributes from OIDC claims.skipTlsVerify:type: boolean+ description: Whether to skip TLS certificate verification.authStyle:enum:- OAUTH2_AUTH_STYLE_UNSPECIFIED- IN_PARAMS- IN_HEADERtype: string+ description: The authentication style for client credentials.format: enumauthEndpoint:readOnly: true@@ -11576,6 +12085,7 @@ components:OIDCIdentityProviderContext:type: objectproperties: {}+ description: OpenID Connect authentication context.ObjectSchema:type: objectproperties:@@ -11588,13 +12098,20 @@ components:- OBJECT- ARRAYtype: string+ description: The data type of this object.format: enumstructKind:- $ref: '#/components/schemas/ObjectSchema_StructKind'+ allOf:+ - $ref: '#/components/schemas/ObjectSchema_StructKind'+ description: Struct schema.arrayKind:- $ref: '#/components/schemas/ObjectSchema_ArrayKind'+ allOf:+ - $ref: '#/components/schemas/ObjectSchema_ArrayKind'+ description: Array schema.semanticType:type: string+ description: The semantic type of this object.+ description: Schema definition for object-type columns.ObjectSchema_ArrayKind:type: objectproperties:@@ -11666,12 +12183,15 @@ components:Format: projects/{project}/rollouts/{rollout}title:type: string+ description: The title of the plan.description:type: string+ description: The description of the plan.specs:type: arrayitems:$ref: '#/components/schemas/Plan_Spec'+ description: The deployment specs for the plan.creator:readOnly: truetype: string@@ -11924,38 +12444,52 @@ components:properties:pid:type: string+ description: Process ID of the session.blockedByPids:type: arrayitems:type: string+ description: PIDs of sessions blocking this session.query:type: string+ description: Current query being executed.state:type: string+ description: Session state (active, idle, etc.).waitEventType:type: string+ description: Wait event type if session is waiting.waitEvent:type: string+ description: Specific wait event if session is waiting.datname:type: string+ description: Database name.usename:type: string+ description: User name.applicationName:type: string+ description: Application name.clientAddr:type: string+ description: Client IP address.clientPort:type: string+ description: Client port number.backendStart:type: string+ description: When the backend process started.format: date-timexactStart:type: string+ description: When the current transaction started.format: date-timequeryStart:type: string+ description: When the current query started.format: date-time- description: Read from `pg_stat_activity`+ description: PostgreSQL session information read from `pg_stat_activity`.PrettyRequest:type: objectproperties:@@ -12036,6 +12570,7 @@ components:properties:statement:type: string+ description: The rollback SQL statement that would undo the task run.PriorBackupDetail:type: objectproperties:@@ -12055,9 +12590,14 @@ components:- $ref: '#/components/schemas/Item_Table'description: The target backup table information.startPosition:- $ref: '#/components/schemas/Position'+ allOf:+ - $ref: '#/components/schemas/Position'+ description: The start position in the SQL statement.endPosition:- $ref: '#/components/schemas/Position'+ allOf:+ - $ref: '#/components/schemas/Position'+ description: The end position in the SQL statement.+ description: A single backup table mapping.Project:type: objectproperties:@@ -12122,8 +12662,9 @@ components:properties:maximumRetries:type: integer- description: The maximum number of retries for the lock timeout issue.+ description: The maximum number of retries for lock timeout errors.format: int32+ description: Execution retry policy configuration.QueryHistory:type: objectproperties:@@ -12342,10 +12883,13 @@ components:properties:start:type: integer+ description: Start position (inclusive).format: int32end:type: integer+ description: End position (exclusive).format: int32+ description: Range of positions in text or sequence.RangeMask_Slice:type: objectproperties:@@ -12372,6 +12916,7 @@ components:Format: projects/{project}/issues/{issue}comment:type: string+ description: The comment explaining the rejection decision.Release:type: objectproperties:@@ -12381,12 +12926,16 @@ components:description: 'Format: projects/{project}/releases/{release}'title:type: string+ description: The title of the release.files:type: arrayitems:$ref: '#/components/schemas/Release_File'+ description: The SQL files included in the release.vcsSource:- $ref: '#/components/schemas/Release_VCSSource'+ allOf:+ - $ref: '#/components/schemas/Release_VCSSource'+ description: The version control source of the release.creator:readOnly: truetype: string@@ -12402,6 +12951,7 @@ components:- ACTIVE- DELETEDtype: string+ description: The lifecycle state of the release.format: enumdigest:type: string@@ -12429,6 +12979,7 @@ components:format: enumversion:type: string+ description: The version identifier for the file.migrationType:enum:- MIGRATION_TYPE_UNSPECIFIED@@ -12461,6 +13012,7 @@ components:readOnly: truetype: stringdescription: The size of the statement in bytes.+ description: A SQL file in a release.Release_VCSSource:type: objectproperties:@@ -12472,10 +13024,12 @@ components:- BITBUCKET- AZURE_DEVOPStype: string+ description: The type of VCS.format: enumurl:type: stringdescription: The url link to the e.g. GitHub commit or pull request.+ description: Version control system source information.RemoveDataSourceRequest:required:- name@@ -12514,18 +13068,19 @@ components:Format: projects/{project}/issues/{issue}comment:type: string+ description: The comment explaining the request.RequestMetadata:type: objectproperties:callerIp:type: string- description: The IP address of the caller.+ description: The IP address of the request originator.callerSuppliedUserAgent:type: stringdescription: |-- The user agent of the caller.- This information is not authenticated and should be treated accordingly.- description: Metadata about the request.+ The user agent string provided by the caller.+ This is supplied by the client and is not authenticated.+ description: Metadata about the incoming request.ResourcePackage:type: objectproperties:@@ -12533,7 +13088,7 @@ components:type: stringdescription: The branding logo.format: bytes- description: The theme resources.+ description: Custom branding resources for the Bytebase instance.Result_SqlReviewReport:type: objectproperties:@@ -12574,19 +13129,22 @@ components:Format: reviewConfigs/{reviewConfig}title:type: string+ description: The title of the review configuration.enabled:type: boolean+ description: Whether the review configuration is enabled.rules:type: arrayitems:$ref: '#/components/schemas/SQLReviewRule'+ description: The SQL review rules to enforce.resources:type: arrayitems:type: stringdescription: |-resources using the config.- Format: {resurce}/{resource id}, for example, environments/test.+ Format: {resource}/{resource id}, for example, environments/test.Revision:type: objectproperties:@@ -12620,6 +13178,7 @@ components:Can be empty.version:type: string+ description: The schema version string for this revision.sheet:type: stringdescription: |-@@ -12636,6 +13195,7 @@ components:statementSize:readOnly: truetype: string+ description: The size of the statement in bytes.issue:type: stringdescription: |-@@ -12675,6 +13235,7 @@ components:format: enumtitle:type: string+ description: The title of the risk rule.level:enum:- RISK_LEVEL_UNSPECIFIED@@ -12682,9 +13243,11 @@ components:- MODERATE- HIGHtype: string+ description: The risk level assigned when this rule matches.format: enumactive:type: boolean+ description: Whether the risk rule is active.condition:allOf:- $ref: '#/components/schemas/Expr'@@ -12743,22 +13306,27 @@ components:properties:name:type: string- description: 'Format: roles/{role}'+ description: 'Resource name. Format: roles/{role}'title:type: string+ description: Human-readable title.description:type: string+ description: Optional description of the role.permissions:type: arrayitems:type: string+ description: List of permission identifiers granted by this role.type:enum:- TYPE_UNSPECIFIED- BUILT_IN- CUSTOMtype: string+ description: Role type indicating if it's built-in or custom.format: enum+ description: Role defines a set of permissions that can be assigned to users.Rollout:required:- plan@@ -12965,10 +13533,13 @@ components:properties:name:type: string+ description: The schema name.tables:type: arrayitems:$ref: '#/components/schemas/TableCatalog'+ description: The tables in the schema.+ description: Schema metadata within a database.SchemaTemplateSetting:type: objectproperties:@@ -13150,6 +13721,7 @@ components:description: |-A page token, received from a previous `SearchLogs` call.Provide this to retrieve the subsequent page.+ description: Request message for searching audit logs.SearchAuditLogsResponse:type: objectproperties:@@ -13163,6 +13735,7 @@ components:A token to retrieve next page of log entities.Pass this value in the page_token field in the subsequent callto retrieve the next page of log entities.+ description: Response message for searching audit logs.SearchIssuesRequest:required:- parent@@ -13362,7 +13935,7 @@ components:- database: the database full name in "instances/{id}/databases/{name}" format, support "==" operator.- instance: the instance full name in "instances/{id}" format, support "==" operator.- type: the type, should be "QUERY" or "EXPORT", support "==" operator.- - statement: the SQL statemnt, support ".matches()" operator.+ - statement: the SQL statement, support ".matches()" operator.For example:project == "projects/{project}"@@ -13394,6 +13967,7 @@ components:type: arrayitems:$ref: '#/components/schemas/Release'+ description: The releases matching the search criteria.nextPageToken:type: stringdescription: |-@@ -13423,7 +13997,7 @@ components:pageSize:type: integerdescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.The maximum number of worksheets to return. The service may return fewer thanthis value.If unspecified, at most 10 worksheets will be returned.@@ -13432,7 +14006,7 @@ components:pageToken:type: stringdescription: |-- Not used.+ Pagination is not currently implemented. This field is reserved for future use.A page token, received from a previous `SearchWorksheets` call.Provide this to retrieve the subsequent page.@@ -13449,7 +14023,8 @@ components:nextPageToken:type: stringdescription: |-- Not used. A token, which can be sent as `page_token` to retrieve the next page.+ Pagination is not currently implemented. This field is reserved for future use.+ A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages.SemanticTypeSetting:type: object@@ -13492,6 +14067,7 @@ components:etag:type: stringdescription: The current etag of the policy.+ description: Request message for setting an IAM policy.Setting:type: objectproperties:@@ -13505,7 +14081,7 @@ components:value:allOf:- $ref: '#/components/schemas/Value'- description: The value of the setting.+ description: The configuration value of the setting.description: The schema of setting.Sheet:required:@@ -13518,9 +14094,9 @@ components:name:type: stringdescription: |-- The name of the sheet resource, generated by the server.- Canonical parent is project.+ The name of the sheet resource.Format: projects/{project}/sheets/{sheet}+ The sheet ID is generated by the server on creation and cannot be changed.title:type: stringdescription: The title of the sheet.@@ -13547,7 +14123,9 @@ components:type: stringdescription: content_size is the full size of the content, may not match the size of the `content` field.payload:- $ref: '#/components/schemas/SheetPayload'+ allOf:+ - $ref: '#/components/schemas/SheetPayload'+ description: Additional metadata and configuration for the sheet.engine:enum:- ENGINE_UNSPECIFIED@@ -13652,6 +14230,7 @@ components:type: arrayitems:$ref: '#/components/schemas/Task'+ description: The tasks within this stage.Status:type: objectproperties:@@ -13782,12 +14361,19 @@ components:properties:name:type: string+ description: The table name.columns:- $ref: '#/components/schemas/TableCatalog_Columns'+ allOf:+ - $ref: '#/components/schemas/TableCatalog_Columns'+ description: Regular table columns.objectSchema:- $ref: '#/components/schemas/ObjectSchema'+ allOf:+ - $ref: '#/components/schemas/ObjectSchema'+ description: Object schema for JSON/XML columns.classification:type: string+ description: The data classification level for this table.+ description: Table metadata within a schema.TableCatalog_Columns:type: objectproperties:@@ -13795,6 +14381,8 @@ components:type: arrayitems:$ref: '#/components/schemas/ColumnCatalog'+ description: The columns in the table.+ description: Column list for regular tables.TableMetadata:type: objectproperties:@@ -13860,6 +14448,7 @@ components:description: The check_constraints is the list of check constraints in a table.owner:type: string+ description: The owner of the table.sortingKeys:type: arrayitems:@@ -13871,8 +14460,10 @@ components:type: arrayitems:$ref: '#/components/schemas/TriggerMetadata'+ description: The triggers is the list of triggers associated with the table.skipDump:type: boolean+ description: Whether to skip this table during schema dump operations.shardingInfo:type: stringdescription: https://docs.pingcap.com/tidb/stable/information-schema-tables/@@ -13973,6 +14564,7 @@ components:format: enumskippedReason:type: string+ description: The reason why the task was skipped.type:enum:- TYPE_UNSPECIFIED@@ -14176,7 +14768,9 @@ components:type: stringdescription: 'Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/session'postgres:- $ref: '#/components/schemas/TaskRunSession_Postgres'+ allOf:+ - $ref: '#/components/schemas/TaskRunSession_Postgres'+ description: PostgreSQL session information.TaskRunSession_Postgres:type: objectproperties:@@ -14194,6 +14788,7 @@ components:items:$ref: '#/components/schemas/Postgres_Session'description: '`blocked_sessions` are blocked by `session`.'+ description: PostgreSQL session information.Task_DatabaseCreate:type: objectproperties:@@ -14213,10 +14808,14 @@ components:description: 'Format: projects/{project}/sheets/{sheet}'characterSet:type: string+ description: The character set for the database.collation:type: string+ description: The collation for the database.environment:type: string+ description: The environment the database belongs to.+ description: Payload for creating a new database.Task_DatabaseDataExport:type: objectproperties:@@ -14243,8 +14842,9 @@ components:password:type: stringdescription: |-- The zip password provide by users.+ The zip password provided by users.Leave it empty if no needs to encrypt the zip file.+ description: Payload for exporting database data.Task_DatabaseUpdate:type: objectproperties:@@ -14253,12 +14853,14 @@ components:description: 'Format: projects/{project}/sheets/{sheet}'schemaVersion:type: string+ description: The target schema version after this update.databaseChangeType:enum:- DATABASE_CHANGE_TYPE_UNSPECIFIED- MIGRATE- SDLtype: string+ description: The type of database change (MIGRATE or SDL).format: enummigrationType:enum:@@ -14269,6 +14871,7 @@ components:type: stringdescription: migration_type is only set when database_change_type is MIGRATE.format: enum+ description: Payload for updating a database schema.TessellationConfig:type: objectproperties:@@ -14450,11 +15053,14 @@ components:- ACTIVE- DELETEDtype: string+ description: The lifecycle state of the user account.format: enumemail:type: string+ description: The email address of the user, used for login and notifications.title:type: string+ description: The display title or full name of the user.userType:enum:- USER_TYPE_UNSPECIFIED@@ -14462,13 +15068,16 @@ components:- SYSTEM_BOT- SERVICE_ACCOUNTtype: string+ description: The type of user account.format: enumpassword:writeOnly: truetype: string+ description: The password for authentication. Only used during user creation or password updates.serviceKey:writeOnly: truetype: string+ description: The service key for service account authentication. Only used for service accounts.mfaEnabled:type: booleandescription: The mfa_enabled flag means if the user has enabled MFA.@@ -14486,7 +15095,9 @@ components:Should be a valid E.164 compliant phone number.Could be empty.profile:- $ref: '#/components/schemas/User_Profile'+ allOf:+ - $ref: '#/components/schemas/User_Profile'+ description: User profile metadata.groups:readOnly: truetype: array@@ -14500,9 +15111,11 @@ components:properties:lastLoginTime:type: string+ description: The last time the user successfully logged in.format: date-timelastChangePasswordTime:type: string+ description: The last time the user changed their password.format: date-timesource:type: string@@ -14742,31 +15355,60 @@ components:description: Whether to enable metric collection for the workspace.tags:- name: ActuatorService+ description: ActuatorService manages system health and operational information.- name: AuditLogService+ description: AuditLogService manages audit logs for system activities and API calls.- name: AuthService+ description: AuthService handles user authentication operations.- name: CelService+ description: CelService manages CEL (Common Expression Language) parsing and formatting operations.- name: ChangelistService+ description: ChangelistService manages changelists for grouping and organizing database changes.- name: DatabaseCatalogService+ description: DatabaseCatalogService manages database schema metadata and classification.- name: DatabaseGroupService+ description: DatabaseGroupService manages database groups for organizing databases by criteria.- name: DatabaseService+ description: DatabaseService manages databases and their schemas.- name: GroupService+ description: GroupService manages user groups for organizing users and permissions.- name: IdentityProviderService+ description: IdentityProviderService manages external identity providers for SSO authentication.- name: InstanceRoleService+ description: InstanceRoleService manages database roles within instances.- name: InstanceService+ description: InstanceService manages database instances and their connections.- name: IssueService+ description: IssueService manages issues for tracking database changes and tasks.- name: OrgPolicyService+ description: OrgPolicyService manages organizational policies at various resource levels.- name: PlanService+ description: PlanService manages deployment plans for database changes.- name: ProjectService+ description: ProjectService manages projects that group databases and changes.- name: ReleaseService+ description: ReleaseService manages releases for coordinating deployments.- name: ReviewConfigService+ description: ReviewConfigService manages approval flow configurations.- name: RevisionService+ description: RevisionService manages schema revision history.- name: RiskService+ description: RiskService manages risk assessment rules for database changes.- name: RoleService+ description: RoleService manages workspace roles and permissions.- name: RolloutService+ description: RolloutService manages the execution of deployment plans.- name: SQLService+ description: SQLService executes SQL queries and manages query operations.- name: SettingService+ description: SettingService manages workspace-level settings and configurations.- name: SheetService+ description: SheetService manages SQL scripts and saved queries.- name: SubscriptionService+ description: SubscriptionService manages enterprise subscriptions and licensing.- name: UserService+ description: UserService manages user accounts and authentication.- name: WorksheetService+ description: WorksheetService manages SQL worksheets for query development.- name: WorkspaceService+ description: WorkspaceService manages workspace-level operations and profile.diff --git a/proto/gen/grpc-doc/v1/README.md b/proto/gen/grpc-doc/v1/README.mdindex 03e6d878b7..e8825ef1a0 100644--- a/proto/gen/grpc-doc/v1/README.md+++ b/proto/gen/grpc-doc/v1/README.md@@ -723,13 +723,13 @@<a name="bytebase-v1-AuthMethod"></a>### AuthMethod-+Authorization method for RPC calls.| Name | Number | Description || ---- | ------ | ----------- |-| AUTH_METHOD_UNSPECIFIED | 0 | |-| IAM | 1 | IAM uses the standard IAM authorization check on the organizational resources. |-| CUSTOM | 2 | Custom authorization method. |+| AUTH_METHOD_UNSPECIFIED | 0 | Unspecified authorization method. |+| IAM | 1 | Standard IAM authorization check on organizational resources. |+| CUSTOM | 2 | Custom authorization logic. |@@ -740,10 +740,10 @@### File-level Extensions| Extension | Type | Base | Number | Description || --------- | ---- | ---- | ------ | ----------- |-| allow_without_credential | bool | .google.protobuf.MethodOptions | 100000 | |-| audit | bool | .google.protobuf.MethodOptions | 100003 | |-| auth_method | AuthMethod | .google.protobuf.MethodOptions | 100002 | |-| permission | string | .google.protobuf.MethodOptions | 100001 | |+| allow_without_credential | bool | .google.protobuf.MethodOptions | 100000 | Whether the method allows access without authentication credentials. |+| audit | bool | .google.protobuf.MethodOptions | 100003 | Whether to audit calls to this method. |+| auth_method | AuthMethod | .google.protobuf.MethodOptions | 100002 | The authorization method to use for this RPC. |+| permission | string | .google.protobuf.MethodOptions | 100001 | The permission required to call this method. |@@ -778,13 +778,13 @@ offset.<a name="bytebase-v1-Range"></a>### Range-+Range of positions in text or sequence.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| start | [int32](#int32) | | |-| end | [int32](#int32) | | |+| start | [int32](#int32) | | Start position (inclusive). |+| end | [int32](#int32) | | End position (exclusive). |@@ -809,51 +809,51 @@ DatabaseChangeType is the database change type.<a name="bytebase-v1-Engine"></a>### Engine-+Database engine type.| Name | Number | Description || ---- | ------ | ----------- |-| ENGINE_UNSPECIFIED | 0 | |-| CLICKHOUSE | 1 | |-| MYSQL | 2 | |-| POSTGRES | 3 | |-| SNOWFLAKE | 4 | |-| SQLITE | 5 | |-| TIDB | 6 | |-| MONGODB | 7 | |-| REDIS | 8 | |-| ORACLE | 9 | |-| SPANNER | 10 | |-| MSSQL | 11 | |-| REDSHIFT | 12 | |-| MARIADB | 13 | |-| OCEANBASE | 14 | |-| STARROCKS | 18 | |-| DORIS | 19 | |-| HIVE | 20 | |-| ELASTICSEARCH | 21 | |-| BIGQUERY | 22 | |-| DYNAMODB | 23 | |-| DATABRICKS | 24 | |-| COCKROACHDB | 25 | |-| COSMOSDB | 26 | |-| TRINO | 27 | |-| CASSANDRA | 28 | |+| ENGINE_UNSPECIFIED | 0 | Unspecified database engine. |+| CLICKHOUSE | 1 | ClickHouse columnar database. |+| MYSQL | 2 | MySQL relational database. |+| POSTGRES | 3 | PostgreSQL relational database. |+| SNOWFLAKE | 4 | Snowflake cloud data warehouse. |+| SQLITE | 5 | SQLite embedded database. |+| TIDB | 6 | TiDB distributed SQL database. |+| MONGODB | 7 | MongoDB document database. |+| REDIS | 8 | Redis key-value store. |+| ORACLE | 9 | Oracle relational database. |+| SPANNER | 10 | Google Cloud Spanner distributed database. |+| MSSQL | 11 | Microsoft SQL Server relational database. |+| REDSHIFT | 12 | Amazon Redshift data warehouse. |+| MARIADB | 13 | MariaDB relational database. |+| OCEANBASE | 14 | OceanBase distributed database. |+| STARROCKS | 18 | StarRocks analytics database. |+| DORIS | 19 | Apache Doris analytics database. |+| HIVE | 20 | Apache Hive data warehouse. |+| ELASTICSEARCH | 21 | Elasticsearch search engine. |+| BIGQUERY | 22 | Google BigQuery data warehouse. |+| DYNAMODB | 23 | Amazon DynamoDB NoSQL database. |+| DATABRICKS | 24 | Databricks lakehouse platform. |+| COCKROACHDB | 25 | CockroachDB distributed SQL database. |+| COSMOSDB | 26 | Azure Cosmos DB multi-model database. |+| TRINO | 27 | Trino distributed SQL query engine. |+| CASSANDRA | 28 | Apache Cassandra NoSQL database. |<a name="bytebase-v1-ExportFormat"></a>### ExportFormat-+Data export format.| Name | Number | Description || ---- | ------ | ----------- |-| FORMAT_UNSPECIFIED | 0 | |-| CSV | 1 | |-| JSON | 2 | |-| SQL | 3 | |-| XLSX | 4 | |+| FORMAT_UNSPECIFIED | 0 | Unspecified export format. |+| CSV | 1 | Comma-separated values format. |+| JSON | 2 | JavaScript Object Notation format. |+| SQL | 3 | SQL statements format. |+| XLSX | 4 | Microsoft Excel spreadsheet format. |@@ -878,38 +878,38 @@ RiskLevel is the risk level.| Name | Number | Description || ---- | ------ | ----------- |-| RISK_LEVEL_UNSPECIFIED | 0 | |-| LOW | 1 | |-| MODERATE | 2 | |-| HIGH | 3 | |+| RISK_LEVEL_UNSPECIFIED | 0 | Unspecified risk level. |+| LOW | 1 | Low risk operation. |+| MODERATE | 2 | Moderate risk operation. |+| HIGH | 3 | High risk operation. |<a name="bytebase-v1-State"></a>### State-+Resource lifecycle state.| Name | Number | Description || ---- | ------ | ----------- || STATE_UNSPECIFIED | 0 | |-| ACTIVE | 1 | |-| DELETED | 2 | |+| ACTIVE | 1 | Resource is active and operational. |+| DELETED | 2 | Resource is soft-deleted but may be recoverable. |<a name="bytebase-v1-VCSType"></a>### VCSType-+Version control system type.| Name | Number | Description || ---- | ------ | ----------- |-| VCS_TYPE_UNSPECIFIED | 0 | |-| GITHUB | 1 | |-| GITLAB | 2 | |-| BITBUCKET | 3 | |-| AZURE_DEVOPS | 4 | |+| VCS_TYPE_UNSPECIFIED | 0 | Unspecified VCS type. |+| GITHUB | 1 | GitHub version control platform. |+| GITLAB | 2 | GitLab version control platform. |+| BITBUCKET | 3 | Bitbucket version control platform. |+| AZURE_DEVOPS | 4 | Azure DevOps version control platform. |@@ -930,16 +930,16 @@ RiskLevel is the risk level.<a name="bytebase-v1-ColumnCatalog"></a>### ColumnCatalog-+Column metadata within a table.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | |-| semantic_type | [string](#string) | | |-| labels | [ColumnCatalog.LabelsEntry](#bytebase-v1-ColumnCatalog-LabelsEntry) | repeated | The user labels for a column. |-| classification | [string](#string) | | |-| object_schema | [ObjectSchema](#bytebase-v1-ObjectSchema) | optional | |+| name | [string](#string) | | The column name. |+| semantic_type | [string](#string) | | The semantic type describing the data purpose. |+| labels | [ColumnCatalog.LabelsEntry](#bytebase-v1-ColumnCatalog-LabelsEntry) | repeated | User-defined labels for this column. |+| classification | [string](#string) | | The data classification level for this column. |+| object_schema | [ObjectSchema](#bytebase-v1-ObjectSchema) | optional | Object schema for complex column types like JSON. |@@ -965,13 +965,13 @@ RiskLevel is the risk level.<a name="bytebase-v1-DatabaseCatalog"></a>### DatabaseCatalog-+Catalog metadata for a database including schemas, tables, and columns.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || name | [string](#string) | | The name of the database catalog. Format: instances/{instance}/databases/{database}/catalog |-| schemas | [SchemaCatalog](#bytebase-v1-SchemaCatalog) | repeated | |+| schemas | [SchemaCatalog](#bytebase-v1-SchemaCatalog) | repeated | The schemas in the database. |@@ -981,7 +981,7 @@ RiskLevel is the risk level.<a name="bytebase-v1-GetDatabaseCatalogRequest"></a>### GetDatabaseCatalogRequest-+Request message for getting a database catalog.| Field | Type | Label | Description |@@ -996,15 +996,15 @@ RiskLevel is the risk level.<a name="bytebase-v1-ObjectSchema"></a>### ObjectSchema-+Schema definition for object-type columns.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| type | [ObjectSchema.Type](#bytebase-v1-ObjectSchema-Type) | | |-| struct_kind | [ObjectSchema.StructKind](#bytebase-v1-ObjectSchema-StructKind) | | |-| array_kind | [ObjectSchema.ArrayKind](#bytebase-v1-ObjectSchema-ArrayKind) | | |-| semantic_type | [string](#string) | | |+| type | [ObjectSchema.Type](#bytebase-v1-ObjectSchema-Type) | | The data type of this object. |+| struct_kind | [ObjectSchema.StructKind](#bytebase-v1-ObjectSchema-StructKind) | | Struct schema. |+| array_kind | [ObjectSchema.ArrayKind](#bytebase-v1-ObjectSchema-ArrayKind) | | Array schema. |+| semantic_type | [string](#string) | | The semantic type of this object. |@@ -1014,12 +1014,12 @@ RiskLevel is the risk level.<a name="bytebase-v1-ObjectSchema-ArrayKind"></a>### ObjectSchema.ArrayKind-+Array type with element schema.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| kind | [ObjectSchema](#bytebase-v1-ObjectSchema) | | |+| kind | [ObjectSchema](#bytebase-v1-ObjectSchema) | | The schema of array elements. |@@ -1029,12 +1029,12 @@ RiskLevel is the risk level.<a name="bytebase-v1-ObjectSchema-StructKind"></a>### ObjectSchema.StructKind-+Structure type with named properties.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| properties | [ObjectSchema.StructKind.PropertiesEntry](#bytebase-v1-ObjectSchema-StructKind-PropertiesEntry) | repeated | |+| properties | [ObjectSchema.StructKind.PropertiesEntry](#bytebase-v1-ObjectSchema-StructKind-PropertiesEntry) | repeated | Properties of the struct. |@@ -1060,13 +1060,13 @@ RiskLevel is the risk level.<a name="bytebase-v1-SchemaCatalog"></a>### SchemaCatalog-+Schema metadata within a database.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | |-| tables | [TableCatalog](#bytebase-v1-TableCatalog) | repeated | |+| name | [string](#string) | | The schema name. |+| tables | [TableCatalog](#bytebase-v1-TableCatalog) | repeated | The tables in the schema. |@@ -1076,15 +1076,15 @@ RiskLevel is the risk level.<a name="bytebase-v1-TableCatalog"></a>### TableCatalog-+Table metadata within a schema.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | |-| columns | [TableCatalog.Columns](#bytebase-v1-TableCatalog-Columns) | | |-| object_schema | [ObjectSchema](#bytebase-v1-ObjectSchema) | | |-| classification | [string](#string) | | |+| name | [string](#string) | | The table name. |+| columns | [TableCatalog.Columns](#bytebase-v1-TableCatalog-Columns) | | Regular table columns. |+| object_schema | [ObjectSchema](#bytebase-v1-ObjectSchema) | | Object schema for JSON/XML columns. |+| classification | [string](#string) | | The data classification level for this table. |@@ -1094,12 +1094,12 @@ RiskLevel is the risk level.<a name="bytebase-v1-TableCatalog-Columns"></a>### TableCatalog.Columns-+Column list for regular tables.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| columns | [ColumnCatalog](#bytebase-v1-ColumnCatalog) | repeated | |+| columns | [ColumnCatalog](#bytebase-v1-ColumnCatalog) | repeated | The columns in the table. |@@ -1109,7 +1109,7 @@ RiskLevel is the risk level.<a name="bytebase-v1-UpdateDatabaseCatalogRequest"></a>### UpdateDatabaseCatalogRequest-+Request message for updating a database catalog.| Field | Type | Label | Description |@@ -1129,16 +1129,16 @@ The catalog's `name` field is used to identify the database catalog to updat<a name="bytebase-v1-ObjectSchema-Type"></a>### ObjectSchema.Type-+Object schema data types.| Name | Number | Description || ---- | ------ | ----------- |-| TYPE_UNSPECIFIED | 0 | |-| STRING | 1 | |-| NUMBER | 2 | |-| BOOLEAN | 3 | |-| OBJECT | 4 | |-| ARRAY | 5 | |+| TYPE_UNSPECIFIED | 0 | Unspecified type. |+| STRING | 1 | String type. |+| NUMBER | 2 | Number type. |+| BOOLEAN | 3 | Boolean type. |+| OBJECT | 4 | Object/struct type. |+| ARRAY | 5 | Array type. |@@ -1149,12 +1149,12 @@ The catalog's `name` field is used to identify the database catalog to updat<a name="bytebase-v1-DatabaseCatalogService"></a>### DatabaseCatalogService-+DatabaseCatalogService manages database schema metadata and classification.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| GetDatabaseCatalog | [GetDatabaseCatalogRequest](#bytebase-v1-GetDatabaseCatalogRequest) | [DatabaseCatalog](#bytebase-v1-DatabaseCatalog) | Permissions required: bb.databaseCatalogs.get |-| UpdateDatabaseCatalog | [UpdateDatabaseCatalogRequest](#bytebase-v1-UpdateDatabaseCatalogRequest) | [DatabaseCatalog](#bytebase-v1-DatabaseCatalog) | Permissions required: bb.databaseCatalogs.update |+| GetDatabaseCatalog | [GetDatabaseCatalogRequest](#bytebase-v1-GetDatabaseCatalogRequest) | [DatabaseCatalog](#bytebase-v1-DatabaseCatalog) | Gets the catalog metadata for a database. Permissions required: bb.databaseCatalogs.get |+| UpdateDatabaseCatalog | [UpdateDatabaseCatalogRequest](#bytebase-v1-UpdateDatabaseCatalogRequest) | [DatabaseCatalog](#bytebase-v1-DatabaseCatalog) | Updates catalog metadata such as classifications and labels. Permissions required: bb.databaseCatalogs.update |@@ -1247,12 +1247,12 @@ When paginating, all other parameters provided to `ListInstanceRoles` must match<a name="bytebase-v1-InstanceRoleService"></a>### InstanceRoleService-+InstanceRoleService manages database roles within instances.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| GetInstanceRole | [GetInstanceRoleRequest](#bytebase-v1-GetInstanceRoleRequest) | [InstanceRole](#bytebase-v1-InstanceRole) | Permissions required: bb.instanceRoles.get |-| ListInstanceRoles | [ListInstanceRolesRequest](#bytebase-v1-ListInstanceRolesRequest) | [ListInstanceRolesResponse](#bytebase-v1-ListInstanceRolesResponse) | Permissions required: bb.instanceRoles.list |+| GetInstanceRole | [GetInstanceRoleRequest](#bytebase-v1-GetInstanceRoleRequest) | [InstanceRole](#bytebase-v1-InstanceRole) | Gets a database role from an instance. Permissions required: bb.instanceRoles.get |+| ListInstanceRoles | [ListInstanceRolesRequest](#bytebase-v1-ListInstanceRolesRequest) | [ListInstanceRolesResponse](#bytebase-v1-ListInstanceRolesResponse) | Lists all database roles in an instance. Permissions required: bb.instanceRoles.list |@@ -1364,18 +1364,18 @@ This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. || Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| id | [string](#string) | | |-| type | [DataSourceType](#bytebase-v1-DataSourceType) | | |-| username | [string](#string) | | |-| password | [string](#string) | | |+| id | [string](#string) | | The unique identifier for this data source. |+| type | [DataSourceType](#bytebase-v1-DataSourceType) | | The type of data source (ADMIN or READ_ONLY). |+| username | [string](#string) | | The username for database authentication. |+| password | [string](#string) | | The password for database authentication. || use_ssl | [bool](#bool) | | Use SSL to connect to the data source. By default, we use system default SSL configuration. |-| ssl_ca | [string](#string) | | |-| ssl_cert | [string](#string) | | |-| ssl_key | [string](#string) | | |+| ssl_ca | [string](#string) | | The SSL certificate authority certificate. |+| ssl_cert | [string](#string) | | The SSL client certificate. |+| ssl_key | [string](#string) | | The SSL client private key. || verify_tls_certificate | [bool](#bool) | | verify_tls_certificate enables TLS certificate verification for SSL connections. Default is false (no verification) for backward compatibility. Set to true for secure connections (recommended for production). Only set to false for development or when certificates cannot be properly validated (e.g., self-signed certs, VPN environments). |-| host | [string](#string) | | |-| port | [string](#string) | | |-| database | [string](#string) | | |+| host | [string](#string) | | The hostname or IP address of the database server. |+| port | [string](#string) | | The port number of the database server. |+| database | [string](#string) | | The name of the database to connect to. || srv | [bool](#bool) | | srv, authentication_database and replica_set are used for MongoDB. srv is a boolean flag that indicates whether the host is a DNS SRV record. || authentication_database | [string](#string) | | authentication_database is the database name to authenticate against, which stores the user credentials. || replica_set | [string](#string) | | replica_set is used for MongoDB replica set. |@@ -1500,11 +1500,11 @@ This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. || Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| secret_type | [DataSourceExternalSecret.SecretType](#bytebase-v1-DataSourceExternalSecret-SecretType) | | |-| url | [string](#string) | | |-| auth_type | [DataSourceExternalSecret.AuthType](#bytebase-v1-DataSourceExternalSecret-AuthType) | | |-| app_role | [DataSourceExternalSecret.AppRoleAuthOption](#bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption) | | |-| token | [string](#string) | | |+| secret_type | [DataSourceExternalSecret.SecretType](#bytebase-v1-DataSourceExternalSecret-SecretType) | | The type of external secret store. |+| url | [string](#string) | | The URL of the external secret store. |+| auth_type | [DataSourceExternalSecret.AuthType](#bytebase-v1-DataSourceExternalSecret-AuthType) | | The authentication method for accessing the secret store. |+| app_role | [DataSourceExternalSecret.AppRoleAuthOption](#bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption) | | AppRole authentication configuration. |+| token | [string](#string) | | Token for direct authentication. || engine_name | [string](#string) | | engine name is the name for secret engine. || secret_name | [string](#string) | | the secret name in the engine to store the password. || password_key_name | [string](#string) | | the key name for the password. |@@ -1522,9 +1522,9 @@ This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. || Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| role_id | [string](#string) | | |+| role_id | [string](#string) | | The role ID for Vault AppRole authentication. || secret_id | [string](#string) | | the secret id for the role without ttl. |-| type | [DataSourceExternalSecret.AppRoleAuthOption.SecretType](#bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption-SecretType) | | |+| type | [DataSourceExternalSecret.AppRoleAuthOption.SecretType](#bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption-SecretType) | | The type of secret for AppRole authentication. || mount_path | [string](#string) | | The path where the approle auth method is mounted. |@@ -1573,15 +1573,15 @@ This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. || Field | Type | Label | Description || ----- | ---- | ----- | ----------- || name | [string](#string) | | The name of the instance. Format: instances/{instance} |-| state | [State](#bytebase-v1-State) | | |-| title | [string](#string) | | |-| engine | [Engine](#bytebase-v1-Engine) | | |-| engine_version | [string](#string) | | |-| external_link | [string](#string) | | |-| data_sources | [DataSource](#bytebase-v1-DataSource) | repeated | |+| state | [State](#bytebase-v1-State) | | The lifecycle state of the instance. |+| title | [string](#string) | | The display title of the instance. |+| engine | [Engine](#bytebase-v1-Engine) | | The database engine type. |+| engine_version | [string](#string) | | The version of the database engine. |+| external_link | [string](#string) | | External URL to the database instance console. |+| data_sources | [DataSource](#bytebase-v1-DataSource) | repeated | Data source configurations for connecting to the instance. || environment | [string](#string) | optional | The environment resource. Format: environments/prod where prod is the environment resource ID. |-| activation | [bool](#bool) | | |-| roles | [InstanceRole](#bytebase-v1-InstanceRole) | repeated | |+| activation | [bool](#bool) | | Whether the instance is activated for use. |+| roles | [InstanceRole](#bytebase-v1-InstanceRole) | repeated | Database roles available in this instance. || sync_interval | [google.protobuf.Duration](#google-protobuf-Duration) | | How often the instance is synced. || maximum_connections | [int32](#int32) | | The maximum number of connections. The default is 10 if the value is unset or zero. || sync_databases | [string](#string) | repeated | Enable sync for following databases. Default empty, means sync all schemas & databases. |@@ -1617,11 +1617,11 @@ This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. || Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| title | [string](#string) | | |-| engine | [Engine](#bytebase-v1-Engine) | | |-| engine_version | [string](#string) | | |-| data_sources | [DataSource](#bytebase-v1-DataSource) | repeated | |-| activation | [bool](#bool) | | |+| title | [string](#string) | | The display title of the instance. |+| engine | [Engine](#bytebase-v1-Engine) | | The database engine type. |+| engine_version | [string](#string) | | The version of the database engine. |+| data_sources | [DataSource](#bytebase-v1-DataSource) | repeated | Data source configurations for the instance. |+| activation | [bool](#bool) | | Whether the instance is activated. || name | [string](#string) | | The name of the instance. Format: instances/{instance} || environment | [string](#string) | optional | The environment resource. Format: environments/prod where prod is the environment resource ID. |@@ -1638,13 +1638,13 @@ This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. || Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| primary | [string](#string) | | |-| instance | [string](#string) | | |-| realm | [string](#string) | | |-| keytab | [bytes](#bytes) | | |-| kdc_host | [string](#string) | | |-| kdc_port | [string](#string) | | |-| kdc_transport_protocol | [string](#string) | | |+| primary | [string](#string) | | The primary component of the Kerberos principal. |+| instance | [string](#string) | | The instance component of the Kerberos principal. |+| realm | [string](#string) | | The Kerberos realm. |+| keytab | [bytes](#bytes) | | The keytab file contents for authentication. |+| kdc_host | [string](#string) | | The hostname of the Key Distribution Center (KDC). |+| kdc_port | [string](#string) | | The port of the Key Distribution Center (KDC). |+| kdc_transport_protocol | [string](#string) | | The transport protocol for KDC communication (tcp or udp). |@@ -1746,7 +1746,7 @@ For example: name == "sample instance" name.matches("sample") re| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| krb_config | [KerberosConfig](#bytebase-v1-KerberosConfig) | | |+| krb_config | [KerberosConfig](#bytebase-v1-KerberosConfig) | | Kerberos authentication configuration. |@@ -1875,9 +1875,9 @@ The instance's `name` field is used to identify the instance to update. Form| Name | Number | Description || ---- | ------ | ----------- |-| SECRET_TYPE_UNSPECIFIED | 0 | |-| PLAIN | 1 | |-| ENVIRONMENT | 2 | |+| SECRET_TYPE_UNSPECIFIED | 0 | Unspecified secret type. |+| PLAIN | 1 | Plain text secret. |+| ENVIRONMENT | 2 | Secret from environment variable. |@@ -1888,7 +1888,7 @@ The instance's `name` field is used to identify the instance to update. Form| Name | Number | Description || ---- | ------ | ----------- |-| AUTH_TYPE_UNSPECIFIED | 0 | |+| AUTH_TYPE_UNSPECIFIED | 0 | Unspecified authentication type. || TOKEN | 1 | ref: https://developer.hashicorp.com/vault/docs/auth/token || VAULT_APP_ROLE | 2 | ref: https://developer.hashicorp.com/vault/docs/auth/approle |@@ -1901,7 +1901,7 @@ The instance's `name` field is used to identify the instance to update. Form| Name | Number | Description || ---- | ------ | ----------- |-| SAECRET_TYPE_UNSPECIFIED | 0 | |+| SAECRET_TYPE_UNSPECIFIED | 0 | Unspecified secret type. || VAULT_KV_V2 | 1 | ref: https://developer.hashicorp.com/vault/api-docs/secret/kv/kv-v2 || AWS_SECRETS_MANAGER | 2 | ref: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html || GCP_SECRET_MANAGER | 3 | ref: https://cloud.google.com/secret-manager/docs |@@ -1915,9 +1915,9 @@ The instance's `name` field is used to identify the instance to update. Form| Name | Number | Description || ---- | ------ | ----------- |-| DATA_SOURCE_UNSPECIFIED | 0 | |-| ADMIN | 1 | |-| READ_ONLY | 2 | |+| DATA_SOURCE_UNSPECIFIED | 0 | Unspecified data source type. |+| ADMIN | 1 | Admin data source with write permissions. |+| READ_ONLY | 2 | Read-only data source for query operations. |@@ -1928,23 +1928,23 @@ The instance's `name` field is used to identify the instance to update. Form<a name="bytebase-v1-InstanceService"></a>### InstanceService-+InstanceService manages database instances and their connections.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| GetInstance | [GetInstanceRequest](#bytebase-v1-GetInstanceRequest) | [Instance](#bytebase-v1-Instance) | Permissions required: bb.instances.get |-| ListInstances | [ListInstancesRequest](#bytebase-v1-ListInstancesRequest) | [ListInstancesResponse](#bytebase-v1-ListInstancesResponse) | Permissions required: bb.instances.list |-| CreateInstance | [CreateInstanceRequest](#bytebase-v1-CreateInstanceRequest) | [Instance](#bytebase-v1-Instance) | Permissions required: bb.instances.create |-| UpdateInstance | [UpdateInstanceRequest](#bytebase-v1-UpdateInstanceRequest) | [Instance](#bytebase-v1-Instance) | Permissions required: bb.instances.update |-| DeleteInstance | [DeleteInstanceRequest](#bytebase-v1-DeleteInstanceRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Permissions required: bb.instances.delete |-| UndeleteInstance | [UndeleteInstanceRequest](#bytebase-v1-UndeleteInstanceRequest) | [Instance](#bytebase-v1-Instance) | Permissions required: bb.instances.undelete |-| SyncInstance | [SyncInstanceRequest](#bytebase-v1-SyncInstanceRequest) | [SyncInstanceResponse](#bytebase-v1-SyncInstanceResponse) | Permissions required: bb.instances.sync |-| ListInstanceDatabase | [ListInstanceDatabaseRequest](#bytebase-v1-ListInstanceDatabaseRequest) | [ListInstanceDatabaseResponse](#bytebase-v1-ListInstanceDatabaseResponse) | Permissions required: bb.instances.get |-| BatchSyncInstances | [BatchSyncInstancesRequest](#bytebase-v1-BatchSyncInstancesRequest) | [BatchSyncInstancesResponse](#bytebase-v1-BatchSyncInstancesResponse) | Permissions required: bb.instances.sync |-| BatchUpdateInstances | [BatchUpdateInstancesRequest](#bytebase-v1-BatchUpdateInstancesRequest) | [BatchUpdateInstancesResponse](#bytebase-v1-BatchUpdateInstancesResponse) | Permissions required: bb.instances.update |-| AddDataSource | [AddDataSourceRequest](#bytebase-v1-AddDataSourceRequest) | [Instance](#bytebase-v1-Instance) | Permissions required: bb.instances.update |-| RemoveDataSource | [RemoveDataSourceRequest](#bytebase-v1-RemoveDataSourceRequest) | [Instance](#bytebase-v1-Instance) | Permissions required: bb.instances.update |-| UpdateDataSource | [UpdateDataSourceRequest](#bytebase-v1-UpdateDataSourceRequest) | [Instance](#bytebase-v1-Instance) | Permissions required: bb.instances.update |+| GetInstance | [GetInstanceRequest](#bytebase-v1-GetInstanceRequest) | [Instance](#bytebase-v1-Instance) | Gets a database instance by name. Permissions required: bb.instances.get |+| ListInstances | [ListInstancesRequest](#bytebase-v1-ListInstancesRequest) | [ListInstancesResponse](#bytebase-v1-ListInstancesResponse) | Lists all database instances. Permissions required: bb.instances.list |+| CreateInstance | [CreateInstanceRequest](#bytebase-v1-CreateInstanceRequest) | [Instance](#bytebase-v1-Instance) | Creates a new database instance. Permissions required: bb.instances.create |+| UpdateInstance | [UpdateInstanceRequest](#bytebase-v1-UpdateInstanceRequest) | [Instance](#bytebase-v1-Instance) | Updates a database instance. Permissions required: bb.instances.update |+| DeleteInstance | [DeleteInstanceRequest](#bytebase-v1-DeleteInstanceRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes or soft-deletes a database instance. Permissions required: bb.instances.delete |+| UndeleteInstance | [UndeleteInstanceRequest](#bytebase-v1-UndeleteInstanceRequest) | [Instance](#bytebase-v1-Instance) | Restores a soft-deleted database instance. Permissions required: bb.instances.undelete |+| SyncInstance | [SyncInstanceRequest](#bytebase-v1-SyncInstanceRequest) | [SyncInstanceResponse](#bytebase-v1-SyncInstanceResponse) | Syncs database schemas and metadata from an instance. Permissions required: bb.instances.sync |+| ListInstanceDatabase | [ListInstanceDatabaseRequest](#bytebase-v1-ListInstanceDatabaseRequest) | [ListInstanceDatabaseResponse](#bytebase-v1-ListInstanceDatabaseResponse) | Lists all databases within an instance without creating them. Permissions required: bb.instances.get |+| BatchSyncInstances | [BatchSyncInstancesRequest](#bytebase-v1-BatchSyncInstancesRequest) | [BatchSyncInstancesResponse](#bytebase-v1-BatchSyncInstancesResponse) | Syncs multiple instances in a single request. Permissions required: bb.instances.sync |+| BatchUpdateInstances | [BatchUpdateInstancesRequest](#bytebase-v1-BatchUpdateInstancesRequest) | [BatchUpdateInstancesResponse](#bytebase-v1-BatchUpdateInstancesResponse) | Updates multiple instances in a single request. Permissions required: bb.instances.update |+| AddDataSource | [AddDataSourceRequest](#bytebase-v1-AddDataSourceRequest) | [Instance](#bytebase-v1-Instance) | Adds a read-only data source to an instance. Permissions required: bb.instances.update |+| RemoveDataSource | [RemoveDataSourceRequest](#bytebase-v1-RemoveDataSourceRequest) | [Instance](#bytebase-v1-Instance) | Removes a read-only data source from an instance. Permissions required: bb.instances.update |+| UpdateDataSource | [UpdateDataSourceRequest](#bytebase-v1-UpdateDataSourceRequest) | [Instance](#bytebase-v1-Instance) | Updates a data source configuration. Permissions required: bb.instances.update |@@ -2320,7 +2320,7 @@ Format: instances/{instance}/databases/{database}/metadata || character_set | [string](#string) | | The character_set is the character set of a database. || collation | [string](#string) | | The collation is the collation of a database. || extensions | [ExtensionMetadata](#bytebase-v1-ExtensionMetadata) | repeated | The extensions is the list of extensions in a database. |-| owner | [string](#string) | | |+| owner | [string](#string) | | The owner of the database. || search_path | [string](#string) | | The search_path is the search path of a PostgreSQL database. |@@ -2455,8 +2455,8 @@ DimensionalConfig defines dimensional and constraint parameters for spatial inde| ----- | ---- | ----- | ----------- || name | [string](#string) | | The name of a type. || values | [string](#string) | repeated | The enum values of a type. |-| comment | [string](#string) | | |-| skip_dump | [bool](#bool) | | |+| comment | [string](#string) | | The comment describing the enum type. |+| skip_dump | [bool](#bool) | | Whether to skip this enum type during schema dump operations. |@@ -2474,9 +2474,9 @@ DimensionalConfig defines dimensional and constraint parameters for spatial inde| name | [string](#string) | | The name of the event. || definition | [string](#string) | | The schedule of the event. || time_zone | [string](#string) | | The time zone of the event. |-| sql_mode | [string](#string) | | |-| character_set_client | [string](#string) | | |-| collation_connection | [string](#string) | | |+| sql_mode | [string](#string) | | The SQL mode setting for the event. |+| character_set_client | [string](#string) | | The character set used by the client creating the event. |+| collation_connection | [string](#string) | | The collation used for the connection when creating the event. || comment | [string](#string) | | The comment is the comment of an event. |@@ -2897,11 +2897,11 @@ This is the concept of schema in Postgres, but it's a no-op for MySQL.| tasks | [TaskMetadata](#bytebase-v1-TaskMetadata) | repeated | The routines is the list of routines in a schema, currently, only used for Snowflake. || materialized_views | [MaterializedViewMetadata](#bytebase-v1-MaterializedViewMetadata) | repeated | The materialized_views is the list of materialized views in a schema. || packages | [PackageMetadata](#bytebase-v1-PackageMetadata) | repeated | The packages is the list of packages in a schema. |-| owner | [string](#string) | | |+| owner | [string](#string) | | The owner of the schema. || sequences | [SequenceMetadata](#bytebase-v1-SequenceMetadata) | repeated | The sequences is the list of sequences in a schema, sorted by name. |-| events | [EventMetadata](#bytebase-v1-EventMetadata) | repeated | |-| enum_types | [EnumTypeMetadata](#bytebase-v1-EnumTypeMetadata) | repeated | |-| skip_dump | [bool](#bool) | | |+| events | [EventMetadata](#bytebase-v1-EventMetadata) | repeated | The events is the list of scheduled events in a schema. |+| enum_types | [EnumTypeMetadata](#bytebase-v1-EnumTypeMetadata) | repeated | The enum_types is the list of user-defined enum types in a schema. |+| skip_dump | [bool](#bool) | | Whether to skip this schema during schema dump operations. || comment | [string](#string) | | The comment is the comment of a schema. |@@ -2928,8 +2928,8 @@ This is the concept of schema in Postgres, but it's a no-op for MySQL.| last_value | [string](#string) | | Last value of a sequence. || owner_table | [string](#string) | | The owner table of the sequence. || owner_column | [string](#string) | | The owner column of the sequence. |-| comment | [string](#string) | | |-| skip_dump | [bool](#bool) | | |+| comment | [string](#string) | | The comment describing the sequence. |+| skip_dump | [bool](#bool) | | Whether to skip this sequence during schema dump operations. |@@ -3053,10 +3053,10 @@ TableMetadata is the metadata for tables.| foreign_keys | [ForeignKeyMetadata](#bytebase-v1-ForeignKeyMetadata) | repeated | The foreign_keys is the list of foreign keys in a table. || partitions | [TablePartitionMetadata](#bytebase-v1-TablePartitionMetadata) | repeated | The partitions is the list of partitions in a table. || check_constraints | [CheckConstraintMetadata](#bytebase-v1-CheckConstraintMetadata) | repeated | The check_constraints is the list of check constraints in a table. |-| owner | [string](#string) | | |+| owner | [string](#string) | | The owner of the table. || sorting_keys | [string](#string) | repeated | The sorting_keys is a tuple of column names or arbitrary expressions. ClickHouse specific field. Reference: https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/mergetree#order_by |-| triggers | [TriggerMetadata](#bytebase-v1-TriggerMetadata) | repeated | |-| skip_dump | [bool](#bool) | | |+| triggers | [TriggerMetadata](#bytebase-v1-TriggerMetadata) | repeated | The triggers is the list of triggers associated with the table. |+| skip_dump | [bool](#bool) | | Whether to skip this table during schema dump operations. || sharding_info | [string](#string) | | https://docs.pingcap.com/tidb/stable/information-schema-tables/ || primary_key_type | [string](#string) | | https://docs.pingcap.com/tidb/stable/clustered-indexes/#clustered-indexes CLUSTERED or NONCLUSTERED. |@@ -3141,11 +3141,11 @@ TessellationConfig defines tessellation parameters for spatial indexes.| event | [string](#string) | | The event is the event of the trigger, such as INSERT, UPDATE, DELETE, TRUNCATE. || timing | [string](#string) | | The timing is the timing of the trigger, such as BEFORE, AFTER. || body | [string](#string) | | The body is the body of the trigger. |-| sql_mode | [string](#string) | | |-| character_set_client | [string](#string) | | |-| collation_connection | [string](#string) | | |-| comment | [string](#string) | | |-| skip_dump | [bool](#bool) | | |+| sql_mode | [string](#string) | | The SQL mode setting for the trigger. |+| character_set_client | [string](#string) | | The character set used by the client creating the trigger. |+| collation_connection | [string](#string) | | The collation used for the connection when creating the trigger. |+| comment | [string](#string) | | The comment describing the trigger. |+| skip_dump | [bool](#bool) | | Whether to skip this trigger during schema dump operations. |@@ -3365,23 +3365,23 @@ LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)<a name="bytebase-v1-DatabaseService"></a>### DatabaseService-+DatabaseService manages databases and their schemas.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| GetDatabase | [GetDatabaseRequest](#bytebase-v1-GetDatabaseRequest) | [Database](#bytebase-v1-Database) | Permissions required: bb.databases.get |-| BatchGetDatabases | [BatchGetDatabasesRequest](#bytebase-v1-BatchGetDatabasesRequest) | [BatchGetDatabasesResponse](#bytebase-v1-BatchGetDatabasesResponse) | Permissions required: bb.databases.get |-| ListDatabases | [ListDatabasesRequest](#bytebase-v1-ListDatabasesRequest) | [ListDatabasesResponse](#bytebase-v1-ListDatabasesResponse) | Permissions required: bb.databases.list |-| UpdateDatabase | [UpdateDatabaseRequest](#bytebase-v1-UpdateDatabaseRequest) | [Database](#bytebase-v1-Database) | Permissions required: bb.databases.update |-| BatchUpdateDatabases | [BatchUpdateDatabasesRequest](#bytebase-v1-BatchUpdateDatabasesRequest) | [BatchUpdateDatabasesResponse](#bytebase-v1-BatchUpdateDatabasesResponse) | Permissions required: bb.databases.update |-| SyncDatabase | [SyncDatabaseRequest](#bytebase-v1-SyncDatabaseRequest) | [SyncDatabaseResponse](#bytebase-v1-SyncDatabaseResponse) | Permissions required: bb.databases.sync |-| BatchSyncDatabases | [BatchSyncDatabasesRequest](#bytebase-v1-BatchSyncDatabasesRequest) | [BatchSyncDatabasesResponse](#bytebase-v1-BatchSyncDatabasesResponse) | Permissions required: bb.databases.sync |-| GetDatabaseMetadata | [GetDatabaseMetadataRequest](#bytebase-v1-GetDatabaseMetadataRequest) | [DatabaseMetadata](#bytebase-v1-DatabaseMetadata) | Permissions required: bb.databases.getSchema |-| GetDatabaseSchema | [GetDatabaseSchemaRequest](#bytebase-v1-GetDatabaseSchemaRequest) | [DatabaseSchema](#bytebase-v1-DatabaseSchema) | Permissions required: bb.databases.getSchema |-| DiffSchema | [DiffSchemaRequest](#bytebase-v1-DiffSchemaRequest) | [DiffSchemaResponse](#bytebase-v1-DiffSchemaResponse) | Permissions required: bb.databases.get |-| ListChangelogs | [ListChangelogsRequest](#bytebase-v1-ListChangelogsRequest) | [ListChangelogsResponse](#bytebase-v1-ListChangelogsResponse) | Permissions required: bb.changelogs.list |-| GetChangelog | [GetChangelogRequest](#bytebase-v1-GetChangelogRequest) | [Changelog](#bytebase-v1-Changelog) | Permissions required: changelogs.get |-| GetSchemaString | [GetSchemaStringRequest](#bytebase-v1-GetSchemaStringRequest) | [GetSchemaStringResponse](#bytebase-v1-GetSchemaStringResponse) | Permissions required: databases.getSchema |+| GetDatabase | [GetDatabaseRequest](#bytebase-v1-GetDatabaseRequest) | [Database](#bytebase-v1-Database) | Retrieves a database by name. Permissions required: bb.databases.get |+| BatchGetDatabases | [BatchGetDatabasesRequest](#bytebase-v1-BatchGetDatabasesRequest) | [BatchGetDatabasesResponse](#bytebase-v1-BatchGetDatabasesResponse) | Retrieves multiple databases by their names. Permissions required: bb.databases.get |+| ListDatabases | [ListDatabasesRequest](#bytebase-v1-ListDatabasesRequest) | [ListDatabasesResponse](#bytebase-v1-ListDatabasesResponse) | Lists databases in a project, instance, or workspace. Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent) |+| UpdateDatabase | [UpdateDatabaseRequest](#bytebase-v1-UpdateDatabaseRequest) | [Database](#bytebase-v1-Database) | Updates database properties such as labels and project assignment. Permissions required: bb.databases.update |+| BatchUpdateDatabases | [BatchUpdateDatabasesRequest](#bytebase-v1-BatchUpdateDatabasesRequest) | [BatchUpdateDatabasesResponse](#bytebase-v1-BatchUpdateDatabasesResponse) | Updates multiple databases in a single batch operation. Permissions required: bb.databases.update |+| SyncDatabase | [SyncDatabaseRequest](#bytebase-v1-SyncDatabaseRequest) | [SyncDatabaseResponse](#bytebase-v1-SyncDatabaseResponse) | Synchronizes database schema from the instance. Permissions required: bb.databases.sync |+| BatchSyncDatabases | [BatchSyncDatabasesRequest](#bytebase-v1-BatchSyncDatabasesRequest) | [BatchSyncDatabasesResponse](#bytebase-v1-BatchSyncDatabasesResponse) | Synchronizes multiple databases in a single batch operation. Permissions required: bb.databases.sync |+| GetDatabaseMetadata | [GetDatabaseMetadataRequest](#bytebase-v1-GetDatabaseMetadataRequest) | [DatabaseMetadata](#bytebase-v1-DatabaseMetadata) | Retrieves database metadata including tables, columns, and indexes. Permissions required: bb.databases.getSchema |+| GetDatabaseSchema | [GetDatabaseSchemaRequest](#bytebase-v1-GetDatabaseSchemaRequest) | [DatabaseSchema](#bytebase-v1-DatabaseSchema) | Retrieves database schema as DDL statements. Permissions required: bb.databases.getSchema |+| DiffSchema | [DiffSchemaRequest](#bytebase-v1-DiffSchemaRequest) | [DiffSchemaResponse](#bytebase-v1-DiffSchemaResponse) | Compares and generates migration statements between two schemas. Permissions required: bb.databases.get |+| ListChangelogs | [ListChangelogsRequest](#bytebase-v1-ListChangelogsRequest) | [ListChangelogsResponse](#bytebase-v1-ListChangelogsResponse) | Lists migration history for a database. Permissions required: bb.changelogs.list |+| GetChangelog | [GetChangelogRequest](#bytebase-v1-GetChangelogRequest) | [Changelog](#bytebase-v1-Changelog) | Retrieves a specific changelog entry. Permissions required: bb.changelogs.get |+| GetSchemaString | [GetSchemaStringRequest](#bytebase-v1-GetSchemaStringRequest) | [GetSchemaStringResponse](#bytebase-v1-GetSchemaStringResponse) | Generates schema DDL for a database object. Permissions required: bb.databases.getSchema |@@ -3402,7 +3402,7 @@ LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| roles | [string](#string) | repeated | |+| roles | [string](#string) | repeated | The roles required for approval in order. |@@ -3418,9 +3418,9 @@ LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)| 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-v1-ApprovalFlow) | | |-| title | [string](#string) | | |-| description | [string](#string) | | |+| flow | [ApprovalFlow](#bytebase-v1-ApprovalFlow) | | The approval flow definition. |+| title | [string](#string) | | The title of the approval template. |+| description | [string](#string) | | The description of the approval template. |@@ -3436,7 +3436,7 @@ LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || name | [string](#string) | | The name of the issue to add an approver. Format: projects/{project}/issues/{issue} |-| comment | [string](#string) | | |+| comment | [string](#string) | | The comment explaining the approval decision. |@@ -3454,7 +3454,7 @@ LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)| parent | [string](#string) | | The parent resource shared by all issues being updated. Format: projects/{project} If the operation spans parents, a dash (-) may be accepted as a wildcard. We only support updating the status of databases for now. || issues | [string](#string) | repeated | The list of issues to update. Format: projects/{project}/issues/{issue} || status | [IssueStatus](#bytebase-v1-IssueStatus) | | The new status. |-| reason | [string](#string) | | |+| reason | [string](#string) | | The reason for the status change. |@@ -3480,7 +3480,7 @@ LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || parent | [string](#string) | | The issue name Format: projects/{project}/issues/{issue} |-| issue_comment | [IssueComment](#bytebase-v1-IssueComment) | | |+| issue_comment | [IssueComment](#bytebase-v1-IssueComment) | | The comment to create. |@@ -3512,7 +3512,7 @@ LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || name | [string](#string) | | The name of the issue to retrieve. Format: projects/{project}/issues/{issue} |-| force | [bool](#bool) | | |+| force | [bool](#bool) | | If set to true, bypass cache and fetch the latest data. |@@ -3530,7 +3530,7 @@ LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)| 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. |-| expiration | [google.protobuf.Duration](#google-protobuf-Duration) | | |+| expiration | [google.protobuf.Duration](#google-protobuf-Duration) | | The duration for which the grant is valid. |@@ -3546,12 +3546,12 @@ LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || name | [string](#string) | | The name of the issue. Format: projects/{project}/issues/{issue} |-| title | [string](#string) | | |-| description | [string](#string) | | |+| title | [string](#string) | | The title of the issue. |+| description | [string](#string) | | The description of the issue. || type | [Issue.Type](#bytebase-v1-Issue-Type) | | |-| status | [IssueStatus](#bytebase-v1-IssueStatus) | | |+| status | [IssueStatus](#bytebase-v1-IssueStatus) | | The status of the issue. || approvers | [Issue.Approver](#bytebase-v1-Issue-Approver) | repeated | |-| approval_template | [ApprovalTemplate](#bytebase-v1-ApprovalTemplate) | | |+| approval_template | [ApprovalTemplate](#bytebase-v1-ApprovalTemplate) | | The approval template for the issue. || creator | [string](#string) | | Format: users/[email protected] || create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | || update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |@@ -3559,9 +3559,9 @@ LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)| rollout | [string](#string) | | The rollout associated with the issue. Can be empty. Format: projects/{project}/rollouts/{rollout} || grant_request | [GrantRequest](#bytebase-v1-GrantRequest) | | Used if the issue type is GRANT_REQUEST. || releasers | [string](#string) | repeated | The releasers of the pending stage of the issue rollout, judging from the rollout policy. Format: - roles/workspaceOwner - roles/workspaceDBA - roles/projectOwner - roles/projectReleaser - users/{email} |-| risk_level | [RiskLevel](#bytebase-v1-RiskLevel) | | |+| risk_level | [RiskLevel](#bytebase-v1-RiskLevel) | | The risk level of the issue. || task_status_count | [Issue.TaskStatusCountEntry](#bytebase-v1-Issue-TaskStatusCountEntry) | repeated | The status count of the issue. Keys are the following: - NOT_STARTED - SKIPPED - PENDING - RUNNING - DONE - FAILED - CANCELED |-| labels | [string](#string) | repeated | |+| labels | [string](#string) | repeated | Labels attached to the issue for categorization and filtering. || approval_status | [Issue.ApprovalStatus](#bytebase-v1-Issue-ApprovalStatus) | | || approval_status_error | [string](#string) | | Only populated when approval_status == ERROR |@@ -3573,7 +3573,7 @@ LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)<a name="bytebase-v1-Issue-Approver"></a>### Issue.Approver-+Approvers and their approval status for the issue.| Field | Type | Label | Description |@@ -3605,22 +3605,22 @@ LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)<a name="bytebase-v1-IssueComment"></a>### IssueComment-+A comment on an issue.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || name | [string](#string) | | Format: projects/{project}/issues/{issue}/issueComments/{issueComment-uid} |-| comment | [string](#string) | | |+| comment | [string](#string) | | The text content of the comment. || payload | [string](#string) | | TODO: use struct message instead. || create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | || update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | || creator | [string](#string) | | Format: users/{email} |-| approval | [IssueComment.Approval](#bytebase-v1-IssueComment-Approval) | | |-| issue_update | [IssueComment.IssueUpdate](#bytebase-v1-IssueComment-IssueUpdate) | | |-| stage_end | [IssueComment.StageEnd](#bytebase-v1-IssueComment-StageEnd) | | |-| task_update | [IssueComment.TaskUpdate](#bytebase-v1-IssueComment-TaskUpdate) | | |-| task_prior_backup | [IssueComment.TaskPriorBackup](#bytebase-v1-IssueComment-TaskPriorBackup) | | |+| approval | [IssueComment.Approval](#bytebase-v1-IssueComment-Approval) | | Approval event. |+| issue_update | [IssueComment.IssueUpdate](#bytebase-v1-IssueComment-IssueUpdate) | | Issue update event. |+| stage_end | [IssueComment.StageEnd](#bytebase-v1-IssueComment-StageEnd) | | Stage end event. |+| task_update | [IssueComment.TaskUpdate](#bytebase-v1-IssueComment-TaskUpdate) | | Task update event. |+| task_prior_backup | [IssueComment.TaskPriorBackup](#bytebase-v1-IssueComment-TaskPriorBackup) | | Task prior backup event. |@@ -3630,12 +3630,12 @@ LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)<a name="bytebase-v1-IssueComment-Approval"></a>### IssueComment.Approval-+Approval event information.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| status | [IssueComment.Approval.Status](#bytebase-v1-IssueComment-Approval-Status) | | |+| status | [IssueComment.Approval.Status](#bytebase-v1-IssueComment-Approval-Status) | | The approval status. |@@ -3645,7 +3645,7 @@ LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)<a name="bytebase-v1-IssueComment-IssueUpdate"></a>### IssueComment.IssueUpdate-+Issue update event information.| Field | Type | Label | Description |@@ -3667,12 +3667,12 @@ LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)<a name="bytebase-v1-IssueComment-StageEnd"></a>### IssueComment.StageEnd-+Stage end event information.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| stage | [string](#string) | | |+| stage | [string](#string) | | The stage that ended. |@@ -3682,16 +3682,16 @@ LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)<a name="bytebase-v1-IssueComment-TaskPriorBackup"></a>### IssueComment.TaskPriorBackup-+Task prior backup event information.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| task | [string](#string) | | |-| tables | [IssueComment.TaskPriorBackup.Table](#bytebase-v1-IssueComment-TaskPriorBackup-Table) | repeated | |-| original_line | [int32](#int32) | optional | |-| database | [string](#string) | | |-| error | [string](#string) | | |+| task | [string](#string) | | The task for which backup was performed. |+| tables | [IssueComment.TaskPriorBackup.Table](#bytebase-v1-IssueComment-TaskPriorBackup-Table) | repeated | The tables that were backed up. |+| original_line | [int32](#int32) | optional | The original line number in the statement. |+| database | [string](#string) | | The database that was backed up. |+| error | [string](#string) | | Error message if backup failed. |@@ -3701,13 +3701,13 @@ LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)<a name="bytebase-v1-IssueComment-TaskPriorBackup-Table"></a>### IssueComment.TaskPriorBackup.Table-+Table identification.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| schema | [string](#string) | | |-| table | [string](#string) | | |+| schema | [string](#string) | | The schema name. |+| table | [string](#string) | | The table name. |@@ -3717,12 +3717,12 @@ LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)<a name="bytebase-v1-IssueComment-TaskUpdate"></a>### IssueComment.TaskUpdate-+Task update event information.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| tasks | [string](#string) | repeated | |+| tasks | [string](#string) | repeated | The tasks that were updated. || from_sheet | [string](#string) | optional | Format: projects/{project}/sheets/{sheet} || to_sheet | [string](#string) | optional | Format: projects/{project}/sheets/{sheet} || to_status | [IssueComment.TaskUpdate.Status](#bytebase-v1-IssueComment-TaskUpdate-Status) | optional | |@@ -3759,7 +3759,7 @@ When paginating, all other parameters provided to `ListIssueComments` must match| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| issue_comments | [IssueComment](#bytebase-v1-IssueComment) | repeated | |+| issue_comments | [IssueComment](#bytebase-v1-IssueComment) | repeated | The issue comments from the specified request. || next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |@@ -3817,7 +3817,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} |-| comment | [string](#string) | | |+| comment | [string](#string) | | The comment explaining the rejection decision. |@@ -3833,7 +3833,7 @@ For example: creator == "users/[email protected]" && status in [&#| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || name | [string](#string) | | The name of the issue to request a issue. Format: projects/{project}/issues/{issue} |-| comment | [string](#string) | | |+| comment | [string](#string) | | The comment explaining the request. |@@ -3886,7 +3886,7 @@ When paginating, all other parameters provided to `SearchIssues` must match the| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || parent | [string](#string) | | The issue name Format: projects/{project}/issues/{issue} |-| issue_comment | [IssueComment](#bytebase-v1-IssueComment) | | |+| issue_comment | [IssueComment](#bytebase-v1-IssueComment) | | The comment to update. || update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. || allow_missing | [bool](#bool) | | If set to true, and the issue comment is not found, a new issue comment will be created. In this situation, `update_mask` is ignored. |@@ -3919,90 +3919,90 @@ The issue's `name` field is used to identify the issue to update. Format: pr<a name="bytebase-v1-Issue-ApprovalStatus"></a>### Issue.ApprovalStatus-+The overall approval status for the issue.| Name | Number | Description || ---- | ------ | ----------- |-| APPROVAL_STATUS_UNSPECIFIED | 0 | |-| CHECKING | 1 | |-| PENDING | 2 | |-| APPROVED | 3 | |-| REJECTED | 4 | |-| SKIPPED | 5 | |-| ERROR | 6 | |+| APPROVAL_STATUS_UNSPECIFIED | 0 | Unspecified approval status. |+| CHECKING | 1 | Approval checks are being evaluated. |+| PENDING | 2 | Approval is pending. |+| APPROVED | 3 | Issue has been approved. |+| REJECTED | 4 | Issue has been rejected. |+| SKIPPED | 5 | Approval was skipped. |+| ERROR | 6 | Error occurred during approval evaluation. |<a name="bytebase-v1-Issue-Approver-Status"></a>### Issue.Approver.Status-+The approval status of an approver.| Name | Number | Description || ---- | ------ | ----------- |-| STATUS_UNSPECIFIED | 0 | |-| PENDING | 1 | |-| APPROVED | 2 | |-| REJECTED | 3 | |+| STATUS_UNSPECIFIED | 0 | Unspecified status. |+| PENDING | 1 | Awaiting approval. |+| APPROVED | 2 | Approved. |+| REJECTED | 3 | Rejected. |<a name="bytebase-v1-Issue-Type"></a>### Issue.Type-+The type of issue.| Name | Number | Description || ---- | ------ | ----------- |-| TYPE_UNSPECIFIED | 0 | |-| DATABASE_CHANGE | 1 | |-| GRANT_REQUEST | 2 | |-| DATABASE_EXPORT | 3 | |+| TYPE_UNSPECIFIED | 0 | Unspecified issue type. |+| DATABASE_CHANGE | 1 | Database schema or data change. |+| GRANT_REQUEST | 2 | Database access grant request. |+| DATABASE_EXPORT | 3 | Database data export request. |<a name="bytebase-v1-IssueComment-Approval-Status"></a>### IssueComment.Approval.Status-+Approval status values.| Name | Number | Description || ---- | ------ | ----------- |-| STATUS_UNSPECIFIED | 0 | |-| PENDING | 1 | |-| APPROVED | 2 | |-| REJECTED | 3 | |+| STATUS_UNSPECIFIED | 0 | Unspecified status. |+| PENDING | 1 | Approval pending. |+| APPROVED | 2 | Approved. |+| REJECTED | 3 | Rejected. |<a name="bytebase-v1-IssueComment-TaskUpdate-Status"></a>### IssueComment.TaskUpdate.Status-+Task status values.| Name | Number | Description || ---- | ------ | ----------- |-| STATUS_UNSPECIFIED | 0 | |-| PENDING | 1 | |-| RUNNING | 2 | |-| DONE | 3 | |-| FAILED | 4 | |-| SKIPPED | 5 | |-| CANCELED | 6 | |+| STATUS_UNSPECIFIED | 0 | Unspecified status. |+| PENDING | 1 | Task is pending. |+| RUNNING | 2 | Task is running. |+| DONE | 3 | Task is done. |+| FAILED | 4 | Task failed. |+| SKIPPED | 5 | Task was skipped. |+| CANCELED | 6 | Task was canceled. |<a name="bytebase-v1-IssueStatus"></a>### IssueStatus-+The status of an issue.| Name | Number | Description || ---- | ------ | ----------- |-| ISSUE_STATUS_UNSPECIFIED | 0 | |-| OPEN | 1 | |-| DONE | 2 | |-| CANCELED | 3 | |+| ISSUE_STATUS_UNSPECIFIED | 0 | Unspecified status. |+| OPEN | 1 | Issue is open and active. |+| DONE | 2 | Issue is completed. |+| CANCELED | 3 | Issue is canceled. |@@ -4013,22 +4013,22 @@ The issue's `name` field is used to identify the issue to update. Format: pr<a name="bytebase-v1-IssueService"></a>### IssueService-+IssueService manages issues for tracking database changes and tasks.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| GetIssue | [GetIssueRequest](#bytebase-v1-GetIssueRequest) | [Issue](#bytebase-v1-Issue) | Permissions required: bb.issues.get |-| CreateIssue | [CreateIssueRequest](#bytebase-v1-CreateIssueRequest) | [Issue](#bytebase-v1-Issue) | Permissions required: bb.issues.create |-| ListIssues | [ListIssuesRequest](#bytebase-v1-ListIssuesRequest) | [ListIssuesResponse](#bytebase-v1-ListIssuesResponse) | Permissions required: bb.issues.list |+| GetIssue | [GetIssueRequest](#bytebase-v1-GetIssueRequest) | [Issue](#bytebase-v1-Issue) | Retrieves an issue by name. Permissions required: bb.issues.get |+| CreateIssue | [CreateIssueRequest](#bytebase-v1-CreateIssueRequest) | [Issue](#bytebase-v1-Issue) | Creates a new issue for database changes or tasks. Permissions required: bb.issues.create |+| ListIssues | [ListIssuesRequest](#bytebase-v1-ListIssuesRequest) | [ListIssuesResponse](#bytebase-v1-ListIssuesResponse) | Lists issues in a project. Permissions required: bb.issues.list || SearchIssues | [SearchIssuesRequest](#bytebase-v1-SearchIssuesRequest) | [SearchIssuesResponse](#bytebase-v1-SearchIssuesResponse) | Search for issues that the caller has the bb.issues.get permission on and also satisfy the specified filter & query. Permissions required: bb.issues.get |-| UpdateIssue | [UpdateIssueRequest](#bytebase-v1-UpdateIssueRequest) | [Issue](#bytebase-v1-Issue) | Permissions required: bb.issues.update |-| ListIssueComments | [ListIssueCommentsRequest](#bytebase-v1-ListIssueCommentsRequest) | [ListIssueCommentsResponse](#bytebase-v1-ListIssueCommentsResponse) | Permissions required: bb.issueComments.list |-| CreateIssueComment | [CreateIssueCommentRequest](#bytebase-v1-CreateIssueCommentRequest) | [IssueComment](#bytebase-v1-IssueComment) | Permissions required: bb.issueComments.create |-| UpdateIssueComment | [UpdateIssueCommentRequest](#bytebase-v1-UpdateIssueCommentRequest) | [IssueComment](#bytebase-v1-IssueComment) | Permissions required: bb.issueComments.update |-| BatchUpdateIssuesStatus | [BatchUpdateIssuesStatusRequest](#bytebase-v1-BatchUpdateIssuesStatusRequest) | [BatchUpdateIssuesStatusResponse](#bytebase-v1-BatchUpdateIssuesStatusResponse) | Permissions required: bb.issues.update |-| ApproveIssue | [ApproveIssueRequest](#bytebase-v1-ApproveIssueRequest) | [Issue](#bytebase-v1-Issue) | ApproveIssue approves the issue. The access is based on approval flow. Permissions required: None |-| RejectIssue | [RejectIssueRequest](#bytebase-v1-RejectIssueRequest) | [Issue](#bytebase-v1-Issue) | RejectIssue rejects the issue. The access is based on approval flow. Permissions required: None |-| RequestIssue | [RequestIssueRequest](#bytebase-v1-RequestIssueRequest) | [Issue](#bytebase-v1-Issue) | RequestIssue requests the issue. The access is based on approval flow. Permissions required: None |+| UpdateIssue | [UpdateIssueRequest](#bytebase-v1-UpdateIssueRequest) | [Issue](#bytebase-v1-Issue) | Updates an issue's properties such as title, description, or labels. Permissions required: bb.issues.update |+| ListIssueComments | [ListIssueCommentsRequest](#bytebase-v1-ListIssueCommentsRequest) | [ListIssueCommentsResponse](#bytebase-v1-ListIssueCommentsResponse) | Lists comments on an issue. Permissions required: bb.issueComments.list |+| CreateIssueComment | [CreateIssueCommentRequest](#bytebase-v1-CreateIssueCommentRequest) | [IssueComment](#bytebase-v1-IssueComment) | Adds a comment to an issue. Permissions required: bb.issueComments.create |+| UpdateIssueComment | [UpdateIssueCommentRequest](#bytebase-v1-UpdateIssueCommentRequest) | [IssueComment](#bytebase-v1-IssueComment) | Updates an existing issue comment. Permissions required: bb.issueComments.update |+| BatchUpdateIssuesStatus | [BatchUpdateIssuesStatusRequest](#bytebase-v1-BatchUpdateIssuesStatusRequest) | [BatchUpdateIssuesStatusResponse](#bytebase-v1-BatchUpdateIssuesStatusResponse) | Updates the status of multiple issues in a single operation. Permissions required: bb.issues.update |+| ApproveIssue | [ApproveIssueRequest](#bytebase-v1-ApproveIssueRequest) | [Issue](#bytebase-v1-Issue) | Approves an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step. Permissions required: None (determined by approval flow) |+| RejectIssue | [RejectIssueRequest](#bytebase-v1-RejectIssueRequest) | [Issue](#bytebase-v1-Issue) | Rejects an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step. Permissions required: None (determined by approval flow) |+| RequestIssue | [RequestIssueRequest](#bytebase-v1-RequestIssueRequest) | [Issue](#bytebase-v1-Issue) | Requests changes on an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step. Permissions required: None (determined by approval flow) |@@ -4167,8 +4167,8 @@ The issue's `name` field is used to identify the issue to update. Format: pr| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| level | [Announcement.AlertLevel](#bytebase-v1-Announcement-AlertLevel) | | The alert level of announcemnt |-| text | [string](#string) | | The text of announcemnt |+| level | [Announcement.AlertLevel](#bytebase-v1-Announcement-AlertLevel) | | The alert level of announcement |+| text | [string](#string) | | The text of announcement || link | [string](#string) | | The optional link, user can follow the link to check extra details |@@ -4454,8 +4454,8 @@ The response message for getting a setting.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| page_size | [int32](#int32) | | Not used. The maximum number of settings to return. The service may return fewer than this value. If unspecified, at most 10 settings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |-| page_token | [string](#string) | | Not used. A page token, received from a previous `ListSettings` 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 settings to return. The service may return fewer than this value. If unspecified, at most 10 settings 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 `ListSettings` call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `ListSettings` must match the call that provided the page token. |@@ -4633,7 +4633,7 @@ The schema of setting.| name | [string](#string) | | The resource name of the setting. Must be one of the following forms:- `setting/{setting}` For example, "settings/bb.branding.logo" |-| value | [Value](#bytebase-v1-Value) | | The value of the setting. |+| value | [Value](#bytebase-v1-Value) | | The configuration value of the setting. |@@ -4834,13 +4834,13 @@ We support three levels of AlertLevel: INFO, WARNING, and ERROR.<a name="bytebase-v1-SettingService"></a>### SettingService-+SettingService manages workspace-level settings and configurations.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| ListSettings | [ListSettingsRequest](#bytebase-v1-ListSettingsRequest) | [ListSettingsResponse](#bytebase-v1-ListSettingsResponse) | Permissions required: bb.settings.list |-| GetSetting | [GetSettingRequest](#bytebase-v1-GetSettingRequest) | [Setting](#bytebase-v1-Setting) | Permissions required: bb.settings.get |-| UpdateSetting | [UpdateSettingRequest](#bytebase-v1-UpdateSettingRequest) | [Setting](#bytebase-v1-Setting) | Permissions required: bb.settings.set |+| ListSettings | [ListSettingsRequest](#bytebase-v1-ListSettingsRequest) | [ListSettingsResponse](#bytebase-v1-ListSettingsResponse) | Lists all workspace settings. Permissions required: bb.settings.list |+| GetSetting | [GetSettingRequest](#bytebase-v1-GetSettingRequest) | [Setting](#bytebase-v1-Setting) | Retrieves a workspace setting by name. Permissions required: bb.settings.get |+| UpdateSetting | [UpdateSettingRequest](#bytebase-v1-UpdateSettingRequest) | [Setting](#bytebase-v1-Setting) | Updates a workspace setting. Permissions required: bb.settings.set |@@ -5014,17 +5014,17 @@ The user's `name` field is used to identify the user to update. Format: user| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || name | [string](#string) | | The name of the user. Format: users/{user}. {user} is a system-generated unique ID. |-| state | [State](#bytebase-v1-State) | | |-| email | [string](#string) | | |-| title | [string](#string) | | |-| user_type | [UserType](#bytebase-v1-UserType) | | |-| password | [string](#string) | | |-| service_key | [string](#string) | | |+| state | [State](#bytebase-v1-State) | | The lifecycle state of the user account. |+| email | [string](#string) | | The email address of the user, used for login and notifications. |+| title | [string](#string) | | The display title or full name of the user. |+| user_type | [UserType](#bytebase-v1-UserType) | | The type of user account. |+| password | [string](#string) | | The password for authentication. Only used during user creation or password updates. |+| service_key | [string](#string) | | The service key for service account authentication. Only used for service accounts. || mfa_enabled | [bool](#bool) | | The mfa_enabled flag means if the user has enabled MFA. || mfa_secret | [string](#string) | | The mfa_secret is the temporary secret using in two phase verification. || recovery_codes | [string](#string) | repeated | The recovery_codes is the temporary recovery codes using in two phase verification. || phone | [string](#string) | | Should be a valid E.164 compliant phone number. Could be empty. |-| profile | [User.Profile](#bytebase-v1-User-Profile) | | |+| profile | [User.Profile](#bytebase-v1-User-Profile) | | User profile metadata. || groups | [string](#string) | repeated | The groups for the user. Format: groups/{email} |@@ -5040,8 +5040,8 @@ The user's `name` field is used to identify the user to update. Format: user| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| last_login_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |-| last_change_password_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |+| last_login_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The last time the user successfully logged in. |+| last_change_password_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The last time the user changed their password. || source | [string](#string) | | source means where the user comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID. |@@ -5058,10 +5058,10 @@ The user's `name` field is used to identify the user to update. Format: user| Name | Number | Description || ---- | ------ | ----------- |-| USER_TYPE_UNSPECIFIED | 0 | |-| USER | 1 | |-| SYSTEM_BOT | 2 | |-| SERVICE_ACCOUNT | 3 | |+| USER_TYPE_UNSPECIFIED | 0 | Unspecified user type. |+| USER | 1 | Regular human user account. |+| SYSTEM_BOT | 2 | System-managed bot account for automated operations. |+| SERVICE_ACCOUNT | 3 | Service account for API integrations. |@@ -5072,7 +5072,7 @@ The user's `name` field is used to identify the user to update. Format: user<a name="bytebase-v1-UserService"></a>### UserService-+UserService manages user accounts and authentication.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|@@ -5080,10 +5080,10 @@ The user's `name` field is used to identify the user to update. Format: user| BatchGetUsers | [BatchGetUsersRequest](#bytebase-v1-BatchGetUsersRequest) | [BatchGetUsersResponse](#bytebase-v1-BatchGetUsersResponse) | Get the users in batch. Any authenticated user can batch get users. Permissions required: bb.users.get || GetCurrentUser | [.google.protobuf.Empty](#google-protobuf-Empty) | [User](#bytebase-v1-User) | Get the current authenticated user. Permissions required: None || ListUsers | [ListUsersRequest](#bytebase-v1-ListUsersRequest) | [ListUsersResponse](#bytebase-v1-ListUsersResponse) | List all users. Any authenticated user can list users. Permissions required: bb.users.list |-| CreateUser | [CreateUserRequest](#bytebase-v1-CreateUserRequest) | [User](#bytebase-v1-User) | Create a user. When Disallow Signup is enabled, only the caller with bb.users.create on the workspace can create a user. Otherwise, any unauthenticated user can create a user. Permissions required: bb.users.create |-| UpdateUser | [UpdateUserRequest](#bytebase-v1-UpdateUserRequest) | [User](#bytebase-v1-User) | Only the user itself and the user with bb.users.update permission on the workspace can update the user. Permissions required: bb.users.update |-| DeleteUser | [DeleteUserRequest](#bytebase-v1-DeleteUserRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Only the user with bb.users.delete permission on the workspace can delete the user. The last remaining workspace admin cannot be deleted. Permissions required: bb.users.delete |-| UndeleteUser | [UndeleteUserRequest](#bytebase-v1-UndeleteUserRequest) | [User](#bytebase-v1-User) | Only the user with bb.users.undelete permission on the workspace can undelete the user. Permissions required: bb.users.undelete |+| CreateUser | [CreateUserRequest](#bytebase-v1-CreateUserRequest) | [User](#bytebase-v1-User) | Creates a user. When Disallow Signup is enabled, requires bb.users.create permission; otherwise any user can sign up. Permissions required: bb.users.create (only when Disallow Signup is enabled) |+| UpdateUser | [UpdateUserRequest](#bytebase-v1-UpdateUserRequest) | [User](#bytebase-v1-User) | Updates a user. Users can update their own profile, or users with bb.users.update permission can update any user. Permissions required: bb.users.update (or self) |+| DeleteUser | [DeleteUserRequest](#bytebase-v1-DeleteUserRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted. Permissions required: bb.users.delete |+| UndeleteUser | [UndeleteUserRequest](#bytebase-v1-UndeleteUserRequest) | [User](#bytebase-v1-User) | Restores a deleted user. Permissions required: bb.users.undelete |@@ -5099,34 +5099,34 @@ The user's `name` field is used to identify the user to update. Format: user<a name="bytebase-v1-ActuatorInfo"></a>### ActuatorInfo-ServerInfo is the API message for server info.+System information and configuration for the Bytebase instance.Actuator concept is similar to the Spring Boot Actuator.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| version | [string](#string) | | version is the bytebase's server version |-| git_commit | [string](#string) | | git_commit is the git commit hash of the build |-| readonly | [bool](#bool) | | readonly flag means if the Bytebase is running in readonly mode. |-| saas | [bool](#bool) | | saas flag means if the Bytebase is running in SaaS mode, some features are not allowed to edit by users. |-| demo | [bool](#bool) | | demo flag means if the Bytebase is running in demo mode. |-| host | [string](#string) | | host is the Bytebase instance host. |-| port | [string](#string) | | port is the Bytebase instance port. |-| external_url | [string](#string) | | external_url is the URL where user or webhook callback visits Bytebase. |-| need_admin_setup | [bool](#bool) | | need_admin_setup flag means the Bytebase instance doesn't have any end users. |-| disallow_signup | [bool](#bool) | | disallow_signup is the flag to disable self-service signup. |-| last_active_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | last_active_time is the service last active time in UTC Time Format, any API calls will refresh this value. |-| require_2fa | [bool](#bool) | | require_2fa is the flag to require 2FA for all users. |-| workspace_id | [string](#string) | | workspace_id is the identifier for the workspace. |-| debug | [bool](#bool) | | debug flag means if the debug mode is enabled. |-| unlicensed_features | [string](#string) | repeated | |-| disallow_password_signin | [bool](#bool) | | disallow_password_signin is the flag to disallow user signin with email&password. (except workspace admins) |-| password_restriction | [PasswordRestrictionSetting](#bytebase-v1-PasswordRestrictionSetting) | | |-| docker | [bool](#bool) | | docker flag means if the Bytebase instance is running in docker. |-| user_stats | [ActuatorInfo.StatUser](#bytebase-v1-ActuatorInfo-StatUser) | repeated | |-| activated_instance_count | [int32](#int32) | | |-| total_instance_count | [int32](#int32) | | |-| enable_sample | [bool](#bool) | | |+| version | [string](#string) | | The Bytebase server version. |+| git_commit | [string](#string) | | The git commit hash of the build. |+| readonly | [bool](#bool) | | Whether the Bytebase instance is running in read-only mode. |+| saas | [bool](#bool) | | Whether the Bytebase instance is running in SaaS mode where some features cannot be edited by users. |+| demo | [bool](#bool) | | Whether the Bytebase instance is running in demo mode. |+| host | [string](#string) | | The host address of the Bytebase instance. |+| port | [string](#string) | | The port number of the Bytebase instance. |+| external_url | [string](#string) | | The external URL where users or webhook callbacks access Bytebase. |+| need_admin_setup | [bool](#bool) | | Whether the Bytebase instance requires initial admin setup. |+| disallow_signup | [bool](#bool) | | Whether self-service user signup is disabled. |+| last_active_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The last time any API call was made, refreshed on each request. |+| require_2fa | [bool](#bool) | | Whether two-factor authentication is required for all users. |+| workspace_id | [string](#string) | | The unique identifier for the workspace. |+| debug | [bool](#bool) | | Whether debug mode is enabled. |+| unlicensed_features | [string](#string) | repeated | List of features that are not licensed. |+| disallow_password_signin | [bool](#bool) | | Whether password-based signin is disabled (except for workspace admins). |+| password_restriction | [PasswordRestrictionSetting](#bytebase-v1-PasswordRestrictionSetting) | | Password complexity and restriction requirements. |+| docker | [bool](#bool) | | Whether the Bytebase instance is running in Docker. |+| user_stats | [ActuatorInfo.StatUser](#bytebase-v1-ActuatorInfo-StatUser) | repeated | Statistics about users in the system. |+| activated_instance_count | [int32](#int32) | | The number of activated database instances. |+| total_instance_count | [int32](#int32) | | The total number of database instances. |+| enable_sample | [bool](#bool) | | Whether sample data setup is enabled. |@@ -5136,14 +5136,14 @@ Actuator concept is similar to the Spring Boot Actuator.<a name="bytebase-v1-ActuatorInfo-StatUser"></a>### ActuatorInfo.StatUser-+User statistics by type and state.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| user_type | [UserType](#bytebase-v1-UserType) | | |-| state | [State](#bytebase-v1-State) | | |-| count | [int32](#int32) | | |+| user_type | [UserType](#bytebase-v1-UserType) | | The type of user. |+| state | [State](#bytebase-v1-State) | | The state of the user. |+| count | [int32](#int32) | | The count of users matching this type and state. |@@ -5153,7 +5153,7 @@ Actuator concept is similar to the Spring Boot Actuator.<a name="bytebase-v1-DeleteCacheRequest"></a>### DeleteCacheRequest-+Request message for deleting cache.@@ -5163,7 +5163,7 @@ Actuator concept is similar to the Spring Boot Actuator.<a name="bytebase-v1-GetActuatorInfoRequest"></a>### GetActuatorInfoRequest-+Request message for getting actuator information.@@ -5173,7 +5173,7 @@ Actuator concept is similar to the Spring Boot Actuator.<a name="bytebase-v1-GetResourcePackageRequest"></a>### GetResourcePackageRequest-The request message for getting the theme resource.+Request message for getting branding resources.@@ -5183,7 +5183,7 @@ The request message for getting the theme resource.<a name="bytebase-v1-ResourcePackage"></a>### ResourcePackage-The theme resources.+Custom branding resources for the Bytebase instance.| Field | Type | Label | Description |@@ -5198,7 +5198,7 @@ The theme resources.<a name="bytebase-v1-SetupSampleRequest"></a>### SetupSampleRequest-+Request message for setting up sample data.@@ -5208,7 +5208,7 @@ The theme resources.<a name="bytebase-v1-UpdateActuatorInfoRequest"></a>### UpdateActuatorInfoRequest-+Request message for updating actuator information.| Field | Type | Label | Description |@@ -5231,15 +5231,15 @@ The theme resources.<a name="bytebase-v1-ActuatorService"></a>### ActuatorService-+ActuatorService manages system health and operational information.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| GetActuatorInfo | [GetActuatorInfoRequest](#bytebase-v1-GetActuatorInfoRequest) | [ActuatorInfo](#bytebase-v1-ActuatorInfo) | Permissions required: None |-| UpdateActuatorInfo | [UpdateActuatorInfoRequest](#bytebase-v1-UpdateActuatorInfoRequest) | [ActuatorInfo](#bytebase-v1-ActuatorInfo) | Permissions required: bb.settings.set |-| SetupSample | [SetupSampleRequest](#bytebase-v1-SetupSampleRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Permissions required: bb.projects.create |-| DeleteCache | [DeleteCacheRequest](#bytebase-v1-DeleteCacheRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Permissions required: None |-| GetResourcePackage | [GetResourcePackageRequest](#bytebase-v1-GetResourcePackageRequest) | [ResourcePackage](#bytebase-v1-ResourcePackage) | Permissions required: None |+| GetActuatorInfo | [GetActuatorInfoRequest](#bytebase-v1-GetActuatorInfoRequest) | [ActuatorInfo](#bytebase-v1-ActuatorInfo) | Gets system information and health status of the Bytebase instance. Permissions required: None |+| UpdateActuatorInfo | [UpdateActuatorInfoRequest](#bytebase-v1-UpdateActuatorInfoRequest) | [ActuatorInfo](#bytebase-v1-ActuatorInfo) | Updates system configuration settings for the Bytebase instance. Permissions required: bb.settings.set |+| SetupSample | [SetupSampleRequest](#bytebase-v1-SetupSampleRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Sets up sample data for demonstration and testing purposes. Permissions required: bb.projects.create |+| DeleteCache | [DeleteCacheRequest](#bytebase-v1-DeleteCacheRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Clears the system cache to force data refresh. Permissions required: None |+| GetResourcePackage | [GetResourcePackageRequest](#bytebase-v1-GetResourcePackageRequest) | [ResourcePackage](#bytebase-v1-ResourcePackage) | Gets custom branding resources such as logos. Permissions required: None |@@ -5255,7 +5255,7 @@ The theme resources.<a name="bytebase-v1-Binding"></a>### Binding-+Binding associates members with a role and optional conditions.| Field | Type | Label | Description |@@ -5277,8 +5277,7 @@ For example: resource.database == "instances/local-pg/databases/postgres"<a name="bytebase-v1-BindingDelta"></a>### BindingDelta-One delta entry for Binding. Each individual change (only one member in each-entry) to a binding will be a separate entry.+A single change to a binding.| Field | Type | Label | Description |@@ -5296,7 +5295,7 @@ entry) to a binding will be a separate entry.<a name="bytebase-v1-GetIamPolicyRequest"></a>### GetIamPolicyRequest-+Request message for getting an IAM policy.| Field | Type | Label | Description |@@ -5311,7 +5310,7 @@ entry) to a binding will be a separate entry.<a name="bytebase-v1-IamPolicy"></a>### IamPolicy-+IAM policy that binds members to roles.| Field | Type | Label | Description |@@ -5327,7 +5326,7 @@ entry) to a binding will be a separate entry.<a name="bytebase-v1-PolicyDelta"></a>### PolicyDelta-The difference delta between two policies.+Describes changes between two IAM policies.| Field | Type | Label | Description |@@ -5342,7 +5341,7 @@ The difference delta between two policies.<a name="bytebase-v1-SetIamPolicyRequest"></a>### SetIamPolicyRequest-+Request message for setting an IAM policy.| Field | Type | Label | Description |@@ -5361,13 +5360,13 @@ The difference delta between two policies.<a name="bytebase-v1-BindingDelta-Action"></a>### BindingDelta.Action-The type of action performed on a Binding in a policy.+Type of action performed on a binding.| Name | Number | Description || ---- | ------ | ----------- |-| ACTION_UNSPECIFIED | 0 | |-| ADD | 1 | |-| REMOVE | 2 | |+| ACTION_UNSPECIFIED | 0 | Unspecified action. |+| ADD | 1 | Add a binding. |+| REMOVE | 2 | Remove a binding. |@@ -5388,12 +5387,12 @@ The type of action performed on a Binding in a policy.<a name="bytebase-v1-AuditData"></a>### AuditData-+Additional audit data specific to certain operations.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| policy_delta | [PolicyDelta](#bytebase-v1-PolicyDelta) | | |+| policy_delta | [PolicyDelta](#bytebase-v1-PolicyDelta) | | Changes to IAM policies. |@@ -5403,23 +5402,23 @@ The type of action performed on a Binding in a policy.<a name="bytebase-v1-AuditLog"></a>### AuditLog-+Audit log entry recording system activity or API call.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || name | [string](#string) | | The name of the log. Formats: - projects/{project}/auditLogs/{uid} - workspaces/{workspace}/auditLogs/{uid} |-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |-| user | [string](#string) | | Format: users/[email protected] |-| method | [string](#string) | | e.g. `/bytebase.v1.SQLService/Query`, `bb.project.repository.push` |-| severity | [AuditLog.Severity](#bytebase-v1-AuditLog-Severity) | | |-| resource | [string](#string) | | The associated resource. |-| request | [string](#string) | | JSON-encoded request. |-| response | [string](#string) | | JSON-encoded 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. |-| request_metadata | [RequestMetadata](#bytebase-v1-RequestMetadata) | | Metadata about the operation. |+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The timestamp when the audit log was created. |+| user | [string](#string) | | The user who performed the action. Format: users/{email} |+| method | [string](#string) | | The method or action being audited. For example: /bytebase.v1.SQLService/Query or bb.project.repository.push |+| severity | [AuditLog.Severity](#bytebase-v1-AuditLog-Severity) | | The severity level of this audit log entry. |+| resource | [string](#string) | | The resource associated with this audit log. |+| request | [string](#string) | | The request payload in JSON format. |+| response | [string](#string) | | The response payload in JSON format. Some fields may be omitted if they are too large or contain sensitive information. |+| status | [google.rpc.Status](#google-rpc-Status) | | The status of the operation. |+| latency | [google.protobuf.Duration](#google-protobuf-Duration) | | The duration of the operation. |+| service_data | [google.protobuf.Any](#google-protobuf-Any) | | Service-specific metadata about the request, response, and activities. |+| request_metadata | [RequestMetadata](#bytebase-v1-RequestMetadata) | | Metadata about the request context. |@@ -5429,7 +5428,7 @@ The type of action performed on a Binding in a policy.<a name="bytebase-v1-ExportAuditLogsRequest"></a>### ExportAuditLogsRequest-+Request message for exporting audit logs.| Field | Type | Label | Description |@@ -5449,12 +5448,12 @@ The type of action performed on a Binding in a policy.<a name="bytebase-v1-ExportAuditLogsResponse"></a>### ExportAuditLogsResponse-+Response message for exporting audit logs.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| content | [bytes](#bytes) | | |+| content | [bytes](#bytes) | | The exported audit log content in the requested format. || next_page_token | [string](#string) | | A token to retrieve next page of log entities. Pass this value in the page_token field in the subsequent call to retrieve the next page of log entities. |@@ -5465,13 +5464,13 @@ The type of action performed on a Binding in a policy.<a name="bytebase-v1-RequestMetadata"></a>### RequestMetadata-Metadata about the request.+Metadata about the incoming request.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| caller_ip | [string](#string) | | The IP address of the caller. |-| caller_supplied_user_agent | [string](#string) | | The user agent of the caller. This information is not authenticated and should be treated accordingly. |+| caller_ip | [string](#string) | | The IP address of the request originator. |+| caller_supplied_user_agent | [string](#string) | | The user agent string provided by the caller. This is supplied by the client and is not authenticated. |@@ -5481,7 +5480,7 @@ Metadata about the request.<a name="bytebase-v1-SearchAuditLogsRequest"></a>### SearchAuditLogsRequest-+Request message for searching audit logs.| Field | Type | Label | Description |@@ -5504,7 +5503,7 @@ For example: - filter = "method == '/bytebase.v1.SQLService/Query'&#<a name="bytebase-v1-SearchAuditLogsResponse"></a>### SearchAuditLogsResponse-+Response message for searching audit logs.| Field | Type | Label | Description |@@ -5522,19 +5521,19 @@ For example: - filter = "method == '/bytebase.v1.SQLService/Query'&#<a name="bytebase-v1-AuditLog-Severity"></a>### AuditLog.Severity-+Severity level for audit log entries.| Name | Number | Description || ---- | ------ | ----------- |-| DEFAULT | 0 | |-| DEBUG | 1 | |-| INFO | 2 | |-| NOTICE | 3 | |-| WARNING | 4 | |-| ERROR | 5 | |-| CRITICAL | 6 | |-| ALERT | 7 | |-| EMERGENCY | 8 | |+| DEFAULT | 0 | Default severity level. |+| DEBUG | 1 | Debug-level information. |+| INFO | 2 | Informational messages. |+| NOTICE | 3 | Notable events. |+| WARNING | 4 | Warning conditions. |+| ERROR | 5 | Error conditions. |+| CRITICAL | 6 | Critical conditions. |+| ALERT | 7 | Action must be taken immediately. |+| EMERGENCY | 8 | System is unusable. |@@ -5545,12 +5544,12 @@ For example: - filter = "method == '/bytebase.v1.SQLService/Query'&#<a name="bytebase-v1-AuditLogService"></a>### AuditLogService-+AuditLogService manages audit logs for system activities and API calls.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| SearchAuditLogs | [SearchAuditLogsRequest](#bytebase-v1-SearchAuditLogsRequest) | [SearchAuditLogsResponse](#bytebase-v1-SearchAuditLogsResponse) | Permissions required: None |-| ExportAuditLogs | [ExportAuditLogsRequest](#bytebase-v1-ExportAuditLogsRequest) | [ExportAuditLogsResponse](#bytebase-v1-ExportAuditLogsResponse) | Permissions required: bb.auditLogs.export |+| SearchAuditLogs | [SearchAuditLogsRequest](#bytebase-v1-SearchAuditLogsRequest) | [SearchAuditLogsResponse](#bytebase-v1-SearchAuditLogsResponse) | Searches audit logs with optional filtering and pagination. Permissions required: bb.auditLogs.search |+| ExportAuditLogs | [ExportAuditLogsRequest](#bytebase-v1-ExportAuditLogsRequest) | [ExportAuditLogsResponse](#bytebase-v1-ExportAuditLogsResponse) | Exports audit logs in a specified format for external analysis. Permissions required: bb.auditLogs.export |@@ -5566,13 +5565,13 @@ For example: - filter = "method == '/bytebase.v1.SQLService/Query'&#<a name="bytebase-v1-IdentityProviderContext"></a>### IdentityProviderContext-+Context for identity provider authentication.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| oauth2_context | [OAuth2IdentityProviderContext](#bytebase-v1-OAuth2IdentityProviderContext) | | |-| oidc_context | [OIDCIdentityProviderContext](#bytebase-v1-OIDCIdentityProviderContext) | | |+| oauth2_context | [OAuth2IdentityProviderContext](#bytebase-v1-OAuth2IdentityProviderContext) | | OAuth2 authentication context. |+| oidc_context | [OIDCIdentityProviderContext](#bytebase-v1-OIDCIdentityProviderContext) | | OpenID Connect authentication context. |@@ -5587,8 +5586,8 @@ For example: - filter = "method == '/bytebase.v1.SQLService/Query'&#| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| email | [string](#string) | | |-| password | [string](#string) | | |+| email | [string](#string) | | User's email address. |+| password | [string](#string) | | User's password for authentication. || web | [bool](#bool) | | If web is set, we will set access token, refresh token, and user to the cookie. || idp_name | [string](#string) | | The name of the identity provider. Format: idps/{idp} || idp_context | [IdentityProviderContext](#bytebase-v1-IdentityProviderContext) | | The idp_context is using to get the user information from identity provider. |@@ -5609,9 +5608,9 @@ For example: - filter = "method == '/bytebase.v1.SQLService/Query'&#| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| token | [string](#string) | | |-| mfa_temp_token | [string](#string) | optional | |-| require_reset_password | [bool](#bool) | | |+| 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. |@@ -5622,7 +5621,7 @@ For example: - filter = "method == '/bytebase.v1.SQLService/Query'&#<a name="bytebase-v1-LogoutRequest"></a>### LogoutRequest-+Request to logout current user session.@@ -5632,12 +5631,12 @@ For example: - filter = "method == '/bytebase.v1.SQLService/Query'&#<a name="bytebase-v1-OAuth2IdentityProviderContext"></a>### OAuth2IdentityProviderContext-+OAuth2 authentication context.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| code | [string](#string) | | |+| code | [string](#string) | | Authorization code from OAuth2 provider. |@@ -5647,7 +5646,7 @@ For example: - filter = "method == '/bytebase.v1.SQLService/Query'&#<a name="bytebase-v1-OIDCIdentityProviderContext"></a>### OIDCIdentityProviderContext-+OpenID Connect authentication context.@@ -5663,12 +5662,12 @@ For example: - filter = "method == '/bytebase.v1.SQLService/Query'&#<a name="bytebase-v1-AuthService"></a>### AuthService-+AuthService handles user authentication operations.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| Login | [LoginRequest](#bytebase-v1-LoginRequest) | [LoginResponse](#bytebase-v1-LoginResponse) | Permissions required: None |-| Logout | [LogoutRequest](#bytebase-v1-LogoutRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Permissions required: None |+| Login | [LoginRequest](#bytebase-v1-LoginRequest) | [LoginResponse](#bytebase-v1-LoginResponse) | Authenticates a user and returns access tokens. Permissions required: None |+| Logout | [LogoutRequest](#bytebase-v1-LogoutRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Logs out the current user session. Permissions required: None |@@ -5684,12 +5683,12 @@ For example: - filter = "method == '/bytebase.v1.SQLService/Query'&#<a name="bytebase-v1-BatchDeparseRequest"></a>### BatchDeparseRequest-+Request message for batch deparsing CEL expressions.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| expressions | [google.api.expr.v1alpha1.Expr](#google-api-expr-v1alpha1-Expr) | repeated | |+| expressions | [google.api.expr.v1alpha1.Expr](#google-api-expr-v1alpha1-Expr) | repeated | The CEL expression ASTs to deparse. |@@ -5699,12 +5698,12 @@ For example: - filter = "method == '/bytebase.v1.SQLService/Query'&#<a name="bytebase-v1-BatchDeparseResponse"></a>### BatchDeparseResponse-+Response message for batch deparsing CEL expressions.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| expressions | [string](#string) | repeated | |+| expressions | [string](#string) | repeated | The deparsed CEL expressions as strings. |@@ -5714,12 +5713,12 @@ For example: - filter = "method == '/bytebase.v1.SQLService/Query'&#<a name="bytebase-v1-BatchParseRequest"></a>### BatchParseRequest-+Request message for batch parsing CEL expressions.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| expressions | [string](#string) | repeated | |+| expressions | [string](#string) | repeated | The CEL expression strings to parse. |@@ -5729,12 +5728,12 @@ For example: - filter = "method == '/bytebase.v1.SQLService/Query'&#<a name="bytebase-v1-BatchParseResponse"></a>### BatchParseResponse-+Response message for batch parsing CEL expressions.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| expressions | [google.api.expr.v1alpha1.Expr](#google-api-expr-v1alpha1-Expr) | repeated | |+| expressions | [google.api.expr.v1alpha1.Expr](#google-api-expr-v1alpha1-Expr) | repeated | The parsed CEL expressions as AST. |@@ -5750,12 +5749,12 @@ For example: - filter = "method == '/bytebase.v1.SQLService/Query'&#<a name="bytebase-v1-CelService"></a>### CelService-+CelService manages CEL (Common Expression Language) parsing and formatting operations.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| BatchParse | [BatchParseRequest](#bytebase-v1-BatchParseRequest) | [BatchParseResponse](#bytebase-v1-BatchParseResponse) | Permissions required: None |-| BatchDeparse | [BatchDeparseRequest](#bytebase-v1-BatchDeparseRequest) | [BatchDeparseResponse](#bytebase-v1-BatchDeparseResponse) | Permissions required: None |+| BatchParse | [BatchParseRequest](#bytebase-v1-BatchParseRequest) | [BatchParseResponse](#bytebase-v1-BatchParseResponse) | Parses multiple CEL expression strings into AST representations. Permissions required: None |+| BatchDeparse | [BatchDeparseRequest](#bytebase-v1-BatchDeparseRequest) | [BatchDeparseResponse](#bytebase-v1-BatchDeparseResponse) | Converts multiple CEL AST representations back into expression strings. Permissions required: None |@@ -5771,16 +5770,16 @@ For example: - filter = "method == '/bytebase.v1.SQLService/Query'&#<a name="bytebase-v1-Changelist"></a>### Changelist-+A changelist groups multiple database changes together.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || name | [string](#string) | | The name of the changelist resource. Canonical parent is project. Format: projects/{project}/changelists/{changelist} |-| description | [string](#string) | | |+| description | [string](#string) | | The description of the changelist. || creator | [string](#string) | | The creator of the changelist. Format: users/{email} |-| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The last update time of the changelist. |-| changes | [Changelist.Change](#bytebase-v1-Changelist-Change) | repeated | |+| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The last time the changelist was updated. |+| changes | [Changelist.Change](#bytebase-v1-Changelist-Change) | repeated | The list of changes in this changelist. |@@ -5790,13 +5789,13 @@ For example: - filter = "method == '/bytebase.v1.SQLService/Query'&#<a name="bytebase-v1-Changelist-Change"></a>### Changelist.Change-+A single change in a changelist.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| sheet | [string](#string) | | The name of a sheet. |-| source | [string](#string) | | The source of origin. 1) changelog: instances/{instance}/databases/{database}/changelogs/{changelog}. 2) raw SQL if empty. |+| sheet | [string](#string) | | The sheet containing the SQL statement. |+| source | [string](#string) | | The source of this change. Format: instances/{instance}/databases/{database}/changelogs/{changelog} If empty, the change is from raw SQL. |@@ -5806,7 +5805,7 @@ For example: - filter = "method == '/bytebase.v1.SQLService/Query'&#<a name="bytebase-v1-CreateChangelistRequest"></a>### CreateChangelistRequest-+Request message for creating a changelist.| Field | Type | Label | Description |@@ -5825,7 +5824,7 @@ This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |<a name="bytebase-v1-DeleteChangelistRequest"></a>### DeleteChangelistRequest-+Request message for deleting a changelist.| Field | Type | Label | Description |@@ -5840,7 +5839,7 @@ This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |<a name="bytebase-v1-GetChangelistRequest"></a>### GetChangelistRequest-+Request message for getting a changelist.| Field | Type | Label | Description |@@ -5855,14 +5854,14 @@ This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |<a name="bytebase-v1-ListChangelistsRequest"></a>### ListChangelistsRequest-+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) | | Not used. 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) | | Not used. 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 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.When paginating, all other parameters provided to `ListDatabases` must match the call that provided the page token. |@@ -5874,7 +5873,7 @@ When paginating, all other parameters provided to `ListDatabases` must match the<a name="bytebase-v1-ListChangelistsResponse"></a>### ListChangelistsResponse-+Response message for listing changelists.| Field | Type | Label | Description |@@ -5890,7 +5889,7 @@ When paginating, all other parameters provided to `ListDatabases` must match the<a name="bytebase-v1-UpdateChangelistRequest"></a>### UpdateChangelistRequest-+Request message for updating a changelist.| Field | Type | Label | Description |@@ -5915,15 +5914,15 @@ The changelist's `name` field is used to identify the changelist to update.<a name="bytebase-v1-ChangelistService"></a>### ChangelistService-+ChangelistService manages changelists for grouping and organizing database changes.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| CreateChangelist | [CreateChangelistRequest](#bytebase-v1-CreateChangelistRequest) | [Changelist](#bytebase-v1-Changelist) | Permissions required: bb.changelists.create |-| GetChangelist | [GetChangelistRequest](#bytebase-v1-GetChangelistRequest) | [Changelist](#bytebase-v1-Changelist) | Permissions required: bb.changelists.get |-| ListChangelists | [ListChangelistsRequest](#bytebase-v1-ListChangelistsRequest) | [ListChangelistsResponse](#bytebase-v1-ListChangelistsResponse) | Permissions required: bb.changelists.list |-| UpdateChangelist | [UpdateChangelistRequest](#bytebase-v1-UpdateChangelistRequest) | [Changelist](#bytebase-v1-Changelist) | Permissions required: bb.changelists.update |-| DeleteChangelist | [DeleteChangelistRequest](#bytebase-v1-DeleteChangelistRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Permissions required: bb.changelists.delete |+| CreateChangelist | [CreateChangelistRequest](#bytebase-v1-CreateChangelistRequest) | [Changelist](#bytebase-v1-Changelist) | Creates a new changelist in a project. Permissions required: bb.changelists.create |+| GetChangelist | [GetChangelistRequest](#bytebase-v1-GetChangelistRequest) | [Changelist](#bytebase-v1-Changelist) | Gets a changelist by name. Permissions required: bb.changelists.get |+| ListChangelists | [ListChangelistsRequest](#bytebase-v1-ListChangelistsRequest) | [ListChangelistsResponse](#bytebase-v1-ListChangelistsResponse) | Lists changelists in a project. Permissions required: bb.changelists.list |+| UpdateChangelist | [UpdateChangelistRequest](#bytebase-v1-UpdateChangelistRequest) | [Changelist](#bytebase-v1-Changelist) | Updates a changelist. Permissions required: bb.changelists.update |+| DeleteChangelist | [DeleteChangelistRequest](#bytebase-v1-DeleteChangelistRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a changelist. Permissions required: bb.changelists.delete |@@ -5939,7 +5938,7 @@ The changelist's `name` field is used to identify the changelist to update.<a name="bytebase-v1-CreateDatabaseGroupRequest"></a>### CreateDatabaseGroupRequest-+Request message for creating a database group.| Field | Type | Label | Description |@@ -5959,7 +5958,7 @@ This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |<a name="bytebase-v1-DatabaseGroup"></a>### DatabaseGroup-+A group of databases matched by expressions.| Field | Type | Label | Description |@@ -5981,7 +5980,7 @@ For example: resource.environment_id == "test" && resource.datab<a name="bytebase-v1-DatabaseGroup-Database"></a>### DatabaseGroup.Database-+A database within a database group.| Field | Type | Label | Description |@@ -5996,7 +5995,7 @@ For example: resource.environment_id == "test" && resource.datab<a name="bytebase-v1-DeleteDatabaseGroupRequest"></a>### DeleteDatabaseGroupRequest-+Request message for deleting a database group.| Field | Type | Label | Description |@@ -6011,7 +6010,7 @@ For example: resource.environment_id == "test" && resource.datab<a name="bytebase-v1-GetDatabaseGroupRequest"></a>### GetDatabaseGroupRequest-+Request message for getting a database group.| Field | Type | Label | Description |@@ -6027,14 +6026,14 @@ For example: resource.environment_id == "test" && resource.datab<a name="bytebase-v1-ListDatabaseGroupsRequest"></a>### ListDatabaseGroupsRequest-+Request message for listing database groups.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || parent | [string](#string) | | The parent resource whose database groups are to be listed. Format: projects/{project} |-| page_size | [int32](#int32) | | Not used. The maximum number of database groups to return. The service may return fewer than this value. If unspecified, at most 50 database groups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |-| page_token | [string](#string) | | Not used. A page token, received from a previous `ListDatabaseGroups` 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 database groups to return. The service may return fewer than this value. If unspecified, at most 50 database groups 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 `ListDatabaseGroups` call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `ListDatabaseGroups` must match the call that provided the page token. || view | [DatabaseGroupView](#bytebase-v1-DatabaseGroupView) | | The view to return. Defaults to DATABASE_GROUP_VIEW_BASIC. |@@ -6047,13 +6046,13 @@ When paginating, all other parameters provided to `ListDatabaseGroups` must matc<a name="bytebase-v1-ListDatabaseGroupsResponse"></a>### ListDatabaseGroupsResponse-+Response message for listing database groups.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| database_groups | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | repeated | database_groups is the list of database groups. |-| next_page_token | [string](#string) | | Not used. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |+| database_groups | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | repeated | The database groups from the specified request. |+| next_page_token | [string](#string) | | Pagination is not currently implemented. This field is reserved for future use. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |@@ -6063,7 +6062,7 @@ When paginating, all other parameters provided to `ListDatabaseGroups` must matc<a name="bytebase-v1-UpdateDatabaseGroupRequest"></a>### UpdateDatabaseGroupRequest-+Request message for updating a database group.| Field | Type | Label | Description |@@ -6084,7 +6083,7 @@ The database group's `name` field is used to identify the database group to<a name="bytebase-v1-DatabaseGroupView"></a>### DatabaseGroupView-+View options for database group responses.| Name | Number | Description || ---- | ------ | ----------- |@@ -6101,15 +6100,15 @@ The database group's `name` field is used to identify the database group to<a name="bytebase-v1-DatabaseGroupService"></a>### DatabaseGroupService-+DatabaseGroupService manages database groups for organizing databases by criteria.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| ListDatabaseGroups | [ListDatabaseGroupsRequest](#bytebase-v1-ListDatabaseGroupsRequest) | [ListDatabaseGroupsResponse](#bytebase-v1-ListDatabaseGroupsResponse) | Permissions required: bb.projects.get |-| GetDatabaseGroup | [GetDatabaseGroupRequest](#bytebase-v1-GetDatabaseGroupRequest) | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | Permissions required: bb.projects.get |-| CreateDatabaseGroup | [CreateDatabaseGroupRequest](#bytebase-v1-CreateDatabaseGroupRequest) | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | Permissions required: bb.projects.update |-| UpdateDatabaseGroup | [UpdateDatabaseGroupRequest](#bytebase-v1-UpdateDatabaseGroupRequest) | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | Permissions required: bb.projects.update |-| DeleteDatabaseGroup | [DeleteDatabaseGroupRequest](#bytebase-v1-DeleteDatabaseGroupRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Permissions required: bb.projects.update |+| ListDatabaseGroups | [ListDatabaseGroupsRequest](#bytebase-v1-ListDatabaseGroupsRequest) | [ListDatabaseGroupsResponse](#bytebase-v1-ListDatabaseGroupsResponse) | Lists database groups in a project. Permissions required: bb.projects.get |+| GetDatabaseGroup | [GetDatabaseGroupRequest](#bytebase-v1-GetDatabaseGroupRequest) | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | Gets a database group by name. Permissions required: bb.projects.get |+| CreateDatabaseGroup | [CreateDatabaseGroupRequest](#bytebase-v1-CreateDatabaseGroupRequest) | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | Creates a new database group. Permissions required: bb.projects.update |+| UpdateDatabaseGroup | [UpdateDatabaseGroupRequest](#bytebase-v1-UpdateDatabaseGroupRequest) | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | Updates a database group. Permissions required: bb.projects.update |+| DeleteDatabaseGroup | [DeleteDatabaseGroupRequest](#bytebase-v1-DeleteDatabaseGroupRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a database group. Permissions required: bb.projects.update |@@ -6125,7 +6124,7 @@ The database group's `name` field is used to identify the database group to<a name="bytebase-v1-BatchGetGroupsRequest"></a>### BatchGetGroupsRequest-+Request message for batch getting groups.| Field | Type | Label | Description |@@ -6140,7 +6139,7 @@ The database group's `name` field is used to identify the database group to<a name="bytebase-v1-BatchGetGroupsResponse"></a>### BatchGetGroupsResponse-+Response message for batch getting groups.| Field | Type | Label | Description |@@ -6155,7 +6154,7 @@ The database group's `name` field is used to identify the database group to<a name="bytebase-v1-CreateGroupRequest"></a>### CreateGroupRequest-+Request message for creating a group.| Field | Type | Label | Description |@@ -6171,7 +6170,7 @@ The database group's `name` field is used to identify the database group to<a name="bytebase-v1-DeleteGroupRequest"></a>### DeleteGroupRequest-+Request message for deleting a group.| Field | Type | Label | Description |@@ -6186,7 +6185,7 @@ The database group's `name` field is used to identify the database group to<a name="bytebase-v1-GetGroupRequest"></a>### GetGroupRequest-+Request message for getting a group.| Field | Type | Label | Description |@@ -6201,16 +6200,16 @@ The database group's `name` field is used to identify the database group to<a name="bytebase-v1-Group"></a>### Group-+A group of users within the workspace.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || name | [string](#string) | | The name of the group to retrieve. Format: groups/{group}, group is an email. |-| title | [string](#string) | | |-| description | [string](#string) | | |-| members | [GroupMember](#bytebase-v1-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. |+| title | [string](#string) | | The display title of the group. |+| description | [string](#string) | | The description of the group. |+| members | [GroupMember](#bytebase-v1-GroupMember) | repeated | The members of the group. |+| source | [string](#string) | | The source system where the group originated (e.g., Entra ID for SCIM sync). |@@ -6220,7 +6219,7 @@ The database group's `name` field is used to identify the database group to<a name="bytebase-v1-GroupMember"></a>### GroupMember-+A member of a group with a role.| Field | Type | Label | Description |@@ -6228,7 +6227,7 @@ The database group's `name` field is used to identify the database group to| member | [string](#string) | | Member is the principal who belong to this group.Format: users/[email protected] |-| role | [GroupMember.Role](#bytebase-v1-GroupMember-Role) | | |+| role | [GroupMember.Role](#bytebase-v1-GroupMember-Role) | | The member's role in the group. |@@ -6238,7 +6237,7 @@ Format: users/[email protected] |<a name="bytebase-v1-ListGroupsRequest"></a>### ListGroupsRequest-+Request message for listing groups.| Field | Type | Label | Description |@@ -6261,7 +6260,7 @@ For example: title == "dba" email == "[email protected]" title.ma<a name="bytebase-v1-ListGroupsResponse"></a>### ListGroupsResponse-+Response message for listing groups.| Field | Type | Label | Description |@@ -6277,7 +6276,7 @@ For example: title == "dba" email == "[email protected]" title.ma<a name="bytebase-v1-UpdateGroupRequest"></a>### UpdateGroupRequest-+Request message for updating a group.| Field | Type | Label | Description |@@ -6298,13 +6297,13 @@ The group's `name` field is used to identify the group to update. Format: gr<a name="bytebase-v1-GroupMember-Role"></a>### GroupMember.Role-+The role of a group member.| Name | Number | Description || ---- | ------ | ----------- |-| ROLE_UNSPECIFIED | 0 | |-| OWNER | 1 | |-| MEMBER | 2 | |+| ROLE_UNSPECIFIED | 0 | Unspecified role. |+| OWNER | 1 | Group owner. |+| MEMBER | 2 | Group member. |@@ -6315,16 +6314,16 @@ The group's `name` field is used to identify the group to update. Format: gr<a name="bytebase-v1-GroupService"></a>### GroupService-+GroupService manages user groups for organizing users and permissions.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| GetGroup | [GetGroupRequest](#bytebase-v1-GetGroupRequest) | [Group](#bytebase-v1-Group) | Permissions required: bb.groups.get |-| BatchGetGroups | [BatchGetGroupsRequest](#bytebase-v1-BatchGetGroupsRequest) | [BatchGetGroupsResponse](#bytebase-v1-BatchGetGroupsResponse) | Get the groups in batch. Permissions required: bb.groups.get |-| ListGroups | [ListGroupsRequest](#bytebase-v1-ListGroupsRequest) | [ListGroupsResponse](#bytebase-v1-ListGroupsResponse) | Permissions required: bb.groups.list |-| CreateGroup | [CreateGroupRequest](#bytebase-v1-CreateGroupRequest) | [Group](#bytebase-v1-Group) | Permissions required: bb.groups.create |-| UpdateGroup | [UpdateGroupRequest](#bytebase-v1-UpdateGroupRequest) | [Group](#bytebase-v1-Group) | UpdateGroup updates the group. Users with "bb.groups.update" permission on the workspace or the group owner can access this method. Permissions required: bb.groups.update |-| DeleteGroup | [DeleteGroupRequest](#bytebase-v1-DeleteGroupRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Permissions required: bb.groups.delete |+| GetGroup | [GetGroupRequest](#bytebase-v1-GetGroupRequest) | [Group](#bytebase-v1-Group) | Gets a group by name. Permissions required: bb.groups.get |+| BatchGetGroups | [BatchGetGroupsRequest](#bytebase-v1-BatchGetGroupsRequest) | [BatchGetGroupsResponse](#bytebase-v1-BatchGetGroupsResponse) | Gets multiple groups in a single request. Permissions required: bb.groups.get |+| ListGroups | [ListGroupsRequest](#bytebase-v1-ListGroupsRequest) | [ListGroupsResponse](#bytebase-v1-ListGroupsResponse) | Lists all groups in the workspace. Permissions required: bb.groups.list |+| CreateGroup | [CreateGroupRequest](#bytebase-v1-CreateGroupRequest) | [Group](#bytebase-v1-Group) | Creates a new group. Permissions required: bb.groups.create |+| UpdateGroup | [UpdateGroupRequest](#bytebase-v1-UpdateGroupRequest) | [Group](#bytebase-v1-Group) | Updates a group. Group owners or users with bb.groups.update permission can update. Permissions required: bb.groups.update OR caller is group owner |+| DeleteGroup | [DeleteGroupRequest](#bytebase-v1-DeleteGroupRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a group. Group owners or users with bb.groups.delete permission can delete. Permissions required: bb.groups.delete OR caller is group owner |@@ -6399,7 +6398,7 @@ we can extract the relevant data based with `FieldMapping`.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | |+| name | [string](#string) | | The name of the identity provider to retrieve. Format: idps/{idp} |@@ -6415,10 +6414,10 @@ we can extract the relevant data based with `FieldMapping`.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || name | [string](#string) | | The name of the identity provider. Format: idps/{idp} |-| title | [string](#string) | | |-| domain | [string](#string) | | |-| type | [IdentityProviderType](#bytebase-v1-IdentityProviderType) | | |-| config | [IdentityProviderConfig](#bytebase-v1-IdentityProviderConfig) | | |+| title | [string](#string) | | The display title of the identity provider. |+| domain | [string](#string) | | The domain for email matching when using this identity provider. |+| type | [IdentityProviderType](#bytebase-v1-IdentityProviderType) | | The type of identity provider protocol. |+| config | [IdentityProviderConfig](#bytebase-v1-IdentityProviderConfig) | | The configuration details for the identity provider. |@@ -6433,9 +6432,9 @@ we can extract the relevant data based with `FieldMapping`.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| oauth2_config | [OAuth2IdentityProviderConfig](#bytebase-v1-OAuth2IdentityProviderConfig) | | |-| oidc_config | [OIDCIdentityProviderConfig](#bytebase-v1-OIDCIdentityProviderConfig) | | |-| ldap_config | [LDAPIdentityProviderConfig](#bytebase-v1-LDAPIdentityProviderConfig) | | |+| oauth2_config | [OAuth2IdentityProviderConfig](#bytebase-v1-OAuth2IdentityProviderConfig) | | OAuth2 protocol configuration. |+| oidc_config | [OIDCIdentityProviderConfig](#bytebase-v1-OIDCIdentityProviderConfig) | | OIDC protocol configuration. |+| ldap_config | [LDAPIdentityProviderConfig](#bytebase-v1-LDAPIdentityProviderConfig) | | LDAP protocol configuration. |@@ -6473,8 +6472,8 @@ LDAPIdentityProviderConfig is the structure for LDAP identity provider config.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| page_size | [int32](#int32) | | Not used. The maximum number of identity providers to return. The service may return fewer than this value. If unspecified, at most 10 will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |-| page_token | [string](#string) | | Not used. A page token, received from a previous `ListIdentityProviders` 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 identity providers to return. The service may return fewer than this value. If unspecified, at most 10 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 `ListIdentityProviders` call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `ListIdentityProviders` must match the call that provided the page token. |@@ -6507,15 +6506,15 @@ OAuth2IdentityProviderConfig is the structure for OAuth2 identity provider confi| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| auth_url | [string](#string) | | |-| token_url | [string](#string) | | |-| user_info_url | [string](#string) | | |-| client_id | [string](#string) | | |-| client_secret | [string](#string) | | |-| scopes | [string](#string) | repeated | |-| field_mapping | [FieldMapping](#bytebase-v1-FieldMapping) | | |-| skip_tls_verify | [bool](#bool) | | |-| auth_style | [OAuth2AuthStyle](#bytebase-v1-OAuth2AuthStyle) | | |+| auth_url | [string](#string) | | The authorization endpoint URL for OAuth2 flow. |+| token_url | [string](#string) | | The token endpoint URL for exchanging authorization code. |+| user_info_url | [string](#string) | | The user information endpoint URL. |+| client_id | [string](#string) | | The OAuth2 client identifier. |+| client_secret | [string](#string) | | The OAuth2 client secret for authentication. |+| scopes | [string](#string) | repeated | The list of OAuth2 scopes to request. |+| field_mapping | [FieldMapping](#bytebase-v1-FieldMapping) | | Mapping configuration for user attributes from OAuth2 response. |+| skip_tls_verify | [bool](#bool) | | Whether to skip TLS certificate verification. |+| auth_style | [OAuth2AuthStyle](#bytebase-v1-OAuth2AuthStyle) | | The authentication style for client credentials. |@@ -6545,13 +6544,13 @@ OIDCIdentityProviderConfig is the structure for OIDC identity provider config.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| issuer | [string](#string) | | |-| client_id | [string](#string) | | |-| client_secret | [string](#string) | | |+| issuer | [string](#string) | | The OIDC issuer URL for the identity provider. |+| client_id | [string](#string) | | The OIDC client identifier. |+| client_secret | [string](#string) | | The OIDC client secret for authentication. || scopes | [string](#string) | repeated | The scopes that the OIDC provider supports. Should be fetched from the well-known configuration file of the OIDC provider. |-| field_mapping | [FieldMapping](#bytebase-v1-FieldMapping) | | |-| skip_tls_verify | [bool](#bool) | | |-| auth_style | [OAuth2AuthStyle](#bytebase-v1-OAuth2AuthStyle) | | |+| field_mapping | [FieldMapping](#bytebase-v1-FieldMapping) | | Mapping configuration for user attributes from OIDC claims. |+| skip_tls_verify | [bool](#bool) | | Whether to skip TLS certificate verification. |+| auth_style | [OAuth2AuthStyle](#bytebase-v1-OAuth2AuthStyle) | | The authentication style for client credentials. || auth_endpoint | [string](#string) | | The authorization endpoint of the OIDC provider. Should be fetched from the well-known configuration file of the OIDC provider. |@@ -6651,10 +6650,10 @@ The identity provider's `name` field is used to identify the identity provid| Name | Number | Description || ---- | ------ | ----------- |-| IDENTITY_PROVIDER_TYPE_UNSPECIFIED | 0 | |-| OAUTH2 | 1 | |-| OIDC | 2 | |-| LDAP | 3 | |+| IDENTITY_PROVIDER_TYPE_UNSPECIFIED | 0 | Unspecified identity provider type. |+| OAUTH2 | 1 | OAuth 2.0 authentication protocol. |+| OIDC | 2 | OpenID Connect authentication protocol. |+| LDAP | 3 | LDAP directory service authentication. |@@ -6691,16 +6690,16 @@ The identity provider's `name` field is used to identify the identity provid<a name="bytebase-v1-IdentityProviderService"></a>### IdentityProviderService-+IdentityProviderService manages external identity providers for SSO authentication.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| GetIdentityProvider | [GetIdentityProviderRequest](#bytebase-v1-GetIdentityProviderRequest) | [IdentityProvider](#bytebase-v1-IdentityProvider) | Permissions required: bb.identityProviders.get |-| ListIdentityProviders | [ListIdentityProvidersRequest](#bytebase-v1-ListIdentityProvidersRequest) | [ListIdentityProvidersResponse](#bytebase-v1-ListIdentityProvidersResponse) | Permissions required: None |-| CreateIdentityProvider | [CreateIdentityProviderRequest](#bytebase-v1-CreateIdentityProviderRequest) | [IdentityProvider](#bytebase-v1-IdentityProvider) | Permissions required: bb.identityProviders.create |-| UpdateIdentityProvider | [UpdateIdentityProviderRequest](#bytebase-v1-UpdateIdentityProviderRequest) | [IdentityProvider](#bytebase-v1-IdentityProvider) | Permissions required: bb.identityProviders.update |-| DeleteIdentityProvider | [DeleteIdentityProviderRequest](#bytebase-v1-DeleteIdentityProviderRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Permissions required: bb.identityProviders.delete |-| TestIdentityProvider | [TestIdentityProviderRequest](#bytebase-v1-TestIdentityProviderRequest) | [TestIdentityProviderResponse](#bytebase-v1-TestIdentityProviderResponse) | Permissions required: bb.identityProviders.update |+| GetIdentityProvider | [GetIdentityProviderRequest](#bytebase-v1-GetIdentityProviderRequest) | [IdentityProvider](#bytebase-v1-IdentityProvider) | Gets an identity provider by name. Permissions required: bb.identityProviders.get |+| ListIdentityProviders | [ListIdentityProvidersRequest](#bytebase-v1-ListIdentityProvidersRequest) | [ListIdentityProvidersResponse](#bytebase-v1-ListIdentityProvidersResponse) | Lists all configured identity providers (public endpoint for login page). Permissions required: None |+| CreateIdentityProvider | [CreateIdentityProviderRequest](#bytebase-v1-CreateIdentityProviderRequest) | [IdentityProvider](#bytebase-v1-IdentityProvider) | Creates a new identity provider. Permissions required: bb.identityProviders.create |+| UpdateIdentityProvider | [UpdateIdentityProviderRequest](#bytebase-v1-UpdateIdentityProviderRequest) | [IdentityProvider](#bytebase-v1-IdentityProvider) | Updates an identity provider. Permissions required: bb.identityProviders.update |+| DeleteIdentityProvider | [DeleteIdentityProviderRequest](#bytebase-v1-DeleteIdentityProviderRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes an identity provider. Permissions required: bb.identityProviders.delete |+| TestIdentityProvider | [TestIdentityProviderRequest](#bytebase-v1-TestIdentityProviderRequest) | [TestIdentityProviderResponse](#bytebase-v1-TestIdentityProviderResponse) | Tests the connection and configuration of an identity provider. Permissions required: bb.identityProviders.update |@@ -6723,7 +6722,7 @@ The identity provider's `name` field is used to identify the identity provid| ----- | ---- | ----- | ----------- || parent | [string](#string) | | The parent resource where this instance will be created. Workspace resource name: "". Environment resource name: environments/environment-id. Instance resource name: instances/instance-id. Database resource name: instances/instance-id/databases/database-name. || policy | [Policy](#bytebase-v1-Policy) | | The policy to create. |-| type | [PolicyType](#bytebase-v1-PolicyType) | | |+| type | [PolicyType](#bytebase-v1-PolicyType) | | The type of policy to create. |@@ -6733,12 +6732,12 @@ The identity provider's `name` field is used to identify the identity provid<a name="bytebase-v1-DataSourceQueryPolicy"></a>### DataSourceQueryPolicy-DataSourceQueryPolicy is the policy configuration for running statements in the SQL editor.+Policy for controlling which data sources can be queried in the SQL editor.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| admin_data_source_restriction | [DataSourceQueryPolicy.Restriction](#bytebase-v1-DataSourceQueryPolicy-Restriction) | | |+| admin_data_source_restriction | [DataSourceQueryPolicy.Restriction](#bytebase-v1-DataSourceQueryPolicy-Restriction) | | Restriction for admin data source queries. || disallow_ddl | [bool](#bool) | | Disallow running DDL statements in the SQL editor. || disallow_dml | [bool](#bool) | | Disallow running DML statements in the SQL editor. |@@ -6786,9 +6785,9 @@ DataSourceQueryPolicy is the policy configuration for running statements in the| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || parent | [string](#string) | | The parent, which owns this collection of policies. Format: {resource type}/{resource id} |-| policy_type | [PolicyType](#bytebase-v1-PolicyType) | optional | |-| page_size | [int32](#int32) | | Not used. The maximum number of policies to return. The service may return fewer than this value. If unspecified, at most 10 policies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |-| page_token | [string](#string) | | Not used. A page token, received from a previous `ListPolicies` call. Provide this to retrieve the subsequent page.+| policy_type | [PolicyType](#bytebase-v1-PolicyType) | optional | Filter by specific policy type. |+| page_size | [int32](#int32) | | Pagination is not currently implemented. This field is reserved for future use. The maximum number of policies to return. The service may return fewer than this value. If unspecified, at most 10 policies 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 `ListPolicies` call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `ListPolicies` must match the call that provided the page token. || show_deleted | [bool](#bool) | | Show deleted policies if specified. |@@ -6822,7 +6821,7 @@ MaskingExceptionPolicy is the allowlist of users who can access sensitive data.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| masking_exceptions | [MaskingExceptionPolicy.MaskingException](#bytebase-v1-MaskingExceptionPolicy-MaskingException) | repeated | |+| masking_exceptions | [MaskingExceptionPolicy.MaskingException](#bytebase-v1-MaskingExceptionPolicy-MaskingException) | repeated | The list of masking exceptions. |@@ -6832,12 +6831,12 @@ MaskingExceptionPolicy is the allowlist of users who can access sensitive data.<a name="bytebase-v1-MaskingExceptionPolicy-MaskingException"></a>### MaskingExceptionPolicy.MaskingException-+An exception allowing specific users to access masked data.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| action | [MaskingExceptionPolicy.MaskingException.Action](#bytebase-v1-MaskingExceptionPolicy-MaskingException-Action) | | action is the action that the user can access sensitive data. |+| action | [MaskingExceptionPolicy.MaskingException.Action](#bytebase-v1-MaskingExceptionPolicy-MaskingException-Action) | | The action that the user can perform on sensitive data. || member | [string](#string) | | Member is the principal who bind to this exception policy instance.- `user:{email}`: An email address that represents a specific Bytebase account. For example, `[email protected]`. - `group:{email}`: An email address for group. |@@ -6855,12 +6854,12 @@ For example: resource.instance_id == "local" && resource.databas<a name="bytebase-v1-MaskingRulePolicy"></a>### MaskingRulePolicy-+Policy for configuring data masking rules.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| rules | [MaskingRulePolicy.MaskingRule](#bytebase-v1-MaskingRulePolicy-MaskingRule) | repeated | |+| rules | [MaskingRulePolicy.MaskingRule](#bytebase-v1-MaskingRulePolicy-MaskingRule) | repeated | The list of masking rules. |@@ -6870,12 +6869,12 @@ For example: resource.instance_id == "local" && resource.databas<a name="bytebase-v1-MaskingRulePolicy-MaskingRule"></a>### MaskingRulePolicy.MaskingRule-+A rule that defines when and how to mask data.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| id | [string](#string) | | A unique identifier for a node in UUID format. |+| id | [string](#string) | | A unique identifier for the rule in UUID format. || condition | [google.type.Expr](#google-type-Expr) | | The condition for the masking rule. The syntax and semantics of CEL are documented at https://github.com/google/cel-specSupport variables: resource.environment_id: the environment resource id. resource.project_id: the project resource id. resource.instance_id: the instance resource id. resource.database_name: the database name. resource.table_name: the table name. resource.column_name: the column name. resource.classification_level: the classification level.@@ -6883,7 +6882,7 @@ Support variables: resource.environment_id: the environment resource id. resourcEach variable support following operations: ==: the value equals the target. !=: the value not equals the target. in: the value matches one of the targets. !(in): the value not matches any of the targets.For example: resource.environment_id == "test" && resource.project_id == "sample-project" resource.instance_id == "sample-instance" && resource.database_name == "employee" && resource.table_name in ["table1", "table2"] resource.environment_id != "test" || !(resource.project_id in ["poject1", "prject2"]) resource.instance_id == "sample-instance" && (resource.database_name == "db1" || resource.database_name == "db2") |-| semantic_type | [string](#string) | | |+| semantic_type | [string](#string) | | The semantic type of data to mask (e.g., "SSN", "EMAIL"). |@@ -6899,15 +6898,15 @@ For example: resource.environment_id == "test" && resource.proje| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || name | [string](#string) | | The name of the policy. Format: {resource name}/policies/{policy type} Workspace resource name: "". Environment resource name: environments/environment-id. Instance resource name: instances/instance-id. Database resource name: instances/instance-id/databases/database-name. |-| inherit_from_parent | [bool](#bool) | | |-| type | [PolicyType](#bytebase-v1-PolicyType) | | |+| inherit_from_parent | [bool](#bool) | | Whether this policy inherits from its parent resource. |+| type | [PolicyType](#bytebase-v1-PolicyType) | | The type of policy. || rollout_policy | [RolloutPolicy](#bytebase-v1-RolloutPolicy) | | || masking_rule_policy | [MaskingRulePolicy](#bytebase-v1-MaskingRulePolicy) | | || masking_exception_policy | [MaskingExceptionPolicy](#bytebase-v1-MaskingExceptionPolicy) | | || tag_policy | [TagPolicy](#bytebase-v1-TagPolicy) | | || data_source_query_policy | [DataSourceQueryPolicy](#bytebase-v1-DataSourceQueryPolicy) | | || query_data_policy | [QueryDataPolicy](#bytebase-v1-QueryDataPolicy) | | |-| enforce | [bool](#bool) | | |+| enforce | [bool](#bool) | | Whether the policy is enforced. || resource_type | [PolicyResourceType](#bytebase-v1-PolicyResourceType) | | The resource type for the policy. |@@ -6924,10 +6923,10 @@ 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 |-| 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. |+| disable_export | [bool](#bool) | | Disable data export in the SQL editor. |+| maximum_result_size | [int64](#int64) | | The maximum result size limit in bytes. The default value is 100MB, we will use the default value if the setting not exists, or the limit <= 0. |+| maximum_result_rows | [int32](#int32) | | The maximum number of rows to return. The default value is -1, means no limit. |+| disable_copy_data | [bool](#bool) | | Disable copying query results. |@@ -6937,13 +6936,13 @@ QueryDataPolicy is the policy configuration for querying data.<a name="bytebase-v1-RolloutPolicy"></a>### RolloutPolicy-+Rollout policy configuration.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| automatic | [bool](#bool) | | |-| roles | [string](#string) | repeated | |+| automatic | [bool](#bool) | | Whether rollout is automatic without manual approval. |+| roles | [string](#string) | repeated | The roles that can approve rollout execution. || checkers | [RolloutPolicy.Checkers](#bytebase-v1-RolloutPolicy-Checkers) | | Checkers that must pass before rollout execution. These checks are performed in UI workflows only. |@@ -6985,16 +6984,16 @@ QueryDataPolicy is the policy configuration for querying data.<a name="bytebase-v1-SQLReviewRule"></a>### SQLReviewRule-The SQL review rules. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.+SQL review rule configuration. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| type | [string](#string) | | |-| level | [SQLReviewRuleLevel](#bytebase-v1-SQLReviewRuleLevel) | | |+| type | [string](#string) | | The type of SQL review rule. |+| level | [SQLReviewRuleLevel](#bytebase-v1-SQLReviewRuleLevel) | | The severity level of the rule. || payload | [string](#string) | | The payload is a JSON string that varies by rule type. |-| engine | [Engine](#bytebase-v1-Engine) | | |-| comment | [string](#string) | | |+| engine | [Engine](#bytebase-v1-Engine) | | The database engine this rule applies to. |+| comment | [string](#string) | | Additional comment for the rule. |@@ -7004,7 +7003,7 @@ The SQL review rules. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.<a name="bytebase-v1-TagPolicy"></a>### TagPolicy-+Policy for tagging resources with metadata.| Field | Type | Label | Description |@@ -7056,57 +7055,57 @@ The policy's `name` field is used to identify the instance to update. Format<a name="bytebase-v1-DataSourceQueryPolicy-Restriction"></a>### DataSourceQueryPolicy.Restriction-+Restriction level for admin data source access.| Name | Number | Description || ---- | ------ | ----------- |-| RESTRICTION_UNSPECIFIED | 0 | |-| FALLBACK | 1 | Allow to query admin data sources when there is no read-only data source. |-| DISALLOW | 2 | Disallow to query admin data sources. |+| RESTRICTION_UNSPECIFIED | 0 | Unspecified restriction. |+| FALLBACK | 1 | Allow querying admin data sources when there is no read-only data source. |+| DISALLOW | 2 | Disallow querying admin data sources. |<a name="bytebase-v1-MaskingExceptionPolicy-MaskingException-Action"></a>### MaskingExceptionPolicy.MaskingException.Action-+The action that the exception permits.| Name | Number | Description || ---- | ------ | ----------- |-| ACTION_UNSPECIFIED | 0 | |-| QUERY | 1 | |-| EXPORT | 2 | |+| ACTION_UNSPECIFIED | 0 | Unspecified action. |+| QUERY | 1 | Allow querying sensitive data. |+| EXPORT | 2 | Allow exporting sensitive data. |<a name="bytebase-v1-PolicyResourceType"></a>### PolicyResourceType-+The resource type that a policy can be attached to.| Name | Number | Description || ---- | ------ | ----------- |-| RESOURCE_TYPE_UNSPECIFIED | 0 | |-| WORKSPACE | 1 | |-| ENVIRONMENT | 2 | |-| PROJECT | 3 | |+| RESOURCE_TYPE_UNSPECIFIED | 0 | Unspecified resource type. |+| WORKSPACE | 1 | Workspace-level policy. |+| ENVIRONMENT | 2 | Environment-level policy. |+| PROJECT | 3 | Project-level policy. |<a name="bytebase-v1-PolicyType"></a>### PolicyType-+The type of organizational policy.| Name | Number | Description || ---- | ------ | ----------- |-| POLICY_TYPE_UNSPECIFIED | 0 | |-| ROLLOUT_POLICY | 11 | |-| MASKING_RULE | 9 | |-| MASKING_EXCEPTION | 10 | |-| TAG | 13 | |-| DATA_SOURCE_QUERY | 14 | |-| DATA_QUERY | 16 | |+| POLICY_TYPE_UNSPECIFIED | 0 | Unspecified policy type. |+| ROLLOUT_POLICY | 11 | Rollout deployment policy. |+| MASKING_RULE | 9 | Data masking rule policy. |+| MASKING_EXCEPTION | 10 | Data masking exception policy. |+| TAG | 13 | Resource tag policy. |+| DATA_SOURCE_QUERY | 14 | Data source query restrictions policy. |+| DATA_QUERY | 16 | Query data access policy. |@@ -7126,14 +7125,14 @@ The policy's `name` field is used to identify the instance to update. Format<a name="bytebase-v1-SQLReviewRuleLevel"></a>### SQLReviewRuleLevel-+The severity level for SQL review rules.| Name | Number | Description || ---- | ------ | ----------- |-| LEVEL_UNSPECIFIED | 0 | |-| ERROR | 1 | |-| WARNING | 2 | |-| DISABLED | 3 | |+| LEVEL_UNSPECIFIED | 0 | Unspecified level. |+| ERROR | 1 | Rule violation is an error. |+| WARNING | 2 | Rule violation is a warning. |+| DISABLED | 3 | Rule is disabled. |@@ -7144,15 +7143,15 @@ The policy's `name` field is used to identify the instance to update. Format<a name="bytebase-v1-OrgPolicyService"></a>### OrgPolicyService-+OrgPolicyService manages organizational policies at various resource levels.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| GetPolicy | [GetPolicyRequest](#bytebase-v1-GetPolicyRequest) | [Policy](#bytebase-v1-Policy) | Permissions required: bb.policies.get |-| ListPolicies | [ListPoliciesRequest](#bytebase-v1-ListPoliciesRequest) | [ListPoliciesResponse](#bytebase-v1-ListPoliciesResponse) | Permissions required: bb.policies.list |-| CreatePolicy | [CreatePolicyRequest](#bytebase-v1-CreatePolicyRequest) | [Policy](#bytebase-v1-Policy) | Permissions required: bb.policies.create |-| UpdatePolicy | [UpdatePolicyRequest](#bytebase-v1-UpdatePolicyRequest) | [Policy](#bytebase-v1-Policy) | Permissions required: bb.policies.update |-| DeletePolicy | [DeletePolicyRequest](#bytebase-v1-DeletePolicyRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Permissions required: bb.policies.delete |+| GetPolicy | [GetPolicyRequest](#bytebase-v1-GetPolicyRequest) | [Policy](#bytebase-v1-Policy) | Retrieves a policy by name. Permissions required: bb.policies.get |+| ListPolicies | [ListPoliciesRequest](#bytebase-v1-ListPoliciesRequest) | [ListPoliciesResponse](#bytebase-v1-ListPoliciesResponse) | Lists policies at a specified resource level. Permissions required: bb.policies.list |+| CreatePolicy | [CreatePolicyRequest](#bytebase-v1-CreatePolicyRequest) | [Policy](#bytebase-v1-Policy) | Creates a new organizational policy. Permissions required: bb.policies.create |+| UpdatePolicy | [UpdatePolicyRequest](#bytebase-v1-UpdatePolicyRequest) | [Policy](#bytebase-v1-Policy) | Updates an existing organizational policy. Permissions required: bb.policies.update |+| DeletePolicy | [DeletePolicyRequest](#bytebase-v1-DeletePolicyRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes an organizational policy. Permissions required: bb.policies.delete |@@ -7231,8 +7230,8 @@ The policy's `name` field is used to identify the instance to update. Format| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || parent | [string](#string) | | The parent, which owns this collection of plan check runs. Format: projects/{project}/plans/{plan} |-| page_size | [int32](#int32) | | Not used. The maximum number of plan check runs to return. The service may return fewer than this value. If unspecified, at most 10 plan check runs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |-| page_token | [string](#string) | | Not used. A page token, received from a previous `ListPlanCheckRuns` 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 plan check runs to return. The service may return fewer than this value. If unspecified, at most 10 plan check runs 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 `ListPlanCheckRuns` call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `ListPlanCheckRuns` must match the call that provided the page token. || latest_only | [bool](#bool) | | If set to true, only the latest plan check run will be returned. |@@ -7310,9 +7309,9 @@ When paginating, all other parameters provided to `ListPlans` must match the cal| state | [State](#bytebase-v1-State) | | The state of the plan. || issue | [string](#string) | | The issue associated with the plan. Can be empty. Format: projects/{project}/issues/{issue} || rollout | [string](#string) | | The rollout associated with the plan. Can be empty. Format: projects/{project}/rollouts/{rollout} |-| title | [string](#string) | | |-| description | [string](#string) | | |-| specs | [Plan.Spec](#bytebase-v1-Plan-Spec) | repeated | |+| title | [string](#string) | | The title of the plan. |+| description | [string](#string) | | The description of the plan. |+| specs | [Plan.Spec](#bytebase-v1-Plan-Spec) | repeated | The deployment specs for the plan. || creator | [string](#string) | | Format: users/[email protected] || create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | || update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |@@ -7667,12 +7666,12 @@ The plan's `name` field is used to identify the plan to update. Format: proj| Name | Number | Description || ---- | ------ | ----------- |-| TYPE_UNSPECIFIED | 0 | |-| DATABASE_STATEMENT_FAKE_ADVISE | 1 | |-| DATABASE_STATEMENT_ADVISE | 3 | |-| DATABASE_STATEMENT_SUMMARY_REPORT | 5 | |-| DATABASE_CONNECT | 6 | |-| DATABASE_GHOST_SYNC | 7 | |+| TYPE_UNSPECIFIED | 0 | Unspecified check type. |+| DATABASE_STATEMENT_FAKE_ADVISE | 1 | Fake advise check for testing purposes without executing against database. |+| DATABASE_STATEMENT_ADVISE | 3 | SQL review check that analyzes statements against configured SQL review rules. |+| DATABASE_STATEMENT_SUMMARY_REPORT | 5 | Summary report check that generates impact analysis for the statements. |+| DATABASE_CONNECT | 6 | Connection check that verifies database connectivity. |+| DATABASE_GHOST_SYNC | 7 | Ghost sync check that validates gh-ost online schema change compatibility. |@@ -7683,18 +7682,18 @@ The plan's `name` field is used to identify the plan to update. Format: proj<a name="bytebase-v1-PlanService"></a>### PlanService-+PlanService manages deployment plans for database changes.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| GetPlan | [GetPlanRequest](#bytebase-v1-GetPlanRequest) | [Plan](#bytebase-v1-Plan) | Permissions required: bb.plans.get |-| ListPlans | [ListPlansRequest](#bytebase-v1-ListPlansRequest) | [ListPlansResponse](#bytebase-v1-ListPlansResponse) | Permissions required: bb.plans.list |+| GetPlan | [GetPlanRequest](#bytebase-v1-GetPlanRequest) | [Plan](#bytebase-v1-Plan) | Retrieves a deployment plan by name. Permissions required: bb.plans.get |+| ListPlans | [ListPlansRequest](#bytebase-v1-ListPlansRequest) | [ListPlansResponse](#bytebase-v1-ListPlansResponse) | Lists deployment plans in a project. Permissions required: bb.plans.list || SearchPlans | [SearchPlansRequest](#bytebase-v1-SearchPlansRequest) | [SearchPlansResponse](#bytebase-v1-SearchPlansResponse) | Search for plans that the caller has the bb.plans.get permission on and also satisfy the specified filter & query. Permissions required: bb.plans.get |-| CreatePlan | [CreatePlanRequest](#bytebase-v1-CreatePlanRequest) | [Plan](#bytebase-v1-Plan) | Permissions required: bb.plans.create |-| UpdatePlan | [UpdatePlanRequest](#bytebase-v1-UpdatePlanRequest) | [Plan](#bytebase-v1-Plan) | UpdatePlan updates the plan. The plan creator and the user with bb.plans.update permission on the project can update the plan. Permissions required: bb.plans.update |-| ListPlanCheckRuns | [ListPlanCheckRunsRequest](#bytebase-v1-ListPlanCheckRunsRequest) | [ListPlanCheckRunsResponse](#bytebase-v1-ListPlanCheckRunsResponse) | Permissions required: bb.planCheckRuns.list |-| RunPlanChecks | [RunPlanChecksRequest](#bytebase-v1-RunPlanChecksRequest) | [RunPlanChecksResponse](#bytebase-v1-RunPlanChecksResponse) | Permissions required: bb.planCheckRuns.run |-| BatchCancelPlanCheckRuns | [BatchCancelPlanCheckRunsRequest](#bytebase-v1-BatchCancelPlanCheckRunsRequest) | [BatchCancelPlanCheckRunsResponse](#bytebase-v1-BatchCancelPlanCheckRunsResponse) | Permissions required: bb.planCheckRuns.run |+| CreatePlan | [CreatePlanRequest](#bytebase-v1-CreatePlanRequest) | [Plan](#bytebase-v1-Plan) | Creates a new deployment plan. Permissions required: bb.plans.create |+| UpdatePlan | [UpdatePlanRequest](#bytebase-v1-UpdatePlanRequest) | [Plan](#bytebase-v1-Plan) | UpdatePlan updates the plan. The plan creator and the user with bb.plans.update permission on the project can update the plan. Permissions required: bb.plans.update (or creator) |+| ListPlanCheckRuns | [ListPlanCheckRunsRequest](#bytebase-v1-ListPlanCheckRunsRequest) | [ListPlanCheckRunsResponse](#bytebase-v1-ListPlanCheckRunsResponse) | Lists plan check runs for a deployment plan. Permissions required: bb.planCheckRuns.list |+| RunPlanChecks | [RunPlanChecksRequest](#bytebase-v1-RunPlanChecksRequest) | [RunPlanChecksResponse](#bytebase-v1-RunPlanChecksResponse) | Executes validation checks on a deployment plan. Permissions required: bb.planCheckRuns.run |+| BatchCancelPlanCheckRuns | [BatchCancelPlanCheckRunsRequest](#bytebase-v1-BatchCancelPlanCheckRunsRequest) | [BatchCancelPlanCheckRunsResponse](#bytebase-v1-BatchCancelPlanCheckRunsResponse) | Cancels multiple plan check runs. Permissions required: bb.planCheckRuns.run |@@ -7710,6 +7709,7 @@ The plan's `name` field is used to identify the plan to update. Format: proj<a name="bytebase-v1-Activity"></a>### Activity+Activity types for webhook notifications.TODO(zp): move to activity later.@@ -7773,7 +7773,7 @@ TODO(zp): move to activity later.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| policy_results | [BatchGetIamPolicyResponse.PolicyResult](#bytebase-v1-BatchGetIamPolicyResponse-PolicyResult) | repeated | |+| policy_results | [BatchGetIamPolicyResponse.PolicyResult](#bytebase-v1-BatchGetIamPolicyResponse-PolicyResult) | repeated | The policy results for each requested project. |@@ -7783,13 +7783,13 @@ TODO(zp): move to activity later.<a name="bytebase-v1-BatchGetIamPolicyResponse-PolicyResult"></a>### BatchGetIamPolicyResponse.PolicyResult-+Result for a single project's IAM policy.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| project | [string](#string) | | |-| policy | [IamPolicy](#bytebase-v1-IamPolicy) | | |+| project | [string](#string) | | The project resource name. |+| policy | [IamPolicy](#bytebase-v1-IamPolicy) | | The IAM policy for the project. |@@ -7849,14 +7849,14 @@ This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |<a name="bytebase-v1-Label"></a>### Label-+A label for categorizing and organizing issues.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| value | [string](#string) | | |-| color | [string](#string) | | |-| group | [string](#string) | | |+| value | [string](#string) | | The label value/name. |+| color | [string](#string) | | The color code for the label (e.g., hex color). |+| group | [string](#string) | | The group this label belongs to. |@@ -7908,22 +7908,22 @@ When paginating, all other parameters provided to `ListProjects` must match the| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || name | [string](#string) | | The name of the project. Format: projects/{project} |-| state | [State](#bytebase-v1-State) | | |+| state | [State](#bytebase-v1-State) | | The lifecycle state of the project. || title | [string](#string) | | The title or name of a project. It's not unique within the workspace. |-| webhooks | [Webhook](#bytebase-v1-Webhook) | repeated | |-| data_classification_config_id | [string](#string) | | |-| issue_labels | [Label](#bytebase-v1-Label) | repeated | |+| webhooks | [Webhook](#bytebase-v1-Webhook) | repeated | The list of webhooks configured for the project. |+| data_classification_config_id | [string](#string) | | The data classification configuration ID for the project. |+| issue_labels | [Label](#bytebase-v1-Label) | repeated | Labels available for tagging issues in this project. || force_issue_labels | [bool](#bool) | | Force issue labels to be used when creating an issue. |-| allow_modify_statement | [bool](#bool) | | Allow modifying statement after issue is created. |-| auto_resolve_issue | [bool](#bool) | | Enable auto resolve issue. |-| enforce_issue_title | [bool](#bool) | | Enforce issue title created by user instead of generated by Bytebase. |-| auto_enable_backup | [bool](#bool) | | Whether to automatically enable backup. |-| 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-v1-Project-ExecutionRetryPolicy) | | Execution retry policy for the task run. |-| ci_sampling_size | [int32](#int32) | | The maximum databases of rows to sample during CI data validation. Without specification, 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. |+| allow_modify_statement | [bool](#bool) | | Allow modifying SQL statements after issue is created. |+| auto_resolve_issue | [bool](#bool) | | Enable automatic issue resolution when tasks complete. |+| enforce_issue_title | [bool](#bool) | | Enforce issue title to be created by user instead of generated by Bytebase. |+| auto_enable_backup | [bool](#bool) | | Whether to automatically enable backup for database changes. |+| skip_backup_errors | [bool](#bool) | | Whether to skip backup errors and continue with data migration. |+| postgres_database_tenant_mode | [bool](#bool) | | Whether to enable database tenant mode for PostgreSQL. If enabled, issues will include "set role <db_owner>" statement. |+| allow_self_approval | [bool](#bool) | | Whether to allow issue creators to self-approve their own issues. |+| execution_retry_policy | [Project.ExecutionRetryPolicy](#bytebase-v1-Project-ExecutionRetryPolicy) | | Execution retry policy for task runs. |+| ci_sampling_size | [int32](#int32) | | The maximum number of database rows to sample during CI data validation. Without specification, sampling is disabled, resulting in full validation. |+| parallel_tasks_per_rollout | [int32](#int32) | | The maximum number of parallel tasks allowed during rollout execution. || labels | [Project.LabelsEntry](#bytebase-v1-Project-LabelsEntry) | repeated | Labels are key-value pairs that can be attached to the project. For example, { "environment": "production", "team": "backend" } || enforce_sql_review | [bool](#bool) | | Whether to enforce SQL review checks to pass before issue creation. If enabled, issues cannot be created when SQL review finds errors. |@@ -7935,12 +7935,12 @@ When paginating, all other parameters provided to `ListProjects` must match the<a name="bytebase-v1-Project-ExecutionRetryPolicy"></a>### Project.ExecutionRetryPolicy-+Execution retry policy configuration.| 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 retries for lock timeout errors. |@@ -8125,11 +8125,11 @@ The project's `name` field is used to identify the project to update. Format<a name="bytebase-v1-Activity-Type"></a>### Activity.Type-+Activity type enumeration.| Name | Number | Description || ---- | ------ | ----------- |-| TYPE_UNSPECIFIED | 0 | |+| TYPE_UNSPECIFIED | 0 | Unspecified type. || NOTIFY_ISSUE_APPROVED | 23 | Notifications via webhooks.NOTIFY_ISSUE_APPROVED represents the issue approved notification. |@@ -8149,18 +8149,18 @@ ISSUE_CREATE represents creating an issue. |<a name="bytebase-v1-Webhook-Type"></a>### Webhook.Type-+Webhook integration type.| Name | Number | Description || ---- | ------ | ----------- |-| TYPE_UNSPECIFIED | 0 | |-| SLACK | 1 | |-| DISCORD | 2 | |-| TEAMS | 3 | |-| DINGTALK | 4 | |-| FEISHU | 5 | |-| WECOM | 6 | |-| LARK | 8 | |+| TYPE_UNSPECIFIED | 0 | Unspecified type. |+| SLACK | 1 | Slack integration. |+| DISCORD | 2 | Discord integration. |+| TEAMS | 3 | Microsoft Teams integration. |+| DINGTALK | 4 | DingTalk integration. |+| FEISHU | 5 | Feishu integration. |+| WECOM | 6 | WeCom (WeChat Work) integration. |+| LARK | 8 | Lark integration. |@@ -8171,25 +8171,25 @@ ISSUE_CREATE represents creating an issue. |<a name="bytebase-v1-ProjectService"></a>### ProjectService-+ProjectService manages projects that group databases and changes.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|| GetProject | [GetProjectRequest](#bytebase-v1-GetProjectRequest) | [Project](#bytebase-v1-Project) | GetProject retrieves a project by name. Users with "bb.projects.get" permission on the workspace or the project owner can access this method. Permissions required: bb.projects.get |-| ListProjects | [ListProjectsRequest](#bytebase-v1-ListProjectsRequest) | [ListProjectsResponse](#bytebase-v1-ListProjectsResponse) | Permissions required: bb.projects.list |-| SearchProjects | [SearchProjectsRequest](#bytebase-v1-SearchProjectsRequest) | [SearchProjectsResponse](#bytebase-v1-SearchProjectsResponse) | Permissions required: None |-| CreateProject | [CreateProjectRequest](#bytebase-v1-CreateProjectRequest) | [Project](#bytebase-v1-Project) | Permissions required: bb.projects.create |-| UpdateProject | [UpdateProjectRequest](#bytebase-v1-UpdateProjectRequest) | [Project](#bytebase-v1-Project) | Permissions required: bb.projects.update |-| DeleteProject | [DeleteProjectRequest](#bytebase-v1-DeleteProjectRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Permissions required: bb.projects.delete |-| UndeleteProject | [UndeleteProjectRequest](#bytebase-v1-UndeleteProjectRequest) | [Project](#bytebase-v1-Project) | Permissions required: bb.projects.undelete |-| BatchDeleteProjects | [BatchDeleteProjectsRequest](#bytebase-v1-BatchDeleteProjectsRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Permissions required: bb.projects.delete |-| GetIamPolicy | [GetIamPolicyRequest](#bytebase-v1-GetIamPolicyRequest) | [IamPolicy](#bytebase-v1-IamPolicy) | Permissions required: bb.projects.getIamPolicy |-| BatchGetIamPolicy | [BatchGetIamPolicyRequest](#bytebase-v1-BatchGetIamPolicyRequest) | [BatchGetIamPolicyResponse](#bytebase-v1-BatchGetIamPolicyResponse) | Deprecated. Permissions required: bb.projects.getIamPolicy |-| SetIamPolicy | [SetIamPolicyRequest](#bytebase-v1-SetIamPolicyRequest) | [IamPolicy](#bytebase-v1-IamPolicy) | Permissions required: bb.projects.setIamPolicy |-| AddWebhook | [AddWebhookRequest](#bytebase-v1-AddWebhookRequest) | [Project](#bytebase-v1-Project) | Permissions required: bb.projects.update |-| UpdateWebhook | [UpdateWebhookRequest](#bytebase-v1-UpdateWebhookRequest) | [Project](#bytebase-v1-Project) | Permissions required: bb.projects.update |-| RemoveWebhook | [RemoveWebhookRequest](#bytebase-v1-RemoveWebhookRequest) | [Project](#bytebase-v1-Project) | Permissions required: bb.projects.update |-| TestWebhook | [TestWebhookRequest](#bytebase-v1-TestWebhookRequest) | [TestWebhookResponse](#bytebase-v1-TestWebhookResponse) | Permissions required: bb.projects.update |+| ListProjects | [ListProjectsRequest](#bytebase-v1-ListProjectsRequest) | [ListProjectsResponse](#bytebase-v1-ListProjectsResponse) | Lists all projects in the workspace with optional filtering. Permissions required: bb.projects.list |+| SearchProjects | [SearchProjectsRequest](#bytebase-v1-SearchProjectsRequest) | [SearchProjectsResponse](#bytebase-v1-SearchProjectsResponse) | Searches for projects with advanced filtering capabilities. Permissions required: bb.projects.get (or project-level bb.projects.get for specific projects) |+| CreateProject | [CreateProjectRequest](#bytebase-v1-CreateProjectRequest) | [Project](#bytebase-v1-Project) | Creates a new project in the workspace. Permissions required: bb.projects.create |+| UpdateProject | [UpdateProjectRequest](#bytebase-v1-UpdateProjectRequest) | [Project](#bytebase-v1-Project) | Updates an existing project's properties. Permissions required: bb.projects.update |+| DeleteProject | [DeleteProjectRequest](#bytebase-v1-DeleteProjectRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes (soft-delete or purge) a project. Permissions required: bb.projects.delete |+| UndeleteProject | [UndeleteProjectRequest](#bytebase-v1-UndeleteProjectRequest) | [Project](#bytebase-v1-Project) | Restores a soft-deleted project. Permissions required: bb.projects.undelete |+| BatchDeleteProjects | [BatchDeleteProjectsRequest](#bytebase-v1-BatchDeleteProjectsRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes multiple projects in a single operation. Permissions required: bb.projects.delete |+| GetIamPolicy | [GetIamPolicyRequest](#bytebase-v1-GetIamPolicyRequest) | [IamPolicy](#bytebase-v1-IamPolicy) | Retrieves the IAM policy for a project. Permissions required: bb.projects.getIamPolicy |+| BatchGetIamPolicy | [BatchGetIamPolicyRequest](#bytebase-v1-BatchGetIamPolicyRequest) | [BatchGetIamPolicyResponse](#bytebase-v1-BatchGetIamPolicyResponse) | Deprecated. No permission check implemented. Permissions required: None |+| SetIamPolicy | [SetIamPolicyRequest](#bytebase-v1-SetIamPolicyRequest) | [IamPolicy](#bytebase-v1-IamPolicy) | Sets the IAM policy for a project. Permissions required: bb.projects.setIamPolicy |+| AddWebhook | [AddWebhookRequest](#bytebase-v1-AddWebhookRequest) | [Project](#bytebase-v1-Project) | Adds a webhook to a project for notifications. Permissions required: bb.projects.update |+| UpdateWebhook | [UpdateWebhookRequest](#bytebase-v1-UpdateWebhookRequest) | [Project](#bytebase-v1-Project) | Updates an existing webhook configuration. Permissions required: bb.projects.update |+| RemoveWebhook | [RemoveWebhookRequest](#bytebase-v1-RemoveWebhookRequest) | [Project](#bytebase-v1-Project) | Removes a webhook from a project. Permissions required: bb.projects.update |+| TestWebhook | [TestWebhookRequest](#bytebase-v1-TestWebhookRequest) | [TestWebhookResponse](#bytebase-v1-TestWebhookResponse) | Tests a webhook by sending a test notification. Permissions required: bb.projects.update |@@ -8741,7 +8741,7 @@ for field description.| page_token | [string](#string) | | A page token, received from a previous `ListQueryHistory` call. Provide this to retrieve the subsequent page. || filter | [string](#string) | | Filter is the filter to apply on the search query history The syntax and semantics of CEL are documented at https://github.com/google/cel-spec-Supported filter: - project: the project full name in "projects/{id}" format, support "==" operator. - database: the database full name in "instances/{id}/databases/{name}" format, support "==" operator. - instance: the instance full name in "instances/{id}" format, support "==" operator. - type: the type, should be "QUERY" or "EXPORT", support "==" operator. - statement: the SQL statemnt, support ".matches()" operator.+Supported filter: - project: the project full name in "projects/{id}" format, support "==" operator. - database: the database full name in "instances/{id}/databases/{name}" format, support "==" operator. - instance: the instance full name in "instances/{id}" format, support "==" operator. - type: the type, should be "QUERY" or "EXPORT", support "==" operator. - statement: the SQL statement, support ".matches()" operator.For example: project == "projects/{project}" database == "instances/{instance}/databases/{database}" instance == "instances/{instance}" type == "QUERY" type == "EXPORT" statement.matches("select") type == "QUERY" && statement.matches("select") |@@ -8804,9 +8804,9 @@ For example: project == "projects/{project}" database == "instances/| Name | Number | Description || ---- | ------ | ----------- |-| TYPE_UNSPECIFIED | 0 | |-| QUERY | 1 | |-| EXPORT | 2 | |+| TYPE_UNSPECIFIED | 0 | Unspecified query history type. |+| QUERY | 1 | Query execution for data retrieval. |+| EXPORT | 2 | Data export operation to file. |@@ -8818,8 +8818,8 @@ For example: project == "projects/{project}" database == "instances/| Name | Number | Description || ---- | ------ | ----------- || REDIS_RUN_COMMANDS_ON_UNSPECIFIED | 0 | UNSPECIFIED defaults to SINGLE_NODE. |-| SINGLE_NODE | 1 | |-| ALL_NODES | 2 | |+| SINGLE_NODE | 1 | Execute Redis commands on a single node in the cluster. |+| ALL_NODES | 2 | Execute Redis commands on all nodes in the cluster for cluster-wide operations. |@@ -8830,13 +8830,13 @@ For example: project == "projects/{project}" database == "instances/| Name | Number | Description || ---- | ------ | ----------- |-| LEVEL_UNSPECIFIED | 0 | Unspecified. |-| INFO | 1 | |-| WARNING | 2 | |-| DEBUG | 3 | |-| LOG | 4 | |-| NOTICE | 5 | |-| EXCEPTION | 6 | |+| LEVEL_UNSPECIFIED | 0 | Unspecified message level. |+| INFO | 1 | Informational message. |+| WARNING | 2 | Warning message indicating potential issues. |+| DEBUG | 3 | Debug message for development and troubleshooting. |+| LOG | 4 | General log message. |+| NOTICE | 5 | Notice message for important information. |+| EXCEPTION | 6 | Exception message indicating error conditions. |@@ -8847,18 +8847,18 @@ For example: project == "projects/{project}" database == "instances/<a name="bytebase-v1-SQLService"></a>### SQLService-+SQLService executes SQL queries and manages query operations.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| Query | [QueryRequest](#bytebase-v1-QueryRequest) | [QueryResponse](#bytebase-v1-QueryResponse) | Permissions required: bb.databases.get |-| AdminExecute | [AdminExecuteRequest](#bytebase-v1-AdminExecuteRequest) stream | [AdminExecuteResponse](#bytebase-v1-AdminExecuteResponse) stream | Permissions required: bb.sql.admin |-| SearchQueryHistories | [SearchQueryHistoriesRequest](#bytebase-v1-SearchQueryHistoriesRequest) | [SearchQueryHistoriesResponse](#bytebase-v1-SearchQueryHistoriesResponse) | SearchQueryHistories searches query histories for the caller. Permissions required: None |-| Export | [ExportRequest](#bytebase-v1-ExportRequest) | [ExportResponse](#bytebase-v1-ExportResponse) | Permissions required: bb.databases.get |-| Check | [CheckRequest](#bytebase-v1-CheckRequest) | [CheckResponse](#bytebase-v1-CheckResponse) | Permissions required: bb.databases.check |-| Pretty | [PrettyRequest](#bytebase-v1-PrettyRequest) | [PrettyResponse](#bytebase-v1-PrettyResponse) | Permissions required: None |-| DiffMetadata | [DiffMetadataRequest](#bytebase-v1-DiffMetadataRequest) | [DiffMetadataResponse](#bytebase-v1-DiffMetadataResponse) | Permissions required: None |-| AICompletion | [AICompletionRequest](#bytebase-v1-AICompletionRequest) | [AICompletionResponse](#bytebase-v1-AICompletionResponse) | Permissions required: None |+| Query | [QueryRequest](#bytebase-v1-QueryRequest) | [QueryResponse](#bytebase-v1-QueryResponse) | Executes a read-only SQL query against a database. Permissions required: bb.databases.get |+| AdminExecute | [AdminExecuteRequest](#bytebase-v1-AdminExecuteRequest) stream | [AdminExecuteResponse](#bytebase-v1-AdminExecuteResponse) stream | Executes SQL with admin privileges via streaming connection. Permissions required: bb.sql.admin |+| SearchQueryHistories | [SearchQueryHistoriesRequest](#bytebase-v1-SearchQueryHistoriesRequest) | [SearchQueryHistoriesResponse](#bytebase-v1-SearchQueryHistoriesResponse) | SearchQueryHistories searches query histories for the caller. Permissions required: None (only returns caller's own query histories) |+| Export | [ExportRequest](#bytebase-v1-ExportRequest) | [ExportResponse](#bytebase-v1-ExportResponse) | Exports query results to a file format. Permissions required: bb.databases.get |+| Check | [CheckRequest](#bytebase-v1-CheckRequest) | [CheckResponse](#bytebase-v1-CheckResponse) | Validates SQL statements against review rules. Permissions required: bb.databases.check |+| Pretty | [PrettyRequest](#bytebase-v1-PrettyRequest) | [PrettyResponse](#bytebase-v1-PrettyResponse) | Formats and normalizes SQL schema definitions. Permissions required: None |+| DiffMetadata | [DiffMetadataRequest](#bytebase-v1-DiffMetadataRequest) | [DiffMetadataResponse](#bytebase-v1-DiffMetadataResponse) | Computes schema differences between two database metadata. Permissions required: None |+| AICompletion | [AICompletionRequest](#bytebase-v1-AICompletionRequest) | [AICompletionResponse](#bytebase-v1-AICompletionResponse) | Provides AI-powered SQL completion and generation. Permissions required: None (authenticated users only, requires AI to be enabled) |@@ -8896,8 +8896,8 @@ For example: project == "projects/{project}" database == "instances/| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| results | [CheckReleaseResponse.CheckResult](#bytebase-v1-CheckReleaseResponse-CheckResult) | repeated | |-| affected_rows | [int64](#int64) | | The affected rows of the check. |+| results | [CheckReleaseResponse.CheckResult](#bytebase-v1-CheckReleaseResponse-CheckResult) | repeated | The check results for each file and target combination. |+| affected_rows | [int64](#int64) | | The total affected rows across all checks. || risk_level | [RiskLevel](#bytebase-v1-RiskLevel) | | The aggregated risk level of the check. |@@ -8908,7 +8908,7 @@ For example: project == "projects/{project}" database == "instances/<a name="bytebase-v1-CheckReleaseResponse-CheckResult"></a>### CheckReleaseResponse.CheckResult-+Check result for a single release file on a target database.| Field | Type | Label | Description |@@ -8998,7 +8998,7 @@ When paginating, all other parameters provided to `ListReleases` must match the| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| releases | [Release](#bytebase-v1-Release) | repeated | |+| releases | [Release](#bytebase-v1-Release) | repeated | The releases from the specified request. || next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |@@ -9015,12 +9015,12 @@ When paginating, all other parameters provided to `ListReleases` must match the| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || name | [string](#string) | | Format: projects/{project}/releases/{release} |-| title | [string](#string) | | |-| files | [Release.File](#bytebase-v1-Release-File) | repeated | |-| vcs_source | [Release.VCSSource](#bytebase-v1-Release-VCSSource) | | |+| title | [string](#string) | | The title of the release. |+| files | [Release.File](#bytebase-v1-Release-File) | repeated | The SQL files included in the release. |+| vcs_source | [Release.VCSSource](#bytebase-v1-Release-VCSSource) | | The version control source of the release. || creator | [string](#string) | | Format: users/[email protected] || create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |-| state | [State](#bytebase-v1-State) | | |+| state | [State](#bytebase-v1-State) | | The lifecycle state of the release. || digest | [string](#string) | | The digest of the release. The user can provide the digest of the release. It can be used later to retrieve the release in GetRelease. Whether to provide digest and how to generate it is up to the user. If the digest is not empty, it must be unique in the project. Otherwise, an ALREADY_EXISTS error will be returned. |@@ -9031,7 +9031,7 @@ When paginating, all other parameters provided to `ListReleases` must match the<a name="bytebase-v1-Release-File"></a>### Release.File-+A SQL file in a release.| Field | Type | Label | Description |@@ -9039,7 +9039,7 @@ When paginating, all other parameters provided to `ListReleases` must match the| 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`. || type | [Release.File.Type](#bytebase-v1-Release-File-Type) | | The type of the file. |-| version | [string](#string) | | |+| 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. || sheet | [string](#string) | | For inputs, we must either use `sheet` or `statement`. For outputs, we always use `sheet`. `statement` is the preview of the sheet content.@@ -9056,12 +9056,12 @@ The sheet that holds the content. Format: projects/{project}/sheets/{sheet} |<a name="bytebase-v1-Release-VCSSource"></a>### Release.VCSSource-+Version control system source information.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| vcs_type | [VCSType](#bytebase-v1-VCSType) | | |+| 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. |@@ -9097,7 +9097,7 @@ When paginating, all other parameters provided to `ListReleases` must match the| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| releases | [Release](#bytebase-v1-Release) | repeated | |+| releases | [Release](#bytebase-v1-Release) | repeated | The releases matching the search criteria. || 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. |@@ -9142,27 +9142,27 @@ When paginating, all other parameters provided to `ListReleases` must match the<a name="bytebase-v1-Release-File-MigrationType"></a>### Release.File.MigrationType-+The migration type for versioned files.| Name | Number | Description || ---- | ------ | ----------- |-| MIGRATION_TYPE_UNSPECIFIED | 0 | |-| DDL | 1 | |-| DDL_GHOST | 2 | |-| DML | 3 | |+| MIGRATION_TYPE_UNSPECIFIED | 0 | Unspecified migration type. |+| DDL | 1 | DDL (Data Definition Language) migration. |+| DDL_GHOST | 2 | DDL migration using gh-ost for online schema changes. |+| DML | 3 | DML (Data Manipulation Language) migration. |<a name="bytebase-v1-Release-File-Type"></a>### Release.File.Type-+The type of migration file.| Name | Number | Description || ---- | ------ | ----------- |-| TYPE_UNSPECIFIED | 0 | |-| VERSIONED | 1 | |-| DECLARATIVE | 2 | |+| TYPE_UNSPECIFIED | 0 | Unspecified type. |+| VERSIONED | 1 | Versioned migration file with sequential version numbers. |+| DECLARATIVE | 2 | Declarative schema definition file describing desired state. |@@ -9173,18 +9173,18 @@ When paginating, all other parameters provided to `ListReleases` must match the<a name="bytebase-v1-ReleaseService"></a>### ReleaseService-+ReleaseService manages releases for coordinating deployments.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| GetRelease | [GetReleaseRequest](#bytebase-v1-GetReleaseRequest) | [Release](#bytebase-v1-Release) | Permissions required: bb.releases.get |-| ListReleases | [ListReleasesRequest](#bytebase-v1-ListReleasesRequest) | [ListReleasesResponse](#bytebase-v1-ListReleasesResponse) | Permissions required: bb.releases.list |-| SearchReleases | [SearchReleasesRequest](#bytebase-v1-SearchReleasesRequest) | [SearchReleasesResponse](#bytebase-v1-SearchReleasesResponse) | Permissions required: bb.releases.get |-| CreateRelease | [CreateReleaseRequest](#bytebase-v1-CreateReleaseRequest) | [Release](#bytebase-v1-Release) | Permissions required: bb.releases.create |-| UpdateRelease | [UpdateReleaseRequest](#bytebase-v1-UpdateReleaseRequest) | [Release](#bytebase-v1-Release) | Permissions required: bb.releases.update |-| DeleteRelease | [DeleteReleaseRequest](#bytebase-v1-DeleteReleaseRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Permissions required: bb.releases.delete |-| UndeleteRelease | [UndeleteReleaseRequest](#bytebase-v1-UndeleteReleaseRequest) | [Release](#bytebase-v1-Release) | Permissions required: bb.releases.undelete |-| CheckRelease | [CheckReleaseRequest](#bytebase-v1-CheckReleaseRequest) | [CheckReleaseResponse](#bytebase-v1-CheckReleaseResponse) | Permissions required: bb.releases.check |+| GetRelease | [GetReleaseRequest](#bytebase-v1-GetReleaseRequest) | [Release](#bytebase-v1-Release) | Retrieves a release by name. Permissions required: bb.releases.get |+| ListReleases | [ListReleasesRequest](#bytebase-v1-ListReleasesRequest) | [ListReleasesResponse](#bytebase-v1-ListReleasesResponse) | Lists releases in a project. Permissions required: bb.releases.list |+| SearchReleases | [SearchReleasesRequest](#bytebase-v1-SearchReleasesRequest) | [SearchReleasesResponse](#bytebase-v1-SearchReleasesResponse) | Searches releases by digest or other criteria. Permissions required: bb.releases.get |+| CreateRelease | [CreateReleaseRequest](#bytebase-v1-CreateReleaseRequest) | [Release](#bytebase-v1-Release) | Creates a new release with SQL files. Permissions required: bb.releases.create |+| UpdateRelease | [UpdateReleaseRequest](#bytebase-v1-UpdateReleaseRequest) | [Release](#bytebase-v1-Release) | Updates an existing release. Permissions required: bb.releases.update |+| DeleteRelease | [DeleteReleaseRequest](#bytebase-v1-DeleteReleaseRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a release. Permissions required: bb.releases.delete |+| UndeleteRelease | [UndeleteReleaseRequest](#bytebase-v1-UndeleteReleaseRequest) | [Release](#bytebase-v1-Release) | Restores a deleted release. Permissions required: bb.releases.undelete |+| CheckRelease | [CheckReleaseRequest](#bytebase-v1-CheckReleaseRequest) | [CheckReleaseResponse](#bytebase-v1-CheckReleaseResponse) | Validates a release by dry-running checks on target databases. Permissions required: bb.releases.check |@@ -9250,8 +9250,8 @@ When paginating, all other parameters provided to `ListReleases` must match the| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| page_size | [int32](#int32) | | Not used. 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_token | [string](#string) | | Not used. A page token, 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 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_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. |@@ -9285,10 +9285,10 @@ 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} |-| title | [string](#string) | | |-| enabled | [bool](#bool) | | |-| rules | [SQLReviewRule](#bytebase-v1-SQLReviewRule) | repeated | |-| resources | [string](#string) | repeated | resources using the config. Format: {resurce}/{resource id}, for example, environments/test. |+| 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. |@@ -9323,15 +9323,15 @@ The name field is used to identify the sql review to update. |<a name="bytebase-v1-ReviewConfigService"></a>### ReviewConfigService-+ReviewConfigService manages approval flow configurations.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| CreateReviewConfig | [CreateReviewConfigRequest](#bytebase-v1-CreateReviewConfigRequest) | [ReviewConfig](#bytebase-v1-ReviewConfig) | Permissions required: bb.reviewConfigs.create |-| ListReviewConfigs | [ListReviewConfigsRequest](#bytebase-v1-ListReviewConfigsRequest) | [ListReviewConfigsResponse](#bytebase-v1-ListReviewConfigsResponse) | Permissions required: bb.reviewConfigs.list |-| GetReviewConfig | [GetReviewConfigRequest](#bytebase-v1-GetReviewConfigRequest) | [ReviewConfig](#bytebase-v1-ReviewConfig) | Permissions required: bb.reviewConfigs.get |-| UpdateReviewConfig | [UpdateReviewConfigRequest](#bytebase-v1-UpdateReviewConfigRequest) | [ReviewConfig](#bytebase-v1-ReviewConfig) | Permissions required: bb.reviewConfigs.update |-| DeleteReviewConfig | [DeleteReviewConfigRequest](#bytebase-v1-DeleteReviewConfigRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Permissions required: bb.reviewConfigs.delete |+| CreateReviewConfig | [CreateReviewConfigRequest](#bytebase-v1-CreateReviewConfigRequest) | [ReviewConfig](#bytebase-v1-ReviewConfig) | Creates a new SQL review configuration. Permissions required: bb.reviewConfigs.create |+| ListReviewConfigs | [ListReviewConfigsRequest](#bytebase-v1-ListReviewConfigsRequest) | [ListReviewConfigsResponse](#bytebase-v1-ListReviewConfigsResponse) | Lists all SQL review configurations. Permissions required: bb.reviewConfigs.list |+| GetReviewConfig | [GetReviewConfigRequest](#bytebase-v1-GetReviewConfigRequest) | [ReviewConfig](#bytebase-v1-ReviewConfig) | Retrieves a SQL review configuration by name. Permissions required: bb.reviewConfigs.get |+| UpdateReviewConfig | [UpdateReviewConfigRequest](#bytebase-v1-UpdateReviewConfigRequest) | [ReviewConfig](#bytebase-v1-ReviewConfig) | Updates a SQL review configuration. Permissions required: bb.reviewConfigs.update |+| DeleteReviewConfig | [DeleteReviewConfigRequest](#bytebase-v1-DeleteReviewConfigRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a SQL review configuration. Permissions required: bb.reviewConfigs.delete |@@ -9434,7 +9434,7 @@ The name field is used to identify the sql review to update. || page_token | [string](#string) | | A page token, received from a previous `ListRevisions` call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `ListRevisions` must match the call that provided the page token. |-| show_deleted | [bool](#bool) | | |+| show_deleted | [bool](#bool) | | Whether to include deleted revisions in the results. |@@ -9449,7 +9449,7 @@ When paginating, all other parameters provided to `ListRevisions` must match the| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| revisions | [Revision](#bytebase-v1-Revision) | repeated | |+| revisions | [Revision](#bytebase-v1-Revision) | repeated | The revisions from the specified request. || next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |@@ -9471,11 +9471,11 @@ When paginating, all other parameters provided to `ListRevisions` must match the| deleter | [string](#string) | | Format: users/[email protected] Can be empty. || delete_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | Can be empty. || file | [string](#string) | | Format: projects/{project}/releases/{release}/files/{id} Can be empty. |-| version | [string](#string) | | |+| version | [string](#string) | | The schema version string for this revision. || sheet | [string](#string) | | The sheet that holds the content. Format: projects/{project}/sheets/{sheet} || sheet_sha256 | [string](#string) | | The SHA256 hash value of the sheet. || statement | [string](#string) | | The statement is used for preview purpose. |-| statement_size | [int64](#int64) | | |+| statement_size | [int64](#int64) | | The size of the statement in bytes. || issue | [string](#string) | | The issue associated with the revision. Can be empty. Format: projects/{project}/issues/{issue} || task_run | [string](#string) | | The task run associated with the revision. Can be empty. Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{taskRun} || type | [Revision.Type](#bytebase-v1-Revision-Type) | | The type of the revision. |@@ -9490,13 +9490,13 @@ When paginating, all other parameters provided to `ListRevisions` must match the<a name="bytebase-v1-Revision-Type"></a>### Revision.Type-+The type of schema revision.| Name | Number | Description || ---- | ------ | ----------- |-| TYPE_UNSPECIFIED | 0 | |-| VERSIONED | 1 | |-| DECLARATIVE | 2 | |+| TYPE_UNSPECIFIED | 0 | Unspecified type. |+| VERSIONED | 1 | Versioned schema migration. |+| DECLARATIVE | 2 | Declarative schema definition. |@@ -9507,15 +9507,15 @@ When paginating, all other parameters provided to `ListRevisions` must match the<a name="bytebase-v1-RevisionService"></a>### RevisionService-+RevisionService manages schema revision history.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| ListRevisions | [ListRevisionsRequest](#bytebase-v1-ListRevisionsRequest) | [ListRevisionsResponse](#bytebase-v1-ListRevisionsResponse) | Permissions required: bb.revisions.list |-| GetRevision | [GetRevisionRequest](#bytebase-v1-GetRevisionRequest) | [Revision](#bytebase-v1-Revision) | Permissions required: bb.revisions.get |-| CreateRevision | [CreateRevisionRequest](#bytebase-v1-CreateRevisionRequest) | [Revision](#bytebase-v1-Revision) | Permissions required: bb.revisions.create |-| BatchCreateRevisions | [BatchCreateRevisionsRequest](#bytebase-v1-BatchCreateRevisionsRequest) | [BatchCreateRevisionsResponse](#bytebase-v1-BatchCreateRevisionsResponse) | Permissions required: bb.revisions.create |-| DeleteRevision | [DeleteRevisionRequest](#bytebase-v1-DeleteRevisionRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Permissions required: bb.revisions.delete |+| ListRevisions | [ListRevisionsRequest](#bytebase-v1-ListRevisionsRequest) | [ListRevisionsResponse](#bytebase-v1-ListRevisionsResponse) | Lists schema revisions for a database. Permissions required: bb.revisions.list |+| GetRevision | [GetRevisionRequest](#bytebase-v1-GetRevisionRequest) | [Revision](#bytebase-v1-Revision) | Retrieves a schema revision by name. Permissions required: bb.revisions.get |+| CreateRevision | [CreateRevisionRequest](#bytebase-v1-CreateRevisionRequest) | [Revision](#bytebase-v1-Revision) | Creates a new schema revision. Permissions required: bb.revisions.create |+| BatchCreateRevisions | [BatchCreateRevisionsRequest](#bytebase-v1-BatchCreateRevisionsRequest) | [BatchCreateRevisionsResponse](#bytebase-v1-BatchCreateRevisionsResponse) | Creates multiple schema revisions in a single operation. Permissions required: bb.revisions.create |+| DeleteRevision | [DeleteRevisionRequest](#bytebase-v1-DeleteRevisionRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a schema revision. Permissions required: bb.revisions.delete |@@ -9581,10 +9581,10 @@ When paginating, all other parameters provided to `ListRevisions` must match the| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| page_size | [int32](#int32) | | Not used. The maximum number of risks to return. The service may return fewer than this value. If unspecified, at most 10 risks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |-| page_token | [string](#string) | | Not used. A page token, received from a previous `ListRisks` 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 risks to return. The service may return fewer than this value. If unspecified, at most 10 risks 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 `ListRisks` call. Provide this to retrieve the subsequent page.-When paginating, all other parameters provided to `LiskRisks` must match the call that provided the page token. |+When paginating, all other parameters provided to `ListRisks` must match the call that provided the page token. |@@ -9617,9 +9617,9 @@ When paginating, all other parameters provided to `LiskRisks` must match the cal| ----- | ---- | ----- | ----------- || name | [string](#string) | | Format: risks/{risk} || source | [Risk.Source](#bytebase-v1-Risk-Source) | | |-| title | [string](#string) | | |-| level | [RiskLevel](#bytebase-v1-RiskLevel) | | |-| active | [bool](#bool) | | |+| 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. || condition | [google.type.Expr](#google-type-Expr) | | The condition that is associated with the risk. The syntax and semantics of CEL are documented at https://github.com/google/cel-specAll supported variables: statement.affected_rows: affected row count in the DDL/DML, support "==", "!=", "<", "<=", ">", ">=" operations. statement.table_rows: table row count number, support "==", "!=", "<", "<=", ">", ">=" operations. resource.environment_id: the environment resource id, support "==", "!=", "in [xx]", "!(in [xx])" operations. resource.project_id: the project resource id, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" operations. resource.db_engine: the database engine type, support "==", "!=", "in [xx]", "!(in [xx])" operations. Check the Engine enum for the values. statement.sql_type: the SQL type, support "==", "!=", "in [xx]", "!(in [xx])" operations. when the risk source is DDL, check https://github.com/bytebase/bytebase/blob/main/frontend/src/plugins/cel/types/values.ts#L70 for supported values. when the risk source is DML, check https://github.com/bytebase/bytebase/blob/main/frontend/src/plugins/cel/types/values.ts#L71 for supported values. resource.database_name: the database name, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" operations. resource.schema_name: the schema name, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" operations. resource.table_name: the table name, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" operations. statement.text: the SQL statement, support "contains()", "matches()", "startsWith()", "endsWith()" operations. request.expiration_days: the role expiration days for the request, support "==", "!=", "<", "<=", ">", ">=" operations. request.role: the request role full name, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" operations.@@ -9681,15 +9681,15 @@ The risk's `name` field is used to identify the risk to update. Format: risk<a name="bytebase-v1-RiskService"></a>### RiskService-+RiskService manages risk assessment rules for database changes.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| ListRisks | [ListRisksRequest](#bytebase-v1-ListRisksRequest) | [ListRisksResponse](#bytebase-v1-ListRisksResponse) | Permissions required: bb.risks.list |-| CreateRisk | [CreateRiskRequest](#bytebase-v1-CreateRiskRequest) | [Risk](#bytebase-v1-Risk) | Permissions required: bb.risks.create |-| GetRisk | [GetRiskRequest](#bytebase-v1-GetRiskRequest) | [Risk](#bytebase-v1-Risk) | Permissions required: bb.risks.list |-| UpdateRisk | [UpdateRiskRequest](#bytebase-v1-UpdateRiskRequest) | [Risk](#bytebase-v1-Risk) | Permissions required: bb.risks.update |-| DeleteRisk | [DeleteRiskRequest](#bytebase-v1-DeleteRiskRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Permissions required: bb.risks.delete |+| ListRisks | [ListRisksRequest](#bytebase-v1-ListRisksRequest) | [ListRisksResponse](#bytebase-v1-ListRisksResponse) | Lists all risk assessment rules. Permissions required: bb.risks.list |+| CreateRisk | [CreateRiskRequest](#bytebase-v1-CreateRiskRequest) | [Risk](#bytebase-v1-Risk) | Creates a new risk assessment rule. Permissions required: bb.risks.create |+| GetRisk | [GetRiskRequest](#bytebase-v1-GetRiskRequest) | [Risk](#bytebase-v1-Risk) | Retrieves a risk assessment rule by name. Permissions required: bb.risks.list |+| UpdateRisk | [UpdateRiskRequest](#bytebase-v1-UpdateRiskRequest) | [Risk](#bytebase-v1-Risk) | Updates an existing risk assessment rule. Permissions required: bb.risks.update |+| DeleteRisk | [DeleteRiskRequest](#bytebase-v1-DeleteRiskRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a risk assessment rule. Permissions required: bb.risks.delete |@@ -9710,7 +9710,7 @@ The risk's `name` field is used to identify the risk to update. Format: risk| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| role | [Role](#bytebase-v1-Role) | | |+| role | [Role](#bytebase-v1-Role) | | The role to create. || role_id | [string](#string) | | The ID to use for the role, which will become the final component of the role's resource name.This value should be 4-63 characters, and valid characters are /[a-z][A-Z][0-9]/. |@@ -9728,7 +9728,7 @@ This value should be 4-63 characters, and valid characters are /[a-z][A-Z][0-9]/| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | Format: roles/{role} |+| name | [string](#string) | | The name of the role to delete. Format: roles/{role} |@@ -9758,8 +9758,8 @@ This value should be 4-63 characters, and valid characters are /[a-z][A-Z][0-9]/| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| page_size | [int32](#int32) | | Not used. The maximum number of roles to return. The service may return fewer than this value. If unspecified, at most 10 reviews will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |-| page_token | [string](#string) | | Not used. A page token, received from a previous `ListRoles` 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 roles to return. The service may return fewer than this value. If unspecified, at most 10 reviews 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 `ListRoles` call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `ListRoles` must match the call that provided the page token. |@@ -9776,7 +9776,7 @@ When paginating, all other parameters provided to `ListRoles` must match the cal| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| roles | [Role](#bytebase-v1-Role) | repeated | |+| roles | [Role](#bytebase-v1-Role) | repeated | The roles from the specified request. || next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |@@ -9787,16 +9787,16 @@ When paginating, all other parameters provided to `ListRoles` must match the cal<a name="bytebase-v1-Role"></a>### Role-+Role defines a set of permissions that can be assigned to users.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | Format: roles/{role} |-| title | [string](#string) | | |-| description | [string](#string) | | |-| permissions | [string](#string) | repeated | |-| type | [Role.Type](#bytebase-v1-Role-Type) | | |+| name | [string](#string) | | Resource name. Format: roles/{role} |+| title | [string](#string) | | Human-readable title. |+| description | [string](#string) | | Optional description of the role. |+| permissions | [string](#string) | repeated | List of permission identifiers granted by this role. |+| type | [Role.Type](#bytebase-v1-Role-Type) | | Role type indicating if it's built-in or custom. |@@ -9811,9 +9811,9 @@ When paginating, all other parameters provided to `ListRoles` must match the cal| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| role | [Role](#bytebase-v1-Role) | | |-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | |-| allow_missing | [bool](#bool) | | If set to true, and the role is not found, a new role will be created. |+| role | [Role](#bytebase-v1-Role) | | The role to update. |+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |+| allow_missing | [bool](#bool) | | If set to true, and the role is not found, a new role will be created. In this situation, `update_mask` is ignored. |@@ -9830,8 +9830,8 @@ When paginating, all other parameters provided to `ListRoles` must match the cal| Name | Number | Description || ---- | ------ | ----------- || TYPE_UNSPECIFIED | 0 | |-| BUILT_IN | 1 | |-| CUSTOM | 2 | |+| BUILT_IN | 1 | System-defined role that cannot be modified. |+| CUSTOM | 2 | User-defined role that can be modified. |@@ -9842,15 +9842,15 @@ When paginating, all other parameters provided to `ListRoles` must match the cal<a name="bytebase-v1-RoleService"></a>### RoleService-+RoleService manages workspace roles and permissions.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| ListRoles | [ListRolesRequest](#bytebase-v1-ListRolesRequest) | [ListRolesResponse](#bytebase-v1-ListRolesResponse) | Permissions required: bb.roles.list |-| GetRole | [GetRoleRequest](#bytebase-v1-GetRoleRequest) | [Role](#bytebase-v1-Role) | Permissions required: bb.roles.get |-| CreateRole | [CreateRoleRequest](#bytebase-v1-CreateRoleRequest) | [Role](#bytebase-v1-Role) | Permissions required: bb.roles.create |-| UpdateRole | [UpdateRoleRequest](#bytebase-v1-UpdateRoleRequest) | [Role](#bytebase-v1-Role) | Permissions required: bb.roles.update |-| DeleteRole | [DeleteRoleRequest](#bytebase-v1-DeleteRoleRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Permissions required: bb.roles.delete |+| ListRoles | [ListRolesRequest](#bytebase-v1-ListRolesRequest) | [ListRolesResponse](#bytebase-v1-ListRolesResponse) | Lists roles in the workspace. Permissions required: bb.roles.list |+| GetRole | [GetRoleRequest](#bytebase-v1-GetRoleRequest) | [Role](#bytebase-v1-Role) | Retrieves a role by name. Permissions required: bb.roles.get |+| CreateRole | [CreateRoleRequest](#bytebase-v1-CreateRoleRequest) | [Role](#bytebase-v1-Role) | Creates a new custom role. Permissions required: bb.roles.create |+| UpdateRole | [UpdateRoleRequest](#bytebase-v1-UpdateRoleRequest) | [Role](#bytebase-v1-Role) | Updates a role's properties. Permissions required: bb.roles.update |+| DeleteRole | [DeleteRoleRequest](#bytebase-v1-DeleteRoleRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a custom role. Permissions required: bb.roles.delete |@@ -9873,7 +9873,7 @@ When paginating, all other parameters provided to `ListRoles` must match the cal| ----- | ---- | ----- | ----------- || parent | [string](#string) | | The name of the parent of the taskRuns. Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task} Use `projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/-` to cancel task runs under the same stage. || task_runs | [string](#string) | repeated | The taskRuns to cancel. Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |-| reason | [string](#string) | | |+| reason | [string](#string) | | The reason for canceling the task runs. |@@ -9900,7 +9900,7 @@ When paginating, all other parameters provided to `ListRoles` must match the cal| ----- | ---- | ----- | ----------- || parent | [string](#string) | | The name of the parent of the tasks. Format: projects/{project}/rollouts/{rollout}/stages/{stage} || tasks | [string](#string) | repeated | The tasks to run. Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task} |-| reason | [string](#string) | | |+| reason | [string](#string) | | The reason for running the tasks. || run_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | The task run should run after run_time. |@@ -9928,7 +9928,7 @@ When paginating, all other parameters provided to `ListRoles` must match the cal| ----- | ---- | ----- | ----------- || parent | [string](#string) | | The name of the parent of the tasks. Format: projects/{project}/rollouts/{rollout}/stages/{stage} || tasks | [string](#string) | repeated | The tasks to skip. Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task} |-| reason | [string](#string) | | |+| reason | [string](#string) | | The reason for skipping the tasks. |@@ -10072,8 +10072,8 @@ For example: creator == "users/[email protected]" && update_time &| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || parent | [string](#string) | | The parent, which owns this collection of plans. Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task} Use "projects/{project}/rollouts/{rollout}/stages/-/tasks/-" to list all taskRuns from a rollout. |-| page_size | [int32](#int32) | | Not used. The maximum number of taskRuns to return. The service may return fewer than this value. If unspecified, at most 10 taskRuns will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |-| page_token | [string](#string) | | Not used. A page token, received from a previous `ListTaskRuns` 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 taskRuns to return. The service may return fewer than this value. If unspecified, at most 10 taskRuns 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 `ListTaskRuns` call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `ListTaskRuns` must match the call that provided the page token. |@@ -10137,7 +10137,7 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| statement | [string](#string) | | |+| statement | [string](#string) | | The rollback SQL statement that would undo the task run. |@@ -10177,7 +10177,7 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the| 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. || 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 | |+| tasks | [Task](#bytebase-v1-Task) | repeated | The tasks within this stage. |@@ -10195,7 +10195,7 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the| name | [string](#string) | | Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task} || spec_id | [string](#string) | | A UUID4 string that uniquely identifies the Spec. Could be empty if the rollout of the task does not have an associating plan. || status | [Task.Status](#bytebase-v1-Task-Status) | | Status is the status of the task. |-| skipped_reason | [string](#string) | | |+| skipped_reason | [string](#string) | | The reason why the task was skipped. || type | [Task.Type](#bytebase-v1-Task-Type) | | || target | [string](#string) | | Format: instances/{instance} if the task is DatabaseCreate. Format: instances/{instance}/databases/{database} || database_create | [Task.DatabaseCreate](#bytebase-v1-Task-DatabaseCreate) | | |@@ -10212,7 +10212,7 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the<a name="bytebase-v1-Task-DatabaseCreate"></a>### Task.DatabaseCreate-+Payload for creating a new database.| Field | Type | Label | Description |@@ -10221,9 +10221,9 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the| database | [string](#string) | | database name || table | [string](#string) | | table name || sheet | [string](#string) | | Format: projects/{project}/sheets/{sheet} |-| character_set | [string](#string) | | |-| collation | [string](#string) | | |-| environment | [string](#string) | | |+| character_set | [string](#string) | | The character set for the database. |+| collation | [string](#string) | | The collation for the database. |+| environment | [string](#string) | | The environment the database belongs to. |@@ -10233,7 +10233,7 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the<a name="bytebase-v1-Task-DatabaseDataExport"></a>### Task.DatabaseDataExport-+Payload for exporting database data.| Field | Type | Label | Description |@@ -10241,7 +10241,7 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the| target | [string](#string) | | The resource name of the target. Format: instances/{instance-id}/databases/{database-name} || sheet | [string](#string) | | The resource name of the sheet. Format: projects/{project}/sheets/{sheet} || format | [ExportFormat](#bytebase-v1-ExportFormat) | | The format of the exported file. |-| password | [string](#string) | optional | The zip password provide by users. Leave it empty if no needs to encrypt the zip file. |+| password | [string](#string) | optional | The zip password provided by users. Leave it empty if no needs to encrypt the zip file. |@@ -10251,14 +10251,14 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the<a name="bytebase-v1-Task-DatabaseUpdate"></a>### Task.DatabaseUpdate-+Payload for updating a database schema.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || sheet | [string](#string) | | Format: projects/{project}/sheets/{sheet} |-| schema_version | [string](#string) | | |-| database_change_type | [DatabaseChangeType](#bytebase-v1-DatabaseChangeType) | | |+| schema_version | [string](#string) | | The target schema version after this update. |+| database_change_type | [DatabaseChangeType](#bytebase-v1-DatabaseChangeType) | | The type of database change (MIGRATE or SDL). || migration_type | [MigrationType](#bytebase-v1-MigrationType) | | migration_type is only set when database_change_type is MIGRATE. |@@ -10275,17 +10275,17 @@ 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}/tasks/{task}/taskRuns/{taskRun} |-| creator | [string](#string) | | Format: user/[email protected] |+| creator | [string](#string) | | Format: users/[email protected] || create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | || update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |-| status | [TaskRun.Status](#bytebase-v1-TaskRun-Status) | | |-| detail | [string](#string) | | Below are the results of a task run. |+| status | [TaskRun.Status](#bytebase-v1-TaskRun-Status) | | The current execution status of the task run. |+| detail | [string](#string) | | Below are the results of a task run. Detailed information about the task run result. || changelog | [string](#string) | | The resource name of the changelog. Format: instances/{instance}/databases/{database}/changelogs/{changelog} |-| schema_version | [string](#string) | | |-| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |-| export_archive_status | [TaskRun.ExportArchiveStatus](#bytebase-v1-TaskRun-ExportArchiveStatus) | | |+| schema_version | [string](#string) | | The schema version after this task run completes. |+| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The time when the task run started execution. |+| export_archive_status | [TaskRun.ExportArchiveStatus](#bytebase-v1-TaskRun-ExportArchiveStatus) | | The export archive status for data export tasks. || prior_backup_detail | [TaskRun.PriorBackupDetail](#bytebase-v1-TaskRun-PriorBackupDetail) | | The prior backup detail that will be used to rollback the task run. |-| scheduler_info | [TaskRun.SchedulerInfo](#bytebase-v1-TaskRun-SchedulerInfo) | | |+| scheduler_info | [TaskRun.SchedulerInfo](#bytebase-v1-TaskRun-SchedulerInfo) | | Scheduling information about the task run. || sheet | [string](#string) | | Format: projects/{project}/sheets/{sheet} || run_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | The task run should run after run_time. This can only be set when creating the task run calling BatchRunTasks. |@@ -10297,12 +10297,12 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the<a name="bytebase-v1-TaskRun-PriorBackupDetail"></a>### TaskRun.PriorBackupDetail-+Prior backup detail for rollback purposes.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| items | [TaskRun.PriorBackupDetail.Item](#bytebase-v1-TaskRun-PriorBackupDetail-Item) | repeated | |+| items | [TaskRun.PriorBackupDetail.Item](#bytebase-v1-TaskRun-PriorBackupDetail-Item) | repeated | The list of backed up tables. |@@ -10312,15 +10312,15 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the<a name="bytebase-v1-TaskRun-PriorBackupDetail-Item"></a>### TaskRun.PriorBackupDetail.Item-+A single backup table mapping.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || source_table | [TaskRun.PriorBackupDetail.Item.Table](#bytebase-v1-TaskRun-PriorBackupDetail-Item-Table) | | The original table information. || target_table | [TaskRun.PriorBackupDetail.Item.Table](#bytebase-v1-TaskRun-PriorBackupDetail-Item-Table) | | The target backup table information. |-| start_position | [Position](#bytebase-v1-Position) | | |-| end_position | [Position](#bytebase-v1-Position) | | |+| start_position | [Position](#bytebase-v1-Position) | | The start position in the SQL statement. |+| end_position | [Position](#bytebase-v1-Position) | | The end position in the SQL statement. |@@ -10330,14 +10330,14 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the<a name="bytebase-v1-TaskRun-PriorBackupDetail-Item-Table"></a>### TaskRun.PriorBackupDetail.Item.Table-+Table information.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || database | [string](#string) | | The database information. Format: instances/{instance}/databases/{database} |-| schema | [string](#string) | | |-| table | [string](#string) | | |+| schema | [string](#string) | | The schema name. |+| table | [string](#string) | | The table name. |@@ -10347,13 +10347,13 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the<a name="bytebase-v1-TaskRun-SchedulerInfo"></a>### TaskRun.SchedulerInfo-+Information about task run scheduling.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| report_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |-| waiting_cause | [TaskRun.SchedulerInfo.WaitingCause](#bytebase-v1-TaskRun-SchedulerInfo-WaitingCause) | | |+| report_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The time when the scheduling info was reported. |+| waiting_cause | [TaskRun.SchedulerInfo.WaitingCause](#bytebase-v1-TaskRun-SchedulerInfo-WaitingCause) | | The cause for the task run waiting. |@@ -10363,14 +10363,14 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the<a name="bytebase-v1-TaskRun-SchedulerInfo-WaitingCause"></a>### TaskRun.SchedulerInfo.WaitingCause-+Information about why a task run is waiting.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| connection_limit | [bool](#bool) | | |-| task | [TaskRun.SchedulerInfo.WaitingCause.Task](#bytebase-v1-TaskRun-SchedulerInfo-WaitingCause-Task) | | |-| parallel_tasks_limit | [bool](#bool) | | |+| connection_limit | [bool](#bool) | | Waiting due to connection limit reached. |+| task | [TaskRun.SchedulerInfo.WaitingCause.Task](#bytebase-v1-TaskRun-SchedulerInfo-WaitingCause-Task) | | Waiting for another task to complete. |+| parallel_tasks_limit | [bool](#bool) | | Waiting due to parallel tasks limit. |@@ -10380,7 +10380,7 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the<a name="bytebase-v1-TaskRun-SchedulerInfo-WaitingCause-Task"></a>### TaskRun.SchedulerInfo.WaitingCause.Task-+Information about a blocking task.| Field | Type | Label | Description |@@ -10402,7 +10402,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}/tasks/{task}/taskRuns/{taskRun}/log |-| entries | [TaskRunLogEntry](#bytebase-v1-TaskRunLogEntry) | repeated | |+| entries | [TaskRunLogEntry](#bytebase-v1-TaskRunLogEntry) | repeated | The log entries for this task run. |@@ -10417,17 +10417,17 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| type | [TaskRunLogEntry.Type](#bytebase-v1-TaskRunLogEntry-Type) | | |-| log_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |-| deploy_id | [string](#string) | | |-| schema_dump | [TaskRunLogEntry.SchemaDump](#bytebase-v1-TaskRunLogEntry-SchemaDump) | | |-| command_execute | [TaskRunLogEntry.CommandExecute](#bytebase-v1-TaskRunLogEntry-CommandExecute) | | |-| database_sync | [TaskRunLogEntry.DatabaseSync](#bytebase-v1-TaskRunLogEntry-DatabaseSync) | | |-| task_run_status_update | [TaskRunLogEntry.TaskRunStatusUpdate](#bytebase-v1-TaskRunLogEntry-TaskRunStatusUpdate) | | |-| transaction_control | [TaskRunLogEntry.TransactionControl](#bytebase-v1-TaskRunLogEntry-TransactionControl) | | |-| prior_backup | [TaskRunLogEntry.PriorBackup](#bytebase-v1-TaskRunLogEntry-PriorBackup) | | |-| retry_info | [TaskRunLogEntry.RetryInfo](#bytebase-v1-TaskRunLogEntry-RetryInfo) | | |-| compute_diff | [TaskRunLogEntry.ComputeDiff](#bytebase-v1-TaskRunLogEntry-ComputeDiff) | | |+| type | [TaskRunLogEntry.Type](#bytebase-v1-TaskRunLogEntry-Type) | | The type of this log entry. |+| log_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The time when the log was recorded. |+| deploy_id | [string](#string) | | The deployment ID for this log entry. |+| schema_dump | [TaskRunLogEntry.SchemaDump](#bytebase-v1-TaskRunLogEntry-SchemaDump) | | Schema dump details (if type is SCHEMA_DUMP). |+| command_execute | [TaskRunLogEntry.CommandExecute](#bytebase-v1-TaskRunLogEntry-CommandExecute) | | Command execution details (if type is COMMAND_EXECUTE). |+| database_sync | [TaskRunLogEntry.DatabaseSync](#bytebase-v1-TaskRunLogEntry-DatabaseSync) | | Database sync details (if type is DATABASE_SYNC). |+| task_run_status_update | [TaskRunLogEntry.TaskRunStatusUpdate](#bytebase-v1-TaskRunLogEntry-TaskRunStatusUpdate) | | Task run status update details (if type is TASK_RUN_STATUS_UPDATE). |+| transaction_control | [TaskRunLogEntry.TransactionControl](#bytebase-v1-TaskRunLogEntry-TransactionControl) | | Transaction control details (if type is TRANSACTION_CONTROL). |+| prior_backup | [TaskRunLogEntry.PriorBackup](#bytebase-v1-TaskRunLogEntry-PriorBackup) | | Prior backup details (if type is PRIOR_BACKUP). |+| retry_info | [TaskRunLogEntry.RetryInfo](#bytebase-v1-TaskRunLogEntry-RetryInfo) | | Retry information details (if type is RETRY_INFO). |+| compute_diff | [TaskRunLogEntry.ComputeDiff](#bytebase-v1-TaskRunLogEntry-ComputeDiff) | | Compute diff details (if type is COMPUTE_DIFF). |@@ -10437,15 +10437,15 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the<a name="bytebase-v1-TaskRunLogEntry-CommandExecute"></a>### TaskRunLogEntry.CommandExecute-+Command execution details.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| log_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |+| log_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the command was logged. || command_indexes | [int32](#int32) | repeated | Either `command_indexes` or `statement` is set. The indexes of the executed commands. || statement | [string](#string) | | The executed statement. |-| response | [TaskRunLogEntry.CommandExecute.CommandResponse](#bytebase-v1-TaskRunLogEntry-CommandExecute-CommandResponse) | | |+| response | [TaskRunLogEntry.CommandExecute.CommandResponse](#bytebase-v1-TaskRunLogEntry-CommandExecute-CommandResponse) | | The response from executing the command. |@@ -10455,14 +10455,14 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the<a name="bytebase-v1-TaskRunLogEntry-CommandExecute-CommandResponse"></a>### TaskRunLogEntry.CommandExecute.CommandResponse-+Command execution response.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| log_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |-| error | [string](#string) | | |-| affected_rows | [int64](#int64) | | |+| log_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the response was logged. |+| error | [string](#string) | | Error message if command execution failed. |+| affected_rows | [int64](#int64) | | Total affected rows. || all_affected_rows | [int64](#int64) | repeated | `all_affected_rows` is the affected rows of each command. `all_affected_rows` may be unavailable if the database driver doesn't support it. Caller should fallback to `affected_rows` in that case. |@@ -10473,14 +10473,14 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the<a name="bytebase-v1-TaskRunLogEntry-ComputeDiff"></a>### TaskRunLogEntry.ComputeDiff-+Schema diff computation details.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |-| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |-| error | [string](#string) | | |+| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When diff computation started. |+| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When diff computation ended. |+| error | [string](#string) | | Error message if computation failed. |@@ -10490,14 +10490,14 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the<a name="bytebase-v1-TaskRunLogEntry-DatabaseSync"></a>### TaskRunLogEntry.DatabaseSync-+Database synchronization details.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |-| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |-| error | [string](#string) | | |+| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the database sync started. |+| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the database sync ended. |+| error | [string](#string) | | Error message if sync failed. |@@ -10507,15 +10507,15 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the<a name="bytebase-v1-TaskRunLogEntry-PriorBackup"></a>### TaskRunLogEntry.PriorBackup-+Prior backup operation details.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |-| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |-| prior_backup_detail | [TaskRun.PriorBackupDetail](#bytebase-v1-TaskRun-PriorBackupDetail) | | |-| error | [string](#string) | | |+| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the backup started. |+| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the backup ended. |+| prior_backup_detail | [TaskRun.PriorBackupDetail](#bytebase-v1-TaskRun-PriorBackupDetail) | | The backup details. |+| error | [string](#string) | | Error message if the backup failed. |@@ -10525,14 +10525,14 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the<a name="bytebase-v1-TaskRunLogEntry-RetryInfo"></a>### TaskRunLogEntry.RetryInfo-+Retry information for failed operations.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| error | [string](#string) | | |-| retry_count | [int32](#int32) | | |-| maximum_retries | [int32](#int32) | | |+| error | [string](#string) | | The error that triggered the retry. |+| retry_count | [int32](#int32) | | Current retry attempt number. |+| maximum_retries | [int32](#int32) | | Maximum number of retries allowed. |@@ -10542,14 +10542,14 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the<a name="bytebase-v1-TaskRunLogEntry-SchemaDump"></a>### TaskRunLogEntry.SchemaDump-+Schema dump operation details.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |-| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |-| error | [string](#string) | | |+| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the schema dump started. |+| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the schema dump ended. |+| error | [string](#string) | | Error message if the schema dump failed. |@@ -10559,12 +10559,12 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the<a name="bytebase-v1-TaskRunLogEntry-TaskRunStatusUpdate"></a>### TaskRunLogEntry.TaskRunStatusUpdate-+Task run status update details.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| status | [TaskRunLogEntry.TaskRunStatusUpdate.Status](#bytebase-v1-TaskRunLogEntry-TaskRunStatusUpdate-Status) | | |+| status | [TaskRunLogEntry.TaskRunStatusUpdate.Status](#bytebase-v1-TaskRunLogEntry-TaskRunStatusUpdate-Status) | | The new status. |@@ -10574,13 +10574,13 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the<a name="bytebase-v1-TaskRunLogEntry-TransactionControl"></a>### TaskRunLogEntry.TransactionControl-+Transaction control operation details.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| type | [TaskRunLogEntry.TransactionControl.Type](#bytebase-v1-TaskRunLogEntry-TransactionControl-Type) | | |-| error | [string](#string) | | |+| type | [TaskRunLogEntry.TransactionControl.Type](#bytebase-v1-TaskRunLogEntry-TransactionControl-Type) | | The type of transaction control. |+| error | [string](#string) | | Error message if the operation failed. |@@ -10596,7 +10596,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}/tasks/{task}/taskRuns/{taskRun}/session |-| postgres | [TaskRunSession.Postgres](#bytebase-v1-TaskRunSession-Postgres) | | |+| postgres | [TaskRunSession.Postgres](#bytebase-v1-TaskRunSession-Postgres) | | PostgreSQL session information. |@@ -10606,7 +10606,7 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the<a name="bytebase-v1-TaskRunSession-Postgres"></a>### TaskRunSession.Postgres-+PostgreSQL session information.| Field | Type | Label | Description |@@ -10623,25 +10623,25 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the<a name="bytebase-v1-TaskRunSession-Postgres-Session"></a>### TaskRunSession.Postgres.Session-Read from `pg_stat_activity`+PostgreSQL session information read from `pg_stat_activity`.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| pid | [string](#string) | | |-| blocked_by_pids | [string](#string) | repeated | |-| query | [string](#string) | | |-| state | [string](#string) | optional | |-| wait_event_type | [string](#string) | optional | |-| wait_event | [string](#string) | optional | |-| datname | [string](#string) | optional | |-| usename | [string](#string) | optional | |-| application_name | [string](#string) | | |-| client_addr | [string](#string) | optional | |-| client_port | [string](#string) | optional | |-| backend_start | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |-| xact_start | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | |-| query_start | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | |+| pid | [string](#string) | | Process ID of the session. |+| blocked_by_pids | [string](#string) | repeated | PIDs of sessions blocking this session. |+| query | [string](#string) | | Current query being executed. |+| state | [string](#string) | optional | Session state (active, idle, etc.). |+| wait_event_type | [string](#string) | optional | Wait event type if session is waiting. |+| wait_event | [string](#string) | optional | Specific wait event if session is waiting. |+| datname | [string](#string) | optional | Database name. |+| usename | [string](#string) | optional | User name. |+| application_name | [string](#string) | | Application name. |+| client_addr | [string](#string) | optional | Client IP address. |+| client_port | [string](#string) | optional | Client port number. |+| backend_start | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the backend process started. |+| xact_start | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | When the current transaction started. |+| query_start | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | When the current query started. |@@ -10657,14 +10657,14 @@ Read from `pg_stat_activity`| Name | Number | Description || ---- | ------ | ----------- |-| STATUS_UNSPECIFIED | 0 | |-| NOT_STARTED | 1 | |-| PENDING | 2 | |-| RUNNING | 3 | |-| DONE | 4 | |-| FAILED | 5 | |-| CANCELED | 6 | |-| SKIPPED | 7 | |+| STATUS_UNSPECIFIED | 0 | Unspecified status. |+| NOT_STARTED | 1 | Task has not started and is awaiting its turn in the deployment sequence. |+| PENDING | 2 | Task is ready to run and waiting for approval or scheduled time. |+| RUNNING | 3 | Task is currently executing. |+| DONE | 4 | Task completed successfully. |+| FAILED | 5 | Task execution failed with errors. |+| CANCELED | 6 | Task execution was canceled by a user. |+| SKIPPED | 7 | Task was skipped and will not be executed. |@@ -10675,12 +10675,12 @@ Read from `pg_stat_activity`| Name | Number | Description || ---- | ------ | ----------- |-| TYPE_UNSPECIFIED | 0 | |-| GENERAL | 1 | |-| DATABASE_CREATE | 2 | use payload DatabaseCreate |-| DATABASE_MIGRATE | 3 | use payload DatabaseUpdate |-| DATABASE_SDL | 6 | use payload DatabaseUpdate |-| DATABASE_EXPORT | 5 | use payload DatabaseDataExport |+| TYPE_UNSPECIFIED | 0 | Unspecified task type. |+| GENERAL | 1 | General task for miscellaneous operations. |+| DATABASE_CREATE | 2 | Database creation task that creates a new database. Use payload DatabaseCreate. |+| DATABASE_MIGRATE | 3 | Database migration task that applies versioned schema changes. Use payload DatabaseUpdate. |+| DATABASE_SDL | 6 | Database SDL (Schema Definition Language) task that synchronizes declarative schema. Use payload DatabaseUpdate. |+| DATABASE_EXPORT | 5 | Database export task that exports query results or table data. Use payload DatabaseDataExport. |@@ -10691,9 +10691,9 @@ Read from `pg_stat_activity`| Name | Number | Description || ---- | ------ | ----------- |-| EXPORT_ARCHIVE_STATUS_UNSPECIFIED | 0 | |-| READY | 1 | |-| EXPORTED | 2 | |+| EXPORT_ARCHIVE_STATUS_UNSPECIFIED | 0 | Unspecified export archive status. |+| READY | 1 | Export archive is ready for download. |+| EXPORTED | 2 | Export archive has been downloaded by the user. |@@ -10704,23 +10704,23 @@ Read from `pg_stat_activity`| Name | Number | Description || ---- | ------ | ----------- |-| STATUS_UNSPECIFIED | 0 | |-| PENDING | 1 | |-| RUNNING | 2 | |-| DONE | 3 | |-| FAILED | 4 | |-| CANCELED | 5 | |+| STATUS_UNSPECIFIED | 0 | Unspecified status. |+| PENDING | 1 | Task run is queued and waiting to start execution. |+| RUNNING | 2 | Task run is currently executing. |+| DONE | 3 | Task run completed successfully. |+| FAILED | 4 | Task run execution failed with errors. |+| CANCELED | 5 | Task run execution was canceled by a user. |<a name="bytebase-v1-TaskRunLogEntry-TaskRunStatusUpdate-Status"></a>### TaskRunLogEntry.TaskRunStatusUpdate.Status-+Internal status for task run execution.| Name | Number | Description || ---- | ------ | ----------- |-| STATUS_UNSPECIFIED | 0 | |+| 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 |@@ -10729,33 +10729,33 @@ Read from `pg_stat_activity`<a name="bytebase-v1-TaskRunLogEntry-TransactionControl-Type"></a>### TaskRunLogEntry.TransactionControl.Type-+Transaction control type.| Name | Number | Description || ---- | ------ | ----------- |-| TYPE_UNSPECIFIED | 0 | |-| BEGIN | 1 | |-| COMMIT | 2 | |-| ROLLBACK | 3 | |+| TYPE_UNSPECIFIED | 0 | Unspecified type. |+| BEGIN | 1 | Begin transaction. |+| COMMIT | 2 | Commit transaction. |+| ROLLBACK | 3 | Rollback transaction. |<a name="bytebase-v1-TaskRunLogEntry-Type"></a>### TaskRunLogEntry.Type-+The type of log entry.| Name | Number | Description || ---- | ------ | ----------- |-| TYPE_UNSPECIFIED | 0 | |-| SCHEMA_DUMP | 1 | |-| COMMAND_EXECUTE | 2 | |-| DATABASE_SYNC | 3 | |-| TASK_RUN_STATUS_UPDATE | 4 | |-| TRANSACTION_CONTROL | 5 | |-| PRIOR_BACKUP | 6 | |-| RETRY_INFO | 7 | |-| COMPUTE_DIFF | 8 | |+| TYPE_UNSPECIFIED | 0 | Unspecified type. |+| SCHEMA_DUMP | 1 | Schema dump operation. |+| COMMAND_EXECUTE | 2 | Command execution. |+| DATABASE_SYNC | 3 | Database synchronization. |+| TASK_RUN_STATUS_UPDATE | 4 | Task run status update. |+| TRANSACTION_CONTROL | 5 | Transaction control (BEGIN, COMMIT, ROLLBACK). |+| PRIOR_BACKUP | 6 | Prior backup operation. |+| RETRY_INFO | 7 | Retry information. |+| COMPUTE_DIFF | 8 | Schema diff computation. |@@ -10766,22 +10766,22 @@ Read from `pg_stat_activity`<a name="bytebase-v1-RolloutService"></a>### RolloutService-+RolloutService manages the execution of deployment plans.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| GetRollout | [GetRolloutRequest](#bytebase-v1-GetRolloutRequest) | [Rollout](#bytebase-v1-Rollout) | Permissions required: bb.rollouts.get |-| ListRollouts | [ListRolloutsRequest](#bytebase-v1-ListRolloutsRequest) | [ListRolloutsResponse](#bytebase-v1-ListRolloutsResponse) | Permissions required: bb.rollouts.list |-| CreateRollout | [CreateRolloutRequest](#bytebase-v1-CreateRolloutRequest) | [Rollout](#bytebase-v1-Rollout) | Permissions required: bb.rollouts.create |-| PreviewRollout | [PreviewRolloutRequest](#bytebase-v1-PreviewRolloutRequest) | [Rollout](#bytebase-v1-Rollout) | Permissions required: bb.rollouts.preview |-| ListTaskRuns | [ListTaskRunsRequest](#bytebase-v1-ListTaskRunsRequest) | [ListTaskRunsResponse](#bytebase-v1-ListTaskRunsResponse) | Permissions required: bb.taskRuns.list |-| GetTaskRun | [GetTaskRunRequest](#bytebase-v1-GetTaskRunRequest) | [TaskRun](#bytebase-v1-TaskRun) | Permissions required: bb.taskRuns.list |-| GetTaskRunLog | [GetTaskRunLogRequest](#bytebase-v1-GetTaskRunLogRequest) | [TaskRunLog](#bytebase-v1-TaskRunLog) | Permissions required: bb.taskRuns.list |-| GetTaskRunSession | [GetTaskRunSessionRequest](#bytebase-v1-GetTaskRunSessionRequest) | [TaskRunSession](#bytebase-v1-TaskRunSession) | Permissions required: bb.taskRuns.list |-| BatchRunTasks | [BatchRunTasksRequest](#bytebase-v1-BatchRunTasksRequest) | [BatchRunTasksResponse](#bytebase-v1-BatchRunTasksResponse) | Permissions required: None |-| BatchSkipTasks | [BatchSkipTasksRequest](#bytebase-v1-BatchSkipTasksRequest) | [BatchSkipTasksResponse](#bytebase-v1-BatchSkipTasksResponse) | Permissions required: None |-| BatchCancelTaskRuns | [BatchCancelTaskRunsRequest](#bytebase-v1-BatchCancelTaskRunsRequest) | [BatchCancelTaskRunsResponse](#bytebase-v1-BatchCancelTaskRunsResponse) | Permissions required: None |-| PreviewTaskRunRollback | [PreviewTaskRunRollbackRequest](#bytebase-v1-PreviewTaskRunRollbackRequest) | [PreviewTaskRunRollbackResponse](#bytebase-v1-PreviewTaskRunRollbackResponse) | Permissions required: bb.taskRuns.list |+| GetRollout | [GetRolloutRequest](#bytebase-v1-GetRolloutRequest) | [Rollout](#bytebase-v1-Rollout) | Retrieves a rollout by name. Permissions required: bb.rollouts.get |+| ListRollouts | [ListRolloutsRequest](#bytebase-v1-ListRolloutsRequest) | [ListRolloutsResponse](#bytebase-v1-ListRolloutsResponse) | Lists rollouts in a project. Permissions required: bb.rollouts.list |+| CreateRollout | [CreateRolloutRequest](#bytebase-v1-CreateRolloutRequest) | [Rollout](#bytebase-v1-Rollout) | Creates a new rollout from a plan. Permissions required: bb.rollouts.create |+| PreviewRollout | [PreviewRolloutRequest](#bytebase-v1-PreviewRolloutRequest) | [Rollout](#bytebase-v1-Rollout) | Previews the rollout that would be created from a plan. Permissions required: bb.rollouts.preview |+| ListTaskRuns | [ListTaskRunsRequest](#bytebase-v1-ListTaskRunsRequest) | [ListTaskRunsResponse](#bytebase-v1-ListTaskRunsResponse) | Lists task run executions for a task. Permissions required: bb.taskRuns.list |+| GetTaskRun | [GetTaskRunRequest](#bytebase-v1-GetTaskRunRequest) | [TaskRun](#bytebase-v1-TaskRun) | Retrieves a task run by name. Permissions required: bb.taskRuns.list |+| GetTaskRunLog | [GetTaskRunLogRequest](#bytebase-v1-GetTaskRunLogRequest) | [TaskRunLog](#bytebase-v1-TaskRunLog) | Retrieves execution logs for a task run. Permissions required: bb.taskRuns.list |+| GetTaskRunSession | [GetTaskRunSessionRequest](#bytebase-v1-GetTaskRunSessionRequest) | [TaskRunSession](#bytebase-v1-TaskRunSession) | Retrieves database session information for a running task. Permissions required: bb.taskRuns.list |+| BatchRunTasks | [BatchRunTasksRequest](#bytebase-v1-BatchRunTasksRequest) | [BatchRunTasksResponse](#bytebase-v1-BatchRunTasksResponse) | Executes multiple tasks in a rollout stage. Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment) |+| BatchSkipTasks | [BatchSkipTasksRequest](#bytebase-v1-BatchSkipTasksRequest) | [BatchSkipTasksResponse](#bytebase-v1-BatchSkipTasksResponse) | Skips multiple tasks in a rollout stage. Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment) |+| BatchCancelTaskRuns | [BatchCancelTaskRunsRequest](#bytebase-v1-BatchCancelTaskRunsRequest) | [BatchCancelTaskRunsResponse](#bytebase-v1-BatchCancelTaskRunsResponse) | Cancels multiple running task executions. Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment) |+| PreviewTaskRunRollback | [PreviewTaskRunRollbackRequest](#bytebase-v1-PreviewTaskRunRollbackRequest) | [PreviewTaskRunRollbackResponse](#bytebase-v1-PreviewTaskRunRollbackResponse) | Generates rollback SQL for a completed task run. Permissions required: bb.taskRuns.list |@@ -10865,13 +10865,13 @@ Read from `pg_stat_activity`| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the sheet resource, generated by the server. Canonical parent is project. Format: projects/{project}/sheets/{sheet} |+| name | [string](#string) | | The name of the sheet resource. Format: projects/{project}/sheets/{sheet} The sheet ID is generated by the server on creation and cannot be changed. || title | [string](#string) | | The title of the sheet. || creator | [string](#string) | | The creator of the Sheet. Format: users/{email} || create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The create time of the sheet. || content | [bytes](#bytes) | | The content of the sheet. By default, it will be cut off, if it doesn't match the `content_size`, you can set the `raw` to true in GetSheet request to retrieve the full content. || content_size | [int64](#int64) | | content_size is the full size of the content, may not match the size of the `content` field. |-| payload | [SheetPayload](#bytebase-v1-SheetPayload) | | |+| payload | [SheetPayload](#bytebase-v1-SheetPayload) | | Additional metadata and configuration for the sheet. || engine | [Engine](#bytebase-v1-Engine) | | The SQL dialect. |@@ -10951,14 +10951,14 @@ Type of the SheetPayload.<a name="bytebase-v1-SheetService"></a>### SheetService-+SheetService manages SQL scripts and saved queries.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| CreateSheet | [CreateSheetRequest](#bytebase-v1-CreateSheetRequest) | [Sheet](#bytebase-v1-Sheet) | Permissions required: bb.sheets.create |-| BatchCreateSheets | [BatchCreateSheetsRequest](#bytebase-v1-BatchCreateSheetsRequest) | [BatchCreateSheetsResponse](#bytebase-v1-BatchCreateSheetsResponse) | Permissions required: bb.sheets.create |-| GetSheet | [GetSheetRequest](#bytebase-v1-GetSheetRequest) | [Sheet](#bytebase-v1-Sheet) | Permissions required: bb.sheets.get |-| UpdateSheet | [UpdateSheetRequest](#bytebase-v1-UpdateSheetRequest) | [Sheet](#bytebase-v1-Sheet) | Permissions required: bb.sheets.update |+| CreateSheet | [CreateSheetRequest](#bytebase-v1-CreateSheetRequest) | [Sheet](#bytebase-v1-Sheet) | Creates a new SQL sheet. Permissions required: bb.sheets.create |+| BatchCreateSheets | [BatchCreateSheetsRequest](#bytebase-v1-BatchCreateSheetsRequest) | [BatchCreateSheetsResponse](#bytebase-v1-BatchCreateSheetsResponse) | Creates multiple SQL sheets in a single operation. Permissions required: bb.sheets.create |+| GetSheet | [GetSheetRequest](#bytebase-v1-GetSheetRequest) | [Sheet](#bytebase-v1-Sheet) | Retrieves a SQL sheet by name. Permissions required: bb.sheets.get |+| UpdateSheet | [UpdateSheetRequest](#bytebase-v1-UpdateSheetRequest) | [Sheet](#bytebase-v1-Sheet) | Updates a SQL sheet's title or content. Permissions required: bb.sheets.update |@@ -11144,10 +11144,10 @@ PlanFeature represents the available features in Bytebase| Name | Number | Description || ---- | ------ | ----------- |-| PLAN_TYPE_UNSPECIFIED | 0 | |-| FREE | 1 | |-| TEAM | 2 | |-| ENTERPRISE | 3 | |+| PLAN_TYPE_UNSPECIFIED | 0 | Unspecified plan type. |+| FREE | 1 | Free plan with basic features and no cost. |+| TEAM | 2 | Team plan with collaboration features for small to medium teams. |+| ENTERPRISE | 3 | Enterprise plan with advanced features and dedicated support. |@@ -11158,12 +11158,12 @@ PlanFeature represents the available features in Bytebase<a name="bytebase-v1-SubscriptionService"></a>### SubscriptionService-+SubscriptionService manages enterprise subscriptions and licensing.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|| GetSubscription | [GetSubscriptionRequest](#bytebase-v1-GetSubscriptionRequest) | [Subscription](#bytebase-v1-Subscription) | GetSubscription returns the current subscription. If there is no license, we will return a free plan subscription without expiration time. If there is expired license, we will return a free plan subscription with the expiration time of the expired license. Permissions required: None |-| UpdateSubscription | [UpdateSubscriptionRequest](#bytebase-v1-UpdateSubscriptionRequest) | [Subscription](#bytebase-v1-Subscription) | Permissions required: bb.settings.set |+| UpdateSubscription | [UpdateSubscriptionRequest](#bytebase-v1-UpdateSubscriptionRequest) | [Subscription](#bytebase-v1-Subscription) | Updates the enterprise license subscription. Permissions required: bb.settings.set |@@ -11234,8 +11234,8 @@ PlanFeature represents the available features in BytebaseSupported filter: - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator. - starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator. - visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.For example: creator == "users/{email}" creator != "users/{email}" starred == true starred == false visibility in ["PRIVATE", "PROJECT_READ", "PROJECT_WRITE"] visibility == "PRIVATE" |-| page_size | [int32](#int32) | | Not used. The maximum number of worksheets to return. The service may return fewer than this value. If unspecified, at most 10 worksheets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |-| page_token | [string](#string) | | Not used. A page token, received from a previous `SearchWorksheets` 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 worksheets to return. The service may return fewer than this value. If unspecified, at most 10 worksheets 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 `SearchWorksheets` call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `SearchWorksheets` must match the call that provided the page token. |@@ -11253,7 +11253,7 @@ When paginating, all other parameters provided to `SearchWorksheets` must match| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || worksheets | [Worksheet](#bytebase-v1-Worksheet) | repeated | The worksheets that matched the search criteria. |-| next_page_token | [string](#string) | | Not used. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |+| next_page_token | [string](#string) | | Pagination is not currently implemented. This field is reserved for future use. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |@@ -11361,16 +11361,16 @@ The worksheet's `name` field is used to identify the worksheet to update. Fo<a name="bytebase-v1-WorksheetService"></a>### WorksheetService-+WorksheetService manages SQL worksheets for query development.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| CreateWorksheet | [CreateWorksheetRequest](#bytebase-v1-CreateWorksheetRequest) | [Worksheet](#bytebase-v1-Worksheet) | Create a personal worksheet used in SQL Editor. Permissions required: None |-| GetWorksheet | [GetWorksheetRequest](#bytebase-v1-GetWorksheetRequest) | [Worksheet](#bytebase-v1-Worksheet) | Get a worksheet by name. The users can access this method if, - they are the creator of the worksheet; - they have bb.worksheets.get permission on the workspace; - the sheet is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project. Permissions required: None |-| SearchWorksheets | [SearchWorksheetsRequest](#bytebase-v1-SearchWorksheetsRequest) | [SearchWorksheetsResponse](#bytebase-v1-SearchWorksheetsResponse) | Search for worksheets. This is used for finding my worksheets or worksheets shared by other people. The sheet accessibility is the same as GetWorksheet(). Permissions required: None |-| UpdateWorksheet | [UpdateWorksheetRequest](#bytebase-v1-UpdateWorksheetRequest) | [Worksheet](#bytebase-v1-Worksheet) | Update a worksheet. The users can access this method if, - they are the creator of the worksheet; - they have bb.worksheets.manage permission on the workspace; - the sheet is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project. Permissions required: None |-| UpdateWorksheetOrganizer | [UpdateWorksheetOrganizerRequest](#bytebase-v1-UpdateWorksheetOrganizerRequest) | [WorksheetOrganizer](#bytebase-v1-WorksheetOrganizer) | Update the organizer of a worksheet. The access is the same as UpdateWorksheet method. Permissions required: None |-| DeleteWorksheet | [DeleteWorksheetRequest](#bytebase-v1-DeleteWorksheetRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Delete a worksheet. The access is the same as UpdateWorksheet method. Permissions required: None |+| CreateWorksheet | [CreateWorksheetRequest](#bytebase-v1-CreateWorksheetRequest) | [Worksheet](#bytebase-v1-Worksheet) | Creates a personal worksheet used in SQL Editor. Any authenticated user can create their own worksheets. Permissions required: None (authenticated users only) |+| GetWorksheet | [GetWorksheetRequest](#bytebase-v1-GetWorksheetRequest) | [Worksheet](#bytebase-v1-Worksheet) | Get a worksheet by name. The users can access this method if, - they are the creator of the worksheet; - they have bb.worksheets.get permission on the workspace; - the sheet is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project. Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets) |+| SearchWorksheets | [SearchWorksheetsRequest](#bytebase-v1-SearchWorksheetsRequest) | [SearchWorksheetsResponse](#bytebase-v1-SearchWorksheetsResponse) | Search for worksheets. This is used for finding my worksheets or worksheets shared by other people. The sheet accessibility is the same as GetWorksheet(). Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets) |+| UpdateWorksheet | [UpdateWorksheetRequest](#bytebase-v1-UpdateWorksheetRequest) | [Worksheet](#bytebase-v1-Worksheet) | Update a worksheet. The users can access this method if, - they are the creator of the worksheet; - they have bb.worksheets.manage permission on the workspace; - the sheet is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project. Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets) |+| UpdateWorksheetOrganizer | [UpdateWorksheetOrganizerRequest](#bytebase-v1-UpdateWorksheetOrganizerRequest) | [WorksheetOrganizer](#bytebase-v1-WorksheetOrganizer) | Update the organizer of a worksheet. The access is the same as UpdateWorksheet method. Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets) |+| DeleteWorksheet | [DeleteWorksheetRequest](#bytebase-v1-DeleteWorksheetRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Delete a worksheet. The access is the same as UpdateWorksheet method. Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets) |@@ -11392,12 +11392,12 @@ The worksheet's `name` field is used to identify the worksheet to update. Fo<a name="bytebase-v1-WorkspaceService"></a>### WorkspaceService-+WorkspaceService manages workspace-level operations and profile.| Method Name | Request Type | Response Type | Description || ----------- | ------------ | ------------- | ------------|-| GetIamPolicy | [GetIamPolicyRequest](#bytebase-v1-GetIamPolicyRequest) | [IamPolicy](#bytebase-v1-IamPolicy) | Permissions required: bb.workspaces.getIamPolicy |-| SetIamPolicy | [SetIamPolicyRequest](#bytebase-v1-SetIamPolicyRequest) | [IamPolicy](#bytebase-v1-IamPolicy) | Permissions required: bb.workspaces.setIamPolicy |+| GetIamPolicy | [GetIamPolicyRequest](#bytebase-v1-GetIamPolicyRequest) | [IamPolicy](#bytebase-v1-IamPolicy) | Retrieves IAM policy for the workspace. Permissions required: bb.workspaces.getIamPolicy |+| SetIamPolicy | [SetIamPolicyRequest](#bytebase-v1-SetIamPolicyRequest) | [IamPolicy](#bytebase-v1-IamPolicy) | Sets IAM policy for the workspace. Permissions required: bb.workspaces.setIamPolicy |diff --git a/proto/gen/grpc-doc/v1/index.html b/proto/gen/grpc-doc/v1/index.htmlindex 250503d4f8..6d594ec272 100644--- a/proto/gen/grpc-doc/v1/index.html+++ b/proto/gen/grpc-doc/v1/index.html@@ -2888,7 +2888,7 @@<h3 id="bytebase.v1.AuthMethod">AuthMethod</h3>- <p></p>+ <p>Authorization method for RPC calls.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -2898,19 +2898,19 @@<tr><td>AUTH_METHOD_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified authorization method.</p></td></tr><tr><td>IAM</td><td>1</td>- <td><p>IAM uses the standard IAM authorization check on the organizational resources.</p></td>+ <td><p>Standard IAM authorization check on organizational resources.</p></td></tr><tr><td>CUSTOM</td><td>2</td>- <td><p>Custom authorization method.</p></td>+ <td><p>Custom authorization logic.</p></td></tr></tbody>@@ -2930,7 +2930,7 @@<td><a href="#bool">bool</a></td><td><a href="#google.protobuf.MethodOptions">.google.protobuf.MethodOptions</a></td><td>100000</td>- <td><p></p></td>+ <td><p>Whether the method allows access without authentication credentials.</p></td></tr><tr>@@ -2938,7 +2938,7 @@<td><a href="#bool">bool</a></td><td><a href="#google.protobuf.MethodOptions">.google.protobuf.MethodOptions</a></td><td>100003</td>- <td><p></p></td>+ <td><p>Whether to audit calls to this method.</p></td></tr><tr>@@ -2946,7 +2946,7 @@<td><a href="#bytebase.v1.AuthMethod">AuthMethod</a></td><td><a href="#google.protobuf.MethodOptions">.google.protobuf.MethodOptions</a></td><td>100002</td>- <td><p></p></td>+ <td><p>The authorization method to use for this RPC.</p></td></tr><tr>@@ -2954,7 +2954,7 @@<td><a href="#string">string</a></td><td><a href="#google.protobuf.MethodOptions">.google.protobuf.MethodOptions</a></td><td>100001</td>- <td><p></p></td>+ <td><p>The permission required to call this method.</p></td></tr></tbody>@@ -3002,7 +3002,7 @@<h3 id="bytebase.v1.Range">Range</h3>- <p></p>+ <p>Range of positions in text or sequence.</p><table class="field-table">@@ -3015,14 +3015,14 @@<td>start</td><td><a href="#int32">int32</a></td><td></td>- <td><p> </p></td>+ <td><p>Start position (inclusive). </p></td></tr><tr><td>end</td><td><a href="#int32">int32</a></td><td></td>- <td><p> </p></td>+ <td><p>End position (exclusive). </p></td></tr></tbody>@@ -3064,7 +3064,7 @@</table><h3 id="bytebase.v1.Engine">Engine</h3>- <p></p>+ <p>Database engine type.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -3074,164 +3074,164 @@<tr><td>ENGINE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified database engine.</p></td></tr><tr><td>CLICKHOUSE</td><td>1</td>- <td><p></p></td>+ <td><p>ClickHouse columnar database.</p></td></tr><tr><td>MYSQL</td><td>2</td>- <td><p></p></td>+ <td><p>MySQL relational database.</p></td></tr><tr><td>POSTGRES</td><td>3</td>- <td><p></p></td>+ <td><p>PostgreSQL relational database.</p></td></tr><tr><td>SNOWFLAKE</td><td>4</td>- <td><p></p></td>+ <td><p>Snowflake cloud data warehouse.</p></td></tr><tr><td>SQLITE</td><td>5</td>- <td><p></p></td>+ <td><p>SQLite embedded database.</p></td></tr><tr><td>TIDB</td><td>6</td>- <td><p></p></td>+ <td><p>TiDB distributed SQL database.</p></td></tr><tr><td>MONGODB</td><td>7</td>- <td><p></p></td>+ <td><p>MongoDB document database.</p></td></tr><tr><td>REDIS</td><td>8</td>- <td><p></p></td>+ <td><p>Redis key-value store.</p></td></tr><tr><td>ORACLE</td><td>9</td>- <td><p></p></td>+ <td><p>Oracle relational database.</p></td></tr><tr><td>SPANNER</td><td>10</td>- <td><p></p></td>+ <td><p>Google Cloud Spanner distributed database.</p></td></tr><tr><td>MSSQL</td><td>11</td>- <td><p></p></td>+ <td><p>Microsoft SQL Server relational database.</p></td></tr><tr><td>REDSHIFT</td><td>12</td>- <td><p></p></td>+ <td><p>Amazon Redshift data warehouse.</p></td></tr><tr><td>MARIADB</td><td>13</td>- <td><p></p></td>+ <td><p>MariaDB relational database.</p></td></tr><tr><td>OCEANBASE</td><td>14</td>- <td><p></p></td>+ <td><p>OceanBase distributed database.</p></td></tr><tr><td>STARROCKS</td><td>18</td>- <td><p></p></td>+ <td><p>StarRocks analytics database.</p></td></tr><tr><td>DORIS</td><td>19</td>- <td><p></p></td>+ <td><p>Apache Doris analytics database.</p></td></tr><tr><td>HIVE</td><td>20</td>- <td><p></p></td>+ <td><p>Apache Hive data warehouse.</p></td></tr><tr><td>ELASTICSEARCH</td><td>21</td>- <td><p></p></td>+ <td><p>Elasticsearch search engine.</p></td></tr><tr><td>BIGQUERY</td><td>22</td>- <td><p></p></td>+ <td><p>Google BigQuery data warehouse.</p></td></tr><tr><td>DYNAMODB</td><td>23</td>- <td><p></p></td>+ <td><p>Amazon DynamoDB NoSQL database.</p></td></tr><tr><td>DATABRICKS</td><td>24</td>- <td><p></p></td>+ <td><p>Databricks lakehouse platform.</p></td></tr><tr><td>COCKROACHDB</td><td>25</td>- <td><p></p></td>+ <td><p>CockroachDB distributed SQL database.</p></td></tr><tr><td>COSMOSDB</td><td>26</td>- <td><p></p></td>+ <td><p>Azure Cosmos DB multi-model database.</p></td></tr><tr><td>TRINO</td><td>27</td>- <td><p></p></td>+ <td><p>Trino distributed SQL query engine.</p></td></tr><tr><td>CASSANDRA</td><td>28</td>- <td><p></p></td>+ <td><p>Apache Cassandra NoSQL database.</p></td></tr></tbody></table><h3 id="bytebase.v1.ExportFormat">ExportFormat</h3>- <p></p>+ <p>Data export format.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -3241,31 +3241,31 @@<tr><td>FORMAT_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified export format.</p></td></tr><tr><td>CSV</td><td>1</td>- <td><p></p></td>+ <td><p>Comma-separated values format.</p></td></tr><tr><td>JSON</td><td>2</td>- <td><p></p></td>+ <td><p>JavaScript Object Notation format.</p></td></tr><tr><td>SQL</td><td>3</td>- <td><p></p></td>+ <td><p>SQL statements format.</p></td></tr><tr><td>XLSX</td><td>4</td>- <td><p></p></td>+ <td><p>Microsoft Excel spreadsheet format.</p></td></tr></tbody>@@ -3317,32 +3317,32 @@<tr><td>RISK_LEVEL_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified risk level.</p></td></tr><tr><td>LOW</td><td>1</td>- <td><p></p></td>+ <td><p>Low risk operation.</p></td></tr><tr><td>MODERATE</td><td>2</td>- <td><p></p></td>+ <td><p>Moderate risk operation.</p></td></tr><tr><td>HIGH</td><td>3</td>- <td><p></p></td>+ <td><p>High risk operation.</p></td></tr></tbody></table><h3 id="bytebase.v1.State">State</h3>- <p></p>+ <p>Resource lifecycle state.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -3358,20 +3358,20 @@<tr><td>ACTIVE</td><td>1</td>- <td><p></p></td>+ <td><p>Resource is active and operational.</p></td></tr><tr><td>DELETED</td><td>2</td>- <td><p></p></td>+ <td><p>Resource is soft-deleted but may be recoverable.</p></td></tr></tbody></table><h3 id="bytebase.v1.VCSType">VCSType</h3>- <p></p>+ <p>Version control system type.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -3381,31 +3381,31 @@<tr><td>VCS_TYPE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified VCS type.</p></td></tr><tr><td>GITHUB</td><td>1</td>- <td><p></p></td>+ <td><p>GitHub version control platform.</p></td></tr><tr><td>GITLAB</td><td>2</td>- <td><p></p></td>+ <td><p>GitLab version control platform.</p></td></tr><tr><td>BITBUCKET</td><td>3</td>- <td><p></p></td>+ <td><p>Bitbucket version control platform.</p></td></tr><tr><td>AZURE_DEVOPS</td><td>4</td>- <td><p></p></td>+ <td><p>Azure DevOps version control platform.</p></td></tr></tbody>@@ -3424,7 +3424,7 @@<h3 id="bytebase.v1.ColumnCatalog">ColumnCatalog</h3>- <p></p>+ <p>Column metadata within a table.</p><table class="field-table">@@ -3437,35 +3437,35 @@<td>name</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The column name. </p></td></tr><tr><td>semantic_type</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The semantic type describing the data purpose. </p></td></tr><tr><td>labels</td><td><a href="#bytebase.v1.ColumnCatalog.LabelsEntry">ColumnCatalog.LabelsEntry</a></td><td>repeated</td>- <td><p>The user labels for a column. </p></td>+ <td><p>User-defined labels for this column. </p></td></tr><tr><td>classification</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The data classification level for this column. </p></td></tr><tr><td>object_schema</td><td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td><td>optional</td>- <td><p> </p></td>+ <td><p>Object schema for complex column types like JSON. </p></td></tr></tbody>@@ -3507,7 +3507,7 @@<h3 id="bytebase.v1.DatabaseCatalog">DatabaseCatalog</h3>- <p></p>+ <p>Catalog metadata for a database including schemas, tables, and columns.</p><table class="field-table">@@ -3528,7 +3528,7 @@ Format: instances/{instance}/databases/{database}/catalog </p></td><td>schemas</td><td><a href="#bytebase.v1.SchemaCatalog">SchemaCatalog</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The schemas in the database. </p></td></tr></tbody>@@ -3539,7 +3539,7 @@ Format: instances/{instance}/databases/{database}/catalog </p></td><h3 id="bytebase.v1.GetDatabaseCatalogRequest">GetDatabaseCatalogRequest</h3>- <p></p>+ <p>Request message for getting a database catalog.</p><table class="field-table">@@ -3564,7 +3564,7 @@ Format: instances/{instance}/databases/{database}/catalog </p></td><h3 id="bytebase.v1.ObjectSchema">ObjectSchema</h3>- <p></p>+ <p>Schema definition for object-type columns.</p><table class="field-table">@@ -3577,28 +3577,28 @@ Format: instances/{instance}/databases/{database}/catalog </p></td><td>type</td><td><a href="#bytebase.v1.ObjectSchema.Type">ObjectSchema.Type</a></td><td></td>- <td><p> </p></td>+ <td><p>The data type of this object. </p></td></tr><tr><td>struct_kind</td><td><a href="#bytebase.v1.ObjectSchema.StructKind">ObjectSchema.StructKind</a></td><td></td>- <td><p> </p></td>+ <td><p>Struct schema. </p></td></tr><tr><td>array_kind</td><td><a href="#bytebase.v1.ObjectSchema.ArrayKind">ObjectSchema.ArrayKind</a></td><td></td>- <td><p> </p></td>+ <td><p>Array schema. </p></td></tr><tr><td>semantic_type</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The semantic type of this object. </p></td></tr></tbody>@@ -3609,7 +3609,7 @@ Format: instances/{instance}/databases/{database}/catalog </p></td><h3 id="bytebase.v1.ObjectSchema.ArrayKind">ObjectSchema.ArrayKind</h3>- <p></p>+ <p>Array type with element schema.</p><table class="field-table">@@ -3622,7 +3622,7 @@ Format: instances/{instance}/databases/{database}/catalog </p></td><td>kind</td><td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td><td></td>- <td><p> </p></td>+ <td><p>The schema of array elements. </p></td></tr></tbody>@@ -3633,7 +3633,7 @@ Format: instances/{instance}/databases/{database}/catalog </p></td><h3 id="bytebase.v1.ObjectSchema.StructKind">ObjectSchema.StructKind</h3>- <p></p>+ <p>Structure type with named properties.</p><table class="field-table">@@ -3646,7 +3646,7 @@ Format: instances/{instance}/databases/{database}/catalog </p></td><td>properties</td><td><a href="#bytebase.v1.ObjectSchema.StructKind.PropertiesEntry">ObjectSchema.StructKind.PropertiesEntry</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>Properties of the struct. </p></td></tr></tbody>@@ -3688,7 +3688,7 @@ Format: instances/{instance}/databases/{database}/catalog </p></td><h3 id="bytebase.v1.SchemaCatalog">SchemaCatalog</h3>- <p></p>+ <p>Schema metadata within a database.</p><table class="field-table">@@ -3701,14 +3701,14 @@ Format: instances/{instance}/databases/{database}/catalog </p></td><td>name</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The schema name. </p></td></tr><tr><td>tables</td><td><a href="#bytebase.v1.TableCatalog">TableCatalog</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The tables in the schema. </p></td></tr></tbody>@@ -3719,7 +3719,7 @@ Format: instances/{instance}/databases/{database}/catalog </p></td><h3 id="bytebase.v1.TableCatalog">TableCatalog</h3>- <p></p>+ <p>Table metadata within a schema.</p><table class="field-table">@@ -3732,28 +3732,28 @@ Format: instances/{instance}/databases/{database}/catalog </p></td><td>name</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The table name. </p></td></tr><tr><td>columns</td><td><a href="#bytebase.v1.TableCatalog.Columns">TableCatalog.Columns</a></td><td></td>- <td><p> </p></td>+ <td><p>Regular table columns. </p></td></tr><tr><td>object_schema</td><td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td><td></td>- <td><p> </p></td>+ <td><p>Object schema for JSON/XML columns. </p></td></tr><tr><td>classification</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The data classification level for this table. </p></td></tr></tbody>@@ -3764,7 +3764,7 @@ Format: instances/{instance}/databases/{database}/catalog </p></td><h3 id="bytebase.v1.TableCatalog.Columns">TableCatalog.Columns</h3>- <p></p>+ <p>Column list for regular tables.</p><table class="field-table">@@ -3777,7 +3777,7 @@ Format: instances/{instance}/databases/{database}/catalog </p></td><td>columns</td><td><a href="#bytebase.v1.ColumnCatalog">ColumnCatalog</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The columns in the table. </p></td></tr></tbody>@@ -3788,7 +3788,7 @@ Format: instances/{instance}/databases/{database}/catalog </p></td><h3 id="bytebase.v1.UpdateDatabaseCatalogRequest">UpdateDatabaseCatalogRequest</h3>- <p></p>+ <p>Request message for updating a database catalog.</p><table class="field-table">@@ -3825,7 +3825,7 @@ In this situation, `update_mask` is ignored. </p></td><h3 id="bytebase.v1.ObjectSchema.Type">ObjectSchema.Type</h3>- <p></p>+ <p>Object schema data types.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -3835,37 +3835,37 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>TYPE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified type.</p></td></tr><tr><td>STRING</td><td>1</td>- <td><p></p></td>+ <td><p>String type.</p></td></tr><tr><td>NUMBER</td><td>2</td>- <td><p></p></td>+ <td><p>Number type.</p></td></tr><tr><td>BOOLEAN</td><td>3</td>- <td><p></p></td>+ <td><p>Boolean type.</p></td></tr><tr><td>OBJECT</td><td>4</td>- <td><p></p></td>+ <td><p>Object/struct type.</p></td></tr><tr><td>ARRAY</td><td>5</td>- <td><p></p></td>+ <td><p>Array type.</p></td></tr></tbody>@@ -3876,7 +3876,7 @@ In this situation, `update_mask` is ignored. </p></td><h3 id="bytebase.v1.DatabaseCatalogService">DatabaseCatalogService</h3>- <p></p>+ <p>DatabaseCatalogService manages database schema metadata and classification.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -3887,14 +3887,16 @@ In this situation, `update_mask` is ignored. </p></td><td>GetDatabaseCatalog</td><td><a href="#bytebase.v1.GetDatabaseCatalogRequest">GetDatabaseCatalogRequest</a></td><td><a href="#bytebase.v1.DatabaseCatalog">DatabaseCatalog</a></td>- <td><p>Permissions required: bb.databaseCatalogs.get</p></td>+ <td><p>Gets the catalog metadata for a database.+Permissions required: bb.databaseCatalogs.get</p></td></tr><tr><td>UpdateDatabaseCatalog</td><td><a href="#bytebase.v1.UpdateDatabaseCatalogRequest">UpdateDatabaseCatalogRequest</a></td><td><a href="#bytebase.v1.DatabaseCatalog">DatabaseCatalog</a></td>- <td><p>Permissions required: bb.databaseCatalogs.update</p></td>+ <td><p>Updates catalog metadata such as classifications and labels.+Permissions required: bb.databaseCatalogs.update</p></td></tr></tbody>@@ -4130,7 +4132,7 @@ If this field is omitted, there are no subsequent pages. </p></td><h3 id="bytebase.v1.InstanceRoleService">InstanceRoleService</h3>- <p></p>+ <p>InstanceRoleService manages database roles within instances.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -4141,14 +4143,16 @@ If this field is omitted, there are no subsequent pages. </p></td><td>GetInstanceRole</td><td><a href="#bytebase.v1.GetInstanceRoleRequest">GetInstanceRoleRequest</a></td><td><a href="#bytebase.v1.InstanceRole">InstanceRole</a></td>- <td><p>Permissions required: bb.instanceRoles.get</p></td>+ <td><p>Gets a database role from an instance.+Permissions required: bb.instanceRoles.get</p></td></tr><tr><td>ListInstanceRoles</td><td><a href="#bytebase.v1.ListInstanceRolesRequest">ListInstanceRolesRequest</a></td><td><a href="#bytebase.v1.ListInstanceRolesResponse">ListInstanceRolesResponse</a></td>- <td><p>Permissions required: bb.instanceRoles.list</p></td>+ <td><p>Lists all database roles in an instance.+Permissions required: bb.instanceRoles.list</p></td></tr></tbody>@@ -4377,28 +4381,28 @@ are /[a-z][0-9]-/. </p></td><td>id</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The unique identifier for this data source. </p></td></tr><tr><td>type</td><td><a href="#bytebase.v1.DataSourceType">DataSourceType</a></td><td></td>- <td><p> </p></td>+ <td><p>The type of data source (ADMIN or READ_ONLY). </p></td></tr><tr><td>username</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The username for database authentication. </p></td></tr><tr><td>password</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The password for database authentication. </p></td></tr><tr>@@ -4412,21 +4416,21 @@ are /[a-z][0-9]-/. </p></td><td>ssl_ca</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The SSL certificate authority certificate. </p></td></tr><tr><td>ssl_cert</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The SSL client certificate. </p></td></tr><tr><td>ssl_key</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The SSL client private key. </p></td></tr><tr>@@ -4444,21 +4448,21 @@ validated (e.g., self-signed certs, VPN environments). </p></td><td>host</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The hostname or IP address of the database server. </p></td></tr><tr><td>port</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The port number of the database server. </p></td></tr><tr><td>database</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The name of the database to connect to. </p></td></tr><tr>@@ -4856,35 +4860,35 @@ See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_e<td>secret_type</td><td><a href="#bytebase.v1.DataSourceExternalSecret.SecretType">DataSourceExternalSecret.SecretType</a></td><td></td>- <td><p> </p></td>+ <td><p>The type of external secret store. </p></td></tr><tr><td>url</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The URL of the external secret store. </p></td></tr><tr><td>auth_type</td><td><a href="#bytebase.v1.DataSourceExternalSecret.AuthType">DataSourceExternalSecret.AuthType</a></td><td></td>- <td><p> </p></td>+ <td><p>The authentication method for accessing the secret store. </p></td></tr><tr><td>app_role</td><td><a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption">DataSourceExternalSecret.AppRoleAuthOption</a></td><td></td>- <td><p> </p></td>+ <td><p>AppRole authentication configuration. </p></td></tr><tr><td>token</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Token for direct authentication. </p></td></tr><tr>@@ -4929,7 +4933,7 @@ See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_e<td>role_id</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The role ID for Vault AppRole authentication. </p></td></tr><tr>@@ -4943,7 +4947,7 @@ See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_e<td>type</td><td><a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption.SecretType">DataSourceExternalSecret.AppRoleAuthOption.SecretType</a></td><td></td>- <td><p> </p></td>+ <td><p>The type of secret for AppRole authentication. </p></td></tr><tr>@@ -5049,42 +5053,42 @@ Format: instances/{instance} </p></td><td>state</td><td><a href="#bytebase.v1.State">State</a></td><td></td>- <td><p> </p></td>+ <td><p>The lifecycle state of the instance. </p></td></tr><tr><td>title</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The display title of the instance. </p></td></tr><tr><td>engine</td><td><a href="#bytebase.v1.Engine">Engine</a></td><td></td>- <td><p> </p></td>+ <td><p>The database engine type. </p></td></tr><tr><td>engine_version</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The version of the database engine. </p></td></tr><tr><td>external_link</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>External URL to the database instance console. </p></td></tr><tr><td>data_sources</td><td><a href="#bytebase.v1.DataSource">DataSource</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>Data source configurations for connecting to the instance. </p></td></tr><tr>@@ -5099,14 +5103,14 @@ Format: environments/prod where prod is the environment resource ID. </p></td><td>activation</td><td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Whether the instance is activated for use. </p></td></tr><tr><td>roles</td><td><a href="#bytebase.v1.InstanceRole">InstanceRole</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>Database roles available in this instance. </p></td></tr><tr>@@ -5199,35 +5203,35 @@ For example, { "org_group": "infrastructure", "environment&#<td>title</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The display title of the instance. </p></td></tr><tr><td>engine</td><td><a href="#bytebase.v1.Engine">Engine</a></td><td></td>- <td><p> </p></td>+ <td><p>The database engine type. </p></td></tr><tr><td>engine_version</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The version of the database engine. </p></td></tr><tr><td>data_sources</td><td><a href="#bytebase.v1.DataSource">DataSource</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>Data source configurations for the instance. </p></td></tr><tr><td>activation</td><td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Whether the instance is activated. </p></td></tr><tr>@@ -5267,49 +5271,49 @@ Format: environments/prod where prod is the environment resource ID. </p></td><td>primary</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The primary component of the Kerberos principal. </p></td></tr><tr><td>instance</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The instance component of the Kerberos principal. </p></td></tr><tr><td>realm</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The Kerberos realm. </p></td></tr><tr><td>keytab</td><td><a href="#bytes">bytes</a></td><td></td>- <td><p> </p></td>+ <td><p>The keytab file contents for authentication. </p></td></tr><tr><td>kdc_host</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The hostname of the Key Distribution Center (KDC). </p></td></tr><tr><td>kdc_port</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The port of the Key Distribution Center (KDC). </p></td></tr><tr><td>kdc_transport_protocol</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The transport protocol for KDC communication (tcp or udp). </p></td></tr></tbody>@@ -5540,7 +5544,7 @@ Only READ_ONLY data source can be removed. </p></td><td>krb_config</td><td><a href="#bytebase.v1.KerberosConfig">KerberosConfig</a></td><td></td>- <td><p> </p></td>+ <td><p>Kerberos authentication configuration. </p></td></tr></tbody>@@ -5817,19 +5821,19 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>SECRET_TYPE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified secret type.</p></td></tr><tr><td>PLAIN</td><td>1</td>- <td><p></p></td>+ <td><p>Plain text secret.</p></td></tr><tr><td>ENVIRONMENT</td><td>2</td>- <td><p></p></td>+ <td><p>Secret from environment variable.</p></td></tr></tbody>@@ -5846,7 +5850,7 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>AUTH_TYPE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified authentication type.</p></td></tr><tr>@@ -5875,7 +5879,7 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>SAECRET_TYPE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified secret type.</p></td></tr><tr>@@ -5910,19 +5914,19 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>DATA_SOURCE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified data source type.</p></td></tr><tr><td>ADMIN</td><td>1</td>- <td><p></p></td>+ <td><p>Admin data source with write permissions.</p></td></tr><tr><td>READ_ONLY</td><td>2</td>- <td><p></p></td>+ <td><p>Read-only data source for query operations.</p></td></tr></tbody>@@ -5933,7 +5937,7 @@ In this situation, `update_mask` is ignored. </p></td><h3 id="bytebase.v1.InstanceService">InstanceService</h3>- <p></p>+ <p>InstanceService manages database instances and their connections.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -5944,91 +5948,104 @@ In this situation, `update_mask` is ignored. </p></td><td>GetInstance</td><td><a href="#bytebase.v1.GetInstanceRequest">GetInstanceRequest</a></td><td><a href="#bytebase.v1.Instance">Instance</a></td>- <td><p>Permissions required: bb.instances.get</p></td>+ <td><p>Gets a database instance by name.+Permissions required: bb.instances.get</p></td></tr><tr><td>ListInstances</td><td><a href="#bytebase.v1.ListInstancesRequest">ListInstancesRequest</a></td><td><a href="#bytebase.v1.ListInstancesResponse">ListInstancesResponse</a></td>- <td><p>Permissions required: bb.instances.list</p></td>+ <td><p>Lists all database instances.+Permissions required: bb.instances.list</p></td></tr><tr><td>CreateInstance</td><td><a href="#bytebase.v1.CreateInstanceRequest">CreateInstanceRequest</a></td><td><a href="#bytebase.v1.Instance">Instance</a></td>- <td><p>Permissions required: bb.instances.create</p></td>+ <td><p>Creates a new database instance.+Permissions required: bb.instances.create</p></td></tr><tr><td>UpdateInstance</td><td><a href="#bytebase.v1.UpdateInstanceRequest">UpdateInstanceRequest</a></td><td><a href="#bytebase.v1.Instance">Instance</a></td>- <td><p>Permissions required: bb.instances.update</p></td>+ <td><p>Updates a database instance.+Permissions required: bb.instances.update</p></td></tr><tr><td>DeleteInstance</td><td><a href="#bytebase.v1.DeleteInstanceRequest">DeleteInstanceRequest</a></td><td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>- <td><p>Permissions required: bb.instances.delete</p></td>+ <td><p>Deletes or soft-deletes a database instance.+Permissions required: bb.instances.delete</p></td></tr><tr><td>UndeleteInstance</td><td><a href="#bytebase.v1.UndeleteInstanceRequest">UndeleteInstanceRequest</a></td><td><a href="#bytebase.v1.Instance">Instance</a></td>- <td><p>Permissions required: bb.instances.undelete</p></td>+ <td><p>Restores a soft-deleted database instance.+Permissions required: bb.instances.undelete</p></td></tr><tr><td>SyncInstance</td><td><a href="#bytebase.v1.SyncInstanceRequest">SyncInstanceRequest</a></td><td><a href="#bytebase.v1.SyncInstanceResponse">SyncInstanceResponse</a></td>- <td><p>Permissions required: bb.instances.sync</p></td>+ <td><p>Syncs database schemas and metadata from an instance.+Permissions required: bb.instances.sync</p></td></tr><tr><td>ListInstanceDatabase</td><td><a href="#bytebase.v1.ListInstanceDatabaseRequest">ListInstanceDatabaseRequest</a></td><td><a href="#bytebase.v1.ListInstanceDatabaseResponse">ListInstanceDatabaseResponse</a></td>- <td><p>Permissions required: bb.instances.get</p></td>+ <td><p>Lists all databases within an instance without creating them.+Permissions required: bb.instances.get</p></td></tr><tr><td>BatchSyncInstances</td><td><a href="#bytebase.v1.BatchSyncInstancesRequest">BatchSyncInstancesRequest</a></td><td><a href="#bytebase.v1.BatchSyncInstancesResponse">BatchSyncInstancesResponse</a></td>- <td><p>Permissions required: bb.instances.sync</p></td>+ <td><p>Syncs multiple instances in a single request.+Permissions required: bb.instances.sync</p></td></tr><tr><td>BatchUpdateInstances</td><td><a href="#bytebase.v1.BatchUpdateInstancesRequest">BatchUpdateInstancesRequest</a></td><td><a href="#bytebase.v1.BatchUpdateInstancesResponse">BatchUpdateInstancesResponse</a></td>- <td><p>Permissions required: bb.instances.update</p></td>+ <td><p>Updates multiple instances in a single request.+Permissions required: bb.instances.update</p></td></tr><tr><td>AddDataSource</td><td><a href="#bytebase.v1.AddDataSourceRequest">AddDataSourceRequest</a></td><td><a href="#bytebase.v1.Instance">Instance</a></td>- <td><p>Permissions required: bb.instances.update</p></td>+ <td><p>Adds a read-only data source to an instance.+Permissions required: bb.instances.update</p></td></tr><tr><td>RemoveDataSource</td><td><a href="#bytebase.v1.RemoveDataSourceRequest">RemoveDataSourceRequest</a></td><td><a href="#bytebase.v1.Instance">Instance</a></td>- <td><p>Permissions required: bb.instances.update</p></td>+ <td><p>Removes a read-only data source from an instance.+Permissions required: bb.instances.update</p></td></tr><tr><td>UpdateDataSource</td><td><a href="#bytebase.v1.UpdateDataSourceRequest">UpdateDataSourceRequest</a></td><td><a href="#bytebase.v1.Instance">Instance</a></td>- <td><p>Permissions required: bb.instances.update</p></td>+ <td><p>Updates a data source configuration.+Permissions required: bb.instances.update</p></td></tr></tbody>@@ -7141,7 +7158,7 @@ Format: instances/{instance}/databases/{database}/metadata </p></td><td>owner</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The owner of the database. </p></td></tr><tr>@@ -7443,14 +7460,14 @@ instances/{instance}/databases/{database}/changelogs/{changelog} </p></td><td>comment</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The comment describing the enum type. </p></td></tr><tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Whether to skip this enum type during schema dump operations. </p></td></tr></tbody>@@ -7495,21 +7512,21 @@ instances/{instance}/databases/{database}/changelogs/{changelog} </p></td><td>sql_mode</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The SQL mode setting for the event. </p></td></tr><tr><td>character_set_client</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The character set used by the client creating the event. </p></td></tr><tr><td>collation_connection</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The collation used for the connection when creating the event. </p></td></tr><tr>@@ -8724,7 +8741,7 @@ Snowflake. </p></td><td>owner</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The owner of the schema. </p></td></tr><tr>@@ -8738,21 +8755,21 @@ Snowflake. </p></td><td>events</td><td><a href="#bytebase.v1.EventMetadata">EventMetadata</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The events is the list of scheduled events in a schema. </p></td></tr><tr><td>enum_types</td><td><a href="#bytebase.v1.EnumTypeMetadata">EnumTypeMetadata</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The enum_types is the list of user-defined enum types in a schema. </p></td></tr><tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Whether to skip this schema during schema dump operations. </p></td></tr><tr>@@ -8860,14 +8877,14 @@ Snowflake. </p></td><td>comment</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The comment describing the sequence. </p></td></tr><tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Whether to skip this sequence during schema dump operations. </p></td></tr></tbody>@@ -9269,7 +9286,7 @@ classification and user_comment is parsed from the comment. </p></td><td>owner</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The owner of the table. </p></td></tr><tr>@@ -9284,14 +9301,14 @@ Reference: https://clickhouse.com/docs/en/engines/table-engines/mergetree-family<td>triggers</td><td><a href="#bytebase.v1.TriggerMetadata">TriggerMetadata</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The triggers is the list of triggers associated with the table. </p></td></tr><tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Whether to skip this table during schema dump operations. </p></td></tr><tr>@@ -9584,35 +9601,35 @@ TRUNCATE. </p></td><td>sql_mode</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The SQL mode setting for the trigger. </p></td></tr><tr><td>character_set_client</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The character set used by the client creating the trigger. </p></td></tr><tr><td>collation_connection</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The collation used for the connection when creating the trigger. </p></td></tr><tr><td>comment</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The comment describing the trigger. </p></td></tr><tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Whether to skip this trigger during schema dump operations. </p></td></tr></tbody>@@ -10147,7 +10164,7 @@ The API will default to the BASIC view.</p></td><h3 id="bytebase.v1.DatabaseService">DatabaseService</h3>- <p></p>+ <p>DatabaseService manages databases and their schemas.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -10158,91 +10175,104 @@ The API will default to the BASIC view.</p></td><td>GetDatabase</td><td><a href="#bytebase.v1.GetDatabaseRequest">GetDatabaseRequest</a></td><td><a href="#bytebase.v1.Database">Database</a></td>- <td><p>Permissions required: bb.databases.get</p></td>+ <td><p>Retrieves a database by name.+Permissions required: bb.databases.get</p></td></tr><tr><td>BatchGetDatabases</td><td><a href="#bytebase.v1.BatchGetDatabasesRequest">BatchGetDatabasesRequest</a></td><td><a href="#bytebase.v1.BatchGetDatabasesResponse">BatchGetDatabasesResponse</a></td>- <td><p>Permissions required: bb.databases.get</p></td>+ <td><p>Retrieves multiple databases by their names.+Permissions required: bb.databases.get</p></td></tr><tr><td>ListDatabases</td><td><a href="#bytebase.v1.ListDatabasesRequest">ListDatabasesRequest</a></td><td><a href="#bytebase.v1.ListDatabasesResponse">ListDatabasesResponse</a></td>- <td><p>Permissions required: bb.databases.list</p></td>+ <td><p>Lists databases in a project, instance, or workspace.+Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)</p></td></tr><tr><td>UpdateDatabase</td><td><a href="#bytebase.v1.UpdateDatabaseRequest">UpdateDatabaseRequest</a></td><td><a href="#bytebase.v1.Database">Database</a></td>- <td><p>Permissions required: bb.databases.update</p></td>+ <td><p>Updates database properties such as labels and project assignment.+Permissions required: bb.databases.update</p></td></tr><tr><td>BatchUpdateDatabases</td><td><a href="#bytebase.v1.BatchUpdateDatabasesRequest">BatchUpdateDatabasesRequest</a></td><td><a href="#bytebase.v1.BatchUpdateDatabasesResponse">BatchUpdateDatabasesResponse</a></td>- <td><p>Permissions required: bb.databases.update</p></td>+ <td><p>Updates multiple databases in a single batch operation.+Permissions required: bb.databases.update</p></td></tr><tr><td>SyncDatabase</td><td><a href="#bytebase.v1.SyncDatabaseRequest">SyncDatabaseRequest</a></td><td><a href="#bytebase.v1.SyncDatabaseResponse">SyncDatabaseResponse</a></td>- <td><p>Permissions required: bb.databases.sync</p></td>+ <td><p>Synchronizes database schema from the instance.+Permissions required: bb.databases.sync</p></td></tr><tr><td>BatchSyncDatabases</td><td><a href="#bytebase.v1.BatchSyncDatabasesRequest">BatchSyncDatabasesRequest</a></td><td><a href="#bytebase.v1.BatchSyncDatabasesResponse">BatchSyncDatabasesResponse</a></td>- <td><p>Permissions required: bb.databases.sync</p></td>+ <td><p>Synchronizes multiple databases in a single batch operation.+Permissions required: bb.databases.sync</p></td></tr><tr><td>GetDatabaseMetadata</td><td><a href="#bytebase.v1.GetDatabaseMetadataRequest">GetDatabaseMetadataRequest</a></td><td><a href="#bytebase.v1.DatabaseMetadata">DatabaseMetadata</a></td>- <td><p>Permissions required: bb.databases.getSchema</p></td>+ <td><p>Retrieves database metadata including tables, columns, and indexes.+Permissions required: bb.databases.getSchema</p></td></tr><tr><td>GetDatabaseSchema</td><td><a href="#bytebase.v1.GetDatabaseSchemaRequest">GetDatabaseSchemaRequest</a></td><td><a href="#bytebase.v1.DatabaseSchema">DatabaseSchema</a></td>- <td><p>Permissions required: bb.databases.getSchema</p></td>+ <td><p>Retrieves database schema as DDL statements.+Permissions required: bb.databases.getSchema</p></td></tr><tr><td>DiffSchema</td><td><a href="#bytebase.v1.DiffSchemaRequest">DiffSchemaRequest</a></td><td><a href="#bytebase.v1.DiffSchemaResponse">DiffSchemaResponse</a></td>- <td><p>Permissions required: bb.databases.get</p></td>+ <td><p>Compares and generates migration statements between two schemas.+Permissions required: bb.databases.get</p></td></tr><tr><td>ListChangelogs</td><td><a href="#bytebase.v1.ListChangelogsRequest">ListChangelogsRequest</a></td><td><a href="#bytebase.v1.ListChangelogsResponse">ListChangelogsResponse</a></td>- <td><p>Permissions required: bb.changelogs.list</p></td>+ <td><p>Lists migration history for a database.+Permissions required: bb.changelogs.list</p></td></tr><tr><td>GetChangelog</td><td><a href="#bytebase.v1.GetChangelogRequest">GetChangelogRequest</a></td><td><a href="#bytebase.v1.Changelog">Changelog</a></td>- <td><p>Permissions required: changelogs.get</p></td>+ <td><p>Retrieves a specific changelog entry.+Permissions required: bb.changelogs.get</p></td></tr><tr><td>GetSchemaString</td><td><a href="#bytebase.v1.GetSchemaStringRequest">GetSchemaStringRequest</a></td><td><a href="#bytebase.v1.GetSchemaStringResponse">GetSchemaStringResponse</a></td>- <td><p>Permissions required: databases.getSchema</p></td>+ <td><p>Generates schema DDL for a database object.+Permissions required: bb.databases.getSchema</p></td></tr></tbody>@@ -10447,7 +10477,7 @@ The API will default to the BASIC view.</p></td><td>roles</td><td><a href="#string">string</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The roles required for approval in order. </p></td></tr></tbody>@@ -10480,21 +10510,21 @@ For custom templates, use a UUID or other unique identifier. </p></td><td>flow</td><td><a href="#bytebase.v1.ApprovalFlow">ApprovalFlow</a></td><td></td>- <td><p> </p></td>+ <td><p>The approval flow definition. </p></td></tr><tr><td>title</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The title of the approval template. </p></td></tr><tr><td>description</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The description of the approval template. </p></td></tr></tbody>@@ -10526,7 +10556,7 @@ Format: projects/{project}/issues/{issue} </p></td><td>comment</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The comment explaining the approval decision. </p></td></tr></tbody>@@ -10575,7 +10605,7 @@ Format: projects/{project}/issues/{issue} </p></td><td>reason</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The reason for the status change. </p></td></tr></tbody>@@ -10614,7 +10644,7 @@ Format: projects/{project}/issues/{issue} </p></td><td>issue_comment</td><td><a href="#bytebase.v1.IssueComment">IssueComment</a></td><td></td>- <td><p> </p></td>+ <td><p>The comment to create. </p></td></tr></tbody>@@ -10678,7 +10708,7 @@ Format: projects/{project}/issues/{issue} </p></td><td>force</td><td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>If set to true, bypass cache and fetch the latest data. </p></td></tr></tbody>@@ -10725,7 +10755,7 @@ Format: users/{email}. </p></td><td>expiration</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td>- <td><p> </p></td>+ <td><p>The duration for which the grant is valid. </p></td></tr></tbody>@@ -10757,14 +10787,14 @@ Format: projects/{project}/issues/{issue} </p></td><td>title</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The title of the issue. </p></td></tr><tr><td>description</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The description of the issue. </p></td></tr><tr>@@ -10778,7 +10808,7 @@ Format: projects/{project}/issues/{issue} </p></td><td>status</td><td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td><td></td>- <td><p> </p></td>+ <td><p>The status of the issue. </p></td></tr><tr>@@ -10792,7 +10822,7 @@ Format: projects/{project}/issues/{issue} </p></td><td>approval_template</td><td><a href="#bytebase.v1.ApprovalTemplate">ApprovalTemplate</a></td><td></td>- <td><p> </p></td>+ <td><p>The approval template for the issue. </p></td></tr><tr>@@ -10859,7 +10889,7 @@ Format:<td>risk_level</td><td><a href="#bytebase.v1.RiskLevel">RiskLevel</a></td><td></td>- <td><p> </p></td>+ <td><p>The risk level of the issue. </p></td></tr><tr>@@ -10881,7 +10911,7 @@ Keys are the following:<td>labels</td><td><a href="#string">string</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>Labels attached to the issue for categorization and filtering. </p></td></tr><tr>@@ -10906,7 +10936,7 @@ Keys are the following:<h3 id="bytebase.v1.Issue.Approver">Issue.Approver</h3>- <p></p>+ <p>Approvers and their approval status for the issue.</p><table class="field-table">@@ -10968,7 +10998,7 @@ Keys are the following:<h3 id="bytebase.v1.IssueComment">IssueComment</h3>- <p></p>+ <p>A comment on an issue.</p><table class="field-table">@@ -10988,7 +11018,7 @@ Keys are the following:<td>comment</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The text content of the comment. </p></td></tr><tr>@@ -11023,35 +11053,35 @@ Keys are the following:<td>approval</td><td><a href="#bytebase.v1.IssueComment.Approval">IssueComment.Approval</a></td><td></td>- <td><p> </p></td>+ <td><p>Approval event. </p></td></tr><tr><td>issue_update</td><td><a href="#bytebase.v1.IssueComment.IssueUpdate">IssueComment.IssueUpdate</a></td><td></td>- <td><p> </p></td>+ <td><p>Issue update event. </p></td></tr><tr><td>stage_end</td><td><a href="#bytebase.v1.IssueComment.StageEnd">IssueComment.StageEnd</a></td><td></td>- <td><p> </p></td>+ <td><p>Stage end event. </p></td></tr><tr><td>task_update</td><td><a href="#bytebase.v1.IssueComment.TaskUpdate">IssueComment.TaskUpdate</a></td><td></td>- <td><p> </p></td>+ <td><p>Task update event. </p></td></tr><tr><td>task_prior_backup</td><td><a href="#bytebase.v1.IssueComment.TaskPriorBackup">IssueComment.TaskPriorBackup</a></td><td></td>- <td><p> </p></td>+ <td><p>Task prior backup event. </p></td></tr></tbody>@@ -11062,7 +11092,7 @@ Keys are the following:<h3 id="bytebase.v1.IssueComment.Approval">IssueComment.Approval</h3>- <p></p>+ <p>Approval event information.</p><table class="field-table">@@ -11075,7 +11105,7 @@ Keys are the following:<td>status</td><td><a href="#bytebase.v1.IssueComment.Approval.Status">IssueComment.Approval.Status</a></td><td></td>- <td><p> </p></td>+ <td><p>The approval status. </p></td></tr></tbody>@@ -11086,7 +11116,7 @@ Keys are the following:<h3 id="bytebase.v1.IssueComment.IssueUpdate">IssueComment.IssueUpdate</h3>- <p></p>+ <p>Issue update event information.</p><table class="field-table">@@ -11159,7 +11189,7 @@ Keys are the following:<h3 id="bytebase.v1.IssueComment.StageEnd">IssueComment.StageEnd</h3>- <p></p>+ <p>Stage end event information.</p><table class="field-table">@@ -11172,7 +11202,7 @@ Keys are the following:<td>stage</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The stage that ended. </p></td></tr></tbody>@@ -11183,7 +11213,7 @@ Keys are the following:<h3 id="bytebase.v1.IssueComment.TaskPriorBackup">IssueComment.TaskPriorBackup</h3>- <p></p>+ <p>Task prior backup event information.</p><table class="field-table">@@ -11196,35 +11226,35 @@ Keys are the following:<td>task</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The task for which backup was performed. </p></td></tr><tr><td>tables</td><td><a href="#bytebase.v1.IssueComment.TaskPriorBackup.Table">IssueComment.TaskPriorBackup.Table</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The tables that were backed up. </p></td></tr><tr><td>original_line</td><td><a href="#int32">int32</a></td><td>optional</td>- <td><p> </p></td>+ <td><p>The original line number in the statement. </p></td></tr><tr><td>database</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The database that was backed up. </p></td></tr><tr><td>error</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Error message if backup failed. </p></td></tr></tbody>@@ -11235,7 +11265,7 @@ Keys are the following:<h3 id="bytebase.v1.IssueComment.TaskPriorBackup.Table">IssueComment.TaskPriorBackup.Table</h3>- <p></p>+ <p>Table identification.</p><table class="field-table">@@ -11248,14 +11278,14 @@ Keys are the following:<td>schema</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The schema name. </p></td></tr><tr><td>table</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The table name. </p></td></tr></tbody>@@ -11266,7 +11296,7 @@ Keys are the following:<h3 id="bytebase.v1.IssueComment.TaskUpdate">IssueComment.TaskUpdate</h3>- <p></p>+ <p>Task update event information.</p><table class="field-table">@@ -11279,7 +11309,7 @@ Keys are the following:<td>tasks</td><td><a href="#string">string</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The tasks that were updated. </p></td></tr><tr>@@ -11369,7 +11399,7 @@ the call that provided the page token. </p></td><td>issue_comments</td><td><a href="#bytebase.v1.IssueComment">IssueComment</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The issue comments from the specified request. </p></td></tr><tr>@@ -11520,7 +11550,7 @@ Format: projects/{project}/issues/{issue} </p></td><td>comment</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The comment explaining the rejection decision. </p></td></tr></tbody>@@ -11552,7 +11582,7 @@ Format: projects/{project}/issues/{issue} </p></td><td>comment</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The comment explaining the request. </p></td></tr></tbody>@@ -11678,7 +11708,7 @@ Format: projects/{project}/issues/{issue} </p></td><td>issue_comment</td><td><a href="#bytebase.v1.IssueComment">IssueComment</a></td><td></td>- <td><p> </p></td>+ <td><p>The comment to update. </p></td></tr><tr>@@ -11748,7 +11778,7 @@ In this situation, `update_mask` is ignored. </p></td><h3 id="bytebase.v1.Issue.ApprovalStatus">Issue.ApprovalStatus</h3>- <p></p>+ <p>The overall approval status for the issue.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -11758,50 +11788,50 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>APPROVAL_STATUS_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified approval status.</p></td></tr><tr><td>CHECKING</td><td>1</td>- <td><p></p></td>+ <td><p>Approval checks are being evaluated.</p></td></tr><tr><td>PENDING</td><td>2</td>- <td><p></p></td>+ <td><p>Approval is pending.</p></td></tr><tr><td>APPROVED</td><td>3</td>- <td><p></p></td>+ <td><p>Issue has been approved.</p></td></tr><tr><td>REJECTED</td><td>4</td>- <td><p></p></td>+ <td><p>Issue has been rejected.</p></td></tr><tr><td>SKIPPED</td><td>5</td>- <td><p></p></td>+ <td><p>Approval was skipped.</p></td></tr><tr><td>ERROR</td><td>6</td>- <td><p></p></td>+ <td><p>Error occurred during approval evaluation.</p></td></tr></tbody></table><h3 id="bytebase.v1.Issue.Approver.Status">Issue.Approver.Status</h3>- <p></p>+ <p>The approval status of an approver.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -11811,32 +11841,32 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>STATUS_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified status.</p></td></tr><tr><td>PENDING</td><td>1</td>- <td><p></p></td>+ <td><p>Awaiting approval.</p></td></tr><tr><td>APPROVED</td><td>2</td>- <td><p></p></td>+ <td><p>Approved.</p></td></tr><tr><td>REJECTED</td><td>3</td>- <td><p></p></td>+ <td><p>Rejected.</p></td></tr></tbody></table><h3 id="bytebase.v1.Issue.Type">Issue.Type</h3>- <p></p>+ <p>The type of issue.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -11846,32 +11876,32 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>TYPE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified issue type.</p></td></tr><tr><td>DATABASE_CHANGE</td><td>1</td>- <td><p></p></td>+ <td><p>Database schema or data change.</p></td></tr><tr><td>GRANT_REQUEST</td><td>2</td>- <td><p></p></td>+ <td><p>Database access grant request.</p></td></tr><tr><td>DATABASE_EXPORT</td><td>3</td>- <td><p></p></td>+ <td><p>Database data export request.</p></td></tr></tbody></table><h3 id="bytebase.v1.IssueComment.Approval.Status">IssueComment.Approval.Status</h3>- <p></p>+ <p>Approval status values.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -11881,32 +11911,32 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>STATUS_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified status.</p></td></tr><tr><td>PENDING</td><td>1</td>- <td><p></p></td>+ <td><p>Approval pending.</p></td></tr><tr><td>APPROVED</td><td>2</td>- <td><p></p></td>+ <td><p>Approved.</p></td></tr><tr><td>REJECTED</td><td>3</td>- <td><p></p></td>+ <td><p>Rejected.</p></td></tr></tbody></table><h3 id="bytebase.v1.IssueComment.TaskUpdate.Status">IssueComment.TaskUpdate.Status</h3>- <p></p>+ <p>Task status values.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -11916,50 +11946,50 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>STATUS_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified status.</p></td></tr><tr><td>PENDING</td><td>1</td>- <td><p></p></td>+ <td><p>Task is pending.</p></td></tr><tr><td>RUNNING</td><td>2</td>- <td><p></p></td>+ <td><p>Task is running.</p></td></tr><tr><td>DONE</td><td>3</td>- <td><p></p></td>+ <td><p>Task is done.</p></td></tr><tr><td>FAILED</td><td>4</td>- <td><p></p></td>+ <td><p>Task failed.</p></td></tr><tr><td>SKIPPED</td><td>5</td>- <td><p></p></td>+ <td><p>Task was skipped.</p></td></tr><tr><td>CANCELED</td><td>6</td>- <td><p></p></td>+ <td><p>Task was canceled.</p></td></tr></tbody></table><h3 id="bytebase.v1.IssueStatus">IssueStatus</h3>- <p></p>+ <p>The status of an issue.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -11969,25 +11999,25 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>ISSUE_STATUS_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified status.</p></td></tr><tr><td>OPEN</td><td>1</td>- <td><p></p></td>+ <td><p>Issue is open and active.</p></td></tr><tr><td>DONE</td><td>2</td>- <td><p></p></td>+ <td><p>Issue is completed.</p></td></tr><tr><td>CANCELED</td><td>3</td>- <td><p></p></td>+ <td><p>Issue is canceled.</p></td></tr></tbody>@@ -11998,7 +12028,7 @@ In this situation, `update_mask` is ignored. </p></td><h3 id="bytebase.v1.IssueService">IssueService</h3>- <p></p>+ <p>IssueService manages issues for tracking database changes and tasks.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -12009,21 +12039,24 @@ In this situation, `update_mask` is ignored. </p></td><td>GetIssue</td><td><a href="#bytebase.v1.GetIssueRequest">GetIssueRequest</a></td><td><a href="#bytebase.v1.Issue">Issue</a></td>- <td><p>Permissions required: bb.issues.get</p></td>+ <td><p>Retrieves an issue by name.+Permissions required: bb.issues.get</p></td></tr><tr><td>CreateIssue</td><td><a href="#bytebase.v1.CreateIssueRequest">CreateIssueRequest</a></td><td><a href="#bytebase.v1.Issue">Issue</a></td>- <td><p>Permissions required: bb.issues.create</p></td>+ <td><p>Creates a new issue for database changes or tasks.+Permissions required: bb.issues.create</p></td></tr><tr><td>ListIssues</td><td><a href="#bytebase.v1.ListIssuesRequest">ListIssuesRequest</a></td><td><a href="#bytebase.v1.ListIssuesResponse">ListIssuesResponse</a></td>- <td><p>Permissions required: bb.issues.list</p></td>+ <td><p>Lists issues in a project.+Permissions required: bb.issues.list</p></td></tr><tr>@@ -12038,62 +12071,64 @@ Permissions required: bb.issues.get</p></td><td>UpdateIssue</td><td><a href="#bytebase.v1.UpdateIssueRequest">UpdateIssueRequest</a></td><td><a href="#bytebase.v1.Issue">Issue</a></td>- <td><p>Permissions required: bb.issues.update</p></td>+ <td><p>Updates an issue's properties such as title, description, or labels.+Permissions required: bb.issues.update</p></td></tr><tr><td>ListIssueComments</td><td><a href="#bytebase.v1.ListIssueCommentsRequest">ListIssueCommentsRequest</a></td><td><a href="#bytebase.v1.ListIssueCommentsResponse">ListIssueCommentsResponse</a></td>- <td><p>Permissions required: bb.issueComments.list</p></td>+ <td><p>Lists comments on an issue.+Permissions required: bb.issueComments.list</p></td></tr><tr><td>CreateIssueComment</td><td><a href="#bytebase.v1.CreateIssueCommentRequest">CreateIssueCommentRequest</a></td><td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>- <td><p>Permissions required: bb.issueComments.create</p></td>+ <td><p>Adds a comment to an issue.+Permissions required: bb.issueComments.create</p></td></tr><tr><td>UpdateIssueComment</td><td><a href="#bytebase.v1.UpdateIssueCommentRequest">UpdateIssueCommentRequest</a></td><td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>- <td><p>Permissions required: bb.issueComments.update</p></td>+ <td><p>Updates an existing issue comment.+Permissions required: bb.issueComments.update</p></td></tr><tr><td>BatchUpdateIssuesStatus</td><td><a href="#bytebase.v1.BatchUpdateIssuesStatusRequest">BatchUpdateIssuesStatusRequest</a></td><td><a href="#bytebase.v1.BatchUpdateIssuesStatusResponse">BatchUpdateIssuesStatusResponse</a></td>- <td><p>Permissions required: bb.issues.update</p></td>+ <td><p>Updates the status of multiple issues in a single operation.+Permissions required: bb.issues.update</p></td></tr><tr><td>ApproveIssue</td><td><a href="#bytebase.v1.ApproveIssueRequest">ApproveIssueRequest</a></td><td><a href="#bytebase.v1.Issue">Issue</a></td>- <td><p>ApproveIssue approves the issue.-The access is based on approval flow.-Permissions required: None</p></td>+ <td><p>Approves an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+Permissions required: None (determined by approval flow)</p></td></tr><tr><td>RejectIssue</td><td><a href="#bytebase.v1.RejectIssueRequest">RejectIssueRequest</a></td><td><a href="#bytebase.v1.Issue">Issue</a></td>- <td><p>RejectIssue rejects the issue.-The access is based on approval flow.-Permissions required: None</p></td>+ <td><p>Rejects an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+Permissions required: None (determined by approval flow)</p></td></tr><tr><td>RequestIssue</td><td><a href="#bytebase.v1.RequestIssueRequest">RequestIssueRequest</a></td><td><a href="#bytebase.v1.Issue">Issue</a></td>- <td><p>RequestIssue requests the issue.-The access is based on approval flow.-Permissions required: None</p></td>+ <td><p>Requests changes on an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+Permissions required: None (determined by approval flow)</p></td></tr></tbody>@@ -12521,14 +12556,14 @@ But frontend can be started with a single rule easily. </p></td><td>level</td><td><a href="#bytebase.v1.Announcement.AlertLevel">Announcement.AlertLevel</a></td><td></td>- <td><p>The alert level of announcemnt </p></td>+ <td><p>The alert level of announcement </p></td></tr><tr><td>text</td><td><a href="#string">string</a></td><td></td>- <td><p>The text of announcemnt </p></td>+ <td><p>The text of announcement </p></td></tr><tr>@@ -13161,7 +13196,7 @@ are /[a-z][0-9]-/. </p></td><td>page_size</td><td><a href="#int32">int32</a></td><td></td>- <td><p>Not used.+ <td><p>Pagination is not currently implemented. This field is reserved for future use.The maximum number of settings to return. The service may return fewer thanthis value.If unspecified, at most 10 settings will be returned.@@ -13172,7 +13207,7 @@ The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td><td>page_token</td><td><a href="#string">string</a></td><td></td>- <td><p>Not used.+ <td><p>Pagination is not currently implemented. This field is reserved for future use.A page token, received from a previous `ListSettings` call.Provide this to retrieve the subsequent page.@@ -13589,7 +13624,7 @@ For example, "settings/bb.branding.logo" </p></td><td>value</td><td><a href="#bytebase.v1.Value">Value</a></td><td></td>- <td><p>The value of the setting. </p></td>+ <td><p>The configuration value of the setting. </p></td></tr></tbody>@@ -14151,7 +14186,7 @@ Default to this mode.</p></td><h3 id="bytebase.v1.SettingService">SettingService</h3>- <p></p>+ <p>SettingService manages workspace-level settings and configurations.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -14162,21 +14197,24 @@ Default to this mode.</p></td><td>ListSettings</td><td><a href="#bytebase.v1.ListSettingsRequest">ListSettingsRequest</a></td><td><a href="#bytebase.v1.ListSettingsResponse">ListSettingsResponse</a></td>- <td><p>Permissions required: bb.settings.list</p></td>+ <td><p>Lists all workspace settings.+Permissions required: bb.settings.list</p></td></tr><tr><td>GetSetting</td><td><a href="#bytebase.v1.GetSettingRequest">GetSettingRequest</a></td><td><a href="#bytebase.v1.Setting">Setting</a></td>- <td><p>Permissions required: bb.settings.get</p></td>+ <td><p>Retrieves a workspace setting by name.+Permissions required: bb.settings.get</p></td></tr><tr><td>UpdateSetting</td><td><a href="#bytebase.v1.UpdateSettingRequest">UpdateSettingRequest</a></td><td><a href="#bytebase.v1.Setting">Setting</a></td>- <td><p>Permissions required: bb.settings.set</p></td>+ <td><p>Updates a workspace setting.+Permissions required: bb.settings.set</p></td></tr></tbody>@@ -14579,42 +14617,42 @@ Format: users/{user}. {user} is a system-generated unique ID. </p></td><td>state</td><td><a href="#bytebase.v1.State">State</a></td><td></td>- <td><p> </p></td>+ <td><p>The lifecycle state of the user account. </p></td></tr><tr><td>email</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The email address of the user, used for login and notifications. </p></td></tr><tr><td>title</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The display title or full name of the user. </p></td></tr><tr><td>user_type</td><td><a href="#bytebase.v1.UserType">UserType</a></td><td></td>- <td><p> </p></td>+ <td><p>The type of user account. </p></td></tr><tr><td>password</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The password for authentication. Only used during user creation or password updates. </p></td></tr><tr><td>service_key</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The service key for service account authentication. Only used for service accounts. </p></td></tr><tr>@@ -14650,7 +14688,7 @@ Could be empty. </p></td><td>profile</td><td><a href="#bytebase.v1.User.Profile">User.Profile</a></td><td></td>- <td><p> </p></td>+ <td><p>User profile metadata. </p></td></tr><tr>@@ -14682,14 +14720,14 @@ Format: groups/{email} </p></td><td>last_login_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td>- <td><p> </p></td>+ <td><p>The last time the user successfully logged in. </p></td></tr><tr><td>last_change_password_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td>- <td><p> </p></td>+ <td><p>The last time the user changed their password. </p></td></tr><tr>@@ -14719,25 +14757,25 @@ Format: groups/{email} </p></td><tr><td>USER_TYPE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified user type.</p></td></tr><tr><td>USER</td><td>1</td>- <td><p></p></td>+ <td><p>Regular human user account.</p></td></tr><tr><td>SYSTEM_BOT</td><td>2</td>- <td><p></p></td>+ <td><p>System-managed bot account for automated operations.</p></td></tr><tr><td>SERVICE_ACCOUNT</td><td>3</td>- <td><p></p></td>+ <td><p>Service account for API integrations.</p></td></tr></tbody>@@ -14748,7 +14786,7 @@ Format: groups/{email} </p></td><h3 id="bytebase.v1.UserService">UserService</h3>- <p></p>+ <p>UserService manages user accounts and authentication.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -14794,26 +14832,23 @@ Permissions required: bb.users.list</p></td><td>CreateUser</td><td><a href="#bytebase.v1.CreateUserRequest">CreateUserRequest</a></td><td><a href="#bytebase.v1.User">User</a></td>- <td><p>Create a user.-When Disallow Signup is enabled, only the caller with bb.users.create on the workspace can create a user.-Otherwise, any unauthenticated user can create a user.-Permissions required: bb.users.create</p></td>+ <td><p>Creates a user. When Disallow Signup is enabled, requires bb.users.create permission; otherwise any user can sign up.+Permissions required: bb.users.create (only when Disallow Signup is enabled)</p></td></tr><tr><td>UpdateUser</td><td><a href="#bytebase.v1.UpdateUserRequest">UpdateUserRequest</a></td><td><a href="#bytebase.v1.User">User</a></td>- <td><p>Only the user itself and the user with bb.users.update permission on the workspace can update the user.-Permissions required: bb.users.update</p></td>+ <td><p>Updates a user. Users can update their own profile, or users with bb.users.update permission can update any user.+Permissions required: bb.users.update (or self)</p></td></tr><tr><td>DeleteUser</td><td><a href="#bytebase.v1.DeleteUserRequest">DeleteUserRequest</a></td><td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>- <td><p>Only the user with bb.users.delete permission on the workspace can delete the user.-The last remaining workspace admin cannot be deleted.+ <td><p>Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted.Permissions required: bb.users.delete</p></td></tr>@@ -14821,7 +14856,7 @@ Permissions required: bb.users.delete</p></td><td>UndeleteUser</td><td><a href="#bytebase.v1.UndeleteUserRequest">UndeleteUserRequest</a></td><td><a href="#bytebase.v1.User">User</a></td>- <td><p>Only the user with bb.users.undelete permission on the workspace can undelete the user.+ <td><p>Restores a deleted user.Permissions required: bb.users.undelete</p></td></tr>@@ -14936,7 +14971,7 @@ Permissions required: bb.users.undelete</p></td><h3 id="bytebase.v1.ActuatorInfo">ActuatorInfo</h3>- <p>ServerInfo is the API message for server info.</p><p>Actuator concept is similar to the Spring Boot Actuator.</p>+ <p>System information and configuration for the Bytebase instance.</p><p>Actuator concept is similar to the Spring Boot Actuator.</p><table class="field-table">@@ -14949,154 +14984,154 @@ Permissions required: bb.users.undelete</p></td><td>version</td><td><a href="#string">string</a></td><td></td>- <td><p>version is the bytebase's server version </p></td>+ <td><p>The Bytebase server version. </p></td></tr><tr><td>git_commit</td><td><a href="#string">string</a></td><td></td>- <td><p>git_commit is the git commit hash of the build </p></td>+ <td><p>The git commit hash of the build. </p></td></tr><tr><td>readonly</td><td><a href="#bool">bool</a></td><td></td>- <td><p>readonly flag means if the Bytebase is running in readonly mode. </p></td>+ <td><p>Whether the Bytebase instance is running in read-only mode. </p></td></tr><tr><td>saas</td><td><a href="#bool">bool</a></td><td></td>- <td><p>saas flag means if the Bytebase is running in SaaS mode, some features are not allowed to edit by users. </p></td>+ <td><p>Whether the Bytebase instance is running in SaaS mode where some features cannot be edited by users. </p></td></tr><tr><td>demo</td><td><a href="#bool">bool</a></td><td></td>- <td><p>demo flag means if the Bytebase is running in demo mode. </p></td>+ <td><p>Whether the Bytebase instance is running in demo mode. </p></td></tr><tr><td>host</td><td><a href="#string">string</a></td><td></td>- <td><p>host is the Bytebase instance host. </p></td>+ <td><p>The host address of the Bytebase instance. </p></td></tr><tr><td>port</td><td><a href="#string">string</a></td><td></td>- <td><p>port is the Bytebase instance port. </p></td>+ <td><p>The port number of the Bytebase instance. </p></td></tr><tr><td>external_url</td><td><a href="#string">string</a></td><td></td>- <td><p>external_url is the URL where user or webhook callback visits Bytebase. </p></td>+ <td><p>The external URL where users or webhook callbacks access Bytebase. </p></td></tr><tr><td>need_admin_setup</td><td><a href="#bool">bool</a></td><td></td>- <td><p>need_admin_setup flag means the Bytebase instance doesn't have any end users. </p></td>+ <td><p>Whether the Bytebase instance requires initial admin setup. </p></td></tr><tr><td>disallow_signup</td><td><a href="#bool">bool</a></td><td></td>- <td><p>disallow_signup is the flag to disable self-service signup. </p></td>+ <td><p>Whether self-service user signup is disabled. </p></td></tr><tr><td>last_active_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td>- <td><p>last_active_time is the service last active time in UTC Time Format, any API calls will refresh this value. </p></td>+ <td><p>The last time any API call was made, refreshed on each request. </p></td></tr><tr><td>require_2fa</td><td><a href="#bool">bool</a></td><td></td>- <td><p>require_2fa is the flag to require 2FA for all users. </p></td>+ <td><p>Whether two-factor authentication is required for all users. </p></td></tr><tr><td>workspace_id</td><td><a href="#string">string</a></td><td></td>- <td><p>workspace_id is the identifier for the workspace. </p></td>+ <td><p>The unique identifier for the workspace. </p></td></tr><tr><td>debug</td><td><a href="#bool">bool</a></td><td></td>- <td><p>debug flag means if the debug mode is enabled. </p></td>+ <td><p>Whether debug mode is enabled. </p></td></tr><tr><td>unlicensed_features</td><td><a href="#string">string</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>List of features that are not licensed. </p></td></tr><tr><td>disallow_password_signin</td><td><a href="#bool">bool</a></td><td></td>- <td><p>disallow_password_signin is the flag to disallow user signin with email&password. (except workspace admins) </p></td>+ <td><p>Whether password-based signin is disabled (except for workspace admins). </p></td></tr><tr><td>password_restriction</td><td><a href="#bytebase.v1.PasswordRestrictionSetting">PasswordRestrictionSetting</a></td><td></td>- <td><p> </p></td>+ <td><p>Password complexity and restriction requirements. </p></td></tr><tr><td>docker</td><td><a href="#bool">bool</a></td><td></td>- <td><p>docker flag means if the Bytebase instance is running in docker. </p></td>+ <td><p>Whether the Bytebase instance is running in Docker. </p></td></tr><tr><td>user_stats</td><td><a href="#bytebase.v1.ActuatorInfo.StatUser">ActuatorInfo.StatUser</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>Statistics about users in the system. </p></td></tr><tr><td>activated_instance_count</td><td><a href="#int32">int32</a></td><td></td>- <td><p> </p></td>+ <td><p>The number of activated database instances. </p></td></tr><tr><td>total_instance_count</td><td><a href="#int32">int32</a></td><td></td>- <td><p> </p></td>+ <td><p>The total number of database instances. </p></td></tr><tr><td>enable_sample</td><td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Whether sample data setup is enabled. </p></td></tr></tbody>@@ -15107,7 +15142,7 @@ Permissions required: bb.users.undelete</p></td><h3 id="bytebase.v1.ActuatorInfo.StatUser">ActuatorInfo.StatUser</h3>- <p></p>+ <p>User statistics by type and state.</p><table class="field-table">@@ -15120,21 +15155,21 @@ Permissions required: bb.users.undelete</p></td><td>user_type</td><td><a href="#bytebase.v1.UserType">UserType</a></td><td></td>- <td><p> </p></td>+ <td><p>The type of user. </p></td></tr><tr><td>state</td><td><a href="#bytebase.v1.State">State</a></td><td></td>- <td><p> </p></td>+ <td><p>The state of the user. </p></td></tr><tr><td>count</td><td><a href="#int32">int32</a></td><td></td>- <td><p> </p></td>+ <td><p>The count of users matching this type and state. </p></td></tr></tbody>@@ -15145,28 +15180,28 @@ Permissions required: bb.users.undelete</p></td><h3 id="bytebase.v1.DeleteCacheRequest">DeleteCacheRequest</h3>- <p></p>+ <p>Request message for deleting cache.</p><h3 id="bytebase.v1.GetActuatorInfoRequest">GetActuatorInfoRequest</h3>- <p></p>+ <p>Request message for getting actuator information.</p><h3 id="bytebase.v1.GetResourcePackageRequest">GetResourcePackageRequest</h3>- <p>The request message for getting the theme resource.</p>+ <p>Request message for getting branding resources.</p><h3 id="bytebase.v1.ResourcePackage">ResourcePackage</h3>- <p>The theme resources.</p>+ <p>Custom branding resources for the Bytebase instance.</p><table class="field-table">@@ -15190,14 +15225,14 @@ Permissions required: bb.users.undelete</p></td><h3 id="bytebase.v1.SetupSampleRequest">SetupSampleRequest</h3>- <p></p>+ <p>Request message for setting up sample data.</p><h3 id="bytebase.v1.UpdateActuatorInfoRequest">UpdateActuatorInfoRequest</h3>- <p></p>+ <p>Request message for updating actuator information.</p><table class="field-table">@@ -15242,7 +15277,7 @@ In this situation, `update_mask` is ignored. </p></td><h3 id="bytebase.v1.ActuatorService">ActuatorService</h3>- <p></p>+ <p>ActuatorService manages system health and operational information.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -15253,35 +15288,40 @@ In this situation, `update_mask` is ignored. </p></td><td>GetActuatorInfo</td><td><a href="#bytebase.v1.GetActuatorInfoRequest">GetActuatorInfoRequest</a></td><td><a href="#bytebase.v1.ActuatorInfo">ActuatorInfo</a></td>- <td><p>Permissions required: None</p></td>+ <td><p>Gets system information and health status of the Bytebase instance.+Permissions required: None</p></td></tr><tr><td>UpdateActuatorInfo</td><td><a href="#bytebase.v1.UpdateActuatorInfoRequest">UpdateActuatorInfoRequest</a></td><td><a href="#bytebase.v1.ActuatorInfo">ActuatorInfo</a></td>- <td><p>Permissions required: bb.settings.set</p></td>+ <td><p>Updates system configuration settings for the Bytebase instance.+Permissions required: bb.settings.set</p></td></tr><tr><td>SetupSample</td><td><a href="#bytebase.v1.SetupSampleRequest">SetupSampleRequest</a></td><td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>- <td><p>Permissions required: bb.projects.create</p></td>+ <td><p>Sets up sample data for demonstration and testing purposes.+Permissions required: bb.projects.create</p></td></tr><tr><td>DeleteCache</td><td><a href="#bytebase.v1.DeleteCacheRequest">DeleteCacheRequest</a></td><td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>- <td><p>Permissions required: None</p></td>+ <td><p>Clears the system cache to force data refresh.+Permissions required: None</p></td></tr><tr><td>GetResourcePackage</td><td><a href="#bytebase.v1.GetResourcePackageRequest">GetResourcePackageRequest</a></td><td><a href="#bytebase.v1.ResourcePackage">ResourcePackage</a></td>- <td><p>Permissions required: None</p></td>+ <td><p>Gets custom branding resources such as logos.+Permissions required: None</p></td></tr></tbody>@@ -15365,7 +15405,7 @@ In this situation, `update_mask` is ignored. </p></td><h3 id="bytebase.v1.Binding">Binding</h3>- <p></p>+ <p>Binding associates members with a role and optional conditions.</p><table class="field-table">@@ -15427,7 +15467,7 @@ request.time < timestamp("2025-04-26T11:24:48.655Z") </p></td><h3 id="bytebase.v1.BindingDelta">BindingDelta</h3>- <p>One delta entry for Binding. Each individual change (only one member in each</p><p>entry) to a binding will be a separate entry.</p>+ <p>A single change to a binding.</p><table class="field-table">@@ -15473,7 +15513,7 @@ For example, `roles/projectOwner`. </p></td><h3 id="bytebase.v1.GetIamPolicyRequest">GetIamPolicyRequest</h3>- <p></p>+ <p>Request message for getting an IAM policy.</p><table class="field-table">@@ -15499,7 +15539,7 @@ Format: workspaces/{workspace} </p></td><h3 id="bytebase.v1.IamPolicy">IamPolicy</h3>- <p></p>+ <p>IAM policy that binds members to roles.</p><table class="field-table">@@ -15533,7 +15573,7 @@ the call will be blocked and an ABORTED error will be returned. </p></td><h3 id="bytebase.v1.PolicyDelta">PolicyDelta</h3>- <p>The difference delta between two policies.</p>+ <p>Describes changes between two IAM policies.</p><table class="field-table">@@ -15557,7 +15597,7 @@ the call will be blocked and an ABORTED error will be returned. </p></td><h3 id="bytebase.v1.SetIamPolicyRequest">SetIamPolicyRequest</h3>- <p></p>+ <p>Request message for setting an IAM policy.</p><table class="field-table">@@ -15599,7 +15639,7 @@ Format: workspaces/{workspace} </p></td><h3 id="bytebase.v1.BindingDelta.Action">BindingDelta.Action</h3>- <p>The type of action performed on a Binding in a policy.</p>+ <p>Type of action performed on a binding.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -15609,19 +15649,19 @@ Format: workspaces/{workspace} </p></td><tr><td>ACTION_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified action.</p></td></tr><tr><td>ADD</td><td>1</td>- <td><p></p></td>+ <td><p>Add a binding.</p></td></tr><tr><td>REMOVE</td><td>2</td>- <td><p></p></td>+ <td><p>Remove a binding.</p></td></tr></tbody>@@ -15640,7 +15680,7 @@ Format: workspaces/{workspace} </p></td><h3 id="bytebase.v1.AuditData">AuditData</h3>- <p></p>+ <p>Additional audit data specific to certain operations.</p><table class="field-table">@@ -15653,7 +15693,7 @@ Format: workspaces/{workspace} </p></td><td>policy_delta</td><td><a href="#bytebase.v1.PolicyDelta">PolicyDelta</a></td><td></td>- <td><p> </p></td>+ <td><p>Changes to IAM policies. </p></td></tr></tbody>@@ -15664,7 +15704,7 @@ Format: workspaces/{workspace} </p></td><h3 id="bytebase.v1.AuditLog">AuditLog</h3>- <p></p>+ <p>Audit log entry recording system activity or API call.</p><table class="field-table">@@ -15687,78 +15727,80 @@ Formats:<td>create_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td>- <td><p> </p></td>+ <td><p>The timestamp when the audit log was created. </p></td></tr><tr><td>user</td><td><a href="#string">string</a></td><td></td>- <td><p>Format: users/[email protected] </p></td>+ <td><p>The user who performed the action.+Format: users/{email} </p></td></tr><tr><td>method</td><td><a href="#string">string</a></td><td></td>- <td><p>e.g. `/bytebase.v1.SQLService/Query`, `bb.project.repository.push` </p></td>+ <td><p>The method or action being audited.+For example: /bytebase.v1.SQLService/Query or bb.project.repository.push </p></td></tr><tr><td>severity</td><td><a href="#bytebase.v1.AuditLog.Severity">AuditLog.Severity</a></td><td></td>- <td><p> </p></td>+ <td><p>The severity level of this audit log entry. </p></td></tr><tr><td>resource</td><td><a href="#string">string</a></td><td></td>- <td><p>The associated resource. </p></td>+ <td><p>The resource associated with this audit log. </p></td></tr><tr><td>request</td><td><a href="#string">string</a></td><td></td>- <td><p>JSON-encoded request. </p></td>+ <td><p>The request payload in JSON format. </p></td></tr><tr><td>response</td><td><a href="#string">string</a></td><td></td>- <td><p>JSON-encoded response.-Some fields are omitted because they are too large or contain sensitive information. </p></td>+ <td><p>The response payload in JSON format.+Some fields may be omitted if they are too large or contain sensitive information. </p></td></tr><tr><td>status</td><td><a href="#google.rpc.Status">google.rpc.Status</a></td><td></td>- <td><p> </p></td>+ <td><p>The status of the operation. </p></td></tr><tr><td>latency</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td>- <td><p>The latency of the RPC. </p></td>+ <td><p>The duration of the operation. </p></td></tr><tr><td>service_data</td><td><a href="#google.protobuf.Any">google.protobuf.Any</a></td><td></td>- <td><p>service-specific data about the request, response, and other activities. </p></td>+ <td><p>Service-specific metadata about the request, response, and activities. </p></td></tr><tr><td>request_metadata</td><td><a href="#bytebase.v1.RequestMetadata">RequestMetadata</a></td><td></td>- <td><p>Metadata about the operation. </p></td>+ <td><p>Metadata about the request context. </p></td></tr></tbody>@@ -15769,7 +15811,7 @@ Some fields are omitted because they are too large or contain sensitive informat<h3 id="bytebase.v1.ExportAuditLogsRequest">ExportAuditLogsRequest</h3>- <p></p>+ <p>Request message for exporting audit logs.</p><table class="field-table">@@ -15837,7 +15879,7 @@ Provide this to retrieve the subsequent page. </p></td><h3 id="bytebase.v1.ExportAuditLogsResponse">ExportAuditLogsResponse</h3>- <p></p>+ <p>Response message for exporting audit logs.</p><table class="field-table">@@ -15850,7 +15892,7 @@ Provide this to retrieve the subsequent page. </p></td><td>content</td><td><a href="#bytes">bytes</a></td><td></td>- <td><p> </p></td>+ <td><p>The exported audit log content in the requested format. </p></td></tr><tr>@@ -15870,7 +15912,7 @@ to retrieve the next page of log entities. </p></td><h3 id="bytebase.v1.RequestMetadata">RequestMetadata</h3>- <p>Metadata about the request.</p>+ <p>Metadata about the incoming request.</p><table class="field-table">@@ -15883,15 +15925,15 @@ to retrieve the next page of log entities. </p></td><td>caller_ip</td><td><a href="#string">string</a></td><td></td>- <td><p>The IP address of the caller. </p></td>+ <td><p>The IP address of the request originator. </p></td></tr><tr><td>caller_supplied_user_agent</td><td><a href="#string">string</a></td><td></td>- <td><p>The user agent of the caller.-This information is not authenticated and should be treated accordingly. </p></td>+ <td><p>The user agent string provided by the caller.+This is supplied by the client and is not authenticated. </p></td></tr></tbody>@@ -15902,7 +15944,7 @@ This information is not authenticated and should be treated accordingly. </p></t<h3 id="bytebase.v1.SearchAuditLogsRequest">SearchAuditLogsRequest</h3>- <p></p>+ <p>Request message for searching audit logs.</p><table class="field-table">@@ -15975,7 +16017,7 @@ Provide this to retrieve the subsequent page. </p></td><h3 id="bytebase.v1.SearchAuditLogsResponse">SearchAuditLogsResponse</h3>- <p></p>+ <p>Response message for searching audit logs.</p><table class="field-table">@@ -16010,7 +16052,7 @@ to retrieve the next page of log entities. </p></td><h3 id="bytebase.v1.AuditLog.Severity">AuditLog.Severity</h3>- <p></p>+ <p>Severity level for audit log entries.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -16020,55 +16062,55 @@ to retrieve the next page of log entities. </p></td><tr><td>DEFAULT</td><td>0</td>- <td><p></p></td>+ <td><p>Default severity level.</p></td></tr><tr><td>DEBUG</td><td>1</td>- <td><p></p></td>+ <td><p>Debug-level information.</p></td></tr><tr><td>INFO</td><td>2</td>- <td><p></p></td>+ <td><p>Informational messages.</p></td></tr><tr><td>NOTICE</td><td>3</td>- <td><p></p></td>+ <td><p>Notable events.</p></td></tr><tr><td>WARNING</td><td>4</td>- <td><p></p></td>+ <td><p>Warning conditions.</p></td></tr><tr><td>ERROR</td><td>5</td>- <td><p></p></td>+ <td><p>Error conditions.</p></td></tr><tr><td>CRITICAL</td><td>6</td>- <td><p></p></td>+ <td><p>Critical conditions.</p></td></tr><tr><td>ALERT</td><td>7</td>- <td><p></p></td>+ <td><p>Action must be taken immediately.</p></td></tr><tr><td>EMERGENCY</td><td>8</td>- <td><p></p></td>+ <td><p>System is unusable.</p></td></tr></tbody>@@ -16079,7 +16121,7 @@ to retrieve the next page of log entities. </p></td><h3 id="bytebase.v1.AuditLogService">AuditLogService</h3>- <p></p>+ <p>AuditLogService manages audit logs for system activities and API calls.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -16090,14 +16132,16 @@ to retrieve the next page of log entities. </p></td><td>SearchAuditLogs</td><td><a href="#bytebase.v1.SearchAuditLogsRequest">SearchAuditLogsRequest</a></td><td><a href="#bytebase.v1.SearchAuditLogsResponse">SearchAuditLogsResponse</a></td>- <td><p>Permissions required: None</p></td>+ <td><p>Searches audit logs with optional filtering and pagination.+Permissions required: bb.auditLogs.search</p></td></tr><tr><td>ExportAuditLogs</td><td><a href="#bytebase.v1.ExportAuditLogsRequest">ExportAuditLogsRequest</a></td><td><a href="#bytebase.v1.ExportAuditLogsResponse">ExportAuditLogsResponse</a></td>- <td><p>Permissions required: bb.auditLogs.export</p></td>+ <td><p>Exports audit logs in a specified format for external analysis.+Permissions required: bb.auditLogs.export</p></td></tr></tbody>@@ -16165,7 +16209,7 @@ to retrieve the next page of log entities. </p></td><h3 id="bytebase.v1.IdentityProviderContext">IdentityProviderContext</h3>- <p></p>+ <p>Context for identity provider authentication.</p><table class="field-table">@@ -16178,14 +16222,14 @@ to retrieve the next page of log entities. </p></td><td>oauth2_context</td><td><a href="#bytebase.v1.OAuth2IdentityProviderContext">OAuth2IdentityProviderContext</a></td><td></td>- <td><p> </p></td>+ <td><p>OAuth2 authentication context. </p></td></tr><tr><td>oidc_context</td><td><a href="#bytebase.v1.OIDCIdentityProviderContext">OIDCIdentityProviderContext</a></td><td></td>- <td><p> </p></td>+ <td><p>OpenID Connect authentication context. </p></td></tr></tbody>@@ -16209,14 +16253,14 @@ to retrieve the next page of log entities. </p></td><td>email</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>User's email address. </p></td></tr><tr><td>password</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>User's password for authentication. </p></td></tr><tr>@@ -16283,21 +16327,21 @@ Format: idps/{idp} </p></td><td>token</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Access token for authenticated requests. </p></td></tr><tr><td>mfa_temp_token</td><td><a href="#string">string</a></td><td>optional</td>- <td><p> </p></td>+ <td><p>Temporary token for MFA verification. </p></td></tr><tr><td>require_reset_password</td><td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Whether user must reset password before continuing. </p></td></tr><tr>@@ -16315,14 +16359,14 @@ Format: idps/{idp} </p></td><h3 id="bytebase.v1.LogoutRequest">LogoutRequest</h3>- <p></p>+ <p>Request to logout current user session.</p><h3 id="bytebase.v1.OAuth2IdentityProviderContext">OAuth2IdentityProviderContext</h3>- <p></p>+ <p>OAuth2 authentication context.</p><table class="field-table">@@ -16335,7 +16379,7 @@ Format: idps/{idp} </p></td><td>code</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Authorization code from OAuth2 provider. </p></td></tr></tbody>@@ -16346,7 +16390,7 @@ Format: idps/{idp} </p></td><h3 id="bytebase.v1.OIDCIdentityProviderContext">OIDCIdentityProviderContext</h3>- <p></p>+ <p>OpenID Connect authentication context.</p>@@ -16359,7 +16403,7 @@ Format: idps/{idp} </p></td><h3 id="bytebase.v1.AuthService">AuthService</h3>- <p></p>+ <p>AuthService handles user authentication operations.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -16370,14 +16414,16 @@ Format: idps/{idp} </p></td><td>Login</td><td><a href="#bytebase.v1.LoginRequest">LoginRequest</a></td><td><a href="#bytebase.v1.LoginResponse">LoginResponse</a></td>- <td><p>Permissions required: None</p></td>+ <td><p>Authenticates a user and returns access tokens.+Permissions required: None</p></td></tr><tr><td>Logout</td><td><a href="#bytebase.v1.LogoutRequest">LogoutRequest</a></td><td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>- <td><p>Permissions required: None</p></td>+ <td><p>Logs out the current user session.+Permissions required: None</p></td></tr></tbody>@@ -16431,7 +16477,7 @@ Format: idps/{idp} </p></td><h3 id="bytebase.v1.BatchDeparseRequest">BatchDeparseRequest</h3>- <p></p>+ <p>Request message for batch deparsing CEL expressions.</p><table class="field-table">@@ -16444,7 +16490,7 @@ Format: idps/{idp} </p></td><td>expressions</td><td><a href="#google.api.expr.v1alpha1.Expr">google.api.expr.v1alpha1.Expr</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The CEL expression ASTs to deparse. </p></td></tr></tbody>@@ -16455,7 +16501,7 @@ Format: idps/{idp} </p></td><h3 id="bytebase.v1.BatchDeparseResponse">BatchDeparseResponse</h3>- <p></p>+ <p>Response message for batch deparsing CEL expressions.</p><table class="field-table">@@ -16468,7 +16514,7 @@ Format: idps/{idp} </p></td><td>expressions</td><td><a href="#string">string</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The deparsed CEL expressions as strings. </p></td></tr></tbody>@@ -16479,7 +16525,7 @@ Format: idps/{idp} </p></td><h3 id="bytebase.v1.BatchParseRequest">BatchParseRequest</h3>- <p></p>+ <p>Request message for batch parsing CEL expressions.</p><table class="field-table">@@ -16492,7 +16538,7 @@ Format: idps/{idp} </p></td><td>expressions</td><td><a href="#string">string</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The CEL expression strings to parse. </p></td></tr></tbody>@@ -16503,7 +16549,7 @@ Format: idps/{idp} </p></td><h3 id="bytebase.v1.BatchParseResponse">BatchParseResponse</h3>- <p></p>+ <p>Response message for batch parsing CEL expressions.</p><table class="field-table">@@ -16516,7 +16562,7 @@ Format: idps/{idp} </p></td><td>expressions</td><td><a href="#google.api.expr.v1alpha1.Expr">google.api.expr.v1alpha1.Expr</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The parsed CEL expressions as AST. </p></td></tr></tbody>@@ -16533,7 +16579,7 @@ Format: idps/{idp} </p></td><h3 id="bytebase.v1.CelService">CelService</h3>- <p></p>+ <p>CelService manages CEL (Common Expression Language) parsing and formatting operations.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -16544,14 +16590,16 @@ Format: idps/{idp} </p></td><td>BatchParse</td><td><a href="#bytebase.v1.BatchParseRequest">BatchParseRequest</a></td><td><a href="#bytebase.v1.BatchParseResponse">BatchParseResponse</a></td>- <td><p>Permissions required: None</p></td>+ <td><p>Parses multiple CEL expression strings into AST representations.+Permissions required: None</p></td></tr><tr><td>BatchDeparse</td><td><a href="#bytebase.v1.BatchDeparseRequest">BatchDeparseRequest</a></td><td><a href="#bytebase.v1.BatchDeparseResponse">BatchDeparseResponse</a></td>- <td><p>Permissions required: None</p></td>+ <td><p>Converts multiple CEL AST representations back into expression strings.+Permissions required: None</p></td></tr></tbody>@@ -16605,7 +16653,7 @@ Format: idps/{idp} </p></td><h3 id="bytebase.v1.Changelist">Changelist</h3>- <p></p>+ <p>A changelist groups multiple database changes together.</p><table class="field-table">@@ -16627,7 +16675,7 @@ Format: projects/{project}/changelists/{changelist} </p></td><td>description</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The description of the changelist. </p></td></tr><tr>@@ -16642,14 +16690,14 @@ Format: users/{email} </p></td><td>update_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td>- <td><p>The last update time of the changelist. </p></td>+ <td><p>The last time the changelist was updated. </p></td></tr><tr><td>changes</td><td><a href="#bytebase.v1.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>@@ -16660,7 +16708,7 @@ Format: users/{email} </p></td><h3 id="bytebase.v1.Changelist.Change">Changelist.Change</h3>- <p></p>+ <p>A single change in a changelist.</p><table class="field-table">@@ -16673,16 +16721,16 @@ Format: users/{email} </p></td><td>sheet</td><td><a href="#string">string</a></td><td></td>- <td><p>The name of a sheet. </p></td>+ <td><p>The sheet containing the SQL statement. </p></td></tr><tr><td>source</td><td><a href="#string">string</a></td><td></td>- <td><p>The source of origin.-1) changelog: instances/{instance}/databases/{database}/changelogs/{changelog}.-2) raw SQL if empty. </p></td>+ <td><p>The source of this change.+Format: instances/{instance}/databases/{database}/changelogs/{changelog}+If empty, the change is from raw SQL. </p></td></tr></tbody>@@ -16693,7 +16741,7 @@ Format: users/{email} </p></td><h3 id="bytebase.v1.CreateChangelistRequest">CreateChangelistRequest</h3>- <p></p>+ <p>Request message for creating a changelist.</p><table class="field-table">@@ -16736,7 +16784,7 @@ are /[a-z][0-9]-/. </p></td><h3 id="bytebase.v1.DeleteChangelistRequest">DeleteChangelistRequest</h3>- <p></p>+ <p>Request message for deleting a changelist.</p><table class="field-table">@@ -16761,7 +16809,7 @@ Format: projects/{project}/changelists/{changelist} </p></td><h3 id="bytebase.v1.GetChangelistRequest">GetChangelistRequest</h3>- <p></p>+ <p>Request message for getting a changelist.</p><table class="field-table">@@ -16786,7 +16834,7 @@ Format: projects/{project}/changelists/{changelist} </p></td><h3 id="bytebase.v1.ListChangelistsRequest">ListChangelistsRequest</h3>- <p></p>+ <p>Request message for listing changelists.</p><table class="field-table">@@ -16807,7 +16855,7 @@ Format: projects/{project} </p></td><td>page_size</td><td><a href="#int32">int32</a></td><td></td>- <td><p>Not used.+ <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 thanthis value.If unspecified, at most 50 databases will be returned.@@ -16818,7 +16866,7 @@ The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td><td>page_token</td><td><a href="#string">string</a></td><td></td>- <td><p>Not used.+ <td><p>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.@@ -16834,7 +16882,7 @@ the call that provided the page token. </p></td><h3 id="bytebase.v1.ListChangelistsResponse">ListChangelistsResponse</h3>- <p></p>+ <p>Response message for listing changelists.</p><table class="field-table">@@ -16866,7 +16914,7 @@ If this field is omitted, there are no subsequent pages. </p></td><h3 id="bytebase.v1.UpdateChangelistRequest">UpdateChangelistRequest</h3>- <p></p>+ <p>Request message for updating a changelist.</p><table class="field-table">@@ -16914,7 +16962,7 @@ In this situation, `update_mask` is ignored. </p></td><h3 id="bytebase.v1.ChangelistService">ChangelistService</h3>- <p></p>+ <p>ChangelistService manages changelists for grouping and organizing database changes.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -16925,35 +16973,40 @@ In this situation, `update_mask` is ignored. </p></td><td>CreateChangelist</td><td><a href="#bytebase.v1.CreateChangelistRequest">CreateChangelistRequest</a></td><td><a href="#bytebase.v1.Changelist">Changelist</a></td>- <td><p>Permissions required: bb.changelists.create</p></td>+ <td><p>Creates a new changelist in a project.+Permissions required: bb.changelists.create</p></td></tr><tr><td>GetChangelist</td><td><a href="#bytebase.v1.GetChangelistRequest">GetChangelistRequest</a></td><td><a href="#bytebase.v1.Changelist">Changelist</a></td>- <td><p>Permissions required: bb.changelists.get</p></td>+ <td><p>Gets a changelist by name.+Permissions required: bb.changelists.get</p></td></tr><tr><td>ListChangelists</td><td><a href="#bytebase.v1.ListChangelistsRequest">ListChangelistsRequest</a></td><td><a href="#bytebase.v1.ListChangelistsResponse">ListChangelistsResponse</a></td>- <td><p>Permissions required: bb.changelists.list</p></td>+ <td><p>Lists changelists in a project.+Permissions required: bb.changelists.list</p></td></tr><tr><td>UpdateChangelist</td><td><a href="#bytebase.v1.UpdateChangelistRequest">UpdateChangelistRequest</a></td><td><a href="#bytebase.v1.Changelist">Changelist</a></td>- <td><p>Permissions required: bb.changelists.update</p></td>+ <td><p>Updates a changelist.+Permissions required: bb.changelists.update</p></td></tr><tr><td>DeleteChangelist</td><td><a href="#bytebase.v1.DeleteChangelistRequest">DeleteChangelistRequest</a></td><td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>- <td><p>Permissions required: bb.changelists.delete</p></td>+ <td><p>Deletes a changelist.+Permissions required: bb.changelists.delete</p></td></tr></tbody>@@ -17037,7 +17090,7 @@ In this situation, `update_mask` is ignored. </p></td><h3 id="bytebase.v1.CreateDatabaseGroupRequest">CreateDatabaseGroupRequest</h3>- <p></p>+ <p>Request message for creating a database group.</p><table class="field-table">@@ -17087,7 +17140,7 @@ are /[a-z][0-9]-/. </p></td><h3 id="bytebase.v1.DatabaseGroup">DatabaseGroup</h3>- <p></p>+ <p>A group of databases matched by expressions.</p><table class="field-table">@@ -17145,7 +17198,7 @@ resource.database_labels["tenant"] == "tenant1" </p></td><h3 id="bytebase.v1.DatabaseGroup.Database">DatabaseGroup.Database</h3>- <p></p>+ <p>A database within a database group.</p><table class="field-table">@@ -17170,7 +17223,7 @@ Format: instances/{instance}/databases/{database} </p></td><h3 id="bytebase.v1.DeleteDatabaseGroupRequest">DeleteDatabaseGroupRequest</h3>- <p></p>+ <p>Request message for deleting a database group.</p><table class="field-table">@@ -17195,7 +17248,7 @@ Format: projects/{project}/databaseGroups/{databaseGroup} </p></td><h3 id="bytebase.v1.GetDatabaseGroupRequest">GetDatabaseGroupRequest</h3>- <p></p>+ <p>Request message for getting a database group.</p><table class="field-table">@@ -17227,7 +17280,7 @@ Format: projects/{project}/databaseGroups/{databaseGroup} </p></td><h3 id="bytebase.v1.ListDatabaseGroupsRequest">ListDatabaseGroupsRequest</h3>- <p></p>+ <p>Request message for listing database groups.</p><table class="field-table">@@ -17248,7 +17301,7 @@ Format: projects/{project} </p></td><td>page_size</td><td><a href="#int32">int32</a></td><td></td>- <td><p>Not used.+ <td><p>Pagination is not currently implemented. This field is reserved for future use.The maximum number of database groups to return. The service may return fewer thanthis value.If unspecified, at most 50 database groups will be returned.@@ -17259,7 +17312,7 @@ The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td><td>page_token</td><td><a href="#string">string</a></td><td></td>- <td><p>Not used.+ <td><p>Pagination is not currently implemented. This field is reserved for future use.A page token, received from a previous `ListDatabaseGroups` call.Provide this to retrieve the subsequent page.@@ -17282,7 +17335,7 @@ the call that provided the page token. </p></td><h3 id="bytebase.v1.ListDatabaseGroupsResponse">ListDatabaseGroupsResponse</h3>- <p></p>+ <p>Response message for listing database groups.</p><table class="field-table">@@ -17295,14 +17348,15 @@ the call that provided the page token. </p></td><td>database_groups</td><td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td><td>repeated</td>- <td><p>database_groups is the list of database groups. </p></td>+ <td><p>The database groups from the specified request. </p></td></tr><tr><td>next_page_token</td><td><a href="#string">string</a></td><td></td>- <td><p>Not used. A token, which can be sent as `page_token` to retrieve the next page.+ <td><p>Pagination is not currently implemented. This field is reserved for future use.+A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages. </p></td></tr>@@ -17314,7 +17368,7 @@ If this field is omitted, there are no subsequent pages. </p></td><h3 id="bytebase.v1.UpdateDatabaseGroupRequest">UpdateDatabaseGroupRequest</h3>- <p></p>+ <p>Request message for updating a database group.</p><table class="field-table">@@ -17358,7 +17412,7 @@ In this situation, `update_mask` is ignored. </p></td><h3 id="bytebase.v1.DatabaseGroupView">DatabaseGroupView</h3>- <p></p>+ <p>View options for database group responses.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -17392,7 +17446,7 @@ The API will default to the BASIC view.</p></td><h3 id="bytebase.v1.DatabaseGroupService">DatabaseGroupService</h3>- <p></p>+ <p>DatabaseGroupService manages database groups for organizing databases by criteria.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -17403,35 +17457,40 @@ The API will default to the BASIC view.</p></td><td>ListDatabaseGroups</td><td><a href="#bytebase.v1.ListDatabaseGroupsRequest">ListDatabaseGroupsRequest</a></td><td><a href="#bytebase.v1.ListDatabaseGroupsResponse">ListDatabaseGroupsResponse</a></td>- <td><p>Permissions required: bb.projects.get</p></td>+ <td><p>Lists database groups in a project.+Permissions required: bb.projects.get</p></td></tr><tr><td>GetDatabaseGroup</td><td><a href="#bytebase.v1.GetDatabaseGroupRequest">GetDatabaseGroupRequest</a></td><td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>- <td><p>Permissions required: bb.projects.get</p></td>+ <td><p>Gets a database group by name.+Permissions required: bb.projects.get</p></td></tr><tr><td>CreateDatabaseGroup</td><td><a href="#bytebase.v1.CreateDatabaseGroupRequest">CreateDatabaseGroupRequest</a></td><td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>- <td><p>Permissions required: bb.projects.update</p></td>+ <td><p>Creates a new database group.+Permissions required: bb.projects.update</p></td></tr><tr><td>UpdateDatabaseGroup</td><td><a href="#bytebase.v1.UpdateDatabaseGroupRequest">UpdateDatabaseGroupRequest</a></td><td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>- <td><p>Permissions required: bb.projects.update</p></td>+ <td><p>Updates a database group.+Permissions required: bb.projects.update</p></td></tr><tr><td>DeleteDatabaseGroup</td><td><a href="#bytebase.v1.DeleteDatabaseGroupRequest">DeleteDatabaseGroupRequest</a></td><td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>- <td><p>Permissions required: bb.projects.update</p></td>+ <td><p>Deletes a database group.+Permissions required: bb.projects.update</p></td></tr></tbody>@@ -17515,7 +17574,7 @@ The API will default to the BASIC view.</p></td><h3 id="bytebase.v1.BatchGetGroupsRequest">BatchGetGroupsRequest</h3>- <p></p>+ <p>Request message for batch getting groups.</p><table class="field-table">@@ -17540,7 +17599,7 @@ Format: groups/{email} </p></td><h3 id="bytebase.v1.BatchGetGroupsResponse">BatchGetGroupsResponse</h3>- <p></p>+ <p>Response message for batch getting groups.</p><table class="field-table">@@ -17564,7 +17623,7 @@ Format: groups/{email} </p></td><h3 id="bytebase.v1.CreateGroupRequest">CreateGroupRequest</h3>- <p></p>+ <p>Request message for creating a group.</p><table class="field-table">@@ -17596,7 +17655,7 @@ of the group's resource name. </p></td><h3 id="bytebase.v1.DeleteGroupRequest">DeleteGroupRequest</h3>- <p></p>+ <p>Request message for deleting a group.</p><table class="field-table">@@ -17621,7 +17680,7 @@ Format: groups/{email} </p></td><h3 id="bytebase.v1.GetGroupRequest">GetGroupRequest</h3>- <p></p>+ <p>Request message for getting a group.</p><table class="field-table">@@ -17646,7 +17705,7 @@ Format: groups/{email} </p></td><h3 id="bytebase.v1.Group">Group</h3>- <p></p>+ <p>A group of users within the workspace.</p><table class="field-table">@@ -17667,28 +17726,28 @@ Format: groups/{group}, group is an email. </p></td><td>title</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The display title of the group. </p></td></tr><tr><td>description</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The description of the group. </p></td></tr><tr><td>members</td><td><a href="#bytebase.v1.GroupMember">GroupMember</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The members of the group. </p></td></tr><tr><td>source</td><td><a href="#string">string</a></td><td></td>- <td><p>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 system where the group originated (e.g., Entra ID for SCIM sync). </p></td></tr></tbody>@@ -17699,7 +17758,7 @@ Format: groups/{group}, group is an email. </p></td><h3 id="bytebase.v1.GroupMember">GroupMember</h3>- <p></p>+ <p>A member of a group with a role.</p><table class="field-table">@@ -17721,7 +17780,7 @@ Format: users/[email protected] </p></td><td>role</td><td><a href="#bytebase.v1.GroupMember.Role">GroupMember.Role</a></td><td></td>- <td><p> </p></td>+ <td><p>The member's role in the group. </p></td></tr></tbody>@@ -17732,7 +17791,7 @@ Format: users/[email protected] </p></td><h3 id="bytebase.v1.ListGroupsRequest">ListGroupsRequest</h3>- <p></p>+ <p>Request message for listing groups.</p><table class="field-table">@@ -17792,7 +17851,7 @@ title.matches("dba") || email.matches("dba") </p></td><h3 id="bytebase.v1.ListGroupsResponse">ListGroupsResponse</h3>- <p></p>+ <p>Response message for listing groups.</p><table class="field-table">@@ -17824,7 +17883,7 @@ If this field is omitted, there are no subsequent pages. </p></td><h3 id="bytebase.v1.UpdateGroupRequest">UpdateGroupRequest</h3>- <p></p>+ <p>Request message for updating a group.</p><table class="field-table">@@ -17868,7 +17927,7 @@ In this situation, `update_mask` is ignored. </p></td><h3 id="bytebase.v1.GroupMember.Role">GroupMember.Role</h3>- <p></p>+ <p>The role of a group member.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -17878,19 +17937,19 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>ROLE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified role.</p></td></tr><tr><td>OWNER</td><td>1</td>- <td><p></p></td>+ <td><p>Group owner.</p></td></tr><tr><td>MEMBER</td><td>2</td>- <td><p></p></td>+ <td><p>Group member.</p></td></tr></tbody>@@ -17901,7 +17960,7 @@ In this situation, `update_mask` is ignored. </p></td><h3 id="bytebase.v1.GroupService">GroupService</h3>- <p></p>+ <p>GroupService manages user groups for organizing users and permissions.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -17912,14 +17971,15 @@ In this situation, `update_mask` is ignored. </p></td><td>GetGroup</td><td><a href="#bytebase.v1.GetGroupRequest">GetGroupRequest</a></td><td><a href="#bytebase.v1.Group">Group</a></td>- <td><p>Permissions required: bb.groups.get</p></td>+ <td><p>Gets a group by name.+Permissions required: bb.groups.get</p></td></tr><tr><td>BatchGetGroups</td><td><a href="#bytebase.v1.BatchGetGroupsRequest">BatchGetGroupsRequest</a></td><td><a href="#bytebase.v1.BatchGetGroupsResponse">BatchGetGroupsResponse</a></td>- <td><p>Get the groups in batch.+ <td><p>Gets multiple groups in a single request.Permissions required: bb.groups.get</p></td></tr>@@ -17927,30 +17987,32 @@ Permissions required: bb.groups.get</p></td><td>ListGroups</td><td><a href="#bytebase.v1.ListGroupsRequest">ListGroupsRequest</a></td><td><a href="#bytebase.v1.ListGroupsResponse">ListGroupsResponse</a></td>- <td><p>Permissions required: bb.groups.list</p></td>+ <td><p>Lists all groups in the workspace.+Permissions required: bb.groups.list</p></td></tr><tr><td>CreateGroup</td><td><a href="#bytebase.v1.CreateGroupRequest">CreateGroupRequest</a></td><td><a href="#bytebase.v1.Group">Group</a></td>- <td><p>Permissions required: bb.groups.create</p></td>+ <td><p>Creates a new group.+Permissions required: bb.groups.create</p></td></tr><tr><td>UpdateGroup</td><td><a href="#bytebase.v1.UpdateGroupRequest">UpdateGroupRequest</a></td><td><a href="#bytebase.v1.Group">Group</a></td>- <td><p>UpdateGroup updates the group.-Users with "bb.groups.update" permission on the workspace or the group owner can access this method.-Permissions required: bb.groups.update</p></td>+ <td><p>Updates a group. Group owners or users with bb.groups.update permission can update.+Permissions required: bb.groups.update OR caller is group owner</p></td></tr><tr><td>DeleteGroup</td><td><a href="#bytebase.v1.DeleteGroupRequest">DeleteGroupRequest</a></td><td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>- <td><p>Permissions required: bb.groups.delete</p></td>+ <td><p>Deletes a group. Group owners or users with bb.groups.delete permission can delete.+Permissions required: bb.groups.delete OR caller is group owner</p></td></tr></tbody>@@ -18170,7 +18232,8 @@ Mainly used for OIDC: https://developer.okta.com/docs/guides/customize-tokens-gr<td>name</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The name of the identity provider to retrieve.+Format: idps/{idp} </p></td></tr></tbody>@@ -18202,28 +18265,28 @@ Format: idps/{idp} </p></td><td>title</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The display title of the identity provider. </p></td></tr><tr><td>domain</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The domain for email matching when using this identity provider. </p></td></tr><tr><td>type</td><td><a href="#bytebase.v1.IdentityProviderType">IdentityProviderType</a></td><td></td>- <td><p> </p></td>+ <td><p>The type of identity provider protocol. </p></td></tr><tr><td>config</td><td><a href="#bytebase.v1.IdentityProviderConfig">IdentityProviderConfig</a></td><td></td>- <td><p> </p></td>+ <td><p>The configuration details for the identity provider. </p></td></tr></tbody>@@ -18247,21 +18310,21 @@ Format: idps/{idp} </p></td><td>oauth2_config</td><td><a href="#bytebase.v1.OAuth2IdentityProviderConfig">OAuth2IdentityProviderConfig</a></td><td></td>- <td><p> </p></td>+ <td><p>OAuth2 protocol configuration. </p></td></tr><tr><td>oidc_config</td><td><a href="#bytebase.v1.OIDCIdentityProviderConfig">OIDCIdentityProviderConfig</a></td><td></td>- <td><p> </p></td>+ <td><p>OIDC protocol configuration. </p></td></tr><tr><td>ldap_config</td><td><a href="#bytebase.v1.LDAPIdentityProviderConfig">LDAPIdentityProviderConfig</a></td><td></td>- <td><p> </p></td>+ <td><p>LDAP protocol configuration. </p></td></tr></tbody>@@ -18371,7 +18434,7 @@ server. </p></td><td>page_size</td><td><a href="#int32">int32</a></td><td></td>- <td><p>Not used.+ <td><p>Pagination is not currently implemented. This field is reserved for future use.The maximum number of identity providers to return. The service may return fewer thanthis value.If unspecified, at most 10 will be returned.@@ -18382,7 +18445,7 @@ The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td><td>page_token</td><td><a href="#string">string</a></td><td></td>- <td><p>Not used.+ <td><p>Pagination is not currently implemented. This field is reserved for future use.A page token, received from a previous `ListIdentityProviders` call.Provide this to retrieve the subsequent page.@@ -18443,63 +18506,63 @@ If this field is omitted, there are no subsequent pages. </p></td><td>auth_url</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The authorization endpoint URL for OAuth2 flow. </p></td></tr><tr><td>token_url</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The token endpoint URL for exchanging authorization code. </p></td></tr><tr><td>user_info_url</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The user information endpoint URL. </p></td></tr><tr><td>client_id</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The OAuth2 client identifier. </p></td></tr><tr><td>client_secret</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The OAuth2 client secret for authentication. </p></td></tr><tr><td>scopes</td><td><a href="#string">string</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The list of OAuth2 scopes to request. </p></td></tr><tr><td>field_mapping</td><td><a href="#bytebase.v1.FieldMapping">FieldMapping</a></td><td></td>- <td><p> </p></td>+ <td><p>Mapping configuration for user attributes from OAuth2 response. </p></td></tr><tr><td>skip_tls_verify</td><td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Whether to skip TLS certificate verification. </p></td></tr><tr><td>auth_style</td><td><a href="#bytebase.v1.OAuth2AuthStyle">OAuth2AuthStyle</a></td><td></td>- <td><p> </p></td>+ <td><p>The authentication style for client credentials. </p></td></tr></tbody>@@ -18547,21 +18610,21 @@ If this field is omitted, there are no subsequent pages. </p></td><td>issuer</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The OIDC issuer URL for the identity provider. </p></td></tr><tr><td>client_id</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The OIDC client identifier. </p></td></tr><tr><td>client_secret</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The OIDC client secret for authentication. </p></td></tr><tr>@@ -18576,21 +18639,21 @@ Should be fetched from the well-known configuration file of the OIDC provider. <<td>field_mapping</td><td><a href="#bytebase.v1.FieldMapping">FieldMapping</a></td><td></td>- <td><p> </p></td>+ <td><p>Mapping configuration for user attributes from OIDC claims. </p></td></tr><tr><td>skip_tls_verify</td><td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Whether to skip TLS certificate verification. </p></td></tr><tr><td>auth_style</td><td><a href="#bytebase.v1.OAuth2AuthStyle">OAuth2AuthStyle</a></td><td></td>- <td><p> </p></td>+ <td><p>The authentication style for client credentials. </p></td></tr><tr>@@ -18787,25 +18850,25 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>IDENTITY_PROVIDER_TYPE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified identity provider type.</p></td></tr><tr><td>OAUTH2</td><td>1</td>- <td><p></p></td>+ <td><p>OAuth 2.0 authentication protocol.</p></td></tr><tr><td>OIDC</td><td>2</td>- <td><p></p></td>+ <td><p>OpenID Connect authentication protocol.</p></td></tr><tr><td>LDAP</td><td>3</td>- <td><p></p></td>+ <td><p>LDAP directory service authentication.</p></td></tr></tbody>@@ -18876,7 +18939,7 @@ This is an optional style described in the OAuth2 RFC 6749 section 2.3.1.</p></t<h3 id="bytebase.v1.IdentityProviderService">IdentityProviderService</h3>- <p></p>+ <p>IdentityProviderService manages external identity providers for SSO authentication.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -18887,42 +18950,48 @@ This is an optional style described in the OAuth2 RFC 6749 section 2.3.1.</p></t<td>GetIdentityProvider</td><td><a href="#bytebase.v1.GetIdentityProviderRequest">GetIdentityProviderRequest</a></td><td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>- <td><p>Permissions required: bb.identityProviders.get</p></td>+ <td><p>Gets an identity provider by name.+Permissions required: bb.identityProviders.get</p></td></tr><tr><td>ListIdentityProviders</td><td><a href="#bytebase.v1.ListIdentityProvidersRequest">ListIdentityProvidersRequest</a></td><td><a href="#bytebase.v1.ListIdentityProvidersResponse">ListIdentityProvidersResponse</a></td>- <td><p>Permissions required: None</p></td>+ <td><p>Lists all configured identity providers (public endpoint for login page).+Permissions required: None</p></td></tr><tr><td>CreateIdentityProvider</td><td><a href="#bytebase.v1.CreateIdentityProviderRequest">CreateIdentityProviderRequest</a></td><td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>- <td><p>Permissions required: bb.identityProviders.create</p></td>+ <td><p>Creates a new identity provider.+Permissions required: bb.identityProviders.create</p></td></tr><tr><td>UpdateIdentityProvider</td><td><a href="#bytebase.v1.UpdateIdentityProviderRequest">UpdateIdentityProviderRequest</a></td><td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>- <td><p>Permissions required: bb.identityProviders.update</p></td>+ <td><p>Updates an identity provider.+Permissions required: bb.identityProviders.update</p></td></tr><tr><td>DeleteIdentityProvider</td><td><a href="#bytebase.v1.DeleteIdentityProviderRequest">DeleteIdentityProviderRequest</a></td><td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>- <td><p>Permissions required: bb.identityProviders.delete</p></td>+ <td><p>Deletes an identity provider.+Permissions required: bb.identityProviders.delete</p></td></tr><tr><td>TestIdentityProvider</td><td><a href="#bytebase.v1.TestIdentityProviderRequest">TestIdentityProviderRequest</a></td><td><a href="#bytebase.v1.TestIdentityProviderResponse">TestIdentityProviderResponse</a></td>- <td><p>Permissions required: bb.identityProviders.update</p></td>+ <td><p>Tests the connection and configuration of an identity provider.+Permissions required: bb.identityProviders.update</p></td></tr></tbody>@@ -19047,7 +19116,7 @@ Database resource name: instances/instance-id/databases/database-name. </p></td><td>type</td><td><a href="#bytebase.v1.PolicyType">PolicyType</a></td><td></td>- <td><p> </p></td>+ <td><p>The type of policy to create. </p></td></tr></tbody>@@ -19058,7 +19127,7 @@ Database resource name: instances/instance-id/databases/database-name. </p></td><h3 id="bytebase.v1.DataSourceQueryPolicy">DataSourceQueryPolicy</h3>- <p>DataSourceQueryPolicy is the policy configuration for running statements in the SQL editor.</p>+ <p>Policy for controlling which data sources can be queried in the SQL editor.</p><table class="field-table">@@ -19071,7 +19140,7 @@ Database resource name: instances/instance-id/databases/database-name. </p></td><td>admin_data_source_restriction</td><td><a href="#bytebase.v1.DataSourceQueryPolicy.Restriction">DataSourceQueryPolicy.Restriction</a></td><td></td>- <td><p> </p></td>+ <td><p>Restriction for admin data source queries. </p></td></tr><tr>@@ -19171,14 +19240,14 @@ Format: {resource type}/{resource id} </p></td><td>policy_type</td><td><a href="#bytebase.v1.PolicyType">PolicyType</a></td><td>optional</td>- <td><p> </p></td>+ <td><p>Filter by specific policy type. </p></td></tr><tr><td>page_size</td><td><a href="#int32">int32</a></td><td></td>- <td><p>Not used.+ <td><p>Pagination is not currently implemented. This field is reserved for future use.The maximum number of policies to return. The service may return fewer thanthis value.If unspecified, at most 10 policies will be returned.@@ -19189,7 +19258,7 @@ The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td><td>page_token</td><td><a href="#string">string</a></td><td></td>- <td><p>Not used.+ <td><p>Pagination is not currently implemented. This field is reserved for future use.A page token, received from a previous `ListPolicies` call.Provide this to retrieve the subsequent page.@@ -19257,7 +19326,7 @@ If this field is omitted, there are no subsequent pages. </p></td><td>masking_exceptions</td><td><a href="#bytebase.v1.MaskingExceptionPolicy.MaskingException">MaskingExceptionPolicy.MaskingException</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The list of masking exceptions. </p></td></tr></tbody>@@ -19268,7 +19337,7 @@ If this field is omitted, there are no subsequent pages. </p></td><h3 id="bytebase.v1.MaskingExceptionPolicy.MaskingException">MaskingExceptionPolicy.MaskingException</h3>- <p></p>+ <p>An exception allowing specific users to access masked data.</p><table class="field-table">@@ -19281,7 +19350,7 @@ If this field is omitted, there are no subsequent pages. </p></td><td>action</td><td><a href="#bytebase.v1.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>The action that the user can perform on sensitive data. </p></td></tr><tr>@@ -19324,7 +19393,7 @@ resource.instance_id == "local" && resource.database_name == <h3 id="bytebase.v1.MaskingRulePolicy">MaskingRulePolicy</h3>- <p></p>+ <p>Policy for configuring data masking rules.</p><table class="field-table">@@ -19337,7 +19406,7 @@ resource.instance_id == "local" && resource.database_name == <td>rules</td><td><a href="#bytebase.v1.MaskingRulePolicy.MaskingRule">MaskingRulePolicy.MaskingRule</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The list of masking rules. </p></td></tr></tbody>@@ -19348,7 +19417,7 @@ resource.instance_id == "local" && resource.database_name == <h3 id="bytebase.v1.MaskingRulePolicy.MaskingRule">MaskingRulePolicy.MaskingRule</h3>- <p></p>+ <p>A rule that defines when and how to mask data.</p><table class="field-table">@@ -19361,7 +19430,7 @@ resource.instance_id == "local" && resource.database_name == <td>id</td><td><a href="#string">string</a></td><td></td>- <td><p>A unique identifier for a node in UUID format. </p></td>+ <td><p>A unique identifier for the rule in UUID format. </p></td></tr><tr>@@ -19397,7 +19466,7 @@ resource.instance_id == "sample-instance" && (resource.database_<td>semantic_type</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The semantic type of data to mask (e.g., "SSN", "EMAIL"). </p></td></tr></tbody>@@ -19433,14 +19502,14 @@ Database resource name: instances/instance-id/databases/database-name. </p></td><td>inherit_from_parent</td><td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Whether this policy inherits from its parent resource. </p></td></tr><tr><td>type</td><td><a href="#bytebase.v1.PolicyType">PolicyType</a></td><td></td>- <td><p> </p></td>+ <td><p>The type of policy. </p></td></tr><tr>@@ -19489,7 +19558,7 @@ Database resource name: instances/instance-id/databases/database-name. </p></td><td>enforce</td><td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Whether the policy is enforced. </p></td></tr><tr>@@ -19527,14 +19596,14 @@ Database resource name: instances/instance-id/databases/database-name. </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 data export in the SQL editor. </p></td></tr><tr><td>maximum_result_size</td><td><a href="#int64">int64</a></td><td></td>- <td><p>The size limit in bytes.+ <td><p>The maximum result size limit in bytes.The default value is 100MB, we will use the default value if the setting not exists, or the limit <= 0. </p></td></tr>@@ -19542,7 +19611,7 @@ The default value is 100MB, we will use the default value if the setting not exi<td>maximum_result_rows</td><td><a href="#int32">int32</a></td><td></td>- <td><p>The return rows limit.+ <td><p>The maximum number of rows to return.The default value is -1, means no limit. </p></td></tr>@@ -19550,7 +19619,7 @@ The default value is -1, means no limit. </p></td><td>disable_copy_data</td><td><a href="#bool">bool</a></td><td></td>- <td><p>Disable copying data. </p></td>+ <td><p>Disable copying query results. </p></td></tr></tbody>@@ -19561,7 +19630,7 @@ The default value is -1, means no limit. </p></td><h3 id="bytebase.v1.RolloutPolicy">RolloutPolicy</h3>- <p></p>+ <p>Rollout policy configuration.</p><table class="field-table">@@ -19574,14 +19643,14 @@ The default value is -1, means no limit. </p></td><td>automatic</td><td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Whether rollout is automatic without manual approval. </p></td></tr><tr><td>roles</td><td><a href="#string">string</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The roles that can approve rollout execution. </p></td></tr><tr>@@ -19655,7 +19724,7 @@ These checks are performed in UI workflows only. </p></td><h3 id="bytebase.v1.SQLReviewRule">SQLReviewRule</h3>- <p>The SQL review rules. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.</p>+ <p>SQL review rule configuration. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.</p><table class="field-table">@@ -19668,14 +19737,14 @@ These checks are performed in UI workflows only. </p></td><td>type</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The type of SQL review rule. </p></td></tr><tr><td>level</td><td><a href="#bytebase.v1.SQLReviewRuleLevel">SQLReviewRuleLevel</a></td><td></td>- <td><p> </p></td>+ <td><p>The severity level of the rule. </p></td></tr><tr>@@ -19689,14 +19758,14 @@ These checks are performed in UI workflows only. </p></td><td>engine</td><td><a href="#bytebase.v1.Engine">Engine</a></td><td></td>- <td><p> </p></td>+ <td><p>The database engine this rule applies to. </p></td></tr><tr><td>comment</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Additional comment for the rule. </p></td></tr></tbody>@@ -19707,7 +19776,7 @@ These checks are performed in UI workflows only. </p></td><h3 id="bytebase.v1.TagPolicy">TagPolicy</h3>- <p></p>+ <p>Policy for tagging resources with metadata.</p><table class="field-table">@@ -19811,7 +19880,7 @@ In this situation, `update_mask` is ignored. </p></td><h3 id="bytebase.v1.DataSourceQueryPolicy.Restriction">DataSourceQueryPolicy.Restriction</h3>- <p></p>+ <p>Restriction level for admin data source access.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -19821,26 +19890,26 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>RESTRICTION_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified restriction.</p></td></tr><tr><td>FALLBACK</td><td>1</td>- <td><p>Allow to query admin data sources when there is no read-only data source.</p></td>+ <td><p>Allow querying admin data sources when there is no read-only data source.</p></td></tr><tr><td>DISALLOW</td><td>2</td>- <td><p>Disallow to query admin data sources.</p></td>+ <td><p>Disallow querying admin data sources.</p></td></tr></tbody></table><h3 id="bytebase.v1.MaskingExceptionPolicy.MaskingException.Action">MaskingExceptionPolicy.MaskingException.Action</h3>- <p></p>+ <p>The action that the exception permits.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -19850,26 +19919,26 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>ACTION_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified action.</p></td></tr><tr><td>QUERY</td><td>1</td>- <td><p></p></td>+ <td><p>Allow querying sensitive data.</p></td></tr><tr><td>EXPORT</td><td>2</td>- <td><p></p></td>+ <td><p>Allow exporting sensitive data.</p></td></tr></tbody></table><h3 id="bytebase.v1.PolicyResourceType">PolicyResourceType</h3>- <p></p>+ <p>The resource type that a policy can be attached to.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -19879,32 +19948,32 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>RESOURCE_TYPE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified resource type.</p></td></tr><tr><td>WORKSPACE</td><td>1</td>- <td><p></p></td>+ <td><p>Workspace-level policy.</p></td></tr><tr><td>ENVIRONMENT</td><td>2</td>- <td><p></p></td>+ <td><p>Environment-level policy.</p></td></tr><tr><td>PROJECT</td><td>3</td>- <td><p></p></td>+ <td><p>Project-level policy.</p></td></tr></tbody></table><h3 id="bytebase.v1.PolicyType">PolicyType</h3>- <p></p>+ <p>The type of organizational policy.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -19914,43 +19983,43 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>POLICY_TYPE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified policy type.</p></td></tr><tr><td>ROLLOUT_POLICY</td><td>11</td>- <td><p></p></td>+ <td><p>Rollout deployment policy.</p></td></tr><tr><td>MASKING_RULE</td><td>9</td>- <td><p></p></td>+ <td><p>Data masking rule policy.</p></td></tr><tr><td>MASKING_EXCEPTION</td><td>10</td>- <td><p></p></td>+ <td><p>Data masking exception policy.</p></td></tr><tr><td>TAG</td><td>13</td>- <td><p></p></td>+ <td><p>Resource tag policy.</p></td></tr><tr><td>DATA_SOURCE_QUERY</td><td>14</td>- <td><p></p></td>+ <td><p>Data source query restrictions policy.</p></td></tr><tr><td>DATA_QUERY</td><td>16</td>- <td><p></p></td>+ <td><p>Query data access policy.</p></td></tr></tbody>@@ -19986,7 +20055,7 @@ In this situation, `update_mask` is ignored. </p></td></table><h3 id="bytebase.v1.SQLReviewRuleLevel">SQLReviewRuleLevel</h3>- <p></p>+ <p>The severity level for SQL review rules.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -19996,25 +20065,25 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>LEVEL_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified level.</p></td></tr><tr><td>ERROR</td><td>1</td>- <td><p></p></td>+ <td><p>Rule violation is an error.</p></td></tr><tr><td>WARNING</td><td>2</td>- <td><p></p></td>+ <td><p>Rule violation is a warning.</p></td></tr><tr><td>DISABLED</td><td>3</td>- <td><p></p></td>+ <td><p>Rule is disabled.</p></td></tr></tbody>@@ -20025,7 +20094,7 @@ In this situation, `update_mask` is ignored. </p></td><h3 id="bytebase.v1.OrgPolicyService">OrgPolicyService</h3>- <p></p>+ <p>OrgPolicyService manages organizational policies at various resource levels.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -20036,35 +20105,40 @@ In this situation, `update_mask` is ignored. </p></td><td>GetPolicy</td><td><a href="#bytebase.v1.GetPolicyRequest">GetPolicyRequest</a></td><td><a href="#bytebase.v1.Policy">Policy</a></td>- <td><p>Permissions required: bb.policies.get</p></td>+ <td><p>Retrieves a policy by name.+Permissions required: bb.policies.get</p></td></tr><tr><td>ListPolicies</td><td><a href="#bytebase.v1.ListPoliciesRequest">ListPoliciesRequest</a></td><td><a href="#bytebase.v1.ListPoliciesResponse">ListPoliciesResponse</a></td>- <td><p>Permissions required: bb.policies.list</p></td>+ <td><p>Lists policies at a specified resource level.+Permissions required: bb.policies.list</p></td></tr><tr><td>CreatePolicy</td><td><a href="#bytebase.v1.CreatePolicyRequest">CreatePolicyRequest</a></td><td><a href="#bytebase.v1.Policy">Policy</a></td>- <td><p>Permissions required: bb.policies.create</p></td>+ <td><p>Creates a new organizational policy.+Permissions required: bb.policies.create</p></td></tr><tr><td>UpdatePolicy</td><td><a href="#bytebase.v1.UpdatePolicyRequest">UpdatePolicyRequest</a></td><td><a href="#bytebase.v1.Policy">Policy</a></td>- <td><p>Permissions required: bb.policies.update</p></td>+ <td><p>Updates an existing organizational policy.+Permissions required: bb.policies.update</p></td></tr><tr><td>DeletePolicy</td><td><a href="#bytebase.v1.DeletePolicyRequest">DeletePolicyRequest</a></td><td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>- <td><p>Permissions required: bb.policies.delete</p></td>+ <td><p>Deletes an organizational policy.+Permissions required: bb.policies.delete</p></td></tr></tbody>@@ -20407,7 +20481,7 @@ Format: projects/{project}/plans/{plan} </p></td><td>page_size</td><td><a href="#int32">int32</a></td><td></td>- <td><p>Not used.+ <td><p>Pagination is not currently implemented. This field is reserved for future use.The maximum number of plan check runs to return. The service may return fewer thanthis value.If unspecified, at most 10 plan check runs will be returned.@@ -20418,7 +20492,7 @@ The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td><td>page_token</td><td><a href="#string">string</a></td><td></td>- <td><p>Not used.+ <td><p>Pagination is not currently implemented. This field is reserved for future use.A page token, received from a previous `ListPlanCheckRuns` call.Provide this to retrieve the subsequent page.@@ -20617,21 +20691,21 @@ Format: projects/{project}/rollouts/{rollout} </p></td><td>title</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The title of the plan. </p></td></tr><tr><td>description</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The description of the plan. </p></td></tr><tr><td>specs</td><td><a href="#bytebase.v1.Plan.Spec">Plan.Spec</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The deployment specs for the plan. </p></td></tr><tr>@@ -21538,37 +21612,37 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>TYPE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified check type.</p></td></tr><tr><td>DATABASE_STATEMENT_FAKE_ADVISE</td><td>1</td>- <td><p></p></td>+ <td><p>Fake advise check for testing purposes without executing against database.</p></td></tr><tr><td>DATABASE_STATEMENT_ADVISE</td><td>3</td>- <td><p></p></td>+ <td><p>SQL review check that analyzes statements against configured SQL review rules.</p></td></tr><tr><td>DATABASE_STATEMENT_SUMMARY_REPORT</td><td>5</td>- <td><p></p></td>+ <td><p>Summary report check that generates impact analysis for the statements.</p></td></tr><tr><td>DATABASE_CONNECT</td><td>6</td>- <td><p></p></td>+ <td><p>Connection check that verifies database connectivity.</p></td></tr><tr><td>DATABASE_GHOST_SYNC</td><td>7</td>- <td><p></p></td>+ <td><p>Ghost sync check that validates gh-ost online schema change compatibility.</p></td></tr></tbody>@@ -21579,7 +21653,7 @@ In this situation, `update_mask` is ignored. </p></td><h3 id="bytebase.v1.PlanService">PlanService</h3>- <p></p>+ <p>PlanService manages deployment plans for database changes.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -21590,14 +21664,16 @@ In this situation, `update_mask` is ignored. </p></td><td>GetPlan</td><td><a href="#bytebase.v1.GetPlanRequest">GetPlanRequest</a></td><td><a href="#bytebase.v1.Plan">Plan</a></td>- <td><p>Permissions required: bb.plans.get</p></td>+ <td><p>Retrieves a deployment plan by name.+Permissions required: bb.plans.get</p></td></tr><tr><td>ListPlans</td><td><a href="#bytebase.v1.ListPlansRequest">ListPlansRequest</a></td><td><a href="#bytebase.v1.ListPlansResponse">ListPlansResponse</a></td>- <td><p>Permissions required: bb.plans.list</p></td>+ <td><p>Lists deployment plans in a project.+Permissions required: bb.plans.list</p></td></tr><tr>@@ -21612,7 +21688,8 @@ Permissions required: bb.plans.get</p></td><td>CreatePlan</td><td><a href="#bytebase.v1.CreatePlanRequest">CreatePlanRequest</a></td><td><a href="#bytebase.v1.Plan">Plan</a></td>- <td><p>Permissions required: bb.plans.create</p></td>+ <td><p>Creates a new deployment plan.+Permissions required: bb.plans.create</p></td></tr><tr>@@ -21621,28 +21698,31 @@ Permissions required: bb.plans.get</p></td><td><a href="#bytebase.v1.Plan">Plan</a></td><td><p>UpdatePlan updates the plan.The plan creator and the user with bb.plans.update permission on the project can update the plan.-Permissions required: bb.plans.update</p></td>+Permissions required: bb.plans.update (or creator)</p></td></tr><tr><td>ListPlanCheckRuns</td><td><a href="#bytebase.v1.ListPlanCheckRunsRequest">ListPlanCheckRunsRequest</a></td><td><a href="#bytebase.v1.ListPlanCheckRunsResponse">ListPlanCheckRunsResponse</a></td>- <td><p>Permissions required: bb.planCheckRuns.list</p></td>+ <td><p>Lists plan check runs for a deployment plan.+Permissions required: bb.planCheckRuns.list</p></td></tr><tr><td>RunPlanChecks</td><td><a href="#bytebase.v1.RunPlanChecksRequest">RunPlanChecksRequest</a></td><td><a href="#bytebase.v1.RunPlanChecksResponse">RunPlanChecksResponse</a></td>- <td><p>Permissions required: bb.planCheckRuns.run</p></td>+ <td><p>Executes validation checks on a deployment plan.+Permissions required: bb.planCheckRuns.run</p></td></tr><tr><td>BatchCancelPlanCheckRuns</td><td><a href="#bytebase.v1.BatchCancelPlanCheckRunsRequest">BatchCancelPlanCheckRunsRequest</a></td><td><a href="#bytebase.v1.BatchCancelPlanCheckRunsResponse">BatchCancelPlanCheckRunsResponse</a></td>- <td><p>Permissions required: bb.planCheckRuns.run</p></td>+ <td><p>Cancels multiple plan check runs.+Permissions required: bb.planCheckRuns.run</p></td></tr></tbody>@@ -21756,7 +21836,7 @@ Permissions required: bb.plans.update</p></td><h3 id="bytebase.v1.Activity">Activity</h3>- <p>TODO(zp): move to activity later.</p>+ <p>Activity types for webhook notifications.</p><p>TODO(zp): move to activity later.</p>@@ -21874,7 +21954,7 @@ If set to false, the operation will fail if the project has databases or open is<td>policy_results</td><td><a href="#bytebase.v1.BatchGetIamPolicyResponse.PolicyResult">BatchGetIamPolicyResponse.PolicyResult</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The policy results for each requested project. </p></td></tr></tbody>@@ -21885,7 +21965,7 @@ If set to false, the operation will fail if the project has databases or open is<h3 id="bytebase.v1.BatchGetIamPolicyResponse.PolicyResult">BatchGetIamPolicyResponse.PolicyResult</h3>- <p></p>+ <p>Result for a single project's IAM policy.</p><table class="field-table">@@ -21898,14 +21978,14 @@ If set to false, the operation will fail if the project has databases or open is<td>project</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The project resource name. </p></td></tr><tr><td>policy</td><td><a href="#bytebase.v1.IamPolicy">IamPolicy</a></td><td></td>- <td><p> </p></td>+ <td><p>The IAM policy for the project. </p></td></tr></tbody>@@ -22021,7 +22101,7 @@ Format: projects/{project} </p></td><h3 id="bytebase.v1.Label">Label</h3>- <p></p>+ <p>A label for categorizing and organizing issues.</p><table class="field-table">@@ -22034,21 +22114,21 @@ Format: projects/{project} </p></td><td>value</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The label value/name. </p></td></tr><tr><td>color</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The color code for the label (e.g., hex color). </p></td></tr><tr><td>group</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The group this label belongs to. </p></td></tr></tbody>@@ -22166,7 +22246,7 @@ Format: projects/{project} </p></td><td>state</td><td><a href="#bytebase.v1.State">State</a></td><td></td>- <td><p> </p></td>+ <td><p>The lifecycle state of the project. </p></td></tr><tr>@@ -22180,21 +22260,21 @@ Format: projects/{project} </p></td><td>webhooks</td><td><a href="#bytebase.v1.Webhook">Webhook</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The list of webhooks configured for the project. </p></td></tr><tr><td>data_classification_config_id</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The data classification configuration ID for the project. </p></td></tr><tr><td>issue_labels</td><td><a href="#bytebase.v1.Label">Label</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>Labels available for tagging issues in this project. </p></td></tr><tr>@@ -22208,72 +22288,72 @@ Format: projects/{project} </p></td><td>allow_modify_statement</td><td><a href="#bool">bool</a></td><td></td>- <td><p>Allow modifying statement after issue is created. </p></td>+ <td><p>Allow modifying SQL statements after issue is created. </p></td></tr><tr><td>auto_resolve_issue</td><td><a href="#bool">bool</a></td><td></td>- <td><p>Enable auto resolve issue. </p></td>+ <td><p>Enable automatic issue resolution when tasks complete. </p></td></tr><tr><td>enforce_issue_title</td><td><a href="#bool">bool</a></td><td></td>- <td><p>Enforce issue title created by user instead of generated by Bytebase. </p></td>+ <td><p>Enforce issue title to be created by user instead of generated by Bytebase. </p></td></tr><tr><td>auto_enable_backup</td><td><a href="#bool">bool</a></td><td></td>- <td><p>Whether to automatically enable backup. </p></td>+ <td><p>Whether to automatically enable backup for database changes. </p></td></tr><tr><td>skip_backup_errors</td><td><a href="#bool">bool</a></td><td></td>- <td><p>Whether to skip backup errors and continue the data migration. </p></td>+ <td><p>Whether to skip backup errors and continue with data migration. </p></td></tr><tr><td>postgres_database_tenant_mode</td><td><a href="#bool">bool</a></td><td></td>- <td><p>Whether to enable the database tenant mode for PostgreSQL.-If enabled, the issue will be created with the prepend "set role <db_owner>" statement. </p></td>+ <td><p>Whether to enable database tenant mode for PostgreSQL.+If enabled, issues will include "set role <db_owner>" statement. </p></td></tr><tr><td>allow_self_approval</td><td><a href="#bool">bool</a></td><td></td>- <td><p>Whether to allow the issue creator to self-approve the issue. </p></td>+ <td><p>Whether to allow issue creators to self-approve their own issues. </p></td></tr><tr><td>execution_retry_policy</td><td><a href="#bytebase.v1.Project.ExecutionRetryPolicy">Project.ExecutionRetryPolicy</a></td><td></td>- <td><p>Execution retry policy for the task run. </p></td>+ <td><p>Execution retry policy for task runs. </p></td></tr><tr><td>ci_sampling_size</td><td><a href="#int32">int32</a></td><td></td>- <td><p>The maximum databases of rows to sample during CI data validation.-Without specification, sampling is disabled, resulting in a full validation. </p></td>+ <td><p>The maximum number of database rows to sample during CI data validation.+Without specification, sampling is disabled, resulting in full validation. </p></td></tr><tr><td>parallel_tasks_per_rollout</td><td><a href="#int32">int32</a></td><td></td>- <td><p>The maximum number of parallel tasks to run during the rollout. </p></td>+ <td><p>The maximum number of parallel tasks allowed during rollout execution. </p></td></tr><tr>@@ -22300,7 +22380,7 @@ If enabled, issues cannot be created when SQL review finds errors. </p></td><h3 id="bytebase.v1.Project.ExecutionRetryPolicy">Project.ExecutionRetryPolicy</h3>- <p></p>+ <p>Execution retry policy configuration.</p><table class="field-table">@@ -22313,7 +22393,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 retries for lock timeout errors. </p></td></tr></tbody>@@ -22720,7 +22800,7 @@ It should not be empty, and should be a subset of the following:<h3 id="bytebase.v1.Activity.Type">Activity.Type</h3>- <p></p>+ <p>Activity type enumeration.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -22730,7 +22810,7 @@ It should not be empty, and should be a subset of the following:<tr><td>TYPE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified type.</p></td></tr><tr>@@ -22795,7 +22875,7 @@ ISSUE_CREATE represents creating an issue.</p></td></table><h3 id="bytebase.v1.Webhook.Type">Webhook.Type</h3>- <p></p>+ <p>Webhook integration type.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -22805,49 +22885,49 @@ ISSUE_CREATE represents creating an issue.</p></td><tr><td>TYPE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified type.</p></td></tr><tr><td>SLACK</td><td>1</td>- <td><p></p></td>+ <td><p>Slack integration.</p></td></tr><tr><td>DISCORD</td><td>2</td>- <td><p></p></td>+ <td><p>Discord integration.</p></td></tr><tr><td>TEAMS</td><td>3</td>- <td><p></p></td>+ <td><p>Microsoft Teams integration.</p></td></tr><tr><td>DINGTALK</td><td>4</td>- <td><p></p></td>+ <td><p>DingTalk integration.</p></td></tr><tr><td>FEISHU</td><td>5</td>- <td><p></p></td>+ <td><p>Feishu integration.</p></td></tr><tr><td>WECOM</td><td>6</td>- <td><p></p></td>+ <td><p>WeCom (WeChat Work) integration.</p></td></tr><tr><td>LARK</td><td>8</td>- <td><p></p></td>+ <td><p>Lark integration.</p></td></tr></tbody>@@ -22858,7 +22938,7 @@ ISSUE_CREATE represents creating an issue.</p></td><h3 id="bytebase.v1.ProjectService">ProjectService</h3>- <p></p>+ <p>ProjectService manages projects that group databases and changes.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -22878,99 +22958,112 @@ Permissions required: bb.projects.get</p></td><td>ListProjects</td><td><a href="#bytebase.v1.ListProjectsRequest">ListProjectsRequest</a></td><td><a href="#bytebase.v1.ListProjectsResponse">ListProjectsResponse</a></td>- <td><p>Permissions required: bb.projects.list</p></td>+ <td><p>Lists all projects in the workspace with optional filtering.+Permissions required: bb.projects.list</p></td></tr><tr><td>SearchProjects</td><td><a href="#bytebase.v1.SearchProjectsRequest">SearchProjectsRequest</a></td><td><a href="#bytebase.v1.SearchProjectsResponse">SearchProjectsResponse</a></td>- <td><p>Permissions required: None</p></td>+ <td><p>Searches for projects with advanced filtering capabilities.+Permissions required: bb.projects.get (or project-level bb.projects.get for specific projects)</p></td></tr><tr><td>CreateProject</td><td><a href="#bytebase.v1.CreateProjectRequest">CreateProjectRequest</a></td><td><a href="#bytebase.v1.Project">Project</a></td>- <td><p>Permissions required: bb.projects.create</p></td>+ <td><p>Creates a new project in the workspace.+Permissions required: bb.projects.create</p></td></tr><tr><td>UpdateProject</td><td><a href="#bytebase.v1.UpdateProjectRequest">UpdateProjectRequest</a></td><td><a href="#bytebase.v1.Project">Project</a></td>- <td><p>Permissions required: bb.projects.update</p></td>+ <td><p>Updates an existing project's properties.+Permissions required: bb.projects.update</p></td></tr><tr><td>DeleteProject</td><td><a href="#bytebase.v1.DeleteProjectRequest">DeleteProjectRequest</a></td><td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>- <td><p>Permissions required: bb.projects.delete</p></td>+ <td><p>Deletes (soft-delete or purge) a project.+Permissions required: bb.projects.delete</p></td></tr><tr><td>UndeleteProject</td><td><a href="#bytebase.v1.UndeleteProjectRequest">UndeleteProjectRequest</a></td><td><a href="#bytebase.v1.Project">Project</a></td>- <td><p>Permissions required: bb.projects.undelete</p></td>+ <td><p>Restores a soft-deleted project.+Permissions required: bb.projects.undelete</p></td></tr><tr><td>BatchDeleteProjects</td><td><a href="#bytebase.v1.BatchDeleteProjectsRequest">BatchDeleteProjectsRequest</a></td><td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>- <td><p>Permissions required: bb.projects.delete</p></td>+ <td><p>Deletes multiple projects in a single operation.+Permissions required: bb.projects.delete</p></td></tr><tr><td>GetIamPolicy</td><td><a href="#bytebase.v1.GetIamPolicyRequest">GetIamPolicyRequest</a></td><td><a href="#bytebase.v1.IamPolicy">IamPolicy</a></td>- <td><p>Permissions required: bb.projects.getIamPolicy</p></td>+ <td><p>Retrieves the IAM policy for a project.+Permissions required: bb.projects.getIamPolicy</p></td></tr><tr><td>BatchGetIamPolicy</td><td><a href="#bytebase.v1.BatchGetIamPolicyRequest">BatchGetIamPolicyRequest</a></td><td><a href="#bytebase.v1.BatchGetIamPolicyResponse">BatchGetIamPolicyResponse</a></td>- <td><p>Deprecated.-Permissions required: bb.projects.getIamPolicy</p></td>+ <td><p>Deprecated. No permission check implemented.+Permissions required: None</p></td></tr><tr><td>SetIamPolicy</td><td><a href="#bytebase.v1.SetIamPolicyRequest">SetIamPolicyRequest</a></td><td><a href="#bytebase.v1.IamPolicy">IamPolicy</a></td>- <td><p>Permissions required: bb.projects.setIamPolicy</p></td>+ <td><p>Sets the IAM policy for a project.+Permissions required: bb.projects.setIamPolicy</p></td></tr><tr><td>AddWebhook</td><td><a href="#bytebase.v1.AddWebhookRequest">AddWebhookRequest</a></td><td><a href="#bytebase.v1.Project">Project</a></td>- <td><p>Permissions required: bb.projects.update</p></td>+ <td><p>Adds a webhook to a project for notifications.+Permissions required: bb.projects.update</p></td></tr><tr><td>UpdateWebhook</td><td><a href="#bytebase.v1.UpdateWebhookRequest">UpdateWebhookRequest</a></td><td><a href="#bytebase.v1.Project">Project</a></td>- <td><p>Permissions required: bb.projects.update</p></td>+ <td><p>Updates an existing webhook configuration.+Permissions required: bb.projects.update</p></td></tr><tr><td>RemoveWebhook</td><td><a href="#bytebase.v1.RemoveWebhookRequest">RemoveWebhookRequest</a></td><td><a href="#bytebase.v1.Project">Project</a></td>- <td><p>Permissions required: bb.projects.update</p></td>+ <td><p>Removes a webhook from a project.+Permissions required: bb.projects.update</p></td></tr><tr><td>TestWebhook</td><td><a href="#bytebase.v1.TestWebhookRequest">TestWebhookRequest</a></td><td><a href="#bytebase.v1.TestWebhookResponse">TestWebhookResponse</a></td>- <td><p>Permissions required: bb.projects.update</p></td>+ <td><p>Tests a webhook by sending a test notification.+Permissions required: bb.projects.update</p></td></tr></tbody>@@ -24564,7 +24657,7 @@ Supported filter:- database: the database full name in "instances/{id}/databases/{name}" format, support "==" operator.- instance: the instance full name in "instances/{id}" format, support "==" operator.- type: the type, should be "QUERY" or "EXPORT", support "==" operator.-- statement: the SQL statemnt, support ".matches()" operator.+- statement: the SQL statement, support ".matches()" operator.For example:project == "projects/{project}"@@ -24705,19 +24798,19 @@ Pass this value in the page_token field in the subsequent call to<tr><td>TYPE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified query history type.</p></td></tr><tr><td>QUERY</td><td>1</td>- <td><p></p></td>+ <td><p>Query execution for data retrieval.</p></td></tr><tr><td>EXPORT</td><td>2</td>- <td><p></p></td>+ <td><p>Data export operation to file.</p></td></tr></tbody>@@ -24740,13 +24833,13 @@ Pass this value in the page_token field in the subsequent call to<tr><td>SINGLE_NODE</td><td>1</td>- <td><p></p></td>+ <td><p>Execute Redis commands on a single node in the cluster.</p></td></tr><tr><td>ALL_NODES</td><td>2</td>- <td><p></p></td>+ <td><p>Execute Redis commands on all nodes in the cluster for cluster-wide operations.</p></td></tr></tbody>@@ -24763,43 +24856,43 @@ Pass this value in the page_token field in the subsequent call to<tr><td>LEVEL_UNSPECIFIED</td><td>0</td>- <td><p>Unspecified.</p></td>+ <td><p>Unspecified message level.</p></td></tr><tr><td>INFO</td><td>1</td>- <td><p></p></td>+ <td><p>Informational message.</p></td></tr><tr><td>WARNING</td><td>2</td>- <td><p></p></td>+ <td><p>Warning message indicating potential issues.</p></td></tr><tr><td>DEBUG</td><td>3</td>- <td><p></p></td>+ <td><p>Debug message for development and troubleshooting.</p></td></tr><tr><td>LOG</td><td>4</td>- <td><p></p></td>+ <td><p>General log message.</p></td></tr><tr><td>NOTICE</td><td>5</td>- <td><p></p></td>+ <td><p>Notice message for important information.</p></td></tr><tr><td>EXCEPTION</td><td>6</td>- <td><p></p></td>+ <td><p>Exception message indicating error conditions.</p></td></tr></tbody>@@ -24810,7 +24903,7 @@ Pass this value in the page_token field in the subsequent call to<h3 id="bytebase.v1.SQLService">SQLService</h3>- <p></p>+ <p>SQLService executes SQL queries and manages query operations.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -24821,14 +24914,16 @@ Pass this value in the page_token field in the subsequent call to<td>Query</td><td><a href="#bytebase.v1.QueryRequest">QueryRequest</a></td><td><a href="#bytebase.v1.QueryResponse">QueryResponse</a></td>- <td><p>Permissions required: bb.databases.get</p></td>+ <td><p>Executes a read-only SQL query against a database.+Permissions required: bb.databases.get</p></td></tr><tr><td>AdminExecute</td><td><a href="#bytebase.v1.AdminExecuteRequest">AdminExecuteRequest</a> stream</td><td><a href="#bytebase.v1.AdminExecuteResponse">AdminExecuteResponse</a> stream</td>- <td><p>Permissions required: bb.sql.admin</p></td>+ <td><p>Executes SQL with admin privileges via streaming connection.+Permissions required: bb.sql.admin</p></td></tr><tr>@@ -24836,42 +24931,47 @@ Pass this value in the page_token field in the subsequent call to<td><a href="#bytebase.v1.SearchQueryHistoriesRequest">SearchQueryHistoriesRequest</a></td><td><a href="#bytebase.v1.SearchQueryHistoriesResponse">SearchQueryHistoriesResponse</a></td><td><p>SearchQueryHistories searches query histories for the caller.-Permissions required: None</p></td>+Permissions required: None (only returns caller's own query histories)</p></td></tr><tr><td>Export</td><td><a href="#bytebase.v1.ExportRequest">ExportRequest</a></td><td><a href="#bytebase.v1.ExportResponse">ExportResponse</a></td>- <td><p>Permissions required: bb.databases.get</p></td>+ <td><p>Exports query results to a file format.+Permissions required: bb.databases.get</p></td></tr><tr><td>Check</td><td><a href="#bytebase.v1.CheckRequest">CheckRequest</a></td><td><a href="#bytebase.v1.CheckResponse">CheckResponse</a></td>- <td><p>Permissions required: bb.databases.check</p></td>+ <td><p>Validates SQL statements against review rules.+Permissions required: bb.databases.check</p></td></tr><tr><td>Pretty</td><td><a href="#bytebase.v1.PrettyRequest">PrettyRequest</a></td><td><a href="#bytebase.v1.PrettyResponse">PrettyResponse</a></td>- <td><p>Permissions required: None</p></td>+ <td><p>Formats and normalizes SQL schema definitions.+Permissions required: None</p></td></tr><tr><td>DiffMetadata</td><td><a href="#bytebase.v1.DiffMetadataRequest">DiffMetadataRequest</a></td><td><a href="#bytebase.v1.DiffMetadataResponse">DiffMetadataResponse</a></td>- <td><p>Permissions required: None</p></td>+ <td><p>Computes schema differences between two database metadata.+Permissions required: None</p></td></tr><tr><td>AICompletion</td><td><a href="#bytebase.v1.AICompletionRequest">AICompletionRequest</a></td><td><a href="#bytebase.v1.AICompletionResponse">AICompletionResponse</a></td>- <td><p>Permissions required: None</p></td>+ <td><p>Provides AI-powered SQL completion and generation.+Permissions required: None (authenticated users only, requires AI to be enabled)</p></td></tr></tbody>@@ -25054,14 +25154,14 @@ instances/{instance}/databases/{database} </p></td><td>results</td><td><a href="#bytebase.v1.CheckReleaseResponse.CheckResult">CheckReleaseResponse.CheckResult</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The check results for each file and target combination. </p></td></tr><tr><td>affected_rows</td><td><a href="#int64">int64</a></td><td></td>- <td><p>The affected rows of the check. </p></td>+ <td><p>The total affected rows across all checks. </p></td></tr><tr>@@ -25079,7 +25179,7 @@ instances/{instance}/databases/{database} </p></td><h3 id="bytebase.v1.CheckReleaseResponse.CheckResult">CheckReleaseResponse.CheckResult</h3>- <p></p>+ <p>Check result for a single release file on a target database.</p><table class="field-table">@@ -25276,7 +25376,7 @@ the call that provided the page token. </p></td><td>releases</td><td><a href="#bytebase.v1.Release">Release</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The releases from the specified request. </p></td></tr><tr>@@ -25315,21 +25415,21 @@ If this field is omitted, there are no subsequent pages. </p></td><td>title</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The title of the release. </p></td></tr><tr><td>files</td><td><a href="#bytebase.v1.Release.File">Release.File</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The SQL files included in the release. </p></td></tr><tr><td>vcs_source</td><td><a href="#bytebase.v1.Release.VCSSource">Release.VCSSource</a></td><td></td>- <td><p> </p></td>+ <td><p>The version control source of the release. </p></td></tr><tr>@@ -25350,7 +25450,7 @@ If this field is omitted, there are no subsequent pages. </p></td><td>state</td><td><a href="#bytebase.v1.State">State</a></td><td></td>- <td><p> </p></td>+ <td><p>The lifecycle state of the release. </p></td></tr><tr>@@ -25371,7 +25471,7 @@ If the digest is not empty, it must be unique in the project. Otherwise, an ALRE<h3 id="bytebase.v1.Release.File">Release.File</h3>- <p></p>+ <p>A SQL file in a release.</p><table class="field-table">@@ -25405,7 +25505,7 @@ If the digest is not empty, it must be unique in the project. Otherwise, an ALRE<td>version</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The version identifier for the file. </p></td></tr><tr>@@ -25457,7 +25557,7 @@ Format: projects/{project}/sheets/{sheet} </p></td><h3 id="bytebase.v1.Release.VCSSource">Release.VCSSource</h3>- <p></p>+ <p>Version control system source information.</p><table class="field-table">@@ -25470,7 +25570,7 @@ Format: projects/{project}/sheets/{sheet} </p></td><td>vcs_type</td><td><a href="#bytebase.v1.VCSType">VCSType</a></td><td></td>- <td><p> </p></td>+ <td><p>The type of VCS. </p></td></tr><tr>@@ -25552,7 +25652,7 @@ the call that provided the page token. </p></td><td>releases</td><td><a href="#bytebase.v1.Release">Release</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The releases matching the search criteria. </p></td></tr><tr>@@ -25637,7 +25737,7 @@ In this situation, `update_mask` is ignored. </p></td><h3 id="bytebase.v1.Release.File.MigrationType">Release.File.MigrationType</h3>- <p></p>+ <p>The migration type for versioned files.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -25647,32 +25747,32 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>MIGRATION_TYPE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified migration type.</p></td></tr><tr><td>DDL</td><td>1</td>- <td><p></p></td>+ <td><p>DDL (Data Definition Language) migration.</p></td></tr><tr><td>DDL_GHOST</td><td>2</td>- <td><p></p></td>+ <td><p>DDL migration using gh-ost for online schema changes.</p></td></tr><tr><td>DML</td><td>3</td>- <td><p></p></td>+ <td><p>DML (Data Manipulation Language) migration.</p></td></tr></tbody></table><h3 id="bytebase.v1.Release.File.Type">Release.File.Type</h3>- <p></p>+ <p>The type of migration file.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -25682,19 +25782,19 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>TYPE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified type.</p></td></tr><tr><td>VERSIONED</td><td>1</td>- <td><p></p></td>+ <td><p>Versioned migration file with sequential version numbers.</p></td></tr><tr><td>DECLARATIVE</td><td>2</td>- <td><p></p></td>+ <td><p>Declarative schema definition file describing desired state.</p></td></tr></tbody>@@ -25705,7 +25805,7 @@ In this situation, `update_mask` is ignored. </p></td><h3 id="bytebase.v1.ReleaseService">ReleaseService</h3>- <p></p>+ <p>ReleaseService manages releases for coordinating deployments.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -25716,56 +25816,64 @@ In this situation, `update_mask` is ignored. </p></td><td>GetRelease</td><td><a href="#bytebase.v1.GetReleaseRequest">GetReleaseRequest</a></td><td><a href="#bytebase.v1.Release">Release</a></td>- <td><p>Permissions required: bb.releases.get</p></td>+ <td><p>Retrieves a release by name.+Permissions required: bb.releases.get</p></td></tr><tr><td>ListReleases</td><td><a href="#bytebase.v1.ListReleasesRequest">ListReleasesRequest</a></td><td><a href="#bytebase.v1.ListReleasesResponse">ListReleasesResponse</a></td>- <td><p>Permissions required: bb.releases.list</p></td>+ <td><p>Lists releases in a project.+Permissions required: bb.releases.list</p></td></tr><tr><td>SearchReleases</td><td><a href="#bytebase.v1.SearchReleasesRequest">SearchReleasesRequest</a></td><td><a href="#bytebase.v1.SearchReleasesResponse">SearchReleasesResponse</a></td>- <td><p>Permissions required: bb.releases.get</p></td>+ <td><p>Searches releases by digest or other criteria.+Permissions required: bb.releases.get</p></td></tr><tr><td>CreateRelease</td><td><a href="#bytebase.v1.CreateReleaseRequest">CreateReleaseRequest</a></td><td><a href="#bytebase.v1.Release">Release</a></td>- <td><p>Permissions required: bb.releases.create</p></td>+ <td><p>Creates a new release with SQL files.+Permissions required: bb.releases.create</p></td></tr><tr><td>UpdateRelease</td><td><a href="#bytebase.v1.UpdateReleaseRequest">UpdateReleaseRequest</a></td><td><a href="#bytebase.v1.Release">Release</a></td>- <td><p>Permissions required: bb.releases.update</p></td>+ <td><p>Updates an existing release.+Permissions required: bb.releases.update</p></td></tr><tr><td>DeleteRelease</td><td><a href="#bytebase.v1.DeleteReleaseRequest">DeleteReleaseRequest</a></td><td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>- <td><p>Permissions required: bb.releases.delete</p></td>+ <td><p>Deletes a release.+Permissions required: bb.releases.delete</p></td></tr><tr><td>UndeleteRelease</td><td><a href="#bytebase.v1.UndeleteReleaseRequest">UndeleteReleaseRequest</a></td><td><a href="#bytebase.v1.Release">Release</a></td>- <td><p>Permissions required: bb.releases.undelete</p></td>+ <td><p>Restores a deleted release.+Permissions required: bb.releases.undelete</p></td></tr><tr><td>CheckRelease</td><td><a href="#bytebase.v1.CheckReleaseRequest">CheckReleaseRequest</a></td><td><a href="#bytebase.v1.CheckReleaseResponse">CheckReleaseResponse</a></td>- <td><p>Permissions required: bb.releases.check</p></td>+ <td><p>Validates a release by dry-running checks on target databases.+Permissions required: bb.releases.check</p></td></tr></tbody>@@ -25966,7 +26074,7 @@ Format: reviewConfigs/{reviewConfig} </p></td><td>page_size</td><td><a href="#int32">int32</a></td><td></td>- <td><p>Not used.+ <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 thanthis value.If unspecified, at most 10 sql review will be returned.@@ -25977,7 +26085,7 @@ The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td><td>page_token</td><td><a href="#string">string</a></td><td></td>- <td><p>Not used.+ <td><p>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@@ -26045,21 +26153,21 @@ Format: reviewConfigs/{reviewConfig} </p></td><td>title</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The title of the review configuration. </p></td></tr><tr><td>enabled</td><td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Whether the review configuration is enabled. </p></td></tr><tr><td>rules</td><td><a href="#bytebase.v1.SQLReviewRule">SQLReviewRule</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The SQL review rules to enforce. </p></td></tr><tr>@@ -26067,7 +26175,7 @@ Format: reviewConfigs/{reviewConfig} </p></td><td><a href="#string">string</a></td><td>repeated</td><td><p>resources using the config.-Format: {resurce}/{resource id}, for example, environments/test. </p></td>+Format: {resource}/{resource id}, for example, environments/test. </p></td></tr></tbody>@@ -26125,7 +26233,7 @@ In this situation, `update_mask` is ignored. </p></td><h3 id="bytebase.v1.ReviewConfigService">ReviewConfigService</h3>- <p></p>+ <p>ReviewConfigService manages approval flow configurations.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -26136,35 +26244,40 @@ In this situation, `update_mask` is ignored. </p></td><td>CreateReviewConfig</td><td><a href="#bytebase.v1.CreateReviewConfigRequest">CreateReviewConfigRequest</a></td><td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>- <td><p>Permissions required: bb.reviewConfigs.create</p></td>+ <td><p>Creates a new SQL review configuration.+Permissions required: bb.reviewConfigs.create</p></td></tr><tr><td>ListReviewConfigs</td><td><a href="#bytebase.v1.ListReviewConfigsRequest">ListReviewConfigsRequest</a></td><td><a href="#bytebase.v1.ListReviewConfigsResponse">ListReviewConfigsResponse</a></td>- <td><p>Permissions required: bb.reviewConfigs.list</p></td>+ <td><p>Lists all SQL review configurations.+Permissions required: bb.reviewConfigs.list</p></td></tr><tr><td>GetReviewConfig</td><td><a href="#bytebase.v1.GetReviewConfigRequest">GetReviewConfigRequest</a></td><td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>- <td><p>Permissions required: bb.reviewConfigs.get</p></td>+ <td><p>Retrieves a SQL review configuration by name.+Permissions required: bb.reviewConfigs.get</p></td></tr><tr><td>UpdateReviewConfig</td><td><a href="#bytebase.v1.UpdateReviewConfigRequest">UpdateReviewConfigRequest</a></td><td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>- <td><p>Permissions required: bb.reviewConfigs.update</p></td>+ <td><p>Updates a SQL review configuration.+Permissions required: bb.reviewConfigs.update</p></td></tr><tr><td>DeleteReviewConfig</td><td><a href="#bytebase.v1.DeleteReviewConfigRequest">DeleteReviewConfigRequest</a></td><td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>- <td><p>Permissions required: bb.reviewConfigs.delete</p></td>+ <td><p>Deletes a SQL review configuration.+Permissions required: bb.reviewConfigs.delete</p></td></tr></tbody>@@ -26427,7 +26540,7 @@ match the call that provided the page token. </p></td><td>show_deleted</td><td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Whether to include deleted revisions in the results. </p></td></tr></tbody>@@ -26451,7 +26564,7 @@ match the call that provided the page token. </p></td><td>revisions</td><td><a href="#bytebase.v1.Revision">Revision</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The revisions from the specified request. </p></td></tr><tr>@@ -26528,7 +26641,7 @@ Can be empty. </p></td><td>version</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The schema version string for this revision. </p></td></tr><tr>@@ -26557,7 +26670,7 @@ Format: projects/{project}/sheets/{sheet} </p></td><td>statement_size</td><td><a href="#int64">int64</a></td><td></td>- <td><p> </p></td>+ <td><p>The size of the statement in bytes. </p></td></tr><tr>@@ -26596,7 +26709,7 @@ projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{task<h3 id="bytebase.v1.Revision.Type">Revision.Type</h3>- <p></p>+ <p>The type of schema revision.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -26606,19 +26719,19 @@ projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{task<tr><td>TYPE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified type.</p></td></tr><tr><td>VERSIONED</td><td>1</td>- <td><p></p></td>+ <td><p>Versioned schema migration.</p></td></tr><tr><td>DECLARATIVE</td><td>2</td>- <td><p></p></td>+ <td><p>Declarative schema definition.</p></td></tr></tbody>@@ -26629,7 +26742,7 @@ projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{task<h3 id="bytebase.v1.RevisionService">RevisionService</h3>- <p></p>+ <p>RevisionService manages schema revision history.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -26640,35 +26753,40 @@ projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{task<td>ListRevisions</td><td><a href="#bytebase.v1.ListRevisionsRequest">ListRevisionsRequest</a></td><td><a href="#bytebase.v1.ListRevisionsResponse">ListRevisionsResponse</a></td>- <td><p>Permissions required: bb.revisions.list</p></td>+ <td><p>Lists schema revisions for a database.+Permissions required: bb.revisions.list</p></td></tr><tr><td>GetRevision</td><td><a href="#bytebase.v1.GetRevisionRequest">GetRevisionRequest</a></td><td><a href="#bytebase.v1.Revision">Revision</a></td>- <td><p>Permissions required: bb.revisions.get</p></td>+ <td><p>Retrieves a schema revision by name.+Permissions required: bb.revisions.get</p></td></tr><tr><td>CreateRevision</td><td><a href="#bytebase.v1.CreateRevisionRequest">CreateRevisionRequest</a></td><td><a href="#bytebase.v1.Revision">Revision</a></td>- <td><p>Permissions required: bb.revisions.create</p></td>+ <td><p>Creates a new schema revision.+Permissions required: bb.revisions.create</p></td></tr><tr><td>BatchCreateRevisions</td><td><a href="#bytebase.v1.BatchCreateRevisionsRequest">BatchCreateRevisionsRequest</a></td><td><a href="#bytebase.v1.BatchCreateRevisionsResponse">BatchCreateRevisionsResponse</a></td>- <td><p>Permissions required: bb.revisions.create</p></td>+ <td><p>Creates multiple schema revisions in a single operation.+Permissions required: bb.revisions.create</p></td></tr><tr><td>DeleteRevision</td><td><a href="#bytebase.v1.DeleteRevisionRequest">DeleteRevisionRequest</a></td><td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>- <td><p>Permissions required: bb.revisions.delete</p></td>+ <td><p>Deletes a schema revision.+Permissions required: bb.revisions.delete</p></td></tr></tbody>@@ -26839,7 +26957,7 @@ Format: risks/{risk} </p></td><td>page_size</td><td><a href="#int32">int32</a></td><td></td>- <td><p>Not used.+ <td><p>Pagination is not currently implemented. This field is reserved for future use.The maximum number of risks to return. The service may return fewer thanthis value.If unspecified, at most 10 risks will be returned.@@ -26850,11 +26968,11 @@ The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td><td>page_token</td><td><a href="#string">string</a></td><td></td>- <td><p>Not used.+ <td><p>Pagination is not currently implemented. This field is reserved for future use.A page token, received from a previous `ListRisks` call.Provide this to retrieve the subsequent page.-When paginating, all other parameters provided to `LiskRisks` must match+When paginating, all other parameters provided to `ListRisks` must matchthe call that provided the page token. </p></td></tr>@@ -26925,21 +27043,21 @@ If this field is omitted, there are no subsequent pages. </p></td><td>title</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The title of the risk rule. </p></td></tr><tr><td>level</td><td><a href="#bytebase.v1.RiskLevel">RiskLevel</a></td><td></td>- <td><p> </p></td>+ <td><p>The risk level assigned when this rule matches. </p></td></tr><tr><td>active</td><td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Whether the risk rule is active. </p></td></tr><tr>@@ -27100,7 +27218,7 @@ In this situation, `update_mask` is ignored. </p></td><h3 id="bytebase.v1.RiskService">RiskService</h3>- <p></p>+ <p>RiskService manages risk assessment rules for database changes.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -27111,35 +27229,40 @@ In this situation, `update_mask` is ignored. </p></td><td>ListRisks</td><td><a href="#bytebase.v1.ListRisksRequest">ListRisksRequest</a></td><td><a href="#bytebase.v1.ListRisksResponse">ListRisksResponse</a></td>- <td><p>Permissions required: bb.risks.list</p></td>+ <td><p>Lists all risk assessment rules.+Permissions required: bb.risks.list</p></td></tr><tr><td>CreateRisk</td><td><a href="#bytebase.v1.CreateRiskRequest">CreateRiskRequest</a></td><td><a href="#bytebase.v1.Risk">Risk</a></td>- <td><p>Permissions required: bb.risks.create</p></td>+ <td><p>Creates a new risk assessment rule.+Permissions required: bb.risks.create</p></td></tr><tr><td>GetRisk</td><td><a href="#bytebase.v1.GetRiskRequest">GetRiskRequest</a></td><td><a href="#bytebase.v1.Risk">Risk</a></td>- <td><p>Permissions required: bb.risks.list</p></td>+ <td><p>Retrieves a risk assessment rule by name.+Permissions required: bb.risks.list</p></td></tr><tr><td>UpdateRisk</td><td><a href="#bytebase.v1.UpdateRiskRequest">UpdateRiskRequest</a></td><td><a href="#bytebase.v1.Risk">Risk</a></td>- <td><p>Permissions required: bb.risks.update</p></td>+ <td><p>Updates an existing risk assessment rule.+Permissions required: bb.risks.update</p></td></tr><tr><td>DeleteRisk</td><td><a href="#bytebase.v1.DeleteRiskRequest">DeleteRiskRequest</a></td><td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>- <td><p>Permissions required: bb.risks.delete</p></td>+ <td><p>Deletes a risk assessment rule.+Permissions required: bb.risks.delete</p></td></tr></tbody>@@ -27236,7 +27359,7 @@ In this situation, `update_mask` is ignored. </p></td><td>role</td><td><a href="#bytebase.v1.Role">Role</a></td><td></td>- <td><p> </p></td>+ <td><p>The role to create. </p></td></tr><tr>@@ -27271,7 +27394,8 @@ are /[a-z][A-Z][0-9]/. </p></td><td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>Format: roles/{role} </p></td>+ <td><p>The name of the role to delete.+Format: roles/{role} </p></td></tr></tbody>@@ -27320,7 +27444,7 @@ Format: roles/{role} </p></td><td>page_size</td><td><a href="#int32">int32</a></td><td></td>- <td><p>Not used.+ <td><p>Pagination is not currently implemented. This field is reserved for future use.The maximum number of roles to return. The service may return fewer thanthis value.If unspecified, at most 10 reviews will be returned.@@ -27331,7 +27455,7 @@ The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td><td>page_token</td><td><a href="#string">string</a></td><td></td>- <td><p>Not used.+ <td><p>Pagination is not currently implemented. This field is reserved for future use.A page token, received from a previous `ListRoles` call.Provide this to retrieve the subsequent page.@@ -27360,7 +27484,7 @@ the call that provided the page token. </p></td><td>roles</td><td><a href="#bytebase.v1.Role">Role</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The roles from the specified request. </p></td></tr><tr>@@ -27379,7 +27503,7 @@ If this field is omitted, there are no subsequent pages. </p></td><h3 id="bytebase.v1.Role">Role</h3>- <p></p>+ <p>Role defines a set of permissions that can be assigned to users.</p><table class="field-table">@@ -27392,35 +27516,35 @@ If this field is omitted, there are no subsequent pages. </p></td><td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>Format: roles/{role} </p></td>+ <td><p>Resource name. Format: roles/{role} </p></td></tr><tr><td>title</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Human-readable title. </p></td></tr><tr><td>description</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Optional description of the role. </p></td></tr><tr><td>permissions</td><td><a href="#string">string</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>List of permission identifiers granted by this role. </p></td></tr><tr><td>type</td><td><a href="#bytebase.v1.Role.Type">Role.Type</a></td><td></td>- <td><p> </p></td>+ <td><p>Role type indicating if it's built-in or custom. </p></td></tr></tbody>@@ -27444,21 +27568,22 @@ If this field is omitted, there are no subsequent pages. </p></td><td>role</td><td><a href="#bytebase.v1.Role">Role</a></td><td></td>- <td><p> </p></td>+ <td><p>The role to update. </p></td></tr><tr><td>update_mask</td><td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td><td></td>- <td><p> </p></td>+ <td><p>The list of fields to update. </p></td></tr><tr><td>allow_missing</td><td><a href="#bool">bool</a></td><td></td>- <td><p>If set to true, and the role is not found, a new role will be created. </p></td>+ <td><p>If set to true, and the role is not found, a new role will be created.+In this situation, `update_mask` is ignored. </p></td></tr></tbody>@@ -27487,13 +27612,13 @@ If this field is omitted, there are no subsequent pages. </p></td><tr><td>BUILT_IN</td><td>1</td>- <td><p></p></td>+ <td><p>System-defined role that cannot be modified.</p></td></tr><tr><td>CUSTOM</td><td>2</td>- <td><p></p></td>+ <td><p>User-defined role that can be modified.</p></td></tr></tbody>@@ -27504,7 +27629,7 @@ If this field is omitted, there are no subsequent pages. </p></td><h3 id="bytebase.v1.RoleService">RoleService</h3>- <p></p>+ <p>RoleService manages workspace roles and permissions.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -27515,35 +27640,40 @@ If this field is omitted, there are no subsequent pages. </p></td><td>ListRoles</td><td><a href="#bytebase.v1.ListRolesRequest">ListRolesRequest</a></td><td><a href="#bytebase.v1.ListRolesResponse">ListRolesResponse</a></td>- <td><p>Permissions required: bb.roles.list</p></td>+ <td><p>Lists roles in the workspace.+Permissions required: bb.roles.list</p></td></tr><tr><td>GetRole</td><td><a href="#bytebase.v1.GetRoleRequest">GetRoleRequest</a></td><td><a href="#bytebase.v1.Role">Role</a></td>- <td><p>Permissions required: bb.roles.get</p></td>+ <td><p>Retrieves a role by name.+Permissions required: bb.roles.get</p></td></tr><tr><td>CreateRole</td><td><a href="#bytebase.v1.CreateRoleRequest">CreateRoleRequest</a></td><td><a href="#bytebase.v1.Role">Role</a></td>- <td><p>Permissions required: bb.roles.create</p></td>+ <td><p>Creates a new custom role.+Permissions required: bb.roles.create</p></td></tr><tr><td>UpdateRole</td><td><a href="#bytebase.v1.UpdateRoleRequest">UpdateRoleRequest</a></td><td><a href="#bytebase.v1.Role">Role</a></td>- <td><p>Permissions required: bb.roles.update</p></td>+ <td><p>Updates a role's properties.+Permissions required: bb.roles.update</p></td></tr><tr><td>DeleteRole</td><td><a href="#bytebase.v1.DeleteRoleRequest">DeleteRoleRequest</a></td><td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>- <td><p>Permissions required: bb.roles.delete</p></td>+ <td><p>Deletes a custom role.+Permissions required: bb.roles.delete</p></td></tr></tbody>@@ -27657,7 +27787,7 @@ Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRu<td>reason</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The reason for canceling the task runs. </p></td></tr></tbody>@@ -27704,7 +27834,7 @@ Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task} </p></<td>reason</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The reason for running the tasks. </p></td></tr><tr>@@ -27758,7 +27888,7 @@ Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task} </p></<td>reason</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The reason for skipping the tasks. </p></td></tr></tbody>@@ -28043,7 +28173,7 @@ Use "projects/{project}/rollouts/{rollout}/stages/-/tasks/-" to list all<td>page_size</td><td><a href="#int32">int32</a></td><td></td>- <td><p>Not used.+ <td><p>Pagination is not currently implemented. This field is reserved for future use.The maximum number of taskRuns to return. The service may return fewer thanthis value.If unspecified, at most 10 taskRuns will be returned.@@ -28054,7 +28184,7 @@ The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td><td>page_token</td><td><a href="#string">string</a></td><td></td>- <td><p>Not used.+ <td><p>Pagination is not currently implemented. This field is reserved for future use.A page token, received from a previous `ListTaskRuns` call.Provide this to retrieve the subsequent page.@@ -28171,7 +28301,7 @@ Format: projects/{project} </p></td><td>statement</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The rollback SQL statement that would undo the task run. </p></td></tr></tbody>@@ -28297,7 +28427,7 @@ Format: environments/{environment} for valid environments, or "environments/<td>tasks</td><td><a href="#bytebase.v1.Task">Task</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The tasks within this stage. </p></td></tr></tbody>@@ -28343,7 +28473,7 @@ Could be empty if the rollout of the task does not have an associating plan. </p<td>skipped_reason</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The reason why the task was skipped. </p></td></tr><tr>@@ -28406,7 +28536,7 @@ If there are no task runs or the task run is not scheduled, it will be empty. </<h3 id="bytebase.v1.Task.DatabaseCreate">Task.DatabaseCreate</h3>- <p></p>+ <p>Payload for creating a new database.</p><table class="field-table">@@ -28448,21 +28578,21 @@ Format: projects/{project} </p></td><td>character_set</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The character set for the database. </p></td></tr><tr><td>collation</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The collation for the database. </p></td></tr><tr><td>environment</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The environment the database belongs to. </p></td></tr></tbody>@@ -28473,7 +28603,7 @@ Format: projects/{project} </p></td><h3 id="bytebase.v1.Task.DatabaseDataExport">Task.DatabaseDataExport</h3>- <p></p>+ <p>Payload for exporting database data.</p><table class="field-table">@@ -28509,7 +28639,7 @@ 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.+ <td><p>The zip password provided by users.Leave it empty if no needs to encrypt the zip file. </p></td></tr>@@ -28521,7 +28651,7 @@ Leave it empty if no needs to encrypt the zip file. </p></td><h3 id="bytebase.v1.Task.DatabaseUpdate">Task.DatabaseUpdate</h3>- <p></p>+ <p>Payload for updating a database schema.</p><table class="field-table">@@ -28541,14 +28671,14 @@ Leave it empty if no needs to encrypt the zip file. </p></td><td>schema_version</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The target schema version after this update. </p></td></tr><tr><td>database_change_type</td><td><a href="#bytebase.v1.DatabaseChangeType">DatabaseChangeType</a></td><td></td>- <td><p> </p></td>+ <td><p>The type of database change (MIGRATE or SDL). </p></td></tr><tr>@@ -28586,7 +28716,7 @@ Leave it empty if no needs to encrypt the zip file. </p></td><td>creator</td><td><a href="#string">string</a></td><td></td>- <td><p>Format: user/[email protected] </p></td>+ <td><p>Format: users/[email protected] </p></td></tr><tr>@@ -28607,14 +28737,15 @@ Leave it empty if no needs to encrypt the zip file. </p></td><td>status</td><td><a href="#bytebase.v1.TaskRun.Status">TaskRun.Status</a></td><td></td>- <td><p> </p></td>+ <td><p>The current execution status of the task run. </p></td></tr><tr><td>detail</td><td><a href="#string">string</a></td><td></td>- <td><p>Below are the results of a task run. </p></td>+ <td><p>Below are the results of a task run.+Detailed information about the task run result. </p></td></tr><tr>@@ -28629,21 +28760,21 @@ Format: instances/{instance}/databases/{database}/changelogs/{changelog} </p></t<td>schema_version</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The schema version after this task run completes. </p></td></tr><tr><td>start_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td>- <td><p> </p></td>+ <td><p>The time when the task run started execution. </p></td></tr><tr><td>export_archive_status</td><td><a href="#bytebase.v1.TaskRun.ExportArchiveStatus">TaskRun.ExportArchiveStatus</a></td><td></td>- <td><p> </p></td>+ <td><p>The export archive status for data export tasks. </p></td></tr><tr>@@ -28657,7 +28788,7 @@ Format: instances/{instance}/databases/{database}/changelogs/{changelog} </p></t<td>scheduler_info</td><td><a href="#bytebase.v1.TaskRun.SchedulerInfo">TaskRun.SchedulerInfo</a></td><td></td>- <td><p> </p></td>+ <td><p>Scheduling information about the task run. </p></td></tr><tr>@@ -28683,7 +28814,7 @@ This can only be set when creating the task run calling BatchRunTasks. </p></td><h3 id="bytebase.v1.TaskRun.PriorBackupDetail">TaskRun.PriorBackupDetail</h3>- <p></p>+ <p>Prior backup detail for rollback purposes.</p><table class="field-table">@@ -28696,7 +28827,7 @@ This can only be set when creating the task run calling BatchRunTasks. </p></td><td>items</td><td><a href="#bytebase.v1.TaskRun.PriorBackupDetail.Item">TaskRun.PriorBackupDetail.Item</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The list of backed up tables. </p></td></tr></tbody>@@ -28707,7 +28838,7 @@ This can only be set when creating the task run calling BatchRunTasks. </p></td><h3 id="bytebase.v1.TaskRun.PriorBackupDetail.Item">TaskRun.PriorBackupDetail.Item</h3>- <p></p>+ <p>A single backup table mapping.</p><table class="field-table">@@ -28734,14 +28865,14 @@ This can only be set when creating the task run calling BatchRunTasks. </p></td><td>start_position</td><td><a href="#bytebase.v1.Position">Position</a></td><td></td>- <td><p> </p></td>+ <td><p>The start position in the SQL statement. </p></td></tr><tr><td>end_position</td><td><a href="#bytebase.v1.Position">Position</a></td><td></td>- <td><p> </p></td>+ <td><p>The end position in the SQL statement. </p></td></tr></tbody>@@ -28752,7 +28883,7 @@ This can only be set when creating the task run calling BatchRunTasks. </p></td><h3 id="bytebase.v1.TaskRun.PriorBackupDetail.Item.Table">TaskRun.PriorBackupDetail.Item.Table</h3>- <p></p>+ <p>Table information.</p><table class="field-table">@@ -28773,14 +28904,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>The schema name. </p></td></tr><tr><td>table</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The table name. </p></td></tr></tbody>@@ -28791,7 +28922,7 @@ Format: instances/{instance}/databases/{database} </p></td><h3 id="bytebase.v1.TaskRun.SchedulerInfo">TaskRun.SchedulerInfo</h3>- <p></p>+ <p>Information about task run scheduling.</p><table class="field-table">@@ -28804,14 +28935,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>The time when the scheduling info was reported. </p></td></tr><tr><td>waiting_cause</td><td><a href="#bytebase.v1.TaskRun.SchedulerInfo.WaitingCause">TaskRun.SchedulerInfo.WaitingCause</a></td><td></td>- <td><p> </p></td>+ <td><p>The cause for the task run waiting. </p></td></tr></tbody>@@ -28822,7 +28953,7 @@ Format: instances/{instance}/databases/{database} </p></td><h3 id="bytebase.v1.TaskRun.SchedulerInfo.WaitingCause">TaskRun.SchedulerInfo.WaitingCause</h3>- <p></p>+ <p>Information about why a task run is waiting.</p><table class="field-table">@@ -28835,21 +28966,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>Waiting due to connection limit reached. </p></td></tr><tr><td>task</td><td><a href="#bytebase.v1.TaskRun.SchedulerInfo.WaitingCause.Task">TaskRun.SchedulerInfo.WaitingCause.Task</a></td><td></td>- <td><p> </p></td>+ <td><p>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>Waiting due to parallel tasks limit. </p></td></tr></tbody>@@ -28860,7 +28991,7 @@ Format: instances/{instance}/databases/{database} </p></td><h3 id="bytebase.v1.TaskRun.SchedulerInfo.WaitingCause.Task">TaskRun.SchedulerInfo.WaitingCause.Task</h3>- <p></p>+ <p>Information about a blocking task.</p><table class="field-table">@@ -28911,7 +29042,7 @@ Format: instances/{instance}/databases/{database} </p></td><td>entries</td><td><a href="#bytebase.v1.TaskRunLogEntry">TaskRunLogEntry</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The log entries for this task run. </p></td></tr></tbody>@@ -28935,77 +29066,77 @@ Format: instances/{instance}/databases/{database} </p></td><td>type</td><td><a href="#bytebase.v1.TaskRunLogEntry.Type">TaskRunLogEntry.Type</a></td><td></td>- <td><p> </p></td>+ <td><p>The type of this log entry. </p></td></tr><tr><td>log_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td>- <td><p> </p></td>+ <td><p>The time when the log was recorded. </p></td></tr><tr><td>deploy_id</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The deployment ID for this log entry. </p></td></tr><tr><td>schema_dump</td><td><a href="#bytebase.v1.TaskRunLogEntry.SchemaDump">TaskRunLogEntry.SchemaDump</a></td><td></td>- <td><p> </p></td>+ <td><p>Schema dump details (if type is SCHEMA_DUMP). </p></td></tr><tr><td>command_execute</td><td><a href="#bytebase.v1.TaskRunLogEntry.CommandExecute">TaskRunLogEntry.CommandExecute</a></td><td></td>- <td><p> </p></td>+ <td><p>Command execution details (if type is COMMAND_EXECUTE). </p></td></tr><tr><td>database_sync</td><td><a href="#bytebase.v1.TaskRunLogEntry.DatabaseSync">TaskRunLogEntry.DatabaseSync</a></td><td></td>- <td><p> </p></td>+ <td><p>Database sync details (if type is DATABASE_SYNC). </p></td></tr><tr><td>task_run_status_update</td><td><a href="#bytebase.v1.TaskRunLogEntry.TaskRunStatusUpdate">TaskRunLogEntry.TaskRunStatusUpdate</a></td><td></td>- <td><p> </p></td>+ <td><p>Task run status update details (if type is TASK_RUN_STATUS_UPDATE). </p></td></tr><tr><td>transaction_control</td><td><a href="#bytebase.v1.TaskRunLogEntry.TransactionControl">TaskRunLogEntry.TransactionControl</a></td><td></td>- <td><p> </p></td>+ <td><p>Transaction control details (if type is TRANSACTION_CONTROL). </p></td></tr><tr><td>prior_backup</td><td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup">TaskRunLogEntry.PriorBackup</a></td><td></td>- <td><p> </p></td>+ <td><p>Prior backup details (if type is PRIOR_BACKUP). </p></td></tr><tr><td>retry_info</td><td><a href="#bytebase.v1.TaskRunLogEntry.RetryInfo">TaskRunLogEntry.RetryInfo</a></td><td></td>- <td><p> </p></td>+ <td><p>Retry information details (if type is RETRY_INFO). </p></td></tr><tr><td>compute_diff</td><td><a href="#bytebase.v1.TaskRunLogEntry.ComputeDiff">TaskRunLogEntry.ComputeDiff</a></td><td></td>- <td><p> </p></td>+ <td><p>Compute diff details (if type is COMPUTE_DIFF). </p></td></tr></tbody>@@ -29016,7 +29147,7 @@ Format: instances/{instance}/databases/{database} </p></td><h3 id="bytebase.v1.TaskRunLogEntry.CommandExecute">TaskRunLogEntry.CommandExecute</h3>- <p></p>+ <p>Command execution details.</p><table class="field-table">@@ -29029,7 +29160,7 @@ Format: instances/{instance}/databases/{database} </p></td><td>log_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td>- <td><p> </p></td>+ <td><p>When the command was logged. </p></td></tr><tr>@@ -29051,7 +29182,7 @@ The indexes of the executed commands. </p></td><td>response</td><td><a href="#bytebase.v1.TaskRunLogEntry.CommandExecute.CommandResponse">TaskRunLogEntry.CommandExecute.CommandResponse</a></td><td></td>- <td><p> </p></td>+ <td><p>The response from executing the command. </p></td></tr></tbody>@@ -29062,7 +29193,7 @@ The indexes of the executed commands. </p></td><h3 id="bytebase.v1.TaskRunLogEntry.CommandExecute.CommandResponse">TaskRunLogEntry.CommandExecute.CommandResponse</h3>- <p></p>+ <p>Command execution response.</p><table class="field-table">@@ -29075,21 +29206,21 @@ The indexes of the executed commands. </p></td><td>log_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td>- <td><p> </p></td>+ <td><p>When the response was logged. </p></td></tr><tr><td>error</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Error message if command execution failed. </p></td></tr><tr><td>affected_rows</td><td><a href="#int64">int64</a></td><td></td>- <td><p> </p></td>+ <td><p>Total affected rows. </p></td></tr><tr>@@ -29108,7 +29239,7 @@ The indexes of the executed commands. </p></td><h3 id="bytebase.v1.TaskRunLogEntry.ComputeDiff">TaskRunLogEntry.ComputeDiff</h3>- <p></p>+ <p>Schema diff computation details.</p><table class="field-table">@@ -29121,21 +29252,21 @@ The indexes of the executed commands. </p></td><td>start_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td>- <td><p> </p></td>+ <td><p>When diff computation started. </p></td></tr><tr><td>end_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td>- <td><p> </p></td>+ <td><p>When diff computation ended. </p></td></tr><tr><td>error</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Error message if computation failed. </p></td></tr></tbody>@@ -29146,7 +29277,7 @@ The indexes of the executed commands. </p></td><h3 id="bytebase.v1.TaskRunLogEntry.DatabaseSync">TaskRunLogEntry.DatabaseSync</h3>- <p></p>+ <p>Database synchronization details.</p><table class="field-table">@@ -29159,21 +29290,21 @@ The indexes of the executed commands. </p></td><td>start_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td>- <td><p> </p></td>+ <td><p>When the database sync started. </p></td></tr><tr><td>end_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td>- <td><p> </p></td>+ <td><p>When the database sync ended. </p></td></tr><tr><td>error</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Error message if sync failed. </p></td></tr></tbody>@@ -29184,7 +29315,7 @@ The indexes of the executed commands. </p></td><h3 id="bytebase.v1.TaskRunLogEntry.PriorBackup">TaskRunLogEntry.PriorBackup</h3>- <p></p>+ <p>Prior backup operation details.</p><table class="field-table">@@ -29197,28 +29328,28 @@ The indexes of the executed commands. </p></td><td>start_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td>- <td><p> </p></td>+ <td><p>When the backup started. </p></td></tr><tr><td>end_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td>- <td><p> </p></td>+ <td><p>When the backup ended. </p></td></tr><tr><td>prior_backup_detail</td><td><a href="#bytebase.v1.TaskRun.PriorBackupDetail">TaskRun.PriorBackupDetail</a></td><td></td>- <td><p> </p></td>+ <td><p>The backup details. </p></td></tr><tr><td>error</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Error message if the backup failed. </p></td></tr></tbody>@@ -29229,7 +29360,7 @@ The indexes of the executed commands. </p></td><h3 id="bytebase.v1.TaskRunLogEntry.RetryInfo">TaskRunLogEntry.RetryInfo</h3>- <p></p>+ <p>Retry information for failed operations.</p><table class="field-table">@@ -29242,21 +29373,21 @@ The indexes of the executed commands. </p></td><td>error</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The error that triggered the retry. </p></td></tr><tr><td>retry_count</td><td><a href="#int32">int32</a></td><td></td>- <td><p> </p></td>+ <td><p>Current retry attempt number. </p></td></tr><tr><td>maximum_retries</td><td><a href="#int32">int32</a></td><td></td>- <td><p> </p></td>+ <td><p>Maximum number of retries allowed. </p></td></tr></tbody>@@ -29267,7 +29398,7 @@ The indexes of the executed commands. </p></td><h3 id="bytebase.v1.TaskRunLogEntry.SchemaDump">TaskRunLogEntry.SchemaDump</h3>- <p></p>+ <p>Schema dump operation details.</p><table class="field-table">@@ -29280,21 +29411,21 @@ The indexes of the executed commands. </p></td><td>start_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td>- <td><p> </p></td>+ <td><p>When the schema dump started. </p></td></tr><tr><td>end_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td>- <td><p> </p></td>+ <td><p>When the schema dump ended. </p></td></tr><tr><td>error</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Error message if the schema dump failed. </p></td></tr></tbody>@@ -29305,7 +29436,7 @@ The indexes of the executed commands. </p></td><h3 id="bytebase.v1.TaskRunLogEntry.TaskRunStatusUpdate">TaskRunLogEntry.TaskRunStatusUpdate</h3>- <p></p>+ <p>Task run status update details.</p><table class="field-table">@@ -29318,7 +29449,7 @@ The indexes of the executed commands. </p></td><td>status</td><td><a href="#bytebase.v1.TaskRunLogEntry.TaskRunStatusUpdate.Status">TaskRunLogEntry.TaskRunStatusUpdate.Status</a></td><td></td>- <td><p> </p></td>+ <td><p>The new status. </p></td></tr></tbody>@@ -29329,7 +29460,7 @@ The indexes of the executed commands. </p></td><h3 id="bytebase.v1.TaskRunLogEntry.TransactionControl">TaskRunLogEntry.TransactionControl</h3>- <p></p>+ <p>Transaction control operation details.</p><table class="field-table">@@ -29342,14 +29473,14 @@ The indexes of the executed commands. </p></td><td>type</td><td><a href="#bytebase.v1.TaskRunLogEntry.TransactionControl.Type">TaskRunLogEntry.TransactionControl.Type</a></td><td></td>- <td><p> </p></td>+ <td><p>The type of transaction control. </p></td></tr><tr><td>error</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Error message if the operation failed. </p></td></tr></tbody>@@ -29380,7 +29511,7 @@ The indexes of the executed commands. </p></td><td>postgres</td><td><a href="#bytebase.v1.TaskRunSession.Postgres">TaskRunSession.Postgres</a></td><td></td>- <td><p> </p></td>+ <td><p>PostgreSQL session information. </p></td></tr></tbody>@@ -29391,7 +29522,7 @@ The indexes of the executed commands. </p></td><h3 id="bytebase.v1.TaskRunSession.Postgres">TaskRunSession.Postgres</h3>- <p></p>+ <p>PostgreSQL session information.</p><table class="field-table">@@ -29429,7 +29560,7 @@ The indexes of the executed commands. </p></td><h3 id="bytebase.v1.TaskRunSession.Postgres.Session">TaskRunSession.Postgres.Session</h3>- <p>Read from `pg_stat_activity`</p>+ <p>PostgreSQL session information read from `pg_stat_activity`.</p><table class="field-table">@@ -29442,98 +29573,98 @@ The indexes of the executed commands. </p></td><td>pid</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Process ID of the session. </p></td></tr><tr><td>blocked_by_pids</td><td><a href="#string">string</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>PIDs of sessions blocking this session. </p></td></tr><tr><td>query</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Current query being executed. </p></td></tr><tr><td>state</td><td><a href="#string">string</a></td><td>optional</td>- <td><p> </p></td>+ <td><p>Session state (active, idle, etc.). </p></td></tr><tr><td>wait_event_type</td><td><a href="#string">string</a></td><td>optional</td>- <td><p> </p></td>+ <td><p>Wait event type if session is waiting. </p></td></tr><tr><td>wait_event</td><td><a href="#string">string</a></td><td>optional</td>- <td><p> </p></td>+ <td><p>Specific wait event if session is waiting. </p></td></tr><tr><td>datname</td><td><a href="#string">string</a></td><td>optional</td>- <td><p> </p></td>+ <td><p>Database name. </p></td></tr><tr><td>usename</td><td><a href="#string">string</a></td><td>optional</td>- <td><p> </p></td>+ <td><p>User name. </p></td></tr><tr><td>application_name</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Application name. </p></td></tr><tr><td>client_addr</td><td><a href="#string">string</a></td><td>optional</td>- <td><p> </p></td>+ <td><p>Client IP address. </p></td></tr><tr><td>client_port</td><td><a href="#string">string</a></td><td>optional</td>- <td><p> </p></td>+ <td><p>Client port number. </p></td></tr><tr><td>backend_start</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td>- <td><p> </p></td>+ <td><p>When the backend process started. </p></td></tr><tr><td>xact_start</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td>optional</td>- <td><p> </p></td>+ <td><p>When the current transaction started. </p></td></tr><tr><td>query_start</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td>optional</td>- <td><p> </p></td>+ <td><p>When the current query started. </p></td></tr></tbody>@@ -29556,49 +29687,49 @@ The indexes of the executed commands. </p></td><tr><td>STATUS_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified status.</p></td></tr><tr><td>NOT_STARTED</td><td>1</td>- <td><p></p></td>+ <td><p>Task has not started and is awaiting its turn in the deployment sequence.</p></td></tr><tr><td>PENDING</td><td>2</td>- <td><p></p></td>+ <td><p>Task is ready to run and waiting for approval or scheduled time.</p></td></tr><tr><td>RUNNING</td><td>3</td>- <td><p></p></td>+ <td><p>Task is currently executing.</p></td></tr><tr><td>DONE</td><td>4</td>- <td><p></p></td>+ <td><p>Task completed successfully.</p></td></tr><tr><td>FAILED</td><td>5</td>- <td><p></p></td>+ <td><p>Task execution failed with errors.</p></td></tr><tr><td>CANCELED</td><td>6</td>- <td><p></p></td>+ <td><p>Task execution was canceled by a user.</p></td></tr><tr><td>SKIPPED</td><td>7</td>- <td><p></p></td>+ <td><p>Task was skipped and will not be executed.</p></td></tr></tbody>@@ -29615,37 +29746,41 @@ The indexes of the executed commands. </p></td><tr><td>TYPE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified task type.</p></td></tr><tr><td>GENERAL</td><td>1</td>- <td><p></p></td>+ <td><p>General task for miscellaneous operations.</p></td></tr><tr><td>DATABASE_CREATE</td><td>2</td>- <td><p>use payload DatabaseCreate</p></td>+ <td><p>Database creation task that creates a new database.+Use payload DatabaseCreate.</p></td></tr><tr><td>DATABASE_MIGRATE</td><td>3</td>- <td><p>use payload DatabaseUpdate</p></td>+ <td><p>Database migration task that applies versioned schema changes.+Use payload DatabaseUpdate.</p></td></tr><tr><td>DATABASE_SDL</td><td>6</td>- <td><p>use payload DatabaseUpdate</p></td>+ <td><p>Database SDL (Schema Definition Language) task that synchronizes declarative schema.+Use payload DatabaseUpdate.</p></td></tr><tr><td>DATABASE_EXPORT</td><td>5</td>- <td><p>use payload DatabaseDataExport</p></td>+ <td><p>Database export task that exports query results or table data.+Use payload DatabaseDataExport.</p></td></tr></tbody>@@ -29662,19 +29797,19 @@ The indexes of the executed commands. </p></td><tr><td>EXPORT_ARCHIVE_STATUS_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified export archive status.</p></td></tr><tr><td>READY</td><td>1</td>- <td><p></p></td>+ <td><p>Export archive is ready for download.</p></td></tr><tr><td>EXPORTED</td><td>2</td>- <td><p></p></td>+ <td><p>Export archive has been downloaded by the user.</p></td></tr></tbody>@@ -29691,44 +29826,44 @@ The indexes of the executed commands. </p></td><tr><td>STATUS_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified status.</p></td></tr><tr><td>PENDING</td><td>1</td>- <td><p></p></td>+ <td><p>Task run is queued and waiting to start execution.</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 execution failed with errors.</p></td></tr><tr><td>CANCELED</td><td>5</td>- <td><p></p></td>+ <td><p>Task run execution was canceled by a user.</p></td></tr></tbody></table><h3 id="bytebase.v1.TaskRunLogEntry.TaskRunStatusUpdate.Status">TaskRunLogEntry.TaskRunStatusUpdate.Status</h3>- <p></p>+ <p>Internal status for task run execution.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -29738,7 +29873,7 @@ The indexes of the executed commands. </p></td><tr><td>STATUS_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified status.</p></td></tr><tr>@@ -29757,7 +29892,7 @@ The indexes of the executed commands. </p></td></table><h3 id="bytebase.v1.TaskRunLogEntry.TransactionControl.Type">TaskRunLogEntry.TransactionControl.Type</h3>- <p></p>+ <p>Transaction control type.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -29767,32 +29902,32 @@ The indexes of the executed commands. </p></td><tr><td>TYPE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified type.</p></td></tr><tr><td>BEGIN</td><td>1</td>- <td><p></p></td>+ <td><p>Begin transaction.</p></td></tr><tr><td>COMMIT</td><td>2</td>- <td><p></p></td>+ <td><p>Commit transaction.</p></td></tr><tr><td>ROLLBACK</td><td>3</td>- <td><p></p></td>+ <td><p>Rollback transaction.</p></td></tr></tbody></table><h3 id="bytebase.v1.TaskRunLogEntry.Type">TaskRunLogEntry.Type</h3>- <p></p>+ <p>The type of log entry.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -29802,55 +29937,55 @@ The indexes of the executed commands. </p></td><tr><td>TYPE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified type.</p></td></tr><tr><td>SCHEMA_DUMP</td><td>1</td>- <td><p></p></td>+ <td><p>Schema dump operation.</p></td></tr><tr><td>COMMAND_EXECUTE</td><td>2</td>- <td><p></p></td>+ <td><p>Command execution.</p></td></tr><tr><td>DATABASE_SYNC</td><td>3</td>- <td><p></p></td>+ <td><p>Database synchronization.</p></td></tr><tr><td>TASK_RUN_STATUS_UPDATE</td><td>4</td>- <td><p></p></td>+ <td><p>Task run status update.</p></td></tr><tr><td>TRANSACTION_CONTROL</td><td>5</td>- <td><p></p></td>+ <td><p>Transaction control (BEGIN, COMMIT, ROLLBACK).</p></td></tr><tr><td>PRIOR_BACKUP</td><td>6</td>- <td><p></p></td>+ <td><p>Prior backup operation.</p></td></tr><tr><td>RETRY_INFO</td><td>7</td>- <td><p></p></td>+ <td><p>Retry information.</p></td></tr><tr><td>COMPUTE_DIFF</td><td>8</td>- <td><p></p></td>+ <td><p>Schema diff computation.</p></td></tr></tbody>@@ -29861,7 +29996,7 @@ The indexes of the executed commands. </p></td><h3 id="bytebase.v1.RolloutService">RolloutService</h3>- <p></p>+ <p>RolloutService manages the execution of deployment plans.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -29872,84 +30007,96 @@ The indexes of the executed commands. </p></td><td>GetRollout</td><td><a href="#bytebase.v1.GetRolloutRequest">GetRolloutRequest</a></td><td><a href="#bytebase.v1.Rollout">Rollout</a></td>- <td><p>Permissions required: bb.rollouts.get</p></td>+ <td><p>Retrieves a rollout by name.+Permissions required: bb.rollouts.get</p></td></tr><tr><td>ListRollouts</td><td><a href="#bytebase.v1.ListRolloutsRequest">ListRolloutsRequest</a></td><td><a href="#bytebase.v1.ListRolloutsResponse">ListRolloutsResponse</a></td>- <td><p>Permissions required: bb.rollouts.list</p></td>+ <td><p>Lists rollouts in a project.+Permissions required: bb.rollouts.list</p></td></tr><tr><td>CreateRollout</td><td><a href="#bytebase.v1.CreateRolloutRequest">CreateRolloutRequest</a></td><td><a href="#bytebase.v1.Rollout">Rollout</a></td>- <td><p>Permissions required: bb.rollouts.create</p></td>+ <td><p>Creates a new rollout from a plan.+Permissions required: bb.rollouts.create</p></td></tr><tr><td>PreviewRollout</td><td><a href="#bytebase.v1.PreviewRolloutRequest">PreviewRolloutRequest</a></td><td><a href="#bytebase.v1.Rollout">Rollout</a></td>- <td><p>Permissions required: bb.rollouts.preview</p></td>+ <td><p>Previews the rollout that would be created from a plan.+Permissions required: bb.rollouts.preview</p></td></tr><tr><td>ListTaskRuns</td><td><a href="#bytebase.v1.ListTaskRunsRequest">ListTaskRunsRequest</a></td><td><a href="#bytebase.v1.ListTaskRunsResponse">ListTaskRunsResponse</a></td>- <td><p>Permissions required: bb.taskRuns.list</p></td>+ <td><p>Lists task run executions for a task.+Permissions required: bb.taskRuns.list</p></td></tr><tr><td>GetTaskRun</td><td><a href="#bytebase.v1.GetTaskRunRequest">GetTaskRunRequest</a></td><td><a href="#bytebase.v1.TaskRun">TaskRun</a></td>- <td><p>Permissions required: bb.taskRuns.list</p></td>+ <td><p>Retrieves a task run by name.+Permissions required: bb.taskRuns.list</p></td></tr><tr><td>GetTaskRunLog</td><td><a href="#bytebase.v1.GetTaskRunLogRequest">GetTaskRunLogRequest</a></td><td><a href="#bytebase.v1.TaskRunLog">TaskRunLog</a></td>- <td><p>Permissions required: bb.taskRuns.list</p></td>+ <td><p>Retrieves execution logs for a task run.+Permissions required: bb.taskRuns.list</p></td></tr><tr><td>GetTaskRunSession</td><td><a href="#bytebase.v1.GetTaskRunSessionRequest">GetTaskRunSessionRequest</a></td><td><a href="#bytebase.v1.TaskRunSession">TaskRunSession</a></td>- <td><p>Permissions required: bb.taskRuns.list</p></td>+ <td><p>Retrieves database session information for a running task.+Permissions required: bb.taskRuns.list</p></td></tr><tr><td>BatchRunTasks</td><td><a href="#bytebase.v1.BatchRunTasksRequest">BatchRunTasksRequest</a></td><td><a href="#bytebase.v1.BatchRunTasksResponse">BatchRunTasksResponse</a></td>- <td><p>Permissions required: None</p></td>+ <td><p>Executes multiple tasks in a rollout stage.+Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)</p></td></tr><tr><td>BatchSkipTasks</td><td><a href="#bytebase.v1.BatchSkipTasksRequest">BatchSkipTasksRequest</a></td><td><a href="#bytebase.v1.BatchSkipTasksResponse">BatchSkipTasksResponse</a></td>- <td><p>Permissions required: None</p></td>+ <td><p>Skips multiple tasks in a rollout stage.+Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)</p></td></tr><tr><td>BatchCancelTaskRuns</td><td><a href="#bytebase.v1.BatchCancelTaskRunsRequest">BatchCancelTaskRunsRequest</a></td><td><a href="#bytebase.v1.BatchCancelTaskRunsResponse">BatchCancelTaskRunsResponse</a></td>- <td><p>Permissions required: None</p></td>+ <td><p>Cancels multiple running task executions.+Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)</p></td></tr><tr><td>PreviewTaskRunRollback</td><td><a href="#bytebase.v1.PreviewTaskRunRollbackRequest">PreviewTaskRunRollbackRequest</a></td><td><a href="#bytebase.v1.PreviewTaskRunRollbackResponse">PreviewTaskRunRollbackResponse</a></td>- <td><p>Permissions required: bb.taskRuns.list</p></td>+ <td><p>Generates rollback SQL for a completed task run.+Permissions required: bb.taskRuns.list</p></td></tr></tbody>@@ -30236,9 +30383,9 @@ Format: projects/{project}/sheets/{sheet} </p></td><td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>The name of the sheet resource, generated by the server.-Canonical parent is project.-Format: projects/{project}/sheets/{sheet} </p></td>+ <td><p>The name of the sheet resource.+Format: projects/{project}/sheets/{sheet}+The sheet ID is generated by the server on creation and cannot be changed. </p></td></tr><tr>@@ -30283,7 +30430,7 @@ set the `raw` to true in GetSheet request to retrieve the full content. </p></td<td>payload</td><td><a href="#bytebase.v1.SheetPayload">SheetPayload</a></td><td></td>- <td><p> </p></td>+ <td><p>Additional metadata and configuration for the sheet. </p></td></tr><tr>@@ -30439,7 +30586,7 @@ In this situation, `update_mask` is ignored. </p></td><h3 id="bytebase.v1.SheetService">SheetService</h3>- <p></p>+ <p>SheetService manages SQL scripts and saved queries.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -30450,28 +30597,32 @@ In this situation, `update_mask` is ignored. </p></td><td>CreateSheet</td><td><a href="#bytebase.v1.CreateSheetRequest">CreateSheetRequest</a></td><td><a href="#bytebase.v1.Sheet">Sheet</a></td>- <td><p>Permissions required: bb.sheets.create</p></td>+ <td><p>Creates a new SQL sheet.+Permissions required: bb.sheets.create</p></td></tr><tr><td>BatchCreateSheets</td><td><a href="#bytebase.v1.BatchCreateSheetsRequest">BatchCreateSheetsRequest</a></td><td><a href="#bytebase.v1.BatchCreateSheetsResponse">BatchCreateSheetsResponse</a></td>- <td><p>Permissions required: bb.sheets.create</p></td>+ <td><p>Creates multiple SQL sheets in a single operation.+Permissions required: bb.sheets.create</p></td></tr><tr><td>GetSheet</td><td><a href="#bytebase.v1.GetSheetRequest">GetSheetRequest</a></td><td><a href="#bytebase.v1.Sheet">Sheet</a></td>- <td><p>Permissions required: bb.sheets.get</p></td>+ <td><p>Retrieves a SQL sheet by name.+Permissions required: bb.sheets.get</p></td></tr><tr><td>UpdateSheet</td><td><a href="#bytebase.v1.UpdateSheetRequest">UpdateSheetRequest</a></td><td><a href="#bytebase.v1.Sheet">Sheet</a></td>- <td><p>Permissions required: bb.sheets.update</p></td>+ <td><p>Updates a SQL sheet's title or content.+Permissions required: bb.sheets.update</p></td></tr></tbody>@@ -31187,25 +31338,25 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>PLAN_TYPE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified plan type.</p></td></tr><tr><td>FREE</td><td>1</td>- <td><p></p></td>+ <td><p>Free plan with basic features and no cost.</p></td></tr><tr><td>TEAM</td><td>2</td>- <td><p></p></td>+ <td><p>Team plan with collaboration features for small to medium teams.</p></td></tr><tr><td>ENTERPRISE</td><td>3</td>- <td><p></p></td>+ <td><p>Enterprise plan with advanced features and dedicated support.</p></td></tr></tbody>@@ -31216,7 +31367,7 @@ In this situation, `update_mask` is ignored. </p></td><h3 id="bytebase.v1.SubscriptionService">SubscriptionService</h3>- <p></p>+ <p>SubscriptionService manages enterprise subscriptions and licensing.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -31237,7 +31388,8 @@ Permissions required: None</p></td><td>UpdateSubscription</td><td><a href="#bytebase.v1.UpdateSubscriptionRequest">UpdateSubscriptionRequest</a></td><td><a href="#bytebase.v1.Subscription">Subscription</a></td>- <td><p>Permissions required: bb.settings.set</p></td>+ <td><p>Updates the enterprise license subscription.+Permissions required: bb.settings.set</p></td></tr></tbody>@@ -31399,7 +31551,7 @@ visibility == "PRIVATE" </p></td><td>page_size</td><td><a href="#int32">int32</a></td><td></td>- <td><p>Not used.+ <td><p>Pagination is not currently implemented. This field is reserved for future use.The maximum number of worksheets to return. The service may return fewer thanthis value.If unspecified, at most 10 worksheets will be returned.@@ -31410,7 +31562,7 @@ The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td><td>page_token</td><td><a href="#string">string</a></td><td></td>- <td><p>Not used.+ <td><p>Pagination is not currently implemented. This field is reserved for future use.A page token, received from a previous `SearchWorksheets` call.Provide this to retrieve the subsequent page.@@ -31446,7 +31598,8 @@ the call that provided the page token. </p></td><td>next_page_token</td><td><a href="#string">string</a></td><td></td>- <td><p>Not used. A token, which can be sent as `page_token` to retrieve the next page.+ <td><p>Pagination is not currently implemented. This field is reserved for future use.+A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages. </p></td></tr>@@ -31719,7 +31872,7 @@ Format: worksheets/{worksheet} </p></td><h3 id="bytebase.v1.WorksheetService">WorksheetService</h3>- <p></p>+ <p>WorksheetService manages SQL worksheets for query development.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -31730,8 +31883,8 @@ Format: worksheets/{worksheet} </p></td><td>CreateWorksheet</td><td><a href="#bytebase.v1.CreateWorksheetRequest">CreateWorksheetRequest</a></td><td><a href="#bytebase.v1.Worksheet">Worksheet</a></td>- <td><p>Create a personal worksheet used in SQL Editor.-Permissions required: None</p></td>+ <td><p>Creates a personal worksheet used in SQL Editor. Any authenticated user can create their own worksheets.+Permissions required: None (authenticated users only)</p></td></tr><tr>@@ -31743,7 +31896,7 @@ The users can access this method if,- they are the creator of the worksheet;- they have bb.worksheets.get permission on the workspace;- the sheet is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.-Permissions required: None</p></td>+Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)</p></td></tr><tr>@@ -31753,7 +31906,7 @@ Permissions required: None</p></td><td><p>Search for worksheets.This is used for finding my worksheets or worksheets shared by other people.The sheet accessibility is the same as GetWorksheet().-Permissions required: None</p></td>+Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)</p></td></tr><tr>@@ -31765,7 +31918,7 @@ The users can access this method if,- they are the creator of the worksheet;- they have bb.worksheets.manage permission on the workspace;- the sheet is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.-Permissions required: None</p></td>+Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)</p></td></tr><tr>@@ -31774,7 +31927,7 @@ Permissions required: None</p></td><td><a href="#bytebase.v1.WorksheetOrganizer">WorksheetOrganizer</a></td><td><p>Update the organizer of a worksheet.The access is the same as UpdateWorksheet method.-Permissions required: None</p></td>+Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)</p></td></tr><tr>@@ -31783,7 +31936,7 @@ Permissions required: None</p></td><td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td><td><p>Delete a worksheet.The access is the same as UpdateWorksheet method.-Permissions required: None</p></td>+Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)</p></td></tr></tbody>@@ -31883,7 +32036,7 @@ Permissions required: None</p></td><h3 id="bytebase.v1.WorkspaceService">WorkspaceService</h3>- <p></p>+ <p>WorkspaceService manages workspace-level operations and profile.</p><table class="enum-table"><thead><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>@@ -31894,14 +32047,16 @@ Permissions required: None</p></td><td>GetIamPolicy</td><td><a href="#bytebase.v1.GetIamPolicyRequest">GetIamPolicyRequest</a></td><td><a href="#bytebase.v1.IamPolicy">IamPolicy</a></td>- <td><p>Permissions required: bb.workspaces.getIamPolicy</p></td>+ <td><p>Retrieves IAM policy for the workspace.+Permissions required: bb.workspaces.getIamPolicy</p></td></tr><tr><td>SetIamPolicy</td><td><a href="#bytebase.v1.SetIamPolicyRequest">SetIamPolicyRequest</a></td><td><a href="#bytebase.v1.IamPolicy">IamPolicy</a></td>- <td><p>Permissions required: bb.workspaces.setIamPolicy</p></td>+ <td><p>Sets IAM policy for the workspace.+Permissions required: bb.workspaces.setIamPolicy</p></td></tr></tbody>diff --git a/proto/v1/v1/actuator_service.proto b/proto/v1/v1/actuator_service.protoindex dc5e82ab56..54956a0d2f 100644--- a/proto/v1/v1/actuator_service.proto+++ b/proto/v1/v1/actuator_service.proto@@ -15,7 +15,9 @@ import "v1/user_service.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// ActuatorService manages system health and operational information.service ActuatorService {+ // Gets system information and health status of the Bytebase instance.// Permissions required: Nonerpc GetActuatorInfo(GetActuatorInfoRequest) returns (ActuatorInfo) {option (google.api.http) = {get: "/v1/actuator/info"};@@ -23,6 +25,7 @@ service ActuatorService {option (bytebase.v1.allow_without_credential) = true;}+ // Updates system configuration settings for the Bytebase instance.// Permissions required: bb.settings.setrpc UpdateActuatorInfo(UpdateActuatorInfoRequest) returns (ActuatorInfo) {option (google.api.http) = {@@ -34,6 +37,7 @@ service ActuatorService {option (bytebase.v1.auth_method) = IAM;}+ // Sets up sample data for demonstration and testing purposes.// Permissions required: bb.projects.createrpc SetupSample(SetupSampleRequest) returns (google.protobuf.Empty) {option (google.api.http) = {@@ -44,12 +48,14 @@ service ActuatorService {option (bytebase.v1.auth_method) = IAM;}+ // Clears the system cache to force data refresh.// Permissions required: Nonerpc DeleteCache(DeleteCacheRequest) returns (google.protobuf.Empty) {option (google.api.http) = {delete: "/v1/actuator/cache"};option (bytebase.v1.allow_without_credential) = true;}+ // Gets custom branding resources such as logos.// Permissions required: Nonerpc GetResourcePackage(GetResourcePackageRequest) returns (ResourcePackage) {option (google.api.http) = {get: "/v1/actuator/resources"};@@ -58,19 +64,22 @@ service ActuatorService {}}-// The request message for getting the theme resource.+// Request message for getting branding resources.message GetResourcePackageRequest {}-// The theme resources.+// Custom branding resources for the Bytebase instance.message ResourcePackage {// The branding logo.bytes logo = 1;}+// Request message for setting up sample data.message SetupSampleRequest {}+// Request message for getting actuator information.message GetActuatorInfoRequest {}+// Request message for updating actuator information.message UpdateActuatorInfoRequest {// The actuator to update.ActuatorInfo actuator = 1 [(google.api.field_behavior) = REQUIRED];@@ -83,73 +92,84 @@ message UpdateActuatorInfoRequest {bool allow_missing = 3;}+// Request message for deleting cache.message DeleteCacheRequest {}-// ServerInfo is the API message for server info.+// System information and configuration for the Bytebase instance.// Actuator concept is similar to the Spring Boot Actuator.message ActuatorInfo {- // version is the bytebase's server version+ // The Bytebase server version.string version = 1 [(google.api.field_behavior) = OUTPUT_ONLY];- // git_commit is the git commit hash of the build+ // The git commit hash of the build.string git_commit = 2 [(google.api.field_behavior) = OUTPUT_ONLY];- // readonly flag means if the Bytebase is running in readonly mode.+ // Whether the Bytebase instance is running in read-only mode.bool readonly = 3 [(google.api.field_behavior) = OUTPUT_ONLY];- // saas flag means if the Bytebase is running in SaaS mode, some features are not allowed to edit by users.+ // Whether the Bytebase instance is running in SaaS mode where some features cannot be edited by users.bool saas = 4 [(google.api.field_behavior) = OUTPUT_ONLY];- // demo flag means if the Bytebase is running in demo mode.+ // Whether the Bytebase instance is running in demo mode.bool demo = 5 [(google.api.field_behavior) = OUTPUT_ONLY];- // host is the Bytebase instance host.+ // The host address of the Bytebase instance.string host = 6 [(google.api.field_behavior) = OUTPUT_ONLY];- // port is the Bytebase instance port.+ // The port number of the Bytebase instance.string port = 7 [(google.api.field_behavior) = OUTPUT_ONLY];- // external_url is the URL where user or webhook callback visits Bytebase.+ // The external URL where users or webhook callbacks access Bytebase.string external_url = 8 [(google.api.field_behavior) = OUTPUT_ONLY];- // need_admin_setup flag means the Bytebase instance doesn't have any end users.+ // Whether the Bytebase instance requires initial admin setup.bool need_admin_setup = 9 [(google.api.field_behavior) = OUTPUT_ONLY];- // disallow_signup is the flag to disable self-service signup.+ // Whether self-service user signup is disabled.bool disallow_signup = 10 [(google.api.field_behavior) = OUTPUT_ONLY];- // last_active_time is the service last active time in UTC Time Format, any API calls will refresh this value.+ // The last time any API call was made, refreshed on each request.google.protobuf.Timestamp last_active_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY];- // require_2fa is the flag to require 2FA for all users.+ // Whether two-factor authentication is required for all users.bool require_2fa = 12 [(google.api.field_behavior) = OUTPUT_ONLY];- // workspace_id is the identifier for the workspace.+ // The unique identifier for the workspace.string workspace_id = 13 [(google.api.field_behavior) = OUTPUT_ONLY];- // debug flag means if the debug mode is enabled.+ // Whether debug mode is enabled.bool debug = 15;+ // List of features that are not licensed.repeated string unlicensed_features = 19 [(google.api.field_behavior) = OUTPUT_ONLY];- // disallow_password_signin is the flag to disallow user signin with email&password. (except workspace admins)+ // Whether password-based signin is disabled (except for workspace admins).bool disallow_password_signin = 20 [(google.api.field_behavior) = OUTPUT_ONLY];+ // Password complexity and restriction requirements.PasswordRestrictionSetting password_restriction = 21 [(google.api.field_behavior) = OUTPUT_ONLY];- // docker flag means if the Bytebase instance is running in docker.+ // Whether the Bytebase instance is running in Docker.bool docker = 22 [(google.api.field_behavior) = OUTPUT_ONLY];+ // User statistics by type and state.message StatUser {+ // The type of user.UserType user_type = 1;+ // The state of the user.State state = 2;+ // The count of users matching this type and state.int32 count = 3;}+ // Statistics about users in the system.repeated StatUser user_stats = 23 [(google.api.field_behavior) = OUTPUT_ONLY];+ // The number of activated database instances.int32 activated_instance_count = 24 [(google.api.field_behavior) = OUTPUT_ONLY];+ // The total number of database instances.int32 total_instance_count = 25 [(google.api.field_behavior) = OUTPUT_ONLY];+ // Whether sample data setup is enabled.bool enable_sample = 26 [(google.api.field_behavior) = OUTPUT_ONLY];}diff --git a/proto/v1/v1/annotation.proto b/proto/v1/v1/annotation.protoindex f6be3b5004..9fdec724cf 100644--- a/proto/v1/v1/annotation.proto+++ b/proto/v1/v1/annotation.proto@@ -6,17 +6,24 @@ import "google/protobuf/descriptor.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// Extends MethodOptions to add Bytebase-specific RPC method annotations.extend google.protobuf.MethodOptions {+ // Whether the method allows access without authentication credentials.bool allow_without_credential = 100000;+ // The permission required to call this method.string permission = 100001;+ // The authorization method to use for this RPC.AuthMethod auth_method = 100002;+ // Whether to audit calls to this method.bool audit = 100003;}+// Authorization method for RPC calls.enum AuthMethod {+ // Unspecified authorization method.AUTH_METHOD_UNSPECIFIED = 0;- // IAM uses the standard IAM authorization check on the organizational resources.+ // Standard IAM authorization check on organizational resources.IAM = 1;- // Custom authorization method.+ // Custom authorization logic.CUSTOM = 2;}diff --git a/proto/v1/v1/audit_log_service.proto b/proto/v1/v1/audit_log_service.protoindex a3bea25d5a..583dbfc0ca 100644--- a/proto/v1/v1/audit_log_service.proto+++ b/proto/v1/v1/audit_log_service.proto@@ -15,8 +15,10 @@ import "v1/iam_policy.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// AuditLogService manages audit logs for system activities and API calls.service AuditLogService {- // Permissions required: None+ // Searches audit logs with optional filtering and pagination.+ // Permissions required: bb.auditLogs.searchrpc SearchAuditLogs(SearchAuditLogsRequest) returns (SearchAuditLogsResponse) {option (google.api.http) = {post: "/v1/{parent=projects/*}/auditLogs:search"@@ -30,6 +32,7 @@ service AuditLogService {option (bytebase.v1.auth_method) = IAM;}+ // Exports audit logs in a specified format for external analysis.// Permissions required: bb.auditLogs.exportrpc ExportAuditLogs(ExportAuditLogsRequest) returns (ExportAuditLogsResponse) {option (google.api.http) = {@@ -45,6 +48,7 @@ service AuditLogService {}}+// Request message for searching audit logs.message SearchAuditLogsRequest {string parent = 5 [(google.api.field_behavior) = REQUIRED,@@ -85,6 +89,7 @@ message SearchAuditLogsRequest {string page_token = 4;}+// Response message for searching audit logs.message SearchAuditLogsResponse {repeated AuditLog audit_logs = 1;@@ -94,6 +99,7 @@ message SearchAuditLogsResponse {string next_page_token = 2;}+// Request message for exporting audit logs.message ExportAuditLogsRequest {string parent = 4 [(google.api.field_behavior) = REQUIRED,@@ -125,7 +131,9 @@ message ExportAuditLogsRequest {string page_token = 6;}+// Response message for exporting audit logs.message ExportAuditLogsResponse {+ // The exported audit log content in the requested format.bytes content = 1;// A token to retrieve next page of log entities.@@ -134,6 +142,7 @@ message ExportAuditLogsResponse {string next_page_token = 2;}+// Audit log entry recording system activity or API call.message AuditLog {// The name of the log.// Formats:@@ -141,60 +150,77 @@ message AuditLog {// - workspaces/{workspace}/auditLogs/{uid}string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];+ // The timestamp when the audit log was created.google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];- // Format: users/[email protected]+ // The user who performed the action.+ // Format: users/{email}string user = 3;- // e.g. `/bytebase.v1.SQLService/Query`, `bb.project.repository.push`+ // The method or action being audited.+ // For example: /bytebase.v1.SQLService/Query or bb.project.repository.pushstring method = 4;+ // The severity level of this audit log entry.Severity severity = 5;- // The associated resource.+ // The resource associated with this audit log.string resource = 6;- // JSON-encoded request.+ // The request payload in JSON format.string request = 7;- // JSON-encoded response.- // Some fields are omitted because they are too large or contain sensitive information.+ // The response payload in JSON format.+ // Some fields may be omitted if they are too large or contain sensitive information.string response = 8;+ // The status of the operation.google.rpc.Status status = 9;- // The latency of the RPC.+ // The duration of the operation.google.protobuf.Duration latency = 10;- // service-specific data about the request, response, and other activities.+ // Service-specific metadata about the request, response, and activities.google.protobuf.Any service_data = 11;- // Metadata about the operation.+ // Metadata about the request context.RequestMetadata request_metadata = 12;+ // Severity level for audit log entries.enum Severity {+ // Default severity level.DEFAULT = 0;+ // Debug-level information.DEBUG = 1;+ // Informational messages.INFO = 2;+ // Notable events.NOTICE = 3;+ // Warning conditions.WARNING = 4;+ // Error conditions.ERROR = 5;+ // Critical conditions.CRITICAL = 6;+ // Action must be taken immediately.ALERT = 7;+ // System is unusable.EMERGENCY = 8;}}+// Additional audit data specific to certain operations.message AuditData {+ // Changes to IAM policies.PolicyDelta policy_delta = 1;}-// Metadata about the request.+// Metadata about the incoming request.message RequestMetadata {- // The IP address of the caller.+ // The IP address of the request originator.string caller_ip = 1;- // The user agent of the caller.- // This information is not authenticated and should be treated accordingly.+ // The user agent string provided by the caller.+ // This is supplied by the client and is not authenticated.string caller_supplied_user_agent = 2;}diff --git a/proto/v1/v1/auth_service.proto b/proto/v1/v1/auth_service.protoindex c4512d0fa6..0862e842f0 100644--- a/proto/v1/v1/auth_service.proto+++ b/proto/v1/v1/auth_service.proto@@ -9,7 +9,9 @@ import "v1/user_service.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// AuthService handles user authentication operations.service AuthService {+ // Authenticates a user and returns access tokens.// Permissions required: Nonerpc Login(LoginRequest) returns (LoginResponse) {option (google.api.http) = {@@ -20,6 +22,7 @@ service AuthService {option (bytebase.v1.audit) = true;}+ // Logs out the current user session.// Permissions required: Nonerpc Logout(LogoutRequest) returns (google.protobuf.Empty) {option (google.api.http) = {@@ -32,8 +35,10 @@ service AuthService {}message LoginRequest {+ // User's email address.string email = 1;+ // User's password for authentication.string password = 2;// If web is set, we will set access token, refresh token, and user to the cookie.@@ -56,28 +61,38 @@ message LoginRequest {optional string mfa_temp_token = 8;}+// Context for identity provider authentication.message IdentityProviderContext {oneof context {+ // OAuth2 authentication context.OAuth2IdentityProviderContext oauth2_context = 1;+ // OpenID Connect authentication context.OIDCIdentityProviderContext oidc_context = 2;}}+// OAuth2 authentication context.message OAuth2IdentityProviderContext {+ // Authorization code from OAuth2 provider.string code = 1;}+// OpenID Connect authentication context.message OIDCIdentityProviderContext {}message LoginResponse {+ // Access token for authenticated requests.string token = 1;+ // Temporary token for MFA verification.optional string mfa_temp_token = 2;+ // Whether user must reset password before continuing.bool require_reset_password = 3;// The user of successful login.User user = 4;}+// Request to logout current user session.message LogoutRequest {}diff --git a/proto/v1/v1/cel_service.proto b/proto/v1/v1/cel_service.protoindex 3f0e045acf..a6886996a4 100644--- a/proto/v1/v1/cel_service.proto+++ b/proto/v1/v1/cel_service.proto@@ -8,7 +8,9 @@ import "v1/annotation.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// CelService manages CEL (Common Expression Language) parsing and formatting operations.service CelService {+ // Parses multiple CEL expression strings into AST representations.// Permissions required: Nonerpc BatchParse(BatchParseRequest) returns (BatchParseResponse) {option (google.api.http) = {@@ -18,6 +20,7 @@ service CelService {option (bytebase.v1.allow_without_credential) = true;}+ // Converts multiple CEL AST representations back into expression strings.// Permissions required: Nonerpc BatchDeparse(BatchDeparseRequest) returns (BatchDeparseResponse) {option (google.api.http) = {@@ -28,18 +31,26 @@ service CelService {}}+// Request message for batch parsing CEL expressions.message BatchParseRequest {+ // The CEL expression strings to parse.repeated string expressions = 1;}+// Response message for batch parsing CEL expressions.message BatchParseResponse {+ // The parsed CEL expressions as AST.repeated google.api.expr.v1alpha1.Expr expressions = 1;}+// Request message for batch deparsing CEL expressions.message BatchDeparseRequest {+ // The CEL expression ASTs to deparse.repeated google.api.expr.v1alpha1.Expr expressions = 1;}+// Response message for batch deparsing CEL expressions.message BatchDeparseResponse {+ // The deparsed CEL expressions as strings.repeated string expressions = 1;}diff --git a/proto/v1/v1/changelist_service.proto b/proto/v1/v1/changelist_service.protoindex 0b5345116b..401122799d 100644--- a/proto/v1/v1/changelist_service.proto+++ b/proto/v1/v1/changelist_service.proto@@ -13,7 +13,9 @@ import "v1/annotation.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// ChangelistService manages changelists for grouping and organizing database changes.service ChangelistService {+ // Creates a new changelist in a project.// Permissions required: bb.changelists.createrpc CreateChangelist(CreateChangelistRequest) returns (Changelist) {option (google.api.http) = {@@ -25,6 +27,7 @@ service ChangelistService {option (bytebase.v1.auth_method) = IAM;}+ // Gets a changelist by name.// Permissions required: bb.changelists.getrpc GetChangelist(GetChangelistRequest) returns (Changelist) {option (google.api.http) = {get: "/v1/{name=projects/*/changelists/*}"};@@ -33,6 +36,7 @@ service ChangelistService {option (bytebase.v1.auth_method) = IAM;}+ // Lists changelists in a project.// Permissions required: bb.changelists.listrpc ListChangelists(ListChangelistsRequest) returns (ListChangelistsResponse) {option (google.api.http) = {get: "/v1/{parent=projects/*}/changelists"};@@ -41,6 +45,7 @@ service ChangelistService {option (bytebase.v1.auth_method) = IAM;}+ // Updates a changelist.// Permissions required: bb.changelists.updaterpc UpdateChangelist(UpdateChangelistRequest) returns (Changelist) {option (google.api.http) = {@@ -52,6 +57,7 @@ service ChangelistService {option (bytebase.v1.auth_method) = IAM;}+ // Deletes a changelist.// Permissions required: bb.changelists.deleterpc DeleteChangelist(DeleteChangelistRequest) returns (google.protobuf.Empty) {option (google.api.http) = {delete: "/v1/{name=projects/*/changelists/*}"};@@ -61,6 +67,7 @@ service ChangelistService {}}+// Request message for creating a changelist.message CreateChangelistRequest {// The parent resource where this changelist will be created.// Format: projects/{project}@@ -80,6 +87,7 @@ message CreateChangelistRequest {string changelist_id = 3 [(google.api.field_behavior) = REQUIRED];}+// Request message for getting a changelist.message GetChangelistRequest {// The name of the changelist to retrieve.// Format: projects/{project}/changelists/{changelist}@@ -89,6 +97,7 @@ message GetChangelistRequest {];}+// Request message for listing changelists.message ListChangelistsRequest {// The parent, which owns this collection of changelists.// Format: projects/{project}@@ -97,14 +106,14 @@ message ListChangelistsRequest {(google.api.resource_reference) = {type: "bytebase.com/Project"}];- // Not used.+ // 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.int32 page_size = 2;- // Not used.+ // 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.//@@ -113,6 +122,7 @@ message ListChangelistsRequest {string page_token = 3;}+// Response message for listing changelists.message ListChangelistsResponse {// The changelists from the specified request.repeated Changelist changelists = 1;@@ -122,6 +132,7 @@ message ListChangelistsResponse {string next_page_token = 2;}+// Request message for updating a changelist.message UpdateChangelistRequest {// The changelist to update.//@@ -137,6 +148,7 @@ message UpdateChangelistRequest {bool allow_missing = 3;}+// Request message for deleting a changelist.message DeleteChangelistRequest {// The name of the changelist to delete.// Format: projects/{project}/changelists/{changelist}@@ -146,6 +158,7 @@ message DeleteChangelistRequest {];}+// A changelist groups multiple database changes together.message Changelist {option (google.api.resource) = {type: "bytebase.com/Changelist"@@ -160,22 +173,25 @@ message Changelist {(google.api.field_behavior) = IMMUTABLE];+ // The description of the changelist.string description = 2;// The creator of the changelist.// Format: users/{email}string creator = 3 [(google.api.field_behavior) = OUTPUT_ONLY];- // The last update time of the changelist.+ // The last time the changelist was updated.google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];+ // A single change in a changelist.message Change {- // The name of a sheet.+ // The sheet containing the SQL statement.string sheet = 1;- // The source of origin.- // 1) changelog: instances/{instance}/databases/{database}/changelogs/{changelog}.- // 2) raw SQL if empty.+ // The source of this change.+ // Format: instances/{instance}/databases/{database}/changelogs/{changelog}+ // If empty, the change is from raw SQL.string source = 2;}+ // The list of changes in this changelist.repeated Change changes = 7;}diff --git a/proto/v1/v1/common.proto b/proto/v1/v1/common.protoindex 3d32f6009e..7189715ad0 100644--- a/proto/v1/v1/common.proto+++ b/proto/v1/v1/common.proto@@ -4,54 +4,96 @@ package bytebase.v1;option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// Resource lifecycle state.enum State {STATE_UNSPECIFIED = 0;+ // Resource is active and operational.ACTIVE = 1;+ // Resource is soft-deleted but may be recoverable.DELETED = 2;}+// Database engine type.enum Engine {+ // Unspecified database engine.ENGINE_UNSPECIFIED = 0;+ // ClickHouse columnar database.CLICKHOUSE = 1;+ // MySQL relational database.MYSQL = 2;+ // PostgreSQL relational database.POSTGRES = 3;+ // Snowflake cloud data warehouse.SNOWFLAKE = 4;+ // SQLite embedded database.SQLITE = 5;+ // TiDB distributed SQL database.TIDB = 6;+ // MongoDB document database.MONGODB = 7;+ // Redis key-value store.REDIS = 8;+ // Oracle relational database.ORACLE = 9;+ // Google Cloud Spanner distributed database.SPANNER = 10;+ // Microsoft SQL Server relational database.MSSQL = 11;+ // Amazon Redshift data warehouse.REDSHIFT = 12;+ // MariaDB relational database.MARIADB = 13;+ // OceanBase distributed database.OCEANBASE = 14;+ // StarRocks analytics database.STARROCKS = 18;+ // Apache Doris analytics database.DORIS = 19;+ // Apache Hive data warehouse.HIVE = 20;+ // Elasticsearch search engine.ELASTICSEARCH = 21;+ // Google BigQuery data warehouse.BIGQUERY = 22;+ // Amazon DynamoDB NoSQL database.DYNAMODB = 23;+ // Databricks lakehouse platform.DATABRICKS = 24;+ // CockroachDB distributed SQL database.COCKROACHDB = 25;+ // Azure Cosmos DB multi-model database.COSMOSDB = 26;+ // Trino distributed SQL query engine.TRINO = 27;+ // Apache Cassandra NoSQL database.CASSANDRA = 28;}+// Version control system type.enum VCSType {+ // Unspecified VCS type.VCS_TYPE_UNSPECIFIED = 0;+ // GitHub version control platform.GITHUB = 1;+ // GitLab version control platform.GITLAB = 2;+ // Bitbucket version control platform.BITBUCKET = 3;+ // Azure DevOps version control platform.AZURE_DEVOPS = 4;}+// Data export format.enum ExportFormat {+ // Unspecified export format.FORMAT_UNSPECIFIED = 0;+ // Comma-separated values format.CSV = 1;+ // JavaScript Object Notation format.JSON = 2;+ // SQL statements format.SQL = 3;+ // Microsoft Excel spreadsheet format.XLSX = 4;}@@ -64,8 +106,11 @@ message Position {int32 column = 2;}+// Range of positions in text or sequence.message Range {+ // Start position (inclusive).int32 start = 1;+ // End position (exclusive).int32 end = 2;}@@ -91,8 +136,12 @@ enum MigrationType {// RiskLevel is the risk level.enum RiskLevel {+ // Unspecified risk level.RISK_LEVEL_UNSPECIFIED = 0;+ // Low risk operation.LOW = 1;+ // Moderate risk operation.MODERATE = 2;+ // High risk operation.HIGH = 3;}diff --git a/proto/v1/v1/database_catalog_service.proto b/proto/v1/v1/database_catalog_service.protoindex d7b7523d76..df47b43371 100644--- a/proto/v1/v1/database_catalog_service.proto+++ b/proto/v1/v1/database_catalog_service.proto@@ -10,7 +10,9 @@ import "v1/annotation.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// DatabaseCatalogService manages database schema metadata and classification.service DatabaseCatalogService {+ // Gets the catalog metadata for a database.// Permissions required: bb.databaseCatalogs.getrpc GetDatabaseCatalog(GetDatabaseCatalogRequest) returns (DatabaseCatalog) {option (google.api.http) = {get: "/v1/{name=instances/*/databases/*/catalog}"};@@ -19,6 +21,7 @@ service DatabaseCatalogService {option (bytebase.v1.auth_method) = IAM;}+ // Updates catalog metadata such as classifications and labels.// Permissions required: bb.databaseCatalogs.updaterpc UpdateDatabaseCatalog(UpdateDatabaseCatalogRequest) returns (DatabaseCatalog) {option (google.api.http) = {@@ -32,6 +35,7 @@ service DatabaseCatalogService {}}+// Request message for getting a database catalog.message GetDatabaseCatalogRequest {// The name of the database catalog to retrieve.// Format: instances/{instance}/databases/{database}/catalog@@ -41,6 +45,7 @@ message GetDatabaseCatalogRequest {];}+// Request message for updating a database catalog.message UpdateDatabaseCatalogRequest {// The database catalog to update.//@@ -53,6 +58,7 @@ message UpdateDatabaseCatalogRequest {bool allow_missing = 2;}+// Catalog metadata for a database including schemas, tables, and columns.message DatabaseCatalog {option (google.api.resource) = {type: "bytebase.com/DatabaseCatalog"@@ -63,63 +69,95 @@ message DatabaseCatalog {// Format: instances/{instance}/databases/{database}/catalogstring name = 1;+ // The schemas in the database.repeated SchemaCatalog schemas = 2;}+// Schema metadata within a database.message SchemaCatalog {+ // The schema name.string name = 1;+ // The tables in the schema.repeated TableCatalog tables = 2;}+// Table metadata within a schema.message TableCatalog {+ // The table name.string name = 1;+ // Column list for regular tables.message Columns {+ // The columns in the table.repeated ColumnCatalog columns = 1;}oneof kind {+ // Regular table columns.Columns columns = 2;+ // Object schema for JSON/XML columns.ObjectSchema object_schema = 3;}+ // The data classification level for this table.string classification = 4;}+// Column metadata within a table.message ColumnCatalog {+ // The column name.string name = 1;+ // The semantic type describing the data purpose.string semantic_type = 2;- // The user labels for a column.+ // User-defined labels for this column.map<string, string> labels = 3;+ // The data classification level for this column.string classification = 4;+ // Object schema for complex column types like JSON.optional ObjectSchema object_schema = 5;}+// Schema definition for object-type columns.message ObjectSchema {+ // Object schema data types.enum Type {+ // Unspecified type.TYPE_UNSPECIFIED = 0;+ // String type.STRING = 1;+ // Number type.NUMBER = 2;+ // Boolean type.BOOLEAN = 3;+ // Object/struct type.OBJECT = 4;+ // Array type.ARRAY = 5;}+ // The data type of this object.Type type = 1;+ // Structure type with named properties.message StructKind {+ // Properties of the struct.map<string, ObjectSchema> properties = 1;}+ // Array type with element schema.message ArrayKind {+ // The schema of array elements.ObjectSchema kind = 1;}oneof kind {+ // Struct schema.StructKind struct_kind = 2;+ // Array schema.ArrayKind array_kind = 3;}+ // The semantic type of this object.string semantic_type = 4;}diff --git a/proto/v1/v1/database_group_service.proto b/proto/v1/v1/database_group_service.protoindex 1e148d9507..34e9d95d34 100644--- a/proto/v1/v1/database_group_service.proto+++ b/proto/v1/v1/database_group_service.proto@@ -13,7 +13,9 @@ import "v1/annotation.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// DatabaseGroupService manages database groups for organizing databases by criteria.service DatabaseGroupService {+ // Lists database groups in a project.// Permissions required: bb.projects.getrpc ListDatabaseGroups(ListDatabaseGroupsRequest) returns (ListDatabaseGroupsResponse) {option (google.api.http) = {get: "/v1/{parent=projects/*}/databaseGroups"};@@ -22,6 +24,7 @@ service DatabaseGroupService {option (bytebase.v1.auth_method) = IAM;}+ // Gets a database group by name.// Permissions required: bb.projects.getrpc GetDatabaseGroup(GetDatabaseGroupRequest) returns (DatabaseGroup) {option (google.api.http) = {get: "/v1/{name=projects/*/databaseGroups/*}"};@@ -30,6 +33,7 @@ service DatabaseGroupService {option (bytebase.v1.auth_method) = IAM;}+ // Creates a new database group.// Permissions required: bb.projects.updaterpc CreateDatabaseGroup(CreateDatabaseGroupRequest) returns (DatabaseGroup) {option (google.api.http) = {@@ -42,6 +46,7 @@ service DatabaseGroupService {option (bytebase.v1.audit) = true;}+ // Updates a database group.// Permissions required: bb.projects.updaterpc UpdateDatabaseGroup(UpdateDatabaseGroupRequest) returns (DatabaseGroup) {option (google.api.http) = {@@ -54,6 +59,7 @@ service DatabaseGroupService {option (bytebase.v1.audit) = true;}+ // Deletes a database group.// Permissions required: bb.projects.updaterpc DeleteDatabaseGroup(DeleteDatabaseGroupRequest) returns (google.protobuf.Empty) {option (google.api.http) = {delete: "/v1/{name=projects/*/databaseGroups/*}"};@@ -64,6 +70,7 @@ service DatabaseGroupService {}}+// Request message for listing database groups.message ListDatabaseGroupsRequest {// The parent resource whose database groups are to be listed.// Format: projects/{project}@@ -72,14 +79,14 @@ message ListDatabaseGroupsRequest {(google.api.resource_reference) = {type: "bytebase.com/Project"}];- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// The maximum number of database groups to return. The service may return fewer than// this value.// If unspecified, at most 50 database groups will be returned.// The maximum value is 1000; values above 1000 will be coerced to 1000.int32 page_size = 2;- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// A page token, received from a previous `ListDatabaseGroups` call.// Provide this to retrieve the subsequent page.//@@ -91,15 +98,18 @@ message ListDatabaseGroupsRequest {DatabaseGroupView view = 4;}+// Response message for listing database groups.message ListDatabaseGroupsResponse {- // database_groups is the list of database groups.+ // The database groups from the specified request.repeated DatabaseGroup database_groups = 1;- // Not used. A token, which can be sent as `page_token` to retrieve the next page.+ // Pagination is not currently implemented. This field is reserved for future use.+ // A token, which can be sent as `page_token` to retrieve the next page.// If this field is omitted, there are no subsequent pages.string next_page_token = 2;}+// Request message for getting a database group.message GetDatabaseGroupRequest {// The name of the database group to retrieve.// Format: projects/{project}/databaseGroups/{databaseGroup}@@ -112,6 +122,7 @@ message GetDatabaseGroupRequest {DatabaseGroupView view = 2;}+// Request message for creating a database group.message CreateDatabaseGroupRequest {// The parent resource where this database group will be created.// Format: projects/{project}@@ -134,6 +145,7 @@ message CreateDatabaseGroupRequest {bool validate_only = 4;}+// Request message for updating a database group.message UpdateDatabaseGroupRequest {// The database group to update.//@@ -149,6 +161,7 @@ message UpdateDatabaseGroupRequest {bool allow_missing = 3;}+// Request message for deleting a database group.message DeleteDatabaseGroupRequest {// The name of the database group to delete.// Format: projects/{project}/databaseGroups/{databaseGroup}@@ -158,6 +171,7 @@ message DeleteDatabaseGroupRequest {];}+// View options for database group responses.enum DatabaseGroupView {// The default / unset value.// The API will default to the BASIC view.@@ -170,6 +184,7 @@ enum DatabaseGroupView {DATABASE_GROUP_VIEW_FULL = 2;}+// A group of databases matched by expressions.message DatabaseGroup {option (google.api.resource) = {type: "bytebase.com/DatabaseGroup"@@ -198,6 +213,7 @@ message DatabaseGroup {// resource.database_labels["tenant"] == "tenant1"google.type.Expr database_expr = 3;+ // A database within a database group.message Database {// The resource name of the database.// Format: instances/{instance}/databases/{database}diff --git a/proto/v1/v1/database_service.proto b/proto/v1/v1/database_service.protoindex a5313fd6ea..e60cf3c909 100644--- a/proto/v1/v1/database_service.proto+++ b/proto/v1/v1/database_service.proto@@ -14,7 +14,9 @@ import "v1/instance_service.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// DatabaseService manages databases and their schemas.service DatabaseService {+ // Retrieves a database by name.// Permissions required: bb.databases.getrpc GetDatabase(GetDatabaseRequest) returns (Database) {option (google.api.http) = {get: "/v1/{name=instances/*/databases/*}"};@@ -23,6 +25,7 @@ service DatabaseService {option (bytebase.v1.auth_method) = IAM;}+ // Retrieves multiple databases by their names.// Permissions required: bb.databases.getrpc BatchGetDatabases(BatchGetDatabasesRequest) returns (BatchGetDatabasesResponse) {option (google.api.http) = {@@ -33,7 +36,8 @@ service DatabaseService {option (bytebase.v1.auth_method) = CUSTOM;}- // Permissions required: bb.databases.list+ // Lists databases in a project, instance, or workspace.+ // Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)rpc ListDatabases(ListDatabasesRequest) returns (ListDatabasesResponse) {option (google.api.http) = {get: "/v1/{parent=projects/*}/databases"@@ -47,6 +51,7 @@ service DatabaseService {option (bytebase.v1.auth_method) = CUSTOM;}+ // Updates database properties such as labels and project assignment.// Permissions required: bb.databases.updaterpc UpdateDatabase(UpdateDatabaseRequest) returns (Database) {option (google.api.http) = {@@ -59,6 +64,7 @@ service DatabaseService {option (bytebase.v1.audit) = true;}+ // Updates multiple databases in a single batch operation.// Permissions required: bb.databases.updaterpc BatchUpdateDatabases(BatchUpdateDatabasesRequest) returns (BatchUpdateDatabasesResponse) {option (google.api.http) = {@@ -70,6 +76,7 @@ service DatabaseService {option (bytebase.v1.audit) = true;}+ // Synchronizes database schema from the instance.// Permissions required: bb.databases.syncrpc SyncDatabase(SyncDatabaseRequest) returns (SyncDatabaseResponse) {option (google.api.http) = {@@ -80,6 +87,7 @@ service DatabaseService {option (bytebase.v1.auth_method) = IAM;}+ // Synchronizes multiple databases in a single batch operation.// Permissions required: bb.databases.syncrpc BatchSyncDatabases(BatchSyncDatabasesRequest) returns (BatchSyncDatabasesResponse) {option (google.api.http) = {@@ -90,6 +98,7 @@ service DatabaseService {option (bytebase.v1.auth_method) = IAM;}+ // Retrieves database metadata including tables, columns, and indexes.// Permissions required: bb.databases.getSchemarpc GetDatabaseMetadata(GetDatabaseMetadataRequest) returns (DatabaseMetadata) {option (google.api.http) = {get: "/v1/{name=instances/*/databases/*/metadata}"};@@ -97,6 +106,7 @@ service DatabaseService {option (bytebase.v1.auth_method) = IAM;}+ // Retrieves database schema as DDL statements.// Permissions required: bb.databases.getSchemarpc GetDatabaseSchema(GetDatabaseSchemaRequest) returns (DatabaseSchema) {option (google.api.http) = {get: "/v1/{name=instances/*/databases/*/schema}"};@@ -104,6 +114,7 @@ service DatabaseService {option (bytebase.v1.auth_method) = IAM;}+ // Compares and generates migration statements between two schemas.// Permissions required: bb.databases.getrpc DiffSchema(DiffSchemaRequest) returns (DiffSchemaResponse) {option (google.api.http) = {@@ -120,6 +131,7 @@ service DatabaseService {option (bytebase.v1.auth_method) = IAM;}+ // Lists migration history for a database.// Permissions required: bb.changelogs.listrpc ListChangelogs(ListChangelogsRequest) returns (ListChangelogsResponse) {option (google.api.http) = {get: "/v1/{parent=instances/*/databases/*}/changelogs"};@@ -128,7 +140,8 @@ service DatabaseService {option (bytebase.v1.auth_method) = IAM;}- // Permissions required: changelogs.get+ // Retrieves a specific changelog entry.+ // Permissions required: bb.changelogs.getrpc GetChangelog(GetChangelogRequest) returns (Changelog) {option (google.api.http) = {get: "/v1/{name=instances/*/databases/*/changelogs/*}"};option (google.api.method_signature) = "name";@@ -136,7 +149,8 @@ service DatabaseService {option (bytebase.v1.auth_method) = IAM;}- // Permissions required: databases.getSchema+ // Generates schema DDL for a database object.+ // Permissions required: bb.databases.getSchemarpc GetSchemaString(GetSchemaStringRequest) returns (GetSchemaStringResponse) {option (google.api.http) = {get: "/v1/{name=instances/*/databases/*/schemaString}"};option (google.api.method_signature) = "name";@@ -447,6 +461,7 @@ message DatabaseMetadata {// The extensions is the list of extensions in a database.repeated ExtensionMetadata extensions = 5;+ // The owner of the database.string owner = 7;// The search_path is the search path of a PostgreSQL database.@@ -489,15 +504,19 @@ message SchemaMetadata {// The packages is the list of packages in a schema.repeated PackageMetadata packages = 10;+ // The owner of the schema.string owner = 11;// The sequences is the list of sequences in a schema, sorted by name.repeated SequenceMetadata sequences = 13;+ // The events is the list of scheduled events in a schema.repeated EventMetadata events = 14;+ // The enum_types is the list of user-defined enum types in a schema.repeated EnumTypeMetadata enum_types = 15;+ // Whether to skip this schema during schema dump operations.bool skip_dump = 16;// The comment is the comment of a schema.@@ -511,8 +530,10 @@ message EnumTypeMetadata {// The enum values of a type.repeated string values = 2;+ // The comment describing the enum type.string comment = 3;+ // Whether to skip this enum type during schema dump operations.bool skip_dump = 4;}@@ -526,10 +547,13 @@ message EventMetadata {// The time zone of the event.string time_zone = 3;+ // The SQL mode setting for the event.string sql_mode = 4;+ // The character set used by the client creating the event.string character_set_client = 5;+ // The collation used for the connection when creating the event.string collation_connection = 6;// The comment is the comment of an event.@@ -570,8 +594,10 @@ message SequenceMetadata {// The owner column of the sequence.string owner_column = 11;+ // The comment describing the sequence.string comment = 12;+ // Whether to skip this sequence during schema dump operations.bool skip_dump = 13;}@@ -589,14 +615,19 @@ message TriggerMetadata {// The body is the body of the trigger.string body = 5;+ // The SQL mode setting for the trigger.string sql_mode = 6;+ // The character set used by the client creating the trigger.string character_set_client = 7;+ // The collation used for the connection when creating the trigger.string collation_connection = 8;+ // The comment describing the trigger.string comment = 9;+ // Whether to skip this trigger during schema dump operations.bool skip_dump = 10;}@@ -665,14 +696,17 @@ message TableMetadata {// The check_constraints is the list of check constraints in a table.repeated CheckConstraintMetadata check_constraints = 16;+ // The owner of the table.string owner = 18;// The sorting_keys is a tuple of column names or arbitrary expressions. ClickHouse specific field.// Reference: https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/mergetree#order_byrepeated string sorting_keys = 19;+ // The triggers is the list of triggers associated with the table.repeated TriggerMetadata triggers = 20;+ // Whether to skip this table during schema dump operations.bool skip_dump = 21;// https://docs.pingcap.com/tidb/stable/information-schema-tables/diff --git a/proto/v1/v1/group_service.proto b/proto/v1/v1/group_service.protoindex 1bd82f2b41..6dfec00125 100644--- a/proto/v1/v1/group_service.proto+++ b/proto/v1/v1/group_service.proto@@ -12,7 +12,9 @@ import "v1/annotation.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// GroupService manages user groups for organizing users and permissions.service GroupService {+ // Gets a group by name.// Permissions required: bb.groups.getrpc GetGroup(GetGroupRequest) returns (Group) {option (google.api.http) = {get: "/v1/{name=groups/*}"};@@ -21,7 +23,7 @@ service GroupService {option (bytebase.v1.auth_method) = IAM;}- // Get the groups in batch.+ // Gets multiple groups in a single request.// Permissions required: bb.groups.getrpc BatchGetGroups(BatchGetGroupsRequest) returns (BatchGetGroupsResponse) {option (google.api.http) = {get: "/v1/groups:batchGet"};@@ -29,6 +31,7 @@ service GroupService {option (bytebase.v1.auth_method) = IAM;}+ // Lists all groups in the workspace.// Permissions required: bb.groups.listrpc ListGroups(ListGroupsRequest) returns (ListGroupsResponse) {option (google.api.http) = {get: "/v1/groups"};@@ -37,6 +40,7 @@ service GroupService {option (bytebase.v1.auth_method) = IAM;}+ // Creates a new group.// Permissions required: bb.groups.createrpc CreateGroup(CreateGroupRequest) returns (Group) {option (google.api.http) = {@@ -49,9 +53,8 @@ service GroupService {option (bytebase.v1.audit) = true;}- // UpdateGroup updates the group.- // Users with "bb.groups.update" permission on the workspace or the group owner can access this method.- // Permissions required: bb.groups.update+ // Updates a group. Group owners or users with bb.groups.update permission can update.+ // Permissions required: bb.groups.update OR caller is group ownerrpc UpdateGroup(UpdateGroupRequest) returns (Group) {option (google.api.http) = {patch: "/v1/{group.name=groups/*}"@@ -63,7 +66,8 @@ service GroupService {option (bytebase.v1.audit) = true;}- // Permissions required: bb.groups.delete+ // Deletes a group. Group owners or users with bb.groups.delete permission can delete.+ // Permissions required: bb.groups.delete OR caller is group ownerrpc DeleteGroup(DeleteGroupRequest) returns (google.protobuf.Empty) {option (google.api.http) = {delete: "/v1/{name=groups/*}"};option (google.api.method_signature) = "name";@@ -73,6 +77,7 @@ service GroupService {}}+// Request message for getting a group.message GetGroupRequest {// The name of the group to retrieve.// Format: groups/{email}@@ -82,6 +87,7 @@ message GetGroupRequest {];}+// Request message for batch getting groups.message BatchGetGroupsRequest {// The group names to retrieve.// Format: groups/{email}@@ -91,11 +97,13 @@ message BatchGetGroupsRequest {];}+// Response message for batch getting groups.message BatchGetGroupsResponse {// The groups from the specified request.repeated Group groups = 1;}+// Request message for listing groups.message ListGroupsRequest {// The maximum number of groups to return. The service may return fewer than// this value.@@ -129,6 +137,7 @@ message ListGroupsRequest {string filter = 3;}+// Response message for listing groups.message ListGroupsResponse {// The groups from the specified request.repeated Group groups = 1;@@ -138,6 +147,7 @@ message ListGroupsResponse {string next_page_token = 2;}+// Request message for creating a group.message CreateGroupRequest {// The group to create.Group group = 1 [(google.api.field_behavior) = REQUIRED];@@ -147,6 +157,7 @@ message CreateGroupRequest {string group_email = 2 [(google.api.field_behavior) = REQUIRED];}+// Request message for updating a group.message UpdateGroupRequest {// The group to update.//@@ -162,6 +173,7 @@ message UpdateGroupRequest {bool allow_missing = 3;}+// Request message for deleting a group.message DeleteGroupRequest {// The name of the group to delete.// Format: groups/{email}@@ -171,21 +183,28 @@ message DeleteGroupRequest {];}+// A member of a group with a role.message GroupMember {// Member is the principal who belong to this group.//// Format: users/[email protected]string member = 1;+ // The role of a group member.enum Role {+ // Unspecified role.ROLE_UNSPECIFIED = 0;+ // Group owner.OWNER = 1;+ // Group member.MEMBER = 2;}+ // The member's role in the group.Role role = 2;}+// A group of users within the workspace.message Group {option (google.api.resource) = {type: "bytebase.com/Group"@@ -196,12 +215,15 @@ message Group {// Format: groups/{group}, group is an email.string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];+ // The display title of the group.string title = 2;+ // The description of the group.string description = 3;+ // The members of the group.repeated GroupMember members = 5;- // source means where the group comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID.+ // The source system where the group originated (e.g., Entra ID for SCIM sync).string source = 7;}diff --git a/proto/v1/v1/iam_policy.proto b/proto/v1/v1/iam_policy.protoindex 979c11490d..a388ca8c33 100644--- a/proto/v1/v1/iam_policy.proto+++ b/proto/v1/v1/iam_policy.proto@@ -9,6 +9,7 @@ import "google/type/expr.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// Request message for getting an IAM policy.message GetIamPolicyRequest {// The name of the resource to get the IAM policy.// Format: projects/{project}@@ -19,6 +20,7 @@ message GetIamPolicyRequest {];}+// Request message for setting an IAM policy.message SetIamPolicyRequest {// The name of the resource to set the IAM policy.// Format: projects/{project}@@ -34,6 +36,7 @@ message SetIamPolicyRequest {string etag = 3;}+// IAM policy that binds members to roles.message IamPolicy {// Collection of binding.// A binding binds one or more project members to a single project role.@@ -45,6 +48,7 @@ message IamPolicy {string etag = 2;}+// Binding associates members with a role and optional conditions.message Binding {// The role that is assigned to the members.// Format: roles/{role}@@ -76,19 +80,21 @@ message Binding {google.api.expr.v1alpha1.Expr parsed_expr = 4 [(google.api.field_behavior) = OUTPUT_ONLY];}-// The difference delta between two policies.+// Describes changes between two IAM policies.message PolicyDelta {// The delta for Bindings between two policies.repeated BindingDelta binding_deltas = 1;}-// One delta entry for Binding. Each individual change (only one member in each-// entry) to a binding will be a separate entry.+// A single change to a binding.message BindingDelta {- // The type of action performed on a Binding in a policy.+ // Type of action performed on a binding.enum Action {+ // Unspecified action.ACTION_UNSPECIFIED = 0;+ // Add a binding.ADD = 1;+ // Remove a binding.REMOVE = 2;}diff --git a/proto/v1/v1/idp_service.proto b/proto/v1/v1/idp_service.protoindex b05ecbf4e6..ed08e65415 100644--- a/proto/v1/v1/idp_service.proto+++ b/proto/v1/v1/idp_service.proto@@ -12,7 +12,9 @@ import "v1/annotation.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// IdentityProviderService manages external identity providers for SSO authentication.service IdentityProviderService {+ // Gets an identity provider by name.// Permissions required: bb.identityProviders.getrpc GetIdentityProvider(GetIdentityProviderRequest) returns (IdentityProvider) {option (google.api.http) = {get: "/v1/{name=idps/*}"};@@ -21,6 +23,7 @@ service IdentityProviderService {option (bytebase.v1.auth_method) = IAM;}+ // Lists all configured identity providers (public endpoint for login page).// Permissions required: Nonerpc ListIdentityProviders(ListIdentityProvidersRequest) returns (ListIdentityProvidersResponse) {option (google.api.http) = {get: "/v1/idps"};@@ -29,6 +32,7 @@ service IdentityProviderService {// The method requires no authentication thus no authorization.}+ // Creates a new identity provider.// Permissions required: bb.identityProviders.createrpc CreateIdentityProvider(CreateIdentityProviderRequest) returns (IdentityProvider) {option (google.api.http) = {@@ -41,6 +45,7 @@ service IdentityProviderService {option (bytebase.v1.audit) = true;}+ // Updates an identity provider.// Permissions required: bb.identityProviders.updaterpc UpdateIdentityProvider(UpdateIdentityProviderRequest) returns (IdentityProvider) {option (google.api.http) = {@@ -53,6 +58,7 @@ service IdentityProviderService {option (bytebase.v1.audit) = true;}+ // Deletes an identity provider.// Permissions required: bb.identityProviders.deleterpc DeleteIdentityProvider(DeleteIdentityProviderRequest) returns (google.protobuf.Empty) {option (google.api.http) = {delete: "/v1/{name=idps/*}"};@@ -62,6 +68,7 @@ service IdentityProviderService {option (bytebase.v1.audit) = true;}+ // Tests the connection and configuration of an identity provider.// Permissions required: bb.identityProviders.updaterpc TestIdentityProvider(TestIdentityProviderRequest) returns (TestIdentityProviderResponse) {option (google.api.http) = {@@ -74,6 +81,8 @@ service IdentityProviderService {}message GetIdentityProviderRequest {+ // The name of the identity provider to retrieve.+ // Format: idps/{idp}string name = 1 [(google.api.field_behavior) = REQUIRED,(google.api.resource_reference) = {type: "bytebase.com/IdP"}@@ -81,14 +90,14 @@ message GetIdentityProviderRequest {}message ListIdentityProvidersRequest {- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// The maximum number of identity providers to return. The service may return fewer than// this value.// If unspecified, at most 10 will be returned.// The maximum value is 1000; values above 1000 will be coerced to 1000.int32 page_size = 1;- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// A page token, received from a previous `ListIdentityProviders` call.// Provide this to retrieve the subsequent page.//@@ -178,67 +187,93 @@ message IdentityProvider {// Format: idps/{idp}string name = 1;+ // The display title of the identity provider.string title = 4;+ // The domain for email matching when using this identity provider.string domain = 5;+ // The type of identity provider protocol.IdentityProviderType type = 6;+ // The configuration details for the identity provider.IdentityProviderConfig config = 7;}enum IdentityProviderType {+ // Unspecified identity provider type.IDENTITY_PROVIDER_TYPE_UNSPECIFIED = 0;+ // OAuth 2.0 authentication protocol.OAUTH2 = 1;+ // OpenID Connect authentication protocol.OIDC = 2;+ // LDAP directory service authentication.LDAP = 3;}message IdentityProviderConfig {oneof config {+ // OAuth2 protocol configuration.OAuth2IdentityProviderConfig oauth2_config = 1;+ // OIDC protocol configuration.OIDCIdentityProviderConfig oidc_config = 2;+ // LDAP protocol configuration.LDAPIdentityProviderConfig ldap_config = 3;}}// OAuth2IdentityProviderConfig is the structure for OAuth2 identity provider config.message OAuth2IdentityProviderConfig {+ // The authorization endpoint URL for OAuth2 flow.string auth_url = 1;+ // The token endpoint URL for exchanging authorization code.string token_url = 2;+ // The user information endpoint URL.string user_info_url = 3;+ // The OAuth2 client identifier.string client_id = 4;+ // The OAuth2 client secret for authentication.string client_secret = 5;+ // The list of OAuth2 scopes to request.repeated string scopes = 6;+ // Mapping configuration for user attributes from OAuth2 response.FieldMapping field_mapping = 7;+ // Whether to skip TLS certificate verification.bool skip_tls_verify = 8;+ // The authentication style for client credentials.OAuth2AuthStyle auth_style = 9;}// OIDCIdentityProviderConfig is the structure for OIDC identity provider config.message OIDCIdentityProviderConfig {+ // The OIDC issuer URL for the identity provider.string issuer = 1;+ // The OIDC client identifier.string client_id = 2;+ // The OIDC client secret for authentication.string client_secret = 3;// The scopes that the OIDC provider supports.// Should be fetched from the well-known configuration file of the OIDC provider.repeated string scopes = 4;+ // Mapping configuration for user attributes from OIDC claims.FieldMapping field_mapping = 5;+ // Whether to skip TLS certificate verification.bool skip_tls_verify = 6;+ // The authentication style for client credentials.OAuth2AuthStyle auth_style = 7;// The authorization endpoint of the OIDC provider.diff --git a/proto/v1/v1/instance_role_service.proto b/proto/v1/v1/instance_role_service.protoindex c9cf8b53fe..4dc8ae5200 100644--- a/proto/v1/v1/instance_role_service.proto+++ b/proto/v1/v1/instance_role_service.proto@@ -10,7 +10,9 @@ import "v1/annotation.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// InstanceRoleService manages database roles within instances.service InstanceRoleService {+ // Gets a database role from an instance.// Permissions required: bb.instanceRoles.getrpc GetInstanceRole(GetInstanceRoleRequest) returns (InstanceRole) {option (google.api.http) = {get: "/v1/{name=instances/*/roles/*}"};@@ -19,6 +21,7 @@ service InstanceRoleService {option (bytebase.v1.auth_method) = IAM;}+ // Lists all database roles in an instance.// Permissions required: bb.instanceRoles.listrpc ListInstanceRoles(ListInstanceRolesRequest) returns (ListInstanceRolesResponse) {option (google.api.http) = {get: "/v1/{parent=instances/*}/roles"};diff --git a/proto/v1/v1/instance_service.proto b/proto/v1/v1/instance_service.protoindex 0fe15183e0..b1c4dc6017 100644--- a/proto/v1/v1/instance_service.proto+++ b/proto/v1/v1/instance_service.proto@@ -16,7 +16,9 @@ import "v1/instance_role_service.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// InstanceService manages database instances and their connections.service InstanceService {+ // Gets a database instance by name.// Permissions required: bb.instances.getrpc GetInstance(GetInstanceRequest) returns (Instance) {option (google.api.http) = {get: "/v1/{name=instances/*}"};@@ -25,6 +27,7 @@ service InstanceService {option (bytebase.v1.auth_method) = IAM;}+ // Lists all database instances.// Permissions required: bb.instances.listrpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse) {option (google.api.http) = {get: "/v1/instances"};@@ -33,6 +36,7 @@ service InstanceService {option (bytebase.v1.auth_method) = IAM;}+ // Creates a new database instance.// Permissions required: bb.instances.createrpc CreateInstance(CreateInstanceRequest) returns (Instance) {option (google.api.http) = {@@ -45,6 +49,7 @@ service InstanceService {option (bytebase.v1.audit) = true;}+ // Updates a database instance.// Permissions required: bb.instances.updaterpc UpdateInstance(UpdateInstanceRequest) returns (Instance) {option (google.api.http) = {@@ -57,6 +62,7 @@ service InstanceService {option (bytebase.v1.audit) = true;}+ // Deletes or soft-deletes a database instance.// Permissions required: bb.instances.deleterpc DeleteInstance(DeleteInstanceRequest) returns (google.protobuf.Empty) {option (google.api.http) = {delete: "/v1/{name=instances/*}"};@@ -66,6 +72,7 @@ service InstanceService {option (bytebase.v1.audit) = true;}+ // Restores a soft-deleted database instance.// Permissions required: bb.instances.undeleterpc UndeleteInstance(UndeleteInstanceRequest) returns (Instance) {option (google.api.http) = {@@ -77,6 +84,7 @@ service InstanceService {option (bytebase.v1.audit) = true;}+ // Syncs database schemas and metadata from an instance.// Permissions required: bb.instances.syncrpc SyncInstance(SyncInstanceRequest) returns (SyncInstanceResponse) {option (google.api.http) = {@@ -87,6 +95,7 @@ service InstanceService {option (bytebase.v1.auth_method) = IAM;}+ // Lists all databases within an instance without creating them.// Permissions required: bb.instances.getrpc ListInstanceDatabase(ListInstanceDatabaseRequest) returns (ListInstanceDatabaseResponse) {option (google.api.http) = {@@ -97,6 +106,7 @@ service InstanceService {option (bytebase.v1.auth_method) = IAM;}+ // Syncs multiple instances in a single request.// Permissions required: bb.instances.syncrpc BatchSyncInstances(BatchSyncInstancesRequest) returns (BatchSyncInstancesResponse) {option (google.api.http) = {@@ -107,6 +117,7 @@ service InstanceService {option (bytebase.v1.auth_method) = IAM;}+ // Updates multiple instances in a single request.// Permissions required: bb.instances.updaterpc BatchUpdateInstances(BatchUpdateInstancesRequest) returns (BatchUpdateInstancesResponse) {option (google.api.http) = {@@ -118,6 +129,7 @@ service InstanceService {option (bytebase.v1.audit) = true;}+ // Adds a read-only data source to an instance.// Permissions required: bb.instances.updaterpc AddDataSource(AddDataSourceRequest) returns (Instance) {option (google.api.http) = {@@ -129,6 +141,7 @@ service InstanceService {option (bytebase.v1.audit) = true;}+ // Removes a read-only data source from an instance.// Permissions required: bb.instances.updaterpc RemoveDataSource(RemoveDataSourceRequest) returns (Instance) {option (google.api.http) = {@@ -140,6 +153,7 @@ service InstanceService {option (bytebase.v1.audit) = true;}+ // Updates a data source configuration.// Permissions required: bb.instances.updaterpc UpdateDataSource(UpdateDataSourceRequest) returns (Instance) {option (google.api.http) = {@@ -396,24 +410,32 @@ message Instance {// Format: instances/{instance}string name = 1;+ // The lifecycle state of the instance.State state = 3;+ // The display title of the instance.string title = 4;+ // The database engine type.Engine engine = 5;+ // The version of the database engine.string engine_version = 6 [(google.api.field_behavior) = OUTPUT_ONLY];+ // External URL to the database instance console.string external_link = 7;+ // Data source configurations for connecting to the instance.repeated DataSource data_sources = 8;// The environment resource.// Format: environments/prod where prod is the environment resource ID.optional string environment = 9 [(google.api.field_behavior) = OPTIONAL];+ // Whether the instance is activated for use.bool activation = 10;+ // Database roles available in this instance.repeated InstanceRole roles = 12 [(google.api.field_behavior) = OUTPUT_ONLY];// How often the instance is synced.@@ -437,6 +459,7 @@ message Instance {message DataSourceExternalSecret {enum SecretType {+ // Unspecified secret type.SAECRET_TYPE_UNSPECIFIED = 0;// ref: https://developer.hashicorp.com/vault/api-docs/secret/kv/kv-v2VAULT_KV_V2 = 1;@@ -445,29 +468,38 @@ message DataSourceExternalSecret {// ref: https://cloud.google.com/secret-manager/docsGCP_SECRET_MANAGER = 3;}+ // The type of external secret store.SecretType secret_type = 1;+ // The URL of the external secret store.string url = 2;enum AuthType {+ // Unspecified authentication type.AUTH_TYPE_UNSPECIFIED = 0;// ref: https://developer.hashicorp.com/vault/docs/auth/tokenTOKEN = 1;// ref: https://developer.hashicorp.com/vault/docs/auth/approleVAULT_APP_ROLE = 2;}+ // The authentication method for accessing the secret store.AuthType auth_type = 3;message AppRoleAuthOption {+ // The role ID for Vault AppRole authentication.string role_id = 1 [(google.api.field_behavior) = INPUT_ONLY];// the secret id for the role without ttl.string secret_id = 2 [(google.api.field_behavior) = INPUT_ONLY];enum SecretType {+ // Unspecified secret type.SECRET_TYPE_UNSPECIFIED = 0;+ // Plain text secret.PLAIN = 1;+ // Secret from environment variable.ENVIRONMENT = 2;}+ // The type of secret for AppRole authentication.SecretType type = 3;// The path where the approle auth method is mounted.@@ -475,7 +507,9 @@ message DataSourceExternalSecret {}oneof auth_option {+ // AppRole authentication configuration.AppRoleAuthOption app_role = 4;+ // Token for direct authentication.string token = 5 [(google.api.field_behavior) = INPUT_ONLY];}@@ -488,14 +522,21 @@ message DataSourceExternalSecret {}message DataSource {+ // The unique identifier for this data source.string id = 1;+ // The type of data source (ADMIN or READ_ONLY).DataSourceType type = 2;+ // The username for database authentication.string username = 3;+ // The password for database authentication.string password = 4 [(google.api.field_behavior) = INPUT_ONLY];// Use SSL to connect to the data source. By default, we use system default SSL configuration.bool use_ssl = 30;+ // The SSL certificate authority certificate.string ssl_ca = 5 [(google.api.field_behavior) = INPUT_ONLY];+ // The SSL client certificate.string ssl_cert = 6 [(google.api.field_behavior) = INPUT_ONLY];+ // The SSL client private key.string ssl_key = 7 [(google.api.field_behavior) = INPUT_ONLY];// verify_tls_certificate enables TLS certificate verification for SSL connections.// Default is false (no verification) for backward compatibility.@@ -503,8 +544,11 @@ message DataSource {// Only set to false for development or when certificates cannot be properly// validated (e.g., self-signed certs, VPN environments).bool verify_tls_certificate = 39;+ // The hostname or IP address of the database server.string host = 8;+ // The port number of the database server.string port = 9;+ // The name of the database to connect to.string database = 10;// 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.@@ -613,20 +657,28 @@ message DataSource {}enum DataSourceType {+ // Unspecified data source type.DATA_SOURCE_UNSPECIFIED = 0;+ // Admin data source with write permissions.ADMIN = 1;+ // Read-only data source for query operations.READ_ONLY = 2;}message InstanceResource {+ // The display title of the instance.string title = 1;+ // The database engine type.Engine engine = 2;+ // The version of the database engine.string engine_version = 3 [(google.api.field_behavior) = OUTPUT_ONLY];+ // Data source configurations for the instance.repeated DataSource data_sources = 4;+ // Whether the instance is activated.bool activation = 5;// The name of the instance.@@ -640,16 +692,24 @@ message InstanceResource {message SASLConfig {oneof mechanism {+ // Kerberos authentication configuration.KerberosConfig krb_config = 1;}}message KerberosConfig {+ // The primary component of the Kerberos principal.string primary = 1;+ // The instance component of the Kerberos principal.string instance = 2;+ // The Kerberos realm.string realm = 3;+ // The keytab file contents for authentication.bytes keytab = 4;+ // The hostname of the Key Distribution Center (KDC).string kdc_host = 5;+ // The port of the Key Distribution Center (KDC).string kdc_port = 6;+ // The transport protocol for KDC communication (tcp or udp).string kdc_transport_protocol = 7;}diff --git a/proto/v1/v1/issue_service.proto b/proto/v1/v1/issue_service.protoindex 87ec180fa0..93d2ffbe66 100644--- a/proto/v1/v1/issue_service.proto+++ b/proto/v1/v1/issue_service.proto@@ -15,7 +15,9 @@ import "v1/common.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// IssueService manages issues for tracking database changes and tasks.service IssueService {+ // Retrieves an issue by name.// Permissions required: bb.issues.getrpc GetIssue(GetIssueRequest) returns (Issue) {option (google.api.http) = {get: "/v1/{name=projects/*/issues/*}"};@@ -24,6 +26,7 @@ service IssueService {option (bytebase.v1.auth_method) = IAM;}+ // Creates a new issue for database changes or tasks.// Permissions required: bb.issues.createrpc CreateIssue(CreateIssueRequest) returns (Issue) {option (google.api.http) = {@@ -37,6 +40,7 @@ service IssueService {option (bytebase.v1.audit) = true;}+ // Lists issues in a project.// Permissions required: bb.issues.listrpc ListIssues(ListIssuesRequest) returns (ListIssuesResponse) {option (google.api.http) = {get: "/v1/{parent=projects/*}/issues"};@@ -56,6 +60,7 @@ service IssueService {option (bytebase.v1.auth_method) = CUSTOM;}+ // Updates an issue's properties such as title, description, or labels.// Permissions required: bb.issues.updaterpc UpdateIssue(UpdateIssueRequest) returns (Issue) {option (google.api.http) = {@@ -68,6 +73,7 @@ service IssueService {option (bytebase.v1.audit) = true;}+ // Lists comments on an issue.// Permissions required: bb.issueComments.listrpc ListIssueComments(ListIssueCommentsRequest) returns (ListIssueCommentsResponse) {option (google.api.http) = {get: "/v1/{parent=projects/*/issues/*}/issueComments"};@@ -76,6 +82,7 @@ service IssueService {option (bytebase.v1.auth_method) = IAM;}+ // Adds a comment to an issue.// Permissions required: bb.issueComments.createrpc CreateIssueComment(CreateIssueCommentRequest) returns (IssueComment) {option (google.api.http) = {@@ -88,6 +95,7 @@ service IssueService {option (bytebase.v1.audit) = true;}+ // Updates an existing issue comment.// Permissions required: bb.issueComments.updaterpc UpdateIssueComment(UpdateIssueCommentRequest) returns (IssueComment) {option (google.api.http) = {@@ -100,6 +108,7 @@ service IssueService {option (bytebase.v1.audit) = true;}+ // Updates the status of multiple issues in a single operation.// Permissions required: bb.issues.updaterpc BatchUpdateIssuesStatus(BatchUpdateIssuesStatusRequest) returns (BatchUpdateIssuesStatusResponse) {option (google.api.http) = {@@ -111,9 +120,8 @@ service IssueService {option (bytebase.v1.audit) = true;}- // ApproveIssue approves the issue.- // The access is based on approval flow.- // Permissions required: None+ // Approves an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+ // Permissions required: None (determined by approval flow)rpc ApproveIssue(ApproveIssueRequest) returns (Issue) {option (google.api.http) = {post: "/v1/{name=projects/*/issues/*}:approve"@@ -123,9 +131,8 @@ service IssueService {option (bytebase.v1.audit) = true;}- // RejectIssue rejects the issue.- // The access is based on approval flow.- // Permissions required: None+ // Rejects an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+ // Permissions required: None (determined by approval flow)rpc RejectIssue(RejectIssueRequest) returns (Issue) {option (google.api.http) = {post: "/v1/{name=projects/*/issues/*}:reject"@@ -135,9 +142,8 @@ service IssueService {option (bytebase.v1.audit) = true;}- // RequestIssue requests the issue.- // The access is based on approval flow.- // Permissions required: None+ // Requests changes on an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.+ // Permissions required: None (determined by approval flow)rpc RequestIssue(RequestIssueRequest) returns (Issue) {option (google.api.http) = {post: "/v1/{name=projects/*/issues/*}:request"@@ -156,6 +162,7 @@ message GetIssueRequest {(google.api.resource_reference) = {type: "bytebase.com/Issue"}];+ // If set to true, bypass cache and fetch the latest data.bool force = 2;}@@ -298,6 +305,7 @@ message BatchUpdateIssuesStatusRequest {// The new status.IssueStatus status = 3;+ // The reason for the status change.string reason = 4;}@@ -310,6 +318,7 @@ message ApproveIssueRequest {(google.api.field_behavior) = REQUIRED,(google.api.resource_reference) = {type: "bytebase.com/Issue"}];+ // The comment explaining the approval decision.string comment = 2;}@@ -320,6 +329,7 @@ message RejectIssueRequest {(google.api.field_behavior) = REQUIRED,(google.api.resource_reference) = {type: "bytebase.com/Issue"}];+ // The comment explaining the rejection decision.string comment = 2;}@@ -330,6 +340,7 @@ message RequestIssueRequest {(google.api.field_behavior) = REQUIRED,(google.api.resource_reference) = {type: "bytebase.com/Issue"}];+ // The comment explaining the request.string comment = 2;}@@ -345,25 +356,39 @@ message Issue {// Format: projects/{project}/issues/{issue}string name = 1;+ // The title of the issue.string title = 3;+ // The description of the issue.string description = 4;+ // The type of issue.enum Type {+ // Unspecified issue type.TYPE_UNSPECIFIED = 0;+ // Database schema or data change.DATABASE_CHANGE = 1;+ // Database access grant request.GRANT_REQUEST = 2;+ // Database data export request.DATABASE_EXPORT = 3;}Type type = 5;+ // The status of the issue.IssueStatus status = 6;+ // Approvers and their approval status for the issue.message Approver {+ // The approval status of an approver.enum Status {+ // Unspecified status.STATUS_UNSPECIFIED = 0;+ // Awaiting approval.PENDING = 1;+ // Approved.APPROVED = 2;+ // Rejected.REJECTED = 3;}// The new status.@@ -374,6 +399,7 @@ message Issue {}repeated Approver approvers = 9;+ // The approval template for the issue.ApprovalTemplate approval_template = 10;reserved 11, 12;@@ -408,6 +434,7 @@ message Issue {// - users/{email}repeated string releasers = 20;+ // The risk level of the issue.RiskLevel risk_level = 21;// The status count of the issue.@@ -421,15 +448,24 @@ message Issue {// - CANCELEDmap<string, int32> task_status_count = 22;+ // Labels attached to the issue for categorization and filtering.repeated string labels = 23;+ // The overall approval status for the issue.enum ApprovalStatus {+ // Unspecified approval status.APPROVAL_STATUS_UNSPECIFIED = 0;+ // Approval checks are being evaluated.CHECKING = 1;+ // Approval is pending.PENDING = 2;+ // Issue has been approved.APPROVED = 3;+ // Issue has been rejected.REJECTED = 4;+ // Approval was skipped.SKIPPED = 5;+ // Error occurred during approval evaluation.ERROR = 6;}ApprovalStatus approval_status = 24 [(google.api.field_behavior) = OUTPUT_ONLY];@@ -446,13 +482,19 @@ message GrantRequest {string user = 2;// The condition for the role. Same as the condtion in IAM Binding message.google.type.Expr condition = 3;+ // The duration for which the grant is valid.google.protobuf.Duration expiration = 4;}+// The status of an issue.enum IssueStatus {+ // Unspecified status.ISSUE_STATUS_UNSPECIFIED = 0;+ // Issue is open and active.OPEN = 1;+ // Issue is completed.DONE = 2;+ // Issue is canceled.CANCELED = 3;}@@ -461,12 +503,16 @@ message ApprovalTemplate {// 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.string id = 4;+ // The approval flow definition.ApprovalFlow flow = 1;+ // The title of the approval template.string title = 2;+ // The description of the approval template.string description = 3;}message ApprovalFlow {+ // The roles required for approval in order.repeated string roles = 1;}@@ -492,6 +538,7 @@ message ListIssueCommentsRequest {}message ListIssueCommentsResponse {+ // The issue comments from the specified request.repeated IssueComment issue_comments = 1;// A token, which can be sent as `page_token` to retrieve the next page.@@ -507,6 +554,7 @@ message CreateIssueCommentRequest {(google.api.resource_reference) = {type: "bytebase.com/Issue"}];+ // The comment to create.IssueComment issue_comment = 2;}@@ -518,6 +566,7 @@ message UpdateIssueCommentRequest {(google.api.resource_reference) = {type: "bytebase.com/Issue"}];+ // The comment to update.IssueComment issue_comment = 2;// The list of fields to update.@@ -528,12 +577,14 @@ message UpdateIssueCommentRequest {bool allow_missing = 4;}+// A comment on an issue.message IssueComment {reserved 6;// Format: projects/{project}/issues/{issue}/issueComments/{issueComment-uid}string name = 1;+ // The text content of the comment.string comment = 2;// TODO: use struct message instead.@@ -546,25 +597,39 @@ message IssueComment {// Format: users/{email}string creator = 7 [(google.api.field_behavior) = OUTPUT_ONLY];+ // The event associated with this comment.oneof event {+ // Approval event.Approval approval = 8;+ // Issue update event.IssueUpdate issue_update = 9;+ // Stage end event.StageEnd stage_end = 10;+ // Task update event.TaskUpdate task_update = 11;+ // Task prior backup event.TaskPriorBackup task_prior_backup = 12;}+ // Approval event information.message Approval {+ // The approval status.Status status = 1;+ // Approval status values.enum Status {+ // Unspecified status.STATUS_UNSPECIFIED = 0;+ // Approval pending.PENDING = 1;+ // Approved.APPROVED = 2;+ // Rejected.REJECTED = 3;}}+ // Issue update event information.message IssueUpdate {reserved 7, 8;@@ -579,11 +644,15 @@ message IssueComment {repeated string to_labels = 10;}+ // Stage end event information.message StageEnd {+ // The stage that ended.string stage = 1;}+ // Task update event information.message TaskUpdate {+ // The tasks that were updated.repeated string tasks = 1;// Format: projects/{project}/sheets/{sheet}optional string from_sheet = 2;@@ -591,26 +660,43 @@ message IssueComment {optional string to_sheet = 3;optional Status to_status = 6;+ // Task status values.enum Status {+ // Unspecified status.STATUS_UNSPECIFIED = 0;+ // Task is pending.PENDING = 1;+ // Task is running.RUNNING = 2;+ // Task is done.DONE = 3;+ // Task failed.FAILED = 4;+ // Task was skipped.SKIPPED = 5;+ // Task was canceled.CANCELED = 6;}}+ // Task prior backup event information.message TaskPriorBackup {+ // The task for which backup was performed.string task = 1;+ // The tables that were backed up.repeated Table tables = 2;+ // The original line number in the statement.optional int32 original_line = 3;+ // The database that was backed up.string database = 4;+ // Error message if backup failed.string error = 5;+ // Table identification.message Table {+ // The schema name.string schema = 1;+ // The table name.string table = 2;}}diff --git a/proto/v1/v1/org_policy_service.proto b/proto/v1/v1/org_policy_service.protoindex 8f52eb0e35..c91aedc6ee 100644--- a/proto/v1/v1/org_policy_service.proto+++ b/proto/v1/v1/org_policy_service.proto@@ -15,7 +15,9 @@ import "v1/common.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// OrgPolicyService manages organizational policies at various resource levels.service OrgPolicyService {+ // Retrieves a policy by name.// Permissions required: bb.policies.getrpc GetPolicy(GetPolicyRequest) returns (Policy) {option (google.api.http) = {@@ -31,6 +33,7 @@ service OrgPolicyService {option (bytebase.v1.auth_method) = IAM;}+ // Lists policies at a specified resource level.// Permissions required: bb.policies.listrpc ListPolicies(ListPoliciesRequest) returns (ListPoliciesResponse) {option (google.api.http) = {@@ -46,6 +49,7 @@ service OrgPolicyService {option (bytebase.v1.auth_method) = IAM;}+ // Creates a new organizational policy.// Permissions required: bb.policies.createrpc CreatePolicy(CreatePolicyRequest) returns (Policy) {option (google.api.http) = {@@ -75,6 +79,7 @@ service OrgPolicyService {option (bytebase.v1.audit) = true;}+ // Updates an existing organizational policy.// Permissions required: bb.policies.updaterpc UpdatePolicy(UpdatePolicyRequest) returns (Policy) {option (google.api.http) = {@@ -104,6 +109,7 @@ service OrgPolicyService {option (bytebase.v1.audit) = true;}+ // Deletes an organizational policy.// Permissions required: bb.policies.deleterpc DeletePolicy(DeletePolicyRequest) returns (google.protobuf.Empty) {option (google.api.http) = {@@ -135,6 +141,7 @@ message CreatePolicyRequest {// The policy to create.Policy policy = 2 [(google.api.field_behavior) = REQUIRED];+ // The type of policy to create.PolicyType type = 3;}@@ -187,16 +194,17 @@ message ListPoliciesRequest {(google.api.resource_reference) = {child_type: "bytebase.com/Policy"}];+ // Filter by specific policy type.optional PolicyType policy_type = 2;- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// The maximum number of policies to return. The service may return fewer than// this value.// If unspecified, at most 10 policies will be returned.// The maximum value is 1000; values above 1000 will be coerced to 1000.int32 page_size = 3;- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// A page token, received from a previous `ListPolicies` call.// Provide this to retrieve the subsequent page.//@@ -237,10 +245,13 @@ message Policy {// Database resource name: instances/instance-id/databases/database-name.string name = 1;+ // Whether this policy inherits from its parent resource.bool inherit_from_parent = 4;+ // The type of policy.PolicyType type = 5;+ // The policy configuration.oneof policy {RolloutPolicy rollout_policy = 19;MaskingRulePolicy masking_rule_policy = 17;@@ -250,33 +261,50 @@ message Policy {QueryDataPolicy query_data_policy = 24;}+ // Whether the policy is enforced.bool enforce = 13;// The resource type for the policy.PolicyResourceType resource_type = 14 [(google.api.field_behavior) = OUTPUT_ONLY];}+// The type of organizational policy.enum PolicyType {reserved 2, 4, 6, 5, 7, 12, 15;+ // Unspecified policy type.POLICY_TYPE_UNSPECIFIED = 0;+ // Rollout deployment policy.ROLLOUT_POLICY = 11;+ // Data masking rule policy.MASKING_RULE = 9;+ // Data masking exception policy.MASKING_EXCEPTION = 10;+ // Resource tag policy.TAG = 13;+ // Data source query restrictions policy.DATA_SOURCE_QUERY = 14;+ // Query data access policy.DATA_QUERY = 16;}+// The resource type that a policy can be attached to.enum PolicyResourceType {+ // Unspecified resource type.RESOURCE_TYPE_UNSPECIFIED = 0;+ // Workspace-level policy.WORKSPACE = 1;+ // Environment-level policy.ENVIRONMENT = 2;+ // Project-level policy.PROJECT = 3;}+// Rollout policy configuration.message RolloutPolicy {+ // Whether rollout is automatic without manual approval.bool automatic = 1;+ // The roles that can approve rollout execution.repeated string roles = 2;// Checkers that must pass before rollout execution.// These checks are performed in UI workflows only.@@ -312,48 +340,62 @@ message QueryDataPolicy {// The query timeout duration.google.protobuf.Duration timeout = 1;- // Disable export data in the SQL editor+ // Disable data export in the SQL editor.bool disable_export = 2;- // The size limit in bytes.+ // The maximum result size limit in bytes.// The default value is 100MB, we will use the default value if the setting not exists, or the limit <= 0.int64 maximum_result_size = 3;- // The return rows limit.+ // The maximum number of rows to return.// The default value is -1, means no limit.int32 maximum_result_rows = 4;- // Disable copying data.+ // Disable copying query results.bool disable_copy_data = 5;}-// The SQL review rules. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.+// SQL review rule configuration. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.message SQLReviewRule {+ // The type of SQL review rule.string type = 1;+ // The severity level of the rule.SQLReviewRuleLevel level = 2;// The payload is a JSON string that varies by rule type.string payload = 3;+ // The database engine this rule applies to.Engine engine = 4;+ // Additional comment for the rule.string comment = 5;}+// The severity level for SQL review rules.enum SQLReviewRuleLevel {+ // Unspecified level.LEVEL_UNSPECIFIED = 0;+ // Rule violation is an error.ERROR = 1;+ // Rule violation is a warning.WARNING = 2;+ // Rule is disabled.DISABLED = 3;}// MaskingExceptionPolicy is the allowlist of users who can access sensitive data.message MaskingExceptionPolicy {+ // An exception allowing specific users to access masked data.message MaskingException {+ // The action that the exception permits.enum Action {+ // Unspecified action.ACTION_UNSPECIFIED = 0;+ // Allow querying sensitive data.QUERY = 1;+ // Allow exporting sensitive data.EXPORT = 2;}- // action is the action that the user can access sensitive data.+ // The action that the user can perform on sensitive data.Action action = 1;// Member is the principal who bind to this exception policy instance.@@ -381,12 +423,15 @@ message MaskingExceptionPolicy {google.type.Expr condition = 4;}+ // The list of masking exceptions.repeated MaskingException masking_exceptions = 1;}+// Policy for configuring data masking rules.message MaskingRulePolicy {+ // A rule that defines when and how to mask data.message MaskingRule {- // A unique identifier for a node in UUID format.+ // A unique identifier for the rule in UUID format.string id = 1;// The condition for the masking rule.@@ -414,26 +459,32 @@ message MaskingRulePolicy {// resource.instance_id == "sample-instance" && (resource.database_name == "db1" || resource.database_name == "db2")google.type.Expr condition = 2;+ // The semantic type of data to mask (e.g., "SSN", "EMAIL").string semantic_type = 3;}+ // The list of masking rules.repeated MaskingRule rules = 1;}+// Policy for tagging resources with metadata.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}"map<string, string> tags = 1;}-// DataSourceQueryPolicy is the policy configuration for running statements in the SQL editor.+// Policy for controlling which data sources can be queried in the SQL editor.message DataSourceQueryPolicy {+ // Restriction level for admin data source access.enum Restriction {+ // Unspecified restriction.RESTRICTION_UNSPECIFIED = 0;- // Allow to query admin data sources when there is no read-only data source.+ // Allow querying admin data sources when there is no read-only data source.FALLBACK = 1;- // Disallow to query admin data sources.+ // Disallow querying admin data sources.DISALLOW = 2;}+ // Restriction for admin data source queries.Restriction admin_data_source_restriction = 1;// Disallow running DDL statements in the SQL editor.diff --git a/proto/v1/v1/plan_service.proto b/proto/v1/v1/plan_service.protoindex 92d91a24dc..4d499b28d5 100644--- a/proto/v1/v1/plan_service.proto+++ b/proto/v1/v1/plan_service.proto@@ -14,7 +14,9 @@ import "v1/database_service.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// PlanService manages deployment plans for database changes.service PlanService {+ // Retrieves a deployment plan by name.// Permissions required: bb.plans.getrpc GetPlan(GetPlanRequest) returns (Plan) {option (google.api.http) = {get: "/v1/{name=projects/*/plans/*}"};@@ -23,6 +25,7 @@ service PlanService {option (bytebase.v1.auth_method) = IAM;}+ // Lists deployment plans in a project.// Permissions required: bb.plans.listrpc ListPlans(ListPlansRequest) returns (ListPlansResponse) {option (google.api.http) = {get: "/v1/{parent=projects/*}/plans"};@@ -43,6 +46,7 @@ service PlanService {option (bytebase.v1.auth_method) = CUSTOM;}+ // Creates a new deployment plan.// Permissions required: bb.plans.createrpc CreatePlan(CreatePlanRequest) returns (Plan) {option (google.api.http) = {@@ -57,7 +61,7 @@ service PlanService {// UpdatePlan updates the plan.// The plan creator and the user with bb.plans.update permission on the project can update the plan.- // Permissions required: bb.plans.update+ // Permissions required: bb.plans.update (or creator)rpc UpdatePlan(UpdatePlanRequest) returns (Plan) {option (google.api.http) = {patch: "/v1/{plan.name=projects/*/plans/*}"@@ -69,6 +73,7 @@ service PlanService {option (bytebase.v1.audit) = true;}+ // Lists plan check runs for a deployment plan.// Permissions required: bb.planCheckRuns.listrpc ListPlanCheckRuns(ListPlanCheckRunsRequest) returns (ListPlanCheckRunsResponse) {option (google.api.http) = {get: "/v1/{parent=projects/*/plans/*}/planCheckRuns"};@@ -77,6 +82,7 @@ service PlanService {option (bytebase.v1.auth_method) = IAM;}+ // Executes validation checks on a deployment plan.// Permissions required: bb.planCheckRuns.runrpc RunPlanChecks(RunPlanChecksRequest) returns (RunPlanChecksResponse) {option (google.api.http) = {@@ -88,6 +94,7 @@ service PlanService {option (bytebase.v1.auth_method) = IAM;}+ // Cancels multiple plan check runs.// Permissions required: bb.planCheckRuns.runrpc BatchCancelPlanCheckRuns(BatchCancelPlanCheckRunsRequest) returns (BatchCancelPlanCheckRunsResponse) {option (google.api.http) = {@@ -242,9 +249,12 @@ message Plan {// Format: projects/{project}/rollouts/{rollout}string rollout = 15 [(google.api.field_behavior) = OUTPUT_ONLY];+ // The title of the plan.string title = 4;+ // The description of the plan.string description = 5;+ // The deployment specs for the plan.repeated Spec specs = 14;message Spec {@@ -363,14 +373,14 @@ message ListPlanCheckRunsRequest {(google.api.resource_reference) = {type: "bytebase.com/Plan"}];- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// The maximum number of plan check runs to return. The service may return fewer than// this value.// If unspecified, at most 10 plan check runs will be returned.// The maximum value is 1000; values above 1000 will be coerced to 1000.int32 page_size = 2;- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// A page token, received from a previous `ListPlanCheckRuns` call.// Provide this to retrieve the subsequent page.//@@ -443,11 +453,17 @@ message PlanCheckRun {string name = 1;enum Type {+ // Unspecified check type.TYPE_UNSPECIFIED = 0;+ // Fake advise check for testing purposes without executing against database.DATABASE_STATEMENT_FAKE_ADVISE = 1;+ // SQL review check that analyzes statements against configured SQL review rules.DATABASE_STATEMENT_ADVISE = 3;+ // Summary report check that generates impact analysis for the statements.DATABASE_STATEMENT_SUMMARY_REPORT = 5;+ // Connection check that verifies database connectivity.DATABASE_CONNECT = 6;+ // Ghost sync check that validates gh-ost online schema change compatibility.DATABASE_GHOST_SYNC = 7;}Type type = 3;diff --git a/proto/v1/v1/project_service.proto b/proto/v1/v1/project_service.protoindex abb787ece7..8449e03d2f 100644--- a/proto/v1/v1/project_service.proto+++ b/proto/v1/v1/project_service.proto@@ -14,6 +14,7 @@ import "v1/iam_policy.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// ProjectService manages projects that group databases and changes.service ProjectService {// GetProject retrieves a project by name.// Users with "bb.projects.get" permission on the workspace or the project owner can access this method.@@ -25,6 +26,7 @@ service ProjectService {option (bytebase.v1.auth_method) = IAM;}+ // Lists all projects in the workspace with optional filtering.// Permissions required: bb.projects.listrpc ListProjects(ListProjectsRequest) returns (ListProjectsResponse) {option (google.api.http) = {get: "/v1/projects"};@@ -33,7 +35,8 @@ service ProjectService {option (bytebase.v1.auth_method) = IAM;}- // Permissions required: None+ // Searches for projects with advanced filtering capabilities.+ // Permissions required: bb.projects.get (or project-level bb.projects.get for specific projects)rpc SearchProjects(SearchProjectsRequest) returns (SearchProjectsResponse) {option (google.api.http) = {post: "/v1/projects:search"@@ -44,6 +47,7 @@ service ProjectService {// TODO(d): secure it.}+ // Creates a new project in the workspace.// Permissions required: bb.projects.createrpc CreateProject(CreateProjectRequest) returns (Project) {option (google.api.http) = {@@ -55,6 +59,7 @@ service ProjectService {option (bytebase.v1.auth_method) = IAM;}+ // Updates an existing project's properties.// Permissions required: bb.projects.updaterpc UpdateProject(UpdateProjectRequest) returns (Project) {option (google.api.http) = {@@ -66,6 +71,7 @@ service ProjectService {option (bytebase.v1.auth_method) = IAM;}+ // Deletes (soft-delete or purge) a project.// Permissions required: bb.projects.deleterpc DeleteProject(DeleteProjectRequest) returns (google.protobuf.Empty) {option (google.api.http) = {delete: "/v1/{name=projects/*}"};@@ -75,6 +81,7 @@ service ProjectService {option (bytebase.v1.audit) = true;}+ // Restores a soft-deleted project.// Permissions required: bb.projects.undeleterpc UndeleteProject(UndeleteProjectRequest) returns (Project) {option (google.api.http) = {@@ -86,6 +93,7 @@ service ProjectService {option (bytebase.v1.audit) = true;}+ // Deletes multiple projects in a single operation.// Permissions required: bb.projects.deleterpc BatchDeleteProjects(BatchDeleteProjectsRequest) returns (google.protobuf.Empty) {option (google.api.http) = {@@ -97,6 +105,7 @@ service ProjectService {option (bytebase.v1.audit) = true;}+ // Retrieves the IAM policy for a project.// Permissions required: bb.projects.getIamPolicyrpc GetIamPolicy(GetIamPolicyRequest) returns (IamPolicy) {option (google.api.http) = {get: "/v1/{resource=projects/*}:getIamPolicy"};@@ -104,14 +113,15 @@ service ProjectService {option (bytebase.v1.auth_method) = IAM;}- // Deprecated.- // Permissions required: bb.projects.getIamPolicy+ // Deprecated. No permission check implemented.+ // Permissions required: Nonerpc BatchGetIamPolicy(BatchGetIamPolicyRequest) returns (BatchGetIamPolicyResponse) {option (google.api.http) = {get: "/v1/{scope=*/*}/iamPolicies:batchGet"};option (bytebase.v1.permission) = "bb.projects.getIamPolicy";option (bytebase.v1.auth_method) = CUSTOM;}+ // Sets the IAM policy for a project.// Permissions required: bb.projects.setIamPolicyrpc SetIamPolicy(SetIamPolicyRequest) returns (IamPolicy) {option (google.api.http) = {@@ -123,6 +133,7 @@ service ProjectService {option (bytebase.v1.audit) = true;}+ // Adds a webhook to a project for notifications.// Permissions required: bb.projects.updaterpc AddWebhook(AddWebhookRequest) returns (Project) {option (google.api.http) = {@@ -133,6 +144,7 @@ service ProjectService {option (bytebase.v1.auth_method) = IAM;}+ // Updates an existing webhook configuration.// Permissions required: bb.projects.updaterpc UpdateWebhook(UpdateWebhookRequest) returns (Project) {option (google.api.http) = {@@ -144,6 +156,7 @@ service ProjectService {option (bytebase.v1.auth_method) = IAM;}+ // Removes a webhook from a project.// Permissions required: bb.projects.updaterpc RemoveWebhook(RemoveWebhookRequest) returns (Project) {option (google.api.http) = {@@ -154,6 +167,7 @@ service ProjectService {option (bytebase.v1.auth_method) = IAM;}+ // Tests a webhook by sending a test notification.// Permissions required: bb.projects.updaterpc TestWebhook(TestWebhookRequest) returns (TestWebhookResponse) {option (google.api.http) = {@@ -339,17 +353,25 @@ message BatchGetIamPolicyRequest {}message BatchGetIamPolicyResponse {+ // Result for a single project's IAM policy.message PolicyResult {+ // The project resource name.string project = 1;+ // The IAM policy for the project.IamPolicy policy = 2;}+ // The policy results for each requested project.repeated PolicyResult policy_results = 1;}+// A label for categorizing and organizing issues.message Label {+ // The label value/name.string value = 1;+ // The color code for the label (e.g., hex color).string color = 2;+ // The group this label belongs to.string group = 3;}@@ -364,52 +386,57 @@ message Project {// Format: projects/{project}string name = 1;+ // The lifecycle state of the project.State state = 3;// The title or name of a project. It's not unique within the workspace.string title = 4;+ // The list of webhooks configured for the project.repeated Webhook webhooks = 11;+ // The data classification configuration ID for the project.string data_classification_config_id = 12;+ // Labels available for tagging issues in this project.repeated Label issue_labels = 13;// Force issue labels to be used when creating an issue.bool force_issue_labels = 14;- // Allow modifying statement after issue is created.+ // Allow modifying SQL statements after issue is created.bool allow_modify_statement = 15;- // Enable auto resolve issue.+ // Enable automatic issue resolution when tasks complete.bool auto_resolve_issue = 16;- // Enforce issue title created by user instead of generated by Bytebase.+ // Enforce issue title to be created by user instead of generated by Bytebase.bool enforce_issue_title = 17;- // Whether to automatically enable backup.+ // Whether to automatically enable backup for database changes.bool auto_enable_backup = 18;- // Whether to skip backup errors and continue the data migration.+ // Whether to skip backup errors and continue with data migration.bool skip_backup_errors = 19;- // Whether to enable the database tenant mode for PostgreSQL.- // If enabled, the issue will be created with the prepend "set role <db_owner>" statement.+ // Whether to enable database tenant mode for PostgreSQL.+ // If enabled, issues will include "set role <db_owner>" statement.bool postgres_database_tenant_mode = 20;- // Whether to allow the issue creator to self-approve the issue.+ // Whether to allow issue creators to self-approve their own issues.bool allow_self_approval = 21;- // Execution retry policy for the task run.+ // Execution retry policy for task runs.ExecutionRetryPolicy execution_retry_policy = 22;+ // Execution retry policy configuration.message ExecutionRetryPolicy {- // The maximum number of retries for the lock timeout issue.+ // The maximum number of retries for lock timeout errors.int32 maximum_retries = 1;}- // The maximum databases of rows to sample during CI data validation.- // Without specification, sampling is disabled, resulting in a full validation.+ // The maximum number of database rows to sample during CI data validation.+ // Without specification, sampling is disabled, resulting in full validation.int32 ci_sampling_size = 23;- // The maximum number of parallel tasks to run during the rollout.+ // The maximum number of parallel tasks allowed during rollout execution.int32 parallel_tasks_per_rollout = 24;// Labels are key-value pairs that can be attached to the project.@@ -477,14 +504,23 @@ message Webhook {// format: projects/{project}/webhooks/{webhook}string name = 1;+ // Webhook integration type.enum Type {+ // Unspecified type.TYPE_UNSPECIFIED = 0;+ // Slack integration.SLACK = 1;+ // Discord integration.DISCORD = 2;+ // Microsoft Teams integration.TEAMS = 3;+ // DingTalk integration.DINGTALK = 4;+ // Feishu integration.FEISHU = 5;+ // WeCom (WeChat Work) integration.WECOM = 6;+ // Lark integration.LARK = 8;}// type is the type of the webhook.@@ -513,9 +549,12 @@ message Webhook {repeated Activity.Type notification_types = 5 [(google.api.field_behavior) = UNORDERED_LIST];}+// Activity types for webhook notifications.// TODO(zp): move to activity later.message Activity {+ // Activity type enumeration.enum Type {+ // Unspecified type.TYPE_UNSPECIFIED = 0;// Notifications via webhooks.//diff --git a/proto/v1/v1/release_service.proto b/proto/v1/v1/release_service.protoindex 4307073a5e..5a85489a29 100644--- a/proto/v1/v1/release_service.proto+++ b/proto/v1/v1/release_service.proto@@ -15,7 +15,9 @@ import "v1/sql_service.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// ReleaseService manages releases for coordinating deployments.service ReleaseService {+ // Retrieves a release by name.// Permissions required: bb.releases.getrpc GetRelease(GetReleaseRequest) returns (Release) {option (google.api.http) = {get: "/v1/{name=projects/*/releases/*}"};@@ -24,6 +26,7 @@ service ReleaseService {option (bytebase.v1.auth_method) = IAM;}+ // Lists releases in a project.// Permissions required: bb.releases.listrpc ListReleases(ListReleasesRequest) returns (ListReleasesResponse) {option (google.api.http) = {get: "/v1/{parent=projects/*}/releases"};@@ -32,6 +35,7 @@ service ReleaseService {option (bytebase.v1.auth_method) = IAM;}+ // Searches releases by digest or other criteria.// Permissions required: bb.releases.getrpc SearchReleases(SearchReleasesRequest) returns (SearchReleasesResponse) {option (google.api.http) = {get: "/v1/{parent=projects/*}/releases:search"};@@ -40,6 +44,7 @@ service ReleaseService {option (bytebase.v1.auth_method) = IAM;}+ // Creates a new release with SQL files.// Permissions required: bb.releases.createrpc CreateRelease(CreateReleaseRequest) returns (Release) {option (google.api.http) = {@@ -51,6 +56,7 @@ service ReleaseService {option (bytebase.v1.auth_method) = IAM;}+ // Updates an existing release.// Permissions required: bb.releases.updaterpc UpdateRelease(UpdateReleaseRequest) returns (Release) {option (google.api.http) = {@@ -62,6 +68,7 @@ service ReleaseService {option (bytebase.v1.auth_method) = IAM;}+ // Deletes a release.// Permissions required: bb.releases.deleterpc DeleteRelease(DeleteReleaseRequest) returns (google.protobuf.Empty) {option (google.api.http) = {delete: "/v1/{name=projects/*/releases/*}"};@@ -70,6 +77,7 @@ service ReleaseService {option (bytebase.v1.auth_method) = IAM;}+ // Restores a deleted release.// Permissions required: bb.releases.undeleterpc UndeleteRelease(UndeleteReleaseRequest) returns (Release) {option (google.api.http) = {post: "/v1/{name=projects/*/releases/*}:undelete"};@@ -77,6 +85,7 @@ service ReleaseService {option (bytebase.v1.auth_method) = IAM;}+ // Validates a release by dry-running checks on target databases.// Permissions required: bb.releases.checkrpc CheckRelease(CheckReleaseRequest) returns (CheckReleaseResponse) {option (google.api.http) = {@@ -120,6 +129,7 @@ message ListReleasesRequest {}message ListReleasesResponse {+ // The releases from the specified request.repeated Release releases = 1;// A token, which can be sent as `page_token` to retrieve the next page.@@ -151,6 +161,7 @@ message SearchReleasesRequest {}message SearchReleasesResponse {+ // The releases matching the search criteria.repeated Release releases = 1;// A token, which can be sent as `page_token` to retrieve the next page.@@ -218,6 +229,7 @@ message CheckReleaseRequest {}message CheckReleaseResponse {+ // Check result for a single release file on a target database.message CheckResult {// The file path that is being checked.string file = 1;@@ -236,9 +248,10 @@ message CheckReleaseResponse {RiskLevel risk_level = 5;}+ // The check results for each file and target combination.repeated CheckResult results = 1;- // The affected rows of the check.+ // The total affected rows across all checks.int64 affected_rows = 2;// The aggregated risk level of the check.@@ -254,10 +267,13 @@ message Release {// Format: projects/{project}/releases/{release}string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];+ // The title of the release.string title = 2;+ // The SQL files included in the release.repeated File files = 3;+ // The version control source of the release.VCSSource vcs_source = 4;// Format: users/[email protected]@@ -265,6 +281,7 @@ message Release {google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];+ // The lifecycle state of the release.State state = 7 [(google.api.field_behavior) = OUTPUT_ONLY];// The digest of the release.@@ -273,6 +290,7 @@ message Release {// If the digest is not empty, it must be unique in the project. Otherwise, an ALREADY_EXISTS error will be returned.string digest = 8;+ // A SQL file in a release.message File {// The unique identifier for the file.string id = 1;@@ -280,6 +298,7 @@ message Release {string path = 2;// The type of the file.Type type = 5;+ // The version identifier for the file.string version = 6;// The migration type of the file.// For versioned files, it is the migration type of the file.@@ -299,21 +318,32 @@ message Release {// The size of the statement in bytes.int64 statement_size = 8 [(google.api.field_behavior) = OUTPUT_ONLY];+ // The type of migration file.enum Type {+ // Unspecified type.TYPE_UNSPECIFIED = 0;+ // Versioned migration file with sequential version numbers.VERSIONED = 1;+ // Declarative schema definition file describing desired state.DECLARATIVE = 2;}+ // The migration type for versioned files.enum MigrationType {+ // Unspecified migration type.MIGRATION_TYPE_UNSPECIFIED = 0;+ // DDL (Data Definition Language) migration.DDL = 1;+ // DDL migration using gh-ost for online schema changes.DDL_GHOST = 2;+ // DML (Data Manipulation Language) migration.DML = 3;}}+ // Version control system source information.message VCSSource {+ // The type of VCS.VCSType vcs_type = 1;// 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 7ca34c8987..9909a09f92 100644--- a/proto/v1/v1/review_config_service.proto+++ b/proto/v1/v1/review_config_service.proto@@ -13,7 +13,9 @@ import "v1/org_policy_service.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// ReviewConfigService manages approval flow configurations.service ReviewConfigService {+ // Creates a new SQL review configuration.// Permissions required: bb.reviewConfigs.createrpc CreateReviewConfig(CreateReviewConfigRequest) returns (ReviewConfig) {option (google.api.http) = {@@ -25,6 +27,7 @@ service ReviewConfigService {option (bytebase.v1.auth_method) = IAM;}+ // Lists all SQL review configurations.// Permissions required: bb.reviewConfigs.listrpc ListReviewConfigs(ListReviewConfigsRequest) returns (ListReviewConfigsResponse) {option (google.api.http) = {get: "/v1/reviewConfigs"};@@ -33,6 +36,7 @@ service ReviewConfigService {option (bytebase.v1.auth_method) = IAM;}+ // Retrieves a SQL review configuration by name.// Permissions required: bb.reviewConfigs.getrpc GetReviewConfig(GetReviewConfigRequest) returns (ReviewConfig) {option (google.api.http) = {get: "/v1/{name=reviewConfigs/*}"};@@ -41,6 +45,7 @@ service ReviewConfigService {option (bytebase.v1.auth_method) = IAM;}+ // Updates a SQL review configuration.// Permissions required: bb.reviewConfigs.updaterpc UpdateReviewConfig(UpdateReviewConfigRequest) returns (ReviewConfig) {option (google.api.http) = {@@ -52,6 +57,7 @@ service ReviewConfigService {option (bytebase.v1.auth_method) = IAM;}+ // Deletes a SQL review configuration.// Permissions required: bb.reviewConfigs.deleterpc DeleteReviewConfig(DeleteReviewConfigRequest) returns (google.protobuf.Empty) {option (google.api.http) = {delete: "/v1/{name=reviewConfigs/*}"};@@ -62,14 +68,14 @@ service ReviewConfigService {}message ListReviewConfigsRequest {- // Not used.+ // 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.int32 page_size = 1;- // Not used.+ // 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@@ -133,13 +139,16 @@ message ReviewConfig {// Format: reviewConfigs/{reviewConfig}string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];+ // The title of the review configuration.string title = 2;+ // Whether the review configuration is enabled.bool enabled = 3;+ // The SQL review rules to enforce.repeated SQLReviewRule rules = 7;// resources using the config.- // Format: {resurce}/{resource id}, for example, environments/test.+ // Format: {resource}/{resource id}, for example, environments/test.repeated string resources = 8;}diff --git a/proto/v1/v1/revision_service.proto b/proto/v1/v1/revision_service.protoindex a76678f354..972c2bd842 100644--- a/proto/v1/v1/revision_service.proto+++ b/proto/v1/v1/revision_service.proto@@ -12,7 +12,9 @@ import "v1/annotation.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// RevisionService manages schema revision history.service RevisionService {+ // Lists schema revisions for a database.// Permissions required: bb.revisions.listrpc ListRevisions(ListRevisionsRequest) returns (ListRevisionsResponse) {option (google.api.http) = {get: "/v1/{parent=instances/*/databases/*}/revisions"};@@ -21,6 +23,7 @@ service RevisionService {option (bytebase.v1.auth_method) = IAM;}+ // Retrieves a schema revision by name.// Permissions required: bb.revisions.getrpc GetRevision(GetRevisionRequest) returns (Revision) {option (google.api.http) = {get: "/v1/{name=instances/*/databases/*/revisions/*}"};@@ -29,6 +32,7 @@ service RevisionService {option (bytebase.v1.auth_method) = IAM;}+ // Creates a new schema revision.// Permissions required: bb.revisions.createrpc CreateRevision(CreateRevisionRequest) returns (Revision) {option (google.api.http) = {@@ -39,6 +43,7 @@ service RevisionService {option (bytebase.v1.auth_method) = IAM;}+ // Creates multiple schema revisions in a single operation.// Permissions required: bb.revisions.createrpc BatchCreateRevisions(BatchCreateRevisionsRequest) returns (BatchCreateRevisionsResponse) {option (google.api.http) = {@@ -49,6 +54,7 @@ service RevisionService {option (bytebase.v1.auth_method) = IAM;}+ // Deletes a schema revision.// Permissions required: bb.revisions.deleterpc DeleteRevision(DeleteRevisionRequest) returns (google.protobuf.Empty) {option (google.api.http) = {delete: "/v1/{name=instances/*/databases/*/revisions/*}"};@@ -78,10 +84,12 @@ message ListRevisionsRequest {// match the call that provided the page token.string page_token = 3;+ // Whether to include deleted revisions in the results.bool show_deleted = 4;}message ListRevisionsResponse {+ // The revisions from the specified request.repeated Revision revisions = 1;// A token, which can be sent as `page_token` to retrieve the next page.@@ -162,6 +170,7 @@ message Revision {// Can be empty.string file = 7;+ // The schema version string for this revision.string version = 8;// The sheet that holds the content.@@ -171,6 +180,7 @@ message Revision {string sheet_sha256 = 10 [(google.api.field_behavior) = OUTPUT_ONLY];// The statement is used for preview purpose.string statement = 11 [(google.api.field_behavior) = OUTPUT_ONLY];+ // The size of the statement in bytes.int64 statement_size = 12 [(google.api.field_behavior) = OUTPUT_ONLY];// The issue associated with the revision.@@ -187,9 +197,13 @@ message Revision {// The type of the revision.Type type = 15;+ // The type of schema revision.enum Type {+ // Unspecified type.TYPE_UNSPECIFIED = 0;+ // Versioned schema migration.VERSIONED = 1;+ // Declarative schema definition.DECLARATIVE = 2;}}diff --git a/proto/v1/v1/risk_service.proto b/proto/v1/v1/risk_service.protoindex 060eb334e5..2030374e56 100644--- a/proto/v1/v1/risk_service.proto+++ b/proto/v1/v1/risk_service.proto@@ -14,7 +14,9 @@ import "v1/common.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// RiskService manages risk assessment rules for database changes.service RiskService {+ // Lists all risk assessment rules.// Permissions required: bb.risks.listrpc ListRisks(ListRisksRequest) returns (ListRisksResponse) {option (google.api.http) = {get: "/v1/risks"};@@ -23,6 +25,7 @@ service RiskService {option (bytebase.v1.auth_method) = IAM;}+ // Creates a new risk assessment rule.// Permissions required: bb.risks.createrpc CreateRisk(CreateRiskRequest) returns (Risk) {option (google.api.http) = {@@ -35,6 +38,7 @@ service RiskService {option (bytebase.v1.audit) = true;}+ // Retrieves a risk assessment rule by name.// Permissions required: bb.risks.listrpc GetRisk(GetRiskRequest) returns (Risk) {option (google.api.http) = {get: "/v1/{name=risks/*}"};@@ -43,6 +47,7 @@ service RiskService {option (bytebase.v1.auth_method) = IAM;}+ // Updates an existing risk assessment rule.// Permissions required: bb.risks.updaterpc UpdateRisk(UpdateRiskRequest) returns (Risk) {option (google.api.http) = {@@ -55,6 +60,7 @@ service RiskService {option (bytebase.v1.audit) = true;}+ // Deletes a risk assessment rule.// Permissions required: bb.risks.deleterpc DeleteRisk(DeleteRiskRequest) returns (google.protobuf.Empty) {option (google.api.http) = {delete: "/v1/{name=risks/*}"};@@ -65,18 +71,18 @@ service RiskService {}message ListRisksRequest {- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// The maximum number of risks to return. The service may return fewer than// this value.// If unspecified, at most 10 risks will be returned.// The maximum value is 1000; values above 1000 will be coerced to 1000.int32 page_size = 1;- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// A page token, received from a previous `ListRisks` call.// Provide this to retrieve the subsequent page.//- // When paginating, all other parameters provided to `LiskRisks` must match+ // When paginating, all other parameters provided to `ListRisks` must match// the call that provided the page token.string page_token = 2;}@@ -148,8 +154,11 @@ message Risk {}Source source = 3;+ // The title of the risk rule.string title = 4;+ // The risk level assigned when this rule matches.RiskLevel level = 5;+ // Whether the risk rule is active.bool active = 7;// The condition that is associated with the risk.diff --git a/proto/v1/v1/role_service.proto b/proto/v1/v1/role_service.protoindex 4f8f50ca9d..1a1758ba5b 100644--- a/proto/v1/v1/role_service.proto+++ b/proto/v1/v1/role_service.proto@@ -12,7 +12,9 @@ import "v1/annotation.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// RoleService manages workspace roles and permissions.service RoleService {+ // Lists roles in the workspace.// Permissions required: bb.roles.listrpc ListRoles(ListRolesRequest) returns (ListRolesResponse) {option (google.api.http) = {get: "/v1/roles"};@@ -20,6 +22,7 @@ service RoleService {option (bytebase.v1.auth_method) = IAM;}+ // Retrieves a role by name.// Permissions required: bb.roles.getrpc GetRole(GetRoleRequest) returns (Role) {option (google.api.http) = {get: "/v1/{name=roles/*}"};@@ -28,6 +31,7 @@ service RoleService {option (bytebase.v1.auth_method) = IAM;}+ // Creates a new custom role.// Permissions required: bb.roles.createrpc CreateRole(CreateRoleRequest) returns (Role) {option (google.api.http) = {@@ -39,6 +43,7 @@ service RoleService {option (bytebase.v1.audit) = true;}+ // Updates a role's properties.// Permissions required: bb.roles.updaterpc UpdateRole(UpdateRoleRequest) returns (Role) {option (google.api.http) = {@@ -51,6 +56,7 @@ service RoleService {option (bytebase.v1.audit) = true;}+ // Deletes a custom role.// Permissions required: bb.roles.deleterpc DeleteRole(DeleteRoleRequest) returns (google.protobuf.Empty) {option (google.api.http) = {delete: "/v1/{name=roles/*}"};@@ -62,14 +68,14 @@ service RoleService {}message ListRolesRequest {- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// The maximum number of roles to return. The service may return fewer than// this value.// If unspecified, at most 10 reviews will be returned.// The maximum value is 1000; values above 1000 will be coerced to 1000.int32 page_size = 1;- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// A page token, received from a previous `ListRoles` call.// Provide this to retrieve the subsequent page.//@@ -79,6 +85,7 @@ message ListRolesRequest {}message ListRolesResponse {+ // The roles from the specified request.repeated Role roles = 1;// A token, which can be sent as `page_token` to retrieve the next page.@@ -87,6 +94,7 @@ message ListRolesResponse {}message CreateRoleRequest {+ // The role to create.Role role = 1 [(google.api.field_behavior) = REQUIRED];// The ID to use for the role, which will become the final component@@ -107,13 +115,17 @@ message GetRoleRequest {}message UpdateRoleRequest {- Role role = 1;+ // The role to update.+ Role role = 1 [(google.api.field_behavior) = REQUIRED];+ // The list of fields to update.google.protobuf.FieldMask update_mask = 2;// If set to true, and the role is not found, a new role will be created.+ // In this situation, `update_mask` is ignored.bool allow_missing = 3;}message DeleteRoleRequest {+ // The name of the role to delete.// Format: roles/{role}string name = 1 [(google.api.field_behavior) = REQUIRED,@@ -121,23 +133,30 @@ message DeleteRoleRequest {];}+// Role defines a set of permissions that can be assigned to users.message Role {option (google.api.resource) = {type: "bytebase.com/Role"pattern: "roles/{role}"};- // Format: roles/{role}+ // Resource name. Format: roles/{role}string name = 1;+ // Human-readable title.string title = 2;+ // Optional description of the role.string description = 3;+ // List of permission identifiers granted by this role.repeated string permissions = 4;enum Type {TYPE_UNSPECIFIED = 0;+ // System-defined role that cannot be modified.BUILT_IN = 1;+ // User-defined role that can be modified.CUSTOM = 2;}+ // Role type indicating if it's built-in or custom.Type type = 5;}diff --git a/proto/v1/v1/rollout_service.proto b/proto/v1/v1/rollout_service.protoindex 20d45bf6aa..e8bd8a382d 100644--- a/proto/v1/v1/rollout_service.proto+++ b/proto/v1/v1/rollout_service.proto@@ -13,7 +13,9 @@ import "v1/plan_service.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// RolloutService manages the execution of deployment plans.service RolloutService {+ // Retrieves a rollout by name.// Permissions required: bb.rollouts.getrpc GetRollout(GetRolloutRequest) returns (Rollout) {option (google.api.http) = {get: "/v1/{name=projects/*/rollouts/*}"};@@ -22,6 +24,7 @@ service RolloutService {option (bytebase.v1.auth_method) = IAM;}+ // Lists rollouts in a project.// Permissions required: bb.rollouts.listrpc ListRollouts(ListRolloutsRequest) returns (ListRolloutsResponse) {option (google.api.http) = {get: "/v1/{parent=projects/*}/rollouts"};@@ -30,6 +33,7 @@ service RolloutService {option (bytebase.v1.auth_method) = IAM;}+ // Creates a new rollout from a plan.// Permissions required: bb.rollouts.createrpc CreateRollout(CreateRolloutRequest) returns (Rollout) {option (google.api.http) = {@@ -42,6 +46,7 @@ service RolloutService {option (bytebase.v1.audit) = true;}+ // Previews the rollout that would be created from a plan.// Permissions required: bb.rollouts.previewrpc PreviewRollout(PreviewRolloutRequest) returns (Rollout) {option (google.api.http) = {@@ -53,6 +58,7 @@ service RolloutService {option (bytebase.v1.auth_method) = IAM;}+ // Lists task run executions for a task.// Permissions required: bb.taskRuns.listrpc ListTaskRuns(ListTaskRunsRequest) returns (ListTaskRunsResponse) {option (google.api.http) = {get: "/v1/{parent=projects/*/rollouts/*/stages/*/tasks/*}/taskRuns"};@@ -61,6 +67,7 @@ service RolloutService {option (bytebase.v1.auth_method) = IAM;}+ // Retrieves a task run by name.// Permissions required: bb.taskRuns.listrpc GetTaskRun(GetTaskRunRequest) returns (TaskRun) {option (google.api.http) = {get: "/v1/{name=projects/*/rollouts/*/stages/*/tasks/*/taskRuns/*}"};@@ -69,6 +76,7 @@ service RolloutService {option (bytebase.v1.auth_method) = IAM;}+ // Retrieves execution logs for a task run.// Permissions required: bb.taskRuns.listrpc GetTaskRunLog(GetTaskRunLogRequest) returns (TaskRunLog) {option (google.api.http) = {get: "/v1/{parent=projects/*/rollouts/*/stages/*/tasks/*/taskRuns/*}/log"};@@ -77,6 +85,7 @@ service RolloutService {option (bytebase.v1.auth_method) = IAM;}+ // Retrieves database session information for a running task.// Permissions required: bb.taskRuns.listrpc GetTaskRunSession(GetTaskRunSessionRequest) returns (TaskRunSession) {option (google.api.http) = {get: "/v1/{parent=projects/*/rollouts/*/stages/*/tasks/*/taskRuns/*}/session"};@@ -85,7 +94,8 @@ service RolloutService {option (bytebase.v1.auth_method) = IAM;}- // Permissions required: None+ // Executes multiple tasks in a rollout stage.+ // Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)rpc BatchRunTasks(BatchRunTasksRequest) returns (BatchRunTasksResponse) {option (google.api.http) = {post: "/v1/{parent=projects/*/rollouts/*/stages/*}/tasks:batchRun"@@ -95,7 +105,8 @@ service RolloutService {option (bytebase.v1.auth_method) = CUSTOM;}- // Permissions required: None+ // Skips multiple tasks in a rollout stage.+ // Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)rpc BatchSkipTasks(BatchSkipTasksRequest) returns (BatchSkipTasksResponse) {option (google.api.http) = {post: "/v1/{parent=projects/*/rollouts/*/stages/*}/tasks:batchSkip"@@ -105,7 +116,8 @@ service RolloutService {option (bytebase.v1.auth_method) = CUSTOM;}- // Permissions required: None+ // Cancels multiple running task executions.+ // Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)rpc BatchCancelTaskRuns(BatchCancelTaskRunsRequest) returns (BatchCancelTaskRunsResponse) {option (google.api.http) = {post: "/v1/{parent=projects/*/rollouts/*/stages/*/tasks/*}/taskRuns:batchCancel"@@ -115,6 +127,7 @@ service RolloutService {option (bytebase.v1.auth_method) = CUSTOM;}+ // Generates rollback SQL for a completed task run.// Permissions required: bb.taskRuns.listrpc PreviewTaskRunRollback(PreviewTaskRunRollbackRequest) returns (PreviewTaskRunRollbackResponse) {option (google.api.http) = {@@ -135,6 +148,7 @@ message BatchRunTasksRequest {// Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}repeated string tasks = 2;+ // The reason for running the tasks.string reason = 3;// The task run should run after run_time.@@ -151,6 +165,7 @@ message BatchSkipTasksRequest {// Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}repeated string tasks = 2;+ // The reason for skipping the tasks.string reason = 3;}@@ -165,6 +180,7 @@ message BatchCancelTaskRunsRequest {// Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{taskRun}repeated string task_runs = 2;+ // The reason for canceling the task runs.string reason = 3;}@@ -268,14 +284,14 @@ message ListTaskRunsRequest {(google.api.resource_reference) = {type: "bytebase.com/Task"}];- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// The maximum number of taskRuns to return. The service may return fewer than// this value.// If unspecified, at most 10 taskRuns will be returned.// The maximum value is 1000; values above 1000 will be coerced to 1000.int32 page_size = 2;- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// A page token, received from a previous `ListTaskRuns` call.// Provide this to retrieve the subsequent page.//@@ -366,6 +382,7 @@ message Stage {// Format: environments/{environment} for valid environments, or "environments/-" for stages without environment or with deleted environments.string environment = 4;+ // The tasks within this stage.repeated Task tasks = 5;}@@ -385,29 +402,44 @@ message Task {string spec_id = 4;enum Status {+ // Unspecified status.STATUS_UNSPECIFIED = 0;+ // Task has not started and is awaiting its turn in the deployment sequence.NOT_STARTED = 1;+ // Task is ready to run and waiting for approval or scheduled time.PENDING = 2;+ // Task is currently executing.RUNNING = 3;+ // Task completed successfully.DONE = 4;+ // Task execution failed with errors.FAILED = 5;+ // Task execution was canceled by a user.CANCELED = 6;+ // Task was skipped and will not be executed.SKIPPED = 7;}// Status is the status of the task.Status status = 5;+ // The reason why the task was skipped.string skipped_reason = 15;enum Type {+ // Unspecified task type.TYPE_UNSPECIFIED = 0;+ // General task for miscellaneous operations.GENERAL = 1;- // use payload DatabaseCreate+ // Database creation task that creates a new database.+ // Use payload DatabaseCreate.DATABASE_CREATE = 2;- // use payload DatabaseUpdate+ // Database migration task that applies versioned schema changes.+ // Use payload DatabaseUpdate.DATABASE_MIGRATE = 3;- // use payload DatabaseUpdate+ // Database SDL (Schema Definition Language) task that synchronizes declarative schema.+ // Use payload DatabaseUpdate.DATABASE_SDL = 6;- // use payload DatabaseDataExport+ // Database export task that exports query results or table data.+ // Use payload DatabaseDataExport.DATABASE_EXPORT = 5;}Type type = 6;@@ -430,6 +462,7 @@ message Task {// If there are no task runs or the task run is not scheduled, it will be empty.optional google.protobuf.Timestamp run_time = 21 [(google.api.field_behavior) = OUTPUT_ONLY];+ // Payload for creating a new database.message DatabaseCreate {// The project owning the database.// Format: projects/{project}@@ -440,20 +473,27 @@ message Task {string table = 3;// Format: projects/{project}/sheets/{sheet}string sheet = 4;+ // The character set for the database.string character_set = 5;+ // The collation for the database.string collation = 6;+ // The environment the database belongs to.string environment = 7;}+ // Payload for updating a database schema.message DatabaseUpdate {// Format: projects/{project}/sheets/{sheet}string sheet = 1;+ // The target schema version after this update.string schema_version = 2;+ // The type of database change (MIGRATE or SDL).DatabaseChangeType database_change_type = 3;// migration_type is only set when database_change_type is MIGRATE.MigrationType migration_type = 4;}+ // Payload for exporting database data.message DatabaseDataExport {// The resource name of the target.// Format: instances/{instance-id}/databases/{database-name}@@ -463,7 +503,7 @@ message Task {string sheet = 2;// The format of the exported file.ExportFormat format = 3;- // The zip password provide by users.+ // The zip password provided by users.// Leave it empty if no needs to encrypt the zip file.optional string password = 4;}@@ -480,44 +520,63 @@ message TaskRun {// Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{taskRun}string name = 1;- // Format: user/[email protected]+ // Format: users/[email protected]string creator = 3;google.protobuf.Timestamp create_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];enum Status {+ // Unspecified status.STATUS_UNSPECIFIED = 0;+ // Task run is queued and waiting to start execution.PENDING = 1;+ // Task run is currently executing.RUNNING = 2;+ // Task run completed successfully.DONE = 3;+ // Task run execution failed with errors.FAILED = 4;+ // Task run execution was canceled by a user.CANCELED = 5;}+ // The current execution status of the task run.Status status = 8;// Below are the results of a task run.+ // Detailed information about the task run result.string detail = 9;// The resource name of the changelog.// Format: instances/{instance}/databases/{database}/changelogs/{changelog}string changelog = 20 [(google.api.field_behavior) = OUTPUT_ONLY];+ // The schema version after this task run completes.string schema_version = 11;+ // The time when the task run started execution.google.protobuf.Timestamp start_time = 14 [(google.api.field_behavior) = OUTPUT_ONLY];enum ExportArchiveStatus {+ // Unspecified export archive status.EXPORT_ARCHIVE_STATUS_UNSPECIFIED = 0;+ // Export archive is ready for download.READY = 1;+ // Export archive has been downloaded by the user.EXPORTED = 2;}+ // The export archive status for data export tasks.ExportArchiveStatus export_archive_status = 16;+ // Prior backup detail for rollback purposes.message PriorBackupDetail {+ // A single backup table mapping.message Item {+ // Table information.message Table {// The database information.// Format: instances/{instance}/databases/{database}string database = 1;+ // The schema name.string schema = 2;+ // The table name.string table = 3;}@@ -525,24 +584,35 @@ message TaskRun {Table source_table = 1;// The target backup table information.Table target_table = 2;+ // The start position in the SQL statement.Position start_position = 3;+ // The end position in the SQL statement.Position end_position = 4;}+ // The list of backed up tables.repeated Item items = 1;}// The prior backup detail that will be used to rollback the task run.PriorBackupDetail prior_backup_detail = 17;+ // Information about task run scheduling.message SchedulerInfo {+ // The time when the scheduling info was reported.google.protobuf.Timestamp report_time = 1;+ // Information about why a task run is waiting.message WaitingCause {+ // The reason the task run is waiting.oneof cause {+ // Waiting due to connection limit reached.bool connection_limit = 1;+ // Waiting for another task to complete.Task task = 2;+ // Waiting due to parallel tasks limit.bool parallel_tasks_limit = 3;}+ // Information about a blocking task.message Task {// Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}string task = 1;@@ -550,8 +620,10 @@ message TaskRun {string issue = 2;}}+ // The cause for the task run waiting.WaitingCause waiting_cause = 2;}+ // Scheduling information about the task run.SchedulerInfo scheduler_info = 18 [(google.api.field_behavior) = OUTPUT_ONLY];// Format: projects/{project}/sheets/{sheet}@@ -571,40 +643,68 @@ message TaskRunLog {// Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/logstring name = 1;+ // The log entries for this task run.repeated TaskRunLogEntry entries = 2;}message TaskRunLogEntry {+ // The type of log entry.enum Type {+ // Unspecified type.TYPE_UNSPECIFIED = 0;+ // Schema dump operation.SCHEMA_DUMP = 1;+ // Command execution.COMMAND_EXECUTE = 2;+ // Database synchronization.DATABASE_SYNC = 3;+ // Task run status update.TASK_RUN_STATUS_UPDATE = 4;+ // Transaction control (BEGIN, COMMIT, ROLLBACK).TRANSACTION_CONTROL = 5;+ // Prior backup operation.PRIOR_BACKUP = 6;+ // Retry information.RETRY_INFO = 7;+ // Schema diff computation.COMPUTE_DIFF = 8;}+ // The type of this log entry.Type type = 1;+ // The time when the log was recorded.google.protobuf.Timestamp log_time = 6;+ // The deployment ID for this log entry.string deploy_id = 12;+ // Schema dump details (if type is SCHEMA_DUMP).SchemaDump schema_dump = 2;+ // Command execution details (if type is COMMAND_EXECUTE).CommandExecute command_execute = 3;+ // Database sync details (if type is DATABASE_SYNC).DatabaseSync database_sync = 4;+ // Task run status update details (if type is TASK_RUN_STATUS_UPDATE).TaskRunStatusUpdate task_run_status_update = 5;+ // Transaction control details (if type is TRANSACTION_CONTROL).TransactionControl transaction_control = 7;+ // Prior backup details (if type is PRIOR_BACKUP).PriorBackup prior_backup = 8;+ // Retry information details (if type is RETRY_INFO).RetryInfo retry_info = 9;+ // Compute diff details (if type is COMPUTE_DIFF).ComputeDiff compute_diff = 10;+ // Schema dump operation details.message SchemaDump {+ // When the schema dump started.google.protobuf.Timestamp start_time = 1;+ // When the schema dump ended.google.protobuf.Timestamp end_time = 2;+ // Error message if the schema dump failed.string error = 3;}+ // Command execution details.message CommandExecute {+ // When the command was logged.google.protobuf.Timestamp log_time = 1;// Either `command_indexes` or `statement` is set.// The indexes of the executed commands.@@ -612,10 +712,15 @@ message TaskRunLogEntry {// The executed statement.string statement = 4;+ // The response from executing the command.CommandResponse response = 3;+ // Command execution response.message CommandResponse {+ // When the response was logged.google.protobuf.Timestamp log_time = 1;+ // Error message if command execution failed.string error = 2;+ // Total affected rows.int64 affected_rows = 3;// `all_affected_rows` is the affected rows of each command.// `all_affected_rows` may be unavailable if the database driver doesn't support it. Caller should fallback to `affected_rows` in that case.@@ -623,15 +728,23 @@ message TaskRunLogEntry {}}+ // Database synchronization details.message DatabaseSync {+ // When the database sync started.google.protobuf.Timestamp start_time = 1;+ // When the database sync ended.google.protobuf.Timestamp end_time = 2;+ // Error message if sync failed.string error = 3;}+ // Task run status update details.message TaskRunStatusUpdate {+ // The new status.Status status = 1;+ // Internal status for task run execution.enum Status {+ // Unspecified status.STATUS_UNSPECIFIED = 0;// the task run is ready to be executed by the schedulerRUNNING_WAITING = 1;@@ -640,33 +753,54 @@ message TaskRunLogEntry {}}+ // Transaction control operation details.message TransactionControl {+ // Transaction control type.enum Type {+ // Unspecified type.TYPE_UNSPECIFIED = 0;+ // Begin transaction.BEGIN = 1;+ // Commit transaction.COMMIT = 2;+ // Rollback transaction.ROLLBACK = 3;}+ // The type of transaction control.Type type = 1;+ // Error message if the operation failed.string error = 2;}+ // Prior backup operation details.message PriorBackup {+ // When the backup started.google.protobuf.Timestamp start_time = 1;+ // When the backup ended.google.protobuf.Timestamp end_time = 2;+ // The backup details.TaskRun.PriorBackupDetail prior_backup_detail = 3;+ // Error message if the backup failed.string error = 4;}+ // Retry information for failed operations.message RetryInfo {+ // The error that triggered the retry.string error = 1;+ // Current retry attempt number.int32 retry_count = 2;+ // Maximum number of retries allowed.int32 maximum_retries = 3;}+ // Schema diff computation details.message ComputeDiff {+ // When diff computation started.google.protobuf.Timestamp start_time = 1;+ // When diff computation ended.google.protobuf.Timestamp end_time = 2;+ // Error message if computation failed.string error = 3;}}@@ -688,10 +822,13 @@ message TaskRunSession {// Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/sessionstring name = 1;+ // Database-specific session information.oneof session {+ // PostgreSQL session information.Postgres postgres = 2;}+ // PostgreSQL session information.message Postgres {// `session` is the session of the task run executing commands.Session session = 1;@@ -700,21 +837,35 @@ message TaskRunSession {// `blocked_sessions` are blocked by `session`.repeated Session blocked_sessions = 3;- // Read from `pg_stat_activity`+ // PostgreSQL session information read from `pg_stat_activity`.message Session {+ // Process ID of the session.string pid = 1;+ // PIDs of sessions blocking this session.repeated string blocked_by_pids = 2;+ // Current query being executed.string query = 3;+ // Session state (active, idle, etc.).optional string state = 4;+ // Wait event type if session is waiting.optional string wait_event_type = 5;+ // Specific wait event if session is waiting.optional string wait_event = 6;+ // Database name.optional string datname = 7;+ // User name.optional string usename = 8;+ // Application name.string application_name = 9;+ // Client IP address.optional string client_addr = 10;+ // Client port number.optional string client_port = 11;+ // When the backend process started.google.protobuf.Timestamp backend_start = 12;+ // When the current transaction started.optional google.protobuf.Timestamp xact_start = 13;+ // When the current query started.optional google.protobuf.Timestamp query_start = 14;}}@@ -729,5 +880,6 @@ message PreviewTaskRunRollbackRequest {}message PreviewTaskRunRollbackResponse {+ // The rollback SQL statement that would undo the task run.string statement = 1;}diff --git a/proto/v1/v1/setting_service.proto b/proto/v1/v1/setting_service.protoindex 2edddd55ea..d2d058a465 100644--- a/proto/v1/v1/setting_service.proto+++ b/proto/v1/v1/setting_service.proto@@ -17,7 +17,9 @@ import "v1/issue_service.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// SettingService manages workspace-level settings and configurations.service SettingService {+ // Lists all workspace settings.// Permissions required: bb.settings.listrpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse) {option (google.api.http) = {get: "/v1/settings"};@@ -26,6 +28,7 @@ service SettingService {option (bytebase.v1.auth_method) = IAM;}+ // Retrieves a workspace setting by name.// Permissions required: bb.settings.getrpc GetSetting(GetSettingRequest) returns (Setting) {option (google.api.http) = {get: "/v1/{name=settings/*}"};@@ -34,6 +37,7 @@ service SettingService {option (bytebase.v1.auth_method) = IAM;}+ // Updates a workspace setting.// Permissions required: bb.settings.setrpc UpdateSetting(UpdateSettingRequest) returns (Setting) {option (google.api.http) = {@@ -47,14 +51,14 @@ service SettingService {}message ListSettingsRequest {- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// The maximum number of settings to return. The service may return fewer than// this value.// If unspecified, at most 10 settings will be returned.// The maximum value is 1000; values above 1000 will be coerced to 1000.int32 page_size = 1;- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// A page token, received from a previous `ListSettings` call.// Provide this to retrieve the subsequent page.//@@ -135,7 +139,7 @@ message Setting {// For example, "settings/bb.branding.logo"string name = 1;- // The value of the setting.+ // The configuration value of the setting.Value value = 2;}@@ -240,10 +244,10 @@ message Announcement {CRITICAL = 3;}- // The alert level of announcemnt+ // The alert level of announcementAlertLevel level = 1;- // The text of announcemnt+ // The text of announcementstring text = 2;// The optional link, user can follow the link to check extra detailsdiff --git a/proto/v1/v1/sheet_service.proto b/proto/v1/v1/sheet_service.protoindex 8a0df6c12b..80d2a47946 100644--- a/proto/v1/v1/sheet_service.proto+++ b/proto/v1/v1/sheet_service.proto@@ -13,7 +13,9 @@ import "v1/common.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// SheetService manages SQL scripts and saved queries.service SheetService {+ // Creates a new SQL sheet.// Permissions required: bb.sheets.createrpc CreateSheet(CreateSheetRequest) returns (Sheet) {option (google.api.http) = {@@ -25,6 +27,7 @@ service SheetService {option (bytebase.v1.auth_method) = IAM;}+ // Creates multiple SQL sheets in a single operation.// Permissions required: bb.sheets.createrpc BatchCreateSheets(BatchCreateSheetsRequest) returns (BatchCreateSheetsResponse) {option (google.api.http) = {@@ -35,6 +38,7 @@ service SheetService {option (bytebase.v1.auth_method) = IAM;}+ // Retrieves a SQL sheet by name.// Permissions required: bb.sheets.getrpc GetSheet(GetSheetRequest) returns (Sheet) {option (google.api.http) = {get: "/v1/{name=projects/*/sheets/*}"};@@ -43,6 +47,7 @@ service SheetService {option (bytebase.v1.auth_method) = IAM;}+ // Updates a SQL sheet's title or content.// Permissions required: bb.sheets.updaterpc UpdateSheet(UpdateSheetRequest) returns (Sheet) {option (google.api.http) = {@@ -120,9 +125,9 @@ message Sheet {pattern: "projects/{project}/sheets/{sheet}"};- // The name of the sheet resource, generated by the server.- // Canonical parent is project.+ // The name of the sheet resource.// Format: projects/{project}/sheets/{sheet}+ // The sheet ID is generated by the server on creation and cannot be changed.string name = 1 [(google.api.field_behavior) = REQUIRED,(google.api.field_behavior) = IMMUTABLE@@ -146,6 +151,7 @@ message Sheet {// content_size is the full size of the content, may not match the size of the `content` field.int64 content_size = 8 [(google.api.field_behavior) = OUTPUT_ONLY];+ // Additional metadata and configuration for the sheet.SheetPayload payload = 13;// The SQL dialect.diff --git a/proto/v1/v1/sql_service.proto b/proto/v1/v1/sql_service.protoindex ef7619bd54..c6c08e6050 100644--- a/proto/v1/v1/sql_service.proto+++ b/proto/v1/v1/sql_service.proto@@ -15,7 +15,9 @@ import "v1/database_service.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// SQLService executes SQL queries and manages query operations.service SQLService {+ // Executes a read-only SQL query against a database.// Permissions required: bb.databases.getrpc Query(QueryRequest) returns (QueryResponse) {option (google.api.http) = {@@ -27,6 +29,7 @@ service SQLService {option (bytebase.v1.audit) = true;}+ // Executes SQL with admin privileges via streaming connection.// Permissions required: bb.sql.adminrpc AdminExecute(stream AdminExecuteRequest) returns (stream AdminExecuteResponse) {// GRPC streaming / websocket requires GET method instead of POST.@@ -37,7 +40,7 @@ service SQLService {}// SearchQueryHistories searches query histories for the caller.- // Permissions required: None+ // Permissions required: None (only returns caller's own query histories)rpc SearchQueryHistories(SearchQueryHistoriesRequest) returns (SearchQueryHistoriesResponse) {option (google.api.http) = {post: "/v1/queryHistories:search"@@ -46,6 +49,7 @@ service SQLService {option (bytebase.v1.auth_method) = CUSTOM;}+ // Exports query results to a file format.// Permissions required: bb.databases.getrpc Export(ExportRequest) returns (ExportResponse) {option (google.api.http) = {@@ -66,6 +70,7 @@ service SQLService {option (bytebase.v1.audit) = true;}+ // Validates SQL statements against review rules.// Permissions required: bb.databases.checkrpc Check(CheckRequest) returns (CheckResponse) {option (google.api.http) = {@@ -76,6 +81,7 @@ service SQLService {option (bytebase.v1.auth_method) = IAM;}+ // Formats and normalizes SQL schema definitions.// Permissions required: Nonerpc Pretty(PrettyRequest) returns (PrettyResponse) {option (google.api.http) = {@@ -85,6 +91,7 @@ service SQLService {option (bytebase.v1.allow_without_credential) = true;}+ // Computes schema differences between two database metadata.// Permissions required: Nonerpc DiffMetadata(DiffMetadataRequest) returns (DiffMetadataResponse) {option (google.api.http) = {@@ -95,7 +102,8 @@ service SQLService {// This is a util method requiring no authentication thus no authorization.}- // Permissions required: None+ // Provides AI-powered SQL completion and generation.+ // Permissions required: None (authenticated users only, requires AI to be enabled)rpc AICompletion(AICompletionRequest) returns (AICompletionResponse) {option (google.api.http) = {post: "/v1/sql/aiCompletion"@@ -182,7 +190,9 @@ message QueryOption {enum RedisRunCommandsOn {// UNSPECIFIED defaults to SINGLE_NODE.REDIS_RUN_COMMANDS_ON_UNSPECIFIED = 0;+ // Execute Redis commands on a single node in the cluster.SINGLE_NODE = 1;+ // Execute Redis commands on all nodes in the cluster for cluster-wide operations.ALL_NODES = 2;}RedisRunCommandsOn redis_run_commands_on = 1;@@ -241,13 +251,19 @@ message QueryResult {message Message {enum Level {- // Unspecified.+ // Unspecified message level.LEVEL_UNSPECIFIED = 0;+ // Informational message.INFO = 1;+ // Warning message indicating potential issues.WARNING = 2;+ // Debug message for development and troubleshooting.DEBUG = 3;+ // General log message.LOG = 4;+ // Notice message for important information.NOTICE = 5;+ // Exception message indicating error conditions.EXCEPTION = 6;}@@ -502,7 +518,7 @@ message SearchQueryHistoriesRequest {// - database: the database full name in "instances/{id}/databases/{name}" format, support "==" operator.// - instance: the instance full name in "instances/{id}" format, support "==" operator.// - type: the type, should be "QUERY" or "EXPORT", support "==" operator.- // - statement: the SQL statemnt, support ".matches()" operator.+ // - statement: the SQL statement, support ".matches()" operator.//// For example:// project == "projects/{project}"@@ -545,8 +561,11 @@ message QueryHistory {google.protobuf.Duration duration = 7 [(google.api.field_behavior) = OUTPUT_ONLY];enum Type {+ // Unspecified query history type.TYPE_UNSPECIFIED = 0;+ // Query execution for data retrieval.QUERY = 1;+ // Data export operation to file.EXPORT = 2;}diff --git a/proto/v1/v1/subscription_service.proto b/proto/v1/v1/subscription_service.protoindex 8afbc319e7..31ee5860f4 100644--- a/proto/v1/v1/subscription_service.proto+++ b/proto/v1/v1/subscription_service.proto@@ -10,6 +10,7 @@ import "v1/annotation.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// SubscriptionService manages enterprise subscriptions and licensing.service SubscriptionService {// GetSubscription returns the current subscription.// If there is no license, we will return a free plan subscription without expiration time.@@ -21,6 +22,7 @@ service SubscriptionService {option (bytebase.v1.allow_without_credential) = true;}+ // Updates the enterprise license subscription.// Permissions required: bb.settings.setrpc UpdateSubscription(UpdateSubscriptionRequest) returns (Subscription) {option (google.api.http) = {@@ -44,12 +46,16 @@ message UpdateSubscriptionRequest {}enum PlanType {+ // Unspecified plan type.PLAN_TYPE_UNSPECIFIED = 0;+ // Free plan with basic features and no cost.FREE = 1;+ // Team plan with collaboration features for small to medium teams.TEAM = 2;+ // Enterprise plan with advanced features and dedicated support.ENTERPRISE = 3;}diff --git a/proto/v1/v1/user_service.proto b/proto/v1/v1/user_service.protoindex 8b26afca10..9b471bcdac 100644--- a/proto/v1/v1/user_service.proto+++ b/proto/v1/v1/user_service.proto@@ -14,6 +14,7 @@ import "v1/common.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// UserService manages user accounts and authentication.service UserService {// Get the user.// Any authenticated user can get the user.@@ -52,10 +53,8 @@ service UserService {option (bytebase.v1.auth_method) = IAM;}- // Create a user.- // When Disallow Signup is enabled, only the caller with bb.users.create on the workspace can create a user.- // Otherwise, any unauthenticated user can create a user.- // Permissions required: bb.users.create+ // Creates a user. When Disallow Signup is enabled, requires bb.users.create permission; otherwise any user can sign up.+ // Permissions required: bb.users.create (only when Disallow Signup is enabled)rpc CreateUser(CreateUserRequest) returns (User) {option (google.api.http) = {post: "/v1/users"@@ -67,8 +66,8 @@ service UserService {option (bytebase.v1.audit) = true;}- // Only the user itself and the user with bb.users.update permission on the workspace can update the user.- // Permissions required: bb.users.update+ // Updates a user. Users can update their own profile, or users with bb.users.update permission can update any user.+ // Permissions required: bb.users.update (or self)rpc UpdateUser(UpdateUserRequest) returns (User) {option (google.api.http) = {patch: "/v1/{user.name=users/*}"@@ -79,8 +78,7 @@ service UserService {option (bytebase.v1.audit) = true;}- // Only the user with bb.users.delete permission on the workspace can delete the user.- // The last remaining workspace admin cannot be deleted.+ // Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted.// Permissions required: bb.users.deleterpc DeleteUser(DeleteUserRequest) returns (google.protobuf.Empty) {option (google.api.http) = {delete: "/v1/{name=users/*}"};@@ -89,7 +87,7 @@ service UserService {option (bytebase.v1.audit) = true;}- // Only the user with bb.users.undelete permission on the workspace can undelete the user.+ // Restores a deleted user.// Permissions required: bb.users.undeleterpc UndeleteUser(UndeleteUserRequest) returns (User) {option (google.api.http) = {@@ -234,16 +232,22 @@ message User {// Format: users/{user}. {user} is a system-generated unique ID.string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];+ // The lifecycle state of the user account.State state = 2;+ // The email address of the user, used for login and notifications.string email = 3;+ // The display title or full name of the user.string title = 4;+ // The type of user account.UserType user_type = 5;+ // The password for authentication. Only used during user creation or password updates.string password = 7 [(google.api.field_behavior) = INPUT_ONLY];+ // The service key for service account authentication. Only used for service accounts.string service_key = 8 [(google.api.field_behavior) = INPUT_ONLY];// The mfa_enabled flag means if the user has enabled MFA.@@ -260,12 +264,15 @@ message User {string phone = 12;message Profile {+ // The last time the user successfully logged in.google.protobuf.Timestamp last_login_time = 1;+ // The last time the user changed their password.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.string source = 3;}+ // User profile metadata.Profile profile = 13;// The groups for the user.@@ -274,8 +281,12 @@ message User {}enum UserType {+ // Unspecified user type.USER_TYPE_UNSPECIFIED = 0;+ // Regular human user account.USER = 1;+ // System-managed bot account for automated operations.SYSTEM_BOT = 2;+ // Service account for API integrations.SERVICE_ACCOUNT = 3;}diff --git a/proto/v1/v1/worksheet_service.proto b/proto/v1/v1/worksheet_service.protoindex a794d0477b..e9144af627 100644--- a/proto/v1/v1/worksheet_service.proto+++ b/proto/v1/v1/worksheet_service.proto@@ -12,9 +12,10 @@ import "v1/annotation.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// WorksheetService manages SQL worksheets for query development.service WorksheetService {- // Create a personal worksheet used in SQL Editor.- // Permissions required: None+ // Creates a personal worksheet used in SQL Editor. Any authenticated user can create their own worksheets.+ // Permissions required: None (authenticated users only)rpc CreateWorksheet(CreateWorksheetRequest) returns (Worksheet) {option (google.api.http) = {post: "/v1/worksheets"@@ -29,7 +30,7 @@ service WorksheetService {// - they are the creator of the worksheet;// - they have bb.worksheets.get permission on the workspace;// - the sheet is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.- // Permissions required: None+ // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)rpc GetWorksheet(GetWorksheetRequest) returns (Worksheet) {option (google.api.http) = {get: "/v1/{name=worksheets/*}"};option (google.api.method_signature) = "name";@@ -39,7 +40,7 @@ service WorksheetService {// Search for worksheets.// This is used for finding my worksheets or worksheets shared by other people.// The sheet accessibility is the same as GetWorksheet().- // Permissions required: None+ // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)rpc SearchWorksheets(SearchWorksheetsRequest) returns (SearchWorksheetsResponse) {option (google.api.http) = {post: "/v1/worksheets:search"@@ -53,7 +54,7 @@ service WorksheetService {// - they are the creator of the worksheet;// - they have bb.worksheets.manage permission on the workspace;// - the sheet is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.- // Permissions required: None+ // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)rpc UpdateWorksheet(UpdateWorksheetRequest) returns (Worksheet) {option (google.api.http) = {patch: "/v1/{worksheet.name=worksheets/*}"@@ -65,7 +66,7 @@ service WorksheetService {// Update the organizer of a worksheet.// The access is the same as UpdateWorksheet method.- // Permissions required: None+ // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)rpc UpdateWorksheetOrganizer(UpdateWorksheetOrganizerRequest) returns (WorksheetOrganizer) {option (google.api.http) = {patch: "/v1/{organizer.worksheet=worksheets/*}/organizer"@@ -77,7 +78,7 @@ service WorksheetService {// Delete a worksheet.// The access is the same as UpdateWorksheet method.- // Permissions required: None+ // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)rpc DeleteWorksheet(DeleteWorksheetRequest) returns (google.protobuf.Empty) {option (google.api.http) = {delete: "/v1/{name=worksheets/*}"};option (google.api.method_signature) = "name";@@ -165,14 +166,14 @@ message SearchWorksheetsRequest {// visibility == "PRIVATE"string filter = 1;- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// The maximum number of worksheets to return. The service may return fewer than// this value.// If unspecified, at most 10 worksheets will be returned.// The maximum value is 1000; values above 1000 will be coerced to 1000.int32 page_size = 2;- // Not used.+ // Pagination is not currently implemented. This field is reserved for future use.// A page token, received from a previous `SearchWorksheets` call.// Provide this to retrieve the subsequent page.//@@ -185,7 +186,8 @@ message SearchWorksheetsResponse {// The worksheets that matched the search criteria.repeated Worksheet worksheets = 1;- // Not used. A token, which can be sent as `page_token` to retrieve the next page.+ // Pagination is not currently implemented. This field is reserved for future use.+ // A token, which can be sent as `page_token` to retrieve the next page.// If this field is omitted, there are no subsequent pages.string next_page_token = 2;}diff --git a/proto/v1/v1/workspace_service.proto b/proto/v1/v1/workspace_service.protoindex 0e8ba9e64e..3d5e991b0f 100644--- a/proto/v1/v1/workspace_service.proto+++ b/proto/v1/v1/workspace_service.proto@@ -8,7 +8,9 @@ import "v1/iam_policy.proto";option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";+// WorkspaceService manages workspace-level operations and profile.service WorkspaceService {+ // Retrieves IAM policy for the workspace.// Permissions required: bb.workspaces.getIamPolicyrpc GetIamPolicy(GetIamPolicyRequest) returns (IamPolicy) {option (google.api.http) = {get: "/v1/{resource=workspaces/*}:getIamPolicy"};@@ -16,6 +18,7 @@ service WorkspaceService {option (bytebase.v1.auth_method) = IAM;}+ // Sets IAM policy for the workspace.// Permissions required: bb.workspaces.setIamPolicyrpc SetIamPolicy(SetIamPolicyRequest) returns (IamPolicy) {option (google.api.http) = {