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(instance): support file path TLS material (#20062)
p0nyae310c251a2d
diff --git a/backend/api/mcp/gen/openapi.yaml b/backend/api/mcp/gen/openapi.yamlindex 3569bcf37c..dcb1958b70 100644--- a/backend/api/mcp/gen/openapi.yaml+++ b/backend/api/mcp/gen/openapi.yaml@@ -9831,6 +9831,42 @@ components:type: stringtitle: ssl_keydescription: The SSL client private key.+ sslCaPath:+ type: string+ title: ssl_ca_path+ description: The local filesystem path to the SSL certificate authority certificate.+ sslCertPath:+ type: string+ title: ssl_cert_path+ description: The local filesystem path to the SSL client certificate.+ sslKeyPath:+ type: string+ title: ssl_key_path+ description: The local filesystem path to the SSL client private key.+ sslCaSet:+ type: boolean+ title: ssl_ca_set+ description: Whether an SSL certificate authority certificate has been configured.+ sslCertSet:+ type: boolean+ title: ssl_cert_set+ description: Whether an SSL client certificate has been configured.+ sslKeySet:+ type: boolean+ title: ssl_key_set+ description: Whether an SSL client private key has been configured.+ sslCaPathSet:+ type: boolean+ title: ssl_ca_path_set+ description: Whether an SSL certificate authority path has been configured.+ sslCertPathSet:+ type: boolean+ title: ssl_cert_path_set+ description: Whether an SSL client certificate path has been configured.+ sslKeyPathSet:+ type: boolean+ title: ssl_key_path_set+ description: Whether an SSL client private key path has been configured.verifyTlsCertificate:type: booleantitle: verify_tls_certificatediff --git a/backend/api/v1/audit.go b/backend/api/v1/audit.goindex 8f019903ed..34de053e14 100644--- a/backend/api/v1/audit.go+++ b/backend/api/v1/audit.go@@ -662,12 +662,21 @@ func redactDataSource(d *v1pb.DataSource) *v1pb.DataSource {if cloned.SslCa != "" {cloned.SslCa = maskedString}+ if cloned.SslCaPath != "" {+ cloned.SslCaPath = maskedString+ }if cloned.SslCert != "" {cloned.SslCert = maskedString}+ if cloned.SslCertPath != "" {+ cloned.SslCertPath = maskedString+ }if cloned.SslKey != "" {cloned.SslKey = maskedString}+ if cloned.SslKeyPath != "" {+ cloned.SslKeyPath = maskedString+ }if cloned.SshPassword != "" {cloned.SshPassword = maskedString}diff --git a/backend/api/v1/instance_service.go b/backend/api/v1/instance_service.goindex 808a723521..46cb567edc 100644--- a/backend/api/v1/instance_service.go+++ b/backend/api/v1/instance_service.go@@ -2,7 +2,14 @@ package v1import ("context"+ "crypto/ecdsa"+ "crypto/ed25519"+ "crypto/rsa"+ "crypto/tls"+ "crypto/x509"+ "encoding/pem""log/slog"+ "path/filepath""strings""connectrpc.com/connect"@@ -170,6 +177,11 @@ func (s *InstanceService) CreateInstance(ctx context.Context, req *connect.Reque// connection below, before the instance is persisted.workspaceID := common.GetWorkspaceIDFromContext(ctx)instanceMessage.Workspace = workspaceID+ for _, ds := range instanceMessage.Metadata.GetDataSources() {+ if err := validateAndSanitizeDataSourceTLS(ds); err != nil {+ return nil, connect.NewError(connect.CodeInvalidArgument, err)+ }+ }if err := s.checkInstanceDataSources(ctx, instanceMessage, instanceMessage.Metadata.GetDataSources()); err != nil {return nil, err}@@ -252,6 +264,132 @@ func (s *InstanceService) checkInstanceDataSources(ctx context.Context, instancereturn nil}+func validateAndSanitizeDataSourceTLS(ds *storepb.DataSource) error {+ if !ds.GetUseSsl() {+ ds.SslCa = ""+ ds.SslCert = ""+ ds.SslKey = ""+ ds.SslCaPath = ""+ ds.SslCertPath = ""+ ds.SslKeyPath = ""+ return nil+ }+ for _, conflict := range []struct {+ inlineField string+ pathField string+ inlineValue string+ pathValue string+ }{+ {"ssl_ca", "ssl_ca_path", ds.GetSslCa(), ds.GetSslCaPath()},+ {"ssl_cert", "ssl_cert_path", ds.GetSslCert(), ds.GetSslCertPath()},+ {"ssl_key", "ssl_key_path", ds.GetSslKey(), ds.GetSslKeyPath()},+ } {+ if conflict.inlineValue != "" && conflict.pathValue != "" {+ return errors.Errorf("cannot set both %s and %s; clear one of them by including the field in the update_mask with an empty value when switching TLS material source", conflict.inlineField, conflict.pathField)+ }+ }+ for _, pathField := range []struct {+ field string+ path string+ }{+ {"ssl_ca_path", ds.GetSslCaPath()},+ {"ssl_cert_path", ds.GetSslCertPath()},+ {"ssl_key_path", ds.GetSslKeyPath()},+ } {+ if pathField.path != "" && !filepath.IsAbs(pathField.path) {+ return errors.Errorf("%s must be an absolute path", pathField.field)+ }+ }+ if ds.GetSslCa() != "" {+ if err := validateInlineCAPEM([]byte(ds.GetSslCa())); err != nil {+ return errors.Wrap(err, "invalid ssl_ca PEM")+ }+ }+ certSet := ds.GetSslCert() != "" || ds.GetSslCertPath() != ""+ keySet := ds.GetSslKey() != "" || ds.GetSslKeyPath() != ""+ if certSet != keySet {+ return errors.New("ssl_cert and ssl_key must be both set or unset")+ }+ if ds.GetSslCert() != "" && ds.GetSslKey() != "" {+ if _, err := tls.X509KeyPair([]byte(ds.GetSslCert()), []byte(ds.GetSslKey())); err != nil {+ return errors.Wrap(err, "invalid ssl_cert or ssl_key PEM")+ }+ }+ if ds.GetSslCert() != "" && ds.GetSslKey() == "" {+ if err := validateInlineCertPEM([]byte(ds.GetSslCert())); err != nil {+ return errors.Wrap(err, "invalid ssl_cert PEM")+ }+ }+ if ds.GetSslKey() != "" && ds.GetSslCert() == "" {+ if err := validateInlineKeyPEM([]byte(ds.GetSslKey())); err != nil {+ return errors.Wrap(err, "invalid ssl_key PEM")+ }+ }+ return nil+}++func validateInlineCAPEM(data []byte) error {+ pool := x509.NewCertPool()+ if ok := pool.AppendCertsFromPEM(data); !ok {+ return errors.New("no valid CERTIFICATE PEM block found")+ }+ return nil+}++func validateInlineCertPEM(data []byte) error {+ var certs [][]byte+ for {+ var block *pem.Block+ block, data = pem.Decode(data)+ if block == nil {+ break+ }+ if block.Type == "CERTIFICATE" {+ certs = append(certs, block.Bytes)+ }+ }+ if len(certs) == 0 {+ return errors.New("no CERTIFICATE PEM block found")+ }+ if _, err := x509.ParseCertificate(certs[0]); err != nil {+ return err+ }+ return nil+}++func validateInlineKeyPEM(data []byte) error {+ var block *pem.Block+ for {+ block, data = pem.Decode(data)+ if block == nil {+ return errors.New("no PRIVATE KEY PEM block found")+ }+ if block.Type == "PRIVATE KEY" || strings.HasSuffix(block.Type, " PRIVATE KEY") {+ break+ }+ }+ _, err := parseInlinePrivateKey(block.Bytes)+ return err+}++func parseInlinePrivateKey(der []byte) (any, error) {+ if key, err := x509.ParsePKCS1PrivateKey(der); err == nil {+ return key, nil+ }+ if key, err := x509.ParsePKCS8PrivateKey(der); err == nil {+ switch key := key.(type) {+ case *rsa.PrivateKey, *ecdsa.PrivateKey, ed25519.PrivateKey:+ return key, nil+ default:+ return nil, errors.Errorf("unsupported private key type %T", key)+ }+ }+ if key, err := x509.ParseECPrivateKey(der); err == nil {+ return key, nil+ }+ return nil, errors.New("failed to parse private key")+}+const instanceExceededError = "activation instance count has reached the limit (%v)"func (s *InstanceService) checkDataSource(ctx context.Context, instance *store.InstanceMessage, dataSource *storepb.DataSource) error {@@ -373,6 +511,11 @@ func (s *InstanceService) UpdateInstance(ctx context.Context, req *connect.Requeif err != nil {return nil, connect.NewError(connect.CodeInvalidArgument, err)}+ for _, ds := range dataSources {+ if err := validateAndSanitizeDataSourceTLS(ds); err != nil {+ return nil, connect.NewError(connect.CodeInvalidArgument, err)+ }+ }if err := s.checkInstanceDataSources(ctx, instance, dataSources); err != nil {return nil, err}@@ -634,6 +777,9 @@ func (s *InstanceService) AddDataSource(ctx context.Context, req *connect.Requesif err := s.checkDataSource(ctx, instance, dataSource); err != nil {return nil, err}+ if err := validateAndSanitizeDataSourceTLS(dataSource); err != nil {+ return nil, connect.NewError(connect.CodeInvalidArgument, err)+ }metadata := proto.CloneOf(instance.Metadata)metadata.DataSources = append(metadata.DataSources, dataSource)if err := s.checkInstanceDataSources(ctx, instance, metadata.GetDataSources()); err != nil {@@ -733,10 +879,16 @@ func (s *InstanceService) UpdateDataSource(ctx context.Context, req *connect.ReqdataSource.Password = req.Msg.DataSource.Passwordcase "ssl_ca":dataSource.SslCa = req.Msg.DataSource.SslCa+ case "ssl_ca_path":+ dataSource.SslCaPath = req.Msg.DataSource.SslCaPathcase "ssl_cert":dataSource.SslCert = req.Msg.DataSource.SslCert+ case "ssl_cert_path":+ dataSource.SslCertPath = req.Msg.DataSource.SslCertPathcase "ssl_key":dataSource.SslKey = req.Msg.DataSource.SslKey+ case "ssl_key_path":+ dataSource.SslKeyPath = req.Msg.DataSource.SslKeyPathcase "host":dataSource.Host = req.Msg.DataSource.Hostcase "port":@@ -848,6 +1000,9 @@ func (s *InstanceService) UpdateDataSource(ctx context.Context, req *connect.Req}clearDataSourceAuthentication(dataSource)+ if err := validateAndSanitizeDataSourceTLS(dataSource); err != nil {+ return nil, connect.NewError(connect.CodeInvalidArgument, err)+ }if err := s.checkInstanceDataSources(ctx, instance, metadata.GetDataSources()); err != nil {return nil, errdiff --git a/backend/api/v1/instance_service_converter.go b/backend/api/v1/instance_service_converter.goindex bda5c044b3..c6640c53c0 100644--- a/backend/api/v1/instance_service_converter.go+++ b/backend/api/v1/instance_service_converter.go@@ -216,6 +216,12 @@ func convertDataSources(dataSources []*storepb.DataSource) []*v1pb.DataSource {MasterName: ds.GetMasterName(),MasterUsername: ds.GetMasterUsername(),ExtraConnectionParameters: ds.GetExtraConnectionParameters(),+ SslCaSet: ds.GetSslCa() != "",+ SslCertSet: ds.GetSslCert() != "",+ SslKeySet: ds.GetSslKey() != "",+ SslCaPathSet: ds.GetSslCaPath() != "",+ SslCertPathSet: ds.GetSslCertPath() != "",+ SslKeyPathSet: ds.GetSslKeyPath() != "",}switch dataSource.AuthenticationType {@@ -467,6 +473,9 @@ func convertV1DataSource(dataSource *v1pb.DataSource) (*storepb.DataSource, erroSslCa: dataSource.SslCa,SslCert: dataSource.SslCert,SslKey: dataSource.SslKey,+ SslCaPath: dataSource.SslCaPath,+ SslCertPath: dataSource.SslCertPath,+ SslKeyPath: dataSource.SslKeyPath,Host: dataSource.Host,Port: dataSource.Port,Database: dataSource.Database,diff --git a/backend/api/v1/instance_service_tls_test.go b/backend/api/v1/instance_service_tls_test.gonew file mode 100644index 0000000000..6c0e33920b--- /dev/null+++ b/backend/api/v1/instance_service_tls_test.go@@ -0,0 +1,231 @@+package v1++import (+ "crypto/ed25519"+ "crypto/rand"+ "crypto/x509"+ "encoding/pem"+ "testing"++ "github.com/stretchr/testify/require"++ storepb "github.com/bytebase/bytebase/backend/generated-go/store"+)++const validCAPEM = `-----BEGIN CERTIFICATE-----+MIIDOTCCAiGgAwIBAgIQSRJrEpBGFc7tNb1fb5pKFzANBgkqhkiG9w0BAQsFADAS+MRAwDgYDVQQKEwdBY21lIENvMCAXDTcwMDEwMTAwMDAwMFoYDzIwODQwMTI5MTYw+MDAwWjASMRAwDgYDVQQKEwdBY21lIENvMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A+MIIBCgKCAQEA6Gba5tHV1dAKouAaXO3/ebDUU4rvwCUg/CNaJ2PT5xLD4N1Vcb8r+bFSW2HXKq+MPfVdwIKR/1DczEoAGf/JWQTW7EgzlXrCd3rlajEX2D73faWJekD0U+aUgz5vtrTXZ90BQL7WvRICd7FlEZ6FPOcPlumiyNmzUqtwGhO+9ad1W5BqJaRI6P+YfouNkwR6Na4TzSj5BrqUfP0FwDizKSJ0XXmh8g8G9mtwxOSN3Ru1QFc61Xyeluk+POGKBV/q6RBNklTNe0gI8usUMlYyoC7ytppNMW7X2vodAelSu25jgx2anj9fDVZu+h7AXF5+4nJS4AAt0n1lNY7nGSsdZas8PbQIDAQABo4GIMIGFMA4GA1UdDwEB/wQE+AwICpDATBgNVHSUEDDAKBggrBgEFBQcDATAPBgNVHRMBAf8EBTADAQH/MB0GA1Ud+DgQWBBStsdjh3/JCXXYlQryOrL4Sh7BW5TAuBgNVHREEJzAlggtleGFtcGxlLmNv+bYcEfwAAAYcQAAAAAAAAAAAAAAAAAAAAATANBgkqhkiG9w0BAQsFAAOCAQEAxWGI+5NhpF3nwwy/4yB4i/CwwSpLrWUa70NyhvprUBC50PxiXav1TeDzwzLx/o5HyNwsv+cxv3HdkLW59i/0SlJSrNnWdfZ19oTcS+6PtLoVyISgtyN6DpkKpdG1cOkW3Cy2P2++tK/tKHRP1Y/Ra0RiDpOAmqn0gCOFGz8+lqDIor/T7MTpibL3IxqWfPrvfVRHL3B+grw/ZQTTIVjjh4JBSW3WyWgNo/ikC1lrVxzl4iPUGptxT36Cr7Zk2Bsg0XqwbOvK+5d+NTDREkSnUbie4GeutujmX3Dsx88UiV6UY/4lHJa6I5leHUNOHahRbpbWeOfs/+WkBKOclmOV2xlTVuPw==+-----END CERTIFICATE-----`++const validKeyPEM = `-----BEGIN RSA PRIVATE KEY-----+MIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQDoZtrm0dXV0Aqi+4Bpc7f95sNRTiu/AJSD8I1onY9PnEsPg3VVxvytsVJbYdcqr4w99V3AgpH/UNzMS+gAZ/8lZBNbsSDOVesJ3euVqMRfYPvd9pYl6QPRRpSDPm+2tNdn3QFAvta9EgJ3sW+URnoU85w+W6aLI2bNSq3AaE771p3VbkGolpEjo9h+i42TBHo1rhPNKPkGupR8/QX+AOLMpInRdeaHyDwb2a3DE5I3dG7VAVzrVfJ6W6Q84YoFX+rpEE2SVM17SAjy6xQy+VjKgLvK2mk0xbtfa+h0B6VK7bmODHZqeP18NVm6HsBcXn7iclLgAC3SfWU1jucZK+x1lqzw9tAgMBAAECggEABWzxS1Y2wckblnXY57Z+sl6YdmLV+gxj2r8Qib7g4ZIk+lIlWR1OJNfw7kU4eryib4fc6nOh6O4AWZyYqAK6tqNQSS/eVG0LQTLTTEldHyVJL+dvBe+MsUQOj4nTndZW+QvFzbcm2D8lY5n2nBSxU5ypVoKZ1EqQzytFcLZpTN7d89+EPj0qDyrV4NZlWAwL1AygCwnlwhMQjXEalVF1ylXwU3QzyZ/6MgvF6d3SSUlh+sq+XefuyigXw484cQQgbzopv6niMOmGP3of+yV4JQqUSb3IDmmT68XjGd2Dkxl4iPki+6ZwXf3CCi+c+i/zVEcufgZ3SLf8D99kUGE7v7fZ6AQKBgQD1ZX3RAla9hIhxCf+O+3D+I1j2LMrdjAh0ZKKqwMR4JnHX3mjQI6LwqIctPWTU8wYFECSh9klEclSdCa64s+uI/GNpcqPXejd0cAAdqHEEeG5sHMDt0oFSurL4lyud0GtZvwlzLuwEweuDtvT9cJ+Wfvl86uyO36IW8JdvUprYDctrQKBgQDycZ697qutBieZlGkHpnYWUAeImVA878sJ+w44NuXHvMxBPz+lbJGAg8Cn8fcxNAPqHIraK+kx3po8cZGQywKHUWsxi23ozHoxo++bGqeQb9U661TnfdDspIXia+xilZt3mm5BPzOUuRqlh4Y9SOBpSWRmEhyw76w4ZP+OPxjWYAgwQKBgA/FehSYxeJgRjSdo+MWnK66tjHgDJE8bYpUZsP0JC4R9DL5oiaA+brd2fI6Y+SbyeNBallObt8LSgzdtnEAbjIH8uDJqyOmknNePRvAvR6mP4xyuR+Bv+m+Lgp0DMWTw5J9CKpydZDItc49T/mJ5tPhdFVd+am0NAQnmr1MCZ6nHxAoGABS3Y+LkaC9FdFUUqSU8+Chkd/YbOkuyiENdkvl6t2e52jo5DVc1T7mLiIrRQi4SI8N9bN+/3oJWCT+uaSLX2ouCtNFunblzWHBrhxnZzTeqVq4SLc8aESAnbslKL4i8/+vYZlN+s8xtiNcSvL+lMsOBORSXzpj/4Ot8WwTkn1qyGgECgYBKNTypzAHeLE6yVadFp3nQ+Ckq9yzvP/ib05rvgbvrne00YeOxqJ9gtTrzgh7koqJyX1L4NwdkEza4ilDWpucn0+xiUZS4SoaJq6ZvcBYS62Yr1t8n09iG47YL8ibgtmH3L+svaotvpVxVK+d7BLevA/+ZboOWVe3icTy64BT3OQhmg==+-----END RSA PRIVATE KEY-----`++func TestValidateAndSanitizeDataSourceTLSRejectsSameSlotMixedMaterial(t *testing.T) {+ tests := []struct {+ name string+ ds *storepb.DataSource+ want string+ }{+ {+ name: "ca",+ ds: &storepb.DataSource{UseSsl: true, SslCa: "inline-ca", SslCaPath: "/tmp/ca.pem"},+ want: "cannot set both ssl_ca and ssl_ca_path",+ },+ {+ name: "cert",+ ds: &storepb.DataSource{UseSsl: true, SslCert: "inline-cert", SslCertPath: "/tmp/cert.pem"},+ want: "cannot set both ssl_cert and ssl_cert_path",+ },+ {+ name: "key",+ ds: &storepb.DataSource{UseSsl: true, SslKey: "inline-key", SslKeyPath: "/tmp/key.pem"},+ want: "cannot set both ssl_key and ssl_key_path",+ },+ }+ for _, tc := range tests {+ t.Run(tc.name, func(t *testing.T) {+ err := validateAndSanitizeDataSourceTLS(tc.ds)+ require.Error(t, err)+ require.Contains(t, err.Error(), tc.want)+ })+ }+}++func TestValidateAndSanitizeDataSourceTLSRejectsMergedSameSlotMixedMaterial(t *testing.T) {+ ds := &storepb.DataSource{UseSsl: true, SslCa: "inline-ca", SslCaPath: "/tmp/ca.pem"}++ err := validateAndSanitizeDataSourceTLS(ds)+ require.Error(t, err)+ require.Contains(t, err.Error(), "cannot set both ssl_ca and ssl_ca_path")+}++func TestValidateAndSanitizeDataSourceTLSAllowsCrossSlotMixedMaterial(t *testing.T) {+ err := validateAndSanitizeDataSourceTLS(&storepb.DataSource{UseSsl: true, SslCa: validCAPEM, SslCertPath: "/tmp/cert.pem", SslKeyPath: "/tmp/key.pem"})+ require.NoError(t, err)+}++func TestValidateAndSanitizeDataSourceTLSMatchesRuntimeCAPoolParsing(t *testing.T) {+ caBundle := validKeyPEM + "\n" + validCAPEM+ err := validateAndSanitizeDataSourceTLS(&storepb.DataSource{UseSsl: true, SslCa: caBundle})+ require.NoError(t, err)+}++func TestValidateAndSanitizeDataSourceTLSRejectsSourceSwitchWithoutClearingOldField(t *testing.T) {+ ds := &storepb.DataSource{UseSsl: true, SslCa: validCAPEM, SslCaPath: "/tmp/ca.pem"}++ err := validateAndSanitizeDataSourceTLS(ds)+ require.Error(t, err)+ require.Contains(t, err.Error(), `cannot set both ssl_ca and ssl_ca_path`)+ require.Contains(t, err.Error(), `clear one of them by including the field in the update_mask with an empty value`)+}++func TestValidateAndSanitizeDataSourceTLSAllowsSourceSwitchWithExplicitOldFieldClear(t *testing.T) {+ ds := &storepb.DataSource{UseSsl: true, SslCaPath: "/tmp/ca.pem"}++ err := validateAndSanitizeDataSourceTLS(ds)+ require.NoError(t, err)+}++func TestValidateAndSanitizeDataSourceTLSRejectsPathToInlineSwitchWithoutClearingOldField(t *testing.T) {+ ds := &storepb.DataSource{UseSsl: true, SslCa: validCAPEM, SslCaPath: "/tmp/ca.pem"}++ err := validateAndSanitizeDataSourceTLS(ds)+ require.Error(t, err)+ require.Contains(t, err.Error(), `cannot set both ssl_ca and ssl_ca_path`)+ require.Contains(t, err.Error(), `clear one of them by including the field in the update_mask with an empty value`)+}++func TestValidateAndSanitizeDataSourceTLSAllowsCertPathAndInlineKey(t *testing.T) {+ err := validateAndSanitizeDataSourceTLS(&storepb.DataSource{UseSsl: true, SslCertPath: "/tmp/cert.pem", SslKey: validKeyPEM})+ require.NoError(t, err)+}++func TestValidateAndSanitizeDataSourceTLSAllowsCertInlineAndKeyPath(t *testing.T) {+ err := validateAndSanitizeDataSourceTLS(&storepb.DataSource{UseSsl: true, SslCert: validCAPEM, SslKeyPath: "/tmp/key.pem"})+ require.NoError(t, err)+}++func TestValidateAndSanitizeDataSourceTLSMatchesRuntimeCertPEMScanning(t *testing.T) {+ certBundle := validKeyPEM + "\n" + validCAPEM+ err := validateAndSanitizeDataSourceTLS(&storepb.DataSource{UseSsl: true, SslCert: certBundle, SslKeyPath: "/tmp/key.pem"})+ require.NoError(t, err)+}++func TestValidateAndSanitizeDataSourceTLSRejectsMalformedInlineCertWithKeyPath(t *testing.T) {+ err := validateAndSanitizeDataSourceTLS(&storepb.DataSource{UseSsl: true, SslCert: "not-a-cert", SslKeyPath: "/tmp/key.pem"})+ require.Error(t, err)+ require.Contains(t, err.Error(), "invalid ssl_cert PEM")+}++func TestValidateAndSanitizeDataSourceTLSRejectsMalformedInlineKeyWithCertPath(t *testing.T) {+ err := validateAndSanitizeDataSourceTLS(&storepb.DataSource{UseSsl: true, SslCertPath: "/tmp/cert.pem", SslKey: "not-a-key"})+ require.Error(t, err)+ require.Contains(t, err.Error(), "invalid ssl_key PEM")+}++func TestValidateAndSanitizeDataSourceTLSMatchesRuntimeKeyPEMScanning(t *testing.T) {+ keyBundle := validCAPEM + "\n" + validKeyPEM+ err := validateAndSanitizeDataSourceTLS(&storepb.DataSource{UseSsl: true, SslCertPath: "/tmp/cert.pem", SslKey: keyBundle})+ require.NoError(t, err)+}++func TestValidateAndSanitizeDataSourceTLSAllowsEd25519PrivateKey(t *testing.T) {+ keyPEM := generateEd25519KeyPEM(t)+ err := validateAndSanitizeDataSourceTLS(&storepb.DataSource{UseSsl: true, SslCertPath: "/tmp/cert.pem", SslKey: keyPEM})+ require.NoError(t, err)+}++func generateEd25519KeyPEM(t *testing.T) string {+ t.Helper()++ _, key, err := ed25519.GenerateKey(rand.Reader)+ require.NoError(t, err)+ der, err := x509.MarshalPKCS8PrivateKey(key)+ require.NoError(t, err)+ return string(pem.EncodeToMemory(&pem.Block{Type: "PRIVATE KEY", Bytes: der}))+}++func TestValidateAndSanitizeDataSourceTLSRejectsRelativePath(t *testing.T) {+ ds := &storepb.DataSource{UseSsl: true, SslCaPath: "ca.pem"}++ err := validateAndSanitizeDataSourceTLS(ds)+ require.Error(t, err)+ require.Contains(t, err.Error(), "ssl_ca_path must be an absolute path")+}++func TestValidateAndSanitizeDataSourceTLSRejectsIncompleteCertPath(t *testing.T) {+ ds := &storepb.DataSource{UseSsl: true, SslCertPath: "/tmp/cert.pem"}++ err := validateAndSanitizeDataSourceTLS(ds)+ require.Error(t, err)+ require.Contains(t, err.Error(), "ssl_cert and ssl_key must be both set or unset")+}++func TestValidateAndSanitizeDataSourceTLSAllowsValidPathOnlyCert(t *testing.T) {+ ds := &storepb.DataSource{UseSsl: true, SslCertPath: "/tmp/cert.pem", SslKeyPath: "/tmp/key.pem"}++ err := validateAndSanitizeDataSourceTLS(ds)+ require.NoError(t, err)+}++func TestValidateAndSanitizeDataSourceTLSClearsAllWhenDisabled(t *testing.T) {+ ds := &storepb.DataSource{+ UseSsl: false,+ SslCa: "inline-ca",+ SslCert: "inline-cert",+ SslKey: "inline-key",+ SslCaPath: "/tmp/ca.pem",+ SslCertPath: "/tmp/cert.pem",+ SslKeyPath: "/tmp/key.pem",+ }+ err := validateAndSanitizeDataSourceTLS(ds)+ require.NoError(t, err)+ require.Empty(t, ds.GetSslCa())+ require.Empty(t, ds.GetSslCert())+ require.Empty(t, ds.GetSslKey())+ require.Empty(t, ds.GetSslCaPath())+ require.Empty(t, ds.GetSslCertPath())+ require.Empty(t, ds.GetSslKeyPath())+}diff --git a/backend/component/dbfactory/dbfactory.go b/backend/component/dbfactory/dbfactory.goindex c2b15c197e..b4e9b2dd20 100644--- a/backend/component/dbfactory/dbfactory.go+++ b/backend/component/dbfactory/dbfactory.go@@ -10,6 +10,7 @@ import (storepb "github.com/bytebase/bytebase/backend/generated-go/store"v1pb "github.com/bytebase/bytebase/backend/generated-go/v1""github.com/bytebase/bytebase/backend/plugin/db"+ dbutil "github.com/bytebase/bytebase/backend/plugin/db/util""github.com/bytebase/bytebase/backend/store""github.com/bytebase/bytebase/backend/utils")@@ -54,11 +55,16 @@ func (d *DBFactory) GetDataSourceDriver(ctx context.Context, instance *store.InsconnectionContext.InstanceID = instance.ResourceIDconnectionContext.EngineVersion = instance.Metadata.GetVersion()+ resolvedDataSource, err := dbutil.ResolveTLSMaterial(dataSource)+ if err != nil {+ return nil, err+ }+driver, err := db.Open(ctx,instance.Metadata.GetEngine(),db.ConnectionConfig{- DataSource: dataSource,+ DataSource: resolvedDataSource,ConnectionContext: connectionContext,Password: password,},diff --git a/backend/component/ghost/config.go b/backend/component/ghost/config.goindex a89a469f3f..81cba79da8 100644--- a/backend/component/ghost/config.go+++ b/backend/component/ghost/config.go@@ -14,6 +14,7 @@ import ("github.com/bytebase/bytebase/backend/common"secretcomp "github.com/bytebase/bytebase/backend/component/secret"storepb "github.com/bytebase/bytebase/backend/generated-go/store"+ "github.com/bytebase/bytebase/backend/plugin/db/util""github.com/bytebase/bytebase/backend/store")@@ -204,6 +205,14 @@ func GetUserFlags(flags map[string]string) (*UserFlags, error) {// NewMigrationContext is the context for gh-ost migration.func NewMigrationContext(ctx context.Context, taskID int64, database *store.DatabaseMessage, dataSource *storepb.DataSource, tableName string, tmpTableNameSuffix string, statement string, noop bool, flags map[string]string, serverIDOffset uint) (*ghostbase.MigrationContext, error) {+ resolvedDataSource, err := util.ResolveTLSMaterial(dataSource)+ if err != nil {+ return nil, err+ }+ if resolvedDataSource != nil {+ dataSource = resolvedDataSource+ }+password, err := secretcomp.ReplaceExternalSecret(ctx, dataSource.GetPassword(), dataSource.GetExternalSecret())if err != nil {return nil, err@@ -222,10 +231,14 @@ func NewMigrationContext(ctx context.Context, taskID int64, database *store.Data}if dataSource.GetUseSsl() {migrationContext.UseTLS = true- migrationContext.TLSCACertificate = dataSource.GetSslCa()- migrationContext.TLSCertificate = dataSource.GetSslCert()- migrationContext.TLSKey = dataSource.GetSslKey()- migrationContext.TLSAllowInsecure = true+ migrationContext.TLSAllowInsecure = !dataSource.GetVerifyTlsCertificate()++ tlsCleanup, err := writeTLSMaterialTempFiles(dataSource, migrationContext)+ if err != nil {+ return nil, err+ }+ defer tlsCleanup()+if err := migrationContext.SetupTLS(); err != nil {return nil, errors.Wrapf(err, "failed to set up tls")}@@ -377,6 +390,80 @@ func NewMigrationContext(ctx context.Context, taskID int64, database *store.Datareturn migrationContext, nil}+func writeTLSMaterialTempFiles(dataSource *storepb.DataSource, migrationContext *ghostbase.MigrationContext) (func(), error) {+ var cleanupFiles []string+ cleanup := func() {+ for _, fileName := range cleanupFiles {+ _ = os.Remove(fileName)+ }+ }++ if dataSource.GetSslCa() != "" {+ caFile, err := os.CreateTemp(os.TempDir(), "gh-ost-tls-ca-*")+ if err != nil {+ return nil, errors.Wrap(err, "failed to create temporary CA file")+ }+ if _, err := caFile.WriteString(dataSource.GetSslCa()); err != nil {+ _ = caFile.Close()+ _ = os.Remove(caFile.Name())+ return nil, errors.Wrap(err, "failed to write temporary CA file")+ }+ if err := caFile.Close(); err != nil {+ _ = os.Remove(caFile.Name())+ return nil, errors.Wrap(err, "failed to close temporary CA file")+ }+ cleanupFiles = append(cleanupFiles, caFile.Name())+ migrationContext.TLSCACertificate = caFile.Name()+ }++ if dataSource.GetSslCert() != "" || dataSource.GetSslKey() != "" {+ if dataSource.GetSslCert() == "" || dataSource.GetSslKey() == "" {+ cleanup()+ return nil, errors.Errorf("ssl-cert and ssl-key must be both set or unset")+ }++ certFile, err := os.CreateTemp(os.TempDir(), "gh-ost-tls-cert-*")+ if err != nil {+ cleanup()+ return nil, errors.Wrap(err, "failed to create temporary client certificate file")+ }+ if _, err := certFile.WriteString(dataSource.GetSslCert()); err != nil {+ _ = certFile.Close()+ _ = os.Remove(certFile.Name())+ cleanup()+ return nil, errors.Wrap(err, "failed to write temporary client certificate file")+ }+ if err := certFile.Close(); err != nil {+ _ = os.Remove(certFile.Name())+ cleanup()+ return nil, errors.Wrap(err, "failed to close temporary client certificate file")+ }+ cleanupFiles = append(cleanupFiles, certFile.Name())+ migrationContext.TLSCertificate = certFile.Name()++ keyFile, err := os.CreateTemp(os.TempDir(), "gh-ost-tls-key-*")+ if err != nil {+ cleanup()+ return nil, errors.Wrap(err, "failed to create temporary client key file")+ }+ if _, err := keyFile.WriteString(dataSource.GetSslKey()); err != nil {+ _ = keyFile.Close()+ _ = os.Remove(keyFile.Name())+ cleanup()+ return nil, errors.Wrap(err, "failed to write temporary client key file")+ }+ if err := keyFile.Close(); err != nil {+ _ = os.Remove(keyFile.Name())+ cleanup()+ return nil, errors.Wrap(err, "failed to close temporary client key file")+ }+ cleanupFiles = append(cleanupFiles, keyFile.Name())+ migrationContext.TLSKey = keyFile.Name()+ }++ return cleanup, nil+}+// GetTableNameFromStatement gets the table name from statement for gh-ost.func GetTableNameFromStatement(statement string) (string, error) {// Trim the statement for the parser.diff --git a/backend/component/ghost/config_test.go b/backend/component/ghost/config_test.gonew file mode 100644index 0000000000..b27b3039f1--- /dev/null+++ b/backend/component/ghost/config_test.go@@ -0,0 +1,103 @@+package ghost++import (+ "context"+ "crypto/rand"+ "crypto/rsa"+ "crypto/x509"+ "crypto/x509/pkix"+ "encoding/pem"+ "math/big"+ "path/filepath"+ "testing"+ "time"++ "github.com/stretchr/testify/require"++ storepb "github.com/bytebase/bytebase/backend/generated-go/store"+ "github.com/bytebase/bytebase/backend/store"+)++func TestNewMigrationContextWritesTLSMaterialToTempFiles(t *testing.T) {+ certPEM, keyPEM := generateSelfSignedPEM(t)++ ctx := context.Background()+ database := &store.DatabaseMessage{DatabaseName: "ghostdb"}+ dataSource := &storepb.DataSource{+ Host: "127.0.0.1",+ Port: "3306",+ Username: "root",+ UseSsl: true,+ VerifyTlsCertificate: false,+ SslCa: certPEM,+ SslCert: certPEM,+ SslKey: keyPEM,+ AuthenticationType: storepb.DataSource_PASSWORD,+ }++ migrationContext, err := NewMigrationContext(ctx, 1, database, dataSource, "t", "_suffix", "ALTER TABLE t ADD COLUMN c INT", false, nil, 0)+ require.NoError(t, err)+ require.True(t, migrationContext.UseTLS)+ require.True(t, migrationContext.TLSAllowInsecure)+ require.True(t, filepath.IsAbs(migrationContext.TLSCACertificate))+ require.True(t, filepath.IsAbs(migrationContext.TLSCertificate))+ require.True(t, filepath.IsAbs(migrationContext.TLSKey))+ require.NotEqual(t, certPEM, migrationContext.TLSCACertificate)+ require.NotEqual(t, certPEM, migrationContext.TLSCertificate)+ require.NotEqual(t, keyPEM, migrationContext.TLSKey)+ require.NoFileExists(t, migrationContext.TLSCACertificate)+ require.NoFileExists(t, migrationContext.TLSCertificate)+ require.NoFileExists(t, migrationContext.TLSKey)+}++func TestNewMigrationContextRespectsVerifyTlsCertificate(t *testing.T) {+ certPEM, keyPEM := generateSelfSignedPEM(t)++ ctx := context.Background()+ database := &store.DatabaseMessage{DatabaseName: "ghostdb"}+ dataSource := &storepb.DataSource{+ Host: "127.0.0.1",+ Port: "3306",+ Username: "root",+ UseSsl: true,+ VerifyTlsCertificate: true,+ SslCa: certPEM,+ SslCert: certPEM,+ SslKey: keyPEM,+ }++ migrationContext, err := NewMigrationContext(ctx, 1, database, dataSource, "t", "_suffix", "ALTER TABLE t ADD COLUMN c INT", false, nil, 0)+ require.NoError(t, err)+ require.False(t, migrationContext.TLSAllowInsecure)+}++func generateSelfSignedPEM(t *testing.T) (string, string) {+ t.Helper()++ key, err := rsa.GenerateKey(rand.Reader, 2048)+ require.NoError(t, err)++ template := &x509.Certificate{+ SerialNumber: big.NewInt(1),+ Subject: pkix.Name{+ CommonName: "bytebase-test",+ Organization: []string{"Bytebase"},+ },+ NotBefore: time.Now().Add(-time.Hour),+ NotAfter: time.Now().Add(time.Hour),+ KeyUsage: x509.KeyUsageDigitalSignature | x509.KeyUsageKeyEncipherment | x509.KeyUsageCertSign,+ ExtKeyUsage: []x509.ExtKeyUsage{x509.ExtKeyUsageClientAuth, x509.ExtKeyUsageServerAuth},+ BasicConstraintsValid: true,+ IsCA: true,+ }++ certDER, err := x509.CreateCertificate(rand.Reader, template, template, &key.PublicKey, key)+ require.NoError(t, err)++ certPEM := pem.EncodeToMemory(&pem.Block{Type: "CERTIFICATE", Bytes: certDER})+ keyPEM := pem.EncodeToMemory(&pem.Block{Type: "RSA PRIVATE KEY", Bytes: x509.MarshalPKCS1PrivateKey(key)})+ require.NotEmpty(t, certPEM)+ require.NotEmpty(t, keyPEM)++ return string(certPEM), string(keyPEM)+}diff --git a/backend/generated-go/store/instance.pb.go b/backend/generated-go/store/instance.pb.goindex 588cfa9d31..dd882a6988 100644--- a/backend/generated-go/store/instance.pb.go+++ b/backend/generated-go/store/instance.pb.go@@ -561,13 +561,19 @@ type DataSource struct {Password string `protobuf:"bytes,37,opt,name=password,proto3" json:"password,omitempty"`ObfuscatedPassword string `protobuf:"bytes,4,opt,name=obfuscated_password,json=obfuscatedPassword,proto3" json:"obfuscated_password,omitempty"`// Use SSL to connect to the data source. By default, we use the system's SSL configuration.- UseSsl bool `protobuf:"varint,30,opt,name=use_ssl,json=useSsl,proto3" json:"use_ssl,omitempty"`- SslCa string `protobuf:"bytes,38,opt,name=ssl_ca,json=sslCa,proto3" json:"ssl_ca,omitempty"`- ObfuscatedSslCa string `protobuf:"bytes,5,opt,name=obfuscated_ssl_ca,json=obfuscatedSslCa,proto3" json:"obfuscated_ssl_ca,omitempty"`- SslCert string `protobuf:"bytes,39,opt,name=ssl_cert,json=sslCert,proto3" json:"ssl_cert,omitempty"`- ObfuscatedSslCert string `protobuf:"bytes,6,opt,name=obfuscated_ssl_cert,json=obfuscatedSslCert,proto3" json:"obfuscated_ssl_cert,omitempty"`- SslKey string `protobuf:"bytes,40,opt,name=ssl_key,json=sslKey,proto3" json:"ssl_key,omitempty"`- ObfuscatedSslKey string `protobuf:"bytes,7,opt,name=obfuscated_ssl_key,json=obfuscatedSslKey,proto3" json:"obfuscated_ssl_key,omitempty"`+ UseSsl bool `protobuf:"varint,30,opt,name=use_ssl,json=useSsl,proto3" json:"use_ssl,omitempty"`+ SslCa string `protobuf:"bytes,38,opt,name=ssl_ca,json=sslCa,proto3" json:"ssl_ca,omitempty"`+ ObfuscatedSslCa string `protobuf:"bytes,5,opt,name=obfuscated_ssl_ca,json=obfuscatedSslCa,proto3" json:"obfuscated_ssl_ca,omitempty"`+ SslCert string `protobuf:"bytes,39,opt,name=ssl_cert,json=sslCert,proto3" json:"ssl_cert,omitempty"`+ ObfuscatedSslCert string `protobuf:"bytes,6,opt,name=obfuscated_ssl_cert,json=obfuscatedSslCert,proto3" json:"obfuscated_ssl_cert,omitempty"`+ SslKey string `protobuf:"bytes,40,opt,name=ssl_key,json=sslKey,proto3" json:"ssl_key,omitempty"`+ ObfuscatedSslKey string `protobuf:"bytes,7,opt,name=obfuscated_ssl_key,json=obfuscatedSslKey,proto3" json:"obfuscated_ssl_key,omitempty"`+ SslCaPath string `protobuf:"bytes,50,opt,name=ssl_ca_path,json=sslCaPath,proto3" json:"ssl_ca_path,omitempty"`+ ObfuscatedSslCaPath string `protobuf:"bytes,51,opt,name=obfuscated_ssl_ca_path,json=obfuscatedSslCaPath,proto3" json:"obfuscated_ssl_ca_path,omitempty"`+ SslCertPath string `protobuf:"bytes,52,opt,name=ssl_cert_path,json=sslCertPath,proto3" json:"ssl_cert_path,omitempty"`+ ObfuscatedSslCertPath string `protobuf:"bytes,53,opt,name=obfuscated_ssl_cert_path,json=obfuscatedSslCertPath,proto3" json:"obfuscated_ssl_cert_path,omitempty"`+ SslKeyPath string `protobuf:"bytes,54,opt,name=ssl_key_path,json=sslKeyPath,proto3" json:"ssl_key_path,omitempty"`+ ObfuscatedSslKeyPath string `protobuf:"bytes,55,opt,name=obfuscated_ssl_key_path,json=obfuscatedSslKeyPath,proto3" json:"obfuscated_ssl_key_path,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).@@ -754,6 +760,48 @@ func (x *DataSource) GetObfuscatedSslKey() string {return ""}+func (x *DataSource) GetSslCaPath() string {+ if x != nil {+ return x.SslCaPath+ }+ return ""+}++func (x *DataSource) GetObfuscatedSslCaPath() string {+ if x != nil {+ return x.ObfuscatedSslCaPath+ }+ return ""+}++func (x *DataSource) GetSslCertPath() string {+ if x != nil {+ return x.SslCertPath+ }+ return ""+}++func (x *DataSource) GetObfuscatedSslCertPath() string {+ if x != nil {+ return x.ObfuscatedSslCertPath+ }+ return ""+}++func (x *DataSource) GetSslKeyPath() string {+ if x != nil {+ return x.SslKeyPath+ }+ return ""+}++func (x *DataSource) GetObfuscatedSslKeyPath() string {+ if x != nil {+ return x.ObfuscatedSslKeyPath+ }+ return ""+}+func (x *DataSource) GetVerifyTlsCertificate() bool {if x != nil {return x.VerifyTlsCertificate@@ -1782,7 +1830,7 @@ const file_store_instance_proto_rawDesc = "" +"\x11_connection_limitB\x0e\n" +"\f_valid_untilB\f\n" +"\n" +- "_attribute\"\xba\x1a\n" ++ "_attribute\"\xc5\x1c\n" +"\n" +"DataSource\x12\x0e\n" +"\x02id\x18\x01 \x01(\tR\x02id\x122\n" +@@ -1796,7 +1844,14 @@ const file_store_instance_proto_rawDesc = "" +"\bssl_cert\x18' \x01(\tR\asslCert\x12.\n" +"\x13obfuscated_ssl_cert\x18\x06 \x01(\tR\x11obfuscatedSslCert\x12\x17\n" +"\assl_key\x18( \x01(\tR\x06sslKey\x12,\n" +- "\x12obfuscated_ssl_key\x18\a \x01(\tR\x10obfuscatedSslKey\x124\n" ++ "\x12obfuscated_ssl_key\x18\a \x01(\tR\x10obfuscatedSslKey\x12\x1e\n" ++ "\vssl_ca_path\x182 \x01(\tR\tsslCaPath\x123\n" ++ "\x16obfuscated_ssl_ca_path\x183 \x01(\tR\x13obfuscatedSslCaPath\x12\"\n" ++ "\rssl_cert_path\x184 \x01(\tR\vsslCertPath\x127\n" ++ "\x18obfuscated_ssl_cert_path\x185 \x01(\tR\x15obfuscatedSslCertPath\x12 \n" ++ "\fssl_key_path\x186 \x01(\tR\n" ++ "sslKeyPath\x125\n" ++ "\x17obfuscated_ssl_key_path\x187 \x01(\tR\x14obfuscatedSslKeyPath\x124\n" +"\x16verify_tls_certificate\x18/ \x01(\bR\x14verifyTlsCertificate\x12\x12\n" +"\x04host\x18\b \x01(\tR\x04host\x12\x12\n" +"\x04port\x18\t \x01(\tR\x04port\x12\x1a\n" +diff --git a/backend/generated-go/store/instance_equal.pb.go b/backend/generated-go/store/instance_equal.pb.goindex ce82a564f4..c9412d5922 100644--- a/backend/generated-go/store/instance_equal.pb.go+++ b/backend/generated-go/store/instance_equal.pb.go@@ -226,6 +226,24 @@ func (x *DataSource) Equal(y *DataSource) bool {if x.ObfuscatedSslKey != y.ObfuscatedSslKey {return false}+ if x.SslCaPath != y.SslCaPath {+ return false+ }+ if x.ObfuscatedSslCaPath != y.ObfuscatedSslCaPath {+ return false+ }+ if x.SslCertPath != y.SslCertPath {+ return false+ }+ if x.ObfuscatedSslCertPath != y.ObfuscatedSslCertPath {+ return false+ }+ if x.SslKeyPath != y.SslKeyPath {+ return false+ }+ if x.ObfuscatedSslKeyPath != y.ObfuscatedSslKeyPath {+ return false+ }if x.VerifyTlsCertificate != y.VerifyTlsCertificate {return false}diff --git a/backend/generated-go/v1/instance_service.pb.go b/backend/generated-go/v1/instance_service.pb.goindex aaa493b19c..37ef81b9a1 100644--- a/backend/generated-go/v1/instance_service.pb.go+++ b/backend/generated-go/v1/instance_service.pb.go@@ -1763,6 +1763,24 @@ type DataSource struct {SslCert string `protobuf:"bytes,6,opt,name=ssl_cert,json=sslCert,proto3" json:"ssl_cert,omitempty"`// The SSL client private key.SslKey string `protobuf:"bytes,7,opt,name=ssl_key,json=sslKey,proto3" json:"ssl_key,omitempty"`+ // The local filesystem path to the SSL certificate authority certificate.+ SslCaPath string `protobuf:"bytes,41,opt,name=ssl_ca_path,json=sslCaPath,proto3" json:"ssl_ca_path,omitempty"`+ // The local filesystem path to the SSL client certificate.+ SslCertPath string `protobuf:"bytes,42,opt,name=ssl_cert_path,json=sslCertPath,proto3" json:"ssl_cert_path,omitempty"`+ // The local filesystem path to the SSL client private key.+ SslKeyPath string `protobuf:"bytes,43,opt,name=ssl_key_path,json=sslKeyPath,proto3" json:"ssl_key_path,omitempty"`+ // Whether an SSL certificate authority certificate has been configured.+ SslCaSet bool `protobuf:"varint,44,opt,name=ssl_ca_set,json=sslCaSet,proto3" json:"ssl_ca_set,omitempty"`+ // Whether an SSL client certificate has been configured.+ SslCertSet bool `protobuf:"varint,45,opt,name=ssl_cert_set,json=sslCertSet,proto3" json:"ssl_cert_set,omitempty"`+ // Whether an SSL client private key has been configured.+ SslKeySet bool `protobuf:"varint,46,opt,name=ssl_key_set,json=sslKeySet,proto3" json:"ssl_key_set,omitempty"`+ // Whether an SSL certificate authority path has been configured.+ SslCaPathSet bool `protobuf:"varint,47,opt,name=ssl_ca_path_set,json=sslCaPathSet,proto3" json:"ssl_ca_path_set,omitempty"`+ // Whether an SSL client certificate path has been configured.+ SslCertPathSet bool `protobuf:"varint,48,opt,name=ssl_cert_path_set,json=sslCertPathSet,proto3" json:"ssl_cert_path_set,omitempty"`+ // Whether an SSL client private key path has been configured.+ SslKeyPathSet bool `protobuf:"varint,49,opt,name=ssl_key_path_set,json=sslKeyPathSet,proto3" json:"ssl_key_path_set,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).@@ -1922,6 +1940,69 @@ func (x *DataSource) GetSslKey() string {return ""}+func (x *DataSource) GetSslCaPath() string {+ if x != nil {+ return x.SslCaPath+ }+ return ""+}++func (x *DataSource) GetSslCertPath() string {+ if x != nil {+ return x.SslCertPath+ }+ return ""+}++func (x *DataSource) GetSslKeyPath() string {+ if x != nil {+ return x.SslKeyPath+ }+ return ""+}++func (x *DataSource) GetSslCaSet() bool {+ if x != nil {+ return x.SslCaSet+ }+ return false+}++func (x *DataSource) GetSslCertSet() bool {+ if x != nil {+ return x.SslCertSet+ }+ return false+}++func (x *DataSource) GetSslKeySet() bool {+ if x != nil {+ return x.SslKeySet+ }+ return false+}++func (x *DataSource) GetSslCaPathSet() bool {+ if x != nil {+ return x.SslCaPathSet+ }+ return false+}++func (x *DataSource) GetSslCertPathSet() bool {+ if x != nil {+ return x.SslCertPathSet+ }+ return false+}++func (x *DataSource) GetSslKeyPathSet() bool {+ if x != nil {+ return x.SslKeyPathSet+ }+ return false+}+func (x *DataSource) GetVerifyTlsCertificate() bool {if x != nil {return x.VerifyTlsCertificate@@ -2895,7 +2976,7 @@ const file_v1_instance_service_proto_rawDesc = "" +"\x15AUTH_TYPE_UNSPECIFIED\x10\x00\x12\t\n" +"\x05TOKEN\x10\x01\x12\x12\n" +"\x0eVAULT_APP_ROLE\x10\x02B\r\n" +- "\vauth_option\"\xa5\x14\n" ++ "\vauth_option\"\x93\x17\n" +"\n" +"DataSource\x12\x0e\n" +"\x02id\x18\x01 \x01(\tR\x02id\x12/\n" +@@ -2905,7 +2986,19 @@ const file_v1_instance_service_proto_rawDesc = "" +"\ause_ssl\x18\x1e \x01(\bR\x06useSsl\x12\x1a\n" +"\x06ssl_ca\x18\x05 \x01(\tB\x03\xe0A\x04R\x05sslCa\x12\x1e\n" +"\bssl_cert\x18\x06 \x01(\tB\x03\xe0A\x04R\asslCert\x12\x1c\n" +- "\assl_key\x18\a \x01(\tB\x03\xe0A\x04R\x06sslKey\x124\n" ++ "\assl_key\x18\a \x01(\tB\x03\xe0A\x04R\x06sslKey\x12#\n" ++ "\vssl_ca_path\x18) \x01(\tB\x03\xe0A\x04R\tsslCaPath\x12'\n" ++ "\rssl_cert_path\x18* \x01(\tB\x03\xe0A\x04R\vsslCertPath\x12%\n" ++ "\fssl_key_path\x18+ \x01(\tB\x03\xe0A\x04R\n" ++ "sslKeyPath\x12!\n" ++ "\n" ++ "ssl_ca_set\x18, \x01(\bB\x03\xe0A\x03R\bsslCaSet\x12%\n" ++ "\fssl_cert_set\x18- \x01(\bB\x03\xe0A\x03R\n" ++ "sslCertSet\x12#\n" ++ "\vssl_key_set\x18. \x01(\bB\x03\xe0A\x03R\tsslKeySet\x12*\n" ++ "\x0fssl_ca_path_set\x18/ \x01(\bB\x03\xe0A\x03R\fsslCaPathSet\x12.\n" ++ "\x11ssl_cert_path_set\x180 \x01(\bB\x03\xe0A\x03R\x0esslCertPathSet\x12,\n" ++ "\x10ssl_key_path_set\x181 \x01(\bB\x03\xe0A\x03R\rsslKeyPathSet\x124\n" +"\x16verify_tls_certificate\x18' \x01(\bR\x14verifyTlsCertificate\x12\x12\n" +"\x04host\x18\b \x01(\tR\x04host\x12\x12\n" +"\x04port\x18\t \x01(\tR\x04port\x12\x1a\n" +diff --git a/backend/generated-go/v1/instance_service_equal.pb.go b/backend/generated-go/v1/instance_service_equal.pb.goindex d503b42274..e5225d18f7 100644--- a/backend/generated-go/v1/instance_service_equal.pb.go+++ b/backend/generated-go/v1/instance_service_equal.pb.go@@ -585,6 +585,33 @@ func (x *DataSource) Equal(y *DataSource) bool {if x.SslKey != y.SslKey {return false}+ if x.SslCaPath != y.SslCaPath {+ return false+ }+ if x.SslCertPath != y.SslCertPath {+ return false+ }+ if x.SslKeyPath != y.SslKeyPath {+ return false+ }+ if x.SslCaSet != y.SslCaSet {+ return false+ }+ if x.SslCertSet != y.SslCertSet {+ return false+ }+ if x.SslKeySet != y.SslKeySet {+ return false+ }+ if x.SslCaPathSet != y.SslCaPathSet {+ return false+ }+ if x.SslCertPathSet != y.SslCertPathSet {+ return false+ }+ if x.SslKeyPathSet != y.SslKeyPathSet {+ return false+ }if x.VerifyTlsCertificate != y.VerifyTlsCertificate {return false}diff --git a/backend/plugin/db/elasticsearch/elasticsearch.go b/backend/plugin/db/elasticsearch/elasticsearch.goindex 114871e3e4..51b9125252 100644--- a/backend/plugin/db/elasticsearch/elasticsearch.go+++ b/backend/plugin/db/elasticsearch/elasticsearch.go@@ -155,16 +155,7 @@ func openWithBasicAuth(_ context.Context, config db.ConnectionConfig, address sttlsConfig.MinVersion = tls.VersionTLS12}- esConfig := elasticsearch.Config{- Username: config.DataSource.Username,- Password: config.Password,- Addresses: []string{address},- Transport: &http.Transport{- MaxIdleConnsPerHost: 10,- ResponseHeaderTimeout: 5 * time.Second,- TLSClientConfig: tlsConfig,- },- }+ esConfig := newElasticsearchConfig(config, address, tlsConfig)// default http client.httpClient := &http.Client{Transport: &http.Transport{@@ -172,12 +163,6 @@ func openWithBasicAuth(_ context.Context, config db.ConnectionConfig, address st},}- // If CA cert is provided, update the config- // Note: util.GetTLSConfig already handles CA cert configuration- if config.DataSource.GetSslCert() != "" {- esConfig.CACert = []byte(config.DataSource.GetSslCert())- }-// typed elasticsearch client.typedClient, err := elasticsearch.NewClient(esConfig)if err != nil {@@ -202,6 +187,23 @@ func openWithBasicAuth(_ context.Context, config db.ConnectionConfig, address st}, nil}+func newElasticsearchConfig(config db.ConnectionConfig, address string, tlsConfig *tls.Config) elasticsearch.Config {+ esConfig := elasticsearch.Config{+ Username: config.DataSource.Username,+ Password: config.Password,+ Addresses: []string{address},+ Transport: &http.Transport{+ MaxIdleConnsPerHost: 10,+ ResponseHeaderTimeout: 5 * time.Second,+ TLSClientConfig: tlsConfig,+ },+ }+ if config.DataSource.GetSslCa() != "" {+ esConfig.CACert = []byte(config.DataSource.GetSslCa())+ }+ return esConfig+}+func openWithOpenSearchClient(ctx context.Context, config db.ConnectionConfig, address string) (db.Driver, error) {// Keep debugInfo for error messagesdebugInfo := fmt.Sprintf("OpenSearch config - address: %s, authType: %v", address, config.DataSource.GetAuthenticationType())diff --git a/backend/plugin/db/elasticsearch/elasticsearch_test.go b/backend/plugin/db/elasticsearch/elasticsearch_test.goindex 9de02d974e..e6d7e08469 100644--- a/backend/plugin/db/elasticsearch/elasticsearch_test.go+++ b/backend/plugin/db/elasticsearch/elasticsearch_test.go@@ -4,6 +4,7 @@ import ("context""encoding/json""net/url"+ "os""strings""testing"@@ -12,6 +13,7 @@ import (storepb "github.com/bytebase/bytebase/backend/generated-go/store""github.com/bytebase/bytebase/backend/plugin/db"+ dbutil "github.com/bytebase/bytebase/backend/plugin/db/util")func TestOpenWithAWSAuth(t *testing.T) {@@ -61,6 +63,48 @@ func TestOpenWithAWSAuth(t *testing.T) {}}+func TestNewElasticsearchConfigUsesCACert(t *testing.T) {+ config := db.ConnectionConfig{+ DataSource: &storepb.DataSource{+ Host: "localhost",+ Port: "9200",+ SslCa: "ca-pem",+ SslCert: "cert-pem",+ SslKey: "key-pem",+ UseSsl: false,+ Username: "elastic",+ },+ Password: "password123",+ }++ esConfig := newElasticsearchConfig(config, "https://localhost:9200", nil)+ require.Equal(t, []byte("ca-pem"), esConfig.CACert)+ require.NotEqual(t, []byte("cert-pem"), esConfig.CACert)+}++func TestNewElasticsearchConfigUsesPathCACert(t *testing.T) {+ caPath := t.TempDir() + "/ca.pem"+ require.NoError(t, os.WriteFile(caPath, []byte("path-ca-pem"), 0o600))+ config := db.ConnectionConfig{+ DataSource: &storepb.DataSource{+ Host: "localhost",+ Port: "9200",+ UseSsl: true,+ SslCaPath: caPath,+ Username: "elastic",+ },+ Password: "password123",+ }++ resolvedDataSource, err := dbutil.ResolveTLSMaterial(config.DataSource)+ require.NoError(t, err)+ resolvedConfig := config+ resolvedConfig.DataSource = resolvedDataSource+ esConfig := newElasticsearchConfig(resolvedConfig, "https://localhost:9200", nil)+ require.Equal(t, []byte("path-ca-pem"), esConfig.CACert)+ require.Empty(t, resolvedConfig.DataSource.GetSslCaPath())+}+func TestURLConstructionWithQueryParams(t *testing.T) {testCases := []struct {name stringdiff --git a/backend/plugin/db/mongodb/mongodb.go b/backend/plugin/db/mongodb/mongodb.goindex 2ece1fbd46..d9fe7d941f 100644--- a/backend/plugin/db/mongodb/mongodb.go+++ b/backend/plugin/db/mongodb/mongodb.go@@ -15,7 +15,6 @@ import ("time""github.com/bytebase/gomongo"- "github.com/google/uuid""github.com/pkg/errors""go.mongodb.org/mongo-driver/v2/bson""go.mongodb.org/mongo-driver/v2/mongo"@@ -157,6 +156,11 @@ func (d *Driver) buildMongoshBaseArgs() (args []string, cleanup func(), err erro}var cleanups []string+ cleanup = func() {+ for _, f := range cleanups {+ _ = os.Remove(f)+ }+ }if d.connCfg.DataSource.GetUseSsl() {args = append(args, "--tls")@@ -164,34 +168,49 @@ func (d *Driver) buildMongoshBaseArgs() (args []string, cleanup func(), err erroargs = append(args, "--tlsAllowInvalidHostnames", "--tlsAllowInvalidCertificates")}- id := uuid.New().String()if d.connCfg.DataSource.GetSslCa() == "" {args = append(args, "--tlsUseSystemCA")} else {- caFileName := fmt.Sprintf("mongodb-tls-ca-%s-%s", d.connCfg.ConnectionContext.DatabaseName, id)- if err := os.WriteFile(caFileName, []byte(d.connCfg.DataSource.GetSslCa()), 0400); err != nil {+ caFile, err := os.CreateTemp(os.TempDir(), fmt.Sprintf("mongodb-tls-ca-%s-*", d.connCfg.ConnectionContext.DatabaseName))+ if err != nil {+ return nil, nil, errors.Wrap(err, "failed to create tlsCAFile temporary file")+ }+ if _, err := caFile.WriteString(d.connCfg.DataSource.GetSslCa()); err != nil {+ _ = caFile.Close()+ _ = os.Remove(caFile.Name())return nil, nil, errors.Wrap(err, "failed to write tlsCAFile to temporary file")}- cleanups = append(cleanups, caFileName)- args = append(args, "--tlsCAFile", caFileName)+ if err := caFile.Close(); err != nil {+ _ = os.Remove(caFile.Name())+ return nil, nil, errors.Wrap(err, "failed to close tlsCAFile temporary file")+ }+ cleanups = append(cleanups, caFile.Name())+ args = append(args, "--tlsCAFile", caFile.Name())}if d.connCfg.DataSource.GetSslKey() != "" && d.connCfg.DataSource.GetSslCert() != "" {- clientCertName := fmt.Sprintf("mongodb-tls-client-cert-%s-%s", d.connCfg.ConnectionContext.DatabaseName, id)+ clientCertFile, err := os.CreateTemp(os.TempDir(), fmt.Sprintf("mongodb-tls-client-cert-%s-*", d.connCfg.ConnectionContext.DatabaseName))+ if err != nil {+ cleanup()+ return nil, nil, errors.Wrap(err, "failed to create client certificate temporary file")+ }certContent := d.connCfg.DataSource.GetSslKey() + "\n" + d.connCfg.DataSource.GetSslCert()- if err := os.WriteFile(clientCertName, []byte(certContent), 0400); err != nil {+ if _, err := clientCertFile.WriteString(certContent); err != nil {+ _ = clientCertFile.Close()+ _ = os.Remove(clientCertFile.Name())+ cleanup()return nil, nil, errors.Wrap(err, "failed to write client certificate to temporary file")}- cleanups = append(cleanups, clientCertName)- args = append(args, "--tlsCertificateKeyFile", clientCertName)+ if err := clientCertFile.Close(); err != nil {+ _ = os.Remove(clientCertFile.Name())+ cleanup()+ return nil, nil, errors.Wrap(err, "failed to close client certificate temporary file")+ }+ cleanups = append(cleanups, clientCertFile.Name())+ args = append(args, "--tlsCertificateKeyFile", clientCertFile.Name())}}- cleanup = func() {- for _, f := range cleanups {- _ = os.Remove(f)- }- }return args, cleanup, nil}@@ -400,6 +419,12 @@ func (d *Driver) queryConnWithMongosh(ctx context.Context, statement string, que"--retryWrites","false",}+ var tlsTempFiles []string+ defer func() {+ for _, fileName := range tlsTempFiles {+ _ = os.Remove(fileName)+ }+ }()if d.connCfg.DataSource.GetUseSsl() {mongoshArgs = append(mongoshArgs, "--tls")@@ -410,52 +435,74 @@ func (d *Driver) queryConnWithMongosh(ctx context.Context, statement string, quemongoshArgs = append(mongoshArgs, "--tlsAllowInvalidCertificates")}- uuid := uuid.New().String()if d.connCfg.DataSource.GetSslCa() == "" {mongoshArgs = append(mongoshArgs, "--tlsUseSystemCA")} else {- // Write the tlsCAFile to a temporary file, and use the temporary file as the value of --tlsCAFile.- // The reason is that the --tlsCAFile option of mongosh does not support the value of the certificate directly.- caFileName := fmt.Sprintf("mongodb-tls-ca-%s-%s", d.connCfg.ConnectionContext.DatabaseName, uuid)- defer func() {- // While error occurred in mongosh, the temporary file may not created, so we ignore the error here.- _ = os.Remove(caFileName)- }()- if err := os.WriteFile(caFileName, []byte(d.connCfg.DataSource.GetSslCa()), 0400); err != nil {+ caFile, err := os.CreateTemp(os.TempDir(), fmt.Sprintf("mongodb-tls-ca-%s-*", d.connCfg.ConnectionContext.DatabaseName))+ if err != nil {+ return nil, errors.Wrap(err, "failed to create tlsCAFile temporary file")+ }+ if _, err := caFile.WriteString(d.connCfg.DataSource.GetSslCa()); err != nil {+ _ = caFile.Close()+ _ = os.Remove(caFile.Name())return nil, errors.Wrap(err, "failed to write tlsCAFile to temporary file")}- mongoshArgs = append(mongoshArgs, "--tlsCAFile", caFileName)+ if err := caFile.Close(); err != nil {+ _ = os.Remove(caFile.Name())+ return nil, errors.Wrap(err, "failed to close tlsCAFile temporary file")+ }+ tlsTempFiles = append(tlsTempFiles, caFile.Name())+ mongoshArgs = append(mongoshArgs, "--tlsCAFile", caFile.Name())}if d.connCfg.DataSource.GetSslKey() != "" && d.connCfg.DataSource.GetSslCert() != "" {- clientCertName := fmt.Sprintf("mongodb-tls-client-cert-%s-%s", d.connCfg.ConnectionContext.DatabaseName, uuid)- defer func() {- // While error occurred in mongosh, the temporary file may not created, so we ignore the error here.- _ = os.Remove(clientCertName)- }()+ clientCertFile, err := os.CreateTemp(os.TempDir(), fmt.Sprintf("mongodb-tls-client-cert-%s-*", d.connCfg.ConnectionContext.DatabaseName))+ if err != nil {+ return nil, errors.Wrap(err, "failed to create client certificate temporary file")+ }var sb strings.Builderif _, err := sb.WriteString(d.connCfg.DataSource.GetSslKey()); err != nil {+ _ = clientCertFile.Close()+ _ = os.Remove(clientCertFile.Name())return nil, errors.Wrapf(err, "failed to write ssl key into string builder")}if _, err := sb.WriteString("\n"); err != nil {+ _ = clientCertFile.Close()+ _ = os.Remove(clientCertFile.Name())return nil, errors.Wrapf(err, "failed to write new line into string builder")}if _, err := sb.WriteString(d.connCfg.DataSource.GetSslCert()); err != nil {+ _ = clientCertFile.Close()+ _ = os.Remove(clientCertFile.Name())return nil, errors.Wrapf(err, "failed to write ssl cert into string builder")}- if err := os.WriteFile(clientCertName, []byte(sb.String()), 0400); err != nil {+ if _, err := clientCertFile.WriteString(sb.String()); err != nil {+ _ = clientCertFile.Close()+ _ = os.Remove(clientCertFile.Name())return nil, errors.Wrap(err, "failed to write tlsCAFile to temporary file")}- mongoshArgs = append(mongoshArgs, "--tlsCertificateKeyFile", clientCertName)+ if err := clientCertFile.Close(); err != nil {+ _ = os.Remove(clientCertFile.Name())+ return nil, errors.Wrap(err, "failed to close client certificate temporary file")+ }+ tlsTempFiles = append(tlsTempFiles, clientCertFile.Name())+ mongoshArgs = append(mongoshArgs, "--tlsCertificateKeyFile", clientCertFile.Name())}}- queryResultFileName := fmt.Sprintf("mongodb-query-%s-%s", d.connCfg.ConnectionContext.DatabaseName, uuid.New().String())+ queryResultFile, err := os.CreateTemp(os.TempDir(), fmt.Sprintf("mongodb-query-%s-*", d.connCfg.ConnectionContext.DatabaseName))+ if err != nil {+ return nil, errors.Wrap(err, "failed to create query result temporary file")+ }+ if err := queryResultFile.Close(); err != nil {+ _ = os.Remove(queryResultFile.Name())+ return nil, errors.Wrap(err, "failed to close query result temporary file")+ }defer func() {// While error occurred in mongosh, the temporary file may not created, so we ignore the error here.- _ = os.Remove(queryResultFileName)+ _ = os.Remove(queryResultFile.Name())}()- mongoshArgs = append(mongoshArgs, ">", queryResultFileName)+ mongoshArgs = append(mongoshArgs, ">", queryResultFile.Name())shellArgs := []string{"-c",@@ -467,7 +514,7 @@ func (d *Driver) queryConnWithMongosh(ctx context.Context, statement string, queshCmd.Stderr = &errContentshCmd.Stdout = &outContentif err := shCmd.Run(); err != nil {- f, ferr := os.OpenFile(queryResultFileName, os.O_RDONLY, 0644)+ f, ferr := os.OpenFile(queryResultFile.Name(), os.O_RDONLY, 0644)if ferr == nil {defer f.Close()if content, ferr := io.ReadAll(f); ferr == nil {@@ -481,9 +528,9 @@ func (d *Driver) queryConnWithMongosh(ctx context.Context, statement string, quereturn nil, errors.Wrapf(err, "failed to execute statement in mongosh: \n stdout: %s\n stderr: %s", outContent.String(), errContent.String())}- f, err := os.OpenFile(queryResultFileName, os.O_RDONLY, 0644)+ f, err := os.OpenFile(queryResultFile.Name(), os.O_RDONLY, 0644)if err != nil {- return nil, errors.Wrapf(err, "failed to open file: %s", queryResultFileName)+ return nil, errors.Wrapf(err, "failed to open file: %s", queryResultFile.Name())}defer f.Close()@@ -501,7 +548,7 @@ func (d *Driver) queryConnWithMongosh(ctx context.Context, statement string, quecontent, err := io.ReadAll(f)if err != nil {- return nil, errors.Wrapf(err, "failed to read file: %s", queryResultFileName)+ return nil, errors.Wrapf(err, "failed to read file: %s", queryResultFile.Name())}if simpleStatement {diff --git a/backend/plugin/db/mongodb/mongodb_test.go b/backend/plugin/db/mongodb/mongodb_test.goindex 5d07b1246a..1f662a76bb 100644--- a/backend/plugin/db/mongodb/mongodb_test.go+++ b/backend/plugin/db/mongodb/mongodb_test.go@@ -2,6 +2,8 @@ package mongodbimport ("fmt"+ "os"+ "path/filepath""testing""github.com/google/go-cmp/cmp"@@ -179,6 +181,48 @@ func TestIsMongoStatement(t *testing.T) {}}+func TestBuildMongoshBaseArgsUsesTempDirForTLSFiles(t *testing.T) {+ driver := &Driver{+ connCfg: db.ConnectionConfig{+ DataSource: &storepb.DataSource{+ Host: "localhost",+ Port: "27017",+ UseSsl: true,+ VerifyTlsCertificate: false,+ SslCa: "ca-pem",+ SslCert: "cert-pem",+ SslKey: "key-pem",+ },+ },+ }++ args, cleanup, err := driver.buildMongoshBaseArgs()+ require.NoError(t, err)+ defer cleanup()++ var caFile, clientCertFile string+ for i := 0; i < len(args)-1; i++ {+ switch args[i] {+ case "--tlsCAFile":+ caFile = args[i+1]+ case "--tlsCertificateKeyFile":+ clientCertFile = args[i+1]+ default:+ }+ }++ require.NotEmpty(t, caFile)+ require.NotEmpty(t, clientCertFile)+ require.Equal(t, filepath.Clean(os.TempDir()), filepath.Clean(filepath.Dir(caFile)))+ require.Equal(t, filepath.Clean(os.TempDir()), filepath.Clean(filepath.Dir(clientCertFile)))+ require.FileExists(t, caFile)+ require.FileExists(t, clientCertFile)++ cleanup()+ require.NoFileExists(t, caFile)+ require.NoFileExists(t, clientCertFile)+}+func TestGetSimpleStatementResult(t *testing.T) {testData1 := `{"_id": {diff --git a/backend/plugin/db/util/ssl.go b/backend/plugin/db/util/ssl.goindex 1efcce7467..e645d19dba 100644--- a/backend/plugin/db/util/ssl.go+++ b/backend/plugin/db/util/ssl.go@@ -4,17 +4,82 @@ package utilimport ("crypto/tls""crypto/x509"+ "os"+ "path/filepath""github.com/pkg/errors"+ "google.golang.org/protobuf/proto"storepb "github.com/bytebase/bytebase/backend/generated-go/store")+func HasTLSPath(ds *storepb.DataSource) bool {+ if ds == nil {+ return false+ }+ return ds.GetSslCaPath() != "" || ds.GetSslCertPath() != "" || ds.GetSslKeyPath() != ""+}++func ResolveTLSMaterial(ds *storepb.DataSource) (*storepb.DataSource, error) {+ if ds == nil {+ return nil, nil+ }+ resolved := proto.Clone(ds).(*storepb.DataSource)+ if !resolved.GetUseSsl() || !HasTLSPath(resolved) {+ return resolved, nil+ }++ if resolved.GetSslCaPath() != "" {+ content, err := readTLSPathFile("CA certificate", resolved.GetSslCaPath())+ if err != nil {+ return nil, err+ }+ resolved.SslCa = content+ resolved.SslCaPath = ""+ }+ if resolved.GetSslCertPath() != "" {+ content, err := readTLSPathFile("client certificate", resolved.GetSslCertPath())+ if err != nil {+ return nil, err+ }+ resolved.SslCert = content+ resolved.SslCertPath = ""+ }+ if resolved.GetSslKeyPath() != "" {+ content, err := readTLSPathFile("client key", resolved.GetSslKeyPath())+ if err != nil {+ return nil, err+ }+ resolved.SslKey = content+ resolved.SslKeyPath = ""+ }++ return resolved, nil+}++func readTLSPathFile(label, path string) (string, error) {+ if !filepath.IsAbs(path) {+ return "", errors.Errorf("%s path must be absolute", label)+ }+ content, err := os.ReadFile(path)+ if err != nil {+ return "", errors.Errorf("failed to read %s file", label)+ }+ if len(content) == 0 {+ return "", errors.Errorf("%s file is empty", label)+ }+ return string(content), nil+}+// GetTLSConfig gets the TLS config for connection.+// The datasource must already have path-backed TLS material resolved via ResolveTLSMaterial.func GetTLSConfig(ds *storepb.DataSource) (*tls.Config, error) {if !ds.GetUseSsl() {return nil, nil}+ if HasTLSPath(ds) {+ return nil, errors.New("TLS material must be resolved before building TLS config")+ }cfg := &tls.Config{}diff --git a/backend/plugin/db/util/ssl_test.go b/backend/plugin/db/util/ssl_test.gonew file mode 100644index 0000000000..bc29b8b996--- /dev/null+++ b/backend/plugin/db/util/ssl_test.go@@ -0,0 +1,112 @@+//nolint:revive+package util++import (+ "os"+ "path/filepath"+ "strings"+ "testing"++ "github.com/stretchr/testify/require"++ storepb "github.com/bytebase/bytebase/backend/generated-go/store"+)++func TestResolveTLSMaterialReadsPathFields(t *testing.T) {+ dir := t.TempDir()+ caPath := filepath.Join(dir, "ca.pem")+ certPath := filepath.Join(dir, "cert.pem")+ keyPath := filepath.Join(dir, "key.pem")+ require.NoError(t, os.WriteFile(caPath, []byte("ca-pem"), 0o600))+ require.NoError(t, os.WriteFile(certPath, []byte("cert-pem"), 0o600))+ require.NoError(t, os.WriteFile(keyPath, []byte("key-pem"), 0o600))++ ds := &storepb.DataSource{+ UseSsl: true,+ SslCa: "stale-ca",+ SslCert: "stale-cert",+ SslKey: "stale-key",+ SslCaPath: caPath,+ SslCertPath: certPath,+ SslKeyPath: keyPath,+ }++ resolved, err := ResolveTLSMaterial(ds)+ require.NoError(t, err)+ require.Equal(t, "ca-pem", resolved.GetSslCa())+ require.Equal(t, "cert-pem", resolved.GetSslCert())+ require.Equal(t, "key-pem", resolved.GetSslKey())+ require.Equal(t, "stale-ca", ds.GetSslCa())+ require.Equal(t, caPath, ds.GetSslCaPath())+ require.Equal(t, certPath, ds.GetSslCertPath())+ require.Equal(t, keyPath, ds.GetSslKeyPath())+ require.Empty(t, resolved.GetSslCaPath())+ require.Empty(t, resolved.GetSslCertPath())+ require.Empty(t, resolved.GetSslKeyPath())+}++func TestResolveTLSMaterialPreservesInlineCrossSlotMaterial(t *testing.T) {+ dir := t.TempDir()+ keyPath := filepath.Join(dir, "key.pem")+ require.NoError(t, os.WriteFile(keyPath, []byte("path-key"), 0o600))++ ds := &storepb.DataSource{+ UseSsl: true,+ SslCa: "inline-ca",+ SslCert: "inline-cert",+ SslKeyPath: keyPath,+ }++ resolved, err := ResolveTLSMaterial(ds)+ require.NoError(t, err)+ require.NotSame(t, ds, resolved)+ require.Equal(t, "inline-ca", resolved.GetSslCa())+ require.Equal(t, "inline-cert", resolved.GetSslCert())+ require.Equal(t, "path-key", resolved.GetSslKey())+ require.Empty(t, resolved.GetSslKeyPath())+ require.Equal(t, keyPath, ds.GetSslKeyPath())+ require.Equal(t, "inline-ca", ds.GetSslCa())+ require.Equal(t, "inline-cert", ds.GetSslCert())+ require.Empty(t, ds.GetSslKey())+}++func TestResolveTLSMaterialRejectsRelativePath(t *testing.T) {+ _, err := ResolveTLSMaterial(&storepb.DataSource{+ UseSsl: true,+ SslCaPath: "relative-ca.pem",+ })+ require.Error(t, err)+ require.Contains(t, err.Error(), "CA certificate path must be absolute")+ require.NotContains(t, err.Error(), "relative-ca.pem")+}++func TestResolveTLSMaterialRedactsReadErrors(t *testing.T) {+ missingPath := filepath.Join(t.TempDir(), "missing.pem")+ _, err := ResolveTLSMaterial(&storepb.DataSource{+ UseSsl: true,+ SslCaPath: missingPath,+ })+ require.Error(t, err)+ require.Contains(t, err.Error(), "failed to read CA certificate file")+ require.False(t, strings.Contains(err.Error(), missingPath), err.Error())+ require.NotContains(t, err.Error(), "no such file")+}++func TestGetTLSConfigRequiresResolvedTLSMaterial(t *testing.T) {+ _, err := GetTLSConfig(&storepb.DataSource{+ UseSsl: true,+ SslCaPath: filepath.Join(t.TempDir(), "missing.pem"),+ })+ require.Error(t, err)+ require.Contains(t, err.Error(), "TLS material must be resolved before building TLS config")+ require.NotContains(t, err.Error(), "failed to read CA certificate file")+}++func TestGetTLSConfigIgnoresUnresolvedTLSMaterialWhenDisabled(t *testing.T) {+ tlsConfig, err := GetTLSConfig(&storepb.DataSource{+ UseSsl: false,+ SslCaPath: filepath.Join(t.TempDir(), "missing.pem"),+ })+ require.NoError(t, err)+ require.Nil(t, tlsConfig)+}diff --git a/backend/store/instance.go b/backend/store/instance.goindex 9699f4a965..68079ef3fe 100644--- a/backend/store/instance.go+++ b/backend/store/instance.go@@ -357,10 +357,16 @@ func (s *Store) obfuscateInstance(ctx context.Context, instance *storepb.Instancds.Password = ""ds.ObfuscatedSslCa = common.Obfuscate(ds.GetSslCa(), secret)ds.SslCa = ""+ ds.ObfuscatedSslCaPath = common.Obfuscate(ds.GetSslCaPath(), secret)+ ds.SslCaPath = ""ds.ObfuscatedSslCert = common.Obfuscate(ds.GetSslCert(), secret)ds.SslCert = ""+ ds.ObfuscatedSslCertPath = common.Obfuscate(ds.GetSslCertPath(), secret)+ ds.SslCertPath = ""ds.ObfuscatedSslKey = common.Obfuscate(ds.GetSslKey(), secret)ds.SslKey = ""+ ds.ObfuscatedSslKeyPath = common.Obfuscate(ds.GetSslKeyPath(), secret)+ ds.SslKeyPath = ""ds.ObfuscatedSshPassword = common.Obfuscate(ds.GetSshPassword(), secret)ds.SshPassword = ""ds.ObfuscatedSshPrivateKey = common.Obfuscate(ds.GetSshPrivateKey(), secret)@@ -422,18 +428,33 @@ func (s *Store) deobfuscateInstances(ctx context.Context, instances []*InstanceMreturn err}ds.SslCa = sslCa+ sslCaPath, err := common.Unobfuscate(ds.GetObfuscatedSslCaPath(), secret)+ if err != nil {+ return err+ }+ ds.SslCaPath = sslCaPathsslCert, err := common.Unobfuscate(ds.GetObfuscatedSslCert(), secret)if err != nil {return err}ds.SslCert = sslCert+ sslCertPath, err := common.Unobfuscate(ds.GetObfuscatedSslCertPath(), secret)+ if err != nil {+ return err+ }+ ds.SslCertPath = sslCertPathsslKey, err := common.Unobfuscate(ds.GetObfuscatedSslKey(), secret)if err != nil {return err}ds.SslKey = sslKey+ sslKeyPath, err := common.Unobfuscate(ds.GetObfuscatedSslKeyPath(), secret)+ if err != nil {+ return err+ }+ ds.SslKeyPath = sslKeyPathsshPassword, err := common.Unobfuscate(ds.GetObfuscatedSshPassword(), secret)if err != nil {diff --git a/docs/superpowers/plans/2026-04-20-instance-tls-file-path.md b/docs/superpowers/plans/2026-04-20-instance-tls-file-path.mdnew file mode 100644index 0000000000..584eb6daf8--- /dev/null+++ b/docs/superpowers/plans/2026-04-20-instance-tls-file-path.md@@ -0,0 +1,1279 @@+# Instance TLS File Path Implementation Plan++> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.++**Goal:** Add local filesystem TLS material paths for instance data sources while keeping `use_ssl` as the persisted/API compatibility switch.++**Architecture:** Add path fields as an additive proto/API change, infer the effective TLS source from `use_ssl` plus path presence, and resolve file paths to PEM content before database drivers consume TLS settings. Validate and normalize API writes so mixed explicit inline/path submissions are rejected while source switches clear inactive stored material.++**Tech Stack:** Go, protobuf/buf, Connect RPC, Bytebase store JSONB proto metadata, React, TypeScript, Vitest.++---++### Task 1: Proto Schema And Generated Code++**Files:**+- Modify: `proto/store/store/instance.proto`+- Modify: `proto/v1/v1/instance_service.proto`+- Generated by `cd proto && buf generate`: `backend/generated-go/store/instance.pb.go`+- Generated by `cd proto && buf generate`: `backend/generated-go/store/instance_equal.pb.go`+- Generated by `cd proto && buf generate`: `backend/generated-go/v1/instance_service.pb.go`+- Generated by `cd proto && buf generate`: `backend/generated-go/v1/instance_service_equal.pb.go`+- Generated by `cd proto && buf generate`: `frontend/src/types/proto-es/store/instance_pb.ts`+- Generated by `cd proto && buf generate`: `frontend/src/types/proto-es/v1/instance_service_pb.ts`+- Generated by `cd proto && buf generate`: `frontend/src/types/proto-es/v1/instance_service_pb.d.ts`++- [ ] **Step 1: Add store path fields**++In `proto/store/store/instance.proto`, insert these fields immediately after `obfuscated_ssl_key = 7;`:++```proto+ string ssl_ca_path = 50;+ string obfuscated_ssl_ca_path = 51;+ string ssl_cert_path = 52;+ string obfuscated_ssl_cert_path = 53;+ string ssl_key_path = 54;+ string obfuscated_ssl_key_path = 55;+```++- [ ] **Step 2: Add v1 API path fields and presence flags**++In `proto/v1/v1/instance_service.proto`, insert these fields immediately after `ssl_key = 7`:++```proto+ // The local filesystem path to the SSL certificate authority certificate.+ string ssl_ca_path = 41 [(google.api.field_behavior) = INPUT_ONLY];+ // The local filesystem path to the SSL client certificate.+ string ssl_cert_path = 42 [(google.api.field_behavior) = INPUT_ONLY];+ // The local filesystem path to the SSL client private key.+ string ssl_key_path = 43 [(google.api.field_behavior) = INPUT_ONLY];+ // Whether an SSL certificate authority path has been configured.+ bool has_ssl_ca_path = 44 [(google.api.field_behavior) = OUTPUT_ONLY];+ // Whether an SSL client certificate path has been configured.+ bool has_ssl_cert_path = 45 [(google.api.field_behavior) = OUTPUT_ONLY];+ // Whether an SSL client private key path has been configured.+ bool has_ssl_key_path = 46 [(google.api.field_behavior) = OUTPUT_ONLY];+```++- [ ] **Step 3: Format and lint proto**++Run:++```bash+buf format -w proto+buf lint proto+```++Expected: both commands exit 0.++- [ ] **Step 4: Regenerate proto outputs**++Run:++```bash+cd proto && buf generate+```++Expected: command exits 0 and generated Go/TypeScript files include `SslCaPath`, `SslCertPath`, `SslKeyPath`, `HasSslCaPath`, `HasSslCertPath`, and `HasSslKeyPath`.++- [ ] **Step 5: Commit proto changes**++Run:++```bash+git add proto/store/store/instance.proto proto/v1/v1/instance_service.proto backend/generated-go/store/instance.pb.go backend/generated-go/store/instance_equal.pb.go backend/generated-go/v1/instance_service.pb.go backend/generated-go/v1/instance_service_equal.pb.go frontend/src/types/proto-es/store/instance_pb.ts frontend/src/types/proto-es/v1/instance_service_pb.ts frontend/src/types/proto-es/v1/instance_service_pb.d.ts+git commit -m "feat(instance): add TLS path fields"+```++### Task 2: Store Obfuscation, API Conversion, And Audit Redaction++**Files:**+- Modify: `backend/store/instance.go`+- Modify: `backend/api/v1/instance_service_converter.go`+- Modify: `backend/api/v1/instance_service.go`+- Modify: `backend/api/v1/audit.go`++- [ ] **Step 1: Obfuscate path fields before persistence**++In `backend/store/instance.go`, update `obfuscateInstance()` after the existing SSL key obfuscation:++```go+ ds.ObfuscatedSslCaPath = common.Obfuscate(ds.GetSslCaPath(), secret)+ ds.SslCaPath = ""+ ds.ObfuscatedSslCertPath = common.Obfuscate(ds.GetSslCertPath(), secret)+ ds.SslCertPath = ""+ ds.ObfuscatedSslKeyPath = common.Obfuscate(ds.GetSslKeyPath(), secret)+ ds.SslKeyPath = ""+```++- [ ] **Step 2: Deobfuscate path fields on read**++In `backend/store/instance.go`, update `deobfuscateInstances()` after existing SSL key deobfuscation:++```go+ sslCaPath, err := common.Unobfuscate(ds.GetObfuscatedSslCaPath(), secret)+ if err != nil {+ return err+ }+ ds.SslCaPath = sslCaPath++ sslCertPath, err := common.Unobfuscate(ds.GetObfuscatedSslCertPath(), secret)+ if err != nil {+ return err+ }+ ds.SslCertPath = sslCertPath++ sslKeyPath, err := common.Unobfuscate(ds.GetObfuscatedSslKeyPath(), secret)+ if err != nil {+ return err+ }+ ds.SslKeyPath = sslKeyPath+```++- [ ] **Step 3: Map v1 path inputs into store data sources**++In `backend/api/v1/instance_service_converter.go`, add these assignments to `convertV1DataSource()` next to the existing inline SSL assignments:++```go+ SslCaPath: dataSource.SslCaPath,+ SslCertPath: dataSource.SslCertPath,+ SslKeyPath: dataSource.SslKeyPath,+```++- [ ] **Step 4: Return path presence flags only**++In `backend/api/v1/instance_service_converter.go`, update `convertDataSources()` to populate presence flags and keep path strings empty:++```go+ HasSslCaPath: ds.GetSslCaPath() != "",+ HasSslCertPath: ds.GetSslCertPath() != "",+ HasSslKeyPath: ds.GetSslKeyPath() != "",+```++Keep `SslCaPath`, `SslCertPath`, and `SslKeyPath` unset in responses because they are input-only.++- [ ] **Step 5: Accept path fields in update masks**++In `backend/api/v1/instance_service.go`, add these cases in `UpdateDataSource()` next to the existing SSL mask cases:++```go+ case "ssl_ca_path":+ dataSource.SslCaPath = req.Msg.DataSource.SslCaPath+ case "ssl_cert_path":+ dataSource.SslCertPath = req.Msg.DataSource.SslCertPath+ case "ssl_key_path":+ dataSource.SslKeyPath = req.Msg.DataSource.SslKeyPath+```++- [ ] **Step 6: Redact path fields in audit payloads**++In `backend/api/v1/audit.go`, update `redactDataSource()` after inline SSL redaction:++```go+ if cloned.SslCaPath != "" {+ cloned.SslCaPath = maskedString+ }+ if cloned.SslCertPath != "" {+ cloned.SslCertPath = maskedString+ }+ if cloned.SslKeyPath != "" {+ cloned.SslKeyPath = maskedString+ }+```++- [ ] **Step 7: Format and test the touched packages**++Run:++```bash+gofmt -w backend/store/instance.go backend/api/v1/instance_service_converter.go backend/api/v1/instance_service.go backend/api/v1/audit.go+go test ./backend/store ./backend/api/v1 -run 'TestAudit|TestObfuscate|TestCommon' -count=1+```++Expected: gofmt changes are applied and tests exit 0. If the targeted `-run` expression matches no tests in a package, rerun that package without `-run` before committing.++- [ ] **Step 8: Commit store/API mapping**++Run:++```bash+git add backend/store/instance.go backend/api/v1/instance_service_converter.go backend/api/v1/instance_service.go backend/api/v1/audit.go+git commit -m "feat(instance): persist TLS path fields"+```++### Task 3: TLS Material Resolution++**Files:**+- Create: `backend/plugin/db/util/ssl_test.go`+- Modify: `backend/plugin/db/util/ssl.go`+- Modify: `backend/component/dbfactory/dbfactory.go`++- [ ] **Step 1: Write failing tests for path resolution**++Create `backend/plugin/db/util/ssl_test.go` with these tests:++```go+package util++import (+ "os"+ "path/filepath"+ "strings"+ "testing"++ "github.com/stretchr/testify/require"++ storepb "github.com/bytebase/bytebase/backend/generated-go/store"+)++func TestResolveTLSMaterialReadsPathFields(t *testing.T) {+ dir := t.TempDir()+ caPath := filepath.Join(dir, "ca.pem")+ certPath := filepath.Join(dir, "cert.pem")+ keyPath := filepath.Join(dir, "key.pem")+ require.NoError(t, os.WriteFile(caPath, []byte("ca-pem"), 0600))+ require.NoError(t, os.WriteFile(certPath, []byte("cert-pem"), 0600))+ require.NoError(t, os.WriteFile(keyPath, []byte("key-pem"), 0600))++ ds := &storepb.DataSource{+ UseSsl: true,+ SslCa: "stale-ca",+ SslCert: "stale-cert",+ SslKey: "stale-key",+ SslCaPath: caPath,+ SslCertPath: certPath,+ SslKeyPath: keyPath,+ }++ resolved, err := ResolveTLSMaterial(ds)+ require.NoError(t, err)+ require.Equal(t, "ca-pem", resolved.GetSslCa())+ require.Equal(t, "cert-pem", resolved.GetSslCert())+ require.Equal(t, "key-pem", resolved.GetSslKey())+ require.Equal(t, "stale-ca", ds.GetSslCa())+}++func TestResolveTLSMaterialRejectsRelativePath(t *testing.T) {+ _, err := ResolveTLSMaterial(&storepb.DataSource{+ UseSsl: true,+ SslCaPath: "relative-ca.pem",+ })+ require.Error(t, err)+ require.Contains(t, err.Error(), "CA certificate path must be absolute")+ require.NotContains(t, err.Error(), "relative-ca.pem")+}++func TestResolveTLSMaterialRedactsReadErrors(t *testing.T) {+ missingPath := filepath.Join(t.TempDir(), "missing.pem")+ _, err := ResolveTLSMaterial(&storepb.DataSource{+ UseSsl: true,+ SslCaPath: missingPath,+ })+ require.Error(t, err)+ require.Contains(t, err.Error(), "failed to read CA certificate file")+ require.False(t, strings.Contains(err.Error(), missingPath), err.Error())+ require.NotContains(t, err.Error(), "no such file")+}+```++- [ ] **Step 2: Run the new tests to verify failure**++Run:++```bash+go test ./backend/plugin/db/util -run 'TestResolveTLSMaterial' -count=1+```++Expected: FAIL because `ResolveTLSMaterial` is undefined.++- [ ] **Step 3: Implement TLS path helpers and resolution**++In `backend/plugin/db/util/ssl.go`, add imports:++```go+ "os"+ "path/filepath"++ "google.golang.org/protobuf/proto"+```++Add these helpers above `GetTLSConfig()`:++```go+func HasTLSPath(ds *storepb.DataSource) bool {+ return ds.GetSslCaPath() != "" || ds.GetSslCertPath() != "" || ds.GetSslKeyPath() != ""+}++func ResolveTLSMaterial(ds *storepb.DataSource) (*storepb.DataSource, error) {+ resolved := proto.CloneOf(ds)+ if !resolved.GetUseSsl() || !HasTLSPath(resolved) {+ return resolved, nil+ }++ if resolved.GetSslCaPath() != "" {+ content, err := readTLSPathFile("CA certificate", resolved.GetSslCaPath())+ if err != nil {+ return nil, err+ }+ resolved.SslCa = content+ }+ if resolved.GetSslCertPath() != "" {+ content, err := readTLSPathFile("client certificate", resolved.GetSslCertPath())+ if err != nil {+ return nil, err+ }+ resolved.SslCert = content+ }+ if resolved.GetSslKeyPath() != "" {+ content, err := readTLSPathFile("client key", resolved.GetSslKeyPath())+ if err != nil {+ return nil, err+ }+ resolved.SslKey = content+ }+ return resolved, nil+}++func readTLSPathFile(label, path string) (string, error) {+ if !filepath.IsAbs(path) {+ return "", errors.Errorf("%s path must be absolute", label)+ }+ content, err := os.ReadFile(path)+ if err != nil {+ return "", errors.Errorf("failed to read %s file", label)+ }+ if len(content) == 0 {+ return "", errors.Errorf("%s file is empty", label)+ }+ return string(content), nil+}+```++- [ ] **Step 4: Make GetTLSConfig resolve file paths**++At the start of `GetTLSConfig()` in `backend/plugin/db/util/ssl.go`, replace direct use of the input data source:++```go+func GetTLSConfig(ds *storepb.DataSource) (*tls.Config, error) {+ resolved, err := ResolveTLSMaterial(ds)+ if err != nil {+ return nil, err+ }+ ds = resolved+ if !ds.GetUseSsl() {+ return nil, nil+ }+```++- [ ] **Step 5: Resolve once in DBFactory for drivers that inspect raw SSL fields**++In `backend/component/dbfactory/dbfactory.go`, add an import alias:++```go+ dbutil "github.com/bytebase/bytebase/backend/plugin/db/util"+```++Before `db.Open(...)`, resolve the data source:++```go+ resolvedDataSource, err := dbutil.ResolveTLSMaterial(dataSource)+ if err != nil {+ return nil, err+ }++ driver, err := db.Open(+ ctx,+ instance.Metadata.GetEngine(),+ db.ConnectionConfig{+ DataSource: resolvedDataSource,+ ConnectionContext: connectionContext,+ Password: password,+ },+ )+```++- [ ] **Step 6: Run TLS resolution tests**++Run:++```bash+gofmt -w backend/plugin/db/util/ssl.go backend/plugin/db/util/ssl_test.go backend/component/dbfactory/dbfactory.go+go test ./backend/plugin/db/util ./backend/component/dbfactory -run 'TestResolveTLSMaterial' -count=1+```++Expected: tests exit 0.++- [ ] **Step 7: Commit TLS resolution**++Run:++```bash+git add backend/plugin/db/util/ssl.go backend/plugin/db/util/ssl_test.go backend/component/dbfactory/dbfactory.go+git commit -m "feat(instance): resolve TLS path material"+```++### Task 4: API TLS Validation And Normalization++**Files:**+- Create: `backend/api/v1/instance_service_tls_test.go`+- Modify: `backend/api/v1/instance_service.go`++- [ ] **Step 1: Add focused unit tests for TLS write semantics**++Create `backend/api/v1/instance_service_tls_test.go` with helper-level tests in package `v1`:++```go+package v1++import (+ "testing"++ "github.com/stretchr/testify/require"+ "google.golang.org/protobuf/types/known/fieldmaskpb"++ storepb "github.com/bytebase/bytebase/backend/generated-go/store"+)++func TestValidateDataSourceTLSWriteRejectsMixedExplicitMaterial(t *testing.T) {+ err := validateDataSourceTLSWrite(+ &storepb.DataSource{UseSsl: true, SslCa: "inline-ca", SslCaPath: "/tmp/ca.pem"},+ &storepb.DataSource{UseSsl: true, SslCa: "inline-ca", SslCaPath: "/tmp/ca.pem"},+ []string{"ssl_ca", "ssl_ca_path"},+ )+ require.Error(t, err)+ require.Contains(t, err.Error(), "cannot set both inline TLS material and TLS file paths")+}++func TestNormalizeDataSourceTLSClearsInlineWhenPathWins(t *testing.T) {+ ds := &storepb.DataSource{+ UseSsl: true,+ SslCa: "inline-ca",+ SslCert: "inline-cert",+ SslKey: "inline-key",+ SslCaPath: "/tmp/ca.pem",+ }+ normalizeDataSourceTLS(ds, []string{"ssl_ca_path"})+ require.Empty(t, ds.GetSslCa())+ require.Empty(t, ds.GetSslCert())+ require.Empty(t, ds.GetSslKey())+ require.Equal(t, "/tmp/ca.pem", ds.GetSslCaPath())+}++func TestNormalizeDataSourceTLSClearsPathsWhenSwitchingToInline(t *testing.T) {+ ds := &storepb.DataSource{+ UseSsl: true,+ SslCa: "inline-ca",+ SslCaPath: "",+ SslCertPath: "",+ SslKeyPath: "",+ }+ normalizeDataSourceTLS(ds, []string{"ssl_ca", "ssl_ca_path", "ssl_cert_path", "ssl_key_path"})+ require.Equal(t, "inline-ca", ds.GetSslCa())+ require.Empty(t, ds.GetSslCaPath())+ require.Empty(t, ds.GetSslCertPath())+ require.Empty(t, ds.GetSslKeyPath())+}++func TestNormalizeDataSourceTLSClearsAllWhenDisabled(t *testing.T) {+ ds := &storepb.DataSource{+ UseSsl: false,+ SslCa: "inline-ca",+ SslCert: "inline-cert",+ SslKey: "inline-key",+ SslCaPath: "/tmp/ca.pem",+ SslCertPath: "/tmp/cert.pem",+ SslKeyPath: "/tmp/key.pem",+ }+ normalizeDataSourceTLS(ds, []string{"use_ssl"})+ require.Empty(t, ds.GetSslCa())+ require.Empty(t, ds.GetSslCert())+ require.Empty(t, ds.GetSslKey())+ require.Empty(t, ds.GetSslCaPath())+ require.Empty(t, ds.GetSslCertPath())+ require.Empty(t, ds.GetSslKeyPath())+}++func TestTLSMaskPaths(t *testing.T) {+ mask := &fieldmaskpb.FieldMask{Paths: []string{"ssl_ca_path", "host"}}+ require.True(t, tlsMaskContains(mask.GetPaths(), "ssl_ca_path"))+ require.False(t, tlsMaskContains(mask.GetPaths(), "ssl_cert_path"))+}+```++- [ ] **Step 2: Run tests to verify failure**++Run:++```bash+go test ./backend/api/v1 -run 'TestValidateDataSourceTLSWrite|TestNormalizeDataSourceTLS|TestTLSMaskPaths' -count=1+```++Expected: FAIL because helper functions are undefined.++- [ ] **Step 3: Add TLS helper functions**++In `backend/api/v1/instance_service.go`, add imports:++```go+ "crypto/tls"+ "crypto/x509"+ "path/filepath"+```++Add these helpers near `checkInstanceDataSources()`:++```go+func hasInlineTLSMaterial(ds *storepb.DataSource) bool {+ return ds.GetSslCa() != "" || ds.GetSslCert() != "" || ds.GetSslKey() != ""+}++func hasPathTLSMaterial(ds *storepb.DataSource) bool {+ return ds.GetSslCaPath() != "" || ds.GetSslCertPath() != "" || ds.GetSslKeyPath() != ""+}++func hasExplicitInlineTLSMaterial(ds *storepb.DataSource, mask []string) bool {+ return (tlsMaskContains(mask, "ssl_ca") && ds.GetSslCa() != "") ||+ (tlsMaskContains(mask, "ssl_cert") && ds.GetSslCert() != "") ||+ (tlsMaskContains(mask, "ssl_key") && ds.GetSslKey() != "")+}++func hasExplicitPathTLSMaterial(ds *storepb.DataSource, mask []string) bool {+ return (tlsMaskContains(mask, "ssl_ca_path") && ds.GetSslCaPath() != "") ||+ (tlsMaskContains(mask, "ssl_cert_path") && ds.GetSslCertPath() != "") ||+ (tlsMaskContains(mask, "ssl_key_path") && ds.GetSslKeyPath() != "")+}++func tlsMaskContains(mask []string, field string) bool {+ for _, path := range mask {+ if path == field {+ return true+ }+ }+ return false+}++func validateDataSourceTLSWrite(requested, merged *storepb.DataSource, mask []string) error {+ if hasExplicitInlineTLSMaterial(requested, mask) && hasExplicitPathTLSMaterial(requested, mask) {+ return errors.Errorf("cannot set both inline TLS material and TLS file paths")+ }+ if hasPathTLSMaterial(merged) && hasExplicitInlineTLSMaterial(requested, mask) {+ return errors.Errorf("cannot set inline TLS material while TLS file paths are configured")+ }+ return validateDataSourceTLSConfig(merged)+}++func validateDataSourceTLSConfig(ds *storepb.DataSource) error {+ if !ds.GetUseSsl() {+ return nil+ }+ if hasPathTLSMaterial(ds) {+ for label, path := range map[string]string{+ "ssl_ca_path": ds.GetSslCaPath(),+ "ssl_cert_path": ds.GetSslCertPath(),+ "ssl_key_path": ds.GetSslKeyPath(),+ } {+ if path != "" && !filepath.IsAbs(path) {+ return errors.Errorf("%s must be an absolute path", label)+ }+ }+ return nil+ }+ if ds.GetSslCa() != "" {+ pool := x509.NewCertPool()+ if ok := pool.AppendCertsFromPEM([]byte(ds.GetSslCa())); !ok {+ return errors.Errorf("invalid ssl_ca PEM")+ }+ }+ if (ds.GetSslCert() == "") != (ds.GetSslKey() == "") {+ return errors.Errorf("ssl_cert and ssl_key must be both set or unset")+ }+ if ds.GetSslCert() != "" {+ if _, err := tls.X509KeyPair([]byte(ds.GetSslCert()), []byte(ds.GetSslKey())); err != nil {+ return errors.Wrap(err, "invalid ssl_cert or ssl_key PEM")+ }+ }+ return nil+}++func normalizeDataSourceTLS(ds *storepb.DataSource, _ []string) {+ if !ds.GetUseSsl() {+ clearInlineTLSMaterial(ds)+ clearPathTLSMaterial(ds)+ return+ }+ if hasPathTLSMaterial(ds) {+ clearInlineTLSMaterial(ds)+ return+ }+ clearPathTLSMaterial(ds)+}++func clearInlineTLSMaterial(ds *storepb.DataSource) {+ ds.SslCa = ""+ ds.SslCert = ""+ ds.SslKey = ""+}++func clearPathTLSMaterial(ds *storepb.DataSource) {+ ds.SslCaPath = ""+ ds.SslCertPath = ""+ ds.SslKeyPath = ""+}+```++- [ ] **Step 4: Validate and normalize add data source**++In `AddDataSource()`, after `checkDataSource()` and before appending to metadata, add:++```go+ if err := validateDataSourceTLSWrite(dataSource, dataSource, []string{+ "use_ssl",+ "ssl_ca",+ "ssl_cert",+ "ssl_key",+ "ssl_ca_path",+ "ssl_cert_path",+ "ssl_key_path",+ }); err != nil {+ return nil, connect.NewError(connect.CodeInvalidArgument, err)+ }+ normalizeDataSourceTLS(dataSource, nil)+```++- [ ] **Step 5: Validate and normalize update data source**++In `UpdateDataSource()`, after the update-mask loop and `clearDataSourceAuthentication(dataSource)`, add:++```go+ if err := validateDataSourceTLSWrite(req.Msg.DataSource, dataSource, req.Msg.UpdateMask.GetPaths()); err != nil {+ return nil, connect.NewError(connect.CodeInvalidArgument, err)+ }+ normalizeDataSourceTLS(dataSource, req.Msg.UpdateMask.GetPaths())+```++Keep this before `s.checkInstanceDataSources(...)`.++- [ ] **Step 6: Add update-mask support tests for path cases**++Extend `backend/api/v1/instance_service_tls_test.go` with:++```go+func TestValidateDataSourceTLSWriteRejectsInactiveInlineWithExistingPath(t *testing.T) {+ err := validateDataSourceTLSWrite(+ &storepb.DataSource{UseSsl: true, SslCa: "inline-ca"},+ &storepb.DataSource{UseSsl: true, SslCa: "inline-ca", SslCaPath: "/tmp/ca.pem"},+ []string{"ssl_ca"},+ )+ require.Error(t, err)+ require.Contains(t, err.Error(), "cannot set inline TLS material while TLS file paths are configured")+}++func TestValidateDataSourceTLSConfigRejectsRelativePath(t *testing.T) {+ err := validateDataSourceTLSConfig(&storepb.DataSource{UseSsl: true, SslCaPath: "ca.pem"})+ require.Error(t, err)+ require.Contains(t, err.Error(), "ssl_ca_path must be an absolute path")+}+```++- [ ] **Step 7: Run API TLS tests**++Run:++```bash+gofmt -w backend/api/v1/instance_service.go backend/api/v1/instance_service_tls_test.go+go test ./backend/api/v1 -run 'TestValidateDataSourceTLSWrite|TestNormalizeDataSourceTLS|TestTLSMaskPaths|TestValidateDataSourceTLSConfig' -count=1+```++Expected: tests exit 0.++- [ ] **Step 8: Commit API TLS validation**++Run:++```bash+git add backend/api/v1/instance_service.go backend/api/v1/instance_service_tls_test.go+git commit -m "fix(instance): validate TLS path writes"+```++### Task 5: Driver And Component TLS Consumers++**Files:**+- Create: `backend/component/ghost/config_test.go`+- Modify: `backend/component/ghost/config.go`+- Modify: `backend/plugin/db/elasticsearch/elasticsearch.go`+- Modify: `backend/plugin/db/elasticsearch/elasticsearch_test.go`+- Modify: `backend/plugin/db/mongodb/mongodb.go`+- Modify: `backend/plugin/db/mongodb/mongodb_test.go`+- Modify: `backend/plugin/db/pg/pg.go`+- Modify: `backend/plugin/db/cockroachdb/cockroachdb.go`++- [ ] **Step 1: Add gh-ost temp-file test**++Create `backend/component/ghost/config_test.go`:++```go+package ghost++import (+ "os"+ "testing"++ "github.com/stretchr/testify/require"++ storepb "github.com/bytebase/bytebase/backend/generated-go/store"+ storepkg "github.com/bytebase/bytebase/backend/store"+)++func TestGetMigrationContextWritesTLSMaterialToFiles(t *testing.T) {+ caPEM, certPEM, keyPEM := generateTLSPEMForGhostTest(t)+ instance := &storepkg.InstanceMessage{+ Metadata: &storepb.Instance{+ Engine: storepb.Engine_MYSQL,+ DataSources: []*storepb.DataSource{{+ Type: storepb.DataSourceType_ADMIN,+ Host: "127.0.0.1",+ Port: "3306",+ Username: "root",+ UseSsl: true,+ VerifyTlsCertificate: true,+ SslCa: caPEM,+ SslCert: certPEM,+ SslKey: keyPEM,+ }},+ },+ }++ ctx, err := getMigrationContext(instance, "secret", &storepkg.DatabaseMessage{DatabaseName: "db"}, "tbl", "alter table tbl add column c int", true)+ require.NoError(t, err)+ require.True(t, ctx.UseTLS)+ require.False(t, ctx.TLSAllowInsecure)+ require.FileExists(t, ctx.TLSCACertificate)+ require.FileExists(t, ctx.TLSCertificate)+ require.FileExists(t, ctx.TLSKey)++ gotCA, err := os.ReadFile(ctx.TLSCACertificate)+ require.NoError(t, err)+ require.Equal(t, caPEM, string(gotCA))+}+```++Add a local `generateTLSPEMForGhostTest(t)` helper in the same file using `crypto/rsa`, `crypto/x509`, and `encoding/pem` to return a self-signed CA PEM, a leaf cert PEM, and a leaf key PEM.++Use this helper implementation:++```go+func generateTLSPEMForGhostTest(t *testing.T) (string, string, string) {+ t.Helper()+ caKey, err := rsa.GenerateKey(rand.Reader, 2048)+ require.NoError(t, err)+ caTemplate := &x509.Certificate{+ SerialNumber: big.NewInt(1),+ Subject: pkix.Name{CommonName: "test-ca"},+ NotBefore: time.Now().Add(-time.Hour),+ NotAfter: time.Now().Add(time.Hour),+ KeyUsage: x509.KeyUsageCertSign | x509.KeyUsageDigitalSignature,+ BasicConstraintsValid: true,+ IsCA: true,+ }+ caDER, err := x509.CreateCertificate(rand.Reader, caTemplate, caTemplate, &caKey.PublicKey, caKey)+ require.NoError(t, err)++ leafKey, err := rsa.GenerateKey(rand.Reader, 2048)+ require.NoError(t, err)+ leafTemplate := &x509.Certificate{+ SerialNumber: big.NewInt(2),+ Subject: pkix.Name{CommonName: "client"},+ NotBefore: time.Now().Add(-time.Hour),+ NotAfter: time.Now().Add(time.Hour),+ KeyUsage: x509.KeyUsageDigitalSignature,+ ExtKeyUsage: []x509.ExtKeyUsage{x509.ExtKeyUsageClientAuth},+ }+ leafDER, err := x509.CreateCertificate(rand.Reader, leafTemplate, caTemplate, &leafKey.PublicKey, caKey)+ require.NoError(t, err)++ caPEM := pem.EncodeToMemory(&pem.Block{Type: "CERTIFICATE", Bytes: caDER})+ certPEM := pem.EncodeToMemory(&pem.Block{Type: "CERTIFICATE", Bytes: leafDER})+ keyPEM := pem.EncodeToMemory(&pem.Block{Type: "RSA PRIVATE KEY", Bytes: x509.MarshalPKCS1PrivateKey(leafKey)})+ return string(caPEM), string(certPEM), string(keyPEM)+}+```++The file imports must include:++```go+ "crypto/rand"+ "crypto/rsa"+ "crypto/x509"+ "crypto/x509/pkix"+ "encoding/pem"+ "math/big"+ "time"+```++- [ ] **Step 2: Update gh-ost TLS setup**++In `backend/component/ghost/config.go`, import the DB TLS utility:++```go+ dbutil "github.com/bytebase/bytebase/backend/plugin/db/util"+```++Resolve path material before configuring gh-ost:++```go+ dataSource, err = dbutil.ResolveTLSMaterial(dataSource)+ if err != nil {+ return nil, err+ }+```++Replace direct PEM assignment with temp-file assignment:++```go+ migrationContext.UseTLS = true+ cleanup, err := configureGhostTLSFiles(migrationContext, dataSource)+ if err != nil {+ return nil, err+ }+ defer cleanup()+ migrationContext.TLSAllowInsecure = !dataSource.GetVerifyTlsCertificate()+```++Add helper functions in the same file:++```go+func configureGhostTLSFiles(migrationContext *ghostbase.MigrationContext, dataSource *storepb.DataSource) (func(), error) {+ var files []string+ write := func(pattern, content string) (string, error) {+ if content == "" {+ return "", nil+ }+ file, err := os.CreateTemp(os.TempDir(), pattern)+ if err != nil {+ return "", err+ }+ defer file.Close()+ if _, err := file.WriteString(content); err != nil {+ return "", err+ }+ files = append(files, file.Name())+ return file.Name(), nil+ }++ var err error+ if migrationContext.TLSCACertificate, err = write("ghost-tls-ca-*", dataSource.GetSslCa()); err != nil {+ return nil, err+ }+ if migrationContext.TLSCertificate, err = write("ghost-tls-cert-*", dataSource.GetSslCert()); err != nil {+ return nil, err+ }+ if migrationContext.TLSKey, err = write("ghost-tls-key-*", dataSource.GetSslKey()); err != nil {+ return nil, err+ }+ return func() {+ for _, name := range files {+ _ = os.Remove(name)+ }+ }, nil+}+```++Keep cleanup deferred after `SetupTLS()` succeeds so gh-ost reads the files during setup.++- [ ] **Step 3: Fix Elasticsearch CA assignment**++In `backend/plugin/db/elasticsearch/elasticsearch.go`, change the typed client CA block to use the resolved CA:++```go+ if config.DataSource.GetSslCa() != "" {+ esConfig.CACert = []byte(config.DataSource.GetSslCa())+ }+```++Apply the same fix in both Elasticsearch and OpenSearch client setup paths if both set `CACert`.++- [ ] **Step 4: Fix MongoDB TLS temp-file location**++In `backend/plugin/db/mongodb/mongodb.go`, replace `os.WriteFile(caFileName, ...)` with `os.CreateTemp(os.TempDir(), "mongodb-tls-ca-*")`, write content to that file, close it, append `file.Name()` to cleanup, and pass `file.Name()` to `--tlsCAFile`.++Use the same pattern for the client certificate key file with prefix `mongodb-tls-client-cert-*`.++- [ ] **Step 5: Use already-resolved data sources for PostgreSQL SSL mode checks**++In `backend/plugin/db/pg/pg.go` and `backend/plugin/db/cockroachdb/cockroachdb.go`, keep `util.GetPGSSLMode(config.DataSource)` as-is after Task 3 because `DBFactory` passes resolved data sources to drivers. Do not add a second `ResolveTLSMaterial()` call in these functions.++- [ ] **Step 6: Run component and driver tests**++Run:++```bash+gofmt -w backend/component/ghost/config.go backend/component/ghost/config_test.go backend/plugin/db/elasticsearch/elasticsearch.go backend/plugin/db/elasticsearch/elasticsearch_test.go backend/plugin/db/mongodb/mongodb.go backend/plugin/db/mongodb/mongodb_test.go backend/plugin/db/pg/pg.go backend/plugin/db/cockroachdb/cockroachdb.go+go test ./backend/component/ghost ./backend/plugin/db/elasticsearch ./backend/plugin/db/mongodb ./backend/plugin/db/pg ./backend/plugin/db/cockroachdb -count=1+```++Expected: tests exit 0.++- [ ] **Step 7: Commit driver fixes**++Run:++```bash+git add backend/component/ghost/config.go backend/component/ghost/config_test.go backend/plugin/db/elasticsearch/elasticsearch.go backend/plugin/db/elasticsearch/elasticsearch_test.go backend/plugin/db/mongodb/mongodb.go backend/plugin/db/mongodb/mongodb_test.go backend/plugin/db/pg/pg.go backend/plugin/db/cockroachdb/cockroachdb.go+git commit -m "fix(instance): apply resolved TLS material to drivers"+```++### Task 6: Frontend TLS Source Selection++**Files:**+- Modify: `frontend/src/react/components/instance/SslCertificateForm.tsx`+- Modify: `frontend/src/react/components/instance/DataSourceForm.tsx`+- Modify: `frontend/src/react/components/instance/common.ts`+- Modify: `frontend/src/react/components/instance/InstanceFormBody.tsx`+- Modify: `frontend/src/react/components/instance/InstanceFormButtons.tsx`+- Create: `frontend/src/react/components/instance/tls.ts`+- Create: `frontend/src/react/components/instance/SslCertificateForm.test.tsx`+- Create: `frontend/src/react/components/instance/common.test.ts`+- Modify: `frontend/src/locales/en-US.json`+- Modify: `frontend/src/locales/es-ES.json`+- Modify: `frontend/src/locales/ja-JP.json`+- Modify: `frontend/src/locales/vi-VN.json`+- Modify: `frontend/src/locales/zh-CN.json`++- [ ] **Step 1: Add local TLS source helpers**++Create `frontend/src/react/components/instance/tls.ts`:++```ts+import type { DataSource } from "@/types/proto-es/v1/instance_service_pb";++export type TlsSource = "DISABLED" | "INLINE_PEM" | "FILE_PATH";++export const getTlsSource = (dataSource: DataSource): TlsSource => {+ if (!dataSource.useSsl) {+ return "DISABLED";+ }+ if (+ dataSource.sslCaPath ||+ dataSource.sslCertPath ||+ dataSource.sslKeyPath ||+ dataSource.hasSslCaPath ||+ dataSource.hasSslCertPath ||+ dataSource.hasSslKeyPath+ ) {+ return "FILE_PATH";+ }+ return "INLINE_PEM";+};++export const clearInlineTlsFields = (dataSource: DataSource) => {+ dataSource.sslCa = "";+ dataSource.sslCert = "";+ dataSource.sslKey = "";+};++export const clearPathTlsFields = (dataSource: DataSource) => {+ dataSource.sslCaPath = "";+ dataSource.sslCertPath = "";+ dataSource.sslKeyPath = "";+};+```++- [ ] **Step 2: Extend SSL certificate form props**++In `SslCertificateForm.tsx`, add props for path mode and labels:++```ts+ source?: "INLINE_PEM" | "FILE_PATH";+ onSourceChange?: (source: "INLINE_PEM" | "FILE_PATH") => void;+ caPath?: string;+ onCaPathChange?: (val: string) => void;+ certPath?: string;+ onCertPathChange?: (val: string) => void;+ sslKeyPath?: string;+ onKeyPathChange?: (val: string) => void;+```++Render a two-tab selector for inline PEM vs file paths when `useSsl` is true. In file-path mode, render `<input>` fields instead of droppable textareas.++- [ ] **Step 3: Add empty CA trust hint**++In `SslCertificateForm.tsx`, render this hint under the CA input in both modes:++```tsx+<p className="mt-1 text-xs text-control-light">+ {t("data-source.ssl.empty-ca-uses-system-trust")}+</p>+```++- [ ] **Step 4: Collapse duplicate key/cert visibility condition**++In `SslCertificateForm.tsx`, replace the duplicate booleans with one variable:++```ts+ const hasSSLKeyAndCertFields =+ showKeyAndCert || ![Engine.MSSQL].includes(engineType);+```++Use `hasSSLKeyAndCertFields` for both key and cert tab rendering.++- [ ] **Step 5: Wire source changes in DataSourceForm**++In `DataSourceForm.tsx`, import helpers:++```ts+import {+ clearInlineTlsFields,+ clearPathTlsFields,+ getTlsSource,+ type TlsSource,+} from "./tls";+```++Add handler near `handleUseSslChanged`:++```ts+ const handleTlsSourceChanged = (source: TlsSource) => {+ const next = { ...dataSource, updateSsl: true };+ if (source === "DISABLED") {+ next.useSsl = false;+ clearInlineTlsFields(next);+ clearPathTlsFields(next);+ } else if (source === "INLINE_PEM") {+ next.useSsl = true;+ clearPathTlsFields(next);+ } else {+ next.useSsl = true;+ clearInlineTlsFields(next);+ }+ update(next);+ };+```++Pass `source={getTlsSource(dataSource) === "FILE_PATH" ? "FILE_PATH" : "INLINE_PEM"}` and path field props to `SslCertificateForm`.++- [ ] **Step 6: Include path fields in update masks**++In `frontend/src/react/components/instance/common.ts`, update `calcDataSourceUpdateMask()`:++```ts+ if (updateSsl) {+ updateMask.add("use_ssl");+ updateMask.add("ssl_ca");+ updateMask.add("ssl_key");+ updateMask.add("ssl_cert");+ updateMask.add("ssl_ca_path");+ updateMask.add("ssl_key_path");+ updateMask.add("ssl_cert_path");+ }+```++- [ ] **Step 7: Include path fields in SSL presence checks**++In `InstanceFormBody.tsx` and `InstanceFormButtons.tsx`, expand `hasSslConfig`:++```ts+ const hasSslConfig = !!(+ ds.useSsl ||+ ds.sslCa ||+ ds.sslCert ||+ ds.sslKey ||+ ds.sslCaPath ||+ ds.sslCertPath ||+ ds.sslKeyPath ||+ ds.hasSslCaPath ||+ ds.hasSslCertPath ||+ ds.hasSslKeyPath+ );+```++- [ ] **Step 8: Add locale strings**++Add these keys under `data-source.ssl` in every listed locale file:++```json+ "inline-pem": "Inline PEM",+ "file-path": "File paths",+ "ca-cert-path": "CA certificate path",+ "client-cert-path": "Client certificate path",+ "client-key-path": "Client key path",+ "empty-ca-uses-system-trust": "Leave CA empty to use the system trust store."+```++Use direct translations for non-English files. If translation quality is uncertain, use English rather than leaving empty strings.++- [ ] **Step 9: Add frontend unit tests**++Create `frontend/src/react/components/instance/common.test.ts` with:++```ts+import { describe, expect, it } from "vitest";+import { DataSource } from "@/types/proto-es/v1/instance_service_pb";+import { calcDataSourceUpdateMask, type EditDataSource } from "./common";++describe("calcDataSourceUpdateMask", () => {+ it("includes TLS path fields when SSL is updated", () => {+ const editing = Object.assign(+ new DataSource({ id: "admin", useSsl: true, sslCaPath: "/tmp/ca.pem" }),+ {+ pendingCreate: false,+ updatedPassword: "",+ updatedMasterPassword: "",+ updateSsl: true,+ }+ ) as EditDataSource;+ const original = new DataSource({ id: "admin", useSsl: false });+ const mask = calcDataSourceUpdateMask(editing, original, editing);+ expect(mask).toContain("ssl_ca_path");+ expect(mask).toContain("ssl_cert_path");+ expect(mask).toContain("ssl_key_path");+ });+});+```++Create `frontend/src/react/components/instance/SslCertificateForm.test.tsx` with a render test that asserts the empty CA hint is visible:++```tsx+import { render, screen } from "@testing-library/react";+import { describe, expect, it, vi } from "vitest";+import { SslCertificateForm } from "./SslCertificateForm";++vi.mock("react-i18next", () => ({+ useTranslation: () => ({+ t: (key: string) =>+ key === "data-source.ssl.empty-ca-uses-system-trust"+ ? "Leave CA empty to use the system trust store."+ : key,+ }),+}));++describe("SslCertificateForm", () => {+ it("shows the system trust hint", () => {+ render(<SslCertificateForm source="INLINE_PEM" />);+ expect(+ screen.getByText("Leave CA empty to use the system trust store.")+ ).toBeInTheDocument();+ });+});+```++- [ ] **Step 10: Run frontend checks**++Run:++```bash+pnpm --dir frontend fix+pnpm --dir frontend exec vitest run src/react/components/instance/common.test.ts src/react/components/instance/SslCertificateForm.test.tsx+pnpm --dir frontend type-check+```++Expected: commands exit 0.++- [ ] **Step 11: Commit frontend changes**++Run:++```bash+git add frontend/src/react/components/instance/SslCertificateForm.tsx frontend/src/react/components/instance/DataSourceForm.tsx frontend/src/react/components/instance/common.ts frontend/src/react/components/instance/InstanceFormBody.tsx frontend/src/react/components/instance/InstanceFormButtons.tsx frontend/src/react/components/instance/tls.ts frontend/src/react/components/instance/SslCertificateForm.test.tsx frontend/src/react/components/instance/common.test.ts frontend/src/locales/en-US.json frontend/src/locales/es-ES.json frontend/src/locales/ja-JP.json frontend/src/locales/vi-VN.json frontend/src/locales/zh-CN.json+git commit -m "feat(frontend): add TLS path source selection"+```++### Task 7: Final Verification And Cleanup++**Files:**+- Review all files changed by Tasks 1-6.++- [ ] **Step 1: Confirm no TLS mode enum exists**++Run:++```bash+rg -n "TLSMode|tls_mode|TlsMode" proto backend frontend/src/react/components/instance frontend/src/types/proto-es+```++Expected: no matches related to instance data source TLS source selection.++- [ ] **Step 2: Confirm no data migration was added**++Run:++```bash+git diff --name-only origin/main...HEAD | rg 'backend/migrator/migration|LATEST.sql|migrator_test.go'+```++Expected: no output.++- [ ] **Step 3: Run proto checks**++Run:++```bash+buf format -w proto+buf lint proto+cd proto && buf generate+```++Expected: commands exit 0 and `git diff --exit-code` after generation shows no unexpected generated drift beyond committed generated files.++- [ ] **Step 4: Run Go formatting, lint, and tests**++Run:++```bash+gofmt -w backend/store/instance.go backend/api/v1/instance_service.go backend/api/v1/instance_service_converter.go backend/api/v1/audit.go backend/plugin/db/util/ssl.go backend/plugin/db/util/ssl_test.go backend/component/dbfactory/dbfactory.go backend/component/ghost/config.go backend/component/ghost/config_test.go backend/plugin/db/elasticsearch/elasticsearch.go backend/plugin/db/elasticsearch/elasticsearch_test.go backend/plugin/db/mongodb/mongodb.go backend/plugin/db/mongodb/mongodb_test.go backend/plugin/db/pg/pg.go backend/plugin/db/cockroachdb/cockroachdb.go+golangci-lint run --allow-parallel-runners+go test ./backend/store ./backend/api/v1 ./backend/plugin/db/util ./backend/component/dbfactory ./backend/component/ghost ./backend/plugin/db/elasticsearch ./backend/plugin/db/mongodb ./backend/plugin/db/pg ./backend/plugin/db/cockroachdb -count=1+```++Expected: commands exit 0. If `golangci-lint` reports fixable issues, run `golangci-lint run --fix --allow-parallel-runners`, then rerun `golangci-lint run --allow-parallel-runners`.++- [ ] **Step 5: Run frontend checks**++Run:++```bash+pnpm --dir frontend check+pnpm --dir frontend type-check+pnpm --dir frontend exec vitest run src/react/components/instance/common.test.ts src/react/components/instance/SslCertificateForm.test.tsx+```++Expected: commands exit 0.++- [ ] **Step 6: Build backend**++Run:++```bash+go build -ldflags "-w -s" -p=16 -o ./bytebase-build/bytebase ./backend/bin/server/main.go+```++Expected: command exits 0.++- [ ] **Step 7: Review final diff for compatibility**++Run:++```bash+git diff --stat origin/main...HEAD+git diff origin/main...HEAD -- proto/store/store/instance.proto proto/v1/v1/instance_service.proto backend/api/v1/instance_service.go backend/plugin/db/util/ssl.go frontend/src/react/components/instance+```++Confirm:++- `use_ssl` remains in store and v1 API.+- Only additive proto fields were introduced.+- No persisted/API `TLSMode` enum exists.+- No migration file exists.+- API write validation rejects explicit mixed inline/path material.+- Runtime file path reads return redacted errors.+- Empty CA hint is present in UI strings and form rendering.++- [ ] **Step 8: Commit verification-only fixes if needed**++If verification commands changed formatting or generated files, commit them:++```bash+git add .+git commit -m "chore: finalize TLS path verification fixes"+```++If verification produced no changes, do not create an empty commit.diff --git a/docs/superpowers/plans/2026-04-20-instance-tls-per-field-source.md b/docs/superpowers/plans/2026-04-20-instance-tls-per-field-source.mdnew file mode 100644index 0000000000..be70dea6d1--- /dev/null+++ b/docs/superpowers/plans/2026-04-20-instance-tls-per-field-source.md@@ -0,0 +1,600 @@+# Instance TLS Per-Field Source Implementation Plan++> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.++**Goal:** Replace the current global inline/file-path TLS source behavior with independent source choices for CA material and client certificate/key material.++**Architecture:** Keep `use_ssl` as the only persisted on/off switch and keep the existing path fields. Backend validation rejects inline/path conflicts only within the same material slot, resolves path fields into PEM independently, and validates the effective CA plus effective client cert/key pair. The React form removes the global TLS source selector and uses local-only source selectors for the CA group and client certificate/key group.++**Tech Stack:** Go, proto-generated Go structs, Connect API validation, React, TypeScript, react-i18next, Vitest, pnpm, golangci-lint.++---++## File Structure++- Modify `backend/api/v1/instance_service_tls_test.go`: update tests from global-source semantics to same-slot conflict and cross-slot mixing semantics.+- Modify `backend/api/v1/instance_service.go`: change TLS write validation and normalization helpers.+- Modify `backend/plugin/db/util/ssl_test.go`: add coverage that path resolution overwrites only matching slots and preserves inline material in other slots.+- Modify `backend/plugin/db/util/ssl.go`: keep per-field resolution behavior; adjust only if the new test exposes old global assumptions.+- Modify `frontend/src/react/components/instance/tls.ts`: replace `LocalTlsSource` with `LocalTlsCaSource` and `LocalTlsClientCertSource` helpers.+- Modify `frontend/src/react/components/instance/common.test.ts`: test source inference and per-group clearing helpers.+- Modify `frontend/src/react/components/instance/SslCertificateForm.tsx`: replace the global source selector with CA and client certificate/key source selectors.+- Modify `frontend/src/react/components/instance/SslCertificateForm.test.tsx`: test System trust rendering and per-group source controls.+- Modify `frontend/src/react/components/instance/DataSourceForm.tsx`: keep separate local CA and client source state and update only the corresponding fields.+- Modify `frontend/src/react/locales/*.json` and `frontend/src/locales/*.json`: update TLS source labels from one global source label to CA/client group labels.++---++### Task 1: Backend Same-Slot Validation++**Files:**+- Modify: `backend/api/v1/instance_service_tls_test.go`+- Modify: `backend/api/v1/instance_service.go`++- [ ] **Step 1: Replace the old global mixed-source failing tests**++In `backend/api/v1/instance_service_tls_test.go`, replace `TestValidateDataSourceTLSWriteRejectsMixedExplicitMaterial`, `TestNormalizeDataSourceTLSClearsInlineWhenPathWins`, `TestNormalizeDataSourceTLSClearsStaleInlineWhenPathExists`, `TestNormalizeDataSourceTLSClearsPathsWhenSwitchingToInline`, and `TestValidateDataSourceTLSWriteRejectsInactiveInlineWithExistingPath` with tests that encode the new behavior:++```go+func TestValidateDataSourceTLSWriteRejectsSameSlotMixedMaterial(t *testing.T) {+ tests := []struct {+ name string+ ds *storepb.DataSource+ mask []string+ want string+ }{+ {+ name: "ca",+ ds: &storepb.DataSource{UseSsl: true, SslCa: "inline-ca", SslCaPath: "/tmp/ca.pem"},+ mask: []string{"ssl_ca", "ssl_ca_path"},+ want: "cannot set both ssl_ca and ssl_ca_path",+ },+ {+ name: "cert",+ ds: &storepb.DataSource{UseSsl: true, SslCert: "inline-cert", SslCertPath: "/tmp/cert.pem"},+ mask: []string{"ssl_cert", "ssl_cert_path"},+ want: "cannot set both ssl_cert and ssl_cert_path",+ },+ {+ name: "key",+ ds: &storepb.DataSource{UseSsl: true, SslKey: "inline-key", SslKeyPath: "/tmp/key.pem"},+ mask: []string{"ssl_key", "ssl_key_path"},+ want: "cannot set both ssl_key and ssl_key_path",+ },+ }+ for _, tc := range tests {+ t.Run(tc.name, func(t *testing.T) {+ err := validateDataSourceTLSWrite(tc.ds, tc.ds, tc.mask)+ require.Error(t, err)+ require.Contains(t, err.Error(), tc.want)+ })+ }+}++func TestValidateDataSourceTLSWriteAllowsCrossSlotMixedMaterial(t *testing.T) {+ err := validateDataSourceTLSWrite(+ &storepb.DataSource{UseSsl: true, SslCa: validCAPEM, SslCertPath: "/tmp/cert.pem", SslKeyPath: "/tmp/key.pem"},+ &storepb.DataSource{UseSsl: true, SslCa: validCAPEM, SslCertPath: "/tmp/cert.pem", SslKeyPath: "/tmp/key.pem"},+ []string{"ssl_ca", "ssl_cert_path", "ssl_key_path"},+ )+ require.NoError(t, err)+}++func TestNormalizeDataSourceTLSClearsSameSlotConflictsOnly(t *testing.T) {+ ds := &storepb.DataSource{+ UseSsl: true,+ SslCa: "inline-ca",+ SslCaPath: "/tmp/ca.pem",+ SslCert: "inline-cert",+ SslKeyPath: "/tmp/key.pem",+ }+ normalizeDataSourceTLS(ds, []string{"ssl_ca_path", "ssl_key_path"})+ require.Empty(t, ds.GetSslCa())+ require.Equal(t, "/tmp/ca.pem", ds.GetSslCaPath())+ require.Equal(t, "inline-cert", ds.GetSslCert())+ require.Equal(t, "/tmp/key.pem", ds.GetSslKeyPath())+}+```++Define `validCAPEM` in the test file with this valid self-signed certificate PEM:++```go+const validCAPEM = `-----BEGIN CERTIFICATE-----+MIIDOTCCAiGgAwIBAgIQSRJrEpBGFc7tNb1fb5pKFzANBgkqhkiG9w0BAQsFADAS+MRAwDgYDVQQKEwdBY21lIENvMCAXDTcwMDEwMTAwMDAwMFoYDzIwODQwMTI5MTYw+MDAwWjASMRAwDgYDVQQKEwdBY21lIENvMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A+MIIBCgKCAQEA6Gba5tHV1dAKouAaXO3/ebDUU4rvwCUg/CNaJ2PT5xLD4N1Vcb8r+bFSW2HXKq+MPfVdwIKR/1DczEoAGf/JWQTW7EgzlXrCd3rlajEX2D73faWJekD0U+aUgz5vtrTXZ90BQL7WvRICd7FlEZ6FPOcPlumiyNmzUqtwGhO+9ad1W5BqJaRI6P+YfouNkwR6Na4TzSj5BrqUfP0FwDizKSJ0XXmh8g8G9mtwxOSN3Ru1QFc61Xyeluk+POGKBV/q6RBNklTNe0gI8usUMlYyoC7ytppNMW7X2vodAelSu25jgx2anj9fDVZu+h7AXF5+4nJS4AAt0n1lNY7nGSsdZas8PbQIDAQABo4GIMIGFMA4GA1UdDwEB/wQE+AwICpDATBgNVHSUEDDAKBggrBgEFBQcDATAPBgNVHRMBAf8EBTADAQH/MB0GA1Ud+DgQWBBStsdjh3/JCXXYlQryOrL4Sh7BW5TAuBgNVHREEJzAlggtleGFtcGxlLmNv+bYcEfwAAAYcQAAAAAAAAAAAAAAAAAAAAATANBgkqhkiG9w0BAQsFAAOCAQEAxWGI+5NhpF3nwwy/4yB4i/CwwSpLrWUa70NyhvprUBC50PxiXav1TeDzwzLx/o5HyNwsv+cxv3HdkLW59i/0SlJSrNnWdfZ19oTcS+6PtLoVyISgtyN6DpkKpdG1cOkW3Cy2P2++tK/tKHRP1Y/Ra0RiDpOAmqn0gCOFGz8+lqDIor/T7MTpibL3IxqWfPrvfVRHL3B+grw/ZQTTIVjjh4JBSW3WyWgNo/ikC1lrVxzl4iPUGptxT36Cr7Zk2Bsg0XqwbOvK+5d+NTDREkSnUbie4GeutujmX3Dsx88UiV6UY/4lHJa6I5leHUNOHahRbpbWeOfs/+WkBKOclmOV2xlTVuPw==+-----END CERTIFICATE-----`+```++- [ ] **Step 2: Run tests and verify they fail**++Run:++```bash+go test ./backend/api/v1 -run 'TestValidateDataSourceTLSWrite|TestNormalizeDataSourceTLS|TestTLSMaskPaths|TestValidateDataSourceTLSConfig' -count=1+```++Expected: FAIL because current validation rejects any explicit inline+path write and current normalization clears all inline material when any path exists.++- [ ] **Step 3: Implement same-slot validation**++In `backend/api/v1/instance_service.go`, replace `hasExplicitInlineTLSMaterial`/`hasExplicitPathTLSMaterial` based rejection with slot-specific checks:++```go+func validateDataSourceTLSWrite(requested, merged *storepb.DataSource, mask []string) error {+ if !merged.GetUseSsl() {+ return nil+ }+ for _, conflict := range []struct {+ inlineField string+ pathField string+ inlineValue string+ pathValue string+ }{+ {"ssl_ca", "ssl_ca_path", merged.GetSslCa(), merged.GetSslCaPath()},+ {"ssl_cert", "ssl_cert_path", merged.GetSslCert(), merged.GetSslCertPath()},+ {"ssl_key", "ssl_key_path", merged.GetSslKey(), merged.GetSslKeyPath()},+ } {+ if conflict.inlineValue == "" || conflict.pathValue == "" {+ continue+ }+ if tlsMaskContains(mask, conflict.inlineField) || tlsMaskContains(mask, conflict.pathField) {+ return errors.Errorf("cannot set both %s and %s", conflict.inlineField, conflict.pathField)+ }+ }+ return validateDataSourceTLSConfig(merged)+}+```++Update `validateDataSourceTLSConfig` so path absoluteness is checked whenever path fields are provided, and inline PEM validation still runs when inline PEM is present. Do not return early just because any path field exists.++- [ ] **Step 4: Implement same-slot normalization**++Change `normalizeDataSourceTLS` to clear only conflicting inactive values for fields included in the update mask:++```go+func normalizeDataSourceTLS(ds *storepb.DataSource, mask []string) {+ if !ds.GetUseSsl() {+ clearInlineTLSMaterial(ds)+ clearPathTLSMaterial(ds)+ return+ }+ if tlsMaskContains(mask, "ssl_ca") {+ ds.SslCaPath = ""+ }+ if tlsMaskContains(mask, "ssl_ca_path") {+ ds.SslCa = ""+ }+ if tlsMaskContains(mask, "ssl_cert") {+ ds.SslCertPath = ""+ }+ if tlsMaskContains(mask, "ssl_cert_path") {+ ds.SslCert = ""+ }+ if tlsMaskContains(mask, "ssl_key") {+ ds.SslKeyPath = ""+ }+ if tlsMaskContains(mask, "ssl_key_path") {+ ds.SslKey = ""+ }+}+```++- [ ] **Step 5: Verify backend API tests pass**++Run:++```bash+go test ./backend/api/v1 -run 'TestValidateDataSourceTLSWrite|TestNormalizeDataSourceTLS|TestTLSMaskPaths|TestValidateDataSourceTLSConfig' -count=1+```++Expected: PASS.++- [ ] **Step 6: Commit backend validation changes**++Run:++```bash+gofmt -w backend/api/v1/instance_service.go backend/api/v1/instance_service_tls_test.go+git add backend/api/v1/instance_service.go backend/api/v1/instance_service_tls_test.go+git commit -m "fix(instance): allow per-field TLS material sources"+```++---++### Task 2: TLS Resolution Cross-Slot Preservation++**Files:**+- Modify: `backend/plugin/db/util/ssl_test.go`+- Modify: `backend/plugin/db/util/ssl.go`++- [ ] **Step 1: Add failing resolver test**++Add this test to `backend/plugin/db/util/ssl_test.go`:++```go+func TestResolveTLSMaterialPreservesInlineCrossSlotMaterial(t *testing.T) {+ dir := t.TempDir()+ keyPath := filepath.Join(dir, "key.pem")+ require.NoError(t, os.WriteFile(keyPath, []byte("path-key"), 0o600))++ ds := &storepb.DataSource{+ UseSsl: true,+ SslCa: "inline-ca",+ SslCert: "inline-cert",+ SslKeyPath: keyPath,+ }++ resolved, err := ResolveTLSMaterial(ds)+ require.NoError(t, err)+ require.Equal(t, "inline-ca", resolved.GetSslCa())+ require.Equal(t, "inline-cert", resolved.GetSslCert())+ require.Equal(t, "path-key", resolved.GetSslKey())+ require.Empty(t, resolved.GetSslKeyPath())+ require.Equal(t, keyPath, ds.GetSslKeyPath())+}+```++- [ ] **Step 2: Run resolver tests and verify the new test status**++Run:++```bash+go test ./backend/plugin/db/util -run 'TestResolveTLSMaterial' -count=1+```++Expected: PASS if current resolver already behaves per-field. If it fails, the failure should show a global-source assumption in `ResolveTLSMaterial`.++- [ ] **Step 3: Adjust resolver only if needed**++If the new test fails, change `ResolveTLSMaterial` so each path field overwrites only the matching inline field and clears only the matching path field. It should not clear `SslCa`, `SslCert`, or `SslKey` because another path field exists.++- [ ] **Step 4: Commit resolver test or fix**++Run:++```bash+gofmt -w backend/plugin/db/util/ssl.go backend/plugin/db/util/ssl_test.go+go test ./backend/plugin/db/util -run 'TestResolveTLSMaterial' -count=1+git add backend/plugin/db/util/ssl.go backend/plugin/db/util/ssl_test.go+git commit -m "test(instance): cover mixed TLS material resolution"+```++---++### Task 3: React TLS Source Helpers++**Files:**+- Modify: `frontend/src/react/components/instance/tls.ts`+- Modify: `frontend/src/react/components/instance/common.test.ts`++- [ ] **Step 1: Write failing helper tests**++Replace `frontend/src/react/components/instance/common.test.ts` with tests for per-group helpers:++```ts+import { describe, expect, test } from "vitest";+import {+ applyLocalTlsCaSource,+ applyLocalTlsClientCertSource,+ getLocalTlsCaSource,+ getLocalTlsClientCertSource,+ SSL_UPDATE_MASK_FIELDS,+} from "./tls";++describe("TLS update mask fields", () => {+ test("includes the SSL path fields alongside inline material", () => {+ expect(SSL_UPDATE_MASK_FIELDS).toEqual([+ "use_ssl",+ "ssl_ca",+ "ssl_cert",+ "ssl_key",+ "ssl_ca_path",+ "ssl_cert_path",+ "ssl_key_path",+ ]);+ });+});++describe("TLS local source helpers", () => {+ test("treats empty CA material with SSL enabled as system trust", () => {+ expect(getLocalTlsCaSource({ useSsl: true })).toBe("SYSTEM_TRUST");+ });++ test("clears only CA fields when selecting system trust", () => {+ const next = applyLocalTlsCaSource(+ {+ useSsl: true,+ sslCa: "inline-ca",+ sslCaPath: "/tmp/ca.pem",+ sslCert: "inline-cert",+ sslKeyPath: "/tmp/key.pem",+ } as never,+ "SYSTEM_TRUST"+ );+ expect(next.sslCa).toBe("");+ expect(next.sslCaPath).toBe("");+ expect(next.sslCert).toBe("inline-cert");+ expect(next.sslKeyPath).toBe("/tmp/key.pem");+ });++ test("clears only client cert fields when selecting none", () => {+ const next = applyLocalTlsClientCertSource(+ {+ useSsl: true,+ sslCaPath: "/tmp/ca.pem",+ sslCert: "inline-cert",+ sslKey: "inline-key",+ sslCertPath: "/tmp/cert.pem",+ sslKeyPath: "/tmp/key.pem",+ } as never,+ "NONE"+ );+ expect(next.sslCaPath).toBe("/tmp/ca.pem");+ expect(next.sslCert).toBe("");+ expect(next.sslKey).toBe("");+ expect(next.sslCertPath).toBe("");+ expect(next.sslKeyPath).toBe("");+ });++ test("infers client certificate source from path presence flags", () => {+ expect(getLocalTlsClientCertSource({ useSsl: true, hasSslCertPath: true } as never)).toBe("FILE_PATH");+ });+});+```++- [ ] **Step 2: Run helper tests and verify they fail**++Run:++```bash+pnpm --dir frontend exec vitest run src/react/components/instance/common.test.ts+```++Expected: FAIL because the helper functions do not exist yet.++- [ ] **Step 3: Implement helper types and functions**++In `frontend/src/react/components/instance/tls.ts`, replace `LocalTlsSource` with:++```ts+export const LOCAL_TLS_CA_SOURCE_SYSTEM_TRUST = "SYSTEM_TRUST" as const;+export const LOCAL_TLS_CA_SOURCE_INLINE_PEM = "INLINE_PEM" as const;+export const LOCAL_TLS_CA_SOURCE_FILE_PATH = "FILE_PATH" as const;++export const LOCAL_TLS_CLIENT_CERT_SOURCE_NONE = "NONE" as const;+export const LOCAL_TLS_CLIENT_CERT_SOURCE_INLINE_PEM = "INLINE_PEM" as const;+export const LOCAL_TLS_CLIENT_CERT_SOURCE_FILE_PATH = "FILE_PATH" as const;++export type LocalTlsCaSource =+ | typeof LOCAL_TLS_CA_SOURCE_SYSTEM_TRUST+ | typeof LOCAL_TLS_CA_SOURCE_INLINE_PEM+ | typeof LOCAL_TLS_CA_SOURCE_FILE_PATH;++export type LocalTlsClientCertSource =+ | typeof LOCAL_TLS_CLIENT_CERT_SOURCE_NONE+ | typeof LOCAL_TLS_CLIENT_CERT_SOURCE_INLINE_PEM+ | typeof LOCAL_TLS_CLIENT_CERT_SOURCE_FILE_PATH;+```++Implement `getLocalTlsCaSource`, `getLocalTlsClientCertSource`, `applyLocalTlsCaSource`, `applyLocalTlsClientCertSource`, and `disableLocalTls` so CA changes clear only CA fields and client source changes clear only cert/key fields.++- [ ] **Step 4: Verify helper tests pass**++Run:++```bash+pnpm --dir frontend exec vitest run src/react/components/instance/common.test.ts+```++Expected: PASS.++- [ ] **Step 5: Commit helper changes**++Run:++```bash+pnpm --dir frontend fix+git add frontend/src/react/components/instance/tls.ts frontend/src/react/components/instance/common.test.ts+git commit -m "feat(frontend): split TLS material source helpers"+```++---++### Task 4: React Form Per-Group Source Selectors++**Files:**+- Modify: `frontend/src/react/components/instance/SslCertificateForm.tsx`+- Modify: `frontend/src/react/components/instance/SslCertificateForm.test.tsx`+- Modify: `frontend/src/react/components/instance/DataSourceForm.tsx`+- Modify: `frontend/src/react/locales/en-US.json`+- Modify: `frontend/src/react/locales/es-ES.json`+- Modify: `frontend/src/react/locales/ja-JP.json`+- Modify: `frontend/src/react/locales/vi-VN.json`+- Modify: `frontend/src/react/locales/zh-CN.json`+- Modify: `frontend/src/locales/en-US.json`+- Modify: `frontend/src/locales/es-ES.json`+- Modify: `frontend/src/locales/ja-JP.json`+- Modify: `frontend/src/locales/vi-VN.json`+- Modify: `frontend/src/locales/zh-CN.json`++- [ ] **Step 1: Write failing form test**++Extend `frontend/src/react/components/instance/SslCertificateForm.test.tsx` with:++```tsx+it("renders explicit CA and client certificate source controls", () => {+ render(+ <SslCertificateForm+ useSsl={true}+ caSource="SYSTEM_TRUST"+ onCaSourceChange={() => {}}+ clientCertSource="FILE_PATH"+ onClientCertSourceChange={() => {}}+ showKeyAndCert={true}+ />+ );++ expect(screen.getByText("data-source.ssl.ca-source.self")).toBeTruthy();+ expect(screen.getByText("data-source.ssl.ca-source.system-trust")).toBeTruthy();+ expect(screen.getByText("data-source.ssl.client-cert-source.self")).toBeTruthy();+ expect(screen.getByText("data-source.ssl.client-cert-source.file-path")).toBeTruthy();+});+```++- [ ] **Step 2: Run form test and verify it fails**++Run:++```bash+pnpm --dir frontend exec vitest run src/react/components/instance/SslCertificateForm.test.tsx+```++Expected: FAIL because `caSource` and `clientCertSource` props are not defined.++- [ ] **Step 3: Update form props and rendering**++In `SslCertificateForm.tsx`, replace `source/onSourceChange` with:++```ts+caSource?: LocalTlsCaSource;+onCaSourceChange?: (val: LocalTlsCaSource) => void;+clientCertSource?: LocalTlsClientCertSource;+onClientCertSourceChange?: (val: LocalTlsClientCertSource) => void;+```++Render `CA certificate source` radio options above CA material. For `SYSTEM_TRUST`, show no CA input and show the system trust hint. For `INLINE_PEM`, show the CA textarea. For `FILE_PATH`, show the CA path input.++Render `Client certificate source` radio options before client material when client cert/key fields are supported. For `NONE`, show no cert/key inputs. For `INLINE_PEM`, show the key/cert textareas. For `FILE_PATH`, show cert/key path inputs.++- [ ] **Step 4: Update DataSourceForm state wiring**++In `DataSourceForm.tsx`, replace `localTlsSource` state with:++```ts+const [localTlsCaSource, setLocalTlsCaSource] = useState(getLocalTlsCaSource(dataSource));+const [localTlsClientCertSource, setLocalTlsClientCertSource] = useState(getLocalTlsClientCertSource(dataSource));+```++On data source changes, sync both local states. Pass both sources to `SslCertificateForm`. On CA source change, call `applyLocalTlsCaSource`; on client source change, call `applyLocalTlsClientCertSource`. When SSL is disabled, call `disableLocalTls`.++- [ ] **Step 5: Update locale keys**++Add React and Vue locale keys:++```json+"data-source.ssl.ca-source.self": "CA Certificate Source",+"data-source.ssl.ca-source.system-trust": "System Trust",+"data-source.ssl.client-cert-source.self": "Client Certificate Source",+"data-source.ssl.client-cert-source.none": "None"+```++Reuse existing `data-source.ssl.source.inline-pem` and `data-source.ssl.source.file-path` labels unless the i18n check requires group-specific keys.++- [ ] **Step 6: Verify frontend tests pass**++Run:++```bash+pnpm --dir frontend fix+pnpm --dir frontend exec vitest run src/react/components/instance/common.test.ts src/react/components/instance/SslCertificateForm.test.tsx+pnpm --dir frontend check+pnpm --dir frontend type-check+```++Expected: all commands exit 0.++- [ ] **Step 7: Commit frontend form changes**++Run:++```bash+git add frontend/src/react/components/instance/SslCertificateForm.tsx frontend/src/react/components/instance/SslCertificateForm.test.tsx frontend/src/react/components/instance/DataSourceForm.tsx frontend/src/react/locales frontend/src/locales+git commit -m "feat(frontend): choose TLS sources per material group"+```++---++### Task 5: Final Verification++**Files:**+- Verify all files changed by Tasks 1 through 4.++- [ ] **Step 1: Run proto checks**++Run:++```bash+PATH="$(go env GOPATH)/bin:$PATH" buf format -w proto+PATH="$(go env GOPATH)/bin:$PATH" buf lint proto+(cd proto && PATH="$(go env GOPATH)/bin:$PATH" buf generate)+```++Expected: exit 0. If grpc-doc HTML files change only by whitespace, revert those generated-doc whitespace-only changes before committing.++- [ ] **Step 2: Run backend checks**++Run:++```bash+golangci-lint run --allow-parallel-runners+go test ./backend/api/v1 ./backend/plugin/db/util ./backend/component/dbfactory ./backend/component/ghost ./backend/plugin/db/elasticsearch -count=1+go test ./backend/plugin/db/mongodb -run '^TestBuildMongoshBaseArgsUsesTempDirForTLSFiles$' -count=1+```++Expected: exit 0. Do not run the full MongoDB package unless `mongosh` is installed.++- [ ] **Step 3: Run frontend checks**++Run:++```bash+pnpm --dir frontend check+pnpm --dir frontend type-check+pnpm --dir frontend exec vitest run src/react/components/instance/common.test.ts src/react/components/instance/SslCertificateForm.test.tsx+```++Expected: exit 0.++- [ ] **Step 4: Run server build**++Run:++```bash+go build -ldflags "-w -s" -p=16 -o ./bytebase-build/bytebase ./backend/bin/server/main.go+```++Expected: exit 0.++- [ ] **Step 5: Commit final verification fixes if needed**++If verification caused tracked changes, inspect them with:++```bash+git diff --stat+git diff --check+```++Then commit only intentional fixes:++```bash+git add <changed-files>+git commit -m "fix(instance): finalize TLS per-field source behavior"+```++Expected: `git status --short` is clean when done.diff --git a/docs/superpowers/specs/2026-04-20-instance-tls-path-additive-design.md b/docs/superpowers/specs/2026-04-20-instance-tls-path-additive-design.mdnew file mode 100644index 0000000000..107ac6e014--- /dev/null+++ b/docs/superpowers/specs/2026-04-20-instance-tls-path-additive-design.md@@ -0,0 +1,127 @@+# Instance TLS Path Additive Design++## Goal++Support local filesystem TLS material for instance data sources without breaking existing `use_ssl` storage/API compatibility or requiring a data migration.++## Context++Instance data sources currently store TLS material as inline PEM strings controlled by `use_ssl`. A customer needs to configure TLS material by local filesystem paths instead. A prior design introduced a persisted/API TLS mode enum, but that creates rollout risk: old replicas still read and write `use_ssl`, while new replicas would read and write the enum.++This design keeps `use_ssl` as the stable TLS on/off switch and adds only path fields. The server resolves TLS material per field: each TLS material slot may be inline PEM or a local file path, but a single slot cannot use both at once.++## API And Storage Contract++Keep `use_ssl` in both the store proto and public v1 API for this release.++Add these fields:++- Store data source config: `ssl_ca_path`, `ssl_cert_path`, `ssl_key_path`.+- Store obfuscation fields: `obfuscated_ssl_ca_path`, `obfuscated_ssl_cert_path`, `obfuscated_ssl_key_path`.+- Public v1 API: write-only `ssl_ca_path`, `ssl_cert_path`, `ssl_key_path`.+- Public v1 API: output-only `has_ssl_ca_path`, `has_ssl_cert_path`, `has_ssl_key_path`.++Do not expose or persist a `TLSMode` enum. Do not add a global TLS material source field.++The effective TLS material is resolved independently:++- `use_ssl=false`: TLS is disabled. TLS material is ignored at runtime and may be cleared on save.+- `use_ssl=true` and both `ssl_ca` and `ssl_ca_path` are empty: TLS uses the system trust store for server verification.+- `ssl_ca` set: use inline CA PEM.+- `ssl_ca_path` set: read CA PEM from the local file path.+- `ssl_cert` and `ssl_key` set: use inline client certificate/key.+- `ssl_cert_path` and `ssl_key_path` set: read client certificate/key from local file paths.++API writes that explicitly provide both inline PEM and path material for the same slot are invalid and must return `InvalidArgument`. For example, `ssl_ca` plus `ssl_ca_path` is invalid, but `ssl_ca` plus `ssl_cert_path` and `ssl_key_path` is valid. Existing stored rows with same-slot conflicts are tolerated until the next TLS-related save, where validation should reject or normalization should clear only the inactive same-slot value requested by the user.++## Backend Behavior++Validation must run before normalization. This prevents same-slot mixed-source API writes from being silently laundered into valid rows.++Create and update validation rules:++- If `use_ssl=false`, TLS material may be cleared and must not affect runtime connection behavior.+- If `use_ssl=true`, reject same-slot conflicts: `ssl_ca` with `ssl_ca_path`, `ssl_cert` with `ssl_cert_path`, or `ssl_key` with `ssl_key_path`.+- If `use_ssl=true`, require every provided path field to be absolute.+- If `use_ssl=true`, resolve any provided path fields to PEM before runtime validation and connection setup.+- If the effective CA PEM is non-empty, validate it with `x509.CertPool.AppendCertsFromPEM`.+- If either effective client cert or effective client key is non-empty, require both to be present after resolving inline/path material and validate the pair with `tls.X509KeyPair`.+- Inline CA with file-backed client cert/key is valid. File-backed CA with inline client cert/key is also valid.++Runtime consumers should use resolved TLS material rather than raw data source fields. This keeps behavior consistent across database plugins and components.++Specific component requirements:++- gh-ost expects TLS certificate file paths. Write resolved PEM material to temporary files and assign those temp paths to `TLSCACertificate`, `TLSClientCertificate`, and `TLSClientKey`. Set `TLSAllowInsecure` from `!VerifyTlsCertificate`; do not hardcode insecure TLS.+- Elasticsearch typed client configuration should use the resolved CA PEM for `CACert`. It must not use the client certificate as the CA bundle.+- MongoDB temporary TLS files should be created under the OS temp directory, not the process working directory.+- PostgreSQL SSL mode helpers should avoid re-reading path files when callers already hold a resolved data source.++File-read errors must be redacted before returning API errors. Do not echo the full local path or raw `os.ReadFile` errno details. This reduces filesystem existence and permission oracle leakage for authenticated instance editors. A path allowlist is intentionally out of scope for this additive compatibility change because it would introduce a new deployment policy and configuration surface.++## UI Behavior++The React instance data source form should not use a global local-only Inline PEM/File Path selector. The form should expose source choices per TLS material group:++- TLS enabled: controlled by `use_ssl`.+- CA certificate source: `System trust`, `Inline PEM`, or `File path`.+- Client certificate/key source: `None`, `Inline PEM`, or `File path`.++The source choices map to existing/new API fields:++- TLS disabled: send `use_ssl=false` and clear TLS material in the local form state.+- CA system trust: send `use_ssl=true` and clear `ssl_ca`/`ssl_ca_path` in the local form state.+- CA inline PEM: send `use_ssl=true` and `ssl_ca`.+- CA file path: send `use_ssl=true` and `ssl_ca_path`.+- Client certificate/key none: clear client cert/key inline and path fields in the local form state.+- Client certificate/key inline PEM: send `ssl_cert` and `ssl_key`.+- Client certificate/key file path: send `ssl_cert_path` and `ssl_key_path`.++The UI must not send or depend on a `tls_mode` API field.++When users switch a group source, clear inactive local form fields and dirty tracking for that group only. Switching CA source must not clear client certificate/key fields, and switching client certificate/key source must not clear CA fields. Existing write-only values are represented only by presence flags such as `has_ssl_ca`, `has_ssl_cert`, `has_ssl_key`, `has_ssl_ca_path`, `has_ssl_cert_path`, and `has_ssl_key_path`.++The form should make trust behavior explicit by showing `System trust` as the CA source when no CA inline PEM or path is configured. This removes the ambiguity where `use_ssl=true` with empty CA fields could be visually interpreted as either an empty inline field or an empty path field.++## Rollout And Migration++No data migration is required.++Existing inline TLS rows continue to work because `use_ssl` and the existing PEM fields remain unchanged. New path fields are additive, so old and new servers can coexist at the schema and wire level.++The compatibility guarantee is limited to not losing the TLS on/off state and not breaking unknown-field handling. If a new UI saves path-only TLS and an old server later handles that row, the old server will still see `use_ssl=true` but will not understand or use the path fields. Do not claim mixed-version path TLS is functionally supported by old replicas.++Do not remove `use_ssl` or reserve its field number/name in this release. Removing `use_ssl` can be considered in a future release after old replicas and clients are no longer supported.++## Testing++Backend tests should cover:++- API rejects explicit same-slot mixed inline PEM and path writes.+- API allows cross-slot mixed sources such as inline CA plus file-backed client cert/key.+- API validates invalid inline PEM at save time.+- API validates path fields are absolute when provided.+- TLS file-read errors are redacted.+- Empty CA fields use system trust when TLS verification is enabled.+- Path material resolves only the matching slot and preserves inline material in other slots.+- Inactive same-slot TLS material is cleared on relevant successful saves.+- gh-ost writes resolved PEM to temp files and honors `VerifyTlsCertificate`.+- Elasticsearch uses resolved CA PEM for typed client `CACert`.+- MongoDB creates TLS temp files under the OS temp directory.+- PostgreSQL SSL mode helpers do not trigger redundant path reads.++Frontend tests should cover:++- CA source selection maps to `ssl_ca` or `ssl_ca_path` without touching client cert/key fields.+- Client certificate/key source selection maps to `ssl_cert`/`ssl_key` or `ssl_cert_path`/`ssl_key_path` without touching CA fields.+- Switching a group source clears inactive local values and dirty tracking for that group only.+- Existing write-only values render via presence flags.+- System trust is visible as an explicit CA source.++Proto checks should cover:++- `buf format -w proto`.+- `buf lint proto`.+- `cd proto && buf generate`.++Final verification should include relevant Go tests, frontend type-check/tests for the modified React instance form, and repository lint/format commands required by `AGENTS.md`.diff --git a/frontend/src/locales/en-US.json b/frontend/src/locales/en-US.jsonindex 425f4d86ae..1f8a631592 100644--- a/frontend/src/locales/en-US.json+++ b/frontend/src/locales/en-US.json@@ -610,8 +610,28 @@},"ssl": {"ca-cert": "CA Certificate",+ "ca-empty-uses-system-trust": "Leave empty to use the system trust store",+ "ca-path": "CA Certificate Path",+ "ca-placeholder": "Input or drag and drop YOUR_CA_CERTIFICATE",+ "ca-source": {+ "file-path": "File Path",+ "inline-pem": "Inline PEM",+ "self": "CA Certificate Source",+ "system-trust": "System Trust"+ },"client-cert": "Client Certificate",+ "client-cert-path": "Client Certificate Path",+ "client-cert-placeholder": "Input or drag and drop YOUR_CLIENT_CERT",+ "client-cert-source": {+ "file-path": "File Path",+ "inline-pem": "Inline PEM",+ "none": "None",+ "self": "Client Certificate Source"+ },"client-key": "Client Key",+ "client-key-path": "Client Key Path",+ "client-key-placeholder": "Input or drag and drop YOUR_CLIENT_KEY",+ "configured": "Configured","verify-certificate": "Verify TLS certificate","verify-certificate-tooltip": "Enable TLS certificate verification for secure connections. Disable only for development or when certificates cannot be properly validated (e.g., self-signed certs, VPN environments). Warning: Disabling verification is insecure"},diff --git a/frontend/src/locales/es-ES.json b/frontend/src/locales/es-ES.jsonindex bfd88558cf..d0bd4194eb 100644--- a/frontend/src/locales/es-ES.json+++ b/frontend/src/locales/es-ES.json@@ -610,8 +610,28 @@},"ssl": {"ca-cert": "Certificado de CA",+ "ca-empty-uses-system-trust": "Dejar vacío para usar la tienda de confianza del sistema",+ "ca-path": "Ruta del certificado de CA",+ "ca-placeholder": "Ingrese o arrastre y suelte YOUR_CA_CERTIFICATE",+ "ca-source": {+ "file-path": "Ruta de archivo",+ "inline-pem": "PEM en línea",+ "self": "Origen del certificado de CA",+ "system-trust": "Confianza del sistema"+ },"client-cert": "Certificado del cliente",+ "client-cert-path": "Ruta del certificado del cliente",+ "client-cert-placeholder": "Ingrese o arrastre y suelte YOUR_CLIENT_CERT",+ "client-cert-source": {+ "file-path": "Ruta de archivo",+ "inline-pem": "PEM en línea",+ "none": "Ninguno",+ "self": "Origen del certificado del cliente"+ },"client-key": "Clave del cliente",+ "client-key-path": "Ruta de la clave del cliente",+ "client-key-placeholder": "Ingrese o arrastre y suelte YOUR_CLIENT_KEY",+ "configured": "Configurado","verify-certificate": "Verificar certificado TLS","verify-certificate-tooltip": "Habilitar la verificación del certificado TLS para conexiones seguras. Deshabilitar solo para desarrollo o cuando los certificados no se pueden validar correctamente (por ejemplo, certificados autofirmados, entornos VPN). Advertencia: Deshabilitar la verificación es inseguro"},diff --git a/frontend/src/locales/ja-JP.json b/frontend/src/locales/ja-JP.jsonindex ee894b0846..e7182d09c3 100644--- a/frontend/src/locales/ja-JP.json+++ b/frontend/src/locales/ja-JP.json@@ -610,8 +610,28 @@},"ssl": {"ca-cert": "CA証明書",+ "ca-empty-uses-system-trust": "空欄のままにすると、システムの信頼ストアを使用します",+ "ca-path": "CA証明書のパス",+ "ca-placeholder": "YOUR_CA_CERTIFICATEを入力またはドラッグ&ドロップ",+ "ca-source": {+ "file-path": "ファイルパス",+ "inline-pem": "インラインPEM",+ "self": "CA証明書のソース",+ "system-trust": "システム信頼"+ },"client-cert": "クライアント証明書",+ "client-cert-path": "クライアント証明書のパス",+ "client-cert-placeholder": "YOUR_CLIENT_CERTを入力またはドラッグ&ドロップ",+ "client-cert-source": {+ "file-path": "ファイルパス",+ "inline-pem": "インラインPEM",+ "none": "なし",+ "self": "クライアント証明書のソース"+ },"client-key": "クライアントキー",+ "client-key-path": "クライアントキーのパス",+ "client-key-placeholder": "YOUR_CLIENT_KEYを入力またはドラッグ&ドロップ",+ "configured": "設定済み","verify-certificate": "TLS証明書を検証","verify-certificate-tooltip": "安全な接続のためにTLS証明書の検証を有効にします。開発環境や証明書が適切に検証できない場合(自己署名証明書、VPN環境など)にのみ無効にしてください。警告:検証を無効にすることは安全ではありません"},diff --git a/frontend/src/locales/vi-VN.json b/frontend/src/locales/vi-VN.jsonindex bde8ac462a..98bd824826 100644--- a/frontend/src/locales/vi-VN.json+++ b/frontend/src/locales/vi-VN.json@@ -610,8 +610,28 @@},"ssl": {"ca-cert": "Chứng chỉ CA",+ "ca-empty-uses-system-trust": "Để trống để dùng kho tin cậy của hệ thống",+ "ca-path": "Đường dẫn chứng chỉ CA",+ "ca-placeholder": "Nhập hoặc kéo thả YOUR_CA_CERTIFICATE",+ "ca-source": {+ "file-path": "Đường dẫn tệp",+ "inline-pem": "PEM nội tuyến",+ "self": "Nguồn chứng chỉ CA",+ "system-trust": "Tin cậy hệ thống"+ },"client-cert": "Chứng chỉ máy khách",+ "client-cert-path": "Đường dẫn chứng chỉ máy khách",+ "client-cert-placeholder": "Nhập hoặc kéo thả YOUR_CLIENT_CERT",+ "client-cert-source": {+ "file-path": "Đường dẫn tệp",+ "inline-pem": "PEM nội tuyến",+ "none": "Không có",+ "self": "Nguồn chứng chỉ máy khách"+ },"client-key": "Khóa máy khách",+ "client-key-path": "Đường dẫn khóa máy khách",+ "client-key-placeholder": "Nhập hoặc kéo thả YOUR_CLIENT_KEY",+ "configured": "Đã cấu hình","verify-certificate": "Xác minh chứng chỉ TLS","verify-certificate-tooltip": "Bật xác minh chứng chỉ TLS để kết nối an toàn. Chỉ tắt cho môi trường phát triển hoặc khi không thể xác thực chứng chỉ đúng cách (ví dụ: chứng chỉ tự ký, môi trường VPN). Cảnh báo: Tắt xác minh là không an toàn"},diff --git a/frontend/src/locales/zh-CN.json b/frontend/src/locales/zh-CN.jsonindex fdc1dfe2cb..9462080c84 100644--- a/frontend/src/locales/zh-CN.json+++ b/frontend/src/locales/zh-CN.json@@ -610,8 +610,28 @@},"ssl": {"ca-cert": "CA 证书",+ "ca-empty-uses-system-trust": "留空以使用系统信任存储",+ "ca-path": "CA 证书路径",+ "ca-placeholder": "输入或拖放 YOUR_CA_CERTIFICATE",+ "ca-source": {+ "file-path": "文件路径",+ "inline-pem": "内联 PEM",+ "self": "CA 证书来源",+ "system-trust": "系统信任"+ },"client-cert": "客户端证书",+ "client-cert-path": "客户端证书路径",+ "client-cert-placeholder": "输入或拖放 YOUR_CLIENT_CERT",+ "client-cert-source": {+ "file-path": "文件路径",+ "inline-pem": "内联 PEM",+ "none": "无",+ "self": "客户端证书来源"+ },"client-key": "客户端密钥",+ "client-key-path": "客户端密钥路径",+ "client-key-placeholder": "输入或拖放 YOUR_CLIENT_KEY",+ "configured": "已配置","verify-certificate": "验证 TLS 证书","verify-certificate-tooltip": "启用 TLS 证书验证以确保安全连接。仅在开发环境或证书无法正确验证的情况下禁用(例如自签名证书、VPN 环境)。警告:禁用验证是不安全的"},diff --git a/frontend/src/react/components/instance/DataSourceForm.tsx b/frontend/src/react/components/instance/DataSourceForm.tsxindex 57f999d12c..323212e97d 100644--- a/frontend/src/react/components/instance/DataSourceForm.tsx+++ b/frontend/src/react/components/instance/DataSourceForm.tsx@@ -1,6 +1,6 @@import { create } from "@bufbuild/protobuf";import { Info } from "lucide-react";-import { useCallback, useEffect, useMemo, useState } from "react";+import { useCallback, useEffect, useMemo, useRef, useState } from "react";import { useTranslation } from "react-i18next";import { LearnMoreLink } from "@/react/components/LearnMoreLink";import { Button } from "@/react/components/ui/button";@@ -27,11 +27,18 @@ import {import { onlyAllowNumber } from "@/utils";import { CreateDataSourceExample } from "./CreateDataSourceExample";import { CredentialSourceForm } from "./CredentialSourceForm";-import type { EditDataSource } from "./common";+import type { EditDataSource, TlsUpdateState } from "./common";import { useInstanceFormContext } from "./InstanceFormContext";import { hasInfoContent, type InfoSection } from "./info-content";import { SshConnectionForm } from "./SshConnectionForm";import { SslCertificateForm } from "./SslCertificateForm";+import {+ applyLocalTlsCaSource,+ applyLocalTlsClientCertSource,+ disableLocalTls,+ getLocalTlsCaSource,+ getLocalTlsClientCertSource,+} from "./tls";interface DataSourceFormProps {dataSource: EditDataSource;@@ -41,6 +48,29 @@ interface DataSourceFormProps {onOpenInfoPanel?: (section: InfoSection) => void;}+const mergeTlsUpdateState = (+ current: TlsUpdateState | undefined,+ next: TlsUpdateState+): TlsUpdateState => {+ if (current === true || next === true) {+ return true;+ }+ if (!current) {+ return next;+ }+ if (typeof current === "boolean") {+ return next;+ }+ if (typeof next === "boolean") {+ return current;+ }+ return {+ useSsl: current.useSsl || next.useSsl,+ ca: current.ca || next.ca,+ clientCert: current.clientCert || next.clientCert,+ };+};+export function DataSourceForm({dataSource,hideOptions = false,@@ -81,6 +111,13 @@ export function DataSourceForm({);const [newParamKey, setNewParamKey] = useState("");const [newParamValue, setNewParamValue] = useState("");+ const [localTlsCaSource, setLocalTlsCaSource] = useState(+ getLocalTlsCaSource(dataSource)+ );+ const [localTlsClientCertSource, setLocalTlsClientCertSource] = useState(+ getLocalTlsClientCertSource(dataSource)+ );+ const previousDataSourceIdRef = useRef(dataSource.id);// Sync passwordType when externalSecret changesuseEffect(() => {@@ -93,6 +130,35 @@ export function DataSourceForm({}}, [dataSource.externalSecret]);+ useEffect(() => {+ if (previousDataSourceIdRef.current !== dataSource.id) {+ previousDataSourceIdRef.current = dataSource.id;+ setLocalTlsCaSource(getLocalTlsCaSource(dataSource));+ setLocalTlsClientCertSource(getLocalTlsClientCertSource(dataSource));+ return;+ }+ if (!dataSource.updateSsl) {+ setLocalTlsCaSource(getLocalTlsCaSource(dataSource));+ setLocalTlsClientCertSource(getLocalTlsClientCertSource(dataSource));+ }+ }, [+ dataSource.id,+ dataSource.useSsl,+ dataSource.sslCa,+ dataSource.sslCert,+ dataSource.sslKey,+ dataSource.sslCaPath,+ dataSource.sslCertPath,+ dataSource.sslKeyPath,+ dataSource.sslCaSet,+ dataSource.sslCertSet,+ dataSource.sslKeySet,+ dataSource.sslCaPathSet,+ dataSource.sslCertPathSet,+ dataSource.sslKeyPathSet,+ dataSource.updateSsl,+ ]);+const update = useCallback((partial: Partial<EditDataSource>) => {onDataSourceChange({ ...dataSource, ...partial });@@ -306,14 +372,6 @@ export function DataSourceForm({update({ port: value.trim() });};- const handleUseSslChanged = (useSSL: boolean) => {- update({ useSsl: useSSL, updateSsl: true });- };-- const handleEditSSL = () => {- update({ sslCa: "", sslCert: "", sslKey: "", updateSsl: true });- };-const handleSSHChange = (value: Partial<{sshHost: string;@@ -1590,19 +1648,6 @@ export function DataSourceForm({<div className="sm:col-span-3 sm:col-start-1"><div className="flex items-center justify-start gap-x-2 textlabel">{t("data-source.ssl-connection")}- <button- type="button"- className={`relative inline-flex h-5 w-9 items-center rounded-full transition-colors ${- dataSource.useSsl ? "bg-accent" : "bg-control-bg-hover"- }`}- onClick={() => handleUseSslChanged(!dataSource.useSsl)}- >- <span- className={`inline-block size-3.5 transform rounded-full bg-background transition-transform ${- dataSource.useSsl ? "translate-x-4.5" : "translate-x-0.5"- }`}- />- </button>{isCreating && onOpenInfoPanel && hasSslInfo && (<buttontype="button"@@ -1613,41 +1658,107 @@ export function DataSourceForm({</button>)}</div>- {dataSource.useSsl && (- <>- {dataSource.pendingCreate || dataSource.updateSsl ? (- <SslCertificateForm- verify={dataSource.verifyTlsCertificate}- onVerifyChange={(val) =>- update({ verifyTlsCertificate: val })- }- ca={dataSource.sslCa}- onCaChange={(val) =>- update({ sslCa: val, updateSsl: true })- }- cert={dataSource.sslCert}- onCertChange={(val) =>- update({ sslCert: val, updateSsl: true })- }- sslKey={dataSource.sslKey}- onKeyChange={(val) =>- update({ sslKey: val, updateSsl: true })- }- engineType={basicInfo.engine}- disabled={!allowEdit}- />- ) : (- <Button- variant="outline"- className="mt-2"- disabled={!allowEdit}- onClick={handleEditSSL}- >- {t("common.edit")} - {t("common.write-only")}- </Button>- )}- </>- )}+ <SslCertificateForm+ useSsl={dataSource.useSsl}+ onUseSslChange={(useSsl) => {+ if (useSsl) {+ update({+ useSsl: true,+ updateSsl: mergeTlsUpdateState(dataSource.updateSsl, {+ useSsl: true,+ }),+ });+ return;+ }+ setLocalTlsCaSource("SYSTEM_TRUST");+ setLocalTlsClientCertSource("NONE");+ update({ ...disableLocalTls(dataSource), updateSsl: true });+ }}+ caSource={localTlsCaSource}+ onCaSourceChange={(source) => {+ setLocalTlsCaSource(source);+ update({+ ...applyLocalTlsCaSource(dataSource, source),+ updateSsl: mergeTlsUpdateState(dataSource.updateSsl, {+ ca: true,+ }),+ });+ }}+ clientCertSource={localTlsClientCertSource}+ onClientCertSourceChange={(source) => {+ setLocalTlsClientCertSource(source);+ update({+ ...applyLocalTlsClientCertSource(dataSource, source),+ updateSsl: mergeTlsUpdateState(dataSource.updateSsl, {+ clientCert: true,+ }),+ });+ }}+ verify={dataSource.verifyTlsCertificate}+ onVerifyChange={(val) => update({ verifyTlsCertificate: val })}+ ca={dataSource.sslCa}+ onCaChange={(val) =>+ update({+ sslCa: val,+ updateSsl: mergeTlsUpdateState(dataSource.updateSsl, {+ ca: true,+ }),+ })+ }+ caPath={dataSource.sslCaPath}+ hasCa={dataSource.sslCaSet}+ hasCaPath={dataSource.sslCaPathSet}+ onCaPathChange={(val) =>+ update({+ sslCaPath: val,+ updateSsl: mergeTlsUpdateState(dataSource.updateSsl, {+ ca: true,+ }),+ })+ }+ cert={dataSource.sslCert}+ hasCert={dataSource.sslCertSet}+ onCertChange={(val) =>+ update({+ sslCert: val,+ updateSsl: mergeTlsUpdateState(dataSource.updateSsl, {+ clientCert: true,+ }),+ })+ }+ certPath={dataSource.sslCertPath}+ hasCertPath={dataSource.sslCertPathSet}+ onCertPathChange={(val) =>+ update({+ sslCertPath: val,+ updateSsl: mergeTlsUpdateState(dataSource.updateSsl, {+ clientCert: true,+ }),+ })+ }+ sslKey={dataSource.sslKey}+ hasKey={dataSource.sslKeySet}+ onKeyChange={(val) =>+ update({+ sslKey: val,+ updateSsl: mergeTlsUpdateState(dataSource.updateSsl, {+ clientCert: true,+ }),+ })+ }+ keyPath={dataSource.sslKeyPath}+ hasKeyPath={dataSource.sslKeyPathSet}+ onKeyPathChange={(val) =>+ update({+ sslKeyPath: val,+ updateSsl: mergeTlsUpdateState(dataSource.updateSsl, {+ clientCert: true,+ }),+ })+ }+ engineType={basicInfo.engine}+ disabled={!allowEdit}+ /></div>)}diff --git a/frontend/src/react/components/instance/InstanceFormBody.tsx b/frontend/src/react/components/instance/InstanceFormBody.tsxindex 96316177ed..09647ff574 100644--- a/frontend/src/react/components/instance/InstanceFormBody.tsx+++ b/frontend/src/react/components/instance/InstanceFormBody.tsx@@ -50,6 +50,7 @@ import {urlfy,} from "@/utils";import type { EditDataSource } from "./common";+import { hasSslConfig } from "./common";import {EngineIconPath,MongoDBConnectionStringSchemaList,@@ -854,7 +855,6 @@ export function InstanceFormBody({ onOpenInfoPanel }: InstanceFormBodyProps) {if (!ds) return false;const hasExtraParameters =Object.keys(ds.extraConnectionParameters ?? {}).length > 0;- const hasSslConfig = !!(ds.useSsl || ds.sslCa || ds.sslCert || ds.sslKey);const hasSshConfig = !!(ds.sshHost ||ds.sshPort ||@@ -862,7 +862,7 @@ export function InstanceFormBody({ onOpenInfoPanel }: InstanceFormBodyProps) {ds.sshPassword ||ds.sshPrivateKey);- return hasExtraParameters || hasSslConfig || hasSshConfig;+ return hasExtraParameters || hasSslConfig(ds) || hasSshConfig;}, [editingDataSource]);// Collapse state management based on visibility and configurationdiff --git a/frontend/src/react/components/instance/InstanceFormButtons.tsx b/frontend/src/react/components/instance/InstanceFormButtons.tsxindex a24a59b4ad..d4c1bfa28d 100644--- a/frontend/src/react/components/instance/InstanceFormButtons.tsx+++ b/frontend/src/react/components/instance/InstanceFormButtons.tsx@@ -27,6 +27,7 @@ import {calcDataSourceUpdateMask,extractBasicInfo,extractDataSourceEditState,+ hasSslConfig,} from "./common";import { useInstanceFormContext } from "./InstanceFormContext";@@ -133,7 +134,7 @@ export function InstanceFormButtons({const hasConfiguredConnectionOptions = (ds: EditDataSource): boolean => {const hasExtraParameters =Object.keys(ds.extraConnectionParameters ?? {}).length > 0;- const hasSslConfig = !!(ds.useSsl || ds.sslCa || ds.sslCert || ds.sslKey);+ const hasSslConfigValue = hasSslConfig(ds);const hasSshConfig = !!(ds.sshHost ||ds.sshPort ||@@ -141,7 +142,7 @@ export function InstanceFormButtons({ds.sshPassword ||ds.sshPrivateKey);- return hasExtraParameters || hasSslConfig || hasSshConfig;+ return hasExtraParameters || hasSslConfigValue || hasSshConfig;};const maybeOpenConnectionOptions = (ds: EditDataSource) => {diff --git a/frontend/src/react/components/instance/SslCertificateForm.test.tsx b/frontend/src/react/components/instance/SslCertificateForm.test.tsxnew file mode 100644index 0000000000..9b3405dd3e--- /dev/null+++ b/frontend/src/react/components/instance/SslCertificateForm.test.tsx@@ -0,0 +1,111 @@+import { act } from "react";+import { createRoot } from "react-dom/client";+import { afterEach, describe, expect, test, vi } from "vitest";+import { Engine } from "@/types/proto-es/v1/common_pb";+import { SslCertificateForm } from "./SslCertificateForm";++(+ globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }+).IS_REACT_ACT_ENVIRONMENT = true;++vi.mock("react-i18next", () => ({+ useTranslation: () => ({+ t: (key: string) => key,+ }),+}));++describe("SslCertificateForm", () => {+ afterEach(() => {+ document.body.innerHTML = "";+ });++ test("renders the CA trust hint for inline PEM input", () => {+ const container = document.createElement("div");+ document.body.appendChild(container);+ const root = createRoot(container);++ act(() => {+ root.render(+ <SslCertificateForm+ ca=""+ cert=""+ sslKey=""+ engineType={Engine.POSTGRES}+ />+ );+ });++ expect(container.textContent).toContain(+ "data-source.ssl.ca-empty-uses-system-trust"+ );++ act(() => {+ root.unmount();+ });+ });++ test("renders explicit CA and client certificate source controls", () => {+ const container = document.createElement("div");+ document.body.appendChild(container);+ const root = createRoot(container);++ act(() => {+ root.render(+ <SslCertificateForm+ useSsl={true}+ caSource="SYSTEM_TRUST"+ onCaSourceChange={() => {}}+ clientCertSource="FILE_PATH"+ onClientCertSourceChange={() => {}}+ showKeyAndCert={true}+ />+ );+ });++ expect(container.textContent).toContain("data-source.ssl.ca-source.self");+ expect(container.textContent).toContain(+ "data-source.ssl.ca-source.system-trust"+ );+ expect(container.textContent).toContain(+ "data-source.ssl.client-cert-source.self"+ );+ expect(container.textContent).toContain(+ "data-source.ssl.client-cert-source.file-path"+ );++ act(() => {+ root.unmount();+ });+ });++ test("marks write-only TLS material as configured", () => {+ const container = document.createElement("div");+ document.body.appendChild(container);+ const root = createRoot(container);++ act(() => {+ root.render(+ <SslCertificateForm+ useSsl={true}+ caSource="INLINE_PEM"+ onCaSourceChange={() => {}}+ clientCertSource="FILE_PATH"+ onClientCertSourceChange={() => {}}+ hasCa={true}+ hasCertPath={true}+ hasKeyPath={true}+ showKeyAndCert={true}+ />+ );+ });++ expect(+ container.querySelectorAll('[data-testid="tls-configured-badge"]')+ ).toHaveLength(3);+ expect(container.textContent).toContain("data-source.ssl.configured");++ act(() => {+ root.unmount();+ });+ });+});diff --git a/frontend/src/react/components/instance/SslCertificateForm.tsx b/frontend/src/react/components/instance/SslCertificateForm.tsxindex 407b873073..113fa16dd2 100644--- a/frontend/src/react/components/instance/SslCertificateForm.tsx+++ b/frontend/src/react/components/instance/SslCertificateForm.tsx@@ -1,6 +1,9 @@import { Info } from "lucide-react";import { type DragEvent, useCallback } from "react";import { useTranslation } from "react-i18next";+import { Badge } from "@/react/components/ui/badge";+import { Input } from "@/react/components/ui/input";+import { RadioGroup, RadioGroupItem } from "@/react/components/ui/radio-group";import { Switch } from "@/react/components/ui/switch";import {Tabs,@@ -10,16 +13,44 @@ import {} from "@/react/components/ui/tabs";import { Tooltip } from "@/react/components/ui/tooltip";import { Engine } from "@/types/proto-es/v1/common_pb";+import {+ getLocalTlsCaSource,+ getLocalTlsClientCertSource,+ LOCAL_TLS_CA_SOURCE_FILE_PATH,+ LOCAL_TLS_CA_SOURCE_INLINE_PEM,+ LOCAL_TLS_CA_SOURCE_SYSTEM_TRUST,+ LOCAL_TLS_CLIENT_CERT_SOURCE_FILE_PATH,+ LOCAL_TLS_CLIENT_CERT_SOURCE_INLINE_PEM,+ LOCAL_TLS_CLIENT_CERT_SOURCE_NONE,+ type LocalTlsCaSource,+ type LocalTlsClientCertSource,+} from "./tls";interface SslCertificateFormProps {useSsl?: boolean;onUseSslChange?: (val: boolean) => void;+ caSource?: LocalTlsCaSource;+ onCaSourceChange?: (val: LocalTlsCaSource) => void;+ clientCertSource?: LocalTlsClientCertSource;+ onClientCertSourceChange?: (val: LocalTlsClientCertSource) => void;ca?: string;+ hasCa?: boolean;onCaChange?: (val: string) => void;+ caPath?: string;+ hasCaPath?: boolean;+ onCaPathChange?: (val: string) => void;cert?: string;+ hasCert?: boolean;onCertChange?: (val: string) => void;+ certPath?: string;+ hasCertPath?: boolean;+ onCertPathChange?: (val: string) => void;sslKey?: string;+ hasKey?: boolean;onKeyChange?: (val: string) => void;+ keyPath?: string;+ hasKeyPath?: boolean;+ onKeyPathChange?: (val: string) => void;disabled?: boolean;showVerify?: boolean;showKeyAndCert?: boolean;@@ -77,13 +108,121 @@ function DroppableTextarea({);}+function CaSourceSelector({+ value,+ onChange,+ disabled = false,+}: {+ value: LocalTlsCaSource;+ onChange: (value: LocalTlsCaSource) => void;+ disabled?: boolean;+}) {+ const { t } = useTranslation();+ const options: { value: LocalTlsCaSource; label: string }[] = [+ {+ value: LOCAL_TLS_CA_SOURCE_SYSTEM_TRUST,+ label: t("data-source.ssl.ca-source.system-trust"),+ },+ {+ value: LOCAL_TLS_CA_SOURCE_INLINE_PEM,+ label: t("data-source.ssl.ca-source.inline-pem"),+ },+ {+ value: LOCAL_TLS_CA_SOURCE_FILE_PATH,+ label: t("data-source.ssl.ca-source.file-path"),+ },+ ];++ return (+ <RadioGroup+ value={value}+ onValueChange={(next) => onChange(next as LocalTlsCaSource)}+ aria-label={t("data-source.ssl.ca-source.self")}+ className="mt-2 gap-x-4"+ >+ {options.map((option) => (+ <RadioGroupItem+ key={option.value}+ value={option.value}+ disabled={disabled}+ >+ {option.label}+ </RadioGroupItem>+ ))}+ </RadioGroup>+ );+}++function ClientCertSourceSelector({+ value,+ onChange,+ disabled = false,+}: {+ value: LocalTlsClientCertSource;+ onChange: (value: LocalTlsClientCertSource) => void;+ disabled?: boolean;+}) {+ const { t } = useTranslation();+ const options: { value: LocalTlsClientCertSource; label: string }[] = [+ {+ value: LOCAL_TLS_CLIENT_CERT_SOURCE_NONE,+ label: t("data-source.ssl.client-cert-source.none"),+ },+ {+ value: LOCAL_TLS_CLIENT_CERT_SOURCE_INLINE_PEM,+ label: t("data-source.ssl.client-cert-source.inline-pem"),+ },+ {+ value: LOCAL_TLS_CLIENT_CERT_SOURCE_FILE_PATH,+ label: t("data-source.ssl.client-cert-source.file-path"),+ },+ ];++ return (+ <RadioGroup+ value={value}+ onValueChange={(next) => onChange(next as LocalTlsClientCertSource)}+ aria-label={t("data-source.ssl.client-cert-source.self")}+ className="mt-2 gap-x-4"+ >+ {options.map((option) => (+ <RadioGroupItem+ key={option.value}+ value={option.value}+ disabled={disabled}+ >+ {option.label}+ </RadioGroupItem>+ ))}+ </RadioGroup>+ );+}+export function SslCertificateForm({+ useSsl,+ onUseSslChange,+ caSource,+ onCaSourceChange,+ clientCertSource,+ onClientCertSourceChange,ca = "",+ hasCa = false,onCaChange,+ caPath = "",+ hasCaPath = false,+ onCaPathChange,cert = "",+ hasCert = false,onCertChange,+ certPath = "",+ hasCertPath = false,+ onCertPathChange,sslKey = "",+ hasKey = false,onKeyChange,+ keyPath = "",+ hasKeyPath = false,+ onKeyPathChange,disabled = false,showVerify = true,showKeyAndCert = false,@@ -103,40 +242,246 @@ export function SslCertificateForm({const resolvedCaLabel = caLabel ?? t("data-source.ssl.ca-cert");const resolvedCertLabel = certLabel ?? t("data-source.ssl.client-cert");const resolvedKeyLabel = keyLabel ?? t("data-source.ssl.client-key");+ const resolvedCaPathLabel = t("data-source.ssl.ca-path");+ const resolvedCertPathLabel = t("data-source.ssl.client-cert-path");+ const resolvedKeyPathLabel = t("data-source.ssl.client-key-path");+ const resolvedConfiguredLabel = t("data-source.ssl.configured");+ const resolvedCaHint = t("data-source.ssl.ca-empty-uses-system-trust");+ const resolvedCaPlaceholder = t("data-source.ssl.ca-placeholder");+ const resolvedCertPlaceholder = t("data-source.ssl.client-cert-placeholder");+ const resolvedKeyPlaceholder = t("data-source.ssl.client-key-placeholder");+ const resolvedUseSsl = useSsl ?? true;+ const showUseSslSwitch = useSsl !== undefined && !!onUseSslChange;+ const showCaSourceUi = caSource !== undefined && !!onCaSourceChange;+ const showClientCertSourceUi =+ clientCertSource !== undefined && !!onClientCertSourceChange;+ const showPerGroupSourceUi = showCaSourceUi || showClientCertSourceUi;- const hasSSLKeyField = showKeyAndCert || ![Engine.MSSQL].includes(engineType);- const hasSSLCertField =+ const showKeyAndCertFields =showKeyAndCert || ![Engine.MSSQL].includes(engineType);- return (- <div className="mt-2 flex flex-col gap-y-1">- {showVerify && (- <div className="flex flex-row items-center gap-x-1">- <Switch- checked={verify}- onCheckedChange={(val) => onVerifyChange?.(val)}+ const inferredCaSource = getLocalTlsCaSource({+ useSsl: true,+ sslCa: ca,+ sslCert: cert,+ sslKey,+ sslCaPath: caPath,+ sslCertPath: certPath,+ sslKeyPath: keyPath,+ sslCaSet: false,+ sslCertSet: false,+ sslKeySet: false,+ sslCaPathSet: false,+ sslCertPathSet: false,+ sslKeyPathSet: false,+ });+ const inferredClientCertSource = getLocalTlsClientCertSource({+ useSsl: true,+ sslCa: ca,+ sslCert: cert,+ sslKey,+ sslCaPath: caPath,+ sslCertPath: certPath,+ sslKeyPath: keyPath,+ sslCaSet: false,+ sslCertSet: false,+ sslKeySet: false,+ sslCaPathSet: false,+ sslCertPathSet: false,+ sslKeyPathSet: false,+ });+ const resolvedCaSource = showCaSourceUi+ ? caSource!+ : inferredCaSource === LOCAL_TLS_CA_SOURCE_SYSTEM_TRUST+ ? LOCAL_TLS_CA_SOURCE_INLINE_PEM+ : inferredCaSource;+ const resolvedClientCertSource = showClientCertSourceUi+ ? clientCertSource!+ : inferredClientCertSource === LOCAL_TLS_CLIENT_CERT_SOURCE_NONE+ ? LOCAL_TLS_CLIENT_CERT_SOURCE_INLINE_PEM+ : inferredClientCertSource;+ const showConfiguredBadge = (hasStoredValue: boolean, visibleValue: string) =>+ hasStoredValue && !visibleValue;+ const renderLabel = (+ label: string,+ hasStoredValue: boolean,+ visibleValue: string+ ) => (+ <div className="flex items-center gap-x-2">+ <label className="textlabel block">{label}</label>+ {showConfiguredBadge(hasStoredValue, visibleValue) && (+ <Badge data-testid="tls-configured-badge" variant="success">+ {resolvedConfiguredLabel}+ </Badge>+ )}+ </div>+ );++ const renderCaMaterial = () => {+ if (resolvedCaSource === LOCAL_TLS_CA_SOURCE_SYSTEM_TRUST) {+ return <p className="mt-1 text-xs textinfolabel">{resolvedCaHint}</p>;+ }++ if (resolvedCaSource === LOCAL_TLS_CA_SOURCE_FILE_PATH) {+ return (+ <div className="flex flex-col gap-y-1">+ {renderLabel(resolvedCaPathLabel, hasCaPath, caPath)}+ <Input+ value={caPath}+ onChange={(e) => onCaPathChange?.(e.target.value)}+ disabled={disabled}+ placeholder={resolvedCaPathLabel}+ />+ </div>+ );+ }++ return (+ <div className="flex flex-col gap-y-1">+ {renderLabel(resolvedCaLabel, hasCa, ca)}+ <DroppableTextarea+ value={ca}+ onChange={(val) => onCaChange?.(val)}+ disabled={disabled}+ placeholder={resolvedCaPlaceholder}+ />+ <p className="text-xs textinfolabel">{resolvedCaHint}</p>+ </div>+ );+ };++ const renderClientCertMaterial = () => {+ if (+ !showKeyAndCertFields ||+ resolvedClientCertSource === LOCAL_TLS_CLIENT_CERT_SOURCE_NONE+ ) {+ return null;+ }++ if (resolvedClientCertSource === LOCAL_TLS_CLIENT_CERT_SOURCE_FILE_PATH) {+ return (+ <div className="flex flex-col gap-y-2">+ <div className="flex flex-col gap-y-1">+ {renderLabel(resolvedCertPathLabel, hasCertPath, certPath)}+ <Input+ value={certPath}+ onChange={(e) => onCertPathChange?.(e.target.value)}+ disabled={disabled}+ placeholder={resolvedCertPathLabel}+ />+ </div>+ <div className="flex flex-col gap-y-1">+ {renderLabel(resolvedKeyPathLabel, hasKeyPath, keyPath)}+ <Input+ value={keyPath}+ onChange={(e) => onKeyPathChange?.(e.target.value)}+ disabled={disabled}+ placeholder={resolvedKeyPathLabel}+ />+ </div>+ </div>+ );+ }++ return (+ <div className="flex flex-col gap-y-2">+ <div className="flex flex-col gap-y-1">+ {renderLabel(resolvedKeyLabel, hasKey, sslKey)}+ <DroppableTextarea+ value={sslKey}+ onChange={(val) => onKeyChange?.(val)}disabled={disabled}+ placeholder={resolvedKeyPlaceholder}/>- <label className="textlabel block">{resolvedVerifyLabel}</label>- {showTooltip && (- <Tooltip- content={t("data-source.ssl.verify-certificate-tooltip")}- side="right"- >- <Info className="size-4 text-warning" />- </Tooltip>+ </div>+ <div className="flex flex-col gap-y-1">+ {renderLabel(resolvedCertLabel, hasCert, cert)}+ <DroppableTextarea+ value={cert}+ onChange={(val) => onCertChange?.(val)}+ disabled={disabled}+ placeholder={resolvedCertPlaceholder}+ />+ </div>+ </div>+ );+ };++ const renderLegacyMaterial = () => {+ if (resolvedCaSource === LOCAL_TLS_CA_SOURCE_FILE_PATH) {+ return (+ <div className="flex flex-col gap-y-2">+ <div className="flex flex-col gap-y-1">+ {renderLabel(resolvedCaPathLabel, hasCaPath, caPath)}+ <Input+ value={caPath}+ onChange={(e) => onCaPathChange?.(e.target.value)}+ disabled={disabled}+ placeholder={resolvedCaPathLabel}+ />+ </div>+ {showKeyAndCertFields && (+ <div className="flex flex-col gap-y-1">+ {renderLabel(resolvedCertPathLabel, hasCertPath, certPath)}+ <Input+ value={certPath}+ onChange={(e) => onCertPathChange?.(e.target.value)}+ disabled={disabled}+ placeholder={resolvedCertPathLabel}+ />+ </div>+ )}+ {showKeyAndCertFields && (+ <div className="flex flex-col gap-y-1">+ {renderLabel(resolvedKeyPathLabel, hasKeyPath, keyPath)}+ <Input+ value={keyPath}+ onChange={(e) => onKeyPathChange?.(e.target.value)}+ disabled={disabled}+ placeholder={resolvedKeyPathLabel}+ />+ </div>)}</div>- )}+ );+ }+ return (<Tabs defaultValue="CA"><TabsList>- <TabsTrigger value="CA">{resolvedCaLabel}</TabsTrigger>- {hasSSLKeyField && (- <TabsTrigger value="KEY">{resolvedKeyLabel}</TabsTrigger>+ <TabsTrigger value="CA">+ <span className="inline-flex items-center gap-x-2">+ {resolvedCaLabel}+ {showConfiguredBadge(hasCa, ca) && (+ <Badge data-testid="tls-configured-badge" variant="success">+ {resolvedConfiguredLabel}+ </Badge>+ )}+ </span>+ </TabsTrigger>+ {showKeyAndCertFields && (+ <TabsTrigger value="KEY">+ <span className="inline-flex items-center gap-x-2">+ {resolvedKeyLabel}+ {showConfiguredBadge(hasKey, sslKey) && (+ <Badge data-testid="tls-configured-badge" variant="success">+ {resolvedConfiguredLabel}+ </Badge>+ )}+ </span>+ </TabsTrigger>)}- {hasSSLCertField && (- <TabsTrigger value="CERT">{resolvedCertLabel}</TabsTrigger>+ {showKeyAndCertFields && (+ <TabsTrigger value="CERT">+ <span className="inline-flex items-center gap-x-2">+ {resolvedCertLabel}+ {showConfiguredBadge(hasCert, cert) && (+ <Badge data-testid="tls-configured-badge" variant="success">+ {resolvedConfiguredLabel}+ </Badge>+ )}+ </span>+ </TabsTrigger>)}</TabsList><TabsPanel value="CA" className="pt-1">@@ -144,30 +489,111 @@ export function SslCertificateForm({value={ca}onChange={(val) => onCaChange?.(val)}disabled={disabled}- placeholder="Input or drag and drop YOUR_CA_CERTIFICATE"+ placeholder={resolvedCaPlaceholder}/>+ <p className="mt-1 text-xs textinfolabel">{resolvedCaHint}</p></TabsPanel>- {hasSSLKeyField && (+ {showKeyAndCertFields && (<TabsPanel value="KEY" className="pt-1"><DroppableTextareavalue={sslKey}onChange={(val) => onKeyChange?.(val)}disabled={disabled}- placeholder="Input or drag and drop YOUR_CLIENT_KEY"+ placeholder={resolvedKeyPlaceholder}/></TabsPanel>)}- {hasSSLCertField && (+ {showKeyAndCertFields && (<TabsPanel value="CERT" className="pt-1"><DroppableTextareavalue={cert}onChange={(val) => onCertChange?.(val)}disabled={disabled}- placeholder="Input or drag and drop YOUR_CLIENT_CERT"+ placeholder={resolvedCertPlaceholder}/></TabsPanel>)}</Tabs>+ );+ };++ return (+ <div className="mt-2 flex flex-col gap-y-2">+ {showUseSslSwitch && (+ <div className="flex flex-row items-center gap-x-1">+ <Switch+ checked={resolvedUseSsl}+ onCheckedChange={(val) => onUseSslChange?.(val)}+ disabled={disabled}+ />+ <label className="textlabel block">+ {t("data-source.ssl-connection")}+ </label>+ </div>+ )}++ {resolvedUseSsl && (+ <>+ {showVerify && (+ <div className="flex flex-row items-center gap-x-1">+ <Switch+ checked={verify}+ onCheckedChange={(val) => onVerifyChange?.(val)}+ disabled={disabled}+ />+ <label className="textlabel block">{resolvedVerifyLabel}</label>+ {showTooltip && (+ <Tooltip+ content={t("data-source.ssl.verify-certificate-tooltip")}+ side="right"+ >+ <Info className="size-4 text-warning" />+ </Tooltip>+ )}+ </div>+ )}++ {!showPerGroupSourceUi ? (+ renderLegacyMaterial()+ ) : (+ <>+ <div className="flex flex-col gap-y-2">+ {showCaSourceUi && (+ <div className="flex flex-col gap-y-1">+ <label className="textlabel block">+ {t("data-source.ssl.ca-source.self")}+ </label>+ <CaSourceSelector+ value={resolvedCaSource}+ onChange={onCaSourceChange}+ disabled={disabled}+ />+ </div>+ )}+ {renderCaMaterial()}+ </div>++ {showKeyAndCertFields && (+ <div className="flex flex-col gap-y-2">+ {showClientCertSourceUi && (+ <div className="flex flex-col gap-y-1">+ <label className="textlabel block">+ {t("data-source.ssl.client-cert-source.self")}+ </label>+ <ClientCertSourceSelector+ value={resolvedClientCertSource}+ onChange={onClientCertSourceChange}+ disabled={disabled}+ />+ </div>+ )}+ {renderClientCertMaterial()}+ </div>+ )}+ </>+ )}+ </>+ )}</div>);}diff --git a/frontend/src/react/components/instance/common.test.ts b/frontend/src/react/components/instance/common.test.tsnew file mode 100644index 0000000000..5d1de17f57--- /dev/null+++ b/frontend/src/react/components/instance/common.test.ts@@ -0,0 +1,97 @@+import { describe, expect, test } from "vitest";+import {+ applyLocalTlsCaSource,+ applyLocalTlsClientCertSource,+ getLocalTlsCaSource,+ getLocalTlsClientCertSource,+ SSL_UPDATE_MASK_FIELDS,+} from "./tls";++describe("TLS update mask fields", () => {+ test("includes the SSL path fields alongside inline material", () => {+ expect(SSL_UPDATE_MASK_FIELDS).toEqual([+ "use_ssl",+ "ssl_ca",+ "ssl_cert",+ "ssl_key",+ "ssl_ca_path",+ "ssl_cert_path",+ "ssl_key_path",+ ]);+ });+});++describe("TLS local source helpers", () => {+ test("treats empty CA material with SSL enabled as system trust", () => {+ expect(getLocalTlsCaSource({ useSsl: true })).toBe("SYSTEM_TRUST");+ });++ test("clears only CA fields when selecting system trust", () => {+ const next = applyLocalTlsCaSource(+ {+ useSsl: true,+ sslCa: "inline-ca",+ sslCaPath: "/tmp/ca.pem",+ sslCert: "inline-cert",+ sslKeyPath: "/tmp/key.pem",+ sslCertPathSet: true,+ sslKeyPathSet: true,+ } as never,+ "SYSTEM_TRUST"+ );+ expect(next.sslCa).toBe("");+ expect(next.sslCaPath).toBe("");+ expect(next.sslCert).toBe("inline-cert");+ expect(next.sslKeyPath).toBe("/tmp/key.pem");+ expect(next.sslCertPathSet).toBe(true);+ expect(next.sslKeyPathSet).toBe(true);+ });++ test("clears only client cert fields when selecting none", () => {+ const next = applyLocalTlsClientCertSource(+ {+ useSsl: true,+ sslCaPath: "/tmp/ca.pem",+ sslCert: "inline-cert",+ sslKey: "inline-key",+ sslCertPath: "/tmp/cert.pem",+ sslKeyPath: "/tmp/key.pem",+ sslCaPathSet: true,+ } as never,+ "NONE"+ );+ expect(next.sslCaPath).toBe("/tmp/ca.pem");+ expect(next.sslCaPathSet).toBe(true);+ expect(next.sslCert).toBe("");+ expect(next.sslKey).toBe("");+ expect(next.sslCertPath).toBe("");+ expect(next.sslKeyPath).toBe("");+ });++ test("infers client certificate source from path presence flags", () => {+ expect(+ getLocalTlsClientCertSource({+ useSsl: true,+ sslCertPathSet: true,+ } as never)+ ).toBe("FILE_PATH");+ });++ test("infers client certificate source from inline presence flags", () => {+ expect(+ getLocalTlsClientCertSource({+ useSsl: true,+ sslCertSet: true,+ } as never)+ ).toBe("INLINE_PEM");+ });++ test("infers CA source from inline presence flag", () => {+ expect(+ getLocalTlsCaSource({+ useSsl: true,+ sslCaSet: true,+ } as never)+ ).toBe("INLINE_PEM");+ });+});diff --git a/frontend/src/react/components/instance/common.ts b/frontend/src/react/components/instance/common.tsindex 647bcdf15d..7cef99b6b3 100644--- a/frontend/src/react/components/instance/common.ts+++ b/frontend/src/react/components/instance/common.ts@@ -13,6 +13,25 @@ import {} from "@/types/proto-es/v1/instance_service_pb";import { PlanType } from "@/types/proto-es/v1/subscription_service_pb";import { calcUpdateMask } from "@/utils";+import { hasSslConfig, SSL_UPDATE_MASK_FIELDS } from "./tls";++export type TlsUpdateState =+ | boolean+ | {+ useSsl?: boolean;+ ca?: boolean;+ clientCert?: boolean;+ };++const SSL_CA_UPDATE_MASK_FIELDS = ["use_ssl", "ssl_ca", "ssl_ca_path"] as const;++const SSL_CLIENT_CERT_UPDATE_MASK_FIELDS = [+ "use_ssl",+ "ssl_cert",+ "ssl_key",+ "ssl_cert_path",+ "ssl_key_path",+] as const;export type BasicInfo = Omit<Instance,@@ -25,7 +44,7 @@ export type EditDataSource = DataSource & {updatedMasterPassword: string;useEmptyPassword?: boolean;useEmptyMasterPassword?: boolean;- updateSsl?: boolean;+ updateSsl?: TlsUpdateState;extraConnectionParameters?: Record<string, string>;};@@ -126,11 +145,26 @@ export const calcDataSourceUpdateMask = (editing.password = "";updateMask.add("password");}- if (updateSsl) {- updateMask.add("use_ssl");- updateMask.add("ssl_ca");- updateMask.add("ssl_key");- updateMask.add("ssl_cert");+ updateMask.delete("ssl_ca_set");+ updateMask.delete("ssl_cert_set");+ updateMask.delete("ssl_key_set");+ updateMask.delete("ssl_ca_path_set");+ updateMask.delete("ssl_cert_path_set");+ updateMask.delete("ssl_key_path_set");+ if (updateSsl === true) {+ SSL_UPDATE_MASK_FIELDS.forEach((field) => updateMask.add(field));+ } else if (updateSsl) {+ if (updateSsl.useSsl) {+ updateMask.add("use_ssl");+ }+ if (updateSsl.ca) {+ SSL_CA_UPDATE_MASK_FIELDS.forEach((field) => updateMask.add(field));+ }+ if (updateSsl.clientCert) {+ SSL_CLIENT_CERT_UPDATE_MASK_FIELDS.forEach((field) =>+ updateMask.add(field)+ );+ }}if (updateMask.has("iam_extension")) {@@ -150,3 +184,5 @@ export const calcDataSourceUpdateMask = (return Array.from(updateMask);};++export { hasSslConfig };diff --git a/frontend/src/react/components/instance/tls.ts b/frontend/src/react/components/instance/tls.tsnew file mode 100644index 0000000000..a8ac957e2b--- /dev/null+++ b/frontend/src/react/components/instance/tls.ts@@ -0,0 +1,245 @@+import { cloneDeep } from "lodash-es";+import type { DataSource } from "@/types/proto-es/v1/instance_service_pb";++export const LOCAL_TLS_SOURCE_DISABLED = "DISABLED" as const;+export const LOCAL_TLS_SOURCE_INLINE_PEM = "INLINE_PEM" as const;+export const LOCAL_TLS_SOURCE_FILE_PATH = "FILE_PATH" as const;++export type LocalTlsSource =+ | typeof LOCAL_TLS_SOURCE_DISABLED+ | typeof LOCAL_TLS_SOURCE_INLINE_PEM+ | typeof LOCAL_TLS_SOURCE_FILE_PATH;++export const LOCAL_TLS_CA_SOURCE_SYSTEM_TRUST = "SYSTEM_TRUST" as const;+export const LOCAL_TLS_CA_SOURCE_INLINE_PEM = "INLINE_PEM" as const;+export const LOCAL_TLS_CA_SOURCE_FILE_PATH = "FILE_PATH" as const;++export const LOCAL_TLS_CLIENT_CERT_SOURCE_NONE = "NONE" as const;+export const LOCAL_TLS_CLIENT_CERT_SOURCE_INLINE_PEM = "INLINE_PEM" as const;+export const LOCAL_TLS_CLIENT_CERT_SOURCE_FILE_PATH = "FILE_PATH" as const;++export type LocalTlsCaSource =+ | typeof LOCAL_TLS_CA_SOURCE_SYSTEM_TRUST+ | typeof LOCAL_TLS_CA_SOURCE_INLINE_PEM+ | typeof LOCAL_TLS_CA_SOURCE_FILE_PATH;++export type LocalTlsClientCertSource =+ | typeof LOCAL_TLS_CLIENT_CERT_SOURCE_NONE+ | typeof LOCAL_TLS_CLIENT_CERT_SOURCE_INLINE_PEM+ | typeof LOCAL_TLS_CLIENT_CERT_SOURCE_FILE_PATH;++export const SSL_UPDATE_MASK_FIELDS = [+ "use_ssl",+ "ssl_ca",+ "ssl_cert",+ "ssl_key",+ "ssl_ca_path",+ "ssl_cert_path",+ "ssl_key_path",+] as const;++type LocalTlsDataSource = Partial<+ Pick<+ DataSource,+ | "useSsl"+ | "sslCa"+ | "sslCert"+ | "sslKey"+ | "sslCaPath"+ | "sslCertPath"+ | "sslKeyPath"+ | "sslCaSet"+ | "sslCertSet"+ | "sslKeySet"+ | "sslCaPathSet"+ | "sslCertPathSet"+ | "sslKeyPathSet"+ >+>;++const clearLocalTlsCaFields = (ds: DataSource): void => {+ ds.sslCa = "";+ ds.sslCaPath = "";+ ds.sslCaSet = false;+ ds.sslCaPathSet = false;+};++const clearLocalTlsClientCertFields = (ds: DataSource): void => {+ ds.sslCert = "";+ ds.sslKey = "";+ ds.sslCertPath = "";+ ds.sslKeyPath = "";+ ds.sslCertSet = false;+ ds.sslKeySet = false;+ ds.sslCertPathSet = false;+ ds.sslKeyPathSet = false;+};++export const hasSslConfig = (ds: LocalTlsDataSource | undefined): boolean => {+ if (!ds) return false;+ return !!(+ ds.useSsl ||+ ds.sslCa ||+ ds.sslCert ||+ ds.sslKey ||+ ds.sslCaPath ||+ ds.sslCertPath ||+ ds.sslKeyPath ||+ ds.sslCaSet ||+ ds.sslCertSet ||+ ds.sslKeySet ||+ ds.sslCaPathSet ||+ ds.sslCertPathSet ||+ ds.sslKeyPathSet+ );+};++export const getLocalTlsCaSource = (+ ds: LocalTlsDataSource | undefined+): LocalTlsCaSource => {+ if (!ds?.useSsl) return LOCAL_TLS_CA_SOURCE_SYSTEM_TRUST;+ if (ds.sslCaPath || ds.sslCaPathSet) {+ return LOCAL_TLS_CA_SOURCE_FILE_PATH;+ }+ if (ds.sslCa || ds.sslCaSet) {+ return LOCAL_TLS_CA_SOURCE_INLINE_PEM;+ }+ return LOCAL_TLS_CA_SOURCE_SYSTEM_TRUST;+};++export const getLocalTlsClientCertSource = (+ ds: LocalTlsDataSource | undefined+): LocalTlsClientCertSource => {+ if (!ds?.useSsl) return LOCAL_TLS_CLIENT_CERT_SOURCE_NONE;+ if (+ ds.sslCertPath ||+ ds.sslKeyPath ||+ ds.sslCertPathSet ||+ ds.sslKeyPathSet+ ) {+ return LOCAL_TLS_CLIENT_CERT_SOURCE_FILE_PATH;+ }+ if (ds.sslCert || ds.sslKey || ds.sslCertSet || ds.sslKeySet) {+ return LOCAL_TLS_CLIENT_CERT_SOURCE_INLINE_PEM;+ }+ return LOCAL_TLS_CLIENT_CERT_SOURCE_NONE;+};++export const applyLocalTlsCaSource = (+ ds: DataSource,+ source: LocalTlsCaSource+): DataSource => {+ const next = cloneDeep(ds);+ switch (source) {+ case LOCAL_TLS_CA_SOURCE_SYSTEM_TRUST:+ next.useSsl = true;+ clearLocalTlsCaFields(next);+ break;+ case LOCAL_TLS_CA_SOURCE_INLINE_PEM:+ next.useSsl = true;+ next.sslCaPath = "";+ next.sslCaPathSet = false;+ break;+ case LOCAL_TLS_CA_SOURCE_FILE_PATH:+ next.useSsl = true;+ next.sslCa = "";+ next.sslCaSet = false;+ break;+ }+ return next;+};++export const applyLocalTlsClientCertSource = (+ ds: DataSource,+ source: LocalTlsClientCertSource+): DataSource => {+ const next = cloneDeep(ds);+ switch (source) {+ case LOCAL_TLS_CLIENT_CERT_SOURCE_NONE:+ next.useSsl = true;+ clearLocalTlsClientCertFields(next);+ break;+ case LOCAL_TLS_CLIENT_CERT_SOURCE_INLINE_PEM:+ next.useSsl = true;+ next.sslCertPath = "";+ next.sslKeyPath = "";+ next.sslCertPathSet = false;+ next.sslKeyPathSet = false;+ break;+ case LOCAL_TLS_CLIENT_CERT_SOURCE_FILE_PATH:+ next.useSsl = true;+ next.sslCert = "";+ next.sslKey = "";+ next.sslCertSet = false;+ next.sslKeySet = false;+ break;+ }+ return next;+};++export const disableLocalTls = (ds: DataSource): DataSource => {+ const next = cloneDeep(ds);+ next.useSsl = false;+ next.sslCa = "";+ next.sslCert = "";+ next.sslKey = "";+ next.sslCaPath = "";+ next.sslCertPath = "";+ next.sslKeyPath = "";+ next.sslCaSet = false;+ next.sslCertSet = false;+ next.sslKeySet = false;+ next.sslCaPathSet = false;+ next.sslCertPathSet = false;+ next.sslKeyPathSet = false;+ return next;+};++export const getLocalTlsSource = (+ ds: LocalTlsDataSource | undefined+): LocalTlsSource => {+ if (!ds?.useSsl) return LOCAL_TLS_SOURCE_DISABLED;+ if (+ ds.sslCaPath ||+ ds.sslCertPath ||+ ds.sslKeyPath ||+ ds.sslCaPathSet ||+ ds.sslCertPathSet ||+ ds.sslKeyPathSet+ ) {+ return LOCAL_TLS_SOURCE_FILE_PATH;+ }+ return LOCAL_TLS_SOURCE_INLINE_PEM;+};++export const applyLocalTlsSource = (+ ds: DataSource,+ source: LocalTlsSource+): DataSource => {+ const next = cloneDeep(ds);+ switch (source) {+ case LOCAL_TLS_SOURCE_DISABLED:+ return disableLocalTls(next);+ case LOCAL_TLS_SOURCE_INLINE_PEM:+ next.useSsl = true;+ next.sslCaPath = "";+ next.sslCertPath = "";+ next.sslKeyPath = "";+ next.sslCaPathSet = false;+ next.sslCertPathSet = false;+ next.sslKeyPathSet = false;+ break;+ case LOCAL_TLS_SOURCE_FILE_PATH:+ next.useSsl = true;+ next.sslCa = "";+ next.sslCert = "";+ next.sslKey = "";+ next.sslCaSet = false;+ next.sslCertSet = false;+ next.sslKeySet = false;+ break;+ }+ return next;+};++export type { LocalTlsDataSource };diff --git a/frontend/src/react/locales/en-US.json b/frontend/src/react/locales/en-US.jsonindex 303ce600dd..ce82c146b9 100644--- a/frontend/src/react/locales/en-US.json+++ b/frontend/src/react/locales/en-US.json@@ -530,8 +530,28 @@},"ssl": {"ca-cert": "CA Certificate",+ "ca-empty-uses-system-trust": "Leave empty to use the system trust store",+ "ca-path": "CA Certificate Path",+ "ca-placeholder": "Input or drag and drop YOUR_CA_CERTIFICATE",+ "ca-source": {+ "file-path": "File Path",+ "inline-pem": "Inline PEM",+ "self": "CA Certificate Source",+ "system-trust": "System Trust"+ },"client-cert": "Client Certificate",+ "client-cert-path": "Client Certificate Path",+ "client-cert-placeholder": "Input or drag and drop YOUR_CLIENT_CERT",+ "client-cert-source": {+ "file-path": "File Path",+ "inline-pem": "Inline PEM",+ "none": "None",+ "self": "Client Certificate Source"+ },"client-key": "Client Key",+ "client-key-path": "Client Key Path",+ "client-key-placeholder": "Input or drag and drop YOUR_CLIENT_KEY",+ "configured": "Configured","verify-certificate": "Verify TLS certificate","verify-certificate-tooltip": "Enable TLS certificate verification for secure connections. Disable only for development or when certificates cannot be properly validated (e.g., self-signed certs, VPN environments). Warning: Disabling verification is insecure"},@@ -563,8 +583,12 @@"data-source.ssh.user": "User","data-source.ssl-connection": "SSL Connection","data-source.ssl.ca-cert": "CA Certificate",+ "data-source.ssl.ca-empty-uses-system-trust": "Leave empty to use the system trust store",+ "data-source.ssl.ca-path": "CA Certificate Path","data-source.ssl.client-cert": "Client Certificate",+ "data-source.ssl.client-cert-path": "Client Certificate Path","data-source.ssl.client-key": "Client Key",+ "data-source.ssl.client-key-path": "Client Key Path","data-source.ssl.verify-certificate": "Verify TLS certificate","data-source.ssl.verify-certificate-tooltip": "Enable TLS certificate verification for secure connections. Disable only for development or when certificates cannot be properly validated (e.g., self-signed certs, VPN environments). Warning: Disabling verification is insecure","database": {diff --git a/frontend/src/react/locales/es-ES.json b/frontend/src/react/locales/es-ES.jsonindex 08eca25c33..dc3cc5dbcd 100644--- a/frontend/src/react/locales/es-ES.json+++ b/frontend/src/react/locales/es-ES.json@@ -530,8 +530,28 @@},"ssl": {"ca-cert": "Certificado de CA",+ "ca-empty-uses-system-trust": "Dejar vacío para usar la tienda de confianza del sistema",+ "ca-path": "Ruta del certificado de CA",+ "ca-placeholder": "Ingrese o arrastre y suelte YOUR_CA_CERTIFICATE",+ "ca-source": {+ "file-path": "Ruta de archivo",+ "inline-pem": "PEM en línea",+ "self": "Origen del certificado de CA",+ "system-trust": "Confianza del sistema"+ },"client-cert": "Certificado del cliente",+ "client-cert-path": "Ruta del certificado del cliente",+ "client-cert-placeholder": "Ingrese o arrastre y suelte YOUR_CLIENT_CERT",+ "client-cert-source": {+ "file-path": "Ruta de archivo",+ "inline-pem": "PEM en línea",+ "none": "Ninguno",+ "self": "Origen del certificado del cliente"+ },"client-key": "Clave del cliente",+ "client-key-path": "Ruta de la clave del cliente",+ "client-key-placeholder": "Ingrese o arrastre y suelte YOUR_CLIENT_KEY",+ "configured": "Configurado","verify-certificate": "Verificar certificado TLS","verify-certificate-tooltip": "Habilitar la verificación del certificado TLS para conexiones seguras. Deshabilitar solo para desarrollo o cuando los certificados no se pueden validar correctamente (por ejemplo, certificados autofirmados, entornos VPN). Advertencia: Deshabilitar la verificación es inseguro"},@@ -563,8 +583,12 @@"data-source.ssh.user": "Nombre de usuario","data-source.ssl-connection": "Conexión SSL","data-source.ssl.ca-cert": "Certificado de CA",+ "data-source.ssl.ca-empty-uses-system-trust": "Dejar vacío para usar la tienda de confianza del sistema",+ "data-source.ssl.ca-path": "Ruta del certificado de CA","data-source.ssl.client-cert": "Certificado del cliente",+ "data-source.ssl.client-cert-path": "Ruta del certificado del cliente","data-source.ssl.client-key": "Clave del cliente",+ "data-source.ssl.client-key-path": "Ruta de la clave del cliente","data-source.ssl.verify-certificate": "Verificar certificado TLS","data-source.ssl.verify-certificate-tooltip": "Habilitar la verificación del certificado TLS para conexiones seguras. Deshabilitar solo para desarrollo o cuando los certificados no se pueden validar correctamente (por ejemplo, certificados autofirmados, entornos VPN). Advertencia: Deshabilitar la verificación es inseguro","database": {diff --git a/frontend/src/react/locales/ja-JP.json b/frontend/src/react/locales/ja-JP.jsonindex e155cd164f..950a6ae6f5 100644--- a/frontend/src/react/locales/ja-JP.json+++ b/frontend/src/react/locales/ja-JP.json@@ -530,8 +530,28 @@},"ssl": {"ca-cert": "CA証明書",+ "ca-empty-uses-system-trust": "空欄のままにすると、システムの信頼ストアを使用します",+ "ca-path": "CA証明書のパス",+ "ca-placeholder": "YOUR_CA_CERTIFICATEを入力またはドラッグ&ドロップ",+ "ca-source": {+ "file-path": "ファイルパス",+ "inline-pem": "インラインPEM",+ "self": "CA証明書のソース",+ "system-trust": "システム信頼"+ },"client-cert": "クライアント証明書",+ "client-cert-path": "クライアント証明書のパス",+ "client-cert-placeholder": "YOUR_CLIENT_CERTを入力またはドラッグ&ドロップ",+ "client-cert-source": {+ "file-path": "ファイルパス",+ "inline-pem": "インラインPEM",+ "none": "なし",+ "self": "クライアント証明書のソース"+ },"client-key": "クライアントキー",+ "client-key-path": "クライアントキーのパス",+ "client-key-placeholder": "YOUR_CLIENT_KEYを入力またはドラッグ&ドロップ",+ "configured": "設定済み","verify-certificate": "TLS証明書を検証","verify-certificate-tooltip": "安全な接続のためにTLS証明書の検証を有効にします。開発環境や証明書が適切に検証できない場合(自己署名証明書、VPN環境など)にのみ無効にしてください。警告:検証を無効にすることは安全ではありません"},@@ -563,8 +583,12 @@"data-source.ssh.user": "ユーザー名","data-source.ssl-connection": "SSL接続","data-source.ssl.ca-cert": "CA証明書",+ "data-source.ssl.ca-empty-uses-system-trust": "空欄のままにすると、システムの信頼ストアを使用します",+ "data-source.ssl.ca-path": "CA証明書のパス","data-source.ssl.client-cert": "クライアント証明書",+ "data-source.ssl.client-cert-path": "クライアント証明書のパス","data-source.ssl.client-key": "クライアントキー",+ "data-source.ssl.client-key-path": "クライアントキーのパス","data-source.ssl.verify-certificate": "TLS証明書を検証","data-source.ssl.verify-certificate-tooltip": "安全な接続のためにTLS証明書の検証を有効にします。開発環境や証明書が適切に検証できない場合(自己署名証明書、VPN環境など)にのみ無効にしてください。警告:検証を無効にすることは安全ではありません","database": {diff --git a/frontend/src/react/locales/vi-VN.json b/frontend/src/react/locales/vi-VN.jsonindex 3292d54a79..dc3487274d 100644--- a/frontend/src/react/locales/vi-VN.json+++ b/frontend/src/react/locales/vi-VN.json@@ -530,8 +530,28 @@},"ssl": {"ca-cert": "Chứng chỉ CA",+ "ca-empty-uses-system-trust": "Để trống để dùng kho tin cậy của hệ thống",+ "ca-path": "Đường dẫn chứng chỉ CA",+ "ca-placeholder": "Nhập hoặc kéo thả YOUR_CA_CERTIFICATE",+ "ca-source": {+ "file-path": "Đường dẫn tệp",+ "inline-pem": "PEM nội tuyến",+ "self": "Nguồn chứng chỉ CA",+ "system-trust": "Tin cậy hệ thống"+ },"client-cert": "Chứng chỉ máy khách",+ "client-cert-path": "Đường dẫn chứng chỉ máy khách",+ "client-cert-placeholder": "Nhập hoặc kéo thả YOUR_CLIENT_CERT",+ "client-cert-source": {+ "file-path": "Đường dẫn tệp",+ "inline-pem": "PEM nội tuyến",+ "none": "Không có",+ "self": "Nguồn chứng chỉ máy khách"+ },"client-key": "Khóa máy khách",+ "client-key-path": "Đường dẫn khóa máy khách",+ "client-key-placeholder": "Nhập hoặc kéo thả YOUR_CLIENT_KEY",+ "configured": "Đã cấu hình","verify-certificate": "Xác minh chứng chỉ TLS","verify-certificate-tooltip": "Bật xác minh chứng chỉ TLS để kết nối an toàn. Chỉ tắt cho môi trường phát triển hoặc khi không thể xác thực chứng chỉ đúng cách (ví dụ: chứng chỉ tự ký, môi trường VPN). Cảnh báo: Tắt xác minh là không an toàn"},@@ -563,8 +583,12 @@"data-source.ssh.user": "Người dùng","data-source.ssl-connection": "Kết nối SSL","data-source.ssl.ca-cert": "Chứng chỉ CA",+ "data-source.ssl.ca-empty-uses-system-trust": "Để trống để dùng kho tin cậy của hệ thống",+ "data-source.ssl.ca-path": "Đường dẫn chứng chỉ CA","data-source.ssl.client-cert": "Chứng chỉ máy khách",+ "data-source.ssl.client-cert-path": "Đường dẫn chứng chỉ máy khách","data-source.ssl.client-key": "Khóa máy khách",+ "data-source.ssl.client-key-path": "Đường dẫn khóa máy khách","data-source.ssl.verify-certificate": "Xác minh chứng chỉ TLS","data-source.ssl.verify-certificate-tooltip": "Bật xác minh chứng chỉ TLS để kết nối an toàn. Chỉ tắt cho môi trường phát triển hoặc khi không thể xác thực chứng chỉ đúng cách (ví dụ: chứng chỉ tự ký, môi trường VPN). Cảnh báo: Tắt xác minh là không an toàn","database": {diff --git a/frontend/src/react/locales/zh-CN.json b/frontend/src/react/locales/zh-CN.jsonindex a3de8502ea..22fa73ef25 100644--- a/frontend/src/react/locales/zh-CN.json+++ b/frontend/src/react/locales/zh-CN.json@@ -530,8 +530,28 @@},"ssl": {"ca-cert": "CA 证书",+ "ca-empty-uses-system-trust": "留空以使用系统信任存储",+ "ca-path": "CA 证书路径",+ "ca-placeholder": "输入或拖放 YOUR_CA_CERTIFICATE",+ "ca-source": {+ "file-path": "文件路径",+ "inline-pem": "内联 PEM",+ "self": "CA 证书来源",+ "system-trust": "系统信任"+ },"client-cert": "客户端证书",+ "client-cert-path": "客户端证书路径",+ "client-cert-placeholder": "输入或拖放 YOUR_CLIENT_CERT",+ "client-cert-source": {+ "file-path": "文件路径",+ "inline-pem": "内联 PEM",+ "none": "无",+ "self": "客户端证书来源"+ },"client-key": "客户端密钥",+ "client-key-path": "客户端密钥路径",+ "client-key-placeholder": "输入或拖放 YOUR_CLIENT_KEY",+ "configured": "已配置","verify-certificate": "验证 TLS 证书","verify-certificate-tooltip": "启用 TLS 证书验证以确保安全连接。仅在开发环境或证书无法正确验证的情况下禁用(例如自签名证书、VPN 环境)。警告:禁用验证是不安全的"},@@ -563,8 +583,12 @@"data-source.ssh.user": "用户名","data-source.ssl-connection": "SSL 连接","data-source.ssl.ca-cert": "CA 证书",+ "data-source.ssl.ca-empty-uses-system-trust": "留空以使用系统信任存储",+ "data-source.ssl.ca-path": "CA 证书路径","data-source.ssl.client-cert": "客户端证书",+ "data-source.ssl.client-cert-path": "客户端证书路径","data-source.ssl.client-key": "客户端密钥",+ "data-source.ssl.client-key-path": "客户端密钥路径","data-source.ssl.verify-certificate": "验证 TLS 证书","data-source.ssl.verify-certificate-tooltip": "启用 TLS 证书验证以确保安全连接。仅在开发环境或证书无法正确验证的情况下禁用(例如自签名证书、VPN 环境)。警告:禁用验证是不安全的","database": {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 eb6284fb87..77d7adfd8e 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@@ -965,6 +965,69 @@ export declare type DataSource = Message<"bytebase.v1.DataSource"> & {*/sslKey: string;+ /**+ * The local filesystem path to the SSL certificate authority certificate.+ *+ * @generated from field: string ssl_ca_path = 41;+ */+ sslCaPath: string;++ /**+ * The local filesystem path to the SSL client certificate.+ *+ * @generated from field: string ssl_cert_path = 42;+ */+ sslCertPath: string;++ /**+ * The local filesystem path to the SSL client private key.+ *+ * @generated from field: string ssl_key_path = 43;+ */+ sslKeyPath: string;++ /**+ * Whether an SSL certificate authority certificate has been configured.+ *+ * @generated from field: bool ssl_ca_set = 44;+ */+ sslCaSet: boolean;++ /**+ * Whether an SSL client certificate has been configured.+ *+ * @generated from field: bool ssl_cert_set = 45;+ */+ sslCertSet: boolean;++ /**+ * Whether an SSL client private key has been configured.+ *+ * @generated from field: bool ssl_key_set = 46;+ */+ sslKeySet: boolean;++ /**+ * Whether an SSL certificate authority path has been configured.+ *+ * @generated from field: bool ssl_ca_path_set = 47;+ */+ sslCaPathSet: boolean;++ /**+ * Whether an SSL client certificate path has been configured.+ *+ * @generated from field: bool ssl_cert_path_set = 48;+ */+ sslCertPathSet: boolean;++ /**+ * Whether an SSL client private key path has been configured.+ *+ * @generated from field: bool ssl_key_path_set = 49;+ */+ sslKeyPathSet: boolean;+/*** verify_tls_certificate enables TLS certificate verification for SSL connections.* Default is false (no verification) for backward compatibility.diff --git a/frontend/src/types/proto-es/v1/instance_service_pb.js b/frontend/src/types/proto-es/v1/instance_service_pb.jsindex 7f62bbedca..5e213f0bd2 100644--- a/frontend/src/types/proto-es/v1/instance_service_pb.js+++ b/frontend/src/types/proto-es/v1/instance_service_pb.js@@ -17,7 +17,7 @@ import { file_v1_instance_role_service } from "./instance_role_service_pb";* Describes the file v1/instance_service.proto.*/export const file_v1_instance_service = /*@__PURE__*/- fileDesc("Chl2MS9pbnN0YW5jZV9zZXJ2aWNlLnByb3RvEgtieXRlYmFzZS52MSJBChJHZXRJbnN0YW5jZVJlcXVlc3QSKwoEbmFtZRgBIAEoCUId4EEC+kEXChVieXRlYmFzZS5jb20vSW5zdGFuY2UidQoUTGlzdEluc3RhbmNlc1JlcXVlc3QSEQoJcGFnZV9zaXplGAEgASgFEhIKCnBhZ2VfdG9rZW4YAiABKAkSFAoMc2hvd19kZWxldGVkGAMgASgIEg4KBmZpbHRlchgEIAEoCRIQCghvcmRlcl9ieRgFIAEoCSJaChVMaXN0SW5zdGFuY2VzUmVzcG9uc2USKAoJaW5zdGFuY2VzGAEgAygLMhUuYnl0ZWJhc2UudjEuSW5zdGFuY2USFwoPbmV4dF9wYWdlX3Rva2VuGAIgASgJInEKFUNyZWF0ZUluc3RhbmNlUmVxdWVzdBIsCghpbnN0YW5jZRgBIAEoCzIVLmJ5dGViYXNlLnYxLkluc3RhbmNlQgPgQQISEwoLaW5zdGFuY2VfaWQYAiABKAkSFQoNdmFsaWRhdGVfb25seRgDIAEoCCKNAQoVVXBkYXRlSW5zdGFuY2VSZXF1ZXN0EiwKCGluc3RhbmNlGAEgASgLMhUuYnl0ZWJhc2UudjEuSW5zdGFuY2VCA+BBAhIvCgt1cGRhdGVfbWFzaxgCIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5GaWVsZE1hc2sSFQoNYWxsb3dfbWlzc2luZxgDIAEoCCJiChVEZWxldGVJbnN0YW5jZVJlcXVlc3QSKwoEbmFtZRgBIAEoCUId4EEC+kEXChVieXRlYmFzZS5jb20vSW5zdGFuY2USDQoFZm9yY2UYAiABKAgSDQoFcHVyZ2UYAyABKAgiRgoXVW5kZWxldGVJbnN0YW5jZVJlcXVlc3QSKwoEbmFtZRgBIAEoCUId4EEC+kEXChVieXRlYmFzZS5jb20vSW5zdGFuY2UiXAoTU3luY0luc3RhbmNlUmVxdWVzdBIrCgRuYW1lGAEgASgJQh3gQQL6QRcKFWJ5dGViYXNlLmNvbS9JbnN0YW5jZRIYChBlbmFibGVfZnVsbF9zeW5jGAIgASgIIooBChtMaXN0SW5zdGFuY2VEYXRhYmFzZVJlcXVlc3QSKwoEbmFtZRgBIAEoCUId4EEC+kEXChVieXRlYmFzZS5jb20vSW5zdGFuY2USMQoIaW5zdGFuY2UYAiABKAsyFS5ieXRlYmFzZS52MS5JbnN0YW5jZUID4EECSACIAQFCCwoJX2luc3RhbmNlIjEKHExpc3RJbnN0YW5jZURhdGFiYXNlUmVzcG9uc2USEQoJZGF0YWJhc2VzGAEgAygJIikKFFN5bmNJbnN0YW5jZVJlc3BvbnNlEhEKCWRhdGFiYXNlcxgBIAMoCSJUChlCYXRjaFN5bmNJbnN0YW5jZXNSZXF1ZXN0EjcKCHJlcXVlc3RzGAEgAygLMiAuYnl0ZWJhc2UudjEuU3luY0luc3RhbmNlUmVxdWVzdEID4EECIhwKGkJhdGNoU3luY0luc3RhbmNlc1Jlc3BvbnNlIlgKG0JhdGNoVXBkYXRlSW5zdGFuY2VzUmVxdWVzdBI5CghyZXF1ZXN0cxgBIAMoCzIiLmJ5dGViYXNlLnYxLlVwZGF0ZUluc3RhbmNlUmVxdWVzdEID4EECIkgKHEJhdGNoVXBkYXRlSW5zdGFuY2VzUmVzcG9uc2USKAoJaW5zdGFuY2VzGAEgAygLMhUuYnl0ZWJhc2UudjEuSW5zdGFuY2UijQEKFEFkZERhdGFTb3VyY2VSZXF1ZXN0EisKBG5hbWUYASABKAlCHeBBAvpBFwoVYnl0ZWJhc2UuY29tL0luc3RhbmNlEjEKC2RhdGFfc291cmNlGAIgASgLMhcuYnl0ZWJhc2UudjEuRGF0YVNvdXJjZUID4EECEhUKDXZhbGlkYXRlX29ubHkYAyABKAgieQoXUmVtb3ZlRGF0YVNvdXJjZVJlcXVlc3QSKwoEbmFtZRgBIAEoCUId4EEC+kEXChVieXRlYmFzZS5jb20vSW5zdGFuY2USMQoLZGF0YV9zb3VyY2UYAiABKAsyFy5ieXRlYmFzZS52MS5EYXRhU291cmNlQgPgQQIi2AEKF1VwZGF0ZURhdGFTb3VyY2VSZXF1ZXN0EisKBG5hbWUYASABKAlCHeBBAvpBFwoVYnl0ZWJhc2UuY29tL0luc3RhbmNlEjEKC2RhdGFfc291cmNlGAIgASgLMhcuYnl0ZWJhc2UudjEuRGF0YVNvdXJjZUID4EECEi8KC3VwZGF0ZV9tYXNrGAMgASgLMhouZ29vZ2xlLnByb3RvYnVmLkZpZWxkTWFzaxIVCg12YWxpZGF0ZV9vbmx5GAQgASgIEhUKDWFsbG93X21pc3NpbmcYBSABKAgi5QQKCEluc3RhbmNlEgwKBG5hbWUYASABKAkSIQoFc3RhdGUYAyABKA4yEi5ieXRlYmFzZS52MS5TdGF0ZRIXCgV0aXRsZRgEIAEoCUIIukgFcgMYyAESIwoGZW5naW5lGAUgASgOMhMuYnl0ZWJhc2UudjEuRW5naW5lEhsKDmVuZ2luZV92ZXJzaW9uGAYgASgJQgPgQQMSFQoNZXh0ZXJuYWxfbGluaxgHIAEoCRItCgxkYXRhX3NvdXJjZXMYCCADKAsyFy5ieXRlYmFzZS52MS5EYXRhU291cmNlEh0KC2Vudmlyb25tZW50GAkgASgJQgPgQQFIAIgBARISCgphY3RpdmF0aW9uGAogASgIEi0KBXJvbGVzGAsgAygLMhkuYnl0ZWJhc2UudjEuSW5zdGFuY2VSb2xlQgPgQQMSMAoNc3luY19pbnRlcnZhbBgMIAEoCzIZLmdvb2dsZS5wcm90b2J1Zi5EdXJhdGlvbhIWCg5zeW5jX2RhdGFiYXNlcxgOIAMoCRI3Cg5sYXN0X3N5bmNfdGltZRgPIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXBCA+BBAxIxCgZsYWJlbHMYECADKAsyIS5ieXRlYmFzZS52MS5JbnN0YW5jZS5MYWJlbHNFbnRyeRotCgtMYWJlbHNFbnRyeRILCgNrZXkYASABKAkSDQoFdmFsdWUYAiABKAk6AjgBOjDqQS0KFWJ5dGViYXNlLmNvbS9JbnN0YW5jZRIUaW5zdGFuY2VzL3tpbnN0YW5jZX1CDgoMX2Vudmlyb25tZW50IpsHChhEYXRhU291cmNlRXh0ZXJuYWxTZWNyZXQSRQoLc2VjcmV0X3R5cGUYASABKA4yMC5ieXRlYmFzZS52MS5EYXRhU291cmNlRXh0ZXJuYWxTZWNyZXQuU2VjcmV0VHlwZRILCgN1cmwYAiABKAkSQQoJYXV0aF90eXBlGAMgASgOMi4uYnl0ZWJhc2UudjEuRGF0YVNvdXJjZUV4dGVybmFsU2VjcmV0LkF1dGhUeXBlEksKCGFwcF9yb2xlGAQgASgLMjcuYnl0ZWJhc2UudjEuRGF0YVNvdXJjZUV4dGVybmFsU2VjcmV0LkFwcFJvbGVBdXRoT3B0aW9uSAASFAoFdG9rZW4YBSABKAlCA+BBBEgAEhMKC2VuZ2luZV9uYW1lGAYgASgJEhMKC3NlY3JldF9uYW1lGAcgASgJEhkKEXBhc3N3b3JkX2tleV9uYW1lGAggASgJEiMKG3NraXBfdmF1bHRfdGxzX3ZlcmlmaWNhdGlvbhgJIAEoCBIZCgx2YXVsdF9zc2xfY2EYCiABKAlCA+BBBBIbCg52YXVsdF9zc2xfY2VydBgLIAEoCUID4EEEEhoKDXZhdWx0X3NzbF9rZXkYDCABKAlCA+BBBBruAQoRQXBwUm9sZUF1dGhPcHRpb24SFAoHcm9sZV9pZBgBIAEoCUID4EEEEhYKCXNlY3JldF9pZBgCIAEoCUID4EEEElAKBHR5cGUYAyABKA4yQi5ieXRlYmFzZS52MS5EYXRhU291cmNlRXh0ZXJuYWxTZWNyZXQuQXBwUm9sZUF1dGhPcHRpb24uU2VjcmV0VHlwZRISCgptb3VudF9wYXRoGAQgASgJIkUKClNlY3JldFR5cGUSGwoXU0VDUkVUX1RZUEVfVU5TUEVDSUZJRUQQABIJCgVQTEFJThABEg8KC0VOVklST05NRU5UEAIigAEKClNlY3JldFR5cGUSGwoXU0VDUkVUX1RZUEVfVU5TUEVDSUZJRUQQABIPCgtWQVVMVF9LVl9WMhABEhcKE0FXU19TRUNSRVRTX01BTkFHRVIQAhIWChJHQ1BfU0VDUkVUX01BTkFHRVIQAxITCg9BWlVSRV9LRVlfVkFVTFQQBCJECghBdXRoVHlwZRIZChVBVVRIX1RZUEVfVU5TUEVDSUZJRUQQABIJCgVUT0tFThABEhIKDlZBVUxUX0FQUF9ST0xFEAJCDQoLYXV0aF9vcHRpb24ikQ8KCkRhdGFTb3VyY2USCgoCaWQYASABKAkSKQoEdHlwZRgCIAEoDjIbLmJ5dGViYXNlLnYxLkRhdGFTb3VyY2VUeXBlEhAKCHVzZXJuYW1lGAMgASgJEhUKCHBhc3N3b3JkGAQgASgJQgPgQQQSDwoHdXNlX3NzbBgeIAEoCBITCgZzc2xfY2EYBSABKAlCA+BBBBIVCghzc2xfY2VydBgGIAEoCUID4EEEEhQKB3NzbF9rZXkYByABKAlCA+BBBBIeChZ2ZXJpZnlfdGxzX2NlcnRpZmljYXRlGCcgASgIEgwKBGhvc3QYCCABKAkSDAoEcG9ydBgJIAEoCRIQCghkYXRhYmFzZRgKIAEoCRILCgNzcnYYCyABKAgSHwoXYXV0aGVudGljYXRpb25fZGF0YWJhc2UYDCABKAkSEwoLcmVwbGljYV9zZXQYGSABKAkSCwoDc2lkGA0gASgJEhQKDHNlcnZpY2VfbmFtZRgOIAEoCRIQCghzc2hfaG9zdBgPIAEoCRIQCghzc2hfcG9ydBgQIAEoCRIQCghzc2hfdXNlchgRIAEoCRIZCgxzc2hfcGFzc3dvcmQYEiABKAlCA+BBBBIcCg9zc2hfcHJpdmF0ZV9rZXkYEyABKAlCA+BBBBInChphdXRoZW50aWNhdGlvbl9wcml2YXRlX2tleRgUIAEoCUID4EEEEjIKJWF1dGhlbnRpY2F0aW9uX3ByaXZhdGVfa2V5X3Bhc3NwaHJhc2UYKCABKAlCA+BBBBI+Cg9leHRlcm5hbF9zZWNyZXQYFSABKAsyJS5ieXRlYmFzZS52MS5EYXRhU291cmNlRXh0ZXJuYWxTZWNyZXQSRwoTYXV0aGVudGljYXRpb25fdHlwZRgWIAEoDjIqLmJ5dGViYXNlLnYxLkRhdGFTb3VyY2UuQXV0aGVudGljYXRpb25UeXBlEkMKEGF6dXJlX2NyZWRlbnRpYWwYFyABKAsyJy5ieXRlYmFzZS52MS5EYXRhU291cmNlLkF6dXJlQ3JlZGVudGlhbEgAEj8KDmF3c19jcmVkZW50aWFsGCUgASgLMiUuYnl0ZWJhc2UudjEuRGF0YVNvdXJjZS5BV1NDcmVkZW50aWFsSAASPwoOZ2NwX2NyZWRlbnRpYWwYJiABKAsyJS5ieXRlYmFzZS52MS5EYXRhU291cmNlLkdDUENyZWRlbnRpYWxIABIsCgtzYXNsX2NvbmZpZxgYIAEoCzIXLmJ5dGViYXNlLnYxLlNBU0xDb25maWcSQgoUYWRkaXRpb25hbF9hZGRyZXNzZXMYGiADKAsyHy5ieXRlYmFzZS52MS5EYXRhU291cmNlLkFkZHJlc3NCA+BBARIZChFkaXJlY3RfY29ubmVjdGlvbhgbIAEoCBIOCgZyZWdpb24YHCABKAkSFAoMd2FyZWhvdXNlX2lkGB0gASgJEhMKC21hc3Rlcl9uYW1lGB8gASgJEhcKD21hc3Rlcl91c2VybmFtZRggIAEoCRIXCg9tYXN0ZXJfcGFzc3dvcmQYISABKAkSNQoKcmVkaXNfdHlwZRgiIAEoDjIhLmJ5dGViYXNlLnYxLkRhdGFTb3VyY2UuUmVkaXNUeXBlEg8KB2NsdXN0ZXIYIyABKAkSWwobZXh0cmFfY29ubmVjdGlvbl9wYXJhbWV0ZXJzGCQgAygLMjYuYnl0ZWJhc2UudjEuRGF0YVNvdXJjZS5FeHRyYUNvbm5lY3Rpb25QYXJhbWV0ZXJzRW50cnkaUwoPQXp1cmVDcmVkZW50aWFsEhEKCXRlbmFudF9pZBgBIAEoCRIRCgljbGllbnRfaWQYAiABKAkSGgoNY2xpZW50X3NlY3JldBgDIAEoCUID4EEEGpgBCg1BV1NDcmVkZW50aWFsEhoKDWFjY2Vzc19rZXlfaWQYASABKAlCA+BBBBIeChFzZWNyZXRfYWNjZXNzX2tleRgCIAEoCUID4EEEEhoKDXNlc3Npb25fdG9rZW4YAyABKAlCA+BBBBIVCghyb2xlX2FybhgEIAEoCUID4EEEEhgKC2V4dGVybmFsX2lkGAUgASgJQgPgQQQaJQoNR0NQQ3JlZGVudGlhbBIUCgdjb250ZW50GAEgASgJQgPgQQQaJQoHQWRkcmVzcxIMCgRob3N0GAEgASgJEgwKBHBvcnQYAiABKAkaQAoeRXh0cmFDb25uZWN0aW9uUGFyYW1ldGVyc0VudHJ5EgsKA2tleRgBIAEoCRINCgV2YWx1ZRgCIAEoCToCOAEifAoSQXV0aGVudGljYXRpb25UeXBlEh4KGkFVVEhFTlRJQ0FUSU9OX1VOU1BFQ0lGSUVEEAASDAoIUEFTU1dPUkQQARIYChRHT09HTEVfQ0xPVURfU1FMX0lBTRACEg8KC0FXU19SRFNfSUFNEAMSDQoJQVpVUkVfSUFNEAQiUgoJUmVkaXNUeXBlEhoKFlJFRElTX1RZUEVfVU5TUEVDSUZJRUQQABIOCgpTVEFOREFMT05FEAESDAoIU0VOVElORUwQAhILCgdDTFVTVEVSEANCDwoNaWFtX2V4dGVuc2lvbiLeAQoQSW5zdGFuY2VSZXNvdXJjZRINCgV0aXRsZRgBIAEoCRIjCgZlbmdpbmUYAiABKA4yEy5ieXRlYmFzZS52MS5FbmdpbmUSGwoOZW5naW5lX3ZlcnNpb24YAyABKAlCA+BBAxItCgxkYXRhX3NvdXJjZXMYBCADKAsyFy5ieXRlYmFzZS52MS5EYXRhU291cmNlEhIKCmFjdGl2YXRpb24YBSABKAgSDAoEbmFtZRgGIAEoCRIYCgtlbnZpcm9ubWVudBgHIAEoCUgAiAEBQg4KDF9lbnZpcm9ubWVudCJMCgpTQVNMQ29uZmlnEjEKCmtyYl9jb25maWcYASABKAsyGy5ieXRlYmFzZS52MS5LZXJiZXJvc0NvbmZpZ0gAQgsKCW1lY2hhbmlzbSKWAQoOS2VyYmVyb3NDb25maWcSDwoHcHJpbWFyeRgBIAEoCRIQCghpbnN0YW5jZRgCIAEoCRINCgVyZWFsbRgDIAEoCRIOCgZrZXl0YWIYBCABKAwSEAoIa2RjX2hvc3QYBSABKAkSEAoIa2RjX3BvcnQYBiABKAkSHgoWa2RjX3RyYW5zcG9ydF9wcm90b2NvbBgHIAEoCSpHCg5EYXRhU291cmNlVHlwZRIbChdEQVRBX1NPVVJDRV9VTlNQRUNJRklFRBAAEgkKBUFETUlOEAESDQoJUkVBRF9PTkxZEAIy1BAKD0luc3RhbmNlU2VydmljZRKEAQoLR2V0SW5zdGFuY2USHy5ieXRlYmFzZS52MS5HZXRJbnN0YW5jZVJlcXVlc3QaFS5ieXRlYmFzZS52MS5JbnN0YW5jZSI92kEEbmFtZYrqMBBiYi5pbnN0YW5jZXMuZ2V0kOowAYLT5JMCGBIWL3YxL3tuYW1lPWluc3RhbmNlcy8qfRKJAQoNTGlzdEluc3RhbmNlcxIhLmJ5dGViYXNlLnYxLkxpc3RJbnN0YW5jZXNSZXF1ZXN0GiIuYnl0ZWJhc2UudjEuTGlzdEluc3RhbmNlc1Jlc3BvbnNlIjHaQQCK6jARYmIuaW5zdGFuY2VzLmxpc3SQ6jABgtPkkwIPEg0vdjEvaW5zdGFuY2VzEpYBCg5DcmVhdGVJbnN0YW5jZRIiLmJ5dGViYXNlLnYxLkNyZWF0ZUluc3RhbmNlUmVxdWVzdBoVLmJ5dGViYXNlLnYxLkluc3RhbmNlIknaQQhpbnN0YW5jZYrqMBNiYi5pbnN0YW5jZXMuY3JlYXRlkOowAZjqMAGC0+STAhk6CGluc3RhbmNlIg0vdjEvaW5zdGFuY2VzErQBCg5VcGRhdGVJbnN0YW5jZRIiLmJ5dGViYXNlLnYxLlVwZGF0ZUluc3RhbmNlUmVxdWVzdBoVLmJ5dGViYXNlLnYxLkluc3RhbmNlImfaQRRpbnN0YW5jZSx1cGRhdGVfbWFza4rqMBNiYi5pbnN0YW5jZXMudXBkYXRlkOowAZjqMAGC0+STAis6CGluc3RhbmNlMh8vdjEve2luc3RhbmNlLm5hbWU9aW5zdGFuY2VzLyp9EpIBCg5EZWxldGVJbnN0YW5jZRIiLmJ5dGViYXNlLnYxLkRlbGV0ZUluc3RhbmNlUmVxdWVzdBoWLmdvb2dsZS5wcm90b2J1Zi5FbXB0eSJE2kEEbmFtZYrqMBNiYi5pbnN0YW5jZXMuZGVsZXRlkOowAZjqMAGC0+STAhgqFi92MS97bmFtZT1pbnN0YW5jZXMvKn0SnAEKEFVuZGVsZXRlSW5zdGFuY2USJC5ieXRlYmFzZS52MS5VbmRlbGV0ZUluc3RhbmNlUmVxdWVzdBoVLmJ5dGViYXNlLnYxLkluc3RhbmNlIkuK6jAVYmIuaW5zdGFuY2VzLnVuZGVsZXRlkOowAZjqMAGC0+STAiQ6ASoiHy92MS97bmFtZT1pbnN0YW5jZXMvKn06dW5kZWxldGUSlAEKDFN5bmNJbnN0YW5jZRIgLmJ5dGViYXNlLnYxLlN5bmNJbnN0YW5jZVJlcXVlc3QaIS5ieXRlYmFzZS52MS5TeW5jSW5zdGFuY2VSZXNwb25zZSI/iuowEWJiLmluc3RhbmNlcy5zeW5jkOowAYLT5JMCIDoBKiIbL3YxL3tuYW1lPWluc3RhbmNlcy8qfTpzeW5jErABChRMaXN0SW5zdGFuY2VEYXRhYmFzZRIoLmJ5dGViYXNlLnYxLkxpc3RJbnN0YW5jZURhdGFiYXNlUmVxdWVzdBopLmJ5dGViYXNlLnYxLkxpc3RJbnN0YW5jZURhdGFiYXNlUmVzcG9uc2UiQ4rqMBBiYi5pbnN0YW5jZXMuZ2V0kOowAYLT5JMCJToBKiIgL3YxL3tuYW1lPWluc3RhbmNlcy8qfTpkYXRhYmFzZXMSogEKEkJhdGNoU3luY0luc3RhbmNlcxImLmJ5dGViYXNlLnYxLkJhdGNoU3luY0luc3RhbmNlc1JlcXVlc3QaJy5ieXRlYmFzZS52MS5CYXRjaFN5bmNJbnN0YW5jZXNSZXNwb25zZSI7iuowEWJiLmluc3RhbmNlcy5zeW5jkOowAYLT5JMCHDoBKiIXL3YxL2luc3RhbmNlczpiYXRjaFN5bmMSsAEKFEJhdGNoVXBkYXRlSW5zdGFuY2VzEiguYnl0ZWJhc2UudjEuQmF0Y2hVcGRhdGVJbnN0YW5jZXNSZXF1ZXN0GikuYnl0ZWJhc2UudjEuQmF0Y2hVcGRhdGVJbnN0YW5jZXNSZXNwb25zZSJDiuowE2JiLmluc3RhbmNlcy51cGRhdGWQ6jABmOowAYLT5JMCHjoBKiIZL3YxL2luc3RhbmNlczpiYXRjaFVwZGF0ZRKZAQoNQWRkRGF0YVNvdXJjZRIhLmJ5dGViYXNlLnYxLkFkZERhdGFTb3VyY2VSZXF1ZXN0GhUuYnl0ZWJhc2UudjEuSW5zdGFuY2UiTorqMBNiYi5pbnN0YW5jZXMudXBkYXRlkOowAZjqMAGC0+STAik6ASoiJC92MS97bmFtZT1pbnN0YW5jZXMvKn06YWRkRGF0YVNvdXJjZRKiAQoQUmVtb3ZlRGF0YVNvdXJjZRIkLmJ5dGViYXNlLnYxLlJlbW92ZURhdGFTb3VyY2VSZXF1ZXN0GhUuYnl0ZWJhc2UudjEuSW5zdGFuY2UiUYrqMBNiYi5pbnN0YW5jZXMudXBkYXRlkOowAZjqMAGC0+STAiw6ASoiJy92MS97bmFtZT1pbnN0YW5jZXMvKn06cmVtb3ZlRGF0YVNvdXJjZRLGAQoQVXBkYXRlRGF0YVNvdXJjZRIkLmJ5dGViYXNlLnYxLlVwZGF0ZURhdGFTb3VyY2VSZXF1ZXN0GhUuYnl0ZWJhc2UudjEuSW5zdGFuY2UiddpBF2RhdGFfc291cmNlLHVwZGF0ZV9tYXNriuowE2JiLmluc3RhbmNlcy51cGRhdGWQ6jABmOowAYLT5JMCNjoLZGF0YV9zb3VyY2UyJy92MS97bmFtZT1pbnN0YW5jZXMvKn06dXBkYXRlRGF0YVNvdXJjZUKqAQoPY29tLmJ5dGViYXNlLnYxQhRJbnN0YW5jZVNlcnZpY2VQcm90b1ABWjRnaXRodWIuY29tL2J5dGViYXNlL2J5dGViYXNlL2JhY2tlbmQvZ2VuZXJhdGVkLWdvL3YxogIDQlhYqgILQnl0ZWJhc2UuVjHKAgtCeXRlYmFzZVxWMeICF0J5dGViYXNlXFYxXEdQQk1ldGFkYXRh6gIMQnl0ZWJhc2U6OlYxYgZwcm90bzM", [file_buf_validate_validate, file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_api_resource, file_google_protobuf_duration, file_google_protobuf_empty, file_google_protobuf_field_mask, file_google_protobuf_timestamp, file_v1_annotation, file_v1_common, file_v1_instance_role_service]);+ fileDesc("Chl2MS9pbnN0YW5jZV9zZXJ2aWNlLnByb3RvEgtieXRlYmFzZS52MSJBChJHZXRJbnN0YW5jZVJlcXVlc3QSKwoEbmFtZRgBIAEoCUId4EEC+kEXChVieXRlYmFzZS5jb20vSW5zdGFuY2UidQoUTGlzdEluc3RhbmNlc1JlcXVlc3QSEQoJcGFnZV9zaXplGAEgASgFEhIKCnBhZ2VfdG9rZW4YAiABKAkSFAoMc2hvd19kZWxldGVkGAMgASgIEg4KBmZpbHRlchgEIAEoCRIQCghvcmRlcl9ieRgFIAEoCSJaChVMaXN0SW5zdGFuY2VzUmVzcG9uc2USKAoJaW5zdGFuY2VzGAEgAygLMhUuYnl0ZWJhc2UudjEuSW5zdGFuY2USFwoPbmV4dF9wYWdlX3Rva2VuGAIgASgJInEKFUNyZWF0ZUluc3RhbmNlUmVxdWVzdBIsCghpbnN0YW5jZRgBIAEoCzIVLmJ5dGViYXNlLnYxLkluc3RhbmNlQgPgQQISEwoLaW5zdGFuY2VfaWQYAiABKAkSFQoNdmFsaWRhdGVfb25seRgDIAEoCCKNAQoVVXBkYXRlSW5zdGFuY2VSZXF1ZXN0EiwKCGluc3RhbmNlGAEgASgLMhUuYnl0ZWJhc2UudjEuSW5zdGFuY2VCA+BBAhIvCgt1cGRhdGVfbWFzaxgCIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5GaWVsZE1hc2sSFQoNYWxsb3dfbWlzc2luZxgDIAEoCCJiChVEZWxldGVJbnN0YW5jZVJlcXVlc3QSKwoEbmFtZRgBIAEoCUId4EEC+kEXChVieXRlYmFzZS5jb20vSW5zdGFuY2USDQoFZm9yY2UYAiABKAgSDQoFcHVyZ2UYAyABKAgiRgoXVW5kZWxldGVJbnN0YW5jZVJlcXVlc3QSKwoEbmFtZRgBIAEoCUId4EEC+kEXChVieXRlYmFzZS5jb20vSW5zdGFuY2UiXAoTU3luY0luc3RhbmNlUmVxdWVzdBIrCgRuYW1lGAEgASgJQh3gQQL6QRcKFWJ5dGViYXNlLmNvbS9JbnN0YW5jZRIYChBlbmFibGVfZnVsbF9zeW5jGAIgASgIIooBChtMaXN0SW5zdGFuY2VEYXRhYmFzZVJlcXVlc3QSKwoEbmFtZRgBIAEoCUId4EEC+kEXChVieXRlYmFzZS5jb20vSW5zdGFuY2USMQoIaW5zdGFuY2UYAiABKAsyFS5ieXRlYmFzZS52MS5JbnN0YW5jZUID4EECSACIAQFCCwoJX2luc3RhbmNlIjEKHExpc3RJbnN0YW5jZURhdGFiYXNlUmVzcG9uc2USEQoJZGF0YWJhc2VzGAEgAygJIikKFFN5bmNJbnN0YW5jZVJlc3BvbnNlEhEKCWRhdGFiYXNlcxgBIAMoCSJUChlCYXRjaFN5bmNJbnN0YW5jZXNSZXF1ZXN0EjcKCHJlcXVlc3RzGAEgAygLMiAuYnl0ZWJhc2UudjEuU3luY0luc3RhbmNlUmVxdWVzdEID4EECIhwKGkJhdGNoU3luY0luc3RhbmNlc1Jlc3BvbnNlIlgKG0JhdGNoVXBkYXRlSW5zdGFuY2VzUmVxdWVzdBI5CghyZXF1ZXN0cxgBIAMoCzIiLmJ5dGViYXNlLnYxLlVwZGF0ZUluc3RhbmNlUmVxdWVzdEID4EECIkgKHEJhdGNoVXBkYXRlSW5zdGFuY2VzUmVzcG9uc2USKAoJaW5zdGFuY2VzGAEgAygLMhUuYnl0ZWJhc2UudjEuSW5zdGFuY2UijQEKFEFkZERhdGFTb3VyY2VSZXF1ZXN0EisKBG5hbWUYASABKAlCHeBBAvpBFwoVYnl0ZWJhc2UuY29tL0luc3RhbmNlEjEKC2RhdGFfc291cmNlGAIgASgLMhcuYnl0ZWJhc2UudjEuRGF0YVNvdXJjZUID4EECEhUKDXZhbGlkYXRlX29ubHkYAyABKAgieQoXUmVtb3ZlRGF0YVNvdXJjZVJlcXVlc3QSKwoEbmFtZRgBIAEoCUId4EEC+kEXChVieXRlYmFzZS5jb20vSW5zdGFuY2USMQoLZGF0YV9zb3VyY2UYAiABKAsyFy5ieXRlYmFzZS52MS5EYXRhU291cmNlQgPgQQIi2AEKF1VwZGF0ZURhdGFTb3VyY2VSZXF1ZXN0EisKBG5hbWUYASABKAlCHeBBAvpBFwoVYnl0ZWJhc2UuY29tL0luc3RhbmNlEjEKC2RhdGFfc291cmNlGAIgASgLMhcuYnl0ZWJhc2UudjEuRGF0YVNvdXJjZUID4EECEi8KC3VwZGF0ZV9tYXNrGAMgASgLMhouZ29vZ2xlLnByb3RvYnVmLkZpZWxkTWFzaxIVCg12YWxpZGF0ZV9vbmx5GAQgASgIEhUKDWFsbG93X21pc3NpbmcYBSABKAgi5QQKCEluc3RhbmNlEgwKBG5hbWUYASABKAkSIQoFc3RhdGUYAyABKA4yEi5ieXRlYmFzZS52MS5TdGF0ZRIXCgV0aXRsZRgEIAEoCUIIukgFcgMYyAESIwoGZW5naW5lGAUgASgOMhMuYnl0ZWJhc2UudjEuRW5naW5lEhsKDmVuZ2luZV92ZXJzaW9uGAYgASgJQgPgQQMSFQoNZXh0ZXJuYWxfbGluaxgHIAEoCRItCgxkYXRhX3NvdXJjZXMYCCADKAsyFy5ieXRlYmFzZS52MS5EYXRhU291cmNlEh0KC2Vudmlyb25tZW50GAkgASgJQgPgQQFIAIgBARISCgphY3RpdmF0aW9uGAogASgIEi0KBXJvbGVzGAsgAygLMhkuYnl0ZWJhc2UudjEuSW5zdGFuY2VSb2xlQgPgQQMSMAoNc3luY19pbnRlcnZhbBgMIAEoCzIZLmdvb2dsZS5wcm90b2J1Zi5EdXJhdGlvbhIWCg5zeW5jX2RhdGFiYXNlcxgOIAMoCRI3Cg5sYXN0X3N5bmNfdGltZRgPIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXBCA+BBAxIxCgZsYWJlbHMYECADKAsyIS5ieXRlYmFzZS52MS5JbnN0YW5jZS5MYWJlbHNFbnRyeRotCgtMYWJlbHNFbnRyeRILCgNrZXkYASABKAkSDQoFdmFsdWUYAiABKAk6AjgBOjDqQS0KFWJ5dGViYXNlLmNvbS9JbnN0YW5jZRIUaW5zdGFuY2VzL3tpbnN0YW5jZX1CDgoMX2Vudmlyb25tZW50IpsHChhEYXRhU291cmNlRXh0ZXJuYWxTZWNyZXQSRQoLc2VjcmV0X3R5cGUYASABKA4yMC5ieXRlYmFzZS52MS5EYXRhU291cmNlRXh0ZXJuYWxTZWNyZXQuU2VjcmV0VHlwZRILCgN1cmwYAiABKAkSQQoJYXV0aF90eXBlGAMgASgOMi4uYnl0ZWJhc2UudjEuRGF0YVNvdXJjZUV4dGVybmFsU2VjcmV0LkF1dGhUeXBlEksKCGFwcF9yb2xlGAQgASgLMjcuYnl0ZWJhc2UudjEuRGF0YVNvdXJjZUV4dGVybmFsU2VjcmV0LkFwcFJvbGVBdXRoT3B0aW9uSAASFAoFdG9rZW4YBSABKAlCA+BBBEgAEhMKC2VuZ2luZV9uYW1lGAYgASgJEhMKC3NlY3JldF9uYW1lGAcgASgJEhkKEXBhc3N3b3JkX2tleV9uYW1lGAggASgJEiMKG3NraXBfdmF1bHRfdGxzX3ZlcmlmaWNhdGlvbhgJIAEoCBIZCgx2YXVsdF9zc2xfY2EYCiABKAlCA+BBBBIbCg52YXVsdF9zc2xfY2VydBgLIAEoCUID4EEEEhoKDXZhdWx0X3NzbF9rZXkYDCABKAlCA+BBBBruAQoRQXBwUm9sZUF1dGhPcHRpb24SFAoHcm9sZV9pZBgBIAEoCUID4EEEEhYKCXNlY3JldF9pZBgCIAEoCUID4EEEElAKBHR5cGUYAyABKA4yQi5ieXRlYmFzZS52MS5EYXRhU291cmNlRXh0ZXJuYWxTZWNyZXQuQXBwUm9sZUF1dGhPcHRpb24uU2VjcmV0VHlwZRISCgptb3VudF9wYXRoGAQgASgJIkUKClNlY3JldFR5cGUSGwoXU0VDUkVUX1RZUEVfVU5TUEVDSUZJRUQQABIJCgVQTEFJThABEg8KC0VOVklST05NRU5UEAIigAEKClNlY3JldFR5cGUSGwoXU0VDUkVUX1RZUEVfVU5TUEVDSUZJRUQQABIPCgtWQVVMVF9LVl9WMhABEhcKE0FXU19TRUNSRVRTX01BTkFHRVIQAhIWChJHQ1BfU0VDUkVUX01BTkFHRVIQAxITCg9BWlVSRV9LRVlfVkFVTFQQBCJECghBdXRoVHlwZRIZChVBVVRIX1RZUEVfVU5TUEVDSUZJRUQQABIJCgVUT0tFThABEhIKDlZBVUxUX0FQUF9ST0xFEAJCDQoLYXV0aF9vcHRpb24ijREKCkRhdGFTb3VyY2USCgoCaWQYASABKAkSKQoEdHlwZRgCIAEoDjIbLmJ5dGViYXNlLnYxLkRhdGFTb3VyY2VUeXBlEhAKCHVzZXJuYW1lGAMgASgJEhUKCHBhc3N3b3JkGAQgASgJQgPgQQQSDwoHdXNlX3NzbBgeIAEoCBITCgZzc2xfY2EYBSABKAlCA+BBBBIVCghzc2xfY2VydBgGIAEoCUID4EEEEhQKB3NzbF9rZXkYByABKAlCA+BBBBIYCgtzc2xfY2FfcGF0aBgpIAEoCUID4EEEEhoKDXNzbF9jZXJ0X3BhdGgYKiABKAlCA+BBBBIZCgxzc2xfa2V5X3BhdGgYKyABKAlCA+BBBBIXCgpzc2xfY2Ffc2V0GCwgASgIQgPgQQMSGQoMc3NsX2NlcnRfc2V0GC0gASgIQgPgQQMSGAoLc3NsX2tleV9zZXQYLiABKAhCA+BBAxIcCg9zc2xfY2FfcGF0aF9zZXQYLyABKAhCA+BBAxIeChFzc2xfY2VydF9wYXRoX3NldBgwIAEoCEID4EEDEh0KEHNzbF9rZXlfcGF0aF9zZXQYMSABKAhCA+BBAxIeChZ2ZXJpZnlfdGxzX2NlcnRpZmljYXRlGCcgASgIEgwKBGhvc3QYCCABKAkSDAoEcG9ydBgJIAEoCRIQCghkYXRhYmFzZRgKIAEoCRILCgNzcnYYCyABKAgSHwoXYXV0aGVudGljYXRpb25fZGF0YWJhc2UYDCABKAkSEwoLcmVwbGljYV9zZXQYGSABKAkSCwoDc2lkGA0gASgJEhQKDHNlcnZpY2VfbmFtZRgOIAEoCRIQCghzc2hfaG9zdBgPIAEoCRIQCghzc2hfcG9ydBgQIAEoCRIQCghzc2hfdXNlchgRIAEoCRIZCgxzc2hfcGFzc3dvcmQYEiABKAlCA+BBBBIcCg9zc2hfcHJpdmF0ZV9rZXkYEyABKAlCA+BBBBInChphdXRoZW50aWNhdGlvbl9wcml2YXRlX2tleRgUIAEoCUID4EEEEjIKJWF1dGhlbnRpY2F0aW9uX3ByaXZhdGVfa2V5X3Bhc3NwaHJhc2UYKCABKAlCA+BBBBI+Cg9leHRlcm5hbF9zZWNyZXQYFSABKAsyJS5ieXRlYmFzZS52MS5EYXRhU291cmNlRXh0ZXJuYWxTZWNyZXQSRwoTYXV0aGVudGljYXRpb25fdHlwZRgWIAEoDjIqLmJ5dGViYXNlLnYxLkRhdGFTb3VyY2UuQXV0aGVudGljYXRpb25UeXBlEkMKEGF6dXJlX2NyZWRlbnRpYWwYFyABKAsyJy5ieXRlYmFzZS52MS5EYXRhU291cmNlLkF6dXJlQ3JlZGVudGlhbEgAEj8KDmF3c19jcmVkZW50aWFsGCUgASgLMiUuYnl0ZWJhc2UudjEuRGF0YVNvdXJjZS5BV1NDcmVkZW50aWFsSAASPwoOZ2NwX2NyZWRlbnRpYWwYJiABKAsyJS5ieXRlYmFzZS52MS5EYXRhU291cmNlLkdDUENyZWRlbnRpYWxIABIsCgtzYXNsX2NvbmZpZxgYIAEoCzIXLmJ5dGViYXNlLnYxLlNBU0xDb25maWcSQgoUYWRkaXRpb25hbF9hZGRyZXNzZXMYGiADKAsyHy5ieXRlYmFzZS52MS5EYXRhU291cmNlLkFkZHJlc3NCA+BBARIZChFkaXJlY3RfY29ubmVjdGlvbhgbIAEoCBIOCgZyZWdpb24YHCABKAkSFAoMd2FyZWhvdXNlX2lkGB0gASgJEhMKC21hc3Rlcl9uYW1lGB8gASgJEhcKD21hc3Rlcl91c2VybmFtZRggIAEoCRIXCg9tYXN0ZXJfcGFzc3dvcmQYISABKAkSNQoKcmVkaXNfdHlwZRgiIAEoDjIhLmJ5dGViYXNlLnYxLkRhdGFTb3VyY2UuUmVkaXNUeXBlEg8KB2NsdXN0ZXIYIyABKAkSWwobZXh0cmFfY29ubmVjdGlvbl9wYXJhbWV0ZXJzGCQgAygLMjYuYnl0ZWJhc2UudjEuRGF0YVNvdXJjZS5FeHRyYUNvbm5lY3Rpb25QYXJhbWV0ZXJzRW50cnkaUwoPQXp1cmVDcmVkZW50aWFsEhEKCXRlbmFudF9pZBgBIAEoCRIRCgljbGllbnRfaWQYAiABKAkSGgoNY2xpZW50X3NlY3JldBgDIAEoCUID4EEEGpgBCg1BV1NDcmVkZW50aWFsEhoKDWFjY2Vzc19rZXlfaWQYASABKAlCA+BBBBIeChFzZWNyZXRfYWNjZXNzX2tleRgCIAEoCUID4EEEEhoKDXNlc3Npb25fdG9rZW4YAyABKAlCA+BBBBIVCghyb2xlX2FybhgEIAEoCUID4EEEEhgKC2V4dGVybmFsX2lkGAUgASgJQgPgQQQaJQoNR0NQQ3JlZGVudGlhbBIUCgdjb250ZW50GAEgASgJQgPgQQQaJQoHQWRkcmVzcxIMCgRob3N0GAEgASgJEgwKBHBvcnQYAiABKAkaQAoeRXh0cmFDb25uZWN0aW9uUGFyYW1ldGVyc0VudHJ5EgsKA2tleRgBIAEoCRINCgV2YWx1ZRgCIAEoCToCOAEifAoSQXV0aGVudGljYXRpb25UeXBlEh4KGkFVVEhFTlRJQ0FUSU9OX1VOU1BFQ0lGSUVEEAASDAoIUEFTU1dPUkQQARIYChRHT09HTEVfQ0xPVURfU1FMX0lBTRACEg8KC0FXU19SRFNfSUFNEAMSDQoJQVpVUkVfSUFNEAQiUgoJUmVkaXNUeXBlEhoKFlJFRElTX1RZUEVfVU5TUEVDSUZJRUQQABIOCgpTVEFOREFMT05FEAESDAoIU0VOVElORUwQAhILCgdDTFVTVEVSEANCDwoNaWFtX2V4dGVuc2lvbiLeAQoQSW5zdGFuY2VSZXNvdXJjZRINCgV0aXRsZRgBIAEoCRIjCgZlbmdpbmUYAiABKA4yEy5ieXRlYmFzZS52MS5FbmdpbmUSGwoOZW5naW5lX3ZlcnNpb24YAyABKAlCA+BBAxItCgxkYXRhX3NvdXJjZXMYBCADKAsyFy5ieXRlYmFzZS52MS5EYXRhU291cmNlEhIKCmFjdGl2YXRpb24YBSABKAgSDAoEbmFtZRgGIAEoCRIYCgtlbnZpcm9ubWVudBgHIAEoCUgAiAEBQg4KDF9lbnZpcm9ubWVudCJMCgpTQVNMQ29uZmlnEjEKCmtyYl9jb25maWcYASABKAsyGy5ieXRlYmFzZS52MS5LZXJiZXJvc0NvbmZpZ0gAQgsKCW1lY2hhbmlzbSKWAQoOS2VyYmVyb3NDb25maWcSDwoHcHJpbWFyeRgBIAEoCRIQCghpbnN0YW5jZRgCIAEoCRINCgVyZWFsbRgDIAEoCRIOCgZrZXl0YWIYBCABKAwSEAoIa2RjX2hvc3QYBSABKAkSEAoIa2RjX3BvcnQYBiABKAkSHgoWa2RjX3RyYW5zcG9ydF9wcm90b2NvbBgHIAEoCSpHCg5EYXRhU291cmNlVHlwZRIbChdEQVRBX1NPVVJDRV9VTlNQRUNJRklFRBAAEgkKBUFETUlOEAESDQoJUkVBRF9PTkxZEAIy1BAKD0luc3RhbmNlU2VydmljZRKEAQoLR2V0SW5zdGFuY2USHy5ieXRlYmFzZS52MS5HZXRJbnN0YW5jZVJlcXVlc3QaFS5ieXRlYmFzZS52MS5JbnN0YW5jZSI92kEEbmFtZYrqMBBiYi5pbnN0YW5jZXMuZ2V0kOowAYLT5JMCGBIWL3YxL3tuYW1lPWluc3RhbmNlcy8qfRKJAQoNTGlzdEluc3RhbmNlcxIhLmJ5dGViYXNlLnYxLkxpc3RJbnN0YW5jZXNSZXF1ZXN0GiIuYnl0ZWJhc2UudjEuTGlzdEluc3RhbmNlc1Jlc3BvbnNlIjHaQQCK6jARYmIuaW5zdGFuY2VzLmxpc3SQ6jABgtPkkwIPEg0vdjEvaW5zdGFuY2VzEpYBCg5DcmVhdGVJbnN0YW5jZRIiLmJ5dGViYXNlLnYxLkNyZWF0ZUluc3RhbmNlUmVxdWVzdBoVLmJ5dGViYXNlLnYxLkluc3RhbmNlIknaQQhpbnN0YW5jZYrqMBNiYi5pbnN0YW5jZXMuY3JlYXRlkOowAZjqMAGC0+STAhk6CGluc3RhbmNlIg0vdjEvaW5zdGFuY2VzErQBCg5VcGRhdGVJbnN0YW5jZRIiLmJ5dGViYXNlLnYxLlVwZGF0ZUluc3RhbmNlUmVxdWVzdBoVLmJ5dGViYXNlLnYxLkluc3RhbmNlImfaQRRpbnN0YW5jZSx1cGRhdGVfbWFza4rqMBNiYi5pbnN0YW5jZXMudXBkYXRlkOowAZjqMAGC0+STAis6CGluc3RhbmNlMh8vdjEve2luc3RhbmNlLm5hbWU9aW5zdGFuY2VzLyp9EpIBCg5EZWxldGVJbnN0YW5jZRIiLmJ5dGViYXNlLnYxLkRlbGV0ZUluc3RhbmNlUmVxdWVzdBoWLmdvb2dsZS5wcm90b2J1Zi5FbXB0eSJE2kEEbmFtZYrqMBNiYi5pbnN0YW5jZXMuZGVsZXRlkOowAZjqMAGC0+STAhgqFi92MS97bmFtZT1pbnN0YW5jZXMvKn0SnAEKEFVuZGVsZXRlSW5zdGFuY2USJC5ieXRlYmFzZS52MS5VbmRlbGV0ZUluc3RhbmNlUmVxdWVzdBoVLmJ5dGViYXNlLnYxLkluc3RhbmNlIkuK6jAVYmIuaW5zdGFuY2VzLnVuZGVsZXRlkOowAZjqMAGC0+STAiQ6ASoiHy92MS97bmFtZT1pbnN0YW5jZXMvKn06dW5kZWxldGUSlAEKDFN5bmNJbnN0YW5jZRIgLmJ5dGViYXNlLnYxLlN5bmNJbnN0YW5jZVJlcXVlc3QaIS5ieXRlYmFzZS52MS5TeW5jSW5zdGFuY2VSZXNwb25zZSI/iuowEWJiLmluc3RhbmNlcy5zeW5jkOowAYLT5JMCIDoBKiIbL3YxL3tuYW1lPWluc3RhbmNlcy8qfTpzeW5jErABChRMaXN0SW5zdGFuY2VEYXRhYmFzZRIoLmJ5dGViYXNlLnYxLkxpc3RJbnN0YW5jZURhdGFiYXNlUmVxdWVzdBopLmJ5dGViYXNlLnYxLkxpc3RJbnN0YW5jZURhdGFiYXNlUmVzcG9uc2UiQ4rqMBBiYi5pbnN0YW5jZXMuZ2V0kOowAYLT5JMCJToBKiIgL3YxL3tuYW1lPWluc3RhbmNlcy8qfTpkYXRhYmFzZXMSogEKEkJhdGNoU3luY0luc3RhbmNlcxImLmJ5dGViYXNlLnYxLkJhdGNoU3luY0luc3RhbmNlc1JlcXVlc3QaJy5ieXRlYmFzZS52MS5CYXRjaFN5bmNJbnN0YW5jZXNSZXNwb25zZSI7iuowEWJiLmluc3RhbmNlcy5zeW5jkOowAYLT5JMCHDoBKiIXL3YxL2luc3RhbmNlczpiYXRjaFN5bmMSsAEKFEJhdGNoVXBkYXRlSW5zdGFuY2VzEiguYnl0ZWJhc2UudjEuQmF0Y2hVcGRhdGVJbnN0YW5jZXNSZXF1ZXN0GikuYnl0ZWJhc2UudjEuQmF0Y2hVcGRhdGVJbnN0YW5jZXNSZXNwb25zZSJDiuowE2JiLmluc3RhbmNlcy51cGRhdGWQ6jABmOowAYLT5JMCHjoBKiIZL3YxL2luc3RhbmNlczpiYXRjaFVwZGF0ZRKZAQoNQWRkRGF0YVNvdXJjZRIhLmJ5dGViYXNlLnYxLkFkZERhdGFTb3VyY2VSZXF1ZXN0GhUuYnl0ZWJhc2UudjEuSW5zdGFuY2UiTorqMBNiYi5pbnN0YW5jZXMudXBkYXRlkOowAZjqMAGC0+STAik6ASoiJC92MS97bmFtZT1pbnN0YW5jZXMvKn06YWRkRGF0YVNvdXJjZRKiAQoQUmVtb3ZlRGF0YVNvdXJjZRIkLmJ5dGViYXNlLnYxLlJlbW92ZURhdGFTb3VyY2VSZXF1ZXN0GhUuYnl0ZWJhc2UudjEuSW5zdGFuY2UiUYrqMBNiYi5pbnN0YW5jZXMudXBkYXRlkOowAZjqMAGC0+STAiw6ASoiJy92MS97bmFtZT1pbnN0YW5jZXMvKn06cmVtb3ZlRGF0YVNvdXJjZRLGAQoQVXBkYXRlRGF0YVNvdXJjZRIkLmJ5dGViYXNlLnYxLlVwZGF0ZURhdGFTb3VyY2VSZXF1ZXN0GhUuYnl0ZWJhc2UudjEuSW5zdGFuY2UiddpBF2RhdGFfc291cmNlLHVwZGF0ZV9tYXNriuowE2JiLmluc3RhbmNlcy51cGRhdGWQ6jABmOowAYLT5JMCNjoLZGF0YV9zb3VyY2UyJy92MS97bmFtZT1pbnN0YW5jZXMvKn06dXBkYXRlRGF0YVNvdXJjZUKqAQoPY29tLmJ5dGViYXNlLnYxQhRJbnN0YW5jZVNlcnZpY2VQcm90b1ABWjRnaXRodWIuY29tL2J5dGViYXNlL2J5dGViYXNlL2JhY2tlbmQvZ2VuZXJhdGVkLWdvL3YxogIDQlhYqgILQnl0ZWJhc2UuVjHKAgtCeXRlYmFzZVxWMeICF0J5dGViYXNlXFYxXEdQQk1ldGFkYXRh6gIMQnl0ZWJhc2U6OlYxYgZwcm90bzM", [file_buf_validate_validate, file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_api_resource, file_google_protobuf_duration, file_google_protobuf_empty, file_google_protobuf_field_mask, file_google_protobuf_timestamp, file_v1_annotation, file_v1_common, file_v1_instance_role_service]);/*** Describes the message bytebase.v1.GetInstanceRequest.diff --git a/proto/gen/grpc-doc/openapi.yaml b/proto/gen/grpc-doc/openapi.yamlindex 7cc503a1d7..a812c1eeba 100644--- a/proto/gen/grpc-doc/openapi.yaml+++ b/proto/gen/grpc-doc/openapi.yaml@@ -18940,6 +18940,51 @@ components:title: ssl_keydescription: The SSL client private key.writeOnly: true+ sslCaPath:+ type: string+ title: ssl_ca_path+ description: The local filesystem path to the SSL certificate authority certificate.+ writeOnly: true+ sslCertPath:+ type: string+ title: ssl_cert_path+ description: The local filesystem path to the SSL client certificate.+ writeOnly: true+ sslKeyPath:+ type: string+ title: ssl_key_path+ description: The local filesystem path to the SSL client private key.+ writeOnly: true+ sslCaSet:+ type: boolean+ title: ssl_ca_set+ description: Whether an SSL certificate authority certificate has been configured.+ readOnly: true+ sslCertSet:+ type: boolean+ title: ssl_cert_set+ description: Whether an SSL client certificate has been configured.+ readOnly: true+ sslKeySet:+ type: boolean+ title: ssl_key_set+ description: Whether an SSL client private key has been configured.+ readOnly: true+ sslCaPathSet:+ type: boolean+ title: ssl_ca_path_set+ description: Whether an SSL certificate authority path has been configured.+ readOnly: true+ sslCertPathSet:+ type: boolean+ title: ssl_cert_path_set+ description: Whether an SSL client certificate path has been configured.+ readOnly: true+ sslKeyPathSet:+ type: boolean+ title: ssl_key_path_set+ description: Whether an SSL client private key path has been configured.+ readOnly: trueverifyTlsCertificate:type: booleantitle: verify_tls_certificatediff --git a/proto/gen/grpc-doc/store/README.md b/proto/gen/grpc-doc/store/README.mdindex 4bed9985bf..dbca2224bc 100644--- a/proto/gen/grpc-doc/store/README.md+++ b/proto/gen/grpc-doc/store/README.md@@ -2340,6 +2340,12 @@ OIDCIdentityProviderConfig is the structure for OIDC identity provider config.| obfuscated_ssl_cert | [string](#string) | | || ssl_key | [string](#string) | | || obfuscated_ssl_key | [string](#string) | | |+| ssl_ca_path | [string](#string) | | |+| obfuscated_ssl_ca_path | [string](#string) | | |+| ssl_cert_path | [string](#string) | | |+| obfuscated_ssl_cert_path | [string](#string) | | |+| ssl_key_path | [string](#string) | | |+| obfuscated_ssl_key_path | [string](#string) | | || 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) | | |diff --git a/proto/gen/grpc-doc/store/index.html b/proto/gen/grpc-doc/store/index.htmlindex 2e0eb876e2..a09d1324f1 100644--- a/proto/gen/grpc-doc/store/index.html+++ b/proto/gen/grpc-doc/store/index.html@@ -63,57 +63,57 @@}td p:nth-child(1) {- text-indent: 0;+ text-indent: 0;}-- .field-table td:nth-child(1) {++ .field-table td:nth-child(1) {width: 10em;}- .field-table td:nth-child(2) {+ .field-table td:nth-child(2) {width: 10em;}- .field-table td:nth-child(3) {+ .field-table td:nth-child(3) {width: 6em;}- .field-table td:nth-child(4) {+ .field-table td:nth-child(4) {width: auto;}-- .extension-table td:nth-child(1) {++ .extension-table td:nth-child(1) {width: 10em;}- .extension-table td:nth-child(2) {+ .extension-table td:nth-child(2) {width: 10em;}- .extension-table td:nth-child(3) {+ .extension-table td:nth-child(3) {width: 10em;}- .extension-table td:nth-child(4) {+ .extension-table td:nth-child(4) {width: 5em;}- .extension-table td:nth-child(5) {+ .extension-table td:nth-child(5) {width: auto;}-- .enum-table td:nth-child(1) {++ .enum-table td:nth-child(1) {width: 10em;}- .enum-table td:nth-child(2) {+ .enum-table td:nth-child(2) {width: 10em;}- .enum-table td:nth-child(3) {+ .enum-table td:nth-child(3) {width: auto;}-+.scalar-value-types-table tr {height: 3em;}-+#toc-container ul {list-style-type: none;padding-left: 1em;@@ -124,7 +124,7 @@font-weight: bold;}-+.file-heading {width: 100%;display: table;@@ -140,7 +140,7 @@display: table-cell;}-+.badge {width: 1.6em;height: 1.6em;@@ -160,7 +160,7 @@}</style>-+<link rel="stylesheet" type="text/css" href="stylesheet.css"/></head>@@ -172,1448 +172,1448 @@<div id="toc-container"><ul id="toc">--++<li><a href="#store%2faccess_grant.proto">store/access_grant.proto</a><ul>-+<li><a href="#bytebase.store.AccessGrant"><span class="badge">M</span>AccessGrant</a></li>-+<li><a href="#bytebase.store.AccessGrantPayload"><span class="badge">M</span>AccessGrantPayload</a></li>--++<li><a href="#bytebase.store.AccessGrant.Status"><span class="badge">E</span>AccessGrant.Status</a></li>---+++</ul></li>--++<li><a href="#store%2fcommon.proto">store/common.proto</a><ul>-+<li><a href="#bytebase.store.PageToken"><span class="badge">M</span>PageToken</a></li>-+<li><a href="#bytebase.store.Position"><span class="badge">M</span>Position</a></li>-+<li><a href="#bytebase.store.Range"><span class="badge">M</span>Range</a></li>--++<li><a href="#bytebase.store.Engine"><span class="badge">E</span>Engine</a></li>-+<li><a href="#bytebase.store.ExportFormat"><span class="badge">E</span>ExportFormat</a></li>-+<li><a href="#bytebase.store.RiskLevel"><span class="badge">E</span>RiskLevel</a></li>-+<li><a href="#bytebase.store.SchemaChangeType"><span class="badge">E</span>SchemaChangeType</a></li>-+<li><a href="#bytebase.store.StatementType"><span class="badge">E</span>StatementType</a></li>-+<li><a href="#bytebase.store.VCSType"><span class="badge">E</span>VCSType</a></li>-+<li><a href="#bytebase.store.WebhookType"><span class="badge">E</span>WebhookType</a></li>---+++</ul></li>--++<li><a href="#store%2fadvice.proto">store/advice.proto</a><ul>-+<li><a href="#bytebase.store.Advice"><span class="badge">M</span>Advice</a></li>--++<li><a href="#bytebase.store.Advice.Status"><span class="badge">E</span>Advice.Status</a></li>---+++</ul></li>--++<li><a href="#store%2fapproval.proto">store/approval.proto</a><ul>-+<li><a href="#bytebase.store.ApprovalFlow"><span class="badge">M</span>ApprovalFlow</a></li>-+<li><a href="#bytebase.store.ApprovalTemplate"><span class="badge">M</span>ApprovalTemplate</a></li>-+<li><a href="#bytebase.store.IssuePayloadApproval"><span class="badge">M</span>IssuePayloadApproval</a></li>-+<li><a href="#bytebase.store.IssuePayloadApproval.Approver"><span class="badge">M</span>IssuePayloadApproval.Approver</a></li>--++<li><a href="#bytebase.store.IssuePayloadApproval.Approver.Status"><span class="badge">E</span>IssuePayloadApproval.Approver.Status</a></li>---+++</ul></li>--++<li><a href="#store%2faudit_log.proto">store/audit_log.proto</a><ul>-+<li><a href="#bytebase.store.AuditLog"><span class="badge">M</span>AuditLog</a></li>-+<li><a href="#bytebase.store.RequestMetadata"><span class="badge">M</span>RequestMetadata</a></li>--++<li><a href="#bytebase.store.AuditLog.Severity"><span class="badge">E</span>AuditLog.Severity</a></li>---+++</ul></li>--++<li><a href="#store%2fauth.proto">store/auth.proto</a><ul>--++<li><a href="#bytebase.store.EmailVerificationCodePurpose"><span class="badge">E</span>EmailVerificationCodePurpose</a></li>---+++</ul></li>--++<li><a href="#store%2fchangelog.proto">store/changelog.proto</a><ul>-+<li><a href="#bytebase.store.ChangelogPayload"><span class="badge">M</span>ChangelogPayload</a></li>----++++</ul></li>--++<li><a href="#store%2fdatabase.proto">store/database.proto</a><ul>-+<li><a href="#bytebase.store.BoundingBox"><span class="badge">M</span>BoundingBox</a></li>-+<li><a href="#bytebase.store.CheckConstraintMetadata"><span class="badge">M</span>CheckConstraintMetadata</a></li>-+<li><a href="#bytebase.store.ColumnCatalog"><span class="badge">M</span>ColumnCatalog</a></li>-+<li><a href="#bytebase.store.ColumnCatalog.LabelsEntry"><span class="badge">M</span>ColumnCatalog.LabelsEntry</a></li>-+<li><a href="#bytebase.store.ColumnMetadata"><span class="badge">M</span>ColumnMetadata</a></li>-+<li><a href="#bytebase.store.DatabaseConfig"><span class="badge">M</span>DatabaseConfig</a></li>-+<li><a href="#bytebase.store.DatabaseMetadata"><span class="badge">M</span>DatabaseMetadata</a></li>-+<li><a href="#bytebase.store.DatabaseMetadata.LabelsEntry"><span class="badge">M</span>DatabaseMetadata.LabelsEntry</a></li>-+<li><a href="#bytebase.store.DatabaseSchemaMetadata"><span class="badge">M</span>DatabaseSchemaMetadata</a></li>-+<li><a href="#bytebase.store.DependencyColumn"><span class="badge">M</span>DependencyColumn</a></li>-+<li><a href="#bytebase.store.DependencyTable"><span class="badge">M</span>DependencyTable</a></li>-+<li><a href="#bytebase.store.DimensionalConfig"><span class="badge">M</span>DimensionalConfig</a></li>-+<li><a href="#bytebase.store.EnumTypeMetadata"><span class="badge">M</span>EnumTypeMetadata</a></li>-+<li><a href="#bytebase.store.EventMetadata"><span class="badge">M</span>EventMetadata</a></li>-+<li><a href="#bytebase.store.EventTriggerMetadata"><span class="badge">M</span>EventTriggerMetadata</a></li>-+<li><a href="#bytebase.store.ExcludeConstraintMetadata"><span class="badge">M</span>ExcludeConstraintMetadata</a></li>-+<li><a href="#bytebase.store.ExtensionMetadata"><span class="badge">M</span>ExtensionMetadata</a></li>-+<li><a href="#bytebase.store.ExternalTableMetadata"><span class="badge">M</span>ExternalTableMetadata</a></li>-+<li><a href="#bytebase.store.ForeignKeyMetadata"><span class="badge">M</span>ForeignKeyMetadata</a></li>-+<li><a href="#bytebase.store.FunctionMetadata"><span class="badge">M</span>FunctionMetadata</a></li>-+<li><a href="#bytebase.store.GenerationMetadata"><span class="badge">M</span>GenerationMetadata</a></li>-+<li><a href="#bytebase.store.GridLevel"><span class="badge">M</span>GridLevel</a></li>-+<li><a href="#bytebase.store.IndexMetadata"><span class="badge">M</span>IndexMetadata</a></li>-+<li><a href="#bytebase.store.InstanceRoleMetadata"><span class="badge">M</span>InstanceRoleMetadata</a></li>-+<li><a href="#bytebase.store.LinkedDatabaseMetadata"><span class="badge">M</span>LinkedDatabaseMetadata</a></li>-+<li><a href="#bytebase.store.MaterializedViewMetadata"><span class="badge">M</span>MaterializedViewMetadata</a></li>-+<li><a href="#bytebase.store.ObjectSchema"><span class="badge">M</span>ObjectSchema</a></li>-+<li><a href="#bytebase.store.ObjectSchema.ArrayKind"><span class="badge">M</span>ObjectSchema.ArrayKind</a></li>-+<li><a href="#bytebase.store.ObjectSchema.StructKind"><span class="badge">M</span>ObjectSchema.StructKind</a></li>-+<li><a href="#bytebase.store.ObjectSchema.StructKind.PropertiesEntry"><span class="badge">M</span>ObjectSchema.StructKind.PropertiesEntry</a></li>-+<li><a href="#bytebase.store.PackageMetadata"><span class="badge">M</span>PackageMetadata</a></li>-+<li><a href="#bytebase.store.ProcedureMetadata"><span class="badge">M</span>ProcedureMetadata</a></li>-+<li><a href="#bytebase.store.RuleMetadata"><span class="badge">M</span>RuleMetadata</a></li>-+<li><a href="#bytebase.store.SchemaCatalog"><span class="badge">M</span>SchemaCatalog</a></li>-+<li><a href="#bytebase.store.SchemaMetadata"><span class="badge">M</span>SchemaMetadata</a></li>-+<li><a href="#bytebase.store.SequenceMetadata"><span class="badge">M</span>SequenceMetadata</a></li>-+<li><a href="#bytebase.store.SpatialIndexConfig"><span class="badge">M</span>SpatialIndexConfig</a></li>-+<li><a href="#bytebase.store.SpatialIndexConfig.EngineSpecificEntry"><span class="badge">M</span>SpatialIndexConfig.EngineSpecificEntry</a></li>-+<li><a href="#bytebase.store.StorageConfig"><span class="badge">M</span>StorageConfig</a></li>-+<li><a href="#bytebase.store.StreamMetadata"><span class="badge">M</span>StreamMetadata</a></li>-+<li><a href="#bytebase.store.TableCatalog"><span class="badge">M</span>TableCatalog</a></li>-+<li><a href="#bytebase.store.TableMetadata"><span class="badge">M</span>TableMetadata</a></li>-+<li><a href="#bytebase.store.TablePartitionMetadata"><span class="badge">M</span>TablePartitionMetadata</a></li>-+<li><a href="#bytebase.store.TaskMetadata"><span class="badge">M</span>TaskMetadata</a></li>-+<li><a href="#bytebase.store.TessellationConfig"><span class="badge">M</span>TessellationConfig</a></li>-+<li><a href="#bytebase.store.TriggerMetadata"><span class="badge">M</span>TriggerMetadata</a></li>-+<li><a href="#bytebase.store.ViewMetadata"><span class="badge">M</span>ViewMetadata</a></li>--++<li><a href="#bytebase.store.ColumnMetadata.IdentityGeneration"><span class="badge">E</span>ColumnMetadata.IdentityGeneration</a></li>-+<li><a href="#bytebase.store.GenerationMetadata.Type"><span class="badge">E</span>GenerationMetadata.Type</a></li>-+<li><a href="#bytebase.store.ObjectSchema.Type"><span class="badge">E</span>ObjectSchema.Type</a></li>-+<li><a href="#bytebase.store.StreamMetadata.Mode"><span class="badge">E</span>StreamMetadata.Mode</a></li>-+<li><a href="#bytebase.store.StreamMetadata.Type"><span class="badge">E</span>StreamMetadata.Type</a></li>-+<li><a href="#bytebase.store.SyncStatus"><span class="badge">E</span>SyncStatus</a></li>-+<li><a href="#bytebase.store.TablePartitionMetadata.Type"><span class="badge">E</span>TablePartitionMetadata.Type</a></li>-+<li><a href="#bytebase.store.TaskMetadata.State"><span class="badge">E</span>TaskMetadata.State</a></li>---+++</ul></li>--++<li><a href="#store%2fexport_archive.proto">store/export_archive.proto</a><ul>-+<li><a href="#bytebase.store.ExportArchivePayload"><span class="badge">M</span>ExportArchivePayload</a></li>----++++</ul></li>--++<li><a href="#store%2fgroup.proto">store/group.proto</a><ul>-+<li><a href="#bytebase.store.GroupMember"><span class="badge">M</span>GroupMember</a></li>-+<li><a href="#bytebase.store.GroupPayload"><span class="badge">M</span>GroupPayload</a></li>--++<li><a href="#bytebase.store.GroupMember.Role"><span class="badge">E</span>GroupMember.Role</a></li>---+++</ul></li>--++<li><a href="#store%2fidp.proto">store/idp.proto</a><ul>-+<li><a href="#bytebase.store.FieldMapping"><span class="badge">M</span>FieldMapping</a></li>-+<li><a href="#bytebase.store.IdentityProviderConfig"><span class="badge">M</span>IdentityProviderConfig</a></li>-+<li><a href="#bytebase.store.IdentityProviderUserInfo"><span class="badge">M</span>IdentityProviderUserInfo</a></li>-+<li><a href="#bytebase.store.LDAPIdentityProviderConfig"><span class="badge">M</span>LDAPIdentityProviderConfig</a></li>-+<li><a href="#bytebase.store.OAuth2IdentityProviderConfig"><span class="badge">M</span>OAuth2IdentityProviderConfig</a></li>-+<li><a href="#bytebase.store.OIDCIdentityProviderConfig"><span class="badge">M</span>OIDCIdentityProviderConfig</a></li>--++<li><a href="#bytebase.store.IdentityProviderType"><span class="badge">E</span>IdentityProviderType</a></li>-+<li><a href="#bytebase.store.LDAPIdentityProviderConfig.SecurityProtocol"><span class="badge">E</span>LDAPIdentityProviderConfig.SecurityProtocol</a></li>-+<li><a href="#bytebase.store.OAuth2AuthStyle"><span class="badge">E</span>OAuth2AuthStyle</a></li>---+++</ul></li>--++<li><a href="#store%2finstance.proto">store/instance.proto</a><ul>-+<li><a href="#bytebase.store.DataSource"><span class="badge">M</span>DataSource</a></li>-+<li><a href="#bytebase.store.DataSource.AWSCredential"><span class="badge">M</span>DataSource.AWSCredential</a></li>-+<li><a href="#bytebase.store.DataSource.Address"><span class="badge">M</span>DataSource.Address</a></li>-+<li><a href="#bytebase.store.DataSource.AzureCredential"><span class="badge">M</span>DataSource.AzureCredential</a></li>-+<li><a href="#bytebase.store.DataSource.ExtraConnectionParametersEntry"><span class="badge">M</span>DataSource.ExtraConnectionParametersEntry</a></li>-+<li><a href="#bytebase.store.DataSource.GCPCredential"><span class="badge">M</span>DataSource.GCPCredential</a></li>-+<li><a href="#bytebase.store.DataSourceExternalSecret"><span class="badge">M</span>DataSourceExternalSecret</a></li>-+<li><a href="#bytebase.store.DataSourceExternalSecret.AppRoleAuthOption"><span class="badge">M</span>DataSourceExternalSecret.AppRoleAuthOption</a></li>-+<li><a href="#bytebase.store.Instance"><span class="badge">M</span>Instance</a></li>-+<li><a href="#bytebase.store.Instance.LabelsEntry"><span class="badge">M</span>Instance.LabelsEntry</a></li>-+<li><a href="#bytebase.store.InstanceRole"><span class="badge">M</span>InstanceRole</a></li>-+<li><a href="#bytebase.store.KerberosConfig"><span class="badge">M</span>KerberosConfig</a></li>-+<li><a href="#bytebase.store.SASLConfig"><span class="badge">M</span>SASLConfig</a></li>--++<li><a href="#bytebase.store.DataSource.AuthenticationType"><span class="badge">E</span>DataSource.AuthenticationType</a></li>-+<li><a href="#bytebase.store.DataSource.RedisType"><span class="badge">E</span>DataSource.RedisType</a></li>-+<li><a href="#bytebase.store.DataSourceExternalSecret.AppRoleAuthOption.SecretType"><span class="badge">E</span>DataSourceExternalSecret.AppRoleAuthOption.SecretType</a></li>-+<li><a href="#bytebase.store.DataSourceExternalSecret.AuthType"><span class="badge">E</span>DataSourceExternalSecret.AuthType</a></li>-+<li><a href="#bytebase.store.DataSourceExternalSecret.SecretType"><span class="badge">E</span>DataSourceExternalSecret.SecretType</a></li>-+<li><a href="#bytebase.store.DataSourceType"><span class="badge">E</span>DataSourceType</a></li>---+++</ul></li>--++<li><a href="#store%2fissue.proto">store/issue.proto</a><ul>-+<li><a href="#bytebase.store.Issue"><span class="badge">M</span>Issue</a></li>-+<li><a href="#bytebase.store.RoleGrant"><span class="badge">M</span>RoleGrant</a></li>--++<li><a href="#bytebase.store.Issue.Status"><span class="badge">E</span>Issue.Status</a></li>-+<li><a href="#bytebase.store.Issue.Type"><span class="badge">E</span>Issue.Type</a></li>---+++</ul></li>--++<li><a href="#store%2fissue_comment.proto">store/issue_comment.proto</a><ul>-+<li><a href="#bytebase.store.IssueCommentPayload"><span class="badge">M</span>IssueCommentPayload</a></li>-+<li><a href="#bytebase.store.IssueCommentPayload.Approval"><span class="badge">M</span>IssueCommentPayload.Approval</a></li>-+<li><a href="#bytebase.store.IssueCommentPayload.IssueUpdate"><span class="badge">M</span>IssueCommentPayload.IssueUpdate</a></li>-+<li><a href="#bytebase.store.IssueCommentPayload.PlanSpecUpdate"><span class="badge">M</span>IssueCommentPayload.PlanSpecUpdate</a></li>----++++</ul></li>--++<li><a href="#store%2foauth2.proto">store/oauth2.proto</a><ul>-+<li><a href="#bytebase.store.OAuth2AuthorizationCodeConfig"><span class="badge">M</span>OAuth2AuthorizationCodeConfig</a></li>-+<li><a href="#bytebase.store.OAuth2ClientConfig"><span class="badge">M</span>OAuth2ClientConfig</a></li>----++++</ul></li>--++<li><a href="#store%2fplan.proto">store/plan.proto</a><ul>-+<li><a href="#bytebase.store.PlanConfig"><span class="badge">M</span>PlanConfig</a></li>-+<li><a href="#bytebase.store.PlanConfig.ChangeDatabaseConfig"><span class="badge">M</span>PlanConfig.ChangeDatabaseConfig</a></li>-+<li><a href="#bytebase.store.PlanConfig.CreateDatabaseConfig"><span class="badge">M</span>PlanConfig.CreateDatabaseConfig</a></li>-+<li><a href="#bytebase.store.PlanConfig.ExportDataConfig"><span class="badge">M</span>PlanConfig.ExportDataConfig</a></li>-+<li><a href="#bytebase.store.PlanConfig.Spec"><span class="badge">M</span>PlanConfig.Spec</a></li>----++++</ul></li>--++<li><a href="#store%2fplan_check_run.proto">store/plan_check_run.proto</a><ul>-+<li><a href="#bytebase.store.ChangedResourceDatabase"><span class="badge">M</span>ChangedResourceDatabase</a></li>-+<li><a href="#bytebase.store.ChangedResourceSchema"><span class="badge">M</span>ChangedResourceSchema</a></li>-+<li><a href="#bytebase.store.ChangedResourceTable"><span class="badge">M</span>ChangedResourceTable</a></li>-+<li><a href="#bytebase.store.ChangedResources"><span class="badge">M</span>ChangedResources</a></li>-+<li><a href="#bytebase.store.PlanCheckRunResult"><span class="badge">M</span>PlanCheckRunResult</a></li>-+<li><a href="#bytebase.store.PlanCheckRunResult.Result"><span class="badge">M</span>PlanCheckRunResult.Result</a></li>-+<li><a href="#bytebase.store.PlanCheckRunResult.Result.SqlReviewReport"><span class="badge">M</span>PlanCheckRunResult.Result.SqlReviewReport</a></li>-+<li><a href="#bytebase.store.PlanCheckRunResult.Result.SqlSummaryReport"><span class="badge">M</span>PlanCheckRunResult.Result.SqlSummaryReport</a></li>--++<li><a href="#bytebase.store.PlanCheckType"><span class="badge">E</span>PlanCheckType</a></li>---+++</ul></li>--++<li><a href="#store%2fpolicy.proto">store/policy.proto</a><ul>-+<li><a href="#bytebase.store.Binding"><span class="badge">M</span>Binding</a></li>-+<li><a href="#bytebase.store.IamPolicy"><span class="badge">M</span>IamPolicy</a></li>-+<li><a href="#bytebase.store.MaskingExemptionPolicy"><span class="badge">M</span>MaskingExemptionPolicy</a></li>-+<li><a href="#bytebase.store.MaskingExemptionPolicy.Exemption"><span class="badge">M</span>MaskingExemptionPolicy.Exemption</a></li>-+<li><a href="#bytebase.store.MaskingRulePolicy"><span class="badge">M</span>MaskingRulePolicy</a></li>-+<li><a href="#bytebase.store.MaskingRulePolicy.MaskingRule"><span class="badge">M</span>MaskingRulePolicy.MaskingRule</a></li>-+<li><a href="#bytebase.store.Policy"><span class="badge">M</span>Policy</a></li>-+<li><a href="#bytebase.store.QueryDataPolicy"><span class="badge">M</span>QueryDataPolicy</a></li>-+<li><a href="#bytebase.store.RolloutPolicy"><span class="badge">M</span>RolloutPolicy</a></li>-+<li><a href="#bytebase.store.TagPolicy"><span class="badge">M</span>TagPolicy</a></li>-+<li><a href="#bytebase.store.TagPolicy.TagsEntry"><span class="badge">M</span>TagPolicy.TagsEntry</a></li>--++<li><a href="#bytebase.store.Policy.Resource"><span class="badge">E</span>Policy.Resource</a></li>-+<li><a href="#bytebase.store.Policy.Type"><span class="badge">E</span>Policy.Type</a></li>---+++</ul></li>--++<li><a href="#store%2fproject.proto">store/project.proto</a><ul>-+<li><a href="#bytebase.store.Label"><span class="badge">M</span>Label</a></li>-+<li><a href="#bytebase.store.Project"><span class="badge">M</span>Project</a></li>-+<li><a href="#bytebase.store.Project.ExecutionRetryPolicy"><span class="badge">M</span>Project.ExecutionRetryPolicy</a></li>-+<li><a href="#bytebase.store.Project.LabelsEntry"><span class="badge">M</span>Project.LabelsEntry</a></li>----++++</ul></li>--++<li><a href="#store%2fproject_webhook.proto">store/project_webhook.proto</a><ul>-+<li><a href="#bytebase.store.Activity"><span class="badge">M</span>Activity</a></li>-+<li><a href="#bytebase.store.ProjectWebhook"><span class="badge">M</span>ProjectWebhook</a></li>--++<li><a href="#bytebase.store.Activity.Type"><span class="badge">E</span>Activity.Type</a></li>---+++</ul></li>--++<li><a href="#store%2fquery_history.proto">store/query_history.proto</a><ul>-+<li><a href="#bytebase.store.QueryHistoryPayload"><span class="badge">M</span>QueryHistoryPayload</a></li>----++++</ul></li>--++<li><a href="#store%2frelease.proto">store/release.proto</a><ul>-+<li><a href="#bytebase.store.ReleasePayload"><span class="badge">M</span>ReleasePayload</a></li>-+<li><a href="#bytebase.store.ReleasePayload.File"><span class="badge">M</span>ReleasePayload.File</a></li>-+<li><a href="#bytebase.store.ReleasePayload.VCSSource"><span class="badge">M</span>ReleasePayload.VCSSource</a></li>----++++</ul></li>--++<li><a href="#store%2freview_config.proto">store/review_config.proto</a><ul>-+<li><a href="#bytebase.store.ReviewConfigPayload"><span class="badge">M</span>ReviewConfigPayload</a></li>-+<li><a href="#bytebase.store.SQLReviewRule"><span class="badge">M</span>SQLReviewRule</a></li>-+<li><a href="#bytebase.store.SQLReviewRule.CommentConventionRulePayload"><span class="badge">M</span>SQLReviewRule.CommentConventionRulePayload</a></li>-+<li><a href="#bytebase.store.SQLReviewRule.NamingCaseRulePayload"><span class="badge">M</span>SQLReviewRule.NamingCaseRulePayload</a></li>-+<li><a href="#bytebase.store.SQLReviewRule.NamingRulePayload"><span class="badge">M</span>SQLReviewRule.NamingRulePayload</a></li>-+<li><a href="#bytebase.store.SQLReviewRule.NumberRulePayload"><span class="badge">M</span>SQLReviewRule.NumberRulePayload</a></li>-+<li><a href="#bytebase.store.SQLReviewRule.StringArrayRulePayload"><span class="badge">M</span>SQLReviewRule.StringArrayRulePayload</a></li>-+<li><a href="#bytebase.store.SQLReviewRule.StringRulePayload"><span class="badge">M</span>SQLReviewRule.StringRulePayload</a></li>--++<li><a href="#bytebase.store.SQLReviewRule.Level"><span class="badge">E</span>SQLReviewRule.Level</a></li>-+<li><a href="#bytebase.store.SQLReviewRule.Type"><span class="badge">E</span>SQLReviewRule.Type</a></li>---+++</ul></li>--++<li><a href="#store%2frevision.proto">store/revision.proto</a><ul>-+<li><a href="#bytebase.store.RevisionPayload"><span class="badge">M</span>RevisionPayload</a></li>----++++</ul></li>--++<li><a href="#store%2frole.proto">store/role.proto</a><ul>-+<li><a href="#bytebase.store.RolePermissions"><span class="badge">M</span>RolePermissions</a></li>----++++</ul></li>--++<li><a href="#store%2fserver_config.proto">store/server_config.proto</a><ul>-+<li><a href="#bytebase.store.ServerConfigPayload"><span class="badge">M</span>ServerConfigPayload</a></li>----++++</ul></li>--++<li><a href="#store%2fsetting.proto">store/setting.proto</a><ul>-+<li><a href="#bytebase.store.AISetting"><span class="badge">M</span>AISetting</a></li>-+<li><a href="#bytebase.store.Algorithm"><span class="badge">M</span>Algorithm</a></li>-+<li><a href="#bytebase.store.Algorithm.FullMask"><span class="badge">M</span>Algorithm.FullMask</a></li>-+<li><a href="#bytebase.store.Algorithm.InnerOuterMask"><span class="badge">M</span>Algorithm.InnerOuterMask</a></li>-+<li><a href="#bytebase.store.Algorithm.MD5Mask"><span class="badge">M</span>Algorithm.MD5Mask</a></li>-+<li><a href="#bytebase.store.Algorithm.RangeMask"><span class="badge">M</span>Algorithm.RangeMask</a></li>-+<li><a href="#bytebase.store.Algorithm.RangeMask.Slice"><span class="badge">M</span>Algorithm.RangeMask.Slice</a></li>-+<li><a href="#bytebase.store.AppIMSetting"><span class="badge">M</span>AppIMSetting</a></li>-+<li><a href="#bytebase.store.AppIMSetting.DingTalk"><span class="badge">M</span>AppIMSetting.DingTalk</a></li>-+<li><a href="#bytebase.store.AppIMSetting.Feishu"><span class="badge">M</span>AppIMSetting.Feishu</a></li>-+<li><a href="#bytebase.store.AppIMSetting.IMSetting"><span class="badge">M</span>AppIMSetting.IMSetting</a></li>-+<li><a href="#bytebase.store.AppIMSetting.Lark"><span class="badge">M</span>AppIMSetting.Lark</a></li>-+<li><a href="#bytebase.store.AppIMSetting.Slack"><span class="badge">M</span>AppIMSetting.Slack</a></li>-+<li><a href="#bytebase.store.AppIMSetting.Teams"><span class="badge">M</span>AppIMSetting.Teams</a></li>-+<li><a href="#bytebase.store.AppIMSetting.Wecom"><span class="badge">M</span>AppIMSetting.Wecom</a></li>-+<li><a href="#bytebase.store.DataClassificationSetting"><span class="badge">M</span>DataClassificationSetting</a></li>-+<li><a href="#bytebase.store.DataClassificationSetting.DataClassificationConfig"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig</a></li>-+<li><a href="#bytebase.store.DataClassificationSetting.DataClassificationConfig.ClassificationEntry"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.ClassificationEntry</a></li>-+<li><a href="#bytebase.store.DataClassificationSetting.DataClassificationConfig.DataClassification"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.DataClassification</a></li>-+<li><a href="#bytebase.store.DataClassificationSetting.DataClassificationConfig.Level"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.Level</a></li>-+<li><a href="#bytebase.store.EmailSetting"><span class="badge">M</span>EmailSetting</a></li>-+<li><a href="#bytebase.store.EmailSetting.SMTPConfig"><span class="badge">M</span>EmailSetting.SMTPConfig</a></li>-+<li><a href="#bytebase.store.EnvironmentSetting"><span class="badge">M</span>EnvironmentSetting</a></li>-+<li><a href="#bytebase.store.EnvironmentSetting.Environment"><span class="badge">M</span>EnvironmentSetting.Environment</a></li>-+<li><a href="#bytebase.store.EnvironmentSetting.Environment.TagsEntry"><span class="badge">M</span>EnvironmentSetting.Environment.TagsEntry</a></li>-+<li><a href="#bytebase.store.SemanticTypeSetting"><span class="badge">M</span>SemanticTypeSetting</a></li>-+<li><a href="#bytebase.store.SemanticTypeSetting.SemanticType"><span class="badge">M</span>SemanticTypeSetting.SemanticType</a></li>-+<li><a href="#bytebase.store.SystemSetting"><span class="badge">M</span>SystemSetting</a></li>-+<li><a href="#bytebase.store.WorkspaceApprovalSetting"><span class="badge">M</span>WorkspaceApprovalSetting</a></li>-+<li><a href="#bytebase.store.WorkspaceApprovalSetting.Rule"><span class="badge">M</span>WorkspaceApprovalSetting.Rule</a></li>-+<li><a href="#bytebase.store.WorkspaceProfileSetting"><span class="badge">M</span>WorkspaceProfileSetting</a></li>-+<li><a href="#bytebase.store.WorkspaceProfileSetting.Announcement"><span class="badge">M</span>WorkspaceProfileSetting.Announcement</a></li>-+<li><a href="#bytebase.store.WorkspaceProfileSetting.PasswordRestriction"><span class="badge">M</span>WorkspaceProfileSetting.PasswordRestriction</a></li>--++<li><a href="#bytebase.store.AISetting.Provider"><span class="badge">E</span>AISetting.Provider</a></li>-+<li><a href="#bytebase.store.Algorithm.InnerOuterMask.MaskType"><span class="badge">E</span>Algorithm.InnerOuterMask.MaskType</a></li>-+<li><a href="#bytebase.store.EmailSetting.SMTPConfig.Authentication"><span class="badge">E</span>EmailSetting.SMTPConfig.Authentication</a></li>-+<li><a href="#bytebase.store.EmailSetting.SMTPConfig.Encryption"><span class="badge">E</span>EmailSetting.SMTPConfig.Encryption</a></li>-+<li><a href="#bytebase.store.EmailSetting.Type"><span class="badge">E</span>EmailSetting.Type</a></li>-+<li><a href="#bytebase.store.SettingName"><span class="badge">E</span>SettingName</a></li>-+<li><a href="#bytebase.store.WorkspaceApprovalSetting.Rule.Source"><span class="badge">E</span>WorkspaceApprovalSetting.Rule.Source</a></li>-+<li><a href="#bytebase.store.WorkspaceProfileSetting.Announcement.AlertLevel"><span class="badge">E</span>WorkspaceProfileSetting.Announcement.AlertLevel</a></li>-+<li><a href="#bytebase.store.WorkspaceProfileSetting.DatabaseChangeMode"><span class="badge">E</span>WorkspaceProfileSetting.DatabaseChangeMode</a></li>---+++</ul></li>--++<li><a href="#store%2fsignal.proto">store/signal.proto</a><ul>-+<li><a href="#bytebase.store.Signal"><span class="badge">M</span>Signal</a></li>--++<li><a href="#bytebase.store.Signal.Type"><span class="badge">E</span>Signal.Type</a></li>---+++</ul></li>--++<li><a href="#store%2fsubscription.proto">store/subscription.proto</a><ul>-+<li><a href="#bytebase.store.SubscriptionPayload"><span class="badge">M</span>SubscriptionPayload</a></li>--++<li><a href="#bytebase.store.SubscriptionPayload.BillingInterval"><span class="badge">E</span>SubscriptionPayload.BillingInterval</a></li>-+<li><a href="#bytebase.store.SubscriptionPayload.Plan"><span class="badge">E</span>SubscriptionPayload.Plan</a></li>-+<li><a href="#bytebase.store.SubscriptionPayload.Status"><span class="badge">E</span>SubscriptionPayload.Status</a></li>---+++</ul></li>--++<li><a href="#store%2ftask.proto">store/task.proto</a><ul>-+<li><a href="#bytebase.store.Task"><span class="badge">M</span>Task</a></li>--++<li><a href="#bytebase.store.Task.Type"><span class="badge">E</span>Task.Type</a></li>---+++</ul></li>--++<li><a href="#store%2ftask_run.proto">store/task_run.proto</a><ul>-+<li><a href="#bytebase.store.SchedulerInfo"><span class="badge">M</span>SchedulerInfo</a></li>-+<li><a href="#bytebase.store.SchedulerInfo.WaitingCause"><span class="badge">M</span>SchedulerInfo.WaitingCause</a></li>-+<li><a href="#bytebase.store.TaskRun"><span class="badge">M</span>TaskRun</a></li>-+<li><a href="#bytebase.store.TaskRunPayload"><span class="badge">M</span>TaskRunPayload</a></li>-+<li><a href="#bytebase.store.TaskRunResult"><span class="badge">M</span>TaskRunResult</a></li>--++<li><a href="#bytebase.store.TaskRun.Status"><span class="badge">E</span>TaskRun.Status</a></li>---+++</ul></li>--++<li><a href="#store%2ftask_run_log.proto">store/task_run_log.proto</a><ul>-+<li><a href="#bytebase.store.PriorBackupDetail"><span class="badge">M</span>PriorBackupDetail</a></li>-+<li><a href="#bytebase.store.PriorBackupDetail.Item"><span class="badge">M</span>PriorBackupDetail.Item</a></li>-+<li><a href="#bytebase.store.PriorBackupDetail.Item.Table"><span class="badge">M</span>PriorBackupDetail.Item.Table</a></li>-+<li><a href="#bytebase.store.TaskRunLog"><span class="badge">M</span>TaskRunLog</a></li>-+<li><a href="#bytebase.store.TaskRunLog.CommandExecute"><span class="badge">M</span>TaskRunLog.CommandExecute</a></li>-+<li><a href="#bytebase.store.TaskRunLog.CommandResponse"><span class="badge">M</span>TaskRunLog.CommandResponse</a></li>-+<li><a href="#bytebase.store.TaskRunLog.ComputeDiffEnd"><span class="badge">M</span>TaskRunLog.ComputeDiffEnd</a></li>-+<li><a href="#bytebase.store.TaskRunLog.ComputeDiffStart"><span class="badge">M</span>TaskRunLog.ComputeDiffStart</a></li>-+<li><a href="#bytebase.store.TaskRunLog.DatabaseSyncEnd"><span class="badge">M</span>TaskRunLog.DatabaseSyncEnd</a></li>-+<li><a href="#bytebase.store.TaskRunLog.DatabaseSyncStart"><span class="badge">M</span>TaskRunLog.DatabaseSyncStart</a></li>-+<li><a href="#bytebase.store.TaskRunLog.PriorBackupEnd"><span class="badge">M</span>TaskRunLog.PriorBackupEnd</a></li>-+<li><a href="#bytebase.store.TaskRunLog.PriorBackupStart"><span class="badge">M</span>TaskRunLog.PriorBackupStart</a></li>-+<li><a href="#bytebase.store.TaskRunLog.ReleaseFileExecute"><span class="badge">M</span>TaskRunLog.ReleaseFileExecute</a></li>-+<li><a href="#bytebase.store.TaskRunLog.RetryInfo"><span class="badge">M</span>TaskRunLog.RetryInfo</a></li>-+<li><a href="#bytebase.store.TaskRunLog.SchemaDumpEnd"><span class="badge">M</span>TaskRunLog.SchemaDumpEnd</a></li>-+<li><a href="#bytebase.store.TaskRunLog.SchemaDumpStart"><span class="badge">M</span>TaskRunLog.SchemaDumpStart</a></li>-+<li><a href="#bytebase.store.TaskRunLog.TransactionControl"><span class="badge">M</span>TaskRunLog.TransactionControl</a></li>--++<li><a href="#bytebase.store.TaskRunLog.TransactionControl.Type"><span class="badge">E</span>TaskRunLog.TransactionControl.Type</a></li>-+<li><a href="#bytebase.store.TaskRunLog.Type"><span class="badge">E</span>TaskRunLog.Type</a></li>---+++</ul></li>--++<li><a href="#store%2fuser.proto">store/user.proto</a><ul>-+<li><a href="#bytebase.store.MFAConfig"><span class="badge">M</span>MFAConfig</a></li>-+<li><a href="#bytebase.store.UserProfile"><span class="badge">M</span>UserProfile</a></li>-+<li><a href="#bytebase.store.WorkloadIdentityConfig"><span class="badge">M</span>WorkloadIdentityConfig</a></li>--++<li><a href="#bytebase.store.PrincipalType"><span class="badge">E</span>PrincipalType</a></li>-+<li><a href="#bytebase.store.WorkloadIdentityConfig.ProviderType"><span class="badge">E</span>WorkloadIdentityConfig.ProviderType</a></li>---+++</ul></li>--++<li><a href="#store%2fworksheet.proto">store/worksheet.proto</a><ul>-+<li><a href="#bytebase.store.WorkSheetOrganizerPayload"><span class="badge">M</span>WorkSheetOrganizerPayload</a></li>----++++</ul></li>--++<li><a href="#store%2fworkspace.proto">store/workspace.proto</a><ul>-+<li><a href="#bytebase.store.WorkspacePayload"><span class="badge">M</span>WorkspacePayload</a></li>----++++</ul></li>-+<li><a href="#scalar-value-types">Scalar Value Types</a></li></ul></div>--++<div class="file-heading"><h2 id="store/access_grant.proto">store/access_grant.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.AccessGrant">AccessGrant</h3><p></p>---+++<h3 id="bytebase.store.AccessGrantPayload">AccessGrantPayload</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>issue_id</td><td><a href="#int64">int64</a></td><td></td><td><p>The issue associated with the access grant. </p></td></tr>-+<tr><td>targets</td><td><a href="#string">string</a></td>@@ -1621,28 +1621,28 @@<td><p>The target databases for this access grant.Format: instances/{instance}/databases/{database} </p></td></tr>-+<tr><td>query</td><td><a href="#string">string</a></td><td></td><td><p>The query permission granted. </p></td></tr>-+<tr><td>unmask</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether the grant allows unmasking sensitive data. </p></td></tr>-+<tr><td>reason</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>requested_duration</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>@@ -1651,16 +1651,16 @@ Format: instances/{instance}/databases/{database} </p></td>Stored when the user provides a TTL instead of an absolute expire_time.The server computes expire_time from this value at activation time. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.store.AccessGrant.Status">AccessGrant.Status</h3><p></p><table class="enum-table">@@ -1668,87 +1668,87 @@ The server computes expire_time from this value at activation time. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>STATUS_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>PENDING</td><td>1</td><td><p></p></td></tr>-+<tr><td>ACTIVE</td><td>2</td><td><p></p></td></tr>-+<tr><td>REVOKED</td><td>3</td><td><p></p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="store/common.proto">store/common.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.PageToken">PageToken</h3><p>PageToken is used internally for obfuscating pagination tokens.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>limit</td><td><a href="#int32">int32</a></td><td></td><td><p>Maximum number of items to return. </p></td></tr>-+<tr><td>offset</td><td><a href="#int32">int32</a></td><td></td><td><p>Number of items to skip before starting to return results. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.Position">Position</h3><p>Position in a text expressed as one-based line and one-based column.</p><p>We use 1-based numbering to match the majority of industry standards:</p><p>- Monaco Editor uses 1-based (https://microsoft.github.io/monaco-editor/typedoc/interfaces/IPosition.html)</p><p>- GitHub Actions uses 1-based (https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-error-message)</p><p>- Most text editors display 1-based positions to users</p><p>Note: LSP uses 0-based (https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#position),</p><p>but we follow the canonical user-facing standards.</p><p>Handling unknown positions:</p><p>- If the entire position is unknown, leave this field as nil/undefined</p><p>- If only line is known, set line and leave column as 0 (e.g., line=5, column=0)</p><p>- If only column is known (rare), set column and leave line as 0</p><p>Frontends should check for nil/undefined/zero values and handle them appropriately.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>line</td><td><a href="#int32">int32</a></td>@@ -1757,7 +1757,7 @@ The server computes expire_time from this value at activation time. </p></td>First line of the text is line 1.A value of 0 indicates the line information is unknown. </p></td></tr>-+<tr><td>column</td><td><a href="#int32">int32</a></td>@@ -1772,47 +1772,47 @@ Examples:- "SELECT 你好 FROM t" - column 8 is '你' (even though it's at byte offset 7)- "SELECT 😀 FROM t" - column 8 is '😀' (even though it's 4 bytes in UTF-8) </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.Range">Range</h3><p>Range represents a span within a text or sequence.</p><p>Whether the indices are byte offsets or character indices depends on the context.</p><p>Check the documentation of the field using Range for specific semantics.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>start</td><td><a href="#int32">int32</a></td><td></td><td><p>Start index (inclusive). </p></td></tr>-+<tr><td>end</td><td><a href="#int32">int32</a></td><td></td><td><p>End index (exclusive). </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.store.Engine">Engine</h3><p>Engine represents the type of database system.</p><table class="enum-table">@@ -1820,166 +1820,166 @@ Examples:<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>ENGINE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>CLICKHOUSE</td><td>1</td><td><p></p></td></tr>-+<tr><td>MYSQL</td><td>2</td><td><p></p></td></tr>-+<tr><td>POSTGRES</td><td>3</td><td><p></p></td></tr>-+<tr><td>SNOWFLAKE</td><td>4</td><td><p></p></td></tr>-+<tr><td>SQLITE</td><td>5</td><td><p></p></td></tr>-+<tr><td>TIDB</td><td>6</td><td><p></p></td></tr>-+<tr><td>MONGODB</td><td>7</td><td><p></p></td></tr>-+<tr><td>REDIS</td><td>8</td><td><p></p></td></tr>-+<tr><td>ORACLE</td><td>9</td><td><p></p></td></tr>-+<tr><td>SPANNER</td><td>10</td><td><p></p></td></tr>-+<tr><td>MSSQL</td><td>11</td><td><p></p></td></tr>-+<tr><td>REDSHIFT</td><td>12</td><td><p></p></td></tr>-+<tr><td>MARIADB</td><td>13</td><td><p></p></td></tr>-+<tr><td>OCEANBASE</td><td>14</td><td><p></p></td></tr>-+<tr><td>STARROCKS</td><td>15</td><td><p></p></td></tr>-+<tr><td>DORIS</td><td>16</td><td><p></p></td></tr>-+<tr><td>HIVE</td><td>17</td><td><p></p></td></tr>-+<tr><td>ELASTICSEARCH</td><td>18</td><td><p></p></td></tr>-+<tr><td>BIGQUERY</td><td>19</td><td><p></p></td></tr>-+<tr><td>DYNAMODB</td><td>20</td><td><p></p></td></tr>-+<tr><td>DATABRICKS</td><td>21</td><td><p></p></td></tr>-+<tr><td>COCKROACHDB</td><td>22</td><td><p></p></td></tr>-+<tr><td>COSMOSDB</td><td>23</td><td><p></p></td></tr>-+<tr><td>TRINO</td><td>24</td><td><p></p></td></tr>-+<tr><td>CASSANDRA</td><td>25</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.ExportFormat">ExportFormat</h3><p>ExportFormat represents the file format for exported data.</p><table class="enum-table">@@ -1987,40 +1987,40 @@ Examples:<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>FORMAT_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>CSV</td><td>1</td><td><p></p></td></tr>-+<tr><td>JSON</td><td>2</td><td><p></p></td></tr>-+<tr><td>SQL</td><td>3</td><td><p></p></td></tr>-+<tr><td>XLSX</td><td>4</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.RiskLevel">RiskLevel</h3><p>RiskLevel represents the assessed risk level of a database operation.</p><table class="enum-table">@@ -2028,34 +2028,34 @@ Examples:<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>RISK_LEVEL_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>LOW</td><td>1</td><td><p></p></td></tr>-+<tr><td>MODERATE</td><td>2</td><td><p></p></td></tr>-+<tr><td>HIGH</td><td>3</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.SchemaChangeType">SchemaChangeType</h3><p>SchemaChangeType represents the strategy for schema changes.</p><table class="enum-table">@@ -2063,28 +2063,28 @@ Examples:<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>SCHEMA_CHANGE_TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>VERSIONED</td><td>1</td><td><p>Versioned migration with explicit migration scripts.</p></td></tr>-+<tr><td>DECLARATIVE</td><td>2</td><td><p>Declarative schema definition (state-based).</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.StatementType">StatementType</h3><p>StatementType represents the type of SQL statement.</p><table class="enum-table">@@ -2092,256 +2092,256 @@ Examples:<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>STATEMENT_TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>CREATE_DATABASE</td><td>1</td><td><p>DDL - CREATE statements</p></td></tr>-+<tr><td>CREATE_TABLE</td><td>2</td><td><p></p></td></tr>-+<tr><td>CREATE_VIEW</td><td>3</td><td><p></p></td></tr>-+<tr><td>CREATE_INDEX</td><td>4</td><td><p></p></td></tr>-+<tr><td>CREATE_SEQUENCE</td><td>5</td><td><p></p></td></tr>-+<tr><td>CREATE_SCHEMA</td><td>6</td><td><p></p></td></tr>-+<tr><td>CREATE_FUNCTION</td><td>7</td><td><p></p></td></tr>-+<tr><td>CREATE_TRIGGER</td><td>8</td><td><p></p></td></tr>-+<tr><td>CREATE_PROCEDURE</td><td>9</td><td><p></p></td></tr>-+<tr><td>CREATE_EVENT</td><td>10</td><td><p></p></td></tr>-+<tr><td>CREATE_EXTENSION</td><td>11</td><td><p></p></td></tr>-+<tr><td>CREATE_TYPE</td><td>12</td><td><p></p></td></tr>-+<tr><td>DROP_DATABASE</td><td>20</td><td><p>DDL - DROP statements</p></td></tr>-+<tr><td>DROP_TABLE</td><td>21</td><td><p></p></td></tr>-+<tr><td>DROP_VIEW</td><td>22</td><td><p></p></td></tr>-+<tr><td>DROP_INDEX</td><td>23</td><td><p></p></td></tr>-+<tr><td>DROP_SEQUENCE</td><td>24</td><td><p></p></td></tr>-+<tr><td>DROP_SCHEMA</td><td>25</td><td><p></p></td></tr>-+<tr><td>DROP_FUNCTION</td><td>26</td><td><p></p></td></tr>-+<tr><td>DROP_TRIGGER</td><td>27</td><td><p></p></td></tr>-+<tr><td>DROP_PROCEDURE</td><td>28</td><td><p></p></td></tr>-+<tr><td>DROP_EVENT</td><td>29</td><td><p></p></td></tr>-+<tr><td>DROP_EXTENSION</td><td>30</td><td><p></p></td></tr>-+<tr><td>DROP_TYPE</td><td>31</td><td><p></p></td></tr>-+<tr><td>ALTER_DATABASE</td><td>40</td><td><p>DDL - ALTER statements</p></td></tr>-+<tr><td>ALTER_TABLE</td><td>41</td><td><p></p></td></tr>-+<tr><td>ALTER_VIEW</td><td>42</td><td><p></p></td></tr>-+<tr><td>ALTER_SEQUENCE</td><td>43</td><td><p></p></td></tr>-+<tr><td>ALTER_EVENT</td><td>44</td><td><p></p></td></tr>-+<tr><td>ALTER_TYPE</td><td>45</td><td><p></p></td></tr>-+<tr><td>ALTER_INDEX</td><td>46</td><td><p></p></td></tr>-+<tr><td>TRUNCATE</td><td>50</td><td><p>DDL - Other</p></td></tr>-+<tr><td>RENAME</td><td>51</td><td><p></p></td></tr>-+<tr><td>RENAME_INDEX</td><td>52</td><td><p></p></td></tr>-+<tr><td>RENAME_SCHEMA</td><td>53</td><td><p></p></td></tr>-+<tr><td>RENAME_SEQUENCE</td><td>54</td><td><p></p></td></tr>-+<tr><td>COMMENT</td><td>55</td><td><p></p></td></tr>-+<tr><td>INSERT</td><td>60</td><td><p>DML statements</p></td></tr>-+<tr><td>UPDATE</td><td>61</td><td><p></p></td></tr>-+<tr><td>DELETE</td><td>62</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.VCSType">VCSType</h3><p>VCSType represents the type of version control system.</p><table class="enum-table">@@ -2349,40 +2349,40 @@ Examples:<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>VCS_TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>GITHUB</td><td>1</td><td><p></p></td></tr>-+<tr><td>GITLAB</td><td>2</td><td><p></p></td></tr>-+<tr><td>BITBUCKET</td><td>3</td><td><p></p></td></tr>-+<tr><td>AZURE_DEVOPS</td><td>4</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.WebhookType">WebhookType</h3><p></p><table class="enum-table">@@ -2390,108 +2390,108 @@ Examples:<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>WEBHOOK_TYPE_UNSPECIFIED</td><td>0</td><td><p>Unspecified type.</p></td></tr>-+<tr><td>SLACK</td><td>1</td><td><p>Slack integration.</p></td></tr>-+<tr><td>DISCORD</td><td>2</td><td><p>Discord integration.</p></td></tr>-+<tr><td>TEAMS</td><td>3</td><td><p>Microsoft Teams integration.</p></td></tr>-+<tr><td>DINGTALK</td><td>4</td><td><p>DingTalk integration.</p></td></tr>-+<tr><td>FEISHU</td><td>5</td><td><p>Feishu integration.</p></td></tr>-+<tr><td>WECOM</td><td>6</td><td><p>WeCom (WeChat Work) integration.</p></td></tr>-+<tr><td>LARK</td><td>7</td><td><p>Lark integration.</p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="store/advice.proto">store/advice.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.Advice">Advice</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>status</td><td><a href="#bytebase.store.Advice.Status">Advice.Status</a></td><td></td><td><p>The advice status. </p></td></tr>-+<tr><td>code</td><td><a href="#int32">int32</a></td><td></td><td><p>The advice code. </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>The advice title. </p></td></tr>-+<tr><td>content</td><td><a href="#string">string</a></td><td></td><td><p>The advice content. </p></td></tr>-+<tr><td>start_position</td><td><a href="#bytebase.store.Position">Position</a></td>@@ -2499,23 +2499,23 @@ Examples:<td><p>The start_position is inclusive and the end_position is exclusive.TODO: use range instead. </p></td></tr>-+<tr><td>end_position</td><td><a href="#bytebase.store.Position">Position</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.store.Advice.Status">Advice.Status</h3><p>Status represents the result status of the advice.</p><table class="enum-table">@@ -2523,132 +2523,132 @@ TODO: use range instead. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>STATUS_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>SUCCESS</td><td>1</td><td><p></p></td></tr>-+<tr><td>WARNING</td><td>2</td><td><p></p></td></tr>-+<tr><td>ERROR</td><td>3</td><td><p></p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="store/approval.proto">store/approval.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.ApprovalFlow">ApprovalFlow</h3><p>ApprovalFlow defines the sequence of approvals required.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>roles</td><td><a href="#string">string</a></td><td>repeated</td><td><p>List of role names that must approve, in order. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.ApprovalTemplate">ApprovalTemplate</h3><p>ApprovalTemplate defines the approval workflow and requirements for an issue.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>flow</td><td><a href="#bytebase.store.ApprovalFlow">ApprovalFlow</a></td><td></td><td><p>The approval workflow specification. </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>Human-readable title of the approval template. </p></td></tr>-+<tr><td>description</td><td><a href="#string">string</a></td><td></td><td><p>Detailed description of when this template applies. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.IssuePayloadApproval">IssuePayloadApproval</h3><p>IssuePayloadApproval records the approval template used and approval history for an issue.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>approval_template</td><td><a href="#bytebase.store.ApprovalTemplate">ApprovalTemplate</a></td><td></td><td><p>The approval template being used for this issue. </p></td></tr>-+<tr><td>approvers</td><td><a href="#bytebase.store.IssuePayloadApproval.Approver">IssuePayloadApproval.Approver</a></td><td>repeated</td><td><p>List of approvers and their current status. </p></td></tr>-+<tr><td>approval_finding_done</td><td><a href="#bool">bool</a></td>@@ -2656,31 +2656,31 @@ TODO: use range instead. </p></td><td><p>Whether the system has finished finding a matching approval template.False means the backend is still searching for matching templates. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.IssuePayloadApproval.Approver">IssuePayloadApproval.Approver</h3><p>Approver represents a user who can approve or reject an issue.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>status</td><td><a href="#bytebase.store.IssuePayloadApproval.Approver.Status">IssuePayloadApproval.Approver.Status</a></td><td></td><td><p>The current approval status. </p></td></tr>-+<tr><td>principal</td><td><a href="#string">string</a></td>@@ -2688,16 +2688,16 @@ False means the backend is still searching for matching templates. </p></td><td><p>The principal who is the approver.Format: users/{email}. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.store.IssuePayloadApproval.Approver.Status">IssuePayloadApproval.Approver.Status</h3><p>Status represents the approver's decision state.</p><table class="enum-table">@@ -2705,56 +2705,56 @@ Format: users/{email}. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>STATUS_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>PENDING</td><td>1</td><td><p>Approval is pending from this approver.</p></td></tr>-+<tr><td>APPROVED</td><td>2</td><td><p>Approver has approved the issue.</p></td></tr>-+<tr><td>REJECTED</td><td>3</td><td><p>Approver has rejected the issue.</p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="store/audit_log.proto">store/audit_log.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.AuditLog">AuditLog</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -2764,14 +2764,14 @@ Formats:- projects/{project}- workspaces/{workspace} </p></td></tr>-+<tr><td>method</td><td><a href="#string">string</a></td><td></td><td><p>Example: /bytebase.v1.SQLService/Query </p></td></tr>-+<tr><td>resource</td><td><a href="#string">string</a></td>@@ -2779,28 +2779,28 @@ Formats:<td><p>The resource name.Example: projects/{project} </p></td></tr>-+<tr><td>user</td><td><a href="#string">string</a></td><td></td><td><p>Format: users/{email}. </p></td></tr>-+<tr><td>severity</td><td><a href="#bytebase.store.AuditLog.Severity">AuditLog.Severity</a></td><td></td><td><p> </p></td></tr>-+<tr><td>request</td><td><a href="#string">string</a></td><td></td><td><p>Marshalled request. </p></td></tr>-+<tr><td>response</td><td><a href="#string">string</a></td>@@ -2808,59 +2808,59 @@ Example: projects/{project} </p></td><td><p>Marshalled response.Some fields are omitted because 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></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></tr>-+<tr><td>service_data</td><td><a href="#google.protobuf.Any">google.protobuf.Any</a></td><td></td><td><p>The service-specific data about the request, response, and other activities. </p></td></tr>-+<tr><td>request_metadata</td><td><a href="#bytebase.store.RequestMetadata">RequestMetadata</a></td><td></td><td><p>Metadata about the operation. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.RequestMetadata">RequestMetadata</h3><p>Metadata about the request.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>caller_ip</td><td><a href="#string">string</a></td><td></td><td><p>The IP address of the caller. </p></td></tr>-+<tr><td>caller_supplied_user_agent</td><td><a href="#string">string</a></td>@@ -2868,16 +2868,16 @@ Some fields are omitted because they are too large or contain sensitive informat<td><p>The user agent of the caller.This information is not authenticated and should be treated accordingly. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.store.AuditLog.Severity">AuditLog.Severity</h3><p></p><table class="enum-table">@@ -2885,78 +2885,78 @@ This information is not authenticated and should be treated accordingly. </p></t<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>SEVERITY_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>DEBUG</td><td>1</td><td><p></p></td></tr>-+<tr><td>INFO</td><td>2</td><td><p></p></td></tr>-+<tr><td>NOTICE</td><td>3</td><td><p></p></td></tr>-+<tr><td>WARNING</td><td>4</td><td><p></p></td></tr>-+<tr><td>ERROR</td><td>5</td><td><p></p></td></tr>-+<tr><td>CRITICAL</td><td>6</td><td><p></p></td></tr>-+<tr><td>ALERT</td><td>7</td><td><p></p></td></tr>-+<tr><td>EMERGENCY</td><td>8</td><td><p></p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="store/auth.proto">store/auth.proto</h2><a href="#title">Top</a></div><p></p>--++<h3 id="bytebase.store.EmailVerificationCodePurpose">EmailVerificationCodePurpose</h3><p>EmailVerificationCodePurpose distinguishes login codes from password reset codes.</p><p>Stored as the enum name string in email_verification_code.purpose column.</p><table class="enum-table">@@ -2964,275 +2964,275 @@ This information is not authenticated and should be treated accordingly. </p></t<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>EMAIL_VERIFICATION_CODE_PURPOSE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>LOGIN</td><td>1</td><td><p></p></td></tr>-+<tr><td>PASSWORD_RESET</td><td>2</td><td><p></p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="store/changelog.proto">store/changelog.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.ChangelogPayload">ChangelogPayload</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>task_run</td><td><a href="#string">string</a></td><td></td><td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td></tr>-+<tr><td>git_commit</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>--------++++++++<div class="file-heading"><h2 id="store/database.proto">store/database.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.BoundingBox">BoundingBox</h3><p>BoundingBox defines the bounding box for spatial indexes.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>xmin</td><td><a href="#double">double</a></td><td></td><td><p> </p></td></tr>-+<tr><td>ymin</td><td><a href="#double">double</a></td><td></td><td><p> </p></td></tr>-+<tr><td>xmax</td><td><a href="#double">double</a></td><td></td><td><p> </p></td></tr>-+<tr><td>ymax</td><td><a href="#double">double</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.CheckConstraintMetadata">CheckConstraintMetadata</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the check constraint. </p></td></tr>-+<tr><td>expression</td><td><a href="#string">string</a></td><td></td><td><p>The expression is the expression of a check constraint. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.ColumnCatalog">ColumnCatalog</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the column. </p></td></tr>-+<tr><td>semantic_type</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>labels</td><td><a href="#bytebase.store.ColumnCatalog.LabelsEntry">ColumnCatalog.LabelsEntry</a></td><td>repeated</td><td><p>The user labels for a column. </p></td></tr>-+<tr><td>classification</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>object_schema</td><td><a href="#bytebase.store.ObjectSchema">ObjectSchema</a></td><td>optional</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.ColumnCatalog.LabelsEntry">ColumnCatalog.LabelsEntry</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.ColumnMetadata">ColumnMetadata</h3><p>ColumnMetadata is the metadata for columns.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the column. </p></td></tr>-+<tr><td>position</td><td><a href="#int32">int32</a></td><td></td><td><p>The position is the position in columns. </p></td></tr>-+<tr><td>default</td><td><a href="#string">string</a></td><td></td><td><p>The default value of the column. </p></td></tr>-+<tr><td>default_on_null</td><td><a href="#bool">bool</a></td>@@ -3240,7 +3240,7 @@ This information is not authenticated and should be treated accordingly. </p></t<td><p>Oracle specific metadata.The default_on_null is the default on null of a column. </p></td></tr>-+<tr><td>on_update</td><td><a href="#string">string</a></td>@@ -3249,77 +3249,77 @@ The default_on_null is the default on null of a column. </p></td>For MySQL like databases, it's only supported for TIMESTAMP columns withCURRENT_TIMESTAMP as on update value. </p></td></tr>-+<tr><td>nullable</td><td><a href="#bool">bool</a></td><td></td><td><p>The nullable is the nullable of a column. </p></td></tr>-+<tr><td>type</td><td><a href="#string">string</a></td><td></td><td><p>The type is the type of a column. </p></td></tr>-+<tr><td>character_set</td><td><a href="#string">string</a></td><td></td><td><p>The character_set is the character_set of a column. </p></td></tr>-+<tr><td>collation</td><td><a href="#string">string</a></td><td></td><td><p>The collation is the collation of a column. </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment is the comment of a column. </p></td></tr>-+<tr><td>generation</td><td><a href="#bytebase.store.GenerationMetadata">GenerationMetadata</a></td><td></td><td><p>The generation is for generated columns. </p></td></tr>-+<tr><td>is_identity</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>identity_generation</td><td><a href="#bytebase.store.ColumnMetadata.IdentityGeneration">ColumnMetadata.IdentityGeneration</a></td><td></td><td><p>The identity_generation is for identity columns, PG only. </p></td></tr>-+<tr><td>identity_seed</td><td><a href="#int64">int64</a></td><td></td><td><p>The identity_seed is for identity columns, MSSQL only. </p></td></tr>-+<tr><td>identity_increment</td><td><a href="#int64">int64</a></td><td></td><td><p>The identity_increment is for identity columns, MSSQL only. </p></td></tr>-+<tr><td>default_constraint_name</td><td><a href="#string">string</a></td>@@ -3345,83 +3345,83 @@ To modify the default, you must first drop the existing constraint by name:This field is populated when syncing from the database. When empty (e.g., when parsingfrom SQL files), the system cannot automatically drop the constraint. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.DatabaseConfig">DatabaseConfig</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>schemas</td><td><a href="#bytebase.store.SchemaCatalog">SchemaCatalog</a></td><td>repeated</td><td><p>The schema_configs is the list of configs for schemas in a database. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.DatabaseMetadata">DatabaseMetadata</h3><p>DatabaseMetadata is the metadata for databases.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>labels</td><td><a href="#bytebase.store.DatabaseMetadata.LabelsEntry">DatabaseMetadata.LabelsEntry</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>last_sync_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>backup_available</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>datashare</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>release</td><td><a href="#string">string</a></td>@@ -3429,139 +3429,139 @@ from SQL files), the system cannot automatically drop the constraint. </p></td><td><p>The release that was last applied to this database.Format: projects/{project}/releases/{release_id} </p></td></tr>-+<tr><td>sync_status</td><td><a href="#bytebase.store.SyncStatus">SyncStatus</a></td><td></td><td><p>The sync status of the database. </p></td></tr>-+<tr><td>sync_error</td><td><a href="#string">string</a></td><td></td><td><p>The error message if sync failed. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.DatabaseMetadata.LabelsEntry">DatabaseMetadata.LabelsEntry</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.DatabaseSchemaMetadata">DatabaseSchemaMetadata</h3><p>DatabaseSchemaMetadata is the schema metadata for databases.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>schemas</td><td><a href="#bytebase.store.SchemaMetadata">SchemaMetadata</a></td><td>repeated</td><td><p>The list of schemas in a database. </p></td></tr>-+<tr><td>character_set</td><td><a href="#string">string</a></td><td></td><td><p>The character set of the database. </p></td></tr>-+<tr><td>collation</td><td><a href="#string">string</a></td><td></td><td><p>The collation of the database. </p></td></tr>-+<tr><td>extensions</td><td><a href="#bytebase.store.ExtensionMetadata">ExtensionMetadata</a></td><td>repeated</td><td><p>The list of extensions in a database. </p></td></tr>-+<tr><td>datashare</td><td><a href="#bool">bool</a></td><td></td><td><p>The database belongs to a datashare. </p></td></tr>-+<tr><td>service_name</td><td><a href="#string">string</a></td><td></td><td><p>The service name of the database. It's an Oracle-specific concept. </p></td></tr>-+<tr><td>linked_databases</td><td><a href="#bytebase.store.LinkedDatabaseMetadata">LinkedDatabaseMetadata</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>owner</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>search_path</td><td><a href="#string">string</a></td><td></td><td><p>The search_path is the search path of a PostgreSQL database. </p></td></tr>-+<tr><td>event_triggers</td><td><a href="#bytebase.store.EventTriggerMetadata">EventTriggerMetadata</a></td>@@ -3569,100 +3569,100 @@ Format: projects/{project}/releases/{release_id} </p></td><td><p>The list of event triggers in a database (PostgreSQL specific).Event triggers are database-level objects, not schema-scoped. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.DependencyColumn">DependencyColumn</h3><p>DependencyColumn is the metadata for dependency columns.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>schema</td><td><a href="#string">string</a></td><td></td><td><p>The schema is the schema of a reference column. </p></td></tr>-+<tr><td>table</td><td><a href="#string">string</a></td><td></td><td><p>The table is the table of a reference column. </p></td></tr>-+<tr><td>column</td><td><a href="#string">string</a></td><td></td><td><p>The column is the name of a reference column. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.DependencyTable">DependencyTable</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>schema</td><td><a href="#string">string</a></td><td></td><td><p>The schema is the schema of a reference table. </p></td></tr>-+<tr><td>table</td><td><a href="#string">string</a></td><td></td><td><p>The table is the name of a reference table. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.DimensionalConfig">DimensionalConfig</h3><p>DimensionalConfig defines dimensional and constraint parameters for spatial indexes.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>dimensions</td><td><a href="#int32">int32</a></td><td></td><td><p>Number of dimensions (2-4, default 2) </p></td></tr>-+<tr><td>data_type</td><td><a href="#string">string</a></td>@@ -3670,7 +3670,7 @@ Event triggers are database-level objects, not schema-scoped. </p></td><td><p>Spatial data typeExamples: GEOMETRY, GEOGRAPHY, POINT, POLYGON, etc. </p></td></tr>-+<tr><td>operator_class</td><td><a href="#string">string</a></td>@@ -3678,7 +3678,7 @@ Examples: GEOMETRY, GEOGRAPHY, POINT, POLYGON, etc. </p></td><td><p>PostgreSQL operator classExamples: gist_geometry_ops_2d, gist_geometry_ops_nd, etc. </p></td></tr>-+<tr><td>layer_gtype</td><td><a href="#string">string</a></td>@@ -3686,184 +3686,184 @@ Examples: gist_geometry_ops_2d, gist_geometry_ops_nd, etc. </p></td><td><p>Oracle geometry type constraintExamples: POINT, LINE, POLYGON, COLLECTION </p></td></tr>-+<tr><td>parallel_build</td><td><a href="#bool">bool</a></td><td></td><td><p>Parallel index creation </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.EnumTypeMetadata">EnumTypeMetadata</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the enum type. </p></td></tr>-+<tr><td>values</td><td><a href="#string">string</a></td><td>repeated</td><td><p>The enum values of the type. </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.EventMetadata">EventMetadata</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the event. </p></td></tr>-+<tr><td>definition</td><td><a href="#string">string</a></td><td></td><td><p>The schedule of the event. </p></td></tr>-+<tr><td>time_zone</td><td><a href="#string">string</a></td><td></td><td><p>The time zone of the event. </p></td></tr>-+<tr><td>sql_mode</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>character_set_client</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>collation_connection</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.EventTriggerMetadata">EventTriggerMetadata</h3><p>EventTriggerMetadata is the metadata for PostgreSQL event triggers.</p><p>Event triggers are database-level objects that fire on DDL events.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the event trigger. </p></td></tr>-+<tr><td>event</td><td><a href="#string">string</a></td><td></td><td><p>The event type: DDL_COMMAND_START, DDL_COMMAND_END, SQL_DROP, TABLE_REWRITE. </p></td></tr>-+<tr><td>tags</td><td><a href="#string">string</a></td><td>repeated</td><td><p>The tags filter (e.g., ['CREATE TABLE', 'DROP TABLE']). </p></td></tr>-+<tr><td>function_schema</td><td><a href="#string">string</a></td><td></td><td><p>The schema of the function to execute. </p></td></tr>-+<tr><td>function_name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the function to execute. </p></td></tr>-+<tr><td>enabled</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether the trigger is enabled. </p></td></tr>-+<tr><td>definition</td><td><a href="#string">string</a></td>@@ -3871,45 +3871,45 @@ Examples: POINT, LINE, POLYGON, COLLECTION </p></td><td><p>The full CREATE EVENT TRIGGER definition from pg_get_event_trigger_def().SDL output should prefer using this field. </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment on the event trigger. </p></td></tr>-+<tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td><td><p>Skip dump flag (for extension-owned triggers). </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.ExcludeConstraintMetadata">ExcludeConstraintMetadata</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the EXCLUDE constraint. </p></td></tr>-+<tr><td>expression</td><td><a href="#string">string</a></td>@@ -3917,31 +3917,31 @@ SDL output should prefer using this field. </p></td><td><p>The expression is the full EXCLUDE constraint definition including "EXCLUDE" keyword.Example: "EXCLUDE USING gist (room_id WITH =, during WITH &&)" </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.ExtensionMetadata">ExtensionMetadata</h3><p>ExtensionMetadata is the metadata for extensions.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the extension. </p></td></tr>-+<tr><td>schema</td><td><a href="#string">string</a></td>@@ -3949,97 +3949,97 @@ Example: "EXCLUDE USING gist (room_id WITH =, during WITH &&)" <<td><p>The schema where the extension is installed. However, the extension usageis not limited to the schema. </p></td></tr>-+<tr><td>version</td><td><a href="#string">string</a></td><td></td><td><p>The version is the version of an extension. </p></td></tr>-+<tr><td>description</td><td><a href="#string">string</a></td><td></td><td><p>The description is the description of an extension. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.ExternalTableMetadata">ExternalTableMetadata</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the external table. </p></td></tr>-+<tr><td>external_server_name</td><td><a href="#string">string</a></td><td></td><td><p>The external_server_name is the name of the external server. </p></td></tr>-+<tr><td>external_database_name</td><td><a href="#string">string</a></td><td></td><td><p>The external_database_name is the name of the external database. </p></td></tr>-+<tr><td>columns</td><td><a href="#bytebase.store.ColumnMetadata">ColumnMetadata</a></td><td>repeated</td><td><p>The columns is the ordered list of columns in a foreign table. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.ForeignKeyMetadata">ForeignKeyMetadata</h3><p>ForeignKeyMetadata is the metadata for foreign keys.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the foreign key. </p></td></tr>-+<tr><td>columns</td><td><a href="#string">string</a></td><td>repeated</td><td><p>The columns are the ordered referencing columns of a foreign key. </p></td></tr>-+<tr><td>referenced_schema</td><td><a href="#string">string</a></td>@@ -4047,35 +4047,35 @@ is not limited to the schema. </p></td><td><p>The referenced_schema is the referenced schema name of a foreign key.It is an empty string for databases without such concept such as MySQL. </p></td></tr>-+<tr><td>referenced_table</td><td><a href="#string">string</a></td><td></td><td><p>The referenced_table is the referenced table name of a foreign key. </p></td></tr>-+<tr><td>referenced_columns</td><td><a href="#string">string</a></td><td>repeated</td><td><p>The referenced_columns are the ordered referenced columns of a foreign key. </p></td></tr>-+<tr><td>on_delete</td><td><a href="#string">string</a></td><td></td><td><p>The on_delete is the on delete action of a foreign key. </p></td></tr>-+<tr><td>on_update</td><td><a href="#string">string</a></td><td></td><td><p>The on_update is the on update action of a foreign key. </p></td></tr>-+<tr><td>match_type</td><td><a href="#string">string</a></td>@@ -4084,38 +4084,38 @@ It is an empty string for databases without such concept such as MySQL. </p></tdThe match_type is the PostgreSQL specific field.It's empty string for other databases. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.FunctionMetadata">FunctionMetadata</h3><p>FunctionMetadata is the metadata for functions.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the function. </p></td></tr>-+<tr><td>definition</td><td><a href="#string">string</a></td><td></td><td><p>The definition is the definition of a function. </p></td></tr>-+<tr><td>signature</td><td><a href="#string">string</a></td>@@ -4123,42 +4123,42 @@ It's empty string for other databases. </p></td><td><p>The signature is the name with the number and type of input arguments thefunction takes. </p></td></tr>-+<tr><td>character_set_client</td><td><a href="#string">string</a></td><td></td><td><p>MySQL specific metadata. </p></td></tr>-+<tr><td>collation_connection</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>database_collation</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>sql_mode</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>dependency_tables</td><td><a href="#bytebase.store.DependencyTable">DependencyTable</a></td>@@ -4166,100 +4166,100 @@ function takes. </p></td><td><p>The dependency_tables is the list of dependency tables of a function.For PostgreSQL, it's the list of tables that the function depends on the return type definition. </p></td></tr>-+<tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.GenerationMetadata">GenerationMetadata</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>type</td><td><a href="#bytebase.store.GenerationMetadata.Type">GenerationMetadata.Type</a></td><td></td><td><p> </p></td></tr>-+<tr><td>expression</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.GridLevel">GridLevel</h3><p>GridLevel defines a grid level for spatial tessellation.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>level</td><td><a href="#int32">int32</a></td><td></td><td><p>1-4 for SQL Server </p></td></tr>-+<tr><td>density</td><td><a href="#string">string</a></td><td></td><td><p>LOW, MEDIUM, HIGH </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.IndexMetadata">IndexMetadata</h3><p>IndexMetadata is the metadata for indexes.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the index. </p></td></tr>-+<tr><td>expressions</td><td><a href="#string">string</a></td>@@ -4273,7 +4273,7 @@ pg_get_indexdef(oid, col, true) — the tightest `index_elem` grammar form:- expression key: parenthesized a_expr e.g. "(payload ->> 'k'::text)"The DDL emitter writes entries verbatim into the CREATE INDEX key list. </p></td></tr>-+<tr><td>key_length</td><td><a href="#int64">int64</a></td>@@ -4281,77 +4281,77 @@ The DDL emitter writes entries verbatim into the CREATE INDEX key list. </p></td<td><p>The ordered list of key lengths for the index.If the key length is not specified, it is -1. </p></td></tr>-+<tr><td>descending</td><td><a href="#bool">bool</a></td><td>repeated</td><td><p>The ordered list of descending flags for the index columns. </p></td></tr>-+<tr><td>type</td><td><a href="#string">string</a></td><td></td><td><p>The type is the type of an index. </p></td></tr>-+<tr><td>unique</td><td><a href="#bool">bool</a></td><td></td><td><p>The unique is whether the index is unique. </p></td></tr>-+<tr><td>primary</td><td><a href="#bool">bool</a></td><td></td><td><p>The primary is whether the index is a primary key index. </p></td></tr>-+<tr><td>visible</td><td><a href="#bool">bool</a></td><td></td><td><p>The visible is whether the index is visible. </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment is the comment of an index. </p></td></tr>-+<tr><td>definition</td><td><a href="#string">string</a></td><td></td><td><p>The definition of an index. </p></td></tr>-+<tr><td>parent_index_schema</td><td><a href="#string">string</a></td><td></td><td><p>The schema name of the parent index. </p></td></tr>-+<tr><td>parent_index_name</td><td><a href="#string">string</a></td><td></td><td><p>The index name of the parent index. </p></td></tr>-+<tr><td>granularity</td><td><a href="#int64">int64</a></td><td></td><td><p>The number of granules in the block. It's a ClickHouse specific field. </p></td></tr>-+<tr><td>is_constraint</td><td><a href="#bool">bool</a></td>@@ -4359,14 +4359,14 @@ If the key length is not specified, it is -1. </p></td><td><p>It's a PostgreSQL specific field.The unique constraint and unique index are not the same thing in PostgreSQL. </p></td></tr>-+<tr><td>spatial_config</td><td><a href="#bytebase.store.SpatialIndexConfig">SpatialIndexConfig</a></td><td></td><td><p>Spatial index specific configuration </p></td></tr>-+<tr><td>opclass_names</td><td><a href="#string">string</a></td>@@ -4374,38 +4374,38 @@ The unique constraint and unique index are not the same thing in PostgreSQL. </p<td><p>https://www.postgresql.org/docs/current/catalog-pg-opclass.htmlName of the operator class for each column. (PostgreSQL specific). </p></td></tr>-+<tr><td>opclass_defaults</td><td><a href="#bool">bool</a></td><td>repeated</td><td><p>True if the operator class is the default. (PostgreSQL specific). </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.InstanceRoleMetadata">InstanceRoleMetadata</h3><p>InstanceRoleMetadata is the message for instance role.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The role name. It's unique within the instance. </p></td></tr>-+<tr><td>grant</td><td><a href="#string">string</a></td>@@ -4413,297 +4413,297 @@ Name of the operator class for each column. (PostgreSQL specific). </p></td><td><p>The grant display string on the instance. It's generated by databaseengine. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.LinkedDatabaseMetadata">LinkedDatabaseMetadata</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>username</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>host</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.MaterializedViewMetadata">MaterializedViewMetadata</h3><p>MaterializedViewMetadata is the metadata for materialized views.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the materialized view. </p></td></tr>-+<tr><td>definition</td><td><a href="#string">string</a></td><td></td><td><p>The definition is the definition of a view. </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment is the comment of a view. </p></td></tr>-+<tr><td>dependency_columns</td><td><a href="#bytebase.store.DependencyColumn">DependencyColumn</a></td><td>repeated</td><td><p>The list of dependency columns of the view. </p></td></tr>-+<tr><td>triggers</td><td><a href="#bytebase.store.TriggerMetadata">TriggerMetadata</a></td><td>repeated</td><td><p>The ordered list of columns in the materialized view. </p></td></tr>-+<tr><td>indexes</td><td><a href="#bytebase.store.IndexMetadata">IndexMetadata</a></td><td>repeated</td><td><p>The list of indexes in the materialized view. </p></td></tr>-+<tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.ObjectSchema">ObjectSchema</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>type</td><td><a href="#bytebase.store.ObjectSchema.Type">ObjectSchema.Type</a></td><td></td><td><p> </p></td></tr>-+<tr><td>struct_kind</td><td><a href="#bytebase.store.ObjectSchema.StructKind">ObjectSchema.StructKind</a></td><td></td><td><p> </p></td></tr>-+<tr><td>array_kind</td><td><a href="#bytebase.store.ObjectSchema.ArrayKind">ObjectSchema.ArrayKind</a></td><td></td><td><p> </p></td></tr>-+<tr><td>semantic_type</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.ObjectSchema.ArrayKind">ObjectSchema.ArrayKind</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>kind</td><td><a href="#bytebase.store.ObjectSchema">ObjectSchema</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.ObjectSchema.StructKind">ObjectSchema.StructKind</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>properties</td><td><a href="#bytebase.store.ObjectSchema.StructKind.PropertiesEntry">ObjectSchema.StructKind.PropertiesEntry</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.ObjectSchema.StructKind.PropertiesEntry">ObjectSchema.StructKind.PropertiesEntry</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value</td><td><a href="#bytebase.store.ObjectSchema">ObjectSchema</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.PackageMetadata">PackageMetadata</h3><p>PackageMetadata is the metadata for packages.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the package. </p></td></tr>-+<tr><td>definition</td><td><a href="#string">string</a></td><td></td><td><p>The definition is the definition of a package. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.ProcedureMetadata">ProcedureMetadata</h3><p>ProcedureMetadata is the metadata for procedures.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the procedure. </p></td></tr>-+<tr><td>definition</td><td><a href="#string">string</a></td><td></td><td><p>The definition is the definition of a procedure. </p></td></tr>-+<tr><td>signature</td><td><a href="#string">string</a></td>@@ -4711,132 +4711,132 @@ engine. </p></td><td><p>The signature is the name with the number and type of input arguments thefunction takes. </p></td></tr>-+<tr><td>character_set_client</td><td><a href="#string">string</a></td><td></td><td><p>MySQL specific metadata. </p></td></tr>-+<tr><td>collation_connection</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>database_collation</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>sql_mode</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.RuleMetadata">RuleMetadata</h3><p>RuleMetadata is the metadata for PostgreSQL rules.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the rule. </p></td></tr>-+<tr><td>event</td><td><a href="#string">string</a></td><td></td><td><p>The event type of the rule: SELECT, INSERT, UPDATE, or DELETE. </p></td></tr>-+<tr><td>condition</td><td><a href="#string">string</a></td><td></td><td><p>The WHERE condition of the rule (optional). </p></td></tr>-+<tr><td>action</td><td><a href="#string">string</a></td><td></td><td><p>The command(s) to execute when the rule fires. </p></td></tr>-+<tr><td>is_instead</td><td><a href="#bool">bool</a></td><td></td><td><p>The is_instead indicates whether this is an INSTEAD rule. </p></td></tr>-+<tr><td>is_enabled</td><td><a href="#bool">bool</a></td><td></td><td><p>The is_enabled indicates whether the rule is enabled. </p></td></tr>-+<tr><td>definition</td><td><a href="#string">string</a></td><td></td><td><p>The full CREATE RULE statement. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.SchemaCatalog">SchemaCatalog</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -4844,31 +4844,31 @@ function takes. </p></td><td><p>The schema name.It is an empty string for databases without such concept such as MySQL. </p></td></tr>-+<tr><td>tables</td><td><a href="#bytebase.store.TableCatalog">TableCatalog</a></td><td>repeated</td><td><p>The table_configs is the list of configs for tables in a schema. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.SchemaMetadata">SchemaMetadata</h3><p>SchemaMetadata is the metadata for schemas.</p><p>This is the concept of schema in Postgres, but it's a no-op for MySQL.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -4876,237 +4876,237 @@ It is an empty string for databases without such concept such as MySQL. </p></td<td><p>The schema name.It is an empty string for databases without such concept such as MySQL. </p></td></tr>-+<tr><td>tables</td><td><a href="#bytebase.store.TableMetadata">TableMetadata</a></td><td>repeated</td><td><p>The list of tables in a schema. </p></td></tr>-+<tr><td>external_tables</td><td><a href="#bytebase.store.ExternalTableMetadata">ExternalTableMetadata</a></td><td>repeated</td><td><p>The list of external tables in a schema. </p></td></tr>-+<tr><td>views</td><td><a href="#bytebase.store.ViewMetadata">ViewMetadata</a></td><td>repeated</td><td><p>The list of views in a schema. </p></td></tr>-+<tr><td>functions</td><td><a href="#bytebase.store.FunctionMetadata">FunctionMetadata</a></td><td>repeated</td><td><p>The list of functions in a schema. </p></td></tr>-+<tr><td>procedures</td><td><a href="#bytebase.store.ProcedureMetadata">ProcedureMetadata</a></td><td>repeated</td><td><p>The list of procedures in a schema. </p></td></tr>-+<tr><td>streams</td><td><a href="#bytebase.store.StreamMetadata">StreamMetadata</a></td><td>repeated</td><td><p>The list of streams in a schema, currently only used for Snowflake. </p></td></tr>-+<tr><td>tasks</td><td><a href="#bytebase.store.TaskMetadata">TaskMetadata</a></td><td>repeated</td><td><p>The list of tasks in a schema, currently only used for Snowflake. </p></td></tr>-+<tr><td>materialized_views</td><td><a href="#bytebase.store.MaterializedViewMetadata">MaterializedViewMetadata</a></td><td>repeated</td><td><p>The list of materialized views in a schema. </p></td></tr>-+<tr><td>sequences</td><td><a href="#bytebase.store.SequenceMetadata">SequenceMetadata</a></td><td>repeated</td><td><p>The list of sequences in a schema. </p></td></tr>-+<tr><td>packages</td><td><a href="#bytebase.store.PackageMetadata">PackageMetadata</a></td><td>repeated</td><td><p>The list of packages in a schema. </p></td></tr>-+<tr><td>owner</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>events</td><td><a href="#bytebase.store.EventMetadata">EventMetadata</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>enum_types</td><td><a href="#bytebase.store.EnumTypeMetadata">EnumTypeMetadata</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.SequenceMetadata">SequenceMetadata</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of a sequence. </p></td></tr>-+<tr><td>data_type</td><td><a href="#string">string</a></td><td></td><td><p>The data type of a sequence. </p></td></tr>-+<tr><td>start</td><td><a href="#string">string</a></td><td></td><td><p>The start value of a sequence. </p></td></tr>-+<tr><td>min_value</td><td><a href="#string">string</a></td><td></td><td><p>The minimum value of a sequence. </p></td></tr>-+<tr><td>max_value</td><td><a href="#string">string</a></td><td></td><td><p>The maximum value of a sequence. </p></td></tr>-+<tr><td>increment</td><td><a href="#string">string</a></td><td></td><td><p>The increment value of a sequence. </p></td></tr>-+<tr><td>cycle</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether the sequence cycles. </p></td></tr>-+<tr><td>cache_size</td><td><a href="#string">string</a></td><td></td><td><p>Cache size of a sequence. </p></td></tr>-+<tr><td>last_value</td><td><a href="#string">string</a></td><td></td><td><p>The last value of a sequence. </p></td></tr>-+<tr><td>owner_table</td><td><a href="#string">string</a></td><td></td><td><p>The table that owns the sequence. </p></td></tr>-+<tr><td>owner_column</td><td><a href="#string">string</a></td><td></td><td><p>The column that owns the sequence. </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.SpatialIndexConfig">SpatialIndexConfig</h3><p>SpatialIndexConfig is the configuration for spatial indexes across different database engines.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>method</td><td><a href="#string">string</a></td>@@ -5114,83 +5114,83 @@ It is an empty string for databases without such concept such as MySQL. </p></td<td><p>Index method/type (database-specific)Examples: "SPATIAL" (MySQL/SQL Server), "GIST"/"SPGIST" (PostgreSQL), "MDSYS.SPATIAL_INDEX_V2" (Oracle) </p></td></tr>-+<tr><td>tessellation</td><td><a href="#bytebase.store.TessellationConfig">TessellationConfig</a></td><td></td><td><p>Tessellation configuration (primarily SQL Server) </p></td></tr>-+<tr><td>storage</td><td><a href="#bytebase.store.StorageConfig">StorageConfig</a></td><td></td><td><p>Storage and performance parameters </p></td></tr>-+<tr><td>dimensional</td><td><a href="#bytebase.store.DimensionalConfig">DimensionalConfig</a></td><td></td><td><p>Dimensional and constraint parameters </p></td></tr>-+<tr><td>engine_specific</td><td><a href="#bytebase.store.SpatialIndexConfig.EngineSpecificEntry">SpatialIndexConfig.EngineSpecificEntry</a></td><td>repeated</td><td><p>Database-specific parameters (stored as key-value pairs for extensibility) </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.SpatialIndexConfig.EngineSpecificEntry">SpatialIndexConfig.EngineSpecificEntry</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.StorageConfig">StorageConfig</h3><p>StorageConfig defines storage and performance parameters for spatial indexes.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>fillfactor</td><td><a href="#int32">int32</a></td>@@ -5199,345 +5199,345 @@ Examples: "SPATIAL" (MySQL/SQL Server), "GIST"/"SPGIST"10-100 </p></td></tr>-+<tr><td>buffering</td><td><a href="#string">string</a></td><td></td><td><p>auto, on, off </p></td></tr>-+<tr><td>tablespace</td><td><a href="#string">string</a></td><td></td><td><p>Oracle parameters </p></td></tr>-+<tr><td>work_tablespace</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>sdo_level</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>commit_interval</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>pad_index</td><td><a href="#bool">bool</a></td><td></td><td><p>SQL Server parameters </p></td></tr>-+<tr><td>sort_in_tempdb</td><td><a href="#string">string</a></td><td></td><td><p>ON, OFF </p></td></tr>-+<tr><td>drop_existing</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>online</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>allow_row_locks</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>allow_page_locks</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>maxdop</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>data_compression</td><td><a href="#string">string</a></td><td></td><td><p>NONE, ROW, PAGE </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.StreamMetadata">StreamMetadata</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the stream. </p></td></tr>-+<tr><td>table_name</td><td><a href="#string">string</a></td><td></td><td><p>The table_name is the name of the table/view that the stream is created on. </p></td></tr>-+<tr><td>owner</td><td><a href="#string">string</a></td><td></td><td><p>The owner of the stream. </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment of the stream. </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.store.StreamMetadata.Type">StreamMetadata.Type</a></td><td></td><td><p>The type of the stream. </p></td></tr>-+<tr><td>stale</td><td><a href="#bool">bool</a></td><td></td><td><p>Indicates whether the stream was last read before the `stale_after` time. </p></td></tr>-+<tr><td>mode</td><td><a href="#bytebase.store.StreamMetadata.Mode">StreamMetadata.Mode</a></td><td></td><td><p>The mode of the stream. </p></td></tr>-+<tr><td>definition</td><td><a href="#string">string</a></td><td></td><td><p>The definition of the stream. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.TableCatalog">TableCatalog</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the table. </p></td></tr>-+<tr><td>columns</td><td><a href="#bytebase.store.ColumnCatalog">ColumnCatalog</a></td><td>repeated</td><td><p>The column_configs is the ordered list of configs for columns in a table. </p></td></tr>-+<tr><td>object_schema</td><td><a href="#bytebase.store.ObjectSchema">ObjectSchema</a></td><td>optional</td><td><p> </p></td></tr>-+<tr><td>classification</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.TableMetadata">TableMetadata</h3><p>TableMetadata is the metadata for tables.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the table. </p></td></tr>-+<tr><td>columns</td><td><a href="#bytebase.store.ColumnMetadata">ColumnMetadata</a></td><td>repeated</td><td><p>The columns is the ordered list of columns in a table. </p></td></tr>-+<tr><td>indexes</td><td><a href="#bytebase.store.IndexMetadata">IndexMetadata</a></td><td>repeated</td><td><p>The indexes is the list of indexes in a table. </p></td></tr>-+<tr><td>engine</td><td><a href="#string">string</a></td><td></td><td><p>The engine is the engine of a table. </p></td></tr>-+<tr><td>collation</td><td><a href="#string">string</a></td><td></td><td><p>The collation is the collation of a table. </p></td></tr>-+<tr><td>charset</td><td><a href="#string">string</a></td><td></td><td><p>The character set of the table. </p></td></tr>-+<tr><td>row_count</td><td><a href="#int64">int64</a></td><td></td><td><p>The row_count is the estimated number of rows of a table. </p></td></tr>-+<tr><td>data_size</td><td><a href="#int64">int64</a></td><td></td><td><p>The data_size is the estimated data size of a table. </p></td></tr>-+<tr><td>index_size</td><td><a href="#int64">int64</a></td><td></td><td><p>The index_size is the estimated index size of a table. </p></td></tr>-+<tr><td>data_free</td><td><a href="#int64">int64</a></td><td></td><td><p>The data_free is the estimated free data size of a table. </p></td></tr>-+<tr><td>create_options</td><td><a href="#string">string</a></td><td></td><td><p>The create_options is the create option of a table. </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment is the comment of a table. </p></td></tr>-+<tr><td>foreign_keys</td><td><a href="#bytebase.store.ForeignKeyMetadata">ForeignKeyMetadata</a></td><td>repeated</td><td><p>The foreign_keys is the list of foreign keys in a table. </p></td></tr>-+<tr><td>partitions</td><td><a href="#bytebase.store.TablePartitionMetadata">TablePartitionMetadata</a></td><td>repeated</td><td><p>The partitions is the list of partitions in a table. </p></td></tr>-+<tr><td>check_constraints</td><td><a href="#bytebase.store.CheckConstraintMetadata">CheckConstraintMetadata</a></td><td>repeated</td><td><p>The check_constraints is the list of check constraints in a table. </p></td></tr>-+<tr><td>owner</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>sorting_keys</td><td><a href="#string">string</a></td>@@ -5545,35 +5545,35 @@ Examples: "SPATIAL" (MySQL/SQL Server), "GIST"/"SPGIST"<td><p>The sorting_keys is a tuple of column names or arbitrary expressions. ClickHouse specific field.Reference: https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/mergetree#order_by </p></td></tr>-+<tr><td>triggers</td><td><a href="#bytebase.store.TriggerMetadata">TriggerMetadata</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>rules</td><td><a href="#bytebase.store.RuleMetadata">RuleMetadata</a></td><td>repeated</td><td><p>The rules is the list of rules in a table (PostgreSQL specific). </p></td></tr>-+<tr><td>sharding_info</td><td><a href="#string">string</a></td><td></td><td><p>https://docs.pingcap.com/tidb/stable/information-schema-tables/ </p></td></tr>-+<tr><td>primary_key_type</td><td><a href="#string">string</a></td>@@ -5581,45 +5581,45 @@ Reference: https://clickhouse.com/docs/en/engines/table-engines/mergetree-family<td><p>https://docs.pingcap.com/tidb/stable/clustered-indexes/#clustered-indexesCLUSTERED or NONCLUSTERED. </p></td></tr>-+<tr><td>exclude_constraints</td><td><a href="#bytebase.store.ExcludeConstraintMetadata">ExcludeConstraintMetadata</a></td><td>repeated</td><td><p>The exclude_constraints is the list of EXCLUDE constraints in a table (PostgreSQL specific). </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.TablePartitionMetadata">TablePartitionMetadata</h3><p>TablePartitionMetadata is the metadata for table partitions.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the table partition. </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.store.TablePartitionMetadata.Type">TablePartitionMetadata.Type</a></td><td></td><td><p>The type of a table partition. </p></td></tr>-+<tr><td>expression</td><td><a href="#string">string</a></td>@@ -5635,7 +5635,7 @@ PARTITION BY| RANGE{(expr) | COLUMNS(column_list)}| LIST{(expr) | COLUMNS(column_list)} }. </p></td></tr>-+<tr><td>value</td><td><a href="#string">string</a></td>@@ -5649,7 +5649,7 @@ partition's VALUES IN clause, which is a list of comma-separated integervalues.- For others, it's an empty string. </p></td></tr>-+<tr><td>use_default</td><td><a href="#string">string</a></td>@@ -5659,59 +5659,59 @@ the different value for different database engines. For MySQL, it's [INT]type, 0 means not use default partition, otherwise, it's equals to numberin syntax [SUB]PARTITION {number}. </p></td></tr>-+<tr><td>subpartitions</td><td><a href="#bytebase.store.TablePartitionMetadata">TablePartitionMetadata</a></td><td>repeated</td><td><p>The subpartitions is the list of subpartitions in a table partition. </p></td></tr>-+<tr><td>indexes</td><td><a href="#bytebase.store.IndexMetadata">IndexMetadata</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>check_constraints</td><td><a href="#bytebase.store.CheckConstraintMetadata">CheckConstraintMetadata</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>exclude_constraints</td><td><a href="#bytebase.store.ExcludeConstraintMetadata">ExcludeConstraintMetadata</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.TaskMetadata">TaskMetadata</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the task. </p></td></tr>-+<tr><td>id</td><td><a href="#string">string</a></td>@@ -5719,80 +5719,80 @@ in syntax [SUB]PARTITION {number}. </p></td><td><p>The Snowflake-generated ID of the task.Example: 01ad32a0-1bb6-5e93-0000-000000000001. </p></td></tr>-+<tr><td>owner</td><td><a href="#string">string</a></td><td></td><td><p>The owner of the task. </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment of the task. </p></td></tr>-+<tr><td>warehouse</td><td><a href="#string">string</a></td><td></td><td><p>The warehouse of the task. </p></td></tr>-+<tr><td>schedule</td><td><a href="#string">string</a></td><td></td><td><p>The schedule interval of the task. </p></td></tr>-+<tr><td>predecessors</td><td><a href="#string">string</a></td><td>repeated</td><td><p>The predecessor tasks of the task. </p></td></tr>-+<tr><td>state</td><td><a href="#bytebase.store.TaskMetadata.State">TaskMetadata.State</a></td><td></td><td><p>The state of the task. </p></td></tr>-+<tr><td>condition</td><td><a href="#string">string</a></td><td></td><td><p>The condition of the task. </p></td></tr>-+<tr><td>definition</td><td><a href="#string">string</a></td><td></td><td><p>The definition of the task. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.TessellationConfig">TessellationConfig</h3><p>TessellationConfig defines tessellation parameters for spatial indexes.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>scheme</td><td><a href="#string">string</a></td>@@ -5800,190 +5800,190 @@ Example: 01ad32a0-1bb6-5e93-0000-000000000001. </p></td><td><p>Tessellation schemeExamples: GEOMETRY_GRID, GEOGRAPHY_GRID, GEOMETRY_AUTO_GRID, GEOGRAPHY_AUTO_GRID </p></td></tr>-+<tr><td>bounding_box</td><td><a href="#bytebase.store.BoundingBox">BoundingBox</a></td><td></td><td><p>Bounding box for GEOMETRY indexes (SQL Server) </p></td></tr>-+<tr><td>grid_levels</td><td><a href="#bytebase.store.GridLevel">GridLevel</a></td><td>repeated</td><td><p>Grid level configuration (SQL Server) </p></td></tr>-+<tr><td>cells_per_object</td><td><a href="#int32">int32</a></td><td></td><td><p>Cells per object (SQL Server) </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.TriggerMetadata">TriggerMetadata</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the trigger. </p></td></tr>-+<tr><td>event</td><td><a href="#string">string</a></td><td></td><td><p>The event that triggers this action, such as INSERT, UPDATE, DELETE, or TRUNCATE. </p></td></tr>-+<tr><td>timing</td><td><a href="#string">string</a></td><td></td><td><p>The timing of when the trigger fires, such as BEFORE or AFTER. </p></td></tr>-+<tr><td>body</td><td><a href="#string">string</a></td><td></td><td><p>The body of the trigger. </p></td></tr>-+<tr><td>sql_mode</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>character_set_client</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>collation_connection</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.ViewMetadata">ViewMetadata</h3><p>ViewMetadata is the metadata for views.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the view. </p></td></tr>-+<tr><td>definition</td><td><a href="#string">string</a></td><td></td><td><p>The definition is the definition of a view. </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment is the comment of a view. </p></td></tr>-+<tr><td>dependency_columns</td><td><a href="#bytebase.store.DependencyColumn">DependencyColumn</a></td><td>repeated</td><td><p>The list of dependency columns of a view. </p></td></tr>-+<tr><td>columns</td><td><a href="#bytebase.store.ColumnMetadata">ColumnMetadata</a></td><td>repeated</td><td><p>The ordered list of columns in the view. </p></td></tr>-+<tr><td>triggers</td><td><a href="#bytebase.store.TriggerMetadata">TriggerMetadata</a></td><td>repeated</td><td><p>The list of triggers in the view. </p></td></tr>-+<tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>rules</td><td><a href="#bytebase.store.RuleMetadata">RuleMetadata</a></td><td>repeated</td><td><p>The rules is the list of rules in a view (PostgreSQL specific). </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.store.ColumnMetadata.IdentityGeneration">ColumnMetadata.IdentityGeneration</h3><p></p><table class="enum-table">@@ -5991,28 +5991,28 @@ Examples: GEOMETRY_GRID, GEOGRAPHY_GRID, GEOMETRY_AUTO_GRID, GEOGRAPHY_AUTO_GRID<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>IDENTITY_GENERATION_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>ALWAYS</td><td>1</td><td><p></p></td></tr>-+<tr><td>BY_DEFAULT</td><td>2</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.GenerationMetadata.Type">GenerationMetadata.Type</h3><p></p><table class="enum-table">@@ -6020,28 +6020,28 @@ Examples: GEOMETRY_GRID, GEOGRAPHY_GRID, GEOMETRY_AUTO_GRID, GEOGRAPHY_AUTO_GRID<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>TYPE_VIRTUAL</td><td>1</td><td><p></p></td></tr>-+<tr><td>TYPE_STORED</td><td>2</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.ObjectSchema.Type">ObjectSchema.Type</h3><p></p><table class="enum-table">@@ -6049,46 +6049,46 @@ Examples: GEOMETRY_GRID, GEOGRAPHY_GRID, GEOMETRY_AUTO_GRID, GEOGRAPHY_AUTO_GRID<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>STRING</td><td>1</td><td><p></p></td></tr>-+<tr><td>NUMBER</td><td>2</td><td><p></p></td></tr>-+<tr><td>BOOLEAN</td><td>3</td><td><p></p></td></tr>-+<tr><td>OBJECT</td><td>4</td><td><p></p></td></tr>-+<tr><td>ARRAY</td><td>5</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.StreamMetadata.Mode">StreamMetadata.Mode</h3><p></p><table class="enum-table">@@ -6096,34 +6096,34 @@ Examples: GEOMETRY_GRID, GEOGRAPHY_GRID, GEOMETRY_AUTO_GRID, GEOGRAPHY_AUTO_GRID<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>MODE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>MODE_DEFAULT</td><td>1</td><td><p></p></td></tr>-+<tr><td>MODE_APPEND_ONLY</td><td>2</td><td><p></p></td></tr>-+<tr><td>MODE_INSERT_ONLY</td><td>3</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.StreamMetadata.Type">StreamMetadata.Type</h3><p></p><table class="enum-table">@@ -6131,22 +6131,22 @@ Examples: GEOMETRY_GRID, GEOGRAPHY_GRID, GEOMETRY_AUTO_GRID, GEOGRAPHY_AUTO_GRID<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>TYPE_DELTA</td><td>1</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.SyncStatus">SyncStatus</h3><p>SyncStatus is the status of the database sync operation.</p><table class="enum-table">@@ -6154,28 +6154,28 @@ Examples: GEOMETRY_GRID, GEOGRAPHY_GRID, GEOMETRY_AUTO_GRID, GEOGRAPHY_AUTO_GRID<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>SYNC_STATUS_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>SYNC_STATUS_OK</td><td>1</td><td><p></p></td></tr>-+<tr><td>SYNC_STATUS_FAILED</td><td>2</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.TablePartitionMetadata.Type">TablePartitionMetadata.Type</h3><p>The type is the type of a table partition. Some database engines may not</p><p>support all types. Only available for the following database engines now:</p><p>MySQL: RANGE, RANGE COLUMNS, LIST, LIST COLUMNS, HASH, LINEAR HASH, KEY,</p><p>LINEAR_KEY</p><p>(https://dev.mysql.com/doc/refman/8.0/en/partitioning-types.html) TiDB:</p><p>RANGE, RANGE COLUMNS, LIST, LIST COLUMNS, HASH, KEY PostgreSQL: RANGE,</p><p>LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)</p><table class="enum-table">@@ -6183,64 +6183,64 @@ Examples: GEOMETRY_GRID, GEOGRAPHY_GRID, GEOMETRY_AUTO_GRID, GEOGRAPHY_AUTO_GRID<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>RANGE</td><td>1</td><td><p></p></td></tr>-+<tr><td>RANGE_COLUMNS</td><td>2</td><td><p></p></td></tr>-+<tr><td>LIST</td><td>3</td><td><p></p></td></tr>-+<tr><td>LIST_COLUMNS</td><td>4</td><td><p></p></td></tr>-+<tr><td>HASH</td><td>5</td><td><p></p></td></tr>-+<tr><td>LINEAR_HASH</td><td>6</td><td><p></p></td></tr>-+<tr><td>KEY</td><td>7</td><td><p></p></td></tr>-+<tr><td>LINEAR_KEY</td><td>8</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.TaskMetadata.State">TaskMetadata.State</h3><p></p><table class="enum-table">@@ -6248,88 +6248,88 @@ Examples: GEOMETRY_GRID, GEOGRAPHY_GRID, GEOMETRY_AUTO_GRID, GEOGRAPHY_AUTO_GRID<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>STATE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>STATE_STARTED</td><td>1</td><td><p></p></td></tr>-+<tr><td>STATE_SUSPENDED</td><td>2</td><td><p></p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="store/export_archive.proto">store/export_archive.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.ExportArchivePayload">ExportArchivePayload</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>file_format</td><td><a href="#bytebase.store.ExportFormat">ExportFormat</a></td><td></td><td><p>The exported file format. e.g. JSON, CSV, SQL </p></td></tr>-+</tbody></table>--------++++++++<div class="file-heading"><h2 id="store/group.proto">store/group.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.GroupMember">GroupMember</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>member</td><td><a href="#string">string</a></td>@@ -6338,54 +6338,54 @@ Examples: GEOMETRY_GRID, GEOGRAPHY_GRID, GEOMETRY_AUTO_GRID, GEOGRAPHY_AUTO_GRIDFormat: users/{email}. </p></td></tr>-+<tr><td>role</td><td><a href="#bytebase.store.GroupMember.Role">GroupMember.Role</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.GroupPayload">GroupPayload</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>members</td><td><a href="#bytebase.store.GroupMember">GroupMember</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>source</td><td><a href="#string">string</a></td><td></td><td><p>The source indicates where the group comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.store.GroupMember.Role">GroupMember.Role</h3><p></p><table class="enum-table">@@ -6393,71 +6393,71 @@ Format: users/{email}. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>ROLE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>OWNER</td><td>1</td><td><p></p></td></tr>-+<tr><td>MEMBER</td><td>2</td><td><p></p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="store/idp.proto">store/idp.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.FieldMapping">FieldMapping</h3><p>FieldMapping saves the field names from user info API of identity provider.</p><p>As we save all raw json string of user info response data into `principal.idp_user_info`,</p><p>we can extract the relevant data based with `FieldMapping`.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>identifier</td><td><a href="#string">string</a></td><td></td><td><p>Identifier is the field name of the unique identifier in 3rd-party idp user info. Required. </p></td></tr>-+<tr><td>display_name</td><td><a href="#string">string</a></td><td></td><td><p>DisplayName is the field name of display name in 3rd-party idp user info. Optional. </p></td></tr>-+<tr><td>phone</td><td><a href="#string">string</a></td><td></td><td><p>Phone is the field name of primary phone in 3rd-party idp user info. Optional. </p></td></tr>-+<tr><td>groups</td><td><a href="#string">string</a></td>@@ -6465,83 +6465,83 @@ Format: users/{email}. </p></td><td><p>Groups is the field name of groups in 3rd-party idp user info. Optional.Mainly used for OIDC: https://developer.okta.com/docs/guides/customize-tokens-groups-claim/main/ </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.IdentityProviderConfig">IdentityProviderConfig</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>oauth2_config</td><td><a href="#bytebase.store.OAuth2IdentityProviderConfig">OAuth2IdentityProviderConfig</a></td><td></td><td><p> </p></td></tr>-+<tr><td>oidc_config</td><td><a href="#bytebase.store.OIDCIdentityProviderConfig">OIDCIdentityProviderConfig</a></td><td></td><td><p> </p></td></tr>-+<tr><td>ldap_config</td><td><a href="#bytebase.store.LDAPIdentityProviderConfig">LDAPIdentityProviderConfig</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.IdentityProviderUserInfo">IdentityProviderUserInfo</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>identifier</td><td><a href="#string">string</a></td><td></td><td><p>Identifier is the value of the unique identifier in 3rd-party idp user info. </p></td></tr>-+<tr><td>display_name</td><td><a href="#string">string</a></td><td></td><td><p>DisplayName is the value of display name in 3rd-party idp user info. </p></td></tr>-+<tr><td>phone</td><td><a href="#string">string</a></td><td></td><td><p>Phone is the value of primary phone in 3rd-party idp user info. </p></td></tr>-+<tr><td>groups</td><td><a href="#string">string</a></td>@@ -6549,31 +6549,31 @@ Mainly used for OIDC: https://developer.okta.com/docs/guides/customize-tokens-gr<td><p>Groups is the value of groups in 3rd-party idp user info.Mainly used for OIDC: https://developer.okta.com/docs/guides/customize-tokens-groups-claim/main/ </p></td></tr>-+<tr><td>has_groups</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.LDAPIdentityProviderConfig">LDAPIdentityProviderConfig</h3><p>LDAPIdentityProviderConfig is the structure for LDAP identity provider config.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>host</td><td><a href="#string">string</a></td>@@ -6581,7 +6581,7 @@ Mainly used for OIDC: https://developer.okta.com/docs/guides/customize-tokens-gr<td><p>Host is the hostname or IP address of the LDAP server, e.g."ldap.example.com". </p></td></tr>-+<tr><td>port</td><td><a href="#int32">int32</a></td>@@ -6590,14 +6590,14 @@ Mainly used for OIDC: https://developer.okta.com/docs/guides/customize-tokens-grdefault port of the corresponding security protocol will be used, i.e. 389for StartTLS and 636 for LDAPS. </p></td></tr>-+<tr><td>skip_tls_verify</td><td><a href="#bool">bool</a></td><td></td><td><p>SkipTLSVerify controls whether to skip TLS certificate verification. </p></td></tr>-+<tr><td>bind_dn</td><td><a href="#string">string</a></td>@@ -6605,28 +6605,28 @@ for StartTLS and 636 for LDAPS. </p></td><td><p>BindDN is the DN of the user to bind as a service account to performsearch requests. </p></td></tr>-+<tr><td>bind_password</td><td><a href="#string">string</a></td><td></td><td><p>BindPassword is the password of the user to bind as a service account. </p></td></tr>-+<tr><td>base_dn</td><td><a href="#string">string</a></td><td></td><td><p>BaseDN is the base DN to search for users, e.g. "ou=users,dc=example,dc=com". </p></td></tr>-+<tr><td>user_filter</td><td><a href="#string">string</a></td><td></td><td><p>UserFilter is the filter to search for users, e.g. "(uid=%s)". </p></td></tr>-+<tr><td>security_protocol</td><td><a href="#bytebase.store.LDAPIdentityProviderConfig.SecurityProtocol">LDAPIdentityProviderConfig.SecurityProtocol</a></td>@@ -6634,7 +6634,7 @@ search requests. </p></td><td><p>SecurityProtocol is the security protocol to be used for establishingconnections with the LDAP server. </p></td></tr>-+<tr><td>field_mapping</td><td><a href="#bytebase.store.FieldMapping">FieldMapping</a></td>@@ -6642,162 +6642,162 @@ connections with the LDAP server. </p></td><td><p>FieldMapping is the mapping of the user attributes returned by the LDAPserver. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.OAuth2IdentityProviderConfig">OAuth2IdentityProviderConfig</h3><p>OAuth2IdentityProviderConfig is the structure for OAuth2 identity provider config.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>auth_url</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>token_url</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>user_info_url</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>client_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>client_secret</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>scopes</td><td><a href="#string">string</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>field_mapping</td><td><a href="#bytebase.store.FieldMapping">FieldMapping</a></td><td></td><td><p> </p></td></tr>-+<tr><td>skip_tls_verify</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>auth_style</td><td><a href="#bytebase.store.OAuth2AuthStyle">OAuth2AuthStyle</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.OIDCIdentityProviderConfig">OIDCIdentityProviderConfig</h3><p>OIDCIdentityProviderConfig is the structure for OIDC identity provider config.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>issuer</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>client_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>client_secret</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>scopes</td><td><a href="#string">string</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>field_mapping</td><td><a href="#bytebase.store.FieldMapping">FieldMapping</a></td><td></td><td><p> </p></td></tr>-+<tr><td>skip_tls_verify</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>auth_style</td><td><a href="#bytebase.store.OAuth2AuthStyle">OAuth2AuthStyle</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.store.IdentityProviderType">IdentityProviderType</h3><p></p><table class="enum-table">@@ -6805,34 +6805,34 @@ server. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>IDENTITY_PROVIDER_TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>OAUTH2</td><td>1</td><td><p></p></td></tr>-+<tr><td>OIDC</td><td>2</td><td><p></p></td></tr>-+<tr><td>LDAP</td><td>3</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.LDAPIdentityProviderConfig.SecurityProtocol">LDAPIdentityProviderConfig.SecurityProtocol</h3><p></p><table class="enum-table">@@ -6840,28 +6840,28 @@ server. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>SECURITY_PROTOCOL_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>START_TLS</td><td>1</td><td><p>StartTLS is the security protocol that starts with an unencrypted connection and then upgrades to TLS.</p></td></tr>-+<tr><td>LDAPS</td><td>2</td><td><p>LDAPS is the security protocol that uses TLS from the beginning.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.OAuth2AuthStyle">OAuth2AuthStyle</h3><p></p><table class="enum-table">@@ -6869,136 +6869,178 @@ server. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>OAUTH2_AUTH_STYLE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>IN_PARAMS</td><td>1</td><td><p>IN_PARAMS sends the "client_id" and "client_secret" in the POST bodyas application/x-www-form-urlencoded parameters.</p></td></tr>-+<tr><td>IN_HEADER</td><td>2</td><td><p>IN_HEADER sends the client_id and client_secret using HTTP Basic Authorization.This is an optional style described in the OAuth2 RFC 6749 section 2.3.1.</p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="store/instance.proto">store/instance.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.DataSource">DataSource</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.store.DataSourceType">DataSourceType</a></td><td></td><td><p> </p></td></tr>-+<tr><td>username</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>password</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>obfuscated_password</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>use_ssl</td><td><a href="#bool">bool</a></td><td></td><td><p>Use SSL to connect to the data source. By default, we use the system's SSL configuration. </p></td></tr>-+<tr><td>ssl_ca</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>obfuscated_ssl_ca</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>ssl_cert</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>obfuscated_ssl_cert</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>ssl_key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>obfuscated_ssl_key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-++ <tr>+ <td>ssl_ca_path</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p> </p></td>+ </tr>++ <tr>+ <td>obfuscated_ssl_ca_path</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p> </p></td>+ </tr>++ <tr>+ <td>ssl_cert_path</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p> </p></td>+ </tr>++ <tr>+ <td>obfuscated_ssl_cert_path</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p> </p></td>+ </tr>++ <tr>+ <td>ssl_key_path</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p> </p></td>+ </tr>++ <tr>+ <td>obfuscated_ssl_key_path</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p> </p></td>+ </tr>+<tr><td>verify_tls_certificate</td><td><a href="#bool">bool</a></td>@@ -7009,28 +7051,28 @@ Set to true for secure connections (recommended for production).Only set to false for development or when certificates cannot be properlyvalidated (e.g., self-signed certs, VPN environments). </p></td></tr>-+<tr><td>host</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>port</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>database</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>srv</td><td><a href="#bool">bool</a></td>@@ -7038,35 +7080,35 @@ validated (e.g., self-signed certs, VPN environments). </p></td><td><p>srv, authentication_database, and replica_set are used for MongoDB.srv is a boolean flag that indicates whether the host is a DNS SRV record. </p></td></tr>-+<tr><td>authentication_database</td><td><a href="#string">string</a></td><td></td><td><p>authentication_database is the database name to authenticate against, which stores the user credentials. </p></td></tr>-+<tr><td>replica_set</td><td><a href="#string">string</a></td><td></td><td><p>replica_set is used for MongoDB replica set. </p></td></tr>-+<tr><td>sid</td><td><a href="#string">string</a></td><td></td><td><p>sid and service_name are used for Oracle. </p></td></tr>-+<tr><td>service_name</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>ssh_host</td><td><a href="#string">string</a></td>@@ -7074,49 +7116,49 @@ srv is a boolean flag that indicates whether the host is a DNS SRV record. </p><<td><p>SSH relatedThe hostname of the SSH server agent. </p></td></tr>-+<tr><td>ssh_port</td><td><a href="#string">string</a></td><td></td><td><p>The port of the SSH server agent. It's 22 typically. </p></td></tr>-+<tr><td>ssh_user</td><td><a href="#string">string</a></td><td></td><td><p>The user to login the server. </p></td></tr>-+<tr><td>ssh_password</td><td><a href="#string">string</a></td><td></td><td><p>The password to login the server. If it's empty string, no password is required. </p></td></tr>-+<tr><td>obfuscated_ssh_password</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>ssh_private_key</td><td><a href="#string">string</a></td><td></td><td><p>The private key to login the server. If it's empty string, we will use the system default private key from os.Getenv("SSH_AUTH_SOCK"). </p></td></tr>-+<tr><td>obfuscated_ssh_private_key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>authentication_private_key</td><td><a href="#string">string</a></td>@@ -7124,140 +7166,140 @@ The hostname of the SSH server agent. </p></td><td><p>PKCS#8 private key in PEM format. If it's empty string, no private key is required.Used for authentication when connecting to the data source. </p></td></tr>-+<tr><td>obfuscated_authentication_private_key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>authentication_private_key_passphrase</td><td><a href="#string">string</a></td><td></td><td><p>Passphrase for the encrypted PKCS#8 private key. Only used when the private key is encrypted. </p></td></tr>-+<tr><td>obfuscated_authentication_private_key_passphrase</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>external_secret</td><td><a href="#bytebase.store.DataSourceExternalSecret">DataSourceExternalSecret</a></td><td></td><td><p> </p></td></tr>-+<tr><td>authentication_type</td><td><a href="#bytebase.store.DataSource.AuthenticationType">DataSource.AuthenticationType</a></td><td></td><td><p> </p></td></tr>-+<tr><td>azure_credential</td><td><a href="#bytebase.store.DataSource.AzureCredential">DataSource.AzureCredential</a></td><td></td><td><p> </p></td></tr>-+<tr><td>aws_credential</td><td><a href="#bytebase.store.DataSource.AWSCredential">DataSource.AWSCredential</a></td><td></td><td><p> </p></td></tr>-+<tr><td>gcp_credential</td><td><a href="#bytebase.store.DataSource.GCPCredential">DataSource.GCPCredential</a></td><td></td><td><p> </p></td></tr>-+<tr><td>sasl_config</td><td><a href="#bytebase.store.SASLConfig">SASLConfig</a></td><td></td><td><p> </p></td></tr>-+<tr><td>additional_addresses</td><td><a href="#bytebase.store.DataSource.Address">DataSource.Address</a></td><td>repeated</td><td><p>additional_addresses is used for MongoDB replica set. </p></td></tr>-+<tr><td>direct_connection</td><td><a href="#bool">bool</a></td><td></td><td><p>direct_connection is used for MongoDB to dispatch all the operations to the node specified in the connection string. </p></td></tr>-+<tr><td>region</td><td><a href="#string">string</a></td><td></td><td><p>Region is the location of the database, used for AWS RDS. For example, us-east-1. </p></td></tr>-+<tr><td>warehouse_id</td><td><a href="#string">string</a></td><td></td><td><p>warehouse_id is used by Databricks. </p></td></tr>-+<tr><td>master_name</td><td><a href="#string">string</a></td><td></td><td><p>master_name is the master name used by connecting redis-master via redis sentinel. </p></td></tr>-+<tr><td>master_username</td><td><a href="#string">string</a></td><td></td><td><p>master_username and master_obfuscated_password are master credentials used by redis sentinel mode. </p></td></tr>-+<tr><td>master_password</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>obfuscated_master_password</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>redis_type</td><td><a href="#bytebase.store.DataSource.RedisType">DataSource.RedisType</a></td><td></td><td><p> </p></td></tr>-+<tr><td>cluster</td><td><a href="#string">string</a></td><td></td><td><p>Cluster is the cluster name for the data source. Used by CockroachDB. </p></td></tr>-+<tr><td>extra_connection_parameters</td><td><a href="#bytebase.store.DataSource.ExtraConnectionParametersEntry">DataSource.ExtraConnectionParametersEntry</a></td>@@ -7265,66 +7307,66 @@ Used for authentication when connecting to the data source. </p></td><td><p>Extra connection parameters for the database connection.For PostgreSQL HA, this can be used to set target_session_attrs=read-write </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.DataSource.AWSCredential">DataSource.AWSCredential</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>access_key_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>obfuscated_access_key_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>secret_access_key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>obfuscated_secret_access_key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>session_token</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>obfuscated_session_token</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>role_arn</td><td><a href="#string">string</a></td>@@ -7332,7 +7374,7 @@ For PostgreSQL HA, this can be used to set target_session_attrs=read-write </p><<td><p>ARN of IAM role to assume for cross-account access.See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html </p></td></tr>-+<tr><td>external_id</td><td><a href="#string">string</a></td>@@ -7340,218 +7382,218 @@ See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html </p></td<td><p>Optional external ID for additional security when assuming role.See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.DataSource.Address">DataSource.Address</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>host</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>port</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.DataSource.AzureCredential">DataSource.AzureCredential</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>tenant_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>client_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>client_secret</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>obfuscated_client_secret</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.DataSource.ExtraConnectionParametersEntry">DataSource.ExtraConnectionParametersEntry</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.DataSource.GCPCredential">DataSource.GCPCredential</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>content</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>obfuscated_content</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.DataSourceExternalSecret">DataSourceExternalSecret</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>secret_type</td><td><a href="#bytebase.store.DataSourceExternalSecret.SecretType">DataSourceExternalSecret.SecretType</a></td><td></td><td><p> </p></td></tr>-+<tr><td>url</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>auth_type</td><td><a href="#bytebase.store.DataSourceExternalSecret.AuthType">DataSourceExternalSecret.AuthType</a></td><td></td><td><p> </p></td></tr>-+<tr><td>app_role</td><td><a href="#bytebase.store.DataSourceExternalSecret.AppRoleAuthOption">DataSourceExternalSecret.AppRoleAuthOption</a></td><td></td><td><p> </p></td></tr>-+<tr><td>token</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>engine_name</td><td><a href="#string">string</a></td><td></td><td><p>engine name is the name for secret engine. </p></td></tr>-+<tr><td>secret_name</td><td><a href="#string">string</a></td><td></td><td><p>the secret name in the engine to store the password. </p></td></tr>-+<tr><td>password_key_name</td><td><a href="#string">string</a></td><td></td><td><p>the key name for the password. </p></td></tr>-+<tr><td>skip_vault_tls_verification</td><td><a href="#bool">bool</a></td>@@ -7562,160 +7604,160 @@ skip_vault_tls_verification disables TLS certificate verification for Vault connDefault is false (verification enabled) for security.Only set to true for development or when certificates cannot be properly validated. </p></td></tr>-+<tr><td>vault_ssl_ca</td><td><a href="#string">string</a></td><td></td><td><p>CA certificate for Vault server verification. </p></td></tr>-+<tr><td>obfuscated_vault_ssl_ca</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>vault_ssl_cert</td><td><a href="#string">string</a></td><td></td><td><p>Client certificate for mutual TLS authentication with Vault. </p></td></tr>-+<tr><td>obfuscated_vault_ssl_cert</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>vault_ssl_key</td><td><a href="#string">string</a></td><td></td><td><p>Client private key for mutual TLS authentication with Vault. </p></td></tr>-+<tr><td>obfuscated_vault_ssl_key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.DataSourceExternalSecret.AppRoleAuthOption">DataSourceExternalSecret.AppRoleAuthOption</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>role_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>secret_id</td><td><a href="#string">string</a></td><td></td><td><p>The secret ID for the role without TTL. </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.store.DataSourceExternalSecret.AppRoleAuthOption.SecretType">DataSourceExternalSecret.AppRoleAuthOption.SecretType</a></td><td></td><td><p> </p></td></tr>-+<tr><td>mount_path</td><td><a href="#string">string</a></td><td></td><td><p>The path where the approle auth method is mounted. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.Instance">Instance</h3><p>Instance is the proto for instances.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>engine</td><td><a href="#bytebase.store.Engine">Engine</a></td><td></td><td><p> </p></td></tr>-+<tr><td>activation</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>version</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>external_link</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>data_sources</td><td><a href="#bytebase.store.DataSource">DataSource</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>sync_interval</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td><td><p>The interval between automatic instance synchronizations. </p></td></tr>-+<tr><td>sync_databases</td><td><a href="#string">string</a></td>@@ -7723,7 +7765,7 @@ Only set to true for development or when certificates cannot be properly validat<td><p>Enable sync for the following databases.Default empty, means sync all schemas & databases. </p></td></tr>-+<tr><td>mysql_lower_case_table_names</td><td><a href="#int32">int32</a></td>@@ -7731,21 +7773,21 @@ Default empty, means sync all schemas & databases. </p></td><td><p>The lower_case_table_names config for MySQL instances.It is used to determine whether the table names and database names are case sensitive. </p></td></tr>-+<tr><td>last_sync_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>roles</td><td><a href="#bytebase.store.InstanceRole">InstanceRole</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>labels</td><td><a href="#bytebase.store.Instance.LabelsEntry">Instance.LabelsEntry</a></td>@@ -7753,76 +7795,76 @@ It is used to determine whether the table names and database names are case sens<td><p>Labels are key-value pairs that can be attached to the instance.For example, { "org_group": "infrastructure", "environment": "production" } </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.Instance.LabelsEntry">Instance.LabelsEntry</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.InstanceRole">InstanceRole</h3><p>InstanceRole is the API message for instance role.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The role name. </p></td></tr>-+<tr><td>connection_limit</td><td><a href="#int32">int32</a></td><td>optional</td><td><p>The connection count limit for this role. </p></td></tr>-+<tr><td>valid_until</td><td><a href="#string">string</a></td><td>optional</td><td><p>The expiration for the role's password. </p></td></tr>-+<tr><td>attribute</td><td><a href="#string">string</a></td>@@ -7831,106 +7873,106 @@ For example, { "org_group": "infrastructure", "environment&#For PostgreSQL, it contains super_user, no_inherit, create_role, create_db, can_login, replication and bypass_rls. Docs: https://www.postgresql.org/docs/current/role-attributes.htmlFor MySQL, it is the global privileges as GRANT statements, which means it only contains "GRANT ... ON *.* TO ...". Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.KerberosConfig">KerberosConfig</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>primary</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>instance</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>realm</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>keytab</td><td><a href="#bytes">bytes</a></td><td></td><td><p> </p></td></tr>-+<tr><td>kdc_host</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>kdc_port</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>kdc_transport_protocol</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.SASLConfig">SASLConfig</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>krb_config</td><td><a href="#bytebase.store.KerberosConfig">KerberosConfig</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.store.DataSource.AuthenticationType">DataSource.AuthenticationType</h3><p></p><table class="enum-table">@@ -7938,40 +7980,40 @@ For MySQL, it is the global privileges as GRANT statements, which means it only<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>AUTHENTICATION_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>PASSWORD</td><td>1</td><td><p></p></td></tr>-+<tr><td>GOOGLE_CLOUD_SQL_IAM</td><td>2</td><td><p></p></td></tr>-+<tr><td>AWS_RDS_IAM</td><td>3</td><td><p></p></td></tr>-+<tr><td>AZURE_IAM</td><td>4</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.DataSource.RedisType">DataSource.RedisType</h3><p></p><table class="enum-table">@@ -7979,34 +8021,34 @@ For MySQL, it is the global privileges as GRANT statements, which means it only<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>REDIS_TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>STANDALONE</td><td>1</td><td><p></p></td></tr>-+<tr><td>SENTINEL</td><td>2</td><td><p></p></td></tr>-+<tr><td>CLUSTER</td><td>3</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.DataSourceExternalSecret.AppRoleAuthOption.SecretType">DataSourceExternalSecret.AppRoleAuthOption.SecretType</h3><p></p><table class="enum-table">@@ -8014,28 +8056,28 @@ For MySQL, it is the global privileges as GRANT statements, which means it only<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>SECRET_TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>PLAIN</td><td>1</td><td><p></p></td></tr>-+<tr><td>ENVIRONMENT</td><td>2</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.DataSourceExternalSecret.AuthType">DataSourceExternalSecret.AuthType</h3><p></p><table class="enum-table">@@ -8043,28 +8085,28 @@ For MySQL, it is the global privileges as GRANT statements, which means it only<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>AUTH_TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>TOKEN</td><td>1</td><td><p>ref: https://developer.hashicorp.com/vault/docs/auth/token</p></td></tr>-+<tr><td>VAULT_APP_ROLE</td><td>2</td><td><p>ref: https://developer.hashicorp.com/vault/docs/auth/approle</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.DataSourceExternalSecret.SecretType">DataSourceExternalSecret.SecretType</h3><p></p><table class="enum-table">@@ -8072,40 +8114,40 @@ For MySQL, it is the global privileges as GRANT statements, which means it only<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>SECRET_TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>VAULT_KV_V2</td><td>1</td><td><p>ref: https://developer.hashicorp.com/vault/api-docs/secret/kv/kv-v2</p></td></tr>-+<tr><td>AWS_SECRETS_MANAGER</td><td>2</td><td><p>ref: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html</p></td></tr>-+<tr><td>GCP_SECRET_MANAGER</td><td>3</td><td><p>ref: https://cloud.google.com/secret-manager/docs</p></td></tr>-+<tr><td>AZURE_KEY_VAULT</td><td>4</td><td><p>ref: https://learn.microsoft.com/en-us/azure/key-vault/secrets/about-secrets</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.DataSourceType">DataSourceType</h3><p></p><table class="enum-table">@@ -8113,102 +8155,102 @@ For MySQL, it is the global privileges as GRANT statements, which means it only<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>DATA_SOURCE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>ADMIN</td><td>1</td><td><p></p></td></tr>-+<tr><td>READ_ONLY</td><td>2</td><td><p></p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="store/issue.proto">store/issue.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.Issue">Issue</h3><p>Issue is the metadata for issues that track database operations and access requests.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>approval</td><td><a href="#bytebase.store.IssuePayloadApproval">IssuePayloadApproval</a></td><td></td><td><p>Approval information for the issue workflow. </p></td></tr>-+<tr><td>role_grant</td><td><a href="#bytebase.store.RoleGrant">RoleGrant</a></td><td></td><td><p>Role grant details if this is a role grant issue. </p></td></tr>-+<tr><td>labels</td><td><a href="#string">string</a></td><td>repeated</td><td><p>Labels attached to categorize and filter the issue. </p></td></tr>-+<tr><td>risk_level</td><td><a href="#bytebase.store.RiskLevel">RiskLevel</a></td><td></td><td><p>Risk level for the issue, calculated from statement types. </p></td></tr>-+<tr><td>access_grant_id</td><td><a href="#string">string</a></td><td></td><td><p>The access grant id for ACCESS_GRANT type issue. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.RoleGrant">RoleGrant</h3><p>RoleGrant contains details for requesting a project role.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>role</td><td><a href="#string">string</a></td>@@ -8216,7 +8258,7 @@ For MySQL, it is the global privileges as GRANT statements, which means it only<td><p>The role being requested for the user.Format: roles/EXPORTER. </p></td></tr>-+<tr><td>user</td><td><a href="#string">string</a></td>@@ -8224,30 +8266,30 @@ Format: roles/EXPORTER. </p></td><td><p>The user who will receive the role.Format: users/{email}. </p></td></tr>-+<tr><td>condition</td><td><a href="#google.type.Expr">google.type.Expr</a></td><td></td><td><p>Optional conditional expression that limits when the grant applies. </p></td></tr>-+<tr><td>expiration</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td><td><p>Duration after which the grant automatically expires. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.store.Issue.Status">Issue.Status</h3><p>Status represents the current state of the issue.</p><table class="enum-table">@@ -8255,34 +8297,34 @@ Format: users/{email}. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>ISSUE_STATUS_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>OPEN</td><td>1</td><td><p>Issue is open and pending action.</p></td></tr>-+<tr><td>DONE</td><td>2</td><td><p>Issue has been completed successfully.</p></td></tr>-+<tr><td>CANCELED</td><td>3</td><td><p>Issue was canceled and will not be completed.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.Issue.Type">Issue.Type</h3><p>Type represents the category of issue.</p><table class="enum-table">@@ -8290,204 +8332,204 @@ Format: users/{email}. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>ISSUE_TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>DATABASE_CHANGE</td><td>1</td><td><p>Issue for database schema or data changes.</p></td></tr>-+<tr><td>ROLE_GRANT</td><td>2</td><td><p>Role grant request.</p></td></tr>-+<tr><td>DATABASE_EXPORT</td><td>3</td><td><p>Issue for exporting data from databases.</p></td></tr>-+<tr><td>ACCESS_GRANT</td><td>4</td><td><p>Temporary access grant request.</p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="store/issue_comment.proto">store/issue_comment.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.IssueCommentPayload">IssueCommentPayload</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>approval</td><td><a href="#bytebase.store.IssueCommentPayload.Approval">IssueCommentPayload.Approval</a></td><td></td><td><p> </p></td></tr>-+<tr><td>issue_update</td><td><a href="#bytebase.store.IssueCommentPayload.IssueUpdate">IssueCommentPayload.IssueUpdate</a></td><td></td><td><p> </p></td></tr>-+<tr><td>plan_spec_update</td><td><a href="#bytebase.store.IssueCommentPayload.PlanSpecUpdate">IssueCommentPayload.PlanSpecUpdate</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.IssueCommentPayload.Approval">IssueCommentPayload.Approval</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>status</td><td><a href="#bytebase.store.IssuePayloadApproval.Approver.Status">IssuePayloadApproval.Approver.Status</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.IssueCommentPayload.IssueUpdate">IssueCommentPayload.IssueUpdate</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>from_title</td><td><a href="#string">string</a></td><td>optional</td><td><p> </p></td></tr>-+<tr><td>to_title</td><td><a href="#string">string</a></td><td>optional</td><td><p> </p></td></tr>-+<tr><td>from_description</td><td><a href="#string">string</a></td><td>optional</td><td><p> </p></td></tr>-+<tr><td>to_description</td><td><a href="#string">string</a></td><td>optional</td><td><p> </p></td></tr>-+<tr><td>from_status</td><td><a href="#bytebase.store.Issue.Status">Issue.Status</a></td><td>optional</td><td><p> </p></td></tr>-+<tr><td>to_status</td><td><a href="#bytebase.store.Issue.Status">Issue.Status</a></td><td>optional</td><td><p> </p></td></tr>-+<tr><td>from_labels</td><td><a href="#string">string</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>to_labels</td><td><a href="#string">string</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.IssueCommentPayload.PlanSpecUpdate">IssueCommentPayload.PlanSpecUpdate</h3><p>Plan spec update event (tracks sheet changes to plan specs)</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>spec</td><td><a href="#string">string</a></td>@@ -8495,180 +8537,180 @@ Format: users/{email}. </p></td><td><p>The spec that was updatedFormat: projects/{project}/plans/{plan}/specs/{spec} </p></td></tr>-+<tr><td>from_sheet_sha256</td><td><a href="#string">string</a></td><td>optional</td><td><p>The SHA256 hash of the previous sheet content (hex-encoded). </p></td></tr>-+<tr><td>to_sheet_sha256</td><td><a href="#string">string</a></td><td>optional</td><td><p>The SHA256 hash of the new sheet content (hex-encoded). </p></td></tr>-+</tbody></table>--------++++++++<div class="file-heading"><h2 id="store/oauth2.proto">store/oauth2.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.OAuth2AuthorizationCodeConfig">OAuth2AuthorizationCodeConfig</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>redirect_uri</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>code_challenge</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>code_challenge_method</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.OAuth2ClientConfig">OAuth2ClientConfig</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>client_name</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>redirect_uris</td><td><a href="#string">string</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>grant_types</td><td><a href="#string">string</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>token_endpoint_auth_method</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>--------++++++++<div class="file-heading"><h2 id="store/plan.proto">store/plan.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.PlanConfig">PlanConfig</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>specs</td><td><a href="#bytebase.store.PlanConfig.Spec">PlanConfig.Spec</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>has_rollout</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether the plan has started the rollout. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.PlanConfig.ChangeDatabaseConfig">PlanConfig.ChangeDatabaseConfig</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>targets</td><td><a href="#string">string</a></td>@@ -8677,14 +8719,14 @@ Format: projects/{project}/plans/{plan}/specs/{spec} </p></td>Multi-database format: [instances/{instance-id}/databases/{database-name}].Single database group format: [projects/{project}/databaseGroups/{databaseGroup}]. </p></td></tr>-+<tr><td>sheet_sha256</td><td><a href="#string">string</a></td><td></td><td><p>The SHA256 hash of the sheet content (hex-encoded). </p></td></tr>-+<tr><td>release</td><td><a href="#string">string</a></td>@@ -8692,31 +8734,31 @@ Single database group format: [projects/{project}/databaseGroups/{databaseGroup}<td><p>The resource name of the release.Format: projects/{project}/releases/{release} </p></td></tr>-+<tr><td>enable_prior_backup</td><td><a href="#bool">bool</a></td><td></td><td><p>If set, a backup of the modified data will be created automatically before any changes are applied. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.PlanConfig.CreateDatabaseConfig">PlanConfig.CreateDatabaseConfig</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>target</td><td><a href="#string">string</a></td>@@ -8724,14 +8766,14 @@ Format: projects/{project}/releases/{release} </p></td><td><p>The resource name of the instance on which the database is created.Format: instances/{instance} </p></td></tr>-+<tr><td>database</td><td><a href="#string">string</a></td><td></td><td><p>The name of the database to create. </p></td></tr>-+<tr><td>table</td><td><a href="#string">string</a></td>@@ -8739,35 +8781,35 @@ Format: instances/{instance} </p></td><td><p>table is the name of the table, if it is not empty, Bytebase should create a table after creating the database.For example, in MongoDB, it only creates the database when we first store data in that database. </p></td></tr>-+<tr><td>character_set</td><td><a href="#string">string</a></td><td></td><td><p>character_set is the character set of the database. </p></td></tr>-+<tr><td>collation</td><td><a href="#string">string</a></td><td></td><td><p>collation is the collation of the database. </p></td></tr>-+<tr><td>cluster</td><td><a href="#string">string</a></td><td></td><td><p>cluster is the cluster of the database. This is only applicable to ClickHouse for "ON CLUSTER <<cluster>>". </p></td></tr>-+<tr><td>owner</td><td><a href="#string">string</a></td><td></td><td><p>owner is the owner of the database. This is only applicable to Postgres for "WITH OWNER <<owner>>". </p></td></tr>-+<tr><td>environment</td><td><a href="#string">string</a></td>@@ -8775,24 +8817,24 @@ For example, in MongoDB, it only creates the database when we first store data i<td><p>The environment resource.Format: environments/prod where prod is the environment resource ID. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.PlanConfig.ExportDataConfig">PlanConfig.ExportDataConfig</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>targets</td><td><a href="#string">string</a></td>@@ -8801,21 +8843,21 @@ Format: environments/prod where prod is the environment resource ID. </p></td>Multi-database format: [instances/{instance-id}/databases/{database-name}].Single database group format: [projects/{project}/databaseGroups/{databaseGroup}]. </p></td></tr>-+<tr><td>sheet_sha256</td><td><a href="#string">string</a></td><td></td><td><p>The SHA256 hash of the sheet content (hex-encoded). </p></td></tr>-+<tr><td>format</td><td><a href="#bytebase.store.ExportFormat">ExportFormat</a></td><td></td><td><p>The format of the exported file. </p></td></tr>-+<tr><td>password</td><td><a href="#string">string</a></td>@@ -8823,259 +8865,259 @@ Single database group format: [projects/{project}/databaseGroups/{databaseGroup}<td><p>The zip password provided by users.Leave it empty if there is no need to encrypt the zip file. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.PlanConfig.Spec">PlanConfig.Spec</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>id</td><td><a href="#string">string</a></td><td></td><td><p>A UUID4 string that uniquely identifies the Spec. </p></td></tr>-+<tr><td>create_database_config</td><td><a href="#bytebase.store.PlanConfig.CreateDatabaseConfig">PlanConfig.CreateDatabaseConfig</a></td><td></td><td><p> </p></td></tr>-+<tr><td>change_database_config</td><td><a href="#bytebase.store.PlanConfig.ChangeDatabaseConfig">PlanConfig.ChangeDatabaseConfig</a></td><td></td><td><p> </p></td></tr>-+<tr><td>export_data_config</td><td><a href="#bytebase.store.PlanConfig.ExportDataConfig">PlanConfig.ExportDataConfig</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>--------++++++++<div class="file-heading"><h2 id="store/plan_check_run.proto">store/plan_check_run.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.ChangedResourceDatabase">ChangedResourceDatabase</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>schemas</td><td><a href="#bytebase.store.ChangedResourceSchema">ChangedResourceSchema</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.ChangedResourceSchema">ChangedResourceSchema</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>tables</td><td><a href="#bytebase.store.ChangedResourceTable">ChangedResourceTable</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.ChangedResourceTable">ChangedResourceTable</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>table_rows</td><td><a href="#int64">int64</a></td><td></td><td><p>The estimated row count of the table. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.ChangedResources">ChangedResources</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>databases</td><td><a href="#bytebase.store.ChangedResourceDatabase">ChangedResourceDatabase</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.PlanCheckRunResult">PlanCheckRunResult</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>results</td><td><a href="#bytebase.store.PlanCheckRunResult.Result">PlanCheckRunResult.Result</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>error</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.PlanCheckRunResult.Result">PlanCheckRunResult.Result</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>status</td><td><a href="#bytebase.store.Advice.Status">Advice.Status</a></td><td></td><td><p> </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>content</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>code</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>target</td><td><a href="#string">string</a></td>@@ -9083,106 +9125,106 @@ Leave it empty if there is no need to encrypt the zip file. </p></td><td><p>Target identification for consolidated resultsFormat: instances/{instance}/databases/{database} </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.store.PlanCheckType">PlanCheckType</a></td><td></td><td><p> </p></td></tr>-+<tr><td>sql_summary_report</td><td><a href="#bytebase.store.PlanCheckRunResult.Result.SqlSummaryReport">PlanCheckRunResult.Result.SqlSummaryReport</a></td><td></td><td><p> </p></td></tr>-+<tr><td>sql_review_report</td><td><a href="#bytebase.store.PlanCheckRunResult.Result.SqlReviewReport">PlanCheckRunResult.Result.SqlReviewReport</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.PlanCheckRunResult.Result.SqlReviewReport">PlanCheckRunResult.Result.SqlReviewReport</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>start_position</td><td><a href="#bytebase.store.Position">Position</a></td><td></td><td><p>Position of the SQL statement. </p></td></tr>-+<tr><td>end_position</td><td><a href="#bytebase.store.Position">Position</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.PlanCheckRunResult.Result.SqlSummaryReport">PlanCheckRunResult.Result.SqlSummaryReport</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>statement_types</td><td><a href="#bytebase.store.StatementType">StatementType</a></td><td>repeated</td><td><p>statement_types are the types of statements found in the SQL. </p></td></tr>-+<tr><td>affected_rows</td><td><a href="#int64">int64</a></td><td></td><td><p> </p></td></tr>-+<tr><td>changed_resources</td><td><a href="#bytebase.store.ChangedResources">ChangedResources</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.store.PlanCheckType">PlanCheckType</h3><p></p><table class="enum-table">@@ -9190,56 +9232,56 @@ Format: instances/{instance}/databases/{database} </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>PLAN_CHECK_TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>PLAN_CHECK_TYPE_STATEMENT_ADVISE</td><td>1</td><td><p></p></td></tr>-+<tr><td>PLAN_CHECK_TYPE_STATEMENT_SUMMARY_REPORT</td><td>2</td><td><p></p></td></tr>-+<tr><td>PLAN_CHECK_TYPE_GHOST_SYNC</td><td>3</td><td><p></p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="store/policy.proto">store/policy.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.Binding">Binding</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>role</td><td><a href="#string">string</a></td>@@ -9247,7 +9289,7 @@ Format: instances/{instance}/databases/{database} </p></td><td><p>The role that is assigned to the members.Format: roles/{role} </p></td></tr>-+<tr><td>members</td><td><a href="#string">string</a></td>@@ -9256,7 +9298,7 @@ Format: roles/{role} </p></td>For users, the member should be: users/{email}For groups, the member should be: groups/{email} </p></td></tr>-+<tr><td>condition</td><td><a href="#google.type.Expr">google.type.Expr</a></td>@@ -9265,24 +9307,24 @@ For groups, the member should be: groups/{email} </p></td>If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.IamPolicy">IamPolicy</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>bindings</td><td><a href="#bytebase.store.Binding">Binding</a></td>@@ -9290,48 +9332,48 @@ If the condition evaluates to false, then this binding does not apply to the cur<td><p>Collection of binding.A binding binds one or more members or groups to a single role. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.MaskingExemptionPolicy">MaskingExemptionPolicy</h3><p>MaskingExemptionPolicy is the allowlist of users who can access sensitive data.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>exemptions</td><td><a href="#bytebase.store.MaskingExemptionPolicy.Exemption">MaskingExemptionPolicy.Exemption</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.MaskingExemptionPolicy.Exemption">MaskingExemptionPolicy.Exemption</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>members</td><td><a href="#string">string</a></td>@@ -9340,7 +9382,7 @@ A binding binds one or more members or groups to a single role. </p></td>Format: users/{email} or groups/{group email} </p></td></tr>-+<tr><td>condition</td><td><a href="#google.type.Expr">google.type.Expr</a></td>@@ -9362,93 +9404,93 @@ For example:resource.instance_id == "local" && resource.database_name == "employee" && request.time < timestamp("2025-04-30T11:10:39.000Z")resource.instance_id == "local" && resource.database_name == "employee" </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.MaskingRulePolicy">MaskingRulePolicy</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>rules</td><td><a href="#bytebase.store.MaskingRulePolicy.MaskingRule">MaskingRulePolicy.MaskingRule</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.MaskingRulePolicy.MaskingRule">MaskingRulePolicy.MaskingRule</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>id</td><td><a href="#string">string</a></td><td></td><td><p>A unique identifier for a node in UUID format. </p></td></tr>-+<tr><td>condition</td><td><a href="#google.type.Expr">google.type.Expr</a></td><td></td><td><p> </p></td></tr>-+<tr><td>semantic_type</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.Policy">Policy</h3><p></p>---+++<h3 id="bytebase.store.QueryDataPolicy">QueryDataPolicy</h3><p>QueryDataPolicy is the policy configuration for querying data in the SQL Editor.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>disable_export</td><td><a href="#bool">bool</a></td>@@ -9456,7 +9498,7 @@ resource.instance_id == "local" && resource.database_name == <td><p>workspace-level policyDisable exporting data in the SQL editor. </p></td></tr>-+<tr><td>maximum_result_rows</td><td><a href="#int32">int32</a></td>@@ -9465,7 +9507,7 @@ Disable exporting data in the SQL editor. </p></td>The maximum number of rows to return in the SQL editor.The default value <= 0, means no limit. </p></td></tr>-+<tr><td>disable_copy_data</td><td><a href="#bool">bool</a></td>@@ -9473,7 +9515,7 @@ The default value <= 0, means no limit. </p></td><td><p>workspace-level policyDisable copying data. </p></td></tr>-+<tr><td>allow_admin_data_source</td><td><a href="#bool">bool</a></td>@@ -9481,7 +9523,7 @@ Disable copying data. </p></td><td><p>workspace-level policyAllow using the admin data source to query in the SQL editor. </p></td></tr>-+<tr><td>disallow_ddl</td><td><a href="#bool">bool</a></td>@@ -9490,62 +9532,62 @@ Allow using the admin data source to query in the SQL editor. </p></td>Deprecate following fields.Disallow running DDL statements in the SQL editor. </p></td></tr>-+<tr><td>disallow_dml</td><td><a href="#bool">bool</a></td><td></td><td><p>Disallow running DML statements in the SQL editor. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.RolloutPolicy">RolloutPolicy</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>automatic</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>roles</td><td><a href="#string">string</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.TagPolicy">TagPolicy</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>tags</td><td><a href="#bytebase.store.TagPolicy.TagsEntry">TagPolicy.TagsEntry</a></td>@@ -9553,47 +9595,47 @@ Disallow running DDL statements in the SQL editor. </p></td><td><p>tags is the key-value map for resources.For example, the environment resource can have the SQL review config tag, such as "bb.tag.review_config": "reviewConfigs/{review config resource id}". </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.TagPolicy.TagsEntry">TagPolicy.TagsEntry</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.store.Policy.Resource">Policy.Resource</h3><p></p><table class="enum-table">@@ -9601,34 +9643,34 @@ For example, the environment resource can have the SQL review config tag, such a<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>RESOURCE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>WORKSPACE</td><td>1</td><td><p></p></td></tr>-+<tr><td>ENVIRONMENT</td><td>2</td><td><p></p></td></tr>-+<tr><td>PROJECT</td><td>3</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.Policy.Type">Policy.Type</h3><p></p><table class="enum-table">@@ -9636,133 +9678,133 @@ For example, the environment resource can have the SQL review config tag, such a<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>ROLLOUT</td><td>1</td><td><p></p></td></tr>-+<tr><td>MASKING_EXEMPTION</td><td>2</td><td><p></p></td></tr>-+<tr><td>QUERY_DATA</td><td>3</td><td><p></p></td></tr>-+<tr><td>MASKING_RULE</td><td>4</td><td><p></p></td></tr>-+<tr><td>IAM</td><td>5</td><td><p></p></td></tr>-+<tr><td>TAG</td><td>6</td><td><p></p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="store/project.proto">store/project.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.Label">Label</h3><p>Label represents a categorization tag that can be applied to issues.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>value</td><td><a href="#string">string</a></td><td></td><td><p>The display text of the label. </p></td></tr>-+<tr><td>color</td><td><a href="#string">string</a></td><td></td><td><p>The color for the label in hex format (e.g., "#FF0000"). </p></td></tr>-+<tr><td>group</td><td><a href="#string">string</a></td><td></td><td><p>Optional group name for organizing related labels. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.Project">Project</h3><p>Project contains settings and configuration for a Bytebase project.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>issue_labels</td><td><a href="#bytebase.store.Label">Label</a></td><td>repeated</td><td><p>Available labels that can be applied to issues in this project. </p></td></tr>-+<tr><td>force_issue_labels</td><td><a href="#bool">bool</a></td><td></td><td><p>Force issue labels to be used when creating an issue. </p></td></tr>-+<tr><td>enforce_issue_title</td><td><a href="#bool">bool</a></td><td></td><td><p>Enforce issue title created by user instead of generated by Bytebase. </p></td></tr>-+<tr><td>postgres_database_tenant_mode</td><td><a href="#bool">bool</a></td>@@ -9770,21 +9812,21 @@ For example, the environment resource can have the SQL review config tag, such a<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></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></tr>-+<tr><td>execution_retry_policy</td><td><a href="#bytebase.store.Project.ExecutionRetryPolicy">Project.ExecutionRetryPolicy</a></td><td></td><td><p>Configuration for automatic retry on task execution failures. </p></td></tr>-+<tr><td>ci_sampling_size</td><td><a href="#int32">int32</a></td>@@ -9792,14 +9834,14 @@ If enabled, the issue will be created with the prepend "set role <db_owne<td><p>The maximum number of databases to sample during CI data validation.If not specified, sampling is disabled, resulting in a 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></tr>-+<tr><td>labels</td><td><a href="#bytebase.store.Project.LabelsEntry">Project.LabelsEntry</a></td>@@ -9807,7 +9849,7 @@ If not specified, sampling is disabled, resulting in a full validation. </p></td<td><p>Labels are key-value pairs that can be attached to the project.For example, { "environment": "production", "team": "backend" } </p></td></tr>-+<tr><td>enforce_sql_review</td><td><a href="#bool">bool</a></td>@@ -9815,163 +9857,163 @@ For example, { "environment": "production", "team": "<td><p>Whether to enforce SQL review checks to pass before issue creation.If enabled, issues cannot be created when SQL review finds errors. </p></td></tr>-+<tr><td>require_issue_approval</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether issue approval is required before proceeding with rollout. </p></td></tr>-+<tr><td>require_plan_check_no_error</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether to block rollout when plan check finds errors. </p></td></tr>-+<tr><td>allow_request_role</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>data_classification_config_id</td><td><a href="#string">string</a></td><td></td><td><p>The data classification configuration ID for the project. </p></td></tr>-+<tr><td>allow_just_in_time_access</td><td><a href="#bool">bool</a></td><td></td><td><p>Once enabled, users can request and use the just-in-time access in the SQL Editor. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.Project.ExecutionRetryPolicy">Project.ExecutionRetryPolicy</h3><p>ExecutionRetryPolicy defines retry behavior for failed task executions.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>maximum_retries</td><td><a href="#int32">int32</a></td><td></td><td><p>The maximum number of retry attempts for lock timeout errors. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.Project.LabelsEntry">Project.LabelsEntry</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>--------++++++++<div class="file-heading"><h2 id="store/project_webhook.proto">store/project_webhook.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.Activity">Activity</h3><p>Activity types for webhook notifications.</p>---+++<h3 id="bytebase.store.ProjectWebhook">ProjectWebhook</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>type</td><td><a href="#bytebase.store.WebhookType">WebhookType</a></td><td></td><td><p>Webhook type. </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>Webhook title. </p></td></tr>-+<tr><td>url</td><td><a href="#string">string</a></td><td></td><td><p>Webhook URL. </p></td></tr>-+<tr><td>activities</td><td><a href="#bytebase.store.Activity.Type">Activity.Type</a></td><td>repeated</td><td><p>List of activities that trigger this webhook. </p></td></tr>-+<tr><td>direct_message</td><td><a href="#bool">bool</a></td>@@ -9980,16 +10022,16 @@ If enabled, issues cannot be created when SQL review finds errors. </p></td>to the persons and url will be ignored.IM integration setting should be set for this function to work. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.store.Activity.Type">Activity.Type</h3><p>Activity type enumeration.</p><table class="enum-table">@@ -9997,494 +10039,494 @@ IM integration setting should be set for this function to work. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p>Unspecified type.</p></td></tr>-+<tr><td>ISSUE_CREATED</td><td>10</td><td><p>ISSUE_CREATED represents a new issue creation event.</p></td></tr>-+<tr><td>ISSUE_APPROVAL_REQUESTED</td><td>11</td><td><p>ISSUE_APPROVAL_REQUESTED represents an approval request event.</p></td></tr>-+<tr><td>ISSUE_SENT_BACK</td><td>12</td><td><p>ISSUE_SENT_BACK represents an issue being sent back by an approver.</p></td></tr>-+<tr><td>PIPELINE_FAILED</td><td>13</td><td><p>PIPELINE_FAILED represents a pipeline failure event.</p></td></tr>-+<tr><td>PIPELINE_COMPLETED</td><td>14</td><td><p>PIPELINE_COMPLETED represents a pipeline completion event.</p></td></tr>-+<tr><td>ISSUE_APPROVED</td><td>15</td><td><p>ISSUE_APPROVED represents an issue being fully approved.</p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="store/query_history.proto">store/query_history.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.QueryHistoryPayload">QueryHistoryPayload</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>error</td><td><a href="#string">string</a></td><td>optional</td><td><p> </p></td></tr>-+<tr><td>duration</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>--------++++++++<div class="file-heading"><h2 id="store/release.proto">store/release.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.ReleasePayload">ReleasePayload</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>files</td><td><a href="#bytebase.store.ReleasePayload.File">ReleasePayload.File</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>vcs_source</td><td><a href="#bytebase.store.ReleasePayload.VCSSource">ReleasePayload.VCSSource</a></td><td></td><td><p> </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.store.SchemaChangeType">SchemaChangeType</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.ReleasePayload.File">ReleasePayload.File</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>path</td><td><a href="#string">string</a></td><td></td><td><p>The path of the file, e.g., `2.2/V0001_create_table.sql`. </p></td></tr>-+<tr><td>sheet_sha256</td><td><a href="#string">string</a></td><td></td><td><p>The SHA256 hash of the sheet content (hex-encoded). </p></td></tr>-+<tr><td>version</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.ReleasePayload.VCSSource">ReleasePayload.VCSSource</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>vcs_type</td><td><a href="#bytebase.store.VCSType">VCSType</a></td><td></td><td><p> </p></td></tr>-+<tr><td>url</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>--------++++++++<div class="file-heading"><h2 id="store/review_config.proto">store/review_config.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.ReviewConfigPayload">ReviewConfigPayload</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>sql_review_rules</td><td><a href="#bytebase.store.SQLReviewRule">SQLReviewRule</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.SQLReviewRule">SQLReviewRule</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>type</td><td><a href="#bytebase.store.SQLReviewRule.Type">SQLReviewRule.Type</a></td><td></td><td><p> </p></td></tr>-+<tr><td>level</td><td><a href="#bytebase.store.SQLReviewRule.Level">SQLReviewRule.Level</a></td><td></td><td><p> </p></td></tr>-+<tr><td>naming_payload</td><td><a href="#bytebase.store.SQLReviewRule.NamingRulePayload">SQLReviewRule.NamingRulePayload</a></td><td></td><td><p> </p></td></tr>-+<tr><td>number_payload</td><td><a href="#bytebase.store.SQLReviewRule.NumberRulePayload">SQLReviewRule.NumberRulePayload</a></td><td></td><td><p> </p></td></tr>-+<tr><td>string_array_payload</td><td><a href="#bytebase.store.SQLReviewRule.StringArrayRulePayload">SQLReviewRule.StringArrayRulePayload</a></td><td></td><td><p> </p></td></tr>-+<tr><td>comment_convention_payload</td><td><a href="#bytebase.store.SQLReviewRule.CommentConventionRulePayload">SQLReviewRule.CommentConventionRulePayload</a></td><td></td><td><p> </p></td></tr>-+<tr><td>string_payload</td><td><a href="#bytebase.store.SQLReviewRule.StringRulePayload">SQLReviewRule.StringRulePayload</a></td><td></td><td><p> </p></td></tr>-+<tr><td>naming_case_payload</td><td><a href="#bytebase.store.SQLReviewRule.NamingCaseRulePayload">SQLReviewRule.NamingCaseRulePayload</a></td><td></td><td><p> </p></td></tr>-+<tr><td>engine</td><td><a href="#bytebase.store.Engine">Engine</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.SQLReviewRule.CommentConventionRulePayload">SQLReviewRule.CommentConventionRulePayload</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>required</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>max_length</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.SQLReviewRule.NamingCaseRulePayload">SQLReviewRule.NamingCaseRulePayload</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>upper</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.SQLReviewRule.NamingRulePayload">SQLReviewRule.NamingRulePayload</h3><p>Payload message types for SQL review rules</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>max_length</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>format</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.SQLReviewRule.NumberRulePayload">SQLReviewRule.NumberRulePayload</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>number</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.SQLReviewRule.StringArrayRulePayload">SQLReviewRule.StringArrayRulePayload</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>list</td><td><a href="#string">string</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.SQLReviewRule.StringRulePayload">SQLReviewRule.StringRulePayload</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>value</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.store.SQLReviewRule.Level">SQLReviewRule.Level</h3><p>The severity level for SQL review rules.</p><table class="enum-table">@@ -10492,28 +10534,28 @@ IM integration setting should be set for this function to work. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>LEVEL_UNSPECIFIED</td><td>0</td><td><p>Unspecified level.</p></td></tr>-+<tr><td>ERROR</td><td>1</td><td><p>Rule violation is an error.</p></td></tr>-+<tr><td>WARNING</td><td>2</td><td><p>Rule violation is a warning.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.SQLReviewRule.Type">SQLReviewRule.Type</h3><p></p><table class="enum-table">@@ -10521,704 +10563,704 @@ IM integration setting should be set for this function to work. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>ENGINE_MYSQL_USE_INNODB</td><td>1</td><td><p></p></td></tr>-+<tr><td>NAMING_FULLY_QUALIFIED</td><td>2</td><td><p></p></td></tr>-+<tr><td>NAMING_TABLE</td><td>3</td><td><p></p></td></tr>-+<tr><td>NAMING_COLUMN</td><td>4</td><td><p></p></td></tr>-+<tr><td>NAMING_INDEX_PK</td><td>5</td><td><p></p></td></tr>-+<tr><td>NAMING_INDEX_UK</td><td>6</td><td><p></p></td></tr>-+<tr><td>NAMING_INDEX_FK</td><td>7</td><td><p></p></td></tr>-+<tr><td>NAMING_INDEX_IDX</td><td>8</td><td><p></p></td></tr>-+<tr><td>NAMING_COLUMN_AUTO_INCREMENT</td><td>9</td><td><p></p></td></tr>-+<tr><td>NAMING_TABLE_NO_KEYWORD</td><td>10</td><td><p></p></td></tr>-+<tr><td>NAMING_IDENTIFIER_NO_KEYWORD</td><td>11</td><td><p></p></td></tr>-+<tr><td>NAMING_IDENTIFIER_CASE</td><td>12</td><td><p></p></td></tr>-+<tr><td>STATEMENT_SELECT_NO_SELECT_ALL</td><td>13</td><td><p></p></td></tr>-+<tr><td>STATEMENT_WHERE_REQUIRE_SELECT</td><td>14</td><td><p></p></td></tr>-+<tr><td>STATEMENT_WHERE_REQUIRE_UPDATE_DELETE</td><td>15</td><td><p></p></td></tr>-+<tr><td>STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE</td><td>16</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_ON_DEL_CASCADE</td><td>17</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_RM_TBL_CASCADE</td><td>18</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_COMMIT</td><td>19</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_LIMIT</td><td>20</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_ORDER_BY</td><td>21</td><td><p></p></td></tr>-+<tr><td>STATEMENT_MERGE_ALTER_TABLE</td><td>22</td><td><p></p></td></tr>-+<tr><td>STATEMENT_INSERT_ROW_LIMIT</td><td>23</td><td><p></p></td></tr>-+<tr><td>STATEMENT_INSERT_MUST_SPECIFY_COLUMN</td><td>24</td><td><p></p></td></tr>-+<tr><td>STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND</td><td>25</td><td><p></p></td></tr>-+<tr><td>STATEMENT_AFFECTED_ROW_LIMIT</td><td>26</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DML_DRY_RUN</td><td>27</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_ADD_COLUMN_WITH_DEFAULT</td><td>28</td><td><p></p></td></tr>-+<tr><td>STATEMENT_ADD_CHECK_NOT_VALID</td><td>29</td><td><p></p></td></tr>-+<tr><td>STATEMENT_ADD_FOREIGN_KEY_NOT_VALID</td><td>30</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_ADD_NOT_NULL</td><td>31</td><td><p></p></td></tr>-+<tr><td>STATEMENT_SELECT_FULL_TABLE_SCAN</td><td>32</td><td><p></p></td></tr>-+<tr><td>STATEMENT_CREATE_SPECIFY_SCHEMA</td><td>33</td><td><p></p></td></tr>-+<tr><td>STATEMENT_CHECK_SET_ROLE_VARIABLE</td><td>34</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_USING_FILESORT</td><td>35</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_USING_TEMPORARY</td><td>36</td><td><p></p></td></tr>-+<tr><td>STATEMENT_WHERE_NO_EQUAL_NULL</td><td>37</td><td><p></p></td></tr>-+<tr><td>STATEMENT_WHERE_DISALLOW_FUNCTIONS_AND_CALCULATIONS</td><td>38</td><td><p></p></td></tr>-+<tr><td>STATEMENT_QUERY_MINIMUM_PLAN_LEVEL</td><td>39</td><td><p></p></td></tr>-+<tr><td>STATEMENT_WHERE_MAXIMUM_LOGICAL_OPERATOR_COUNT</td><td>40</td><td><p></p></td></tr>-+<tr><td>STATEMENT_MAXIMUM_LIMIT_VALUE</td><td>41</td><td><p></p></td></tr>-+<tr><td>STATEMENT_MAXIMUM_JOIN_TABLE_COUNT</td><td>42</td><td><p></p></td></tr>-+<tr><td>STATEMENT_MAXIMUM_STATEMENTS_IN_TRANSACTION</td><td>43</td><td><p></p></td></tr>-+<tr><td>STATEMENT_JOIN_STRICT_COLUMN_ATTRS</td><td>44</td><td><p></p></td></tr>-+<tr><td>STATEMENT_NON_TRANSACTIONAL</td><td>45</td><td><p></p></td></tr>-+<tr><td>STATEMENT_ADD_COLUMN_WITHOUT_POSITION</td><td>46</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_OFFLINE_DDL</td><td>47</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_CROSS_DB_QUERIES</td><td>48</td><td><p></p></td></tr>-+<tr><td>STATEMENT_MAX_EXECUTION_TIME</td><td>49</td><td><p></p></td></tr>-+<tr><td>STATEMENT_REQUIRE_ALGORITHM_OPTION</td><td>50</td><td><p></p></td></tr>-+<tr><td>STATEMENT_REQUIRE_LOCK_OPTION</td><td>51</td><td><p></p></td></tr>-+<tr><td>STATEMENT_OBJECT_OWNER_CHECK</td><td>52</td><td><p></p></td></tr>-+<tr><td>TABLE_REQUIRE_PK</td><td>53</td><td><p></p></td></tr>-+<tr><td>TABLE_NO_FOREIGN_KEY</td><td>54</td><td><p></p></td></tr>-+<tr><td>TABLE_DROP_NAMING_CONVENTION</td><td>55</td><td><p></p></td></tr>-+<tr><td>TABLE_COMMENT</td><td>56</td><td><p></p></td></tr>-+<tr><td>TABLE_DISALLOW_PARTITION</td><td>57</td><td><p></p></td></tr>-+<tr><td>TABLE_DISALLOW_TRIGGER</td><td>58</td><td><p></p></td></tr>-+<tr><td>TABLE_NO_DUPLICATE_INDEX</td><td>59</td><td><p></p></td></tr>-+<tr><td>TABLE_TEXT_FIELDS_TOTAL_LENGTH</td><td>60</td><td><p></p></td></tr>-+<tr><td>TABLE_DISALLOW_SET_CHARSET</td><td>61</td><td><p></p></td></tr>-+<tr><td>TABLE_DISALLOW_DDL</td><td>62</td><td><p></p></td></tr>-+<tr><td>TABLE_DISALLOW_DML</td><td>63</td><td><p></p></td></tr>-+<tr><td>TABLE_LIMIT_SIZE</td><td>64</td><td><p></p></td></tr>-+<tr><td>TABLE_REQUIRE_CHARSET</td><td>65</td><td><p></p></td></tr>-+<tr><td>TABLE_REQUIRE_COLLATION</td><td>66</td><td><p></p></td></tr>-+<tr><td>COLUMN_REQUIRED</td><td>67</td><td><p></p></td></tr>-+<tr><td>COLUMN_NO_NULL</td><td>68</td><td><p></p></td></tr>-+<tr><td>COLUMN_DISALLOW_CHANGE_TYPE</td><td>69</td><td><p></p></td></tr>-+<tr><td>COLUMN_SET_DEFAULT_FOR_NOT_NULL</td><td>70</td><td><p></p></td></tr>-+<tr><td>COLUMN_DISALLOW_CHANGE</td><td>71</td><td><p></p></td></tr>-+<tr><td>COLUMN_DISALLOW_CHANGING_ORDER</td><td>72</td><td><p></p></td></tr>-+<tr><td>COLUMN_DISALLOW_DROP</td><td>73</td><td><p></p></td></tr>-+<tr><td>COLUMN_DISALLOW_DROP_IN_INDEX</td><td>74</td><td><p></p></td></tr>-+<tr><td>COLUMN_COMMENT</td><td>75</td><td><p></p></td></tr>-+<tr><td>COLUMN_AUTO_INCREMENT_MUST_INTEGER</td><td>76</td><td><p></p></td></tr>-+<tr><td>COLUMN_TYPE_DISALLOW_LIST</td><td>77</td><td><p></p></td></tr>-+<tr><td>COLUMN_DISALLOW_SET_CHARSET</td><td>78</td><td><p></p></td></tr>-+<tr><td>COLUMN_MAXIMUM_CHARACTER_LENGTH</td><td>79</td><td><p></p></td></tr>-+<tr><td>COLUMN_MAXIMUM_VARCHAR_LENGTH</td><td>80</td><td><p></p></td></tr>-+<tr><td>COLUMN_AUTO_INCREMENT_INITIAL_VALUE</td><td>81</td><td><p></p></td></tr>-+<tr><td>COLUMN_AUTO_INCREMENT_MUST_UNSIGNED</td><td>82</td><td><p></p></td></tr>-+<tr><td>COLUMN_CURRENT_TIME_COUNT_LIMIT</td><td>83</td><td><p></p></td></tr>-+<tr><td>COLUMN_REQUIRE_DEFAULT</td><td>84</td><td><p></p></td></tr>-+<tr><td>COLUMN_DEFAULT_DISALLOW_VOLATILE</td><td>85</td><td><p></p></td></tr>-+<tr><td>COLUMN_ADD_NOT_NULL_REQUIRE_DEFAULT</td><td>86</td><td><p></p></td></tr>-+<tr><td>COLUMN_REQUIRE_CHARSET</td><td>87</td><td><p></p></td></tr>-+<tr><td>COLUMN_REQUIRE_COLLATION</td><td>88</td><td><p></p></td></tr>-+<tr><td>SCHEMA_BACKWARD_COMPATIBILITY</td><td>89</td><td><p></p></td></tr>-+<tr><td>DATABASE_DROP_EMPTY_DATABASE</td><td>90</td><td><p></p></td></tr>-+<tr><td>INDEX_NO_DUPLICATE_COLUMN</td><td>91</td><td><p></p></td></tr>-+<tr><td>INDEX_KEY_NUMBER_LIMIT</td><td>92</td><td><p></p></td></tr>-+<tr><td>INDEX_PK_TYPE_LIMIT</td><td>93</td><td><p></p></td></tr>-+<tr><td>INDEX_TYPE_NO_BLOB</td><td>94</td><td><p></p></td></tr>-+<tr><td>INDEX_TOTAL_NUMBER_LIMIT</td><td>95</td><td><p></p></td></tr>-+<tr><td>INDEX_PRIMARY_KEY_TYPE_ALLOWLIST</td><td>96</td><td><p></p></td></tr>-+<tr><td>INDEX_CREATE_CONCURRENTLY</td><td>97</td><td><p></p></td></tr>-+<tr><td>INDEX_TYPE_ALLOW_LIST</td><td>98</td><td><p></p></td></tr>-+<tr><td>INDEX_NOT_REDUNDANT</td><td>99</td><td><p></p></td></tr>-+<tr><td>SYSTEM_CHARSET_ALLOWLIST</td><td>100</td><td><p></p></td></tr>-+<tr><td>SYSTEM_COLLATION_ALLOWLIST</td><td>101</td><td><p></p></td></tr>-+<tr><td>SYSTEM_COMMENT_LENGTH</td><td>102</td><td><p></p></td></tr>-+<tr><td>SYSTEM_PROCEDURE_DISALLOW_CREATE</td><td>103</td><td><p></p></td></tr>-+<tr><td>SYSTEM_EVENT_DISALLOW_CREATE</td><td>104</td><td><p></p></td></tr>-+<tr><td>SYSTEM_VIEW_DISALLOW_CREATE</td><td>105</td><td><p></p></td></tr>-+<tr><td>SYSTEM_FUNCTION_DISALLOW_CREATE</td><td>106</td><td><p></p></td></tr>-+<tr><td>SYSTEM_FUNCTION_DISALLOWED_LIST</td><td>107</td><td><p></p></td></tr>-+<tr><td>ADVICE_ONLINE_MIGRATION</td><td>108</td><td><p></p></td></tr>-+<tr><td>BUILTIN_PRIOR_BACKUP_CHECK</td><td>109</td><td><p></p></td></tr>-+<tr><td>BUILTIN_WALK_THROUGH_CHECK</td><td>110</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_TRUNCATE</td><td>111</td><td><p></p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="store/revision.proto">store/revision.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.RevisionPayload">RevisionPayload</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>release</td><td><a href="#string">string</a></td>@@ -11226,7 +11268,7 @@ IM integration setting should be set for this function to work. </p></td><td><p>Format: projects/{project}/releases/{release}Can be empty. </p></td></tr>-+<tr><td>file</td><td><a href="#string">string</a></td>@@ -11234,14 +11276,14 @@ Can be empty. </p></td><td><p>The file filepath.Can be empty. </p></td></tr>-+<tr><td>sheet_sha256</td><td><a href="#string">string</a></td><td></td><td><p>The SHA256 hash of the sheet content (hex-encoded). </p></td></tr>-+<tr><td>task_run</td><td><a href="#string">string</a></td>@@ -11250,225 +11292,225 @@ Can be empty. </p></td>Can be empty.Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.store.SchemaChangeType">SchemaChangeType</a></td><td></td><td><p>The type of the revision. </p></td></tr>-+</tbody></table>--------++++++++<div class="file-heading"><h2 id="store/role.proto">store/role.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.RolePermissions">RolePermissions</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>permissions</td><td><a href="#string">string</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>--------++++++++<div class="file-heading"><h2 id="store/server_config.proto">store/server_config.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.ServerConfigPayload">ServerConfigPayload</h3><p>ServerConfigPayload stores global server-level infrastructure configuration.</p><p>Only contains settings that are truly cross-workspace and cannot be derived</p><p>from any workspace context (e.g., JWT signing secret).</p><p>All other settings live in per-workspace WORKSPACE_PROFILE.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>auth_secret</td><td><a href="#string">string</a></td><td></td><td><p>Authentication secret for token signing (32-character random string). </p></td></tr>-+</tbody></table>--------++++++++<div class="file-heading"><h2 id="store/setting.proto">store/setting.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.AISetting">AISetting</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>enabled</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>provider</td><td><a href="#bytebase.store.AISetting.Provider">AISetting.Provider</a></td><td></td><td><p> </p></td></tr>-+<tr><td>endpoint</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>api_key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>model</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>version</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.Algorithm">Algorithm</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>full_mask</td><td><a href="#bytebase.store.Algorithm.FullMask">Algorithm.FullMask</a></td><td></td><td><p> </p></td></tr>-+<tr><td>range_mask</td><td><a href="#bytebase.store.Algorithm.RangeMask">Algorithm.RangeMask</a></td><td></td><td><p> </p></td></tr>-+<tr><td>md5_mask</td><td><a href="#bytebase.store.Algorithm.MD5Mask">Algorithm.MD5Mask</a></td><td></td><td><p> </p></td></tr>-+<tr><td>inner_outer_mask</td><td><a href="#bytebase.store.Algorithm.InnerOuterMask">Algorithm.InnerOuterMask</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.Algorithm.FullMask">Algorithm.FullMask</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>substitution</td><td><a href="#string">string</a></td>@@ -11476,93 +11518,93 @@ Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/task<td><p>substitution is the string used to replace the original value, themax length of the string is 16 bytes. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.Algorithm.InnerOuterMask">Algorithm.InnerOuterMask</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>prefix_len</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>suffix_len</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.store.Algorithm.InnerOuterMask.MaskType">Algorithm.InnerOuterMask.MaskType</a></td><td></td><td><p> </p></td></tr>-+<tr><td>substitution</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.Algorithm.MD5Mask">Algorithm.MD5Mask</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>salt</td><td><a href="#string">string</a></td><td></td><td><p>salt is the salt value to generate a different hash that with the word alone. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.Algorithm.RangeMask">Algorithm.RangeMask</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>slices</td><td><a href="#bytebase.store.Algorithm.RangeMask.Slice">Algorithm.RangeMask.Slice</a></td>@@ -11570,24 +11612,24 @@ max length of the string is 16 bytes. </p></td><td><p>We store it as a repeated field to face the fact that the original value may have multiple parts should be masked.But frontend can be started with a single rule easily. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.Algorithm.RangeMask.Slice">Algorithm.RangeMask.Slice</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>start</td><td><a href="#int32">int32</a></td>@@ -11596,7 +11638,7 @@ But frontend can be started with a single rule easily. </p></td>Uses character indices (not byte offsets) for display-oriented masking.Example: For "你好world", character index 2 refers to 'w' (the 3rd character). </p></td></tr>-+<tr><td>end</td><td><a href="#int32">int32</a></td>@@ -11604,345 +11646,345 @@ Example: For "你好world", character index 2 refers to 'w' (the<td><p>end is the end character index (exclusive) of the original value.Uses character indices (not byte offsets) for display-oriented masking. </p></td></tr>-+<tr><td>substitution</td><td><a href="#string">string</a></td><td></td><td><p>OriginalValue[start:end) would be replaced with substitution. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.AppIMSetting">AppIMSetting</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>settings</td><td><a href="#bytebase.store.AppIMSetting.IMSetting">AppIMSetting.IMSetting</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.AppIMSetting.DingTalk">AppIMSetting.DingTalk</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>client_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>client_secret</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>robot_code</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.AppIMSetting.Feishu">AppIMSetting.Feishu</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>app_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>app_secret</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.AppIMSetting.IMSetting">AppIMSetting.IMSetting</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>type</td><td><a href="#bytebase.store.WebhookType">WebhookType</a></td><td></td><td><p> </p></td></tr>-+<tr><td>slack</td><td><a href="#bytebase.store.AppIMSetting.Slack">AppIMSetting.Slack</a></td><td></td><td><p> </p></td></tr>-+<tr><td>feishu</td><td><a href="#bytebase.store.AppIMSetting.Feishu">AppIMSetting.Feishu</a></td><td></td><td><p> </p></td></tr>-+<tr><td>wecom</td><td><a href="#bytebase.store.AppIMSetting.Wecom">AppIMSetting.Wecom</a></td><td></td><td><p> </p></td></tr>-+<tr><td>lark</td><td><a href="#bytebase.store.AppIMSetting.Lark">AppIMSetting.Lark</a></td><td></td><td><p> </p></td></tr>-+<tr><td>dingtalk</td><td><a href="#bytebase.store.AppIMSetting.DingTalk">AppIMSetting.DingTalk</a></td><td></td><td><p> </p></td></tr>-+<tr><td>teams</td><td><a href="#bytebase.store.AppIMSetting.Teams">AppIMSetting.Teams</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.AppIMSetting.Lark">AppIMSetting.Lark</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>app_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>app_secret</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.AppIMSetting.Slack">AppIMSetting.Slack</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>token</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.AppIMSetting.Teams">AppIMSetting.Teams</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>tenant_id</td><td><a href="#string">string</a></td><td></td><td><p>Azure AD tenant ID (Directory ID). </p></td></tr>-+<tr><td>client_id</td><td><a href="#string">string</a></td><td></td><td><p>Azure AD application (client) ID. </p></td></tr>-+<tr><td>client_secret</td><td><a href="#string">string</a></td><td></td><td><p>Azure AD client secret. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.AppIMSetting.Wecom">AppIMSetting.Wecom</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>corp_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>agent_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>secret</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.DataClassificationSetting">DataClassificationSetting</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>configs</td><td><a href="#bytebase.store.DataClassificationSetting.DataClassificationConfig">DataClassificationSetting.DataClassificationConfig</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.DataClassificationSetting.DataClassificationConfig">DataClassificationSetting.DataClassificationConfig</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>id</td><td><a href="#string">string</a></td>@@ -11950,21 +11992,21 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td<td><p>id is the uuid for classification. Each project can chose oneclassification config. </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>levels</td><td><a href="#bytebase.store.DataClassificationSetting.DataClassificationConfig.Level">DataClassificationSetting.DataClassificationConfig.Level</a></td><td>repeated</td><td><p>levels is user defined level list for classification. </p></td></tr>-+<tr><td>classification</td><td><a href="#bytebase.store.DataClassificationSetting.DataClassificationConfig.ClassificationEntry">DataClassificationSetting.DataClassificationConfig.ClassificationEntry</a></td>@@ -11972,259 +12014,259 @@ classification config. </p></td><td><p>classification is the id - DataClassification map.The id should in [0-9]+-[0-9]+-[0-9]+ format. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.DataClassificationSetting.DataClassificationConfig.ClassificationEntry">DataClassificationSetting.DataClassificationConfig.ClassificationEntry</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value</td><td><a href="#bytebase.store.DataClassificationSetting.DataClassificationConfig.DataClassification">DataClassificationSetting.DataClassificationConfig.DataClassification</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.DataClassificationSetting.DataClassificationConfig.DataClassification">DataClassificationSetting.DataClassificationConfig.DataClassification</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>id</td><td><a href="#string">string</a></td><td></td><td><p>id is the classification id in [0-9]+-[0-9]+-[0-9]+ format. </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>level</td><td><a href="#int32">int32</a></td><td>optional</td><td><p>The sensitivity level. Maps to Level.level. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.DataClassificationSetting.DataClassificationConfig.Level">DataClassificationSetting.DataClassificationConfig.Level</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>level</td><td><a href="#int32">int32</a></td><td></td><td><p>The numeric level for ordering. Higher = more sensitive. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.EmailSetting">EmailSetting</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>from</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>from_name</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.store.EmailSetting.Type">EmailSetting.Type</a></td><td></td><td><p> </p></td></tr>-+<tr><td>smtp</td><td><a href="#bytebase.store.EmailSetting.SMTPConfig">EmailSetting.SMTPConfig</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.EmailSetting.SMTPConfig">EmailSetting.SMTPConfig</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>host</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>port</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>username</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>password</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>encryption</td><td><a href="#bytebase.store.EmailSetting.SMTPConfig.Encryption">EmailSetting.SMTPConfig.Encryption</a></td><td></td><td><p> </p></td></tr>-+<tr><td>authentication</td><td><a href="#bytebase.store.EmailSetting.SMTPConfig.Authentication">EmailSetting.SMTPConfig.Authentication</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.EnvironmentSetting">EnvironmentSetting</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>environments</td><td><a href="#bytebase.store.EnvironmentSetting.Environment">EnvironmentSetting.Environment</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.EnvironmentSetting.Environment">EnvironmentSetting.Environment</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>id</td><td><a href="#string">string</a></td>@@ -12233,322 +12275,322 @@ The id should in [0-9]+-[0-9]+-[0-9]+ format. </p></td>This value should be 4-63 characters, and valid charactersare /[a-z][0-9]-/. </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>The display name of the environment. </p></td></tr>-+<tr><td>tags</td><td><a href="#bytebase.store.EnvironmentSetting.Environment.TagsEntry">EnvironmentSetting.Environment.TagsEntry</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>color</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.EnvironmentSetting.Environment.TagsEntry">EnvironmentSetting.Environment.TagsEntry</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.SemanticTypeSetting">SemanticTypeSetting</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>types</td><td><a href="#bytebase.store.SemanticTypeSetting.SemanticType">SemanticTypeSetting.SemanticType</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.SemanticTypeSetting.SemanticType">SemanticTypeSetting.SemanticType</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>id</td><td><a href="#string">string</a></td><td></td><td><p>id is the uuid for semantic type. </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>the title of the semantic type, it should not be empty. </p></td></tr>-+<tr><td>description</td><td><a href="#string">string</a></td><td></td><td><p>the description of the semantic type, it can be empty. </p></td></tr>-+<tr><td>algorithm</td><td><a href="#bytebase.store.Algorithm">Algorithm</a></td><td></td><td><p> </p></td></tr>-+<tr><td>icon</td><td><a href="#string">string</a></td><td></td><td><p>icon is the icon for semantic type, it can be emoji or base64 encoded image. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.SystemSetting">SystemSetting</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>license</td><td><a href="#string">string</a></td><td></td><td><p>Enterprise license JWT token. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.WorkspaceApprovalSetting">WorkspaceApprovalSetting</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>rules</td><td><a href="#bytebase.store.WorkspaceApprovalSetting.Rule">WorkspaceApprovalSetting.Rule</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.WorkspaceApprovalSetting.Rule">WorkspaceApprovalSetting.Rule</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>template</td><td><a href="#bytebase.store.ApprovalTemplate">ApprovalTemplate</a></td><td></td><td><p> </p></td></tr>-+<tr><td>condition</td><td><a href="#google.type.Expr">google.type.Expr</a></td><td></td><td><p> </p></td></tr>-+<tr><td>source</td><td><a href="#bytebase.store.WorkspaceApprovalSetting.Rule.Source">WorkspaceApprovalSetting.Rule.Source</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.WorkspaceProfileSetting">WorkspaceProfileSetting</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>external_url</td><td><a href="#string">string</a></td><td></td><td><p>The external URL is used for sso authentication callback. </p></td></tr>-+<tr><td>disallow_signup</td><td><a href="#bool">bool</a></td><td></td><td><p>Disallow self-service signup, users can only be invited by the owner. </p></td></tr>-+<tr><td>require_2fa</td><td><a href="#bool">bool</a></td><td></td><td><p>Require 2FA for all users. </p></td></tr>-+<tr><td>refresh_token_duration</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td><td><p>The duration for refresh token. Default is 7 days. </p></td></tr>-+<tr><td>announcement</td><td><a href="#bytebase.store.WorkspaceProfileSetting.Announcement">WorkspaceProfileSetting.Announcement</a></td><td></td><td><p>The setting of custom announcement </p></td></tr>-+<tr><td>maximum_role_expiration</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td><td><p>The max duration for role expired. </p></td></tr>-+<tr><td>domains</td><td><a href="#string">string</a></td><td>repeated</td><td><p>The workspace domain, e.g., bytebase.com. </p></td></tr>-+<tr><td>enforce_identity_domain</td><td><a href="#bool">bool</a></td><td></td><td><p>Only user and group from the domains can be created and login. </p></td></tr>-+<tr><td>database_change_mode</td><td><a href="#bytebase.store.WorkspaceProfileSetting.DatabaseChangeMode">WorkspaceProfileSetting.DatabaseChangeMode</a></td><td></td><td><p>The workspace database change mode. </p></td></tr>-+<tr><td>disallow_password_signin</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether to disallow password signin. (Except workspace admins) </p></td></tr>-+<tr><td>enable_metric_collection</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether to enable metric collection for the workspace. </p></td></tr>-+<tr><td>inactive_session_timeout</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td><td><p>The session expiration time if not activity detected for the user. Value <= 0 means no limit. </p></td></tr>-+<tr><td>enable_audit_log_stdout</td><td><a href="#bool">bool</a></td>@@ -12556,7 +12598,7 @@ are /[a-z][0-9]-/. </p></td><td><p>Whether to enable audit logging to stdout in structured JSON format.Requires TEAM or ENTERPRISE license. </p></td></tr>-+<tr><td>watermark</td><td><a href="#bool">bool</a></td>@@ -12564,35 +12606,35 @@ Requires TEAM or ENTERPRISE license. </p></td><td><p>Whether to display watermark on pages.Requires ENTERPRISE license. </p></td></tr>-+<tr><td>directory_sync_token</td><td><a href="#string">string</a></td><td></td><td><p>The token for directory sync authentication. </p></td></tr>-+<tr><td>password_restriction</td><td><a href="#bytebase.store.WorkspaceProfileSetting.PasswordRestriction">WorkspaceProfileSetting.PasswordRestriction</a></td><td></td><td><p>Password restriction settings. </p></td></tr>-+<tr><td>access_token_duration</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td><td><p>The duration for access token. Default is 1 hour. </p></td></tr>-+<tr><td>enable_debug</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether debug mode is enabled. </p></td></tr>-+<tr><td>sql_result_size</td><td><a href="#int64">int64</a></td>@@ -12600,14 +12642,14 @@ Requires ENTERPRISE license. </p></td><td><p>The maximum result size limit in bytes for query and export, works for the SQL Editor and Export Center.The default value is 100MB, we will use the default value if the setting not exists, or the limit <= 0. </p></td></tr>-+<tr><td>query_timeout</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td><td><p>The query timeout duration for query and export, works for the SQL Editor and Export Center. </p></td></tr>-+<tr><td>allow_email_code_signin</td><td><a href="#bool">bool</a></td>@@ -12615,120 +12657,120 @@ The default value is 100MB, we will use the default value if the setting not exi<td><p>Allow signin/signup using email + a 6-digit one-time verification code.Requires the EMAIL setting to be configured on the workspace. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.WorkspaceProfileSetting.Announcement">WorkspaceProfileSetting.Announcement</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>level</td><td><a href="#bytebase.store.WorkspaceProfileSetting.Announcement.AlertLevel">WorkspaceProfileSetting.Announcement.AlertLevel</a></td><td></td><td><p>The alert level of the announcement. </p></td></tr>-+<tr><td>text</td><td><a href="#string">string</a></td><td></td><td><p>The text of the announcement. </p></td></tr>-+<tr><td>link</td><td><a href="#string">string</a></td><td></td><td><p>The optional link, user can follow the link to check extra details </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.WorkspaceProfileSetting.PasswordRestriction">WorkspaceProfileSetting.PasswordRestriction</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>min_length</td><td><a href="#int32">int32</a></td><td></td><td><p>min_length is the minimum length for password, should be no less than 8. </p></td></tr>-+<tr><td>require_number</td><td><a href="#bool">bool</a></td><td></td><td><p>require_number requires the password must contain at least one number. </p></td></tr>-+<tr><td>require_letter</td><td><a href="#bool">bool</a></td><td></td><td><p>require_letter requires the password must contain at least one letter, regardless of upper case or lower case </p></td></tr>-+<tr><td>require_uppercase_letter</td><td><a href="#bool">bool</a></td><td></td><td><p>require_uppercase_letter requires the password must contain at least one upper case letter. </p></td></tr>-+<tr><td>require_special_character</td><td><a href="#bool">bool</a></td><td></td><td><p>require_special_character requires the password must contain at least one special character. </p></td></tr>-+<tr><td>require_reset_password_for_first_login</td><td><a href="#bool">bool</a></td><td></td><td><p>require_reset_password_for_first_login requires users to reset their password after the 1st login. </p></td></tr>-+<tr><td>password_rotation</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td><td><p>password_rotation requires users to reset their password after the duration. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.store.AISetting.Provider">AISetting.Provider</h3><p></p><table class="enum-table">@@ -12736,40 +12778,40 @@ Requires the EMAIL setting to be configured on the workspace. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>PROVIDER_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>OPEN_AI</td><td>1</td><td><p></p></td></tr>-+<tr><td>CLAUDE</td><td>2</td><td><p></p></td></tr>-+<tr><td>GEMINI</td><td>3</td><td><p></p></td></tr>-+<tr><td>AZURE_OPENAI</td><td>4</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.Algorithm.InnerOuterMask.MaskType">Algorithm.InnerOuterMask.MaskType</h3><p></p><table class="enum-table">@@ -12777,28 +12819,28 @@ Requires the EMAIL setting to be configured on the workspace. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>MASK_TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>INNER</td><td>1</td><td><p></p></td></tr>-+<tr><td>OUTER</td><td>2</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.EmailSetting.SMTPConfig.Authentication">EmailSetting.SMTPConfig.Authentication</h3><p></p><table class="enum-table">@@ -12806,40 +12848,40 @@ Requires the EMAIL setting to be configured on the workspace. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>AUTHENTICATION_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>AUTHENTICATION_NONE</td><td>1</td><td><p></p></td></tr>-+<tr><td>PLAIN</td><td>2</td><td><p></p></td></tr>-+<tr><td>LOGIN</td><td>3</td><td><p></p></td></tr>-+<tr><td>CRAM_MD5</td><td>4</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.EmailSetting.SMTPConfig.Encryption">EmailSetting.SMTPConfig.Encryption</h3><p></p><table class="enum-table">@@ -12847,34 +12889,34 @@ Requires the EMAIL setting to be configured on the workspace. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>ENCRYPTION_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>ENCRYPTION_NONE</td><td>1</td><td><p></p></td></tr>-+<tr><td>STARTTLS</td><td>2</td><td><p></p></td></tr>-+<tr><td>SSL_TLS</td><td>3</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.EmailSetting.Type">EmailSetting.Type</h3><p></p><table class="enum-table">@@ -12882,22 +12924,22 @@ Requires the EMAIL setting to be configured on the workspace. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>SMTP</td><td>1</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.SettingName">SettingName</h3><p></p><table class="enum-table">@@ -12905,70 +12947,70 @@ Requires the EMAIL setting to be configured on the workspace. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>SETTING_NAME_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>SYSTEM</td><td>1</td><td><p></p></td></tr>-+<tr><td>WORKSPACE_PROFILE</td><td>2</td><td><p></p></td></tr>-+<tr><td>WORKSPACE_APPROVAL</td><td>3</td><td><p></p></td></tr>-+<tr><td>APP_IM</td><td>4</td><td><p></p></td></tr>-+<tr><td>AI</td><td>5</td><td><p></p></td></tr>-+<tr><td>DATA_CLASSIFICATION</td><td>6</td><td><p></p></td></tr>-+<tr><td>SEMANTIC_TYPES</td><td>7</td><td><p></p></td></tr>-+<tr><td>ENVIRONMENT</td><td>8</td><td><p></p></td></tr>-+<tr><td>EMAIL</td><td>9</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.WorkspaceApprovalSetting.Rule.Source">WorkspaceApprovalSetting.Rule.Source</h3><p></p><table class="enum-table">@@ -12976,46 +13018,46 @@ Requires the EMAIL setting to be configured on the workspace. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>SOURCE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>CHANGE_DATABASE</td><td>1</td><td><p></p></td></tr>-+<tr><td>CREATE_DATABASE</td><td>2</td><td><p></p></td></tr>-+<tr><td>EXPORT_DATA</td><td>3</td><td><p></p></td></tr>-+<tr><td>REQUEST_ROLE</td><td>4</td><td><p></p></td></tr>-+<tr><td>REQUEST_ACCESS</td><td>5</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.WorkspaceProfileSetting.Announcement.AlertLevel">WorkspaceProfileSetting.Announcement.AlertLevel</h3><p>We support three levels of AlertLevel: INFO, WARNING, and ERROR.</p><table class="enum-table">@@ -13023,34 +13065,34 @@ Requires the EMAIL setting to be configured on the workspace. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>ALERT_LEVEL_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>INFO</td><td>1</td><td><p></p></td></tr>-+<tr><td>WARNING</td><td>2</td><td><p></p></td></tr>-+<tr><td>CRITICAL</td><td>3</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.WorkspaceProfileSetting.DatabaseChangeMode">WorkspaceProfileSetting.DatabaseChangeMode</h3><p></p><table class="enum-table">@@ -13058,81 +13100,81 @@ Requires the EMAIL setting to be configured on the workspace. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>DATABASE_CHANGE_MODE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>PIPELINE</td><td>1</td><td><p>A more advanced database change process, including custom approval workflows and other advanced features.Default to this mode.</p></td></tr>-+<tr><td>EDITOR</td><td>2</td><td><p>A simple database change process in SQL editor. Users can execute SQL directly.</p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="store/signal.proto">store/signal.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.Signal">Signal</h3><p>Signal represents a notification payload sent via PostgreSQL NOTIFY for HA coordination.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>type</td><td><a href="#bytebase.store.Signal.Type">Signal.Type</a></td><td></td><td><p> </p></td></tr>-+<tr><td>uid</td><td><a href="#int64">int64</a></td><td></td><td><p> </p></td></tr>-+<tr><td>project</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.store.Signal.Type">Signal.Type</h3><p>Type represents the type of signal.</p><table class="enum-table">@@ -13140,122 +13182,122 @@ Default to this mode.</p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>CANCEL_PLAN_CHECK_RUN</td><td>1</td><td><p></p></td></tr>-+<tr><td>CANCEL_TASK_RUN</td><td>2</td><td><p></p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="store/subscription.proto">store/subscription.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.SubscriptionPayload">SubscriptionPayload</h3><p>SubscriptionPayload stores all subscription data for a workspace.</p><p>Serialized as JSONB in the subscription table's payload column.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>status</td><td><a href="#bytebase.store.SubscriptionPayload.Status">SubscriptionPayload.Status</a></td><td></td><td><p>Lifecycle </p></td></tr>-+<tr><td>started_at</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>expires_at</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>plan</td><td><a href="#bytebase.store.SubscriptionPayload.Plan">SubscriptionPayload.Plan</a></td><td></td><td><p>Billing details </p></td></tr>-+<tr><td>interval</td><td><a href="#bytebase.store.SubscriptionPayload.BillingInterval">SubscriptionPayload.BillingInterval</a></td><td></td><td><p> </p></td></tr>-+<tr><td>seat</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>instance_count</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>stripe_subscription_id</td><td><a href="#string">string</a></td><td></td><td><p>Stripe integration </p></td></tr>-+<tr><td>stripe_customer_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.store.SubscriptionPayload.BillingInterval">SubscriptionPayload.BillingInterval</h3><p></p><table class="enum-table">@@ -13263,28 +13305,28 @@ Default to this mode.</p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>BILLING_INTERVAL_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>MONTH</td><td>1</td><td><p></p></td></tr>-+<tr><td>YEAR</td><td>2</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.SubscriptionPayload.Plan">SubscriptionPayload.Plan</h3><p></p><table class="enum-table">@@ -13292,28 +13334,28 @@ Default to this mode.</p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>PLAN_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>TEAM</td><td>1</td><td><p></p></td></tr>-+<tr><td>ENTERPRISE</td><td>2</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.SubscriptionPayload.Status">SubscriptionPayload.Status</h3><p></p><table class="enum-table">@@ -13321,77 +13363,77 @@ Default to this mode.</p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>STATUS_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>ACTIVE</td><td>1</td><td><p></p></td></tr>-+<tr><td>PAUSED</td><td>2</td><td><p></p></td></tr>-+<tr><td>CANCELED</td><td>3</td><td><p></p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="store/task.proto">store/task.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.Task">Task</h3><p>Task is the metadata for database operation tasks.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>skipped</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether the task was skipped during execution. </p></td></tr>-+<tr><td>skipped_reason</td><td><a href="#string">string</a></td><td></td><td><p>Reason why the task was skipped. </p></td></tr>-+<tr><td>spec_id</td><td><a href="#string">string</a></td><td></td><td><p>UUID that identifies the spec this task implements. </p></td></tr>-+<tr><td>sheet_sha256</td><td><a href="#string">string</a></td>@@ -13399,7 +13441,7 @@ Default to this mode.</p></td><td><p>The SHA256 hash of a single sheet content (hex-encoded).Used for non-release tasks. </p></td></tr>-+<tr><td>release</td><td><a href="#string">string</a></td>@@ -13407,23 +13449,23 @@ Used for non-release tasks. </p></td><td><p>The release resource name: projects/{project}/releases/{release}.Used for GitOps release-based tasks that execute multiple files. </p></td></tr>-+<tr><td>enable_prior_backup</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether to create an automatic backup before applying changes. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.store.Task.Type">Task.Type</h3><p>Type represents the type of database operation to perform.</p><table class="enum-table">@@ -13431,19 +13473,19 @@ Used for GitOps release-based tasks that execute multiple files. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TASK_TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>DATABASE_CREATE</td><td>1</td><td><p>Create a new database.</p></td></tr>-+<tr><td>DATABASE_MIGRATE</td><td>2</td>@@ -13451,138 +13493,138 @@ Used for GitOps release-based tasks that execute multiple files. </p></td>Execution strategy is determined by release type (VERSIONED/DECLARATIVE)or sheet content for non-release tasks.</p></td></tr>-+<tr><td>DATABASE_EXPORT</td><td>3</td><td><p>Export data from a database.</p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="store/task_run.proto">store/task_run.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.SchedulerInfo">SchedulerInfo</h3><p>SchedulerInfo contains information about task scheduling and execution delays.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>report_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p>Timestamp when the scheduler reported this information. </p></td></tr>-+<tr><td>waiting_cause</td><td><a href="#bytebase.store.SchedulerInfo.WaitingCause">SchedulerInfo.WaitingCause</a></td><td></td><td><p>Reason why the task run is currently waiting. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.SchedulerInfo.WaitingCause">SchedulerInfo.WaitingCause</h3><p>WaitingCause indicates why a task run is waiting to execute.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parallel_tasks_limit</td><td><a href="#bool">bool</a></td><td></td><td><p>Task is waiting due to parallel execution limit. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.TaskRun">TaskRun</h3><p>TaskRun represents an execution attempt of a task.</p>---+++<h3 id="bytebase.store.TaskRunPayload">TaskRunPayload</h3><p>TaskRunPayload contains extensible runtime data for a task run.</p><p>Stored in the payload JSONB column. New fields can be added here</p><p>without database schema changes.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>scheduler_info</td><td><a href="#bytebase.store.SchedulerInfo">SchedulerInfo</a></td><td></td><td><p>Scheduler information about why a task is waiting. </p></td></tr>-+<tr><td>skip_prior_backup</td><td><a href="#bool">bool</a></td><td></td><td><p>If true, prior backup is skipped for this task run. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.TaskRunResult">TaskRunResult</h3><p>TaskRunResult contains the outcome and metadata from a task run execution.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>detail</td><td><a href="#string">string</a></td><td></td><td><p>Error message for failed task runs. Empty for successful or canceled runs. </p></td></tr>-+<tr><td>has_prior_backup</td><td><a href="#bool">bool</a></td>@@ -13591,23 +13633,23 @@ or sheet content for non-release tasks.</p></td>When true, the task run can be rolled back using the backup tables.Backup details are available in the task run logs (PRIOR_BACKUP log entries). </p></td></tr>-+<tr><td>export_archive_id</td><td><a href="#string">string</a></td><td></td><td><p>Resource ID of the export archive generated for export tasks. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.store.TaskRun.Status">TaskRun.Status</h3><p>Status represents the current execution state of a task run.</p><table class="enum-table">@@ -13615,155 +13657,155 @@ Backup details are available in the task run logs (PRIOR_BACKUP log entries). </<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>STATUS_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>PENDING</td><td>1</td><td><p>Task run is queued and waiting to execute.</p></td></tr>-+<tr><td>RUNNING</td><td>2</td><td><p>Task run is currently executing.</p></td></tr>-+<tr><td>DONE</td><td>3</td><td><p>Task run completed successfully.</p></td></tr>-+<tr><td>FAILED</td><td>4</td><td><p>Task run encountered an error and failed.</p></td></tr>-+<tr><td>CANCELED</td><td>5</td><td><p>Task run was canceled by user or system.</p></td></tr>-+<tr><td>NOT_STARTED</td><td>6</td><td><p>Task run has not started yet.</p></td></tr>-+<tr><td>SKIPPED</td><td>7</td><td><p>Task run was skipped and will not execute.</p></td></tr>-+<tr><td>AVAILABLE</td><td>8</td><td><p>Task run is ready for immediate execution.</p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="store/task_run_log.proto">store/task_run_log.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.PriorBackupDetail">PriorBackupDetail</h3><p>PriorBackupDetail contains information about automatic backups created before migration.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>items</td><td><a href="#bytebase.store.PriorBackupDetail.Item">PriorBackupDetail.Item</a></td><td>repeated</td><td><p>List of backup operations performed. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.PriorBackupDetail.Item">PriorBackupDetail.Item</h3><p>Item represents a single backup operation for a table.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>source_table</td><td><a href="#bytebase.store.PriorBackupDetail.Item.Table">PriorBackupDetail.Item.Table</a></td><td></td><td><p>The original table that was backed up. </p></td></tr>-+<tr><td>target_table</td><td><a href="#bytebase.store.PriorBackupDetail.Item.Table">PriorBackupDetail.Item.Table</a></td><td></td><td><p>The backup table where data was copied. </p></td></tr>-+<tr><td>start_position</td><td><a href="#bytebase.store.Position">Position</a></td><td></td><td><p>Starting position in SQL for this backup operation. </p></td></tr>-+<tr><td>end_position</td><td><a href="#bytebase.store.Position">Position</a></td><td></td><td><p>Ending position in SQL for this backup operation. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.PriorBackupDetail.Item.Table">PriorBackupDetail.Item.Table</h3><p>Table identifies a database table.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>database</td><td><a href="#string">string</a></td>@@ -13771,160 +13813,160 @@ Backup details are available in the task run logs (PRIOR_BACKUP log entries). </<td><p>The database containing the table.Format: instances/{instance}/databases/{database} </p></td></tr>-+<tr><td>schema</td><td><a href="#string">string</a></td><td></td><td><p>Schema name (for databases that support schemas). </p></td></tr>-+<tr><td>table</td><td><a href="#string">string</a></td><td></td><td><p>Table name. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.TaskRunLog">TaskRunLog</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>type</td><td><a href="#bytebase.store.TaskRunLog.Type">TaskRunLog.Type</a></td><td></td><td><p> </p></td></tr>-+<tr><td>replica_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>schema_dump_start</td><td><a href="#bytebase.store.TaskRunLog.SchemaDumpStart">TaskRunLog.SchemaDumpStart</a></td><td></td><td><p> </p></td></tr>-+<tr><td>schema_dump_end</td><td><a href="#bytebase.store.TaskRunLog.SchemaDumpEnd">TaskRunLog.SchemaDumpEnd</a></td><td></td><td><p> </p></td></tr>-+<tr><td>command_execute</td><td><a href="#bytebase.store.TaskRunLog.CommandExecute">TaskRunLog.CommandExecute</a></td><td></td><td><p> </p></td></tr>-+<tr><td>command_response</td><td><a href="#bytebase.store.TaskRunLog.CommandResponse">TaskRunLog.CommandResponse</a></td><td></td><td><p> </p></td></tr>-+<tr><td>database_sync_start</td><td><a href="#bytebase.store.TaskRunLog.DatabaseSyncStart">TaskRunLog.DatabaseSyncStart</a></td><td></td><td><p> </p></td></tr>-+<tr><td>database_sync_end</td><td><a href="#bytebase.store.TaskRunLog.DatabaseSyncEnd">TaskRunLog.DatabaseSyncEnd</a></td><td></td><td><p> </p></td></tr>-+<tr><td>transaction_control</td><td><a href="#bytebase.store.TaskRunLog.TransactionControl">TaskRunLog.TransactionControl</a></td><td></td><td><p> </p></td></tr>-+<tr><td>prior_backup_start</td><td><a href="#bytebase.store.TaskRunLog.PriorBackupStart">TaskRunLog.PriorBackupStart</a></td><td></td><td><p> </p></td></tr>-+<tr><td>prior_backup_end</td><td><a href="#bytebase.store.TaskRunLog.PriorBackupEnd">TaskRunLog.PriorBackupEnd</a></td><td></td><td><p> </p></td></tr>-+<tr><td>retry_info</td><td><a href="#bytebase.store.TaskRunLog.RetryInfo">TaskRunLog.RetryInfo</a></td><td></td><td><p> </p></td></tr>-+<tr><td>compute_diff_start</td><td><a href="#bytebase.store.TaskRunLog.ComputeDiffStart">TaskRunLog.ComputeDiffStart</a></td><td></td><td><p> </p></td></tr>-+<tr><td>compute_diff_end</td><td><a href="#bytebase.store.TaskRunLog.ComputeDiffEnd">TaskRunLog.ComputeDiffEnd</a></td><td></td><td><p> </p></td></tr>-+<tr><td>release_file_execute</td><td><a href="#bytebase.store.TaskRunLog.ReleaseFileExecute">TaskRunLog.ReleaseFileExecute</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.TaskRunLog.CommandExecute">TaskRunLog.CommandExecute</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>range</td><td><a href="#bytebase.store.Range">Range</a></td>@@ -13933,45 +13975,45 @@ Format: instances/{instance}/databases/{database} </p></td>Uses byte offsets (not character indices) for efficient slicing of sheet content bytes.Example: For "SELECT 你好;" in a UTF-8 sheet, range [0, 13) represents all 13 bytes. </p></td></tr>-+<tr><td>statement</td><td><a href="#string">string</a></td><td></td><td><p>The statement to be executed. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.TaskRunLog.CommandResponse">TaskRunLog.CommandResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>error</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>affected_rows</td><td><a href="#int64">int64</a></td><td></td><td><p> </p></td></tr>-+<tr><td>all_affected_rows</td><td><a href="#int64">int64</a></td>@@ -13979,247 +14021,247 @@ Example: For "SELECT 你好;" in a UTF-8 sheet, range [0, 13) represents<td><p>`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. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.TaskRunLog.ComputeDiffEnd">TaskRunLog.ComputeDiffEnd</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>error</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.TaskRunLog.ComputeDiffStart">TaskRunLog.ComputeDiffStart</h3><p></p>---+++<h3 id="bytebase.store.TaskRunLog.DatabaseSyncEnd">TaskRunLog.DatabaseSyncEnd</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>error</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.TaskRunLog.DatabaseSyncStart">TaskRunLog.DatabaseSyncStart</h3><p></p>---+++<h3 id="bytebase.store.TaskRunLog.PriorBackupEnd">TaskRunLog.PriorBackupEnd</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>prior_backup_detail</td><td><a href="#bytebase.store.PriorBackupDetail">PriorBackupDetail</a></td><td></td><td><p> </p></td></tr>-+<tr><td>error</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.TaskRunLog.PriorBackupStart">TaskRunLog.PriorBackupStart</h3><p></p>---+++<h3 id="bytebase.store.TaskRunLog.ReleaseFileExecute">TaskRunLog.ReleaseFileExecute</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>version</td><td><a href="#string">string</a></td><td></td><td><p>The version of the file being executed (e.g., "0001"). </p></td></tr>-+<tr><td>file_path</td><td><a href="#string">string</a></td><td></td><td><p>The file path within the release (e.g., "2.2/V0001_create_table.sql"). </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.TaskRunLog.RetryInfo">TaskRunLog.RetryInfo</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>error</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>retry_count</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>maximum_retries</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.TaskRunLog.SchemaDumpEnd">TaskRunLog.SchemaDumpEnd</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>error</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.TaskRunLog.SchemaDumpStart">TaskRunLog.SchemaDumpStart</h3><p></p>---+++<h3 id="bytebase.store.TaskRunLog.TransactionControl">TaskRunLog.TransactionControl</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>type</td><td><a href="#bytebase.store.TaskRunLog.TransactionControl.Type">TaskRunLog.TransactionControl.Type</a></td><td></td><td><p> </p></td></tr>-+<tr><td>error</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.store.TaskRunLog.TransactionControl.Type">TaskRunLog.TransactionControl.Type</h3><p></p><table class="enum-table">@@ -14227,34 +14269,34 @@ Example: For "SELECT 你好;" in a UTF-8 sheet, range [0, 13) represents<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>BEGIN</td><td>1</td><td><p></p></td></tr>-+<tr><td>COMMIT</td><td>2</td><td><p></p></td></tr>-+<tr><td>ROLLBACK</td><td>3</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.TaskRunLog.Type">TaskRunLog.Type</h3><p></p><table class="enum-table">@@ -14262,189 +14304,189 @@ Example: For "SELECT 你好;" in a UTF-8 sheet, range [0, 13) represents<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>SCHEMA_DUMP_START</td><td>1</td><td><p></p></td></tr>-+<tr><td>SCHEMA_DUMP_END</td><td>2</td><td><p></p></td></tr>-+<tr><td>COMMAND_EXECUTE</td><td>3</td><td><p></p></td></tr>-+<tr><td>COMMAND_RESPONSE</td><td>4</td><td><p></p></td></tr>-+<tr><td>DATABASE_SYNC_START</td><td>5</td><td><p></p></td></tr>-+<tr><td>DATABASE_SYNC_END</td><td>6</td><td><p></p></td></tr>-+<tr><td>TRANSACTION_CONTROL</td><td>8</td><td><p></p></td></tr>-+<tr><td>PRIOR_BACKUP_START</td><td>9</td><td><p></p></td></tr>-+<tr><td>PRIOR_BACKUP_END</td><td>10</td><td><p></p></td></tr>-+<tr><td>RETRY_INFO</td><td>11</td><td><p></p></td></tr>-+<tr><td>COMPUTE_DIFF_START</td><td>12</td><td><p></p></td></tr>-+<tr><td>COMPUTE_DIFF_END</td><td>13</td><td><p></p></td></tr>-+<tr><td>RELEASE_FILE_EXECUTE</td><td>14</td><td><p></p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="store/user.proto">store/user.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.MFAConfig">MFAConfig</h3><p>MFAConfig is the MFA configuration for a user.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>otp_secret</td><td><a href="#string">string</a></td><td></td><td><p>The otp_secret is the secret key used to validate the OTP code. </p></td></tr>-+<tr><td>temp_otp_secret</td><td><a href="#string">string</a></td><td></td><td><p>The temp_otp_secret is the temporary secret key used to validate the OTP code and will replace the otp_secret in two-phase commits. </p></td></tr>-+<tr><td>recovery_codes</td><td><a href="#string">string</a></td><td>repeated</td><td><p>The recovery_codes are the codes that can be used to recover the account. </p></td></tr>-+<tr><td>temp_recovery_codes</td><td><a href="#string">string</a></td><td>repeated</td><td><p>The temp_recovery_codes are the temporary codes that will replace the recovery_codes in two-phase commits. </p></td></tr>-+<tr><td>temp_otp_secret_created_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p>The temp_otp_secret_created_time is the timestamp when temp_otp_secret was created. Used to enforce expiration. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.UserProfile">UserProfile</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>last_login_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>last_change_password_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>source</td><td><a href="#string">string</a></td><td></td><td><p>The source indicates where the user comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID. </p></td></tr>-+<tr><td>last_login_workspace</td><td><a href="#string">string</a></td>@@ -14452,61 +14494,61 @@ Example: For "SELECT 你好;" in a UTF-8 sheet, range [0, 13) represents<td><p>The workspace resource ID the user last logged into.Used to auto-select workspace on next login instead of requiring a workspace picker. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.store.WorkloadIdentityConfig">WorkloadIdentityConfig</h3><p>WorkloadIdentityConfig stores OIDC configuration for workload identity.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>provider_type</td><td><a href="#bytebase.store.WorkloadIdentityConfig.ProviderType">WorkloadIdentityConfig.ProviderType</a></td><td></td><td><p>Provider type (currently only GITHUB is supported) </p></td></tr>-+<tr><td>issuer_url</td><td><a href="#string">string</a></td><td></td><td><p>OIDC issuer URL </p></td></tr>-+<tr><td>allowed_audiences</td><td><a href="#string">string</a></td><td>repeated</td><td><p>Allowed audiences for token validation </p></td></tr>-+<tr><td>subject_pattern</td><td><a href="#string">string</a></td><td></td><td><p>Subject pattern to match against token subject claim </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.store.PrincipalType">PrincipalType</h3><p>PrincipalType is the type of a principal.</p><table class="enum-table">@@ -14514,34 +14556,34 @@ Used to auto-select workspace on next login instead of requiring a workspace pic<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>PRINCIPAL_TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>END_USER</td><td>1</td><td><p>END_USER represents the human being using Bytebase.</p></td></tr>-+<tr><td>WORKLOAD_IDENTITY</td><td>2</td><td><p>WORKLOAD_IDENTITY represents external CI/CD workload identity.</p></td></tr>-+<tr><td>SERVICE_ACCOUNT</td><td>3</td><td><p>SERVICE_ACCOUNT represents the external service calling Bytebase OpenAPI.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.store.WorkloadIdentityConfig.ProviderType">WorkloadIdentityConfig.ProviderType</h3><p>ProviderType identifies the CI/CD platform.</p><table class="enum-table">@@ -14549,57 +14591,57 @@ Used to auto-select workspace on next login instead of requiring a workspace pic<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>PROVIDER_TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>GITHUB</td><td>1</td><td><p></p></td></tr>-+<tr><td>GITLAB</td><td>2</td><td><p></p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="store/worksheet.proto">store/worksheet.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.WorkSheetOrganizerPayload">WorkSheetOrganizerPayload</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>starred</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>folders</td><td><a href="#string">string</a></td>@@ -14607,66 +14649,66 @@ Used to auto-select workspace on next login instead of requiring a workspace pic<td><p>The folder path for a worksheet.For example, if the folders is [A, B, C], means the worksheet is in the A/B/C subfolder. </p></td></tr>-+</tbody></table>--------++++++++<div class="file-heading"><h2 id="store/workspace.proto">store/workspace.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.store.WorkspacePayload">WorkspacePayload</h3><p>WorkspacePayload stores workspace-level metadata.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>logo</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>-------+++++++<h2 id="scalar-value-types">Scalar Value Types</h2><table class="scalar-value-types-table">@@ -14674,7 +14716,7 @@ For example, if the folders is [A, B, C], means the worksheet is in the A/B/C su<tr><td>.proto Type</td><td>Notes</td><td>C++</td><td>Java</td><td>Python</td><td>Go</td><td>C#</td><td>PHP</td><td>Ruby</td></tr></thead><tbody>-+<tr id="double"><td>double</td><td></td>@@ -14686,7 +14728,7 @@ For example, if the folders is [A, B, C], means the worksheet is in the A/B/C su<td>float</td><td>Float</td></tr>-+<tr id="float"><td>float</td><td></td>@@ -14698,7 +14740,7 @@ For example, if the folders is [A, B, C], means the worksheet is in the A/B/C su<td>float</td><td>Float</td></tr>-+<tr id="int32"><td>int32</td><td>Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.</td>@@ -14710,7 +14752,7 @@ For example, if the folders is [A, B, C], means the worksheet is in the A/B/C su<td>integer</td><td>Bignum or Fixnum (as required)</td></tr>-+<tr id="int64"><td>int64</td><td>Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.</td>@@ -14722,7 +14764,7 @@ For example, if the folders is [A, B, C], means the worksheet is in the A/B/C su<td>integer/string</td><td>Bignum</td></tr>-+<tr id="uint32"><td>uint32</td><td>Uses variable-length encoding.</td>@@ -14734,7 +14776,7 @@ For example, if the folders is [A, B, C], means the worksheet is in the A/B/C su<td>integer</td><td>Bignum or Fixnum (as required)</td></tr>-+<tr id="uint64"><td>uint64</td><td>Uses variable-length encoding.</td>@@ -14746,7 +14788,7 @@ For example, if the folders is [A, B, C], means the worksheet is in the A/B/C su<td>integer/string</td><td>Bignum or Fixnum (as required)</td></tr>-+<tr id="sint32"><td>sint32</td><td>Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.</td>@@ -14758,7 +14800,7 @@ For example, if the folders is [A, B, C], means the worksheet is in the A/B/C su<td>integer</td><td>Bignum or Fixnum (as required)</td></tr>-+<tr id="sint64"><td>sint64</td><td>Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.</td>@@ -14770,7 +14812,7 @@ For example, if the folders is [A, B, C], means the worksheet is in the A/B/C su<td>integer/string</td><td>Bignum</td></tr>-+<tr id="fixed32"><td>fixed32</td><td>Always four bytes. More efficient than uint32 if values are often greater than 2^28.</td>@@ -14782,7 +14824,7 @@ For example, if the folders is [A, B, C], means the worksheet is in the A/B/C su<td>integer</td><td>Bignum or Fixnum (as required)</td></tr>-+<tr id="fixed64"><td>fixed64</td><td>Always eight bytes. More efficient than uint64 if values are often greater than 2^56.</td>@@ -14794,7 +14836,7 @@ For example, if the folders is [A, B, C], means the worksheet is in the A/B/C su<td>integer/string</td><td>Bignum</td></tr>-+<tr id="sfixed32"><td>sfixed32</td><td>Always four bytes.</td>@@ -14806,7 +14848,7 @@ For example, if the folders is [A, B, C], means the worksheet is in the A/B/C su<td>integer</td><td>Bignum or Fixnum (as required)</td></tr>-+<tr id="sfixed64"><td>sfixed64</td><td>Always eight bytes.</td>@@ -14818,7 +14860,7 @@ For example, if the folders is [A, B, C], means the worksheet is in the A/B/C su<td>integer/string</td><td>Bignum</td></tr>-+<tr id="bool"><td>bool</td><td></td>@@ -14830,7 +14872,7 @@ For example, if the folders is [A, B, C], means the worksheet is in the A/B/C su<td>boolean</td><td>TrueClass/FalseClass</td></tr>-+<tr id="string"><td>string</td><td>A string must always contain UTF-8 encoded or 7-bit ASCII text.</td>@@ -14842,7 +14884,7 @@ For example, if the folders is [A, B, C], means the worksheet is in the A/B/C su<td>string</td><td>String (UTF-8)</td></tr>-+<tr id="bytes"><td>bytes</td><td>May contain any arbitrary sequence of bytes.</td>@@ -14854,7 +14896,7 @@ For example, if the folders is [A, B, C], means the worksheet is in the A/B/C su<td>string</td><td>String (ASCII-8BIT)</td></tr>-+</tbody></table></body>diff --git a/proto/gen/grpc-doc/v1/README.md b/proto/gen/grpc-doc/v1/README.mdindex 503329587d..5c291e1855 100644--- a/proto/gen/grpc-doc/v1/README.md+++ b/proto/gen/grpc-doc/v1/README.md@@ -4461,6 +4461,15 @@ This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. || 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. |+| ssl_ca_path | [string](#string) | | The local filesystem path to the SSL certificate authority certificate. |+| ssl_cert_path | [string](#string) | | The local filesystem path to the SSL client certificate. |+| ssl_key_path | [string](#string) | | The local filesystem path to the SSL client private key. |+| ssl_ca_set | [bool](#bool) | | Whether an SSL certificate authority certificate has been configured. |+| ssl_cert_set | [bool](#bool) | | Whether an SSL client certificate has been configured. |+| ssl_key_set | [bool](#bool) | | Whether an SSL client private key has been configured. |+| ssl_ca_path_set | [bool](#bool) | | Whether an SSL certificate authority path has been configured. |+| ssl_cert_path_set | [bool](#bool) | | Whether an SSL client certificate path has been configured. |+| ssl_key_path_set | [bool](#bool) | | Whether an SSL client private key path has been configured. || verify_tls_certificate | [bool](#bool) | | verify_tls_certificate enables TLS certificate verification for SSL connections. Default is false (no verification) for backward compatibility. Set to true for secure connections (recommended for production). Only set to false for development or when certificates cannot be properly validated (e.g., self-signed certs, VPN environments). || host | [string](#string) | | The hostname or IP address of the database server. || port | [string](#string) | | The port number of the database server. |diff --git a/proto/gen/grpc-doc/v1/index.html b/proto/gen/grpc-doc/v1/index.htmlindex 88deaf4986..e981ff719c 100644--- a/proto/gen/grpc-doc/v1/index.html+++ b/proto/gen/grpc-doc/v1/index.html@@ -63,57 +63,57 @@}td p:nth-child(1) {- text-indent: 0;+ text-indent: 0;}-- .field-table td:nth-child(1) {++ .field-table td:nth-child(1) {width: 10em;}- .field-table td:nth-child(2) {+ .field-table td:nth-child(2) {width: 10em;}- .field-table td:nth-child(3) {+ .field-table td:nth-child(3) {width: 6em;}- .field-table td:nth-child(4) {+ .field-table td:nth-child(4) {width: auto;}-- .extension-table td:nth-child(1) {++ .extension-table td:nth-child(1) {width: 10em;}- .extension-table td:nth-child(2) {+ .extension-table td:nth-child(2) {width: 10em;}- .extension-table td:nth-child(3) {+ .extension-table td:nth-child(3) {width: 10em;}- .extension-table td:nth-child(4) {+ .extension-table td:nth-child(4) {width: 5em;}- .extension-table td:nth-child(5) {+ .extension-table td:nth-child(5) {width: auto;}-- .enum-table td:nth-child(1) {++ .enum-table td:nth-child(1) {width: 10em;}- .enum-table td:nth-child(2) {+ .enum-table td:nth-child(2) {width: 10em;}- .enum-table td:nth-child(3) {+ .enum-table td:nth-child(3) {width: auto;}-+.scalar-value-types-table tr {height: 3em;}-+#toc-container ul {list-style-type: none;padding-left: 1em;@@ -124,7 +124,7 @@font-weight: bold;}-+.file-heading {width: 100%;display: table;@@ -140,7 +140,7 @@display: table-cell;}-+.badge {width: 1.6em;height: 1.6em;@@ -160,7 +160,7 @@}</style>-+<link rel="stylesheet" type="text/css" href="stylesheet.css"/></head>@@ -172,2875 +172,2875 @@<div id="toc-container"><ul id="toc">--++<li><a href="#v1%2fannotation.proto">v1/annotation.proto</a><ul>--++<li><a href="#bytebase.v1.AuthMethod"><span class="badge">E</span>AuthMethod</a></li>--++<li><a href="#v1%2fannotation.proto-extensions"><span class="badge">X</span>File-level Extensions</a></li>-+<li><a href="#v1%2fannotation.proto-extensions"><span class="badge">X</span>File-level Extensions</a></li>-+<li><a href="#v1%2fannotation.proto-extensions"><span class="badge">X</span>File-level Extensions</a></li>-+<li><a href="#v1%2fannotation.proto-extensions"><span class="badge">X</span>File-level Extensions</a></li>--++</ul></li>--++<li><a href="#v1%2faccess_grant_service.proto">v1/access_grant_service.proto</a><ul>-+<li><a href="#bytebase.v1.AccessGrant"><span class="badge">M</span>AccessGrant</a></li>-+<li><a href="#bytebase.v1.ActivateAccessGrantRequest"><span class="badge">M</span>ActivateAccessGrantRequest</a></li>-+<li><a href="#bytebase.v1.CreateAccessGrantRequest"><span class="badge">M</span>CreateAccessGrantRequest</a></li>-+<li><a href="#bytebase.v1.GetAccessGrantRequest"><span class="badge">M</span>GetAccessGrantRequest</a></li>-+<li><a href="#bytebase.v1.ListAccessGrantsRequest"><span class="badge">M</span>ListAccessGrantsRequest</a></li>-+<li><a href="#bytebase.v1.ListAccessGrantsResponse"><span class="badge">M</span>ListAccessGrantsResponse</a></li>-+<li><a href="#bytebase.v1.RevokeAccessGrantRequest"><span class="badge">M</span>RevokeAccessGrantRequest</a></li>-+<li><a href="#bytebase.v1.SearchMyAccessGrantsRequest"><span class="badge">M</span>SearchMyAccessGrantsRequest</a></li>-+<li><a href="#bytebase.v1.SearchMyAccessGrantsResponse"><span class="badge">M</span>SearchMyAccessGrantsResponse</a></li>--++<li><a href="#bytebase.v1.AccessGrant.Status"><span class="badge">E</span>AccessGrant.Status</a></li>---+++<li><a href="#bytebase.v1.AccessGrantService"><span class="badge">S</span>AccessGrantService</a></li>-+</ul></li>--++<li><a href="#v1%2fcommon.proto">v1/common.proto</a><ul>-+<li><a href="#bytebase.v1.PermissionDeniedDetail"><span class="badge">M</span>PermissionDeniedDetail</a></li>-+<li><a href="#bytebase.v1.Position"><span class="badge">M</span>Position</a></li>-+<li><a href="#bytebase.v1.Range"><span class="badge">M</span>Range</a></li>--++<li><a href="#bytebase.v1.Engine"><span class="badge">E</span>Engine</a></li>-+<li><a href="#bytebase.v1.ExportFormat"><span class="badge">E</span>ExportFormat</a></li>-+<li><a href="#bytebase.v1.RiskLevel"><span class="badge">E</span>RiskLevel</a></li>-+<li><a href="#bytebase.v1.State"><span class="badge">E</span>State</a></li>-+<li><a href="#bytebase.v1.StatementType"><span class="badge">E</span>StatementType</a></li>-+<li><a href="#bytebase.v1.VCSType"><span class="badge">E</span>VCSType</a></li>-+<li><a href="#bytebase.v1.WebhookType"><span class="badge">E</span>WebhookType</a></li>---+++</ul></li>--++<li><a href="#v1%2fissue_service.proto">v1/issue_service.proto</a><ul>-+<li><a href="#bytebase.v1.ApprovalFlow"><span class="badge">M</span>ApprovalFlow</a></li>-+<li><a href="#bytebase.v1.ApprovalTemplate"><span class="badge">M</span>ApprovalTemplate</a></li>-+<li><a href="#bytebase.v1.ApproveIssueRequest"><span class="badge">M</span>ApproveIssueRequest</a></li>-+<li><a href="#bytebase.v1.BatchUpdateIssuesStatusRequest"><span class="badge">M</span>BatchUpdateIssuesStatusRequest</a></li>-+<li><a href="#bytebase.v1.BatchUpdateIssuesStatusResponse"><span class="badge">M</span>BatchUpdateIssuesStatusResponse</a></li>-+<li><a href="#bytebase.v1.CreateIssueCommentRequest"><span class="badge">M</span>CreateIssueCommentRequest</a></li>-+<li><a href="#bytebase.v1.CreateIssueRequest"><span class="badge">M</span>CreateIssueRequest</a></li>-+<li><a href="#bytebase.v1.GetIssueRequest"><span class="badge">M</span>GetIssueRequest</a></li>-+<li><a href="#bytebase.v1.Issue"><span class="badge">M</span>Issue</a></li>-+<li><a href="#bytebase.v1.Issue.Approver"><span class="badge">M</span>Issue.Approver</a></li>-+<li><a href="#bytebase.v1.IssueComment"><span class="badge">M</span>IssueComment</a></li>-+<li><a href="#bytebase.v1.IssueComment.Approval"><span class="badge">M</span>IssueComment.Approval</a></li>-+<li><a href="#bytebase.v1.IssueComment.IssueUpdate"><span class="badge">M</span>IssueComment.IssueUpdate</a></li>-+<li><a href="#bytebase.v1.IssueComment.PlanSpecUpdate"><span class="badge">M</span>IssueComment.PlanSpecUpdate</a></li>-+<li><a href="#bytebase.v1.ListIssueCommentsRequest"><span class="badge">M</span>ListIssueCommentsRequest</a></li>-+<li><a href="#bytebase.v1.ListIssueCommentsResponse"><span class="badge">M</span>ListIssueCommentsResponse</a></li>-+<li><a href="#bytebase.v1.ListIssuesRequest"><span class="badge">M</span>ListIssuesRequest</a></li>-+<li><a href="#bytebase.v1.ListIssuesResponse"><span class="badge">M</span>ListIssuesResponse</a></li>-+<li><a href="#bytebase.v1.RejectIssueRequest"><span class="badge">M</span>RejectIssueRequest</a></li>-+<li><a href="#bytebase.v1.RequestIssueRequest"><span class="badge">M</span>RequestIssueRequest</a></li>-+<li><a href="#bytebase.v1.RoleGrant"><span class="badge">M</span>RoleGrant</a></li>-+<li><a href="#bytebase.v1.SearchIssuesRequest"><span class="badge">M</span>SearchIssuesRequest</a></li>-+<li><a href="#bytebase.v1.SearchIssuesResponse"><span class="badge">M</span>SearchIssuesResponse</a></li>-+<li><a href="#bytebase.v1.UpdateIssueCommentRequest"><span class="badge">M</span>UpdateIssueCommentRequest</a></li>-+<li><a href="#bytebase.v1.UpdateIssueRequest"><span class="badge">M</span>UpdateIssueRequest</a></li>--++<li><a href="#bytebase.v1.Issue.ApprovalStatus"><span class="badge">E</span>Issue.ApprovalStatus</a></li>-+<li><a href="#bytebase.v1.Issue.Approver.Status"><span class="badge">E</span>Issue.Approver.Status</a></li>-+<li><a href="#bytebase.v1.Issue.Type"><span class="badge">E</span>Issue.Type</a></li>-+<li><a href="#bytebase.v1.IssueComment.Approval.Status"><span class="badge">E</span>IssueComment.Approval.Status</a></li>-+<li><a href="#bytebase.v1.IssueStatus"><span class="badge">E</span>IssueStatus</a></li>---+++<li><a href="#bytebase.v1.IssueService"><span class="badge">S</span>IssueService</a></li>-+</ul></li>--++<li><a href="#v1%2fsetting_service.proto">v1/setting_service.proto</a><ul>-+<li><a href="#bytebase.v1.AISetting"><span class="badge">M</span>AISetting</a></li>-+<li><a href="#bytebase.v1.Algorithm"><span class="badge">M</span>Algorithm</a></li>-+<li><a href="#bytebase.v1.Algorithm.FullMask"><span class="badge">M</span>Algorithm.FullMask</a></li>-+<li><a href="#bytebase.v1.Algorithm.InnerOuterMask"><span class="badge">M</span>Algorithm.InnerOuterMask</a></li>-+<li><a href="#bytebase.v1.Algorithm.MD5Mask"><span class="badge">M</span>Algorithm.MD5Mask</a></li>-+<li><a href="#bytebase.v1.Algorithm.RangeMask"><span class="badge">M</span>Algorithm.RangeMask</a></li>-+<li><a href="#bytebase.v1.Algorithm.RangeMask.Slice"><span class="badge">M</span>Algorithm.RangeMask.Slice</a></li>-+<li><a href="#bytebase.v1.Announcement"><span class="badge">M</span>Announcement</a></li>-+<li><a href="#bytebase.v1.AppIMSetting"><span class="badge">M</span>AppIMSetting</a></li>-+<li><a href="#bytebase.v1.AppIMSetting.DingTalk"><span class="badge">M</span>AppIMSetting.DingTalk</a></li>-+<li><a href="#bytebase.v1.AppIMSetting.Feishu"><span class="badge">M</span>AppIMSetting.Feishu</a></li>-+<li><a href="#bytebase.v1.AppIMSetting.IMSetting"><span class="badge">M</span>AppIMSetting.IMSetting</a></li>-+<li><a href="#bytebase.v1.AppIMSetting.Lark"><span class="badge">M</span>AppIMSetting.Lark</a></li>-+<li><a href="#bytebase.v1.AppIMSetting.Slack"><span class="badge">M</span>AppIMSetting.Slack</a></li>-+<li><a href="#bytebase.v1.AppIMSetting.Teams"><span class="badge">M</span>AppIMSetting.Teams</a></li>-+<li><a href="#bytebase.v1.AppIMSetting.Wecom"><span class="badge">M</span>AppIMSetting.Wecom</a></li>-+<li><a href="#bytebase.v1.DataClassificationSetting"><span class="badge">M</span>DataClassificationSetting</a></li>-+<li><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig</a></li>-+<li><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.ClassificationEntry</a></li>-+<li><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.DataClassification</a></li>-+<li><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.Level</a></li>-+<li><a href="#bytebase.v1.EmailSetting"><span class="badge">M</span>EmailSetting</a></li>-+<li><a href="#bytebase.v1.EmailSetting.SMTPConfig"><span class="badge">M</span>EmailSetting.SMTPConfig</a></li>-+<li><a href="#bytebase.v1.EnvironmentSetting"><span class="badge">M</span>EnvironmentSetting</a></li>-+<li><a href="#bytebase.v1.EnvironmentSetting.Environment"><span class="badge">M</span>EnvironmentSetting.Environment</a></li>-+<li><a href="#bytebase.v1.EnvironmentSetting.Environment.TagsEntry"><span class="badge">M</span>EnvironmentSetting.Environment.TagsEntry</a></li>-+<li><a href="#bytebase.v1.GetSettingRequest"><span class="badge">M</span>GetSettingRequest</a></li>-+<li><a href="#bytebase.v1.GetSettingResponse"><span class="badge">M</span>GetSettingResponse</a></li>-+<li><a href="#bytebase.v1.ListSettingsRequest"><span class="badge">M</span>ListSettingsRequest</a></li>-+<li><a href="#bytebase.v1.ListSettingsResponse"><span class="badge">M</span>ListSettingsResponse</a></li>-+<li><a href="#bytebase.v1.SemanticTypeSetting"><span class="badge">M</span>SemanticTypeSetting</a></li>-+<li><a href="#bytebase.v1.SemanticTypeSetting.SemanticType"><span class="badge">M</span>SemanticTypeSetting.SemanticType</a></li>-+<li><a href="#bytebase.v1.Setting"><span class="badge">M</span>Setting</a></li>-+<li><a href="#bytebase.v1.SettingValue"><span class="badge">M</span>SettingValue</a></li>-+<li><a href="#bytebase.v1.TestEmailSettingRequest"><span class="badge">M</span>TestEmailSettingRequest</a></li>-+<li><a href="#bytebase.v1.TestEmailSettingResponse"><span class="badge">M</span>TestEmailSettingResponse</a></li>-+<li><a href="#bytebase.v1.UpdateSettingRequest"><span class="badge">M</span>UpdateSettingRequest</a></li>-+<li><a href="#bytebase.v1.WorkspaceApprovalSetting"><span class="badge">M</span>WorkspaceApprovalSetting</a></li>-+<li><a href="#bytebase.v1.WorkspaceApprovalSetting.Rule"><span class="badge">M</span>WorkspaceApprovalSetting.Rule</a></li>-+<li><a href="#bytebase.v1.WorkspaceProfileSetting"><span class="badge">M</span>WorkspaceProfileSetting</a></li>-+<li><a href="#bytebase.v1.WorkspaceProfileSetting.PasswordRestriction"><span class="badge">M</span>WorkspaceProfileSetting.PasswordRestriction</a></li>--++<li><a href="#bytebase.v1.AISetting.Provider"><span class="badge">E</span>AISetting.Provider</a></li>-+<li><a href="#bytebase.v1.Algorithm.InnerOuterMask.MaskType"><span class="badge">E</span>Algorithm.InnerOuterMask.MaskType</a></li>-+<li><a href="#bytebase.v1.Announcement.AlertLevel"><span class="badge">E</span>Announcement.AlertLevel</a></li>-+<li><a href="#bytebase.v1.DatabaseChangeMode"><span class="badge">E</span>DatabaseChangeMode</a></li>-+<li><a href="#bytebase.v1.EmailSetting.SMTPConfig.Authentication"><span class="badge">E</span>EmailSetting.SMTPConfig.Authentication</a></li>-+<li><a href="#bytebase.v1.EmailSetting.SMTPConfig.Encryption"><span class="badge">E</span>EmailSetting.SMTPConfig.Encryption</a></li>-+<li><a href="#bytebase.v1.EmailSetting.Type"><span class="badge">E</span>EmailSetting.Type</a></li>-+<li><a href="#bytebase.v1.Setting.SettingName"><span class="badge">E</span>Setting.SettingName</a></li>-+<li><a href="#bytebase.v1.WorkspaceApprovalSetting.Rule.Source"><span class="badge">E</span>WorkspaceApprovalSetting.Rule.Source</a></li>---+++<li><a href="#bytebase.v1.SettingService"><span class="badge">S</span>SettingService</a></li>-+</ul></li>--++<li><a href="#v1%2factuator_service.proto">v1/actuator_service.proto</a><ul>-+<li><a href="#bytebase.v1.ActuatorInfo"><span class="badge">M</span>ActuatorInfo</a></li>-+<li><a href="#bytebase.v1.DeleteCacheRequest"><span class="badge">M</span>DeleteCacheRequest</a></li>-+<li><a href="#bytebase.v1.GetActuatorInfoRequest"><span class="badge">M</span>GetActuatorInfoRequest</a></li>-+<li><a href="#bytebase.v1.Restriction"><span class="badge">M</span>Restriction</a></li>-+<li><a href="#bytebase.v1.SetupSampleRequest"><span class="badge">M</span>SetupSampleRequest</a></li>----++++<li><a href="#bytebase.v1.ActuatorService"><span class="badge">S</span>ActuatorService</a></li>-+</ul></li>--++<li><a href="#v1%2fai_service.proto">v1/ai_service.proto</a><ul>-+<li><a href="#bytebase.v1.AIChatMessage"><span class="badge">M</span>AIChatMessage</a></li>-+<li><a href="#bytebase.v1.AIChatRequest"><span class="badge">M</span>AIChatRequest</a></li>-+<li><a href="#bytebase.v1.AIChatResponse"><span class="badge">M</span>AIChatResponse</a></li>-+<li><a href="#bytebase.v1.AIChatToolCall"><span class="badge">M</span>AIChatToolCall</a></li>-+<li><a href="#bytebase.v1.AIChatToolDefinition"><span class="badge">M</span>AIChatToolDefinition</a></li>-+<li><a href="#bytebase.v1.AIChatUsage"><span class="badge">M</span>AIChatUsage</a></li>--++<li><a href="#bytebase.v1.AIChatMessageRole"><span class="badge">E</span>AIChatMessageRole</a></li>---+++<li><a href="#bytebase.v1.AIService"><span class="badge">S</span>AIService</a></li>-+</ul></li>--++<li><a href="#v1%2fiam_policy.proto">v1/iam_policy.proto</a><ul>-+<li><a href="#bytebase.v1.Binding"><span class="badge">M</span>Binding</a></li>-+<li><a href="#bytebase.v1.BindingDelta"><span class="badge">M</span>BindingDelta</a></li>-+<li><a href="#bytebase.v1.GetIamPolicyRequest"><span class="badge">M</span>GetIamPolicyRequest</a></li>-+<li><a href="#bytebase.v1.IamPolicy"><span class="badge">M</span>IamPolicy</a></li>-+<li><a href="#bytebase.v1.PolicyDelta"><span class="badge">M</span>PolicyDelta</a></li>-+<li><a href="#bytebase.v1.SetIamPolicyRequest"><span class="badge">M</span>SetIamPolicyRequest</a></li>--++<li><a href="#bytebase.v1.BindingDelta.Action"><span class="badge">E</span>BindingDelta.Action</a></li>---+++</ul></li>--++<li><a href="#v1%2faudit_log_service.proto">v1/audit_log_service.proto</a><ul>-+<li><a href="#bytebase.v1.AuditData"><span class="badge">M</span>AuditData</a></li>-+<li><a href="#bytebase.v1.AuditLog"><span class="badge">M</span>AuditLog</a></li>-+<li><a href="#bytebase.v1.ExportAuditLogsRequest"><span class="badge">M</span>ExportAuditLogsRequest</a></li>-+<li><a href="#bytebase.v1.ExportAuditLogsResponse"><span class="badge">M</span>ExportAuditLogsResponse</a></li>-+<li><a href="#bytebase.v1.RequestMetadata"><span class="badge">M</span>RequestMetadata</a></li>-+<li><a href="#bytebase.v1.SearchAuditLogsRequest"><span class="badge">M</span>SearchAuditLogsRequest</a></li>-+<li><a href="#bytebase.v1.SearchAuditLogsResponse"><span class="badge">M</span>SearchAuditLogsResponse</a></li>--++<li><a href="#bytebase.v1.AuditLog.Severity"><span class="badge">E</span>AuditLog.Severity</a></li>---+++<li><a href="#bytebase.v1.AuditLogService"><span class="badge">S</span>AuditLogService</a></li>-+</ul></li>--++<li><a href="#v1%2fuser_service.proto">v1/user_service.proto</a><ul>-+<li><a href="#bytebase.v1.BatchGetUsersRequest"><span class="badge">M</span>BatchGetUsersRequest</a></li>-+<li><a href="#bytebase.v1.BatchGetUsersResponse"><span class="badge">M</span>BatchGetUsersResponse</a></li>-+<li><a href="#bytebase.v1.CreateUserRequest"><span class="badge">M</span>CreateUserRequest</a></li>-+<li><a href="#bytebase.v1.DeleteUserRequest"><span class="badge">M</span>DeleteUserRequest</a></li>-+<li><a href="#bytebase.v1.GetUserRequest"><span class="badge">M</span>GetUserRequest</a></li>-+<li><a href="#bytebase.v1.ListUsersRequest"><span class="badge">M</span>ListUsersRequest</a></li>-+<li><a href="#bytebase.v1.ListUsersResponse"><span class="badge">M</span>ListUsersResponse</a></li>-+<li><a href="#bytebase.v1.UndeleteUserRequest"><span class="badge">M</span>UndeleteUserRequest</a></li>-+<li><a href="#bytebase.v1.UpdateEmailRequest"><span class="badge">M</span>UpdateEmailRequest</a></li>-+<li><a href="#bytebase.v1.UpdateUserRequest"><span class="badge">M</span>UpdateUserRequest</a></li>-+<li><a href="#bytebase.v1.User"><span class="badge">M</span>User</a></li>-+<li><a href="#bytebase.v1.User.Profile"><span class="badge">M</span>User.Profile</a></li>----++++<li><a href="#bytebase.v1.UserService"><span class="badge">S</span>UserService</a></li>-+</ul></li>--++<li><a href="#v1%2fauth_service.proto">v1/auth_service.proto</a><ul>-+<li><a href="#bytebase.v1.ExchangeTokenRequest"><span class="badge">M</span>ExchangeTokenRequest</a></li>-+<li><a href="#bytebase.v1.ExchangeTokenResponse"><span class="badge">M</span>ExchangeTokenResponse</a></li>-+<li><a href="#bytebase.v1.IdentityProviderContext"><span class="badge">M</span>IdentityProviderContext</a></li>-+<li><a href="#bytebase.v1.LoginRequest"><span class="badge">M</span>LoginRequest</a></li>-+<li><a href="#bytebase.v1.LoginResponse"><span class="badge">M</span>LoginResponse</a></li>-+<li><a href="#bytebase.v1.LogoutRequest"><span class="badge">M</span>LogoutRequest</a></li>-+<li><a href="#bytebase.v1.OAuth2IdentityProviderContext"><span class="badge">M</span>OAuth2IdentityProviderContext</a></li>-+<li><a href="#bytebase.v1.OIDCIdentityProviderContext"><span class="badge">M</span>OIDCIdentityProviderContext</a></li>-+<li><a href="#bytebase.v1.RefreshRequest"><span class="badge">M</span>RefreshRequest</a></li>-+<li><a href="#bytebase.v1.RefreshResponse"><span class="badge">M</span>RefreshResponse</a></li>-+<li><a href="#bytebase.v1.RequestPasswordResetRequest"><span class="badge">M</span>RequestPasswordResetRequest</a></li>-+<li><a href="#bytebase.v1.ResetPasswordRequest"><span class="badge">M</span>ResetPasswordRequest</a></li>-+<li><a href="#bytebase.v1.SendEmailLoginCodeRequest"><span class="badge">M</span>SendEmailLoginCodeRequest</a></li>-+<li><a href="#bytebase.v1.SignupRequest"><span class="badge">M</span>SignupRequest</a></li>-+<li><a href="#bytebase.v1.SwitchWorkspaceRequest"><span class="badge">M</span>SwitchWorkspaceRequest</a></li>----++++<li><a href="#bytebase.v1.AuthService"><span class="badge">S</span>AuthService</a></li>-+</ul></li>--++<li><a href="#v1%2fcel_service.proto">v1/cel_service.proto</a><ul>-+<li><a href="#bytebase.v1.BatchDeparseRequest"><span class="badge">M</span>BatchDeparseRequest</a></li>-+<li><a href="#bytebase.v1.BatchDeparseResponse"><span class="badge">M</span>BatchDeparseResponse</a></li>-+<li><a href="#bytebase.v1.BatchParseRequest"><span class="badge">M</span>BatchParseRequest</a></li>-+<li><a href="#bytebase.v1.BatchParseResponse"><span class="badge">M</span>BatchParseResponse</a></li>----++++<li><a href="#bytebase.v1.CelService"><span class="badge">S</span>CelService</a></li>-+</ul></li>--++<li><a href="#v1%2fdatabase_catalog_service.proto">v1/database_catalog_service.proto</a><ul>-+<li><a href="#bytebase.v1.ColumnCatalog"><span class="badge">M</span>ColumnCatalog</a></li>-+<li><a href="#bytebase.v1.ColumnCatalog.LabelsEntry"><span class="badge">M</span>ColumnCatalog.LabelsEntry</a></li>-+<li><a href="#bytebase.v1.DatabaseCatalog"><span class="badge">M</span>DatabaseCatalog</a></li>-+<li><a href="#bytebase.v1.GetDatabaseCatalogRequest"><span class="badge">M</span>GetDatabaseCatalogRequest</a></li>-+<li><a href="#bytebase.v1.ObjectSchema"><span class="badge">M</span>ObjectSchema</a></li>-+<li><a href="#bytebase.v1.ObjectSchema.ArrayKind"><span class="badge">M</span>ObjectSchema.ArrayKind</a></li>-+<li><a href="#bytebase.v1.ObjectSchema.StructKind"><span class="badge">M</span>ObjectSchema.StructKind</a></li>-+<li><a href="#bytebase.v1.ObjectSchema.StructKind.PropertiesEntry"><span class="badge">M</span>ObjectSchema.StructKind.PropertiesEntry</a></li>-+<li><a href="#bytebase.v1.SchemaCatalog"><span class="badge">M</span>SchemaCatalog</a></li>-+<li><a href="#bytebase.v1.TableCatalog"><span class="badge">M</span>TableCatalog</a></li>-+<li><a href="#bytebase.v1.TableCatalog.Columns"><span class="badge">M</span>TableCatalog.Columns</a></li>-+<li><a href="#bytebase.v1.UpdateDatabaseCatalogRequest"><span class="badge">M</span>UpdateDatabaseCatalogRequest</a></li>--++<li><a href="#bytebase.v1.ObjectSchema.Type"><span class="badge">E</span>ObjectSchema.Type</a></li>---+++<li><a href="#bytebase.v1.DatabaseCatalogService"><span class="badge">S</span>DatabaseCatalogService</a></li>-+</ul></li>--++<li><a href="#v1%2fdatabase_group_service.proto">v1/database_group_service.proto</a><ul>-+<li><a href="#bytebase.v1.CreateDatabaseGroupRequest"><span class="badge">M</span>CreateDatabaseGroupRequest</a></li>-+<li><a href="#bytebase.v1.DatabaseGroup"><span class="badge">M</span>DatabaseGroup</a></li>-+<li><a href="#bytebase.v1.DatabaseGroup.Database"><span class="badge">M</span>DatabaseGroup.Database</a></li>-+<li><a href="#bytebase.v1.DeleteDatabaseGroupRequest"><span class="badge">M</span>DeleteDatabaseGroupRequest</a></li>-+<li><a href="#bytebase.v1.GetDatabaseGroupRequest"><span class="badge">M</span>GetDatabaseGroupRequest</a></li>-+<li><a href="#bytebase.v1.ListDatabaseGroupsRequest"><span class="badge">M</span>ListDatabaseGroupsRequest</a></li>-+<li><a href="#bytebase.v1.ListDatabaseGroupsResponse"><span class="badge">M</span>ListDatabaseGroupsResponse</a></li>-+<li><a href="#bytebase.v1.UpdateDatabaseGroupRequest"><span class="badge">M</span>UpdateDatabaseGroupRequest</a></li>--++<li><a href="#bytebase.v1.DatabaseGroupView"><span class="badge">E</span>DatabaseGroupView</a></li>---+++<li><a href="#bytebase.v1.DatabaseGroupService"><span class="badge">S</span>DatabaseGroupService</a></li>-+</ul></li>--++<li><a href="#v1%2finstance_role_service.proto">v1/instance_role_service.proto</a><ul>-+<li><a href="#bytebase.v1.InstanceRole"><span class="badge">M</span>InstanceRole</a></li>-+<li><a href="#bytebase.v1.ListInstanceRolesRequest"><span class="badge">M</span>ListInstanceRolesRequest</a></li>-+<li><a href="#bytebase.v1.ListInstanceRolesResponse"><span class="badge">M</span>ListInstanceRolesResponse</a></li>----++++<li><a href="#bytebase.v1.InstanceRoleService"><span class="badge">S</span>InstanceRoleService</a></li>-+</ul></li>--++<li><a href="#v1%2finstance_service.proto">v1/instance_service.proto</a><ul>-+<li><a href="#bytebase.v1.AddDataSourceRequest"><span class="badge">M</span>AddDataSourceRequest</a></li>-+<li><a href="#bytebase.v1.BatchSyncInstancesRequest"><span class="badge">M</span>BatchSyncInstancesRequest</a></li>-+<li><a href="#bytebase.v1.BatchSyncInstancesResponse"><span class="badge">M</span>BatchSyncInstancesResponse</a></li>-+<li><a href="#bytebase.v1.BatchUpdateInstancesRequest"><span class="badge">M</span>BatchUpdateInstancesRequest</a></li>-+<li><a href="#bytebase.v1.BatchUpdateInstancesResponse"><span class="badge">M</span>BatchUpdateInstancesResponse</a></li>-+<li><a href="#bytebase.v1.CreateInstanceRequest"><span class="badge">M</span>CreateInstanceRequest</a></li>-+<li><a href="#bytebase.v1.DataSource"><span class="badge">M</span>DataSource</a></li>-+<li><a href="#bytebase.v1.DataSource.AWSCredential"><span class="badge">M</span>DataSource.AWSCredential</a></li>-+<li><a href="#bytebase.v1.DataSource.Address"><span class="badge">M</span>DataSource.Address</a></li>-+<li><a href="#bytebase.v1.DataSource.AzureCredential"><span class="badge">M</span>DataSource.AzureCredential</a></li>-+<li><a href="#bytebase.v1.DataSource.ExtraConnectionParametersEntry"><span class="badge">M</span>DataSource.ExtraConnectionParametersEntry</a></li>-+<li><a href="#bytebase.v1.DataSource.GCPCredential"><span class="badge">M</span>DataSource.GCPCredential</a></li>-+<li><a href="#bytebase.v1.DataSourceExternalSecret"><span class="badge">M</span>DataSourceExternalSecret</a></li>-+<li><a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption"><span class="badge">M</span>DataSourceExternalSecret.AppRoleAuthOption</a></li>-+<li><a href="#bytebase.v1.DeleteInstanceRequest"><span class="badge">M</span>DeleteInstanceRequest</a></li>-+<li><a href="#bytebase.v1.GetInstanceRequest"><span class="badge">M</span>GetInstanceRequest</a></li>-+<li><a href="#bytebase.v1.Instance"><span class="badge">M</span>Instance</a></li>-+<li><a href="#bytebase.v1.Instance.LabelsEntry"><span class="badge">M</span>Instance.LabelsEntry</a></li>-+<li><a href="#bytebase.v1.InstanceResource"><span class="badge">M</span>InstanceResource</a></li>-+<li><a href="#bytebase.v1.KerberosConfig"><span class="badge">M</span>KerberosConfig</a></li>-+<li><a href="#bytebase.v1.ListInstanceDatabaseRequest"><span class="badge">M</span>ListInstanceDatabaseRequest</a></li>-+<li><a href="#bytebase.v1.ListInstanceDatabaseResponse"><span class="badge">M</span>ListInstanceDatabaseResponse</a></li>-+<li><a href="#bytebase.v1.ListInstancesRequest"><span class="badge">M</span>ListInstancesRequest</a></li>-+<li><a href="#bytebase.v1.ListInstancesResponse"><span class="badge">M</span>ListInstancesResponse</a></li>-+<li><a href="#bytebase.v1.RemoveDataSourceRequest"><span class="badge">M</span>RemoveDataSourceRequest</a></li>-+<li><a href="#bytebase.v1.SASLConfig"><span class="badge">M</span>SASLConfig</a></li>-+<li><a href="#bytebase.v1.SyncInstanceRequest"><span class="badge">M</span>SyncInstanceRequest</a></li>-+<li><a href="#bytebase.v1.SyncInstanceResponse"><span class="badge">M</span>SyncInstanceResponse</a></li>-+<li><a href="#bytebase.v1.UndeleteInstanceRequest"><span class="badge">M</span>UndeleteInstanceRequest</a></li>-+<li><a href="#bytebase.v1.UpdateDataSourceRequest"><span class="badge">M</span>UpdateDataSourceRequest</a></li>-+<li><a href="#bytebase.v1.UpdateInstanceRequest"><span class="badge">M</span>UpdateInstanceRequest</a></li>--++<li><a href="#bytebase.v1.DataSource.AuthenticationType"><span class="badge">E</span>DataSource.AuthenticationType</a></li>-+<li><a href="#bytebase.v1.DataSource.RedisType"><span class="badge">E</span>DataSource.RedisType</a></li>-+<li><a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption.SecretType"><span class="badge">E</span>DataSourceExternalSecret.AppRoleAuthOption.SecretType</a></li>-+<li><a href="#bytebase.v1.DataSourceExternalSecret.AuthType"><span class="badge">E</span>DataSourceExternalSecret.AuthType</a></li>-+<li><a href="#bytebase.v1.DataSourceExternalSecret.SecretType"><span class="badge">E</span>DataSourceExternalSecret.SecretType</a></li>-+<li><a href="#bytebase.v1.DataSourceType"><span class="badge">E</span>DataSourceType</a></li>---+++<li><a href="#bytebase.v1.InstanceService"><span class="badge">S</span>InstanceService</a></li>-+</ul></li>--++<li><a href="#v1%2fdatabase_service.proto">v1/database_service.proto</a><ul>-+<li><a href="#bytebase.v1.BatchGetDatabasesRequest"><span class="badge">M</span>BatchGetDatabasesRequest</a></li>-+<li><a href="#bytebase.v1.BatchGetDatabasesResponse"><span class="badge">M</span>BatchGetDatabasesResponse</a></li>-+<li><a href="#bytebase.v1.BatchSyncDatabasesRequest"><span class="badge">M</span>BatchSyncDatabasesRequest</a></li>-+<li><a href="#bytebase.v1.BatchSyncDatabasesResponse"><span class="badge">M</span>BatchSyncDatabasesResponse</a></li>-+<li><a href="#bytebase.v1.BatchUpdateDatabasesRequest"><span class="badge">M</span>BatchUpdateDatabasesRequest</a></li>-+<li><a href="#bytebase.v1.BatchUpdateDatabasesResponse"><span class="badge">M</span>BatchUpdateDatabasesResponse</a></li>-+<li><a href="#bytebase.v1.BoundingBox"><span class="badge">M</span>BoundingBox</a></li>-+<li><a href="#bytebase.v1.Changelog"><span class="badge">M</span>Changelog</a></li>-+<li><a href="#bytebase.v1.CheckConstraintMetadata"><span class="badge">M</span>CheckConstraintMetadata</a></li>-+<li><a href="#bytebase.v1.ColumnMetadata"><span class="badge">M</span>ColumnMetadata</a></li>-+<li><a href="#bytebase.v1.Database"><span class="badge">M</span>Database</a></li>-+<li><a href="#bytebase.v1.Database.LabelsEntry"><span class="badge">M</span>Database.LabelsEntry</a></li>-+<li><a href="#bytebase.v1.DatabaseMetadata"><span class="badge">M</span>DatabaseMetadata</a></li>-+<li><a href="#bytebase.v1.DatabaseSDLSchema"><span class="badge">M</span>DatabaseSDLSchema</a></li>-+<li><a href="#bytebase.v1.DatabaseSchema"><span class="badge">M</span>DatabaseSchema</a></li>-+<li><a href="#bytebase.v1.DependencyColumn"><span class="badge">M</span>DependencyColumn</a></li>-+<li><a href="#bytebase.v1.DependencyTable"><span class="badge">M</span>DependencyTable</a></li>-+<li><a href="#bytebase.v1.DiffSchemaRequest"><span class="badge">M</span>DiffSchemaRequest</a></li>-+<li><a href="#bytebase.v1.DiffSchemaResponse"><span class="badge">M</span>DiffSchemaResponse</a></li>-+<li><a href="#bytebase.v1.DimensionConstraint"><span class="badge">M</span>DimensionConstraint</a></li>-+<li><a href="#bytebase.v1.DimensionalConfig"><span class="badge">M</span>DimensionalConfig</a></li>-+<li><a href="#bytebase.v1.EnumTypeMetadata"><span class="badge">M</span>EnumTypeMetadata</a></li>-+<li><a href="#bytebase.v1.EventMetadata"><span class="badge">M</span>EventMetadata</a></li>-+<li><a href="#bytebase.v1.ExtensionMetadata"><span class="badge">M</span>ExtensionMetadata</a></li>-+<li><a href="#bytebase.v1.ExternalTableMetadata"><span class="badge">M</span>ExternalTableMetadata</a></li>-+<li><a href="#bytebase.v1.ForeignKeyMetadata"><span class="badge">M</span>ForeignKeyMetadata</a></li>-+<li><a href="#bytebase.v1.FunctionMetadata"><span class="badge">M</span>FunctionMetadata</a></li>-+<li><a href="#bytebase.v1.GenerationMetadata"><span class="badge">M</span>GenerationMetadata</a></li>-+<li><a href="#bytebase.v1.GetChangelogRequest"><span class="badge">M</span>GetChangelogRequest</a></li>-+<li><a href="#bytebase.v1.GetDatabaseMetadataRequest"><span class="badge">M</span>GetDatabaseMetadataRequest</a></li>-+<li><a href="#bytebase.v1.GetDatabaseRequest"><span class="badge">M</span>GetDatabaseRequest</a></li>-+<li><a href="#bytebase.v1.GetDatabaseSDLSchemaRequest"><span class="badge">M</span>GetDatabaseSDLSchemaRequest</a></li>-+<li><a href="#bytebase.v1.GetDatabaseSchemaRequest"><span class="badge">M</span>GetDatabaseSchemaRequest</a></li>-+<li><a href="#bytebase.v1.GetSchemaStringRequest"><span class="badge">M</span>GetSchemaStringRequest</a></li>-+<li><a href="#bytebase.v1.GetSchemaStringResponse"><span class="badge">M</span>GetSchemaStringResponse</a></li>-+<li><a href="#bytebase.v1.GridLevel"><span class="badge">M</span>GridLevel</a></li>-+<li><a href="#bytebase.v1.IndexMetadata"><span class="badge">M</span>IndexMetadata</a></li>-+<li><a href="#bytebase.v1.ListChangelogsRequest"><span class="badge">M</span>ListChangelogsRequest</a></li>-+<li><a href="#bytebase.v1.ListChangelogsResponse"><span class="badge">M</span>ListChangelogsResponse</a></li>-+<li><a href="#bytebase.v1.ListDatabasesRequest"><span class="badge">M</span>ListDatabasesRequest</a></li>-+<li><a href="#bytebase.v1.ListDatabasesResponse"><span class="badge">M</span>ListDatabasesResponse</a></li>-+<li><a href="#bytebase.v1.MaterializedViewMetadata"><span class="badge">M</span>MaterializedViewMetadata</a></li>-+<li><a href="#bytebase.v1.PackageMetadata"><span class="badge">M</span>PackageMetadata</a></li>-+<li><a href="#bytebase.v1.ProcedureMetadata"><span class="badge">M</span>ProcedureMetadata</a></li>-+<li><a href="#bytebase.v1.SchemaMetadata"><span class="badge">M</span>SchemaMetadata</a></li>-+<li><a href="#bytebase.v1.SequenceMetadata"><span class="badge">M</span>SequenceMetadata</a></li>-+<li><a href="#bytebase.v1.SpatialIndexConfig"><span class="badge">M</span>SpatialIndexConfig</a></li>-+<li><a href="#bytebase.v1.StorageConfig"><span class="badge">M</span>StorageConfig</a></li>-+<li><a href="#bytebase.v1.StreamMetadata"><span class="badge">M</span>StreamMetadata</a></li>-+<li><a href="#bytebase.v1.SyncDatabaseRequest"><span class="badge">M</span>SyncDatabaseRequest</a></li>-+<li><a href="#bytebase.v1.SyncDatabaseResponse"><span class="badge">M</span>SyncDatabaseResponse</a></li>-+<li><a href="#bytebase.v1.TableMetadata"><span class="badge">M</span>TableMetadata</a></li>-+<li><a href="#bytebase.v1.TablePartitionMetadata"><span class="badge">M</span>TablePartitionMetadata</a></li>-+<li><a href="#bytebase.v1.TaskMetadata"><span class="badge">M</span>TaskMetadata</a></li>-+<li><a href="#bytebase.v1.TessellationConfig"><span class="badge">M</span>TessellationConfig</a></li>-+<li><a href="#bytebase.v1.TriggerMetadata"><span class="badge">M</span>TriggerMetadata</a></li>-+<li><a href="#bytebase.v1.UpdateDatabaseRequest"><span class="badge">M</span>UpdateDatabaseRequest</a></li>-+<li><a href="#bytebase.v1.ViewMetadata"><span class="badge">M</span>ViewMetadata</a></li>--++<li><a href="#bytebase.v1.Changelog.Status"><span class="badge">E</span>Changelog.Status</a></li>-+<li><a href="#bytebase.v1.ChangelogView"><span class="badge">E</span>ChangelogView</a></li>-+<li><a href="#bytebase.v1.ColumnMetadata.IdentityGeneration"><span class="badge">E</span>ColumnMetadata.IdentityGeneration</a></li>-+<li><a href="#bytebase.v1.GenerationMetadata.Type"><span class="badge">E</span>GenerationMetadata.Type</a></li>-+<li><a href="#bytebase.v1.GetDatabaseSDLSchemaRequest.SDLFormat"><span class="badge">E</span>GetDatabaseSDLSchemaRequest.SDLFormat</a></li>-+<li><a href="#bytebase.v1.GetSchemaStringRequest.ObjectType"><span class="badge">E</span>GetSchemaStringRequest.ObjectType</a></li>-+<li><a href="#bytebase.v1.StreamMetadata.Mode"><span class="badge">E</span>StreamMetadata.Mode</a></li>-+<li><a href="#bytebase.v1.StreamMetadata.Type"><span class="badge">E</span>StreamMetadata.Type</a></li>-+<li><a href="#bytebase.v1.SyncStatus"><span class="badge">E</span>SyncStatus</a></li>-+<li><a href="#bytebase.v1.TablePartitionMetadata.Type"><span class="badge">E</span>TablePartitionMetadata.Type</a></li>-+<li><a href="#bytebase.v1.TaskMetadata.State"><span class="badge">E</span>TaskMetadata.State</a></li>---+++<li><a href="#bytebase.v1.DatabaseService"><span class="badge">S</span>DatabaseService</a></li>-+</ul></li>--++<li><a href="#v1%2fgroup_service.proto">v1/group_service.proto</a><ul>-+<li><a href="#bytebase.v1.BatchGetGroupsRequest"><span class="badge">M</span>BatchGetGroupsRequest</a></li>-+<li><a href="#bytebase.v1.BatchGetGroupsResponse"><span class="badge">M</span>BatchGetGroupsResponse</a></li>-+<li><a href="#bytebase.v1.CreateGroupRequest"><span class="badge">M</span>CreateGroupRequest</a></li>-+<li><a href="#bytebase.v1.DeleteGroupRequest"><span class="badge">M</span>DeleteGroupRequest</a></li>-+<li><a href="#bytebase.v1.GetGroupRequest"><span class="badge">M</span>GetGroupRequest</a></li>-+<li><a href="#bytebase.v1.Group"><span class="badge">M</span>Group</a></li>-+<li><a href="#bytebase.v1.GroupMember"><span class="badge">M</span>GroupMember</a></li>-+<li><a href="#bytebase.v1.ListGroupsRequest"><span class="badge">M</span>ListGroupsRequest</a></li>-+<li><a href="#bytebase.v1.ListGroupsResponse"><span class="badge">M</span>ListGroupsResponse</a></li>-+<li><a href="#bytebase.v1.UpdateGroupRequest"><span class="badge">M</span>UpdateGroupRequest</a></li>--++<li><a href="#bytebase.v1.GroupMember.Role"><span class="badge">E</span>GroupMember.Role</a></li>---+++<li><a href="#bytebase.v1.GroupService"><span class="badge">S</span>GroupService</a></li>-+</ul></li>--++<li><a href="#v1%2fidp_service.proto">v1/idp_service.proto</a><ul>-+<li><a href="#bytebase.v1.CreateIdentityProviderRequest"><span class="badge">M</span>CreateIdentityProviderRequest</a></li>-+<li><a href="#bytebase.v1.DeleteIdentityProviderRequest"><span class="badge">M</span>DeleteIdentityProviderRequest</a></li>-+<li><a href="#bytebase.v1.FieldMapping"><span class="badge">M</span>FieldMapping</a></li>-+<li><a href="#bytebase.v1.GetIdentityProviderRequest"><span class="badge">M</span>GetIdentityProviderRequest</a></li>-+<li><a href="#bytebase.v1.IdentityProvider"><span class="badge">M</span>IdentityProvider</a></li>-+<li><a href="#bytebase.v1.IdentityProviderConfig"><span class="badge">M</span>IdentityProviderConfig</a></li>-+<li><a href="#bytebase.v1.LDAPIdentityProviderConfig"><span class="badge">M</span>LDAPIdentityProviderConfig</a></li>-+<li><a href="#bytebase.v1.ListIdentityProvidersRequest"><span class="badge">M</span>ListIdentityProvidersRequest</a></li>-+<li><a href="#bytebase.v1.ListIdentityProvidersResponse"><span class="badge">M</span>ListIdentityProvidersResponse</a></li>-+<li><a href="#bytebase.v1.OAuth2IdentityProviderConfig"><span class="badge">M</span>OAuth2IdentityProviderConfig</a></li>-+<li><a href="#bytebase.v1.OAuth2IdentityProviderTestRequestContext"><span class="badge">M</span>OAuth2IdentityProviderTestRequestContext</a></li>-+<li><a href="#bytebase.v1.OIDCIdentityProviderConfig"><span class="badge">M</span>OIDCIdentityProviderConfig</a></li>-+<li><a href="#bytebase.v1.OIDCIdentityProviderTestRequestContext"><span class="badge">M</span>OIDCIdentityProviderTestRequestContext</a></li>-+<li><a href="#bytebase.v1.TestIdentityProviderRequest"><span class="badge">M</span>TestIdentityProviderRequest</a></li>-+<li><a href="#bytebase.v1.TestIdentityProviderResponse"><span class="badge">M</span>TestIdentityProviderResponse</a></li>-+<li><a href="#bytebase.v1.TestIdentityProviderResponse.ClaimsEntry"><span class="badge">M</span>TestIdentityProviderResponse.ClaimsEntry</a></li>-+<li><a href="#bytebase.v1.TestIdentityProviderResponse.UserInfoEntry"><span class="badge">M</span>TestIdentityProviderResponse.UserInfoEntry</a></li>-+<li><a href="#bytebase.v1.UpdateIdentityProviderRequest"><span class="badge">M</span>UpdateIdentityProviderRequest</a></li>--++<li><a href="#bytebase.v1.IdentityProviderType"><span class="badge">E</span>IdentityProviderType</a></li>-+<li><a href="#bytebase.v1.LDAPIdentityProviderConfig.SecurityProtocol"><span class="badge">E</span>LDAPIdentityProviderConfig.SecurityProtocol</a></li>-+<li><a href="#bytebase.v1.OAuth2AuthStyle"><span class="badge">E</span>OAuth2AuthStyle</a></li>---+++<li><a href="#bytebase.v1.IdentityProviderService"><span class="badge">S</span>IdentityProviderService</a></li>-+</ul></li>--++<li><a href="#v1%2forg_policy_service.proto">v1/org_policy_service.proto</a><ul>-+<li><a href="#bytebase.v1.CreatePolicyRequest"><span class="badge">M</span>CreatePolicyRequest</a></li>-+<li><a href="#bytebase.v1.DeletePolicyRequest"><span class="badge">M</span>DeletePolicyRequest</a></li>-+<li><a href="#bytebase.v1.GetPolicyRequest"><span class="badge">M</span>GetPolicyRequest</a></li>-+<li><a href="#bytebase.v1.ListPoliciesRequest"><span class="badge">M</span>ListPoliciesRequest</a></li>-+<li><a href="#bytebase.v1.ListPoliciesResponse"><span class="badge">M</span>ListPoliciesResponse</a></li>-+<li><a href="#bytebase.v1.MaskingExemptionPolicy"><span class="badge">M</span>MaskingExemptionPolicy</a></li>-+<li><a href="#bytebase.v1.MaskingExemptionPolicy.Exemption"><span class="badge">M</span>MaskingExemptionPolicy.Exemption</a></li>-+<li><a href="#bytebase.v1.MaskingRulePolicy"><span class="badge">M</span>MaskingRulePolicy</a></li>-+<li><a href="#bytebase.v1.MaskingRulePolicy.MaskingRule"><span class="badge">M</span>MaskingRulePolicy.MaskingRule</a></li>-+<li><a href="#bytebase.v1.Policy"><span class="badge">M</span>Policy</a></li>-+<li><a href="#bytebase.v1.QueryDataPolicy"><span class="badge">M</span>QueryDataPolicy</a></li>-+<li><a href="#bytebase.v1.RolloutPolicy"><span class="badge">M</span>RolloutPolicy</a></li>-+<li><a href="#bytebase.v1.TagPolicy"><span class="badge">M</span>TagPolicy</a></li>-+<li><a href="#bytebase.v1.TagPolicy.TagsEntry"><span class="badge">M</span>TagPolicy.TagsEntry</a></li>-+<li><a href="#bytebase.v1.UpdatePolicyRequest"><span class="badge">M</span>UpdatePolicyRequest</a></li>--++<li><a href="#bytebase.v1.PolicyResourceType"><span class="badge">E</span>PolicyResourceType</a></li>-+<li><a href="#bytebase.v1.PolicyType"><span class="badge">E</span>PolicyType</a></li>---+++<li><a href="#bytebase.v1.OrgPolicyService"><span class="badge">S</span>OrgPolicyService</a></li>-+</ul></li>--++<li><a href="#v1%2frollout_service.proto">v1/rollout_service.proto</a><ul>-+<li><a href="#bytebase.v1.BatchCancelTaskRunsRequest"><span class="badge">M</span>BatchCancelTaskRunsRequest</a></li>-+<li><a href="#bytebase.v1.BatchCancelTaskRunsResponse"><span class="badge">M</span>BatchCancelTaskRunsResponse</a></li>-+<li><a href="#bytebase.v1.BatchRunTasksRequest"><span class="badge">M</span>BatchRunTasksRequest</a></li>-+<li><a href="#bytebase.v1.BatchRunTasksResponse"><span class="badge">M</span>BatchRunTasksResponse</a></li>-+<li><a href="#bytebase.v1.BatchSkipTasksRequest"><span class="badge">M</span>BatchSkipTasksRequest</a></li>-+<li><a href="#bytebase.v1.BatchSkipTasksResponse"><span class="badge">M</span>BatchSkipTasksResponse</a></li>-+<li><a href="#bytebase.v1.CreateRolloutRequest"><span class="badge">M</span>CreateRolloutRequest</a></li>-+<li><a href="#bytebase.v1.GetRolloutRequest"><span class="badge">M</span>GetRolloutRequest</a></li>-+<li><a href="#bytebase.v1.GetTaskRunLogRequest"><span class="badge">M</span>GetTaskRunLogRequest</a></li>-+<li><a href="#bytebase.v1.GetTaskRunRequest"><span class="badge">M</span>GetTaskRunRequest</a></li>-+<li><a href="#bytebase.v1.GetTaskRunSessionRequest"><span class="badge">M</span>GetTaskRunSessionRequest</a></li>-+<li><a href="#bytebase.v1.ListRolloutsRequest"><span class="badge">M</span>ListRolloutsRequest</a></li>-+<li><a href="#bytebase.v1.ListRolloutsResponse"><span class="badge">M</span>ListRolloutsResponse</a></li>-+<li><a href="#bytebase.v1.ListTaskRunsRequest"><span class="badge">M</span>ListTaskRunsRequest</a></li>-+<li><a href="#bytebase.v1.ListTaskRunsResponse"><span class="badge">M</span>ListTaskRunsResponse</a></li>-+<li><a href="#bytebase.v1.PreviewTaskRunRollbackRequest"><span class="badge">M</span>PreviewTaskRunRollbackRequest</a></li>-+<li><a href="#bytebase.v1.PreviewTaskRunRollbackResponse"><span class="badge">M</span>PreviewTaskRunRollbackResponse</a></li>-+<li><a href="#bytebase.v1.Rollout"><span class="badge">M</span>Rollout</a></li>-+<li><a href="#bytebase.v1.Stage"><span class="badge">M</span>Stage</a></li>-+<li><a href="#bytebase.v1.Task"><span class="badge">M</span>Task</a></li>-+<li><a href="#bytebase.v1.Task.DatabaseCreate"><span class="badge">M</span>Task.DatabaseCreate</a></li>-+<li><a href="#bytebase.v1.Task.DatabaseDataExport"><span class="badge">M</span>Task.DatabaseDataExport</a></li>-+<li><a href="#bytebase.v1.Task.DatabaseUpdate"><span class="badge">M</span>Task.DatabaseUpdate</a></li>-+<li><a href="#bytebase.v1.TaskRun"><span class="badge">M</span>TaskRun</a></li>-+<li><a href="#bytebase.v1.TaskRun.SchedulerInfo"><span class="badge">M</span>TaskRun.SchedulerInfo</a></li>-+<li><a href="#bytebase.v1.TaskRun.SchedulerInfo.WaitingCause"><span class="badge">M</span>TaskRun.SchedulerInfo.WaitingCause</a></li>-+<li><a href="#bytebase.v1.TaskRunLog"><span class="badge">M</span>TaskRunLog</a></li>-+<li><a href="#bytebase.v1.TaskRunLogEntry"><span class="badge">M</span>TaskRunLogEntry</a></li>-+<li><a href="#bytebase.v1.TaskRunLogEntry.CommandExecute"><span class="badge">M</span>TaskRunLogEntry.CommandExecute</a></li>-+<li><a href="#bytebase.v1.TaskRunLogEntry.CommandExecute.CommandResponse"><span class="badge">M</span>TaskRunLogEntry.CommandExecute.CommandResponse</a></li>-+<li><a href="#bytebase.v1.TaskRunLogEntry.ComputeDiff"><span class="badge">M</span>TaskRunLogEntry.ComputeDiff</a></li>-+<li><a href="#bytebase.v1.TaskRunLogEntry.DatabaseSync"><span class="badge">M</span>TaskRunLogEntry.DatabaseSync</a></li>-+<li><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup"><span class="badge">M</span>TaskRunLogEntry.PriorBackup</a></li>-+<li><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail"><span class="badge">M</span>TaskRunLogEntry.PriorBackup.PriorBackupDetail</a></li>-+<li><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item"><span class="badge">M</span>TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item</a></li>-+<li><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table"><span class="badge">M</span>TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table</a></li>-+<li><a href="#bytebase.v1.TaskRunLogEntry.ReleaseFileExecute"><span class="badge">M</span>TaskRunLogEntry.ReleaseFileExecute</a></li>-+<li><a href="#bytebase.v1.TaskRunLogEntry.RetryInfo"><span class="badge">M</span>TaskRunLogEntry.RetryInfo</a></li>-+<li><a href="#bytebase.v1.TaskRunLogEntry.SchemaDump"><span class="badge">M</span>TaskRunLogEntry.SchemaDump</a></li>-+<li><a href="#bytebase.v1.TaskRunLogEntry.TransactionControl"><span class="badge">M</span>TaskRunLogEntry.TransactionControl</a></li>-+<li><a href="#bytebase.v1.TaskRunSession"><span class="badge">M</span>TaskRunSession</a></li>-+<li><a href="#bytebase.v1.TaskRunSession.Postgres"><span class="badge">M</span>TaskRunSession.Postgres</a></li>-+<li><a href="#bytebase.v1.TaskRunSession.Postgres.Session"><span class="badge">M</span>TaskRunSession.Postgres.Session</a></li>--++<li><a href="#bytebase.v1.Task.Status"><span class="badge">E</span>Task.Status</a></li>-+<li><a href="#bytebase.v1.Task.Type"><span class="badge">E</span>Task.Type</a></li>-+<li><a href="#bytebase.v1.TaskRun.ExportArchiveStatus"><span class="badge">E</span>TaskRun.ExportArchiveStatus</a></li>-+<li><a href="#bytebase.v1.TaskRun.Status"><span class="badge">E</span>TaskRun.Status</a></li>-+<li><a href="#bytebase.v1.TaskRunLogEntry.TransactionControl.Type"><span class="badge">E</span>TaskRunLogEntry.TransactionControl.Type</a></li>-+<li><a href="#bytebase.v1.TaskRunLogEntry.Type"><span class="badge">E</span>TaskRunLogEntry.Type</a></li>---+++<li><a href="#bytebase.v1.RolloutService"><span class="badge">S</span>RolloutService</a></li>-+</ul></li>--++<li><a href="#v1%2fsql_service.proto">v1/sql_service.proto</a><ul>-+<li><a href="#bytebase.v1.AICompletionRequest"><span class="badge">M</span>AICompletionRequest</a></li>-+<li><a href="#bytebase.v1.AICompletionRequest.Message"><span class="badge">M</span>AICompletionRequest.Message</a></li>-+<li><a href="#bytebase.v1.AICompletionResponse"><span class="badge">M</span>AICompletionResponse</a></li>-+<li><a href="#bytebase.v1.AICompletionResponse.Candidate"><span class="badge">M</span>AICompletionResponse.Candidate</a></li>-+<li><a href="#bytebase.v1.AICompletionResponse.Candidate.Content"><span class="badge">M</span>AICompletionResponse.Candidate.Content</a></li>-+<li><a href="#bytebase.v1.AICompletionResponse.Candidate.Content.Part"><span class="badge">M</span>AICompletionResponse.Candidate.Content.Part</a></li>-+<li><a href="#bytebase.v1.AdminExecuteRequest"><span class="badge">M</span>AdminExecuteRequest</a></li>-+<li><a href="#bytebase.v1.AdminExecuteResponse"><span class="badge">M</span>AdminExecuteResponse</a></li>-+<li><a href="#bytebase.v1.Advice"><span class="badge">M</span>Advice</a></li>-+<li><a href="#bytebase.v1.DiffMetadataRequest"><span class="badge">M</span>DiffMetadataRequest</a></li>-+<li><a href="#bytebase.v1.DiffMetadataResponse"><span class="badge">M</span>DiffMetadataResponse</a></li>-+<li><a href="#bytebase.v1.ExportRequest"><span class="badge">M</span>ExportRequest</a></li>-+<li><a href="#bytebase.v1.ExportResponse"><span class="badge">M</span>ExportResponse</a></li>-+<li><a href="#bytebase.v1.MaskingReason"><span class="badge">M</span>MaskingReason</a></li>-+<li><a href="#bytebase.v1.QueryHistory"><span class="badge">M</span>QueryHistory</a></li>-+<li><a href="#bytebase.v1.QueryOption"><span class="badge">M</span>QueryOption</a></li>-+<li><a href="#bytebase.v1.QueryRequest"><span class="badge">M</span>QueryRequest</a></li>-+<li><a href="#bytebase.v1.QueryResponse"><span class="badge">M</span>QueryResponse</a></li>-+<li><a href="#bytebase.v1.QueryResult"><span class="badge">M</span>QueryResult</a></li>-+<li><a href="#bytebase.v1.QueryResult.CommandError"><span class="badge">M</span>QueryResult.CommandError</a></li>-+<li><a href="#bytebase.v1.QueryResult.Message"><span class="badge">M</span>QueryResult.Message</a></li>-+<li><a href="#bytebase.v1.QueryResult.PostgresError"><span class="badge">M</span>QueryResult.PostgresError</a></li>-+<li><a href="#bytebase.v1.QueryResult.SyntaxError"><span class="badge">M</span>QueryResult.SyntaxError</a></li>-+<li><a href="#bytebase.v1.QueryRow"><span class="badge">M</span>QueryRow</a></li>-+<li><a href="#bytebase.v1.RowValue"><span class="badge">M</span>RowValue</a></li>-+<li><a href="#bytebase.v1.RowValue.Timestamp"><span class="badge">M</span>RowValue.Timestamp</a></li>-+<li><a href="#bytebase.v1.RowValue.TimestampTZ"><span class="badge">M</span>RowValue.TimestampTZ</a></li>-+<li><a href="#bytebase.v1.SearchQueryHistoriesRequest"><span class="badge">M</span>SearchQueryHistoriesRequest</a></li>-+<li><a href="#bytebase.v1.SearchQueryHistoriesResponse"><span class="badge">M</span>SearchQueryHistoriesResponse</a></li>--++<li><a href="#bytebase.v1.Advice.Level"><span class="badge">E</span>Advice.Level</a></li>-+<li><a href="#bytebase.v1.Advice.RuleType"><span class="badge">E</span>Advice.RuleType</a></li>-+<li><a href="#bytebase.v1.QueryHistory.Type"><span class="badge">E</span>QueryHistory.Type</a></li>-+<li><a href="#bytebase.v1.QueryOption.MSSQLExplainFormat"><span class="badge">E</span>QueryOption.MSSQLExplainFormat</a></li>-+<li><a href="#bytebase.v1.QueryOption.RedisRunCommandsOn"><span class="badge">E</span>QueryOption.RedisRunCommandsOn</a></li>-+<li><a href="#bytebase.v1.QueryResult.CommandError.Type"><span class="badge">E</span>QueryResult.CommandError.Type</a></li>-+<li><a href="#bytebase.v1.QueryResult.Message.Level"><span class="badge">E</span>QueryResult.Message.Level</a></li>---+++<li><a href="#bytebase.v1.SQLService"><span class="badge">S</span>SQLService</a></li>-+</ul></li>--++<li><a href="#v1%2fplan_service.proto">v1/plan_service.proto</a><ul>-+<li><a href="#bytebase.v1.CancelPlanCheckRunRequest"><span class="badge">M</span>CancelPlanCheckRunRequest</a></li>-+<li><a href="#bytebase.v1.CancelPlanCheckRunResponse"><span class="badge">M</span>CancelPlanCheckRunResponse</a></li>-+<li><a href="#bytebase.v1.CreatePlanRequest"><span class="badge">M</span>CreatePlanRequest</a></li>-+<li><a href="#bytebase.v1.GetPlanCheckRunRequest"><span class="badge">M</span>GetPlanCheckRunRequest</a></li>-+<li><a href="#bytebase.v1.GetPlanRequest"><span class="badge">M</span>GetPlanRequest</a></li>-+<li><a href="#bytebase.v1.ListPlansRequest"><span class="badge">M</span>ListPlansRequest</a></li>-+<li><a href="#bytebase.v1.ListPlansResponse"><span class="badge">M</span>ListPlansResponse</a></li>-+<li><a href="#bytebase.v1.Plan"><span class="badge">M</span>Plan</a></li>-+<li><a href="#bytebase.v1.Plan.ChangeDatabaseConfig"><span class="badge">M</span>Plan.ChangeDatabaseConfig</a></li>-+<li><a href="#bytebase.v1.Plan.CreateDatabaseConfig"><span class="badge">M</span>Plan.CreateDatabaseConfig</a></li>-+<li><a href="#bytebase.v1.Plan.ExportDataConfig"><span class="badge">M</span>Plan.ExportDataConfig</a></li>-+<li><a href="#bytebase.v1.Plan.PlanCheckRunStatusCountEntry"><span class="badge">M</span>Plan.PlanCheckRunStatusCountEntry</a></li>-+<li><a href="#bytebase.v1.Plan.RolloutStageSummary"><span class="badge">M</span>Plan.RolloutStageSummary</a></li>-+<li><a href="#bytebase.v1.Plan.Spec"><span class="badge">M</span>Plan.Spec</a></li>-+<li><a href="#bytebase.v1.Plan.TaskStatusCount"><span class="badge">M</span>Plan.TaskStatusCount</a></li>-+<li><a href="#bytebase.v1.PlanCheckRun"><span class="badge">M</span>PlanCheckRun</a></li>-+<li><a href="#bytebase.v1.PlanCheckRun.Result"><span class="badge">M</span>PlanCheckRun.Result</a></li>-+<li><a href="#bytebase.v1.PlanCheckRun.Result.SqlReviewReport"><span class="badge">M</span>PlanCheckRun.Result.SqlReviewReport</a></li>-+<li><a href="#bytebase.v1.PlanCheckRun.Result.SqlSummaryReport"><span class="badge">M</span>PlanCheckRun.Result.SqlSummaryReport</a></li>-+<li><a href="#bytebase.v1.RunPlanChecksRequest"><span class="badge">M</span>RunPlanChecksRequest</a></li>-+<li><a href="#bytebase.v1.RunPlanChecksResponse"><span class="badge">M</span>RunPlanChecksResponse</a></li>-+<li><a href="#bytebase.v1.UpdatePlanRequest"><span class="badge">M</span>UpdatePlanRequest</a></li>--++<li><a href="#bytebase.v1.PlanCheckRun.Result.Type"><span class="badge">E</span>PlanCheckRun.Result.Type</a></li>-+<li><a href="#bytebase.v1.PlanCheckRun.Status"><span class="badge">E</span>PlanCheckRun.Status</a></li>---+++<li><a href="#bytebase.v1.PlanService"><span class="badge">S</span>PlanService</a></li>-+</ul></li>--++<li><a href="#v1%2fproject_service.proto">v1/project_service.proto</a><ul>-+<li><a href="#bytebase.v1.Activity"><span class="badge">M</span>Activity</a></li>-+<li><a href="#bytebase.v1.AddWebhookRequest"><span class="badge">M</span>AddWebhookRequest</a></li>-+<li><a href="#bytebase.v1.BatchDeleteProjectsRequest"><span class="badge">M</span>BatchDeleteProjectsRequest</a></li>-+<li><a href="#bytebase.v1.BatchGetProjectsRequest"><span class="badge">M</span>BatchGetProjectsRequest</a></li>-+<li><a href="#bytebase.v1.BatchGetProjectsResponse"><span class="badge">M</span>BatchGetProjectsResponse</a></li>-+<li><a href="#bytebase.v1.CreateProjectRequest"><span class="badge">M</span>CreateProjectRequest</a></li>-+<li><a href="#bytebase.v1.DeleteProjectRequest"><span class="badge">M</span>DeleteProjectRequest</a></li>-+<li><a href="#bytebase.v1.GetProjectRequest"><span class="badge">M</span>GetProjectRequest</a></li>-+<li><a href="#bytebase.v1.Label"><span class="badge">M</span>Label</a></li>-+<li><a href="#bytebase.v1.ListProjectsRequest"><span class="badge">M</span>ListProjectsRequest</a></li>-+<li><a href="#bytebase.v1.ListProjectsResponse"><span class="badge">M</span>ListProjectsResponse</a></li>-+<li><a href="#bytebase.v1.Project"><span class="badge">M</span>Project</a></li>-+<li><a href="#bytebase.v1.Project.ExecutionRetryPolicy"><span class="badge">M</span>Project.ExecutionRetryPolicy</a></li>-+<li><a href="#bytebase.v1.Project.LabelsEntry"><span class="badge">M</span>Project.LabelsEntry</a></li>-+<li><a href="#bytebase.v1.RemoveWebhookRequest"><span class="badge">M</span>RemoveWebhookRequest</a></li>-+<li><a href="#bytebase.v1.SearchProjectsRequest"><span class="badge">M</span>SearchProjectsRequest</a></li>-+<li><a href="#bytebase.v1.SearchProjectsResponse"><span class="badge">M</span>SearchProjectsResponse</a></li>-+<li><a href="#bytebase.v1.TestWebhookRequest"><span class="badge">M</span>TestWebhookRequest</a></li>-+<li><a href="#bytebase.v1.TestWebhookResponse"><span class="badge">M</span>TestWebhookResponse</a></li>-+<li><a href="#bytebase.v1.UndeleteProjectRequest"><span class="badge">M</span>UndeleteProjectRequest</a></li>-+<li><a href="#bytebase.v1.UpdateProjectRequest"><span class="badge">M</span>UpdateProjectRequest</a></li>-+<li><a href="#bytebase.v1.UpdateWebhookRequest"><span class="badge">M</span>UpdateWebhookRequest</a></li>-+<li><a href="#bytebase.v1.Webhook"><span class="badge">M</span>Webhook</a></li>--++<li><a href="#bytebase.v1.Activity.Type"><span class="badge">E</span>Activity.Type</a></li>---+++<li><a href="#bytebase.v1.ProjectService"><span class="badge">S</span>ProjectService</a></li>-+</ul></li>--++<li><a href="#v1%2frelease_service.proto">v1/release_service.proto</a><ul>-+<li><a href="#bytebase.v1.CheckReleaseRequest"><span class="badge">M</span>CheckReleaseRequest</a></li>-+<li><a href="#bytebase.v1.CheckReleaseResponse"><span class="badge">M</span>CheckReleaseResponse</a></li>-+<li><a href="#bytebase.v1.CheckReleaseResponse.CheckResult"><span class="badge">M</span>CheckReleaseResponse.CheckResult</a></li>-+<li><a href="#bytebase.v1.CreateReleaseRequest"><span class="badge">M</span>CreateReleaseRequest</a></li>-+<li><a href="#bytebase.v1.DeleteReleaseRequest"><span class="badge">M</span>DeleteReleaseRequest</a></li>-+<li><a href="#bytebase.v1.GetReleaseRequest"><span class="badge">M</span>GetReleaseRequest</a></li>-+<li><a href="#bytebase.v1.ListReleaseCategoriesRequest"><span class="badge">M</span>ListReleaseCategoriesRequest</a></li>-+<li><a href="#bytebase.v1.ListReleaseCategoriesResponse"><span class="badge">M</span>ListReleaseCategoriesResponse</a></li>-+<li><a href="#bytebase.v1.ListReleasesRequest"><span class="badge">M</span>ListReleasesRequest</a></li>-+<li><a href="#bytebase.v1.ListReleasesResponse"><span class="badge">M</span>ListReleasesResponse</a></li>-+<li><a href="#bytebase.v1.Release"><span class="badge">M</span>Release</a></li>-+<li><a href="#bytebase.v1.Release.File"><span class="badge">M</span>Release.File</a></li>-+<li><a href="#bytebase.v1.Release.VCSSource"><span class="badge">M</span>Release.VCSSource</a></li>-+<li><a href="#bytebase.v1.UndeleteReleaseRequest"><span class="badge">M</span>UndeleteReleaseRequest</a></li>-+<li><a href="#bytebase.v1.UpdateReleaseRequest"><span class="badge">M</span>UpdateReleaseRequest</a></li>--++<li><a href="#bytebase.v1.Release.Type"><span class="badge">E</span>Release.Type</a></li>---+++<li><a href="#bytebase.v1.ReleaseService"><span class="badge">S</span>ReleaseService</a></li>-+</ul></li>--++<li><a href="#v1%2freview_config_service.proto">v1/review_config_service.proto</a><ul>-+<li><a href="#bytebase.v1.CreateReviewConfigRequest"><span class="badge">M</span>CreateReviewConfigRequest</a></li>-+<li><a href="#bytebase.v1.DeleteReviewConfigRequest"><span class="badge">M</span>DeleteReviewConfigRequest</a></li>-+<li><a href="#bytebase.v1.GetReviewConfigRequest"><span class="badge">M</span>GetReviewConfigRequest</a></li>-+<li><a href="#bytebase.v1.ListReviewConfigsRequest"><span class="badge">M</span>ListReviewConfigsRequest</a></li>-+<li><a href="#bytebase.v1.ListReviewConfigsResponse"><span class="badge">M</span>ListReviewConfigsResponse</a></li>-+<li><a href="#bytebase.v1.ReviewConfig"><span class="badge">M</span>ReviewConfig</a></li>-+<li><a href="#bytebase.v1.SQLReviewRule"><span class="badge">M</span>SQLReviewRule</a></li>-+<li><a href="#bytebase.v1.SQLReviewRule.CommentConventionRulePayload"><span class="badge">M</span>SQLReviewRule.CommentConventionRulePayload</a></li>-+<li><a href="#bytebase.v1.SQLReviewRule.NamingCaseRulePayload"><span class="badge">M</span>SQLReviewRule.NamingCaseRulePayload</a></li>-+<li><a href="#bytebase.v1.SQLReviewRule.NamingRulePayload"><span class="badge">M</span>SQLReviewRule.NamingRulePayload</a></li>-+<li><a href="#bytebase.v1.SQLReviewRule.NumberRulePayload"><span class="badge">M</span>SQLReviewRule.NumberRulePayload</a></li>-+<li><a href="#bytebase.v1.SQLReviewRule.StringArrayRulePayload"><span class="badge">M</span>SQLReviewRule.StringArrayRulePayload</a></li>-+<li><a href="#bytebase.v1.SQLReviewRule.StringRulePayload"><span class="badge">M</span>SQLReviewRule.StringRulePayload</a></li>-+<li><a href="#bytebase.v1.UpdateReviewConfigRequest"><span class="badge">M</span>UpdateReviewConfigRequest</a></li>--++<li><a href="#bytebase.v1.SQLReviewRule.Level"><span class="badge">E</span>SQLReviewRule.Level</a></li>-+<li><a href="#bytebase.v1.SQLReviewRule.Type"><span class="badge">E</span>SQLReviewRule.Type</a></li>---+++<li><a href="#bytebase.v1.ReviewConfigService"><span class="badge">S</span>ReviewConfigService</a></li>-+</ul></li>--++<li><a href="#v1%2frevision_service.proto">v1/revision_service.proto</a><ul>-+<li><a href="#bytebase.v1.BatchCreateRevisionsRequest"><span class="badge">M</span>BatchCreateRevisionsRequest</a></li>-+<li><a href="#bytebase.v1.BatchCreateRevisionsResponse"><span class="badge">M</span>BatchCreateRevisionsResponse</a></li>-+<li><a href="#bytebase.v1.CreateRevisionRequest"><span class="badge">M</span>CreateRevisionRequest</a></li>-+<li><a href="#bytebase.v1.DeleteRevisionRequest"><span class="badge">M</span>DeleteRevisionRequest</a></li>-+<li><a href="#bytebase.v1.GetRevisionRequest"><span class="badge">M</span>GetRevisionRequest</a></li>-+<li><a href="#bytebase.v1.ListRevisionsRequest"><span class="badge">M</span>ListRevisionsRequest</a></li>-+<li><a href="#bytebase.v1.ListRevisionsResponse"><span class="badge">M</span>ListRevisionsResponse</a></li>-+<li><a href="#bytebase.v1.Revision"><span class="badge">M</span>Revision</a></li>--++<li><a href="#bytebase.v1.Revision.Type"><span class="badge">E</span>Revision.Type</a></li>---+++<li><a href="#bytebase.v1.RevisionService"><span class="badge">S</span>RevisionService</a></li>-+</ul></li>--++<li><a href="#v1%2frole_service.proto">v1/role_service.proto</a><ul>-+<li><a href="#bytebase.v1.CreateRoleRequest"><span class="badge">M</span>CreateRoleRequest</a></li>-+<li><a href="#bytebase.v1.DeleteRoleRequest"><span class="badge">M</span>DeleteRoleRequest</a></li>-+<li><a href="#bytebase.v1.GetRoleRequest"><span class="badge">M</span>GetRoleRequest</a></li>-+<li><a href="#bytebase.v1.ListRolesRequest"><span class="badge">M</span>ListRolesRequest</a></li>-+<li><a href="#bytebase.v1.ListRolesResponse"><span class="badge">M</span>ListRolesResponse</a></li>-+<li><a href="#bytebase.v1.Role"><span class="badge">M</span>Role</a></li>-+<li><a href="#bytebase.v1.UpdateRoleRequest"><span class="badge">M</span>UpdateRoleRequest</a></li>--++<li><a href="#bytebase.v1.Role.Type"><span class="badge">E</span>Role.Type</a></li>---+++<li><a href="#bytebase.v1.RoleService"><span class="badge">S</span>RoleService</a></li>-+</ul></li>--++<li><a href="#v1%2fservice_account_service.proto">v1/service_account_service.proto</a><ul>-+<li><a href="#bytebase.v1.CreateServiceAccountRequest"><span class="badge">M</span>CreateServiceAccountRequest</a></li>-+<li><a href="#bytebase.v1.DeleteServiceAccountRequest"><span class="badge">M</span>DeleteServiceAccountRequest</a></li>-+<li><a href="#bytebase.v1.GetServiceAccountRequest"><span class="badge">M</span>GetServiceAccountRequest</a></li>-+<li><a href="#bytebase.v1.ListServiceAccountsRequest"><span class="badge">M</span>ListServiceAccountsRequest</a></li>-+<li><a href="#bytebase.v1.ListServiceAccountsResponse"><span class="badge">M</span>ListServiceAccountsResponse</a></li>-+<li><a href="#bytebase.v1.ServiceAccount"><span class="badge">M</span>ServiceAccount</a></li>-+<li><a href="#bytebase.v1.UndeleteServiceAccountRequest"><span class="badge">M</span>UndeleteServiceAccountRequest</a></li>-+<li><a href="#bytebase.v1.UpdateServiceAccountRequest"><span class="badge">M</span>UpdateServiceAccountRequest</a></li>----++++<li><a href="#bytebase.v1.ServiceAccountService"><span class="badge">S</span>ServiceAccountService</a></li>-+</ul></li>--++<li><a href="#v1%2fsheet_service.proto">v1/sheet_service.proto</a><ul>-+<li><a href="#bytebase.v1.BatchCreateSheetsRequest"><span class="badge">M</span>BatchCreateSheetsRequest</a></li>-+<li><a href="#bytebase.v1.BatchCreateSheetsResponse"><span class="badge">M</span>BatchCreateSheetsResponse</a></li>-+<li><a href="#bytebase.v1.CreateSheetRequest"><span class="badge">M</span>CreateSheetRequest</a></li>-+<li><a href="#bytebase.v1.GetSheetRequest"><span class="badge">M</span>GetSheetRequest</a></li>-+<li><a href="#bytebase.v1.Sheet"><span class="badge">M</span>Sheet</a></li>----++++<li><a href="#bytebase.v1.SheetService"><span class="badge">S</span>SheetService</a></li>-+</ul></li>--++<li><a href="#v1%2fsubscription_service.proto">v1/subscription_service.proto</a><ul>-+<li><a href="#bytebase.v1.CancelPurchaseRequest"><span class="badge">M</span>CancelPurchaseRequest</a></li>-+<li><a href="#bytebase.v1.CreatePurchaseRequest"><span class="badge">M</span>CreatePurchaseRequest</a></li>-+<li><a href="#bytebase.v1.GetPaymentInfoRequest"><span class="badge">M</span>GetPaymentInfoRequest</a></li>-+<li><a href="#bytebase.v1.GetSubscriptionRequest"><span class="badge">M</span>GetSubscriptionRequest</a></li>-+<li><a href="#bytebase.v1.ListPurchasePlansRequest"><span class="badge">M</span>ListPurchasePlansRequest</a></li>-+<li><a href="#bytebase.v1.ListPurchasePlansResponse"><span class="badge">M</span>ListPurchasePlansResponse</a></li>-+<li><a href="#bytebase.v1.PaymentInfo"><span class="badge">M</span>PaymentInfo</a></li>-+<li><a href="#bytebase.v1.PlanConfig"><span class="badge">M</span>PlanConfig</a></li>-+<li><a href="#bytebase.v1.PlanLimitConfig"><span class="badge">M</span>PlanLimitConfig</a></li>-+<li><a href="#bytebase.v1.PurchaseBillingMethod"><span class="badge">M</span>PurchaseBillingMethod</a></li>-+<li><a href="#bytebase.v1.PurchaseDiscount"><span class="badge">M</span>PurchaseDiscount</a></li>-+<li><a href="#bytebase.v1.PurchasePlan"><span class="badge">M</span>PurchasePlan</a></li>-+<li><a href="#bytebase.v1.PurchasePlanAdditional"><span class="badge">M</span>PurchasePlanAdditional</a></li>-+<li><a href="#bytebase.v1.PurchaseResponse"><span class="badge">M</span>PurchaseResponse</a></li>-+<li><a href="#bytebase.v1.Subscription"><span class="badge">M</span>Subscription</a></li>-+<li><a href="#bytebase.v1.UpdatePurchaseRequest"><span class="badge">M</span>UpdatePurchaseRequest</a></li>-+<li><a href="#bytebase.v1.UploadLicenseRequest"><span class="badge">M</span>UploadLicenseRequest</a></li>-+<li><a href="#bytebase.v1.VerifyCheckoutSessionRequest"><span class="badge">M</span>VerifyCheckoutSessionRequest</a></li>-+<li><a href="#bytebase.v1.VerifyCheckoutSessionResponse"><span class="badge">M</span>VerifyCheckoutSessionResponse</a></li>--++<li><a href="#bytebase.v1.BillingInterval"><span class="badge">E</span>BillingInterval</a></li>-+<li><a href="#bytebase.v1.PlanFeature"><span class="badge">E</span>PlanFeature</a></li>-+<li><a href="#bytebase.v1.PlanType"><span class="badge">E</span>PlanType</a></li>-+<li><a href="#bytebase.v1.PurchaseDiscount.Type"><span class="badge">E</span>PurchaseDiscount.Type</a></li>-+<li><a href="#bytebase.v1.PurchasePlanAdditional.Type"><span class="badge">E</span>PurchasePlanAdditional.Type</a></li>---+++<li><a href="#bytebase.v1.SubscriptionService"><span class="badge">S</span>SubscriptionService</a></li>-+</ul></li>--++<li><a href="#v1%2fworkload_identity_service.proto">v1/workload_identity_service.proto</a><ul>-+<li><a href="#bytebase.v1.CreateWorkloadIdentityRequest"><span class="badge">M</span>CreateWorkloadIdentityRequest</a></li>-+<li><a href="#bytebase.v1.DeleteWorkloadIdentityRequest"><span class="badge">M</span>DeleteWorkloadIdentityRequest</a></li>-+<li><a href="#bytebase.v1.GetWorkloadIdentityRequest"><span class="badge">M</span>GetWorkloadIdentityRequest</a></li>-+<li><a href="#bytebase.v1.ListWorkloadIdentitiesRequest"><span class="badge">M</span>ListWorkloadIdentitiesRequest</a></li>-+<li><a href="#bytebase.v1.ListWorkloadIdentitiesResponse"><span class="badge">M</span>ListWorkloadIdentitiesResponse</a></li>-+<li><a href="#bytebase.v1.UndeleteWorkloadIdentityRequest"><span class="badge">M</span>UndeleteWorkloadIdentityRequest</a></li>-+<li><a href="#bytebase.v1.UpdateWorkloadIdentityRequest"><span class="badge">M</span>UpdateWorkloadIdentityRequest</a></li>-+<li><a href="#bytebase.v1.WorkloadIdentity"><span class="badge">M</span>WorkloadIdentity</a></li>-+<li><a href="#bytebase.v1.WorkloadIdentityConfig"><span class="badge">M</span>WorkloadIdentityConfig</a></li>--++<li><a href="#bytebase.v1.WorkloadIdentityConfig.ProviderType"><span class="badge">E</span>WorkloadIdentityConfig.ProviderType</a></li>---+++<li><a href="#bytebase.v1.WorkloadIdentityService"><span class="badge">S</span>WorkloadIdentityService</a></li>-+</ul></li>--++<li><a href="#v1%2fworksheet_service.proto">v1/worksheet_service.proto</a><ul>-+<li><a href="#bytebase.v1.BatchUpdateWorksheetOrganizerRequest"><span class="badge">M</span>BatchUpdateWorksheetOrganizerRequest</a></li>-+<li><a href="#bytebase.v1.BatchUpdateWorksheetOrganizerResponse"><span class="badge">M</span>BatchUpdateWorksheetOrganizerResponse</a></li>-+<li><a href="#bytebase.v1.CreateWorksheetRequest"><span class="badge">M</span>CreateWorksheetRequest</a></li>-+<li><a href="#bytebase.v1.DeleteWorksheetRequest"><span class="badge">M</span>DeleteWorksheetRequest</a></li>-+<li><a href="#bytebase.v1.GetWorksheetRequest"><span class="badge">M</span>GetWorksheetRequest</a></li>-+<li><a href="#bytebase.v1.SearchWorksheetsRequest"><span class="badge">M</span>SearchWorksheetsRequest</a></li>-+<li><a href="#bytebase.v1.SearchWorksheetsResponse"><span class="badge">M</span>SearchWorksheetsResponse</a></li>-+<li><a href="#bytebase.v1.UpdateWorksheetOrganizerRequest"><span class="badge">M</span>UpdateWorksheetOrganizerRequest</a></li>-+<li><a href="#bytebase.v1.UpdateWorksheetRequest"><span class="badge">M</span>UpdateWorksheetRequest</a></li>-+<li><a href="#bytebase.v1.Worksheet"><span class="badge">M</span>Worksheet</a></li>-+<li><a href="#bytebase.v1.WorksheetOrganizer"><span class="badge">M</span>WorksheetOrganizer</a></li>--++<li><a href="#bytebase.v1.Worksheet.Visibility"><span class="badge">E</span>Worksheet.Visibility</a></li>---+++<li><a href="#bytebase.v1.WorksheetService"><span class="badge">S</span>WorksheetService</a></li>-+</ul></li>--++<li><a href="#v1%2fworkspace_service.proto">v1/workspace_service.proto</a><ul>-+<li><a href="#bytebase.v1.GetWorkspaceRequest"><span class="badge">M</span>GetWorkspaceRequest</a></li>-+<li><a href="#bytebase.v1.ListWorkspacesRequest"><span class="badge">M</span>ListWorkspacesRequest</a></li>-+<li><a href="#bytebase.v1.ListWorkspacesResponse"><span class="badge">M</span>ListWorkspacesResponse</a></li>-+<li><a href="#bytebase.v1.UpdateWorkspaceRequest"><span class="badge">M</span>UpdateWorkspaceRequest</a></li>-+<li><a href="#bytebase.v1.Workspace"><span class="badge">M</span>Workspace</a></li>----++++<li><a href="#bytebase.v1.WorkspaceService"><span class="badge">S</span>WorkspaceService</a></li>-+</ul></li>-+<li><a href="#scalar-value-types">Scalar Value Types</a></li></ul></div>--++<div class="file-heading"><h2 id="v1/annotation.proto">v1/annotation.proto</h2><a href="#title">Top</a></div><p></p>--++<h3 id="bytebase.v1.AuthMethod">AuthMethod</h3><p>Authorization method for RPC calls.</p><table class="enum-table">@@ -3048,37 +3048,37 @@<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>AUTH_METHOD_UNSPECIFIED</td><td>0</td><td><p>Unspecified authorization method.</p></td></tr>-+<tr><td>IAM</td><td>1</td><td><p>Standard IAM authorization check on organizational resources.</p></td></tr>-+<tr><td>CUSTOM</td><td>2</td><td><p>Custom authorization logic.</p></td></tr>-+</tbody></table>--++<h3 id="v1/annotation.proto-extensions">File-level Extensions</h3><table class="extension-table"><thead><tr><td>Extension</td><td>Type</td><td>Base</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>allow_without_credential</td><td><a href="#bool">bool</a></td>@@ -3086,7 +3086,7 @@<td>100000</td><td><p>Whether the method allows access without authentication credentials.</p></td></tr>-+<tr><td>audit</td><td><a href="#bool">bool</a></td>@@ -3094,7 +3094,7 @@<td>100003</td><td><p>Whether to audit calls to this method.</p></td></tr>-+<tr><td>auth_method</td><td><a href="#bytebase.v1.AuthMethod">AuthMethod</a></td>@@ -3102,7 +3102,7 @@<td>100002</td><td><p>The authorization method to use for this RPC.</p></td></tr>-+<tr><td>permission</td><td><a href="#string">string</a></td>@@ -3110,30 +3110,30 @@<td>100001</td><td><p>The permission required to call this method.</p></td></tr>-+</tbody></table>----++++<div class="file-heading"><h2 id="v1/access_grant_service.proto">v1/access_grant_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.AccessGrant">AccessGrant</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -3142,7 +3142,7 @@Format: projects/{project}/accessGrants/{access_grant}The {access_grant} segment is a server-generated unique ID. </p></td></tr>-+<tr><td>creator</td><td><a href="#string">string</a></td>@@ -3150,7 +3150,7 @@ The {access_grant} segment is a server-generated unique ID. </p></td><td><p>The creator of the access grant.Format: users/{email} </p></td></tr>-+<tr><td>status</td><td><a href="#bytebase.v1.AccessGrant.Status">AccessGrant.Status</a></td>@@ -3160,14 +3160,14 @@ An ACTIVE grant with `expire_time` in the past is effectively expiredand no longer authorizes access. Use `expire_time` to determinewhether an ACTIVE grant has expired. </p></td></tr>-+<tr><td>expire_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p>The expiration time of the access grant. </p></td></tr>-+<tr><td>ttl</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>@@ -3175,7 +3175,7 @@ whether an ACTIVE grant has expired. </p></td><td><p>Input only. The time-to-live duration for the access grant.The server computes `expire_time` from this value at activation time. </p></td></tr>-+<tr><td>issue</td><td><a href="#string">string</a></td>@@ -3184,7 +3184,7 @@ The server computes `expire_time` from this value at activation time. </p></td>Can be empty.Format: projects/{project}/issues/{issue} </p></td></tr>-+<tr><td>targets</td><td><a href="#string">string</a></td>@@ -3192,59 +3192,59 @@ Format: projects/{project}/issues/{issue} </p></td><td><p>The target databases for this access grant.Format: instances/{instance}/databases/{database} </p></td></tr>-+<tr><td>query</td><td><a href="#string">string</a></td><td></td><td><p>The query permission granted. </p></td></tr>-+<tr><td>unmask</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether the grant allows unmasking sensitive data. </p></td></tr>-+<tr><td>create_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>update_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>reason</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ActivateAccessGrantRequest">ActivateAccessGrantRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -3252,24 +3252,24 @@ Format: instances/{instance}/databases/{database} </p></td><td><p>The name of the access grant to activate.Format: projects/{project}/accessGrants/{access_grant} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.CreateAccessGrantRequest">CreateAccessGrantRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -3277,31 +3277,31 @@ Format: projects/{project}/accessGrants/{access_grant} </p></td><td><p>The parent project for the access grant.Format: projects/{project} </p></td></tr>-+<tr><td>access_grant</td><td><a href="#bytebase.v1.AccessGrant">AccessGrant</a></td><td></td><td><p>The access grant to create. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetAccessGrantRequest">GetAccessGrantRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -3309,24 +3309,24 @@ Format: projects/{project} </p></td><td><p>The name of the access grant to retrieve.Format: projects/{project}/accessGrants/{access_grant} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListAccessGrantsRequest">ListAccessGrantsRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -3334,21 +3334,21 @@ Format: projects/{project}/accessGrants/{access_grant} </p></td><td><p>The parent project of the access grants.Format: projects/{project} </p></td></tr>-+<tr><td>page_size</td><td><a href="#int32">int32</a></td><td></td><td><p>The maximum number of access grants to return. </p></td></tr>-+<tr><td>page_token</td><td><a href="#string">string</a></td><td></td><td><p>A page token from a previous ListAccessGrants call. </p></td></tr>-+<tr><td>filter</td><td><a href="#string">string</a></td>@@ -3373,7 +3373,7 @@ Examples:- status == "ACTIVE" && expire_time > "2024-02-01T00:00:00Z"- target == "instances/sample/databases/employee" </p></td></tr>-+<tr><td>order_by</td><td><a href="#string">string</a></td>@@ -3385,31 +3385,31 @@ For example:- order_by = "expire_time desc"- order_by = "expire_time asc, create_time desc" </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListAccessGrantsResponse">ListAccessGrantsResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>access_grants</td><td><a href="#bytebase.v1.AccessGrant">AccessGrant</a></td><td>repeated</td><td><p>The access grants from the specified request. </p></td></tr>-+<tr><td>next_page_token</td><td><a href="#string">string</a></td>@@ -3417,24 +3417,24 @@ For example:<td><p>A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.RevokeAccessGrantRequest">RevokeAccessGrantRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -3442,24 +3442,24 @@ If this field is omitted, there are no subsequent pages. </p></td><td><p>The name of the access grant to revoke.Format: projects/{project}/accessGrants/{access_grant} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SearchMyAccessGrantsRequest">SearchMyAccessGrantsRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -3467,59 +3467,59 @@ Format: projects/{project}/accessGrants/{access_grant} </p></td><td><p>The parent project to search in.Format: projects/{project} </p></td></tr>-+<tr><td>page_size</td><td><a href="#int32">int32</a></td><td></td><td><p>The maximum number of access grants to return. </p></td></tr>-+<tr><td>page_token</td><td><a href="#string">string</a></td><td></td><td><p>A page token from a previous SearchMyAccessGrants call. </p></td></tr>-+<tr><td>filter</td><td><a href="#string">string</a></td><td></td><td><p>Check the filter field in the ListAccessGrantsRequest message. </p></td></tr>-+<tr><td>order_by</td><td><a href="#string">string</a></td><td></td><td><p>Check the order_by field in the ListAccessGrantsRequest message. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SearchMyAccessGrantsResponse">SearchMyAccessGrantsResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>access_grants</td><td><a href="#bytebase.v1.AccessGrant">AccessGrant</a></td><td>repeated</td><td><p>The access grants from the specified request. </p></td></tr>-+<tr><td>next_page_token</td><td><a href="#string">string</a></td>@@ -3527,16 +3527,16 @@ Format: projects/{project} </p></td><td><p>A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.AccessGrant.Status">AccessGrant.Status</h3><p>The status of the access grant.</p><table class="enum-table">@@ -3544,39 +3544,39 @@ If this field is omitted, there are no subsequent pages. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>STATUS_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>PENDING</td><td>1</td><td><p>The access grant is pending approval.</p></td></tr>-+<tr><td>ACTIVE</td><td>2</td><td><p>The access grant is active. Check `expire_time` to determinewhether the grant is still valid or has expired.</p></td></tr>-+<tr><td>REVOKED</td><td>3</td><td><p>The access grant has been revoked.</p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AccessGrantService">AccessGrantService</h3><p>AccessGrantService manages temporary access grants within projects.</p><table class="enum-table">@@ -3584,55 +3584,55 @@ whether the grant is still valid or has expired.</p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>GetAccessGrant</td><td><a href="#bytebase.v1.GetAccessGrantRequest">GetAccessGrantRequest</a></td><td><a href="#bytebase.v1.AccessGrant">AccessGrant</a></td><td><p>Gets an access grant by name.</p></td></tr>-+<tr><td>ListAccessGrants</td><td><a href="#bytebase.v1.ListAccessGrantsRequest">ListAccessGrantsRequest</a></td><td><a href="#bytebase.v1.ListAccessGrantsResponse">ListAccessGrantsResponse</a></td><td><p>Lists access grants in a project.</p></td></tr>-+<tr><td>CreateAccessGrant</td><td><a href="#bytebase.v1.CreateAccessGrantRequest">CreateAccessGrantRequest</a></td><td><a href="#bytebase.v1.AccessGrant">AccessGrant</a></td><td><p>Creates an access grant.</p></td></tr>-+<tr><td>ActivateAccessGrant</td><td><a href="#bytebase.v1.ActivateAccessGrantRequest">ActivateAccessGrantRequest</a></td><td><a href="#bytebase.v1.AccessGrant">AccessGrant</a></td><td><p>Activates a pending access grant.</p></td></tr>-+<tr><td>RevokeAccessGrant</td><td><a href="#bytebase.v1.RevokeAccessGrantRequest">RevokeAccessGrantRequest</a></td><td><a href="#bytebase.v1.AccessGrant">AccessGrant</a></td><td><p>Revokes an active access grant.</p></td></tr>-+<tr><td>SearchMyAccessGrants</td><td><a href="#bytebase.v1.SearchMyAccessGrantsRequest">SearchMyAccessGrantsRequest</a></td><td><a href="#bytebase.v1.SearchMyAccessGrantsResponse">SearchMyAccessGrantsResponse</a></td><td><p>Searches access grants created by the caller.</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -3644,127 +3644,127 @@ whether the grant is still valid or has expired.</p></td></tr></thead><tbody>---+++<tr><td>GetAccessGrant</td><td>GET</td><td>/v1/{name=projects/*/accessGrants/*}</td><td></td></tr>----++++<tr><td>ListAccessGrants</td><td>GET</td><td>/v1/{parent=projects/*}/accessGrants</td><td></td></tr>----++++<tr><td>CreateAccessGrant</td><td>POST</td><td>/v1/{parent=projects/*}/accessGrants</td><td>access_grant</td></tr>----++++<tr><td>ActivateAccessGrant</td><td>POST</td><td>/v1/{name=projects/*/accessGrants/*}:activate</td><td>*</td></tr>----++++<tr><td>RevokeAccessGrant</td><td>POST</td><td>/v1/{name=projects/*/accessGrants/*}:revoke</td><td>*</td></tr>----++++<tr><td>SearchMyAccessGrants</td><td>POST</td><td>/v1/{parent=projects/*}/accessGrants:searchMy</td><td>*</td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/common.proto">v1/common.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.PermissionDeniedDetail">PermissionDeniedDetail</h3><p>PermissionDeniedDetail provides structured information about permission failures.</p><p>Used as error detail when returning CodePermissionDenied errors.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>method</td><td><a href="#string">string</a></td><td></td><td><p>The API method that was called. </p></td></tr>-+<tr><td>required_permissions</td><td><a href="#string">string</a></td><td>repeated</td><td><p>The permissions required but not granted to the user. </p></td></tr>-+<tr><td>resources</td><td><a href="#string">string</a></td><td>repeated</td><td><p>The resources the user was trying to access. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Position">Position</h3><p>Position in a text expressed as one-based line and one-based column.</p><p>We use 1-based numbering to match the majority of industry standards:</p><p>- Monaco Editor uses 1-based (https://microsoft.github.io/monaco-editor/typedoc/interfaces/IPosition.html)</p><p>- GitHub Actions uses 1-based (https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-error-message)</p><p>- Most text editors display 1-based positions to users</p><p>Note: LSP uses 0-based (https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#position),</p><p>but we follow the canonical user-facing standards.</p><p>Handling unknown positions:</p><p>- If the entire position is unknown, leave this field as nil/undefined</p><p>- If only line is known, set line and leave column as 0 (e.g., line=5, column=0)</p><p>- If only column is known (rare), set column and leave line as 0</p><p>Frontends should check for nil/undefined/zero values and handle them appropriately.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>line</td><td><a href="#int32">int32</a></td>@@ -3773,7 +3773,7 @@ whether the grant is still valid or has expired.</p></td>First line of the text is line 1.A value of 0 indicates the line information is unknown. </p></td></tr>-+<tr><td>column</td><td><a href="#int32">int32</a></td>@@ -3788,47 +3788,47 @@ Examples:- "SELECT 你好 FROM t" - column 8 is '你' (even though it's at byte offset 7)- "SELECT 😀 FROM t" - column 8 is '😀' (even though it's 4 bytes in UTF-8) </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Range">Range</h3><p>Range represents a span within a text or sequence.</p><p>Whether the indices are byte offsets or character indices depends on the context.</p><p>Check the documentation of the field using Range for specific semantics.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>start</td><td><a href="#int32">int32</a></td><td></td><td><p>Start index (inclusive). </p></td></tr>-+<tr><td>end</td><td><a href="#int32">int32</a></td><td></td><td><p>End index (exclusive). </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.Engine">Engine</h3><p>Database engine type.</p><table class="enum-table">@@ -3836,166 +3836,166 @@ Examples:<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>ENGINE_UNSPECIFIED</td><td>0</td><td><p>Unspecified database engine.</p></td></tr>-+<tr><td>CLICKHOUSE</td><td>1</td><td><p>ClickHouse columnar database.</p></td></tr>-+<tr><td>MYSQL</td><td>2</td><td><p>MySQL relational database.</p></td></tr>-+<tr><td>POSTGRES</td><td>3</td><td><p>PostgreSQL relational database.</p></td></tr>-+<tr><td>SNOWFLAKE</td><td>4</td><td><p>Snowflake cloud data warehouse.</p></td></tr>-+<tr><td>SQLITE</td><td>5</td><td><p>SQLite embedded database.</p></td></tr>-+<tr><td>TIDB</td><td>6</td><td><p>TiDB distributed SQL database.</p></td></tr>-+<tr><td>MONGODB</td><td>7</td><td><p>MongoDB document database.</p></td></tr>-+<tr><td>REDIS</td><td>8</td><td><p>Redis key-value store.</p></td></tr>-+<tr><td>ORACLE</td><td>9</td><td><p>Oracle relational database.</p></td></tr>-+<tr><td>SPANNER</td><td>10</td><td><p>Google Cloud Spanner distributed database.</p></td></tr>-+<tr><td>MSSQL</td><td>11</td><td><p>Microsoft SQL Server relational database.</p></td></tr>-+<tr><td>REDSHIFT</td><td>12</td><td><p>Amazon Redshift data warehouse.</p></td></tr>-+<tr><td>MARIADB</td><td>13</td><td><p>MariaDB relational database.</p></td></tr>-+<tr><td>OCEANBASE</td><td>14</td><td><p>OceanBase distributed database.</p></td></tr>-+<tr><td>STARROCKS</td><td>15</td><td><p>StarRocks analytics database.</p></td></tr>-+<tr><td>DORIS</td><td>16</td><td><p>Apache Doris analytics database.</p></td></tr>-+<tr><td>HIVE</td><td>17</td><td><p>Apache Hive data warehouse.</p></td></tr>-+<tr><td>ELASTICSEARCH</td><td>18</td><td><p>Elasticsearch search engine.</p></td></tr>-+<tr><td>BIGQUERY</td><td>19</td><td><p>Google BigQuery data warehouse.</p></td></tr>-+<tr><td>DYNAMODB</td><td>20</td><td><p>Amazon DynamoDB NoSQL database.</p></td></tr>-+<tr><td>DATABRICKS</td><td>21</td><td><p>Databricks lakehouse platform.</p></td></tr>-+<tr><td>COCKROACHDB</td><td>22</td><td><p>CockroachDB distributed SQL database.</p></td></tr>-+<tr><td>COSMOSDB</td><td>23</td><td><p>Azure Cosmos DB multi-model database.</p></td></tr>-+<tr><td>TRINO</td><td>24</td><td><p>Trino distributed SQL query engine.</p></td></tr>-+<tr><td>CASSANDRA</td><td>25</td><td><p>Apache Cassandra NoSQL database.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.ExportFormat">ExportFormat</h3><p>Data export format.</p><table class="enum-table">@@ -4003,40 +4003,40 @@ Examples:<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>FORMAT_UNSPECIFIED</td><td>0</td><td><p>Unspecified export format.</p></td></tr>-+<tr><td>CSV</td><td>1</td><td><p>Comma-separated values format.</p></td></tr>-+<tr><td>JSON</td><td>2</td><td><p>JavaScript Object Notation format.</p></td></tr>-+<tr><td>SQL</td><td>3</td><td><p>SQL statements format.</p></td></tr>-+<tr><td>XLSX</td><td>4</td><td><p>Microsoft Excel spreadsheet format.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.RiskLevel">RiskLevel</h3><p>RiskLevel is the risk level.</p><table class="enum-table">@@ -4044,34 +4044,34 @@ Examples:<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>RISK_LEVEL_UNSPECIFIED</td><td>0</td><td><p>Unspecified risk level.</p></td></tr>-+<tr><td>LOW</td><td>1</td><td><p>Low risk operation.</p></td></tr>-+<tr><td>MODERATE</td><td>2</td><td><p>Moderate risk operation.</p></td></tr>-+<tr><td>HIGH</td><td>3</td><td><p>High risk operation.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.State">State</h3><p>Resource lifecycle state.</p><table class="enum-table">@@ -4079,28 +4079,28 @@ Examples:<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>STATE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>ACTIVE</td><td>1</td><td><p>Resource is active and operational.</p></td></tr>-+<tr><td>DELETED</td><td>2</td><td><p>Resource is soft-deleted but may be recoverable.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.StatementType">StatementType</h3><p>StatementType represents the type of SQL statement.</p><table class="enum-table">@@ -4108,256 +4108,256 @@ Examples:<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>STATEMENT_TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>CREATE_DATABASE</td><td>1</td><td><p>DDL - CREATE statements</p></td></tr>-+<tr><td>CREATE_TABLE</td><td>2</td><td><p></p></td></tr>-+<tr><td>CREATE_VIEW</td><td>3</td><td><p></p></td></tr>-+<tr><td>CREATE_INDEX</td><td>4</td><td><p></p></td></tr>-+<tr><td>CREATE_SEQUENCE</td><td>5</td><td><p></p></td></tr>-+<tr><td>CREATE_SCHEMA</td><td>6</td><td><p></p></td></tr>-+<tr><td>CREATE_FUNCTION</td><td>7</td><td><p></p></td></tr>-+<tr><td>CREATE_TRIGGER</td><td>8</td><td><p></p></td></tr>-+<tr><td>CREATE_PROCEDURE</td><td>9</td><td><p></p></td></tr>-+<tr><td>CREATE_EVENT</td><td>10</td><td><p></p></td></tr>-+<tr><td>CREATE_EXTENSION</td><td>11</td><td><p></p></td></tr>-+<tr><td>CREATE_TYPE</td><td>12</td><td><p></p></td></tr>-+<tr><td>DROP_DATABASE</td><td>20</td><td><p>DDL - DROP statements</p></td></tr>-+<tr><td>DROP_TABLE</td><td>21</td><td><p></p></td></tr>-+<tr><td>DROP_VIEW</td><td>22</td><td><p></p></td></tr>-+<tr><td>DROP_INDEX</td><td>23</td><td><p></p></td></tr>-+<tr><td>DROP_SEQUENCE</td><td>24</td><td><p></p></td></tr>-+<tr><td>DROP_SCHEMA</td><td>25</td><td><p></p></td></tr>-+<tr><td>DROP_FUNCTION</td><td>26</td><td><p></p></td></tr>-+<tr><td>DROP_TRIGGER</td><td>27</td><td><p></p></td></tr>-+<tr><td>DROP_PROCEDURE</td><td>28</td><td><p></p></td></tr>-+<tr><td>DROP_EVENT</td><td>29</td><td><p></p></td></tr>-+<tr><td>DROP_EXTENSION</td><td>30</td><td><p></p></td></tr>-+<tr><td>DROP_TYPE</td><td>31</td><td><p></p></td></tr>-+<tr><td>ALTER_DATABASE</td><td>40</td><td><p>DDL - ALTER statements</p></td></tr>-+<tr><td>ALTER_TABLE</td><td>41</td><td><p></p></td></tr>-+<tr><td>ALTER_VIEW</td><td>42</td><td><p></p></td></tr>-+<tr><td>ALTER_SEQUENCE</td><td>43</td><td><p></p></td></tr>-+<tr><td>ALTER_EVENT</td><td>44</td><td><p></p></td></tr>-+<tr><td>ALTER_TYPE</td><td>45</td><td><p></p></td></tr>-+<tr><td>ALTER_INDEX</td><td>46</td><td><p></p></td></tr>-+<tr><td>TRUNCATE</td><td>50</td><td><p>DDL - Other</p></td></tr>-+<tr><td>RENAME</td><td>51</td><td><p></p></td></tr>-+<tr><td>RENAME_INDEX</td><td>52</td><td><p></p></td></tr>-+<tr><td>RENAME_SCHEMA</td><td>53</td><td><p></p></td></tr>-+<tr><td>RENAME_SEQUENCE</td><td>54</td><td><p></p></td></tr>-+<tr><td>COMMENT</td><td>55</td><td><p></p></td></tr>-+<tr><td>INSERT</td><td>60</td><td><p>DML statements</p></td></tr>-+<tr><td>UPDATE</td><td>61</td><td><p></p></td></tr>-+<tr><td>DELETE</td><td>62</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.VCSType">VCSType</h3><p>Version control system type.</p><table class="enum-table">@@ -4365,40 +4365,40 @@ Examples:<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>VCS_TYPE_UNSPECIFIED</td><td>0</td><td><p>Unspecified VCS type.</p></td></tr>-+<tr><td>GITHUB</td><td>1</td><td><p>GitHub version control platform.</p></td></tr>-+<tr><td>GITLAB</td><td>2</td><td><p>GitLab version control platform.</p></td></tr>-+<tr><td>BITBUCKET</td><td>3</td><td><p>Bitbucket version control platform.</p></td></tr>-+<tr><td>AZURE_DEVOPS</td><td>4</td><td><p>Azure DevOps version control platform.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.WebhookType">WebhookType</h3><p>Webhook integration type.</p><table class="enum-table">@@ -4406,142 +4406,142 @@ Examples:<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>WEBHOOK_TYPE_UNSPECIFIED</td><td>0</td><td><p>Unspecified type.</p></td></tr>-+<tr><td>SLACK</td><td>1</td><td><p>Slack integration.</p></td></tr>-+<tr><td>DISCORD</td><td>2</td><td><p>Discord integration.</p></td></tr>-+<tr><td>TEAMS</td><td>3</td><td><p>Microsoft Teams integration.</p></td></tr>-+<tr><td>DINGTALK</td><td>4</td><td><p>DingTalk integration.</p></td></tr>-+<tr><td>FEISHU</td><td>5</td><td><p>Feishu integration.</p></td></tr>-+<tr><td>WECOM</td><td>6</td><td><p>WeCom (WeChat Work) integration.</p></td></tr>-+<tr><td>LARK</td><td>7</td><td><p>Lark integration.</p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="v1/issue_service.proto">v1/issue_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.ApprovalFlow">ApprovalFlow</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>roles</td><td><a href="#string">string</a></td><td>repeated</td><td><p>The roles required for approval in order. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ApprovalTemplate">ApprovalTemplate</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>flow</td><td><a href="#bytebase.v1.ApprovalFlow">ApprovalFlow</a></td><td></td><td><p>The approval flow definition. </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>The title of the approval template. </p></td></tr>-+<tr><td>description</td><td><a href="#string">string</a></td><td></td><td><p>The description of the approval template. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ApproveIssueRequest">ApproveIssueRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -4549,31 +4549,31 @@ Examples:<td><p>The name of the issue to add an approver.Format: projects/{project}/issues/{issue} </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment explaining the approval decision. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BatchUpdateIssuesStatusRequest">BatchUpdateIssuesStatusRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -4583,7 +4583,7 @@ Format: projects/{project}If the operation spans parents, a dash (-) may be accepted as a wildcard.We only support updating the status of databases for now. </p></td></tr>-+<tr><td>issues</td><td><a href="#string">string</a></td>@@ -4591,45 +4591,45 @@ We only support updating the status of databases for now. </p></td><td><p>The list of issues to update.Format: projects/{project}/issues/{issue} </p></td></tr>-+<tr><td>status</td><td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td><td></td><td><p>The new status. </p></td></tr>-+<tr><td>reason</td><td><a href="#string">string</a></td><td></td><td><p>The reason for the status change. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BatchUpdateIssuesStatusResponse">BatchUpdateIssuesStatusResponse</h3><p></p>---+++<h3 id="bytebase.v1.CreateIssueCommentRequest">CreateIssueCommentRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -4637,31 +4637,31 @@ Format: projects/{project}/issues/{issue} </p></td><td><p>The issue nameFormat: projects/{project}/issues/{issue} </p></td></tr>-+<tr><td>issue_comment</td><td><a href="#bytebase.v1.IssueComment">IssueComment</a></td><td></td><td><p>The comment to create. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.CreateIssueRequest">CreateIssueRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -4669,31 +4669,31 @@ Format: projects/{project}/issues/{issue} </p></td><td><p>The parent, which owns this collection of issues.Format: projects/{project} </p></td></tr>-+<tr><td>issue</td><td><a href="#bytebase.v1.Issue">Issue</a></td><td></td><td><p>The issue to create. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetIssueRequest">GetIssueRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -4701,31 +4701,31 @@ Format: projects/{project} </p></td><td><p>The name of the issue to retrieve.Format: projects/{project}/issues/{issue} </p></td></tr>-+<tr><td>force</td><td><a href="#bool">bool</a></td><td></td><td><p>If set to true, bypass cache and fetch the latest data. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Issue">Issue</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -4733,70 +4733,70 @@ Format: projects/{project}/issues/{issue} </p></td><td><p>The name of the issue.Format: projects/{project}/issues/{issue} </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>The title of the issue. </p></td></tr>-+<tr><td>description</td><td><a href="#string">string</a></td><td></td><td><p>The description of the issue. </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.v1.Issue.Type">Issue.Type</a></td><td></td><td><p> </p></td></tr>-+<tr><td>status</td><td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td><td></td><td><p>The status of the issue. </p></td></tr>-+<tr><td>approvers</td><td><a href="#bytebase.v1.Issue.Approver">Issue.Approver</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>approval_template</td><td><a href="#bytebase.v1.ApprovalTemplate">ApprovalTemplate</a></td><td></td><td><p>The approval template for the issue. </p></td></tr>-+<tr><td>creator</td><td><a href="#string">string</a></td><td></td><td><p>Format: users/[email protected] </p></td></tr>-+<tr><td>create_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>update_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>plan</td><td><a href="#string">string</a></td>@@ -4805,35 +4805,35 @@ Format: projects/{project}/issues/{issue} </p></td>Can be empty.Format: projects/{project}/plans/{plan} </p></td></tr>-+<tr><td>role_grant</td><td><a href="#bytebase.v1.RoleGrant">RoleGrant</a></td><td></td><td><p>Used if the issue type is ROLE_GRANT. </p></td></tr>-+<tr><td>risk_level</td><td><a href="#bytebase.v1.RiskLevel">RiskLevel</a></td><td></td><td><p>The risk level of the issue. </p></td></tr>-+<tr><td>labels</td><td><a href="#string">string</a></td><td>repeated</td><td><p>Labels attached to the issue for categorization and filtering. </p></td></tr>-+<tr><td>approval_status</td><td><a href="#bytebase.v1.Issue.ApprovalStatus">Issue.ApprovalStatus</a></td><td></td><td><p> </p></td></tr>-+<tr><td>access_grant</td><td><a href="#string">string</a></td>@@ -4841,232 +4841,232 @@ Format: projects/{project}/plans/{plan} </p></td><td><p>The access grant associated with this issue.Format: projects/{project}/accessGrants/{access_grant} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Issue.Approver">Issue.Approver</h3><p>Approvers and their approval status for the issue.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>status</td><td><a href="#bytebase.v1.Issue.Approver.Status">Issue.Approver.Status</a></td><td></td><td><p>The new status. </p></td></tr>-+<tr><td>principal</td><td><a href="#string">string</a></td><td></td><td><p>Format: users/[email protected] </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.IssueComment">IssueComment</h3><p>A comment on an issue.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>Format: projects/{project}/issues/{issue}/issueComments/{issueComment-uid} </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The text content of the comment. </p></td></tr>-+<tr><td>payload</td><td><a href="#string">string</a></td><td></td><td><p>TODO: use struct message instead. </p></td></tr>-+<tr><td>create_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>update_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>creator</td><td><a href="#string">string</a></td><td></td><td><p>Format: users/{email} </p></td></tr>-+<tr><td>approval</td><td><a href="#bytebase.v1.IssueComment.Approval">IssueComment.Approval</a></td><td></td><td><p>Approval event. </p></td></tr>-+<tr><td>issue_update</td><td><a href="#bytebase.v1.IssueComment.IssueUpdate">IssueComment.IssueUpdate</a></td><td></td><td><p>Issue update event. </p></td></tr>-+<tr><td>plan_spec_update</td><td><a href="#bytebase.v1.IssueComment.PlanSpecUpdate">IssueComment.PlanSpecUpdate</a></td><td></td><td><p>Plan spec update event. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.IssueComment.Approval">IssueComment.Approval</h3><p>Approval event information.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>status</td><td><a href="#bytebase.v1.IssueComment.Approval.Status">IssueComment.Approval.Status</a></td><td></td><td><p>The approval status. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.IssueComment.IssueUpdate">IssueComment.IssueUpdate</h3><p>Issue update event information.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>from_title</td><td><a href="#string">string</a></td><td>optional</td><td><p> </p></td></tr>-+<tr><td>to_title</td><td><a href="#string">string</a></td><td>optional</td><td><p> </p></td></tr>-+<tr><td>from_description</td><td><a href="#string">string</a></td><td>optional</td><td><p> </p></td></tr>-+<tr><td>to_description</td><td><a href="#string">string</a></td><td>optional</td><td><p> </p></td></tr>-+<tr><td>from_status</td><td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td><td>optional</td><td><p> </p></td></tr>-+<tr><td>to_status</td><td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td><td>optional</td><td><p> </p></td></tr>-+<tr><td>from_labels</td><td><a href="#string">string</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>to_labels</td><td><a href="#string">string</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.IssueComment.PlanSpecUpdate">IssueComment.PlanSpecUpdate</h3><p>Plan spec update event information (tracks sheet changes to plan specs).</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>spec</td><td><a href="#string">string</a></td>@@ -5074,7 +5074,7 @@ Format: projects/{project}/accessGrants/{access_grant} </p></td><td><p>The spec that was updated.Format: projects/{project}/plans/{plan}/specs/{spec} </p></td></tr>-+<tr><td>from_sheet</td><td><a href="#string">string</a></td>@@ -5082,7 +5082,7 @@ Format: projects/{project}/plans/{plan}/specs/{spec} </p></td><td><p>The previous sheet.Format: projects/{project}/sheets/{sheet} </p></td></tr>-+<tr><td>to_sheet</td><td><a href="#string">string</a></td>@@ -5090,31 +5090,31 @@ Format: projects/{project}/sheets/{sheet} </p></td><td><p>The new sheet.Format: projects/{project}/sheets/{sheet} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListIssueCommentsRequest">ListIssueCommentsRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td><td></td><td><p>Format: projects/{projects}/issues/{issue} </p></td></tr>-+<tr><td>page_size</td><td><a href="#int32">int32</a></td>@@ -5124,7 +5124,7 @@ this value.If unspecified, at most 10 issue comments will be returned.The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td></tr>-+<tr><td>page_token</td><td><a href="#string">string</a></td>@@ -5135,31 +5135,31 @@ Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `ListIssueComments` must matchthe call that provided the page token. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListIssueCommentsResponse">ListIssueCommentsResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>issue_comments</td><td><a href="#bytebase.v1.IssueComment">IssueComment</a></td><td>repeated</td><td><p>The issue comments from the specified request. </p></td></tr>-+<tr><td>next_page_token</td><td><a href="#string">string</a></td>@@ -5167,24 +5167,24 @@ the call that provided the page token. </p></td><td><p>A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListIssuesRequest">ListIssuesRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -5192,7 +5192,7 @@ If this field is omitted, there are no subsequent pages. </p></td><td><p>The parent, which owns this collection of issues.Format: projects/{project} </p></td></tr>-+<tr><td>page_size</td><td><a href="#int32">int32</a></td>@@ -5202,7 +5202,7 @@ this value.If unspecified, at most 10 issues will be returned.The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td></tr>-+<tr><td>page_token</td><td><a href="#string">string</a></td>@@ -5213,7 +5213,7 @@ Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `ListIssues` must matchthe call that provided the page token. </p></td></tr>-+<tr><td>filter</td><td><a href="#string">string</a></td>@@ -5238,14 +5238,14 @@ labels in ["label1", "label2"]risk_level in ["HIGH", "MODERATE"]create_time >= "2025-01-02T15:04:05Z07:00" </p></td></tr>-+<tr><td>query</td><td><a href="#string">string</a></td><td></td><td><p>Query is the query statement. </p></td></tr>-+<tr><td>order_by</td><td><a href="#string">string</a></td>@@ -5259,31 +5259,31 @@ For example:- order_by = "create_time desc"- order_by = "update_time asc" </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListIssuesResponse">ListIssuesResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>issues</td><td><a href="#bytebase.v1.Issue">Issue</a></td><td>repeated</td><td><p>The issues from the specified request. </p></td></tr>-+<tr><td>next_page_token</td><td><a href="#string">string</a></td>@@ -5291,24 +5291,24 @@ For example:<td><p>A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.RejectIssueRequest">RejectIssueRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -5316,31 +5316,31 @@ If this field is omitted, there are no subsequent pages. </p></td><td><p>The name of the issue to add a rejection.Format: projects/{project}/issues/{issue} </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment explaining the rejection decision. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.RequestIssueRequest">RequestIssueRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -5348,31 +5348,31 @@ Format: projects/{project}/issues/{issue} </p></td><td><p>The name of the issue to request a issue.Format: projects/{project}/issues/{issue} </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment explaining the request. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.RoleGrant">RoleGrant</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>role</td><td><a href="#string">string</a></td>@@ -5380,7 +5380,7 @@ Format: projects/{project}/issues/{issue} </p></td><td><p>The requested role.Format: roles/EXPORTER. </p></td></tr>-+<tr><td>user</td><td><a href="#string">string</a></td>@@ -5388,38 +5388,38 @@ Format: roles/EXPORTER. </p></td><td><p>The user to be granted.Format: users/{email}. </p></td></tr>-+<tr><td>condition</td><td><a href="#google.type.Expr">google.type.Expr</a></td><td></td><td><p>The condition for the role. Same as the condition in IAM Binding message. </p></td></tr>-+<tr><td>expiration</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td><td><p>The duration for which the grant is valid. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SearchIssuesRequest">SearchIssuesRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -5428,7 +5428,7 @@ Format: users/{email}. </p></td>Format: projects/{project}Use "projects/-" to list all issues from all projects. </p></td></tr>-+<tr><td>page_size</td><td><a href="#int32">int32</a></td>@@ -5438,7 +5438,7 @@ this value.If unspecified, at most 10 issues will be returned.The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td></tr>-+<tr><td>page_token</td><td><a href="#string">string</a></td>@@ -5449,7 +5449,7 @@ Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `SearchIssues` must matchthe call that provided the page token. </p></td></tr>-+<tr><td>filter</td><td><a href="#string">string</a></td>@@ -5457,14 +5457,14 @@ the call that provided the page token. </p></td><td><p>Filter is used to filter issues returned in the list.Check the filter field in the ListIssuesRequest message. </p></td></tr>-+<tr><td>query</td><td><a href="#string">string</a></td><td></td><td><p>Query is the query statement. </p></td></tr>-+<tr><td>order_by</td><td><a href="#string">string</a></td>@@ -5478,31 +5478,31 @@ For example:- order_by = "create_time desc"- order_by = "update_time asc" </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SearchIssuesResponse">SearchIssuesResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>issues</td><td><a href="#bytebase.v1.Issue">Issue</a></td><td>repeated</td><td><p>The issues from the specified request. </p></td></tr>-+<tr><td>next_page_token</td><td><a href="#string">string</a></td>@@ -5510,24 +5510,24 @@ For example:<td><p>A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdateIssueCommentRequest">UpdateIssueCommentRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -5535,21 +5535,21 @@ If this field is omitted, there are no subsequent pages. </p></td><td><p>The issue nameFormat: projects/{project}/issues/{issue} </p></td></tr>-+<tr><td>issue_comment</td><td><a href="#bytebase.v1.IssueComment">IssueComment</a></td><td></td><td><p>The comment to update. </p></td></tr>-+<tr><td>update_mask</td><td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td><td></td><td><p>The list of fields to update. </p></td></tr>-+<tr><td>allow_missing</td><td><a href="#bool">bool</a></td>@@ -5557,24 +5557,24 @@ Format: projects/{project}/issues/{issue} </p></td><td><p>If set to true, and the issue comment is not found, a new issue comment will be created.In this situation, `update_mask` is ignored. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdateIssueRequest">UpdateIssueRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>issue</td><td><a href="#bytebase.v1.Issue">Issue</a></td>@@ -5584,14 +5584,14 @@ In this situation, `update_mask` is ignored. </p></td>The issue's `name` field is used to identify the issue to update.Format: projects/{project}/issues/{issue} </p></td></tr>-+<tr><td>update_mask</td><td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td><td></td><td><p>The list of fields to update. </p></td></tr>-+<tr><td>allow_missing</td><td><a href="#bool">bool</a></td>@@ -5599,16 +5599,16 @@ Format: projects/{project}/issues/{issue} </p></td><td><p>If set to true, and the issue is not found, a new issue will be created.In this situation, `update_mask` is ignored. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.Issue.ApprovalStatus">Issue.ApprovalStatus</h3><p>The overall approval status for the issue.</p><table class="enum-table">@@ -5616,46 +5616,46 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>APPROVAL_STATUS_UNSPECIFIED</td><td>0</td><td><p>Unspecified approval status.</p></td></tr>-+<tr><td>CHECKING</td><td>1</td><td><p>Approval checks are being evaluated.</p></td></tr>-+<tr><td>PENDING</td><td>2</td><td><p>Approval is pending.</p></td></tr>-+<tr><td>APPROVED</td><td>3</td><td><p>Issue has been approved.</p></td></tr>-+<tr><td>REJECTED</td><td>4</td><td><p>Issue has been rejected.</p></td></tr>-+<tr><td>SKIPPED</td><td>5</td><td><p>Approval was skipped.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.Issue.Approver.Status">Issue.Approver.Status</h3><p>The approval status of an approver.</p><table class="enum-table">@@ -5663,34 +5663,34 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>STATUS_UNSPECIFIED</td><td>0</td><td><p>Unspecified status.</p></td></tr>-+<tr><td>PENDING</td><td>1</td><td><p>Awaiting approval.</p></td></tr>-+<tr><td>APPROVED</td><td>2</td><td><p>Approved.</p></td></tr>-+<tr><td>REJECTED</td><td>3</td><td><p>Rejected.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.Issue.Type">Issue.Type</h3><p>The type of issue.</p><table class="enum-table">@@ -5698,40 +5698,40 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p>Unspecified issue type.</p></td></tr>-+<tr><td>DATABASE_CHANGE</td><td>1</td><td><p>Database schema or data change.</p></td></tr>-+<tr><td>ROLE_GRANT</td><td>2</td><td><p>Role grant request.</p></td></tr>-+<tr><td>DATABASE_EXPORT</td><td>3</td><td><p>Database data export request.</p></td></tr>-+<tr><td>ACCESS_GRANT</td><td>4</td><td><p>Temporary access grant request.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.IssueComment.Approval.Status">IssueComment.Approval.Status</h3><p>Approval status values.</p><table class="enum-table">@@ -5739,34 +5739,34 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>STATUS_UNSPECIFIED</td><td>0</td><td><p>Unspecified status.</p></td></tr>-+<tr><td>PENDING</td><td>1</td><td><p>Approval pending.</p></td></tr>-+<tr><td>APPROVED</td><td>2</td><td><p>Approved.</p></td></tr>-+<tr><td>REJECTED</td><td>3</td><td><p>Rejected.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.IssueStatus">IssueStatus</h3><p>The status of an issue.</p><table class="enum-table">@@ -5774,38 +5774,38 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>ISSUE_STATUS_UNSPECIFIED</td><td>0</td><td><p>Unspecified status.</p></td></tr>-+<tr><td>OPEN</td><td>1</td><td><p>Issue is open and active.</p></td></tr>-+<tr><td>DONE</td><td>2</td><td><p>Issue is completed.</p></td></tr>-+<tr><td>CANCELED</td><td>3</td><td><p>Issue is canceled.</p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.IssueService">IssueService</h3><p>IssueService manages issues for tracking database changes and tasks.</p><table class="enum-table">@@ -5813,7 +5813,7 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>GetIssue</td><td><a href="#bytebase.v1.GetIssueRequest">GetIssueRequest</a></td>@@ -5821,7 +5821,7 @@ In this situation, `update_mask` is ignored. </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>@@ -5829,7 +5829,7 @@ Permissions required: bb.issues.get</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>@@ -5837,7 +5837,7 @@ Permissions required: bb.issues.create</p></td><td><p>Lists issues in a project.Permissions required: bb.issues.list</p></td></tr>-+<tr><td>SearchIssues</td><td><a href="#bytebase.v1.SearchIssuesRequest">SearchIssuesRequest</a></td>@@ -5845,7 +5845,7 @@ Permissions required: bb.issues.list</p></td><td><p>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</p></td></tr>-+<tr><td>UpdateIssue</td><td><a href="#bytebase.v1.UpdateIssueRequest">UpdateIssueRequest</a></td>@@ -5853,7 +5853,7 @@ Permissions required: bb.issues.get</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>@@ -5861,7 +5861,7 @@ Permissions required: bb.issues.update</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>@@ -5869,7 +5869,7 @@ Permissions required: bb.issueComments.list</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>@@ -5877,7 +5877,7 @@ Permissions required: bb.issueComments.create</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>@@ -5885,7 +5885,7 @@ Permissions required: bb.issueComments.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>@@ -5893,7 +5893,7 @@ Permissions required: bb.issues.update</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>@@ -5901,7 +5901,7 @@ Permissions required: None (determined by approval flow)</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>@@ -5909,13 +5909,13 @@ Permissions required: None (determined by approval flow)</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></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -5927,253 +5927,253 @@ Permissions required: None (determined by approval flow)</p></td></tr></thead><tbody>---+++<tr><td>GetIssue</td><td>GET</td><td>/v1/{name=projects/*/issues/*}</td><td></td></tr>----++++<tr><td>CreateIssue</td><td>POST</td><td>/v1/{parent=projects/*}/issues</td><td>issue</td></tr>----++++<tr><td>ListIssues</td><td>GET</td><td>/v1/{parent=projects/*}/issues</td><td></td></tr>----++++<tr><td>SearchIssues</td><td>POST</td><td>/v1/{parent=projects/*}/issues:search</td><td>*</td></tr>----++++<tr><td>UpdateIssue</td><td>PATCH</td><td>/v1/{issue.name=projects/*/issues/*}</td><td>issue</td></tr>----++++<tr><td>ListIssueComments</td><td>GET</td><td>/v1/{parent=projects/*/issues/*}/issueComments</td><td></td></tr>----++++<tr><td>CreateIssueComment</td><td>POST</td><td>/v1/{parent=projects/*/issues/*}:comment</td><td>issue_comment</td></tr>----++++<tr><td>UpdateIssueComment</td><td>PATCH</td><td>/v1/{parent=projects/*/issues/*}:comment</td><td>issue_comment</td></tr>----++++<tr><td>BatchUpdateIssuesStatus</td><td>POST</td><td>/v1/{parent=projects/*}/issues:batchUpdateStatus</td><td>*</td></tr>----++++<tr><td>ApproveIssue</td><td>POST</td><td>/v1/{name=projects/*/issues/*}:approve</td><td>*</td></tr>----++++<tr><td>RejectIssue</td><td>POST</td><td>/v1/{name=projects/*/issues/*}:reject</td><td>*</td></tr>----++++<tr><td>RequestIssue</td><td>POST</td><td>/v1/{name=projects/*/issues/*}:request</td><td>*</td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/setting_service.proto">v1/setting_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.AISetting">AISetting</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>enabled</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>provider</td><td><a href="#bytebase.v1.AISetting.Provider">AISetting.Provider</a></td><td></td><td><p> </p></td></tr>-+<tr><td>endpoint</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>api_key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>model</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>version</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Algorithm">Algorithm</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>full_mask</td><td><a href="#bytebase.v1.Algorithm.FullMask">Algorithm.FullMask</a></td><td></td><td><p> </p></td></tr>-+<tr><td>range_mask</td><td><a href="#bytebase.v1.Algorithm.RangeMask">Algorithm.RangeMask</a></td><td></td><td><p> </p></td></tr>-+<tr><td>md5_mask</td><td><a href="#bytebase.v1.Algorithm.MD5Mask">Algorithm.MD5Mask</a></td><td></td><td><p> </p></td></tr>-+<tr><td>inner_outer_mask</td><td><a href="#bytebase.v1.Algorithm.InnerOuterMask">Algorithm.InnerOuterMask</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Algorithm.FullMask">Algorithm.FullMask</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>substitution</td><td><a href="#string">string</a></td>@@ -6181,93 +6181,93 @@ Permissions required: None (determined by approval flow)</p></td><td><p>substitution is the string used to replace the original value, themax length of the string is 16 bytes. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Algorithm.InnerOuterMask">Algorithm.InnerOuterMask</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>prefix_len</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>suffix_len</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.v1.Algorithm.InnerOuterMask.MaskType">Algorithm.InnerOuterMask.MaskType</a></td><td></td><td><p> </p></td></tr>-+<tr><td>substitution</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Algorithm.MD5Mask">Algorithm.MD5Mask</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>salt</td><td><a href="#string">string</a></td><td></td><td><p>salt is the salt value to generate a different hash that with the word alone. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Algorithm.RangeMask">Algorithm.RangeMask</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>slices</td><td><a href="#bytebase.v1.Algorithm.RangeMask.Slice">Algorithm.RangeMask.Slice</a></td>@@ -6275,24 +6275,24 @@ max length of the string is 16 bytes. </p></td><td><p>We store it as a repeated field to face the fact that the original value may have multiple parts should be masked.But frontend can be started with a single rule easily. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Algorithm.RangeMask.Slice">Algorithm.RangeMask.Slice</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>start</td><td><a href="#int32">int32</a></td>@@ -6301,7 +6301,7 @@ But frontend can be started with a single rule easily. </p></td>Uses character indices (not byte offsets) for display-oriented masking.Example: For "你好world", character index 2 refers to 'w' (the 3rd character). </p></td></tr>-+<tr><td>end</td><td><a href="#int32">int32</a></td>@@ -6309,404 +6309,404 @@ Example: For "你好world", character index 2 refers to 'w' (the<td><p>end is the end character index (exclusive) of the original value.Uses character indices (not byte offsets) for display-oriented masking. </p></td></tr>-+<tr><td>substitution</td><td><a href="#string">string</a></td><td></td><td><p>substitution is the string used to replace the OriginalValue[start:end). </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Announcement">Announcement</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>level</td><td><a href="#bytebase.v1.Announcement.AlertLevel">Announcement.AlertLevel</a></td><td></td><td><p>The alert level of announcement </p></td></tr>-+<tr><td>text</td><td><a href="#string">string</a></td><td></td><td><p>The text of announcement </p></td></tr>-+<tr><td>link</td><td><a href="#string">string</a></td><td></td><td><p>The optional link, user can follow the link to check extra details </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AppIMSetting">AppIMSetting</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>settings</td><td><a href="#bytebase.v1.AppIMSetting.IMSetting">AppIMSetting.IMSetting</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AppIMSetting.DingTalk">AppIMSetting.DingTalk</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>client_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>client_secret</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>robot_code</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AppIMSetting.Feishu">AppIMSetting.Feishu</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>app_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>app_secret</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AppIMSetting.IMSetting">AppIMSetting.IMSetting</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>type</td><td><a href="#bytebase.v1.WebhookType">WebhookType</a></td><td></td><td><p> </p></td></tr>-+<tr><td>slack</td><td><a href="#bytebase.v1.AppIMSetting.Slack">AppIMSetting.Slack</a></td><td></td><td><p> </p></td></tr>-+<tr><td>feishu</td><td><a href="#bytebase.v1.AppIMSetting.Feishu">AppIMSetting.Feishu</a></td><td></td><td><p> </p></td></tr>-+<tr><td>wecom</td><td><a href="#bytebase.v1.AppIMSetting.Wecom">AppIMSetting.Wecom</a></td><td></td><td><p> </p></td></tr>-+<tr><td>lark</td><td><a href="#bytebase.v1.AppIMSetting.Lark">AppIMSetting.Lark</a></td><td></td><td><p> </p></td></tr>-+<tr><td>dingtalk</td><td><a href="#bytebase.v1.AppIMSetting.DingTalk">AppIMSetting.DingTalk</a></td><td></td><td><p> </p></td></tr>-+<tr><td>teams</td><td><a href="#bytebase.v1.AppIMSetting.Teams">AppIMSetting.Teams</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AppIMSetting.Lark">AppIMSetting.Lark</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>app_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>app_secret</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AppIMSetting.Slack">AppIMSetting.Slack</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>token</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AppIMSetting.Teams">AppIMSetting.Teams</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>tenant_id</td><td><a href="#string">string</a></td><td></td><td><p>Azure AD tenant ID (Directory ID). </p></td></tr>-+<tr><td>client_id</td><td><a href="#string">string</a></td><td></td><td><p>Azure AD application (client) ID. </p></td></tr>-+<tr><td>client_secret</td><td><a href="#string">string</a></td><td></td><td><p>Azure AD client secret. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AppIMSetting.Wecom">AppIMSetting.Wecom</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>corp_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>agent_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>secret</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DataClassificationSetting">DataClassificationSetting</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>configs</td><td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig">DataClassificationSetting.DataClassificationConfig</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig">DataClassificationSetting.DataClassificationConfig</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>id</td><td><a href="#string">string</a></td><td></td><td><p>id is the uuid for classification. Each project can chose one classification config. </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>levels</td><td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level">DataClassificationSetting.DataClassificationConfig.Level</a></td><td>repeated</td><td><p>levels is user defined level list for classification. </p></td></tr>-+<tr><td>classification</td><td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry">DataClassificationSetting.DataClassificationConfig.ClassificationEntry</a></td>@@ -6714,252 +6714,252 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td<td><p>classification is the id - DataClassification map.The id should in [0-9]+-[0-9]+-[0-9]+ format. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry">DataClassificationSetting.DataClassificationConfig.ClassificationEntry</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value</td><td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification">DataClassificationSetting.DataClassificationConfig.DataClassification</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification">DataClassificationSetting.DataClassificationConfig.DataClassification</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>id</td><td><a href="#string">string</a></td><td></td><td><p>id is the classification id in [0-9]+-[0-9]+-[0-9]+ format. </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>level</td><td><a href="#int32">int32</a></td><td>optional</td><td><p>The sensitivity level. Maps to Level.level. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level">DataClassificationSetting.DataClassificationConfig.Level</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>level</td><td><a href="#int32">int32</a></td><td></td><td><p>The numeric level for ordering. Higher = more sensitive. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.EmailSetting">EmailSetting</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>from</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>from_name</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.v1.EmailSetting.Type">EmailSetting.Type</a></td><td></td><td><p> </p></td></tr>-+<tr><td>smtp</td><td><a href="#bytebase.v1.EmailSetting.SMTPConfig">EmailSetting.SMTPConfig</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.EmailSetting.SMTPConfig">EmailSetting.SMTPConfig</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>host</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>port</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>username</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>password</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>encryption</td><td><a href="#bytebase.v1.EmailSetting.SMTPConfig.Encryption">EmailSetting.SMTPConfig.Encryption</a></td><td></td><td><p> </p></td></tr>-+<tr><td>authentication</td><td><a href="#bytebase.v1.EmailSetting.SMTPConfig.Authentication">EmailSetting.SMTPConfig.Authentication</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.EnvironmentSetting">EnvironmentSetting</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>environments</td><td><a href="#bytebase.v1.EnvironmentSetting.Environment">EnvironmentSetting.Environment</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.EnvironmentSetting.Environment">EnvironmentSetting.Environment</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -6968,7 +6968,7 @@ The id should in [0-9]+-[0-9]+-[0-9]+ format. </p></td>Format: environments/{environment}.Output only. </p></td></tr>-+<tr><td>id</td><td><a href="#string">string</a></td>@@ -6977,231 +6977,231 @@ Output only. </p></td>This value should be 4-63 characters, and valid charactersare /[a-z][0-9]-/. </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>The display name of the environment. </p></td></tr>-+<tr><td>tags</td><td><a href="#bytebase.v1.EnvironmentSetting.Environment.TagsEntry">EnvironmentSetting.Environment.TagsEntry</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>color</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.EnvironmentSetting.Environment.TagsEntry">EnvironmentSetting.Environment.TagsEntry</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetSettingRequest">GetSettingRequest</h3><p>The request message for getting a setting.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The resource name of the setting. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetSettingResponse">GetSettingResponse</h3><p>The response message for getting a setting.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>setting</td><td><a href="#bytebase.v1.Setting">Setting</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListSettingsRequest">ListSettingsRequest</h3><p></p>---+++<h3 id="bytebase.v1.ListSettingsResponse">ListSettingsResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>settings</td><td><a href="#bytebase.v1.Setting">Setting</a></td><td>repeated</td><td><p>The settings from the specified request. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SemanticTypeSetting">SemanticTypeSetting</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>types</td><td><a href="#bytebase.v1.SemanticTypeSetting.SemanticType">SemanticTypeSetting.SemanticType</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SemanticTypeSetting.SemanticType">SemanticTypeSetting.SemanticType</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>id</td><td><a href="#string">string</a></td><td></td><td><p>id is the uuid for semantic type. </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>the title of the semantic type, it should not be empty. </p></td></tr>-+<tr><td>description</td><td><a href="#string">string</a></td><td></td><td><p>the description of the semantic type, it can be empty. </p></td></tr>-+<tr><td>algorithm</td><td><a href="#bytebase.v1.Algorithm">Algorithm</a></td><td></td><td><p> </p></td></tr>-+<tr><td>icon</td><td><a href="#string">string</a></td><td></td><td><p>icon is the icon for semantic type, it can be emoji or base64 encoded image. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Setting">Setting</h3><p>The schema of setting.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -7210,180 +7210,180 @@ are /[a-z][0-9]-/. </p></td>Format: settings/{setting}Example: "settings/SEMANTIC_TYPES" </p></td></tr>-+<tr><td>value</td><td><a href="#bytebase.v1.SettingValue">SettingValue</a></td><td></td><td><p>The configuration value of the setting. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SettingValue">SettingValue</h3><p>The data in setting value.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>app_im</td><td><a href="#bytebase.v1.AppIMSetting">AppIMSetting</a></td><td></td><td><p> </p></td></tr>-+<tr><td>workspace_profile</td><td><a href="#bytebase.v1.WorkspaceProfileSetting">WorkspaceProfileSetting</a></td><td></td><td><p> </p></td></tr>-+<tr><td>workspace_approval</td><td><a href="#bytebase.v1.WorkspaceApprovalSetting">WorkspaceApprovalSetting</a></td><td></td><td><p> </p></td></tr>-+<tr><td>data_classification</td><td><a href="#bytebase.v1.DataClassificationSetting">DataClassificationSetting</a></td><td></td><td><p> </p></td></tr>-+<tr><td>semantic_type</td><td><a href="#bytebase.v1.SemanticTypeSetting">SemanticTypeSetting</a></td><td></td><td><p> </p></td></tr>-+<tr><td>ai</td><td><a href="#bytebase.v1.AISetting">AISetting</a></td><td></td><td><p> </p></td></tr>-+<tr><td>environment</td><td><a href="#bytebase.v1.EnvironmentSetting">EnvironmentSetting</a></td><td></td><td><p> </p></td></tr>-+<tr><td>email</td><td><a href="#bytebase.v1.EmailSetting">EmailSetting</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TestEmailSettingRequest">TestEmailSettingRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>email_setting</td><td><a href="#bytebase.v1.EmailSetting">EmailSetting</a></td><td></td><td><p> </p></td></tr>-+<tr><td>to</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TestEmailSettingResponse">TestEmailSettingResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>success</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>error</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdateSettingRequest">UpdateSettingRequest</h3><p>The request message for updating or creating a setting.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>setting</td><td><a href="#bytebase.v1.Setting">Setting</a></td><td></td><td><p>The setting to update. </p></td></tr>-+<tr><td>validate_only</td><td><a href="#bool">bool</a></td>@@ -7391,69 +7391,69 @@ Example: "settings/SEMANTIC_TYPES" </p></td><td><p>validate_only is a flag to indicate whether to validate the setting value,server would not persist the setting value if it is true. </p></td></tr>-+<tr><td>allow_missing</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>update_mask</td><td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.WorkspaceApprovalSetting">WorkspaceApprovalSetting</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>rules</td><td><a href="#bytebase.v1.WorkspaceApprovalSetting.Rule">WorkspaceApprovalSetting.Rule</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.WorkspaceApprovalSetting.Rule">WorkspaceApprovalSetting.Rule</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>template</td><td><a href="#bytebase.v1.ApprovalTemplate">ApprovalTemplate</a></td><td></td><td><p> </p></td></tr>-+<tr><td>condition</td><td><a href="#google.type.Expr">google.type.Expr</a></td>@@ -7487,115 +7487,115 @@ For examples:resource.environment_id == "prod" && statement.affected_rows >= 100resource.table_name.matches("sensitive_.*") && resource.db_engine == "MYSQL" </p></td></tr>-+<tr><td>source</td><td><a href="#bytebase.v1.WorkspaceApprovalSetting.Rule.Source">WorkspaceApprovalSetting.Rule.Source</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.WorkspaceProfileSetting">WorkspaceProfileSetting</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>external_url</td><td><a href="#string">string</a></td><td></td><td><p>The external URL is used for sso authentication callback. </p></td></tr>-+<tr><td>disallow_signup</td><td><a href="#bool">bool</a></td><td></td><td><p>Disallow self-service signup, users can only be invited by the owner. </p></td></tr>-+<tr><td>require_mfa</td><td><a href="#bool">bool</a></td><td></td><td><p>Require MFA for all users. </p></td></tr>-+<tr><td>refresh_token_duration</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td><td><p>The duration for refresh token. Default is 7 days. </p></td></tr>-+<tr><td>announcement</td><td><a href="#bytebase.v1.Announcement">Announcement</a></td><td></td><td><p>The setting of custom announcement </p></td></tr>-+<tr><td>maximum_role_expiration</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td><td><p>The max duration for role expired. </p></td></tr>-+<tr><td>domains</td><td><a href="#string">string</a></td><td>repeated</td><td><p>The workspace domain, e.g., bytebase.com. </p></td></tr>-+<tr><td>enforce_identity_domain</td><td><a href="#bool">bool</a></td><td></td><td><p>Only user and group from the domains can be created and login. </p></td></tr>-+<tr><td>database_change_mode</td><td><a href="#bytebase.v1.DatabaseChangeMode">DatabaseChangeMode</a></td><td></td><td><p>The workspace database change mode. </p></td></tr>-+<tr><td>disallow_password_signin</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether to disallow password signin. (Except workspace admins) </p></td></tr>-+<tr><td>enable_metric_collection</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether to enable metric collection for the workspace. </p></td></tr>-+<tr><td>inactive_session_timeout</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td><td><p>The session expiration time if not activity detected for the user. Value <= 0 means no limit. </p></td></tr>-+<tr><td>enable_audit_log_stdout</td><td><a href="#bool">bool</a></td>@@ -7603,7 +7603,7 @@ resource.table_name.matches("sensitive_.*") && resource.db_engin<td><p>Whether to enable audit logging to stdout in structured JSON format.Requires TEAM or ENTERPRISE license. </p></td></tr>-+<tr><td>watermark</td><td><a href="#bool">bool</a></td>@@ -7611,35 +7611,35 @@ Requires TEAM or ENTERPRISE license. </p></td><td><p>Whether to display watermark on pages.Requires ENTERPRISE license. </p></td></tr>-+<tr><td>directory_sync_token</td><td><a href="#string">string</a></td><td></td><td><p>The token for directory sync authentication. </p></td></tr>-+<tr><td>password_restriction</td><td><a href="#bytebase.v1.WorkspaceProfileSetting.PasswordRestriction">WorkspaceProfileSetting.PasswordRestriction</a></td><td></td><td><p>Password restriction settings. </p></td></tr>-+<tr><td>access_token_duration</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td><td><p>The duration for access token. Default is 1 hour. </p></td></tr>-+<tr><td>enable_debug</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether debug mode is enabled. </p></td></tr>-+<tr><td>sql_result_size</td><td><a href="#int64">int64</a></td>@@ -7647,14 +7647,14 @@ Requires ENTERPRISE license. </p></td><td><p>The maximum result size limit in bytes for query and export, works for the SQL Editor and Export Center.The default value is 100MB, we will use the default value if the setting not exists, or the limit <= 0. </p></td></tr>-+<tr><td>query_timeout</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td><td><p>The query timeout duration for query and export, works for the SQL Editor and Export Center. </p></td></tr>-+<tr><td>allow_email_code_signin</td><td><a href="#bool">bool</a></td>@@ -7662,82 +7662,82 @@ The default value is 100MB, we will use the default value if the setting not exi<td><p>Allow signin/signup using email + a 6-digit one-time verification code.Requires the EMAIL setting to be configured on the workspace. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.WorkspaceProfileSetting.PasswordRestriction">WorkspaceProfileSetting.PasswordRestriction</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>min_length</td><td><a href="#int32">int32</a></td><td></td><td><p>min_length is the minimum length for password, should no less than 8. </p></td></tr>-+<tr><td>require_number</td><td><a href="#bool">bool</a></td><td></td><td><p>require_number requires the password must contains at least one number. </p></td></tr>-+<tr><td>require_letter</td><td><a href="#bool">bool</a></td><td></td><td><p>require_letter requires the password must contains at least one letter, regardless of upper case or lower case </p></td></tr>-+<tr><td>require_uppercase_letter</td><td><a href="#bool">bool</a></td><td></td><td><p>require_uppercase_letter requires the password must contains at least one upper case letter. </p></td></tr>-+<tr><td>require_special_character</td><td><a href="#bool">bool</a></td><td></td><td><p>require_special_character requires the password must contains at least one special character. </p></td></tr>-+<tr><td>require_reset_password_for_first_login</td><td><a href="#bool">bool</a></td><td></td><td><p>require_reset_password_for_first_login requires users to reset their password after the 1st login. </p></td></tr>-+<tr><td>password_rotation</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td><td><p>password_rotation requires users to reset their password after the duration. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.AISetting.Provider">AISetting.Provider</h3><p></p><table class="enum-table">@@ -7745,40 +7745,40 @@ Requires the EMAIL setting to be configured on the workspace. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>PROVIDER_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>OPEN_AI</td><td>1</td><td><p></p></td></tr>-+<tr><td>CLAUDE</td><td>2</td><td><p></p></td></tr>-+<tr><td>GEMINI</td><td>3</td><td><p></p></td></tr>-+<tr><td>AZURE_OPENAI</td><td>4</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.Algorithm.InnerOuterMask.MaskType">Algorithm.InnerOuterMask.MaskType</h3><p></p><table class="enum-table">@@ -7786,28 +7786,28 @@ Requires the EMAIL setting to be configured on the workspace. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>MASK_TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>INNER</td><td>1</td><td><p></p></td></tr>-+<tr><td>OUTER</td><td>2</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.Announcement.AlertLevel">Announcement.AlertLevel</h3><p>We support three levels of AlertLevel: INFO, WARNING, and ERROR.</p><table class="enum-table">@@ -7815,34 +7815,34 @@ Requires the EMAIL setting to be configured on the workspace. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>ALERT_LEVEL_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>INFO</td><td>1</td><td><p></p></td></tr>-+<tr><td>WARNING</td><td>2</td><td><p></p></td></tr>-+<tr><td>CRITICAL</td><td>3</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.DatabaseChangeMode">DatabaseChangeMode</h3><p></p><table class="enum-table">@@ -7850,29 +7850,29 @@ Requires the EMAIL setting to be configured on the workspace. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>DATABASE_CHANGE_MODE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>PIPELINE</td><td>1</td><td><p>A more advanced database change process, including custom approval workflows and other advanced features.Default to this mode.</p></td></tr>-+<tr><td>EDITOR</td><td>2</td><td><p>A simple database change process in SQL editor. Users can execute SQL directly.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.EmailSetting.SMTPConfig.Authentication">EmailSetting.SMTPConfig.Authentication</h3><p></p><table class="enum-table">@@ -7880,40 +7880,40 @@ Default to this mode.</p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>AUTHENTICATION_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>AUTHENTICATION_NONE</td><td>1</td><td><p></p></td></tr>-+<tr><td>PLAIN</td><td>2</td><td><p></p></td></tr>-+<tr><td>LOGIN</td><td>3</td><td><p></p></td></tr>-+<tr><td>CRAM_MD5</td><td>4</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.EmailSetting.SMTPConfig.Encryption">EmailSetting.SMTPConfig.Encryption</h3><p></p><table class="enum-table">@@ -7921,34 +7921,34 @@ Default to this mode.</p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>ENCRYPTION_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>ENCRYPTION_NONE</td><td>1</td><td><p></p></td></tr>-+<tr><td>STARTTLS</td><td>2</td><td><p></p></td></tr>-+<tr><td>SSL_TLS</td><td>3</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.EmailSetting.Type">EmailSetting.Type</h3><p></p><table class="enum-table">@@ -7956,22 +7956,22 @@ Default to this mode.</p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>SMTP</td><td>1</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.Setting.SettingName">Setting.SettingName</h3><p></p><table class="enum-table">@@ -7979,64 +7979,64 @@ Default to this mode.</p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>SETTING_NAME_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>WORKSPACE_PROFILE</td><td>1</td><td><p></p></td></tr>-+<tr><td>WORKSPACE_APPROVAL</td><td>2</td><td><p></p></td></tr>-+<tr><td>APP_IM</td><td>3</td><td><p></p></td></tr>-+<tr><td>AI</td><td>4</td><td><p></p></td></tr>-+<tr><td>DATA_CLASSIFICATION</td><td>5</td><td><p></p></td></tr>-+<tr><td>SEMANTIC_TYPES</td><td>6</td><td><p></p></td></tr>-+<tr><td>ENVIRONMENT</td><td>7</td><td><p></p></td></tr>-+<tr><td>EMAIL</td><td>8</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.WorkspaceApprovalSetting.Rule.Source">WorkspaceApprovalSetting.Rule.Source</h3><p></p><table class="enum-table">@@ -8044,50 +8044,50 @@ Default to this mode.</p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>SOURCE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>CHANGE_DATABASE</td><td>1</td><td><p></p></td></tr>-+<tr><td>CREATE_DATABASE</td><td>2</td><td><p></p></td></tr>-+<tr><td>EXPORT_DATA</td><td>3</td><td><p></p></td></tr>-+<tr><td>REQUEST_ROLE</td><td>4</td><td><p></p></td></tr>-+<tr><td>REQUEST_ACCESS</td><td>5</td><td><p></p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SettingService">SettingService</h3><p>SettingService manages workspace-level settings and configurations.</p><table class="enum-table">@@ -8095,7 +8095,7 @@ Default to this mode.</p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>ListSettings</td><td><a href="#bytebase.v1.ListSettingsRequest">ListSettingsRequest</a></td>@@ -8103,7 +8103,7 @@ Default to this mode.</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>@@ -8111,7 +8111,7 @@ Permissions required: bb.settings.list</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>@@ -8119,7 +8119,7 @@ Permissions required: bb.settings.get</p></td><td><p>Updates a workspace setting.Permissions required: bb.settings.set</p></td></tr>-+<tr><td>TestEmailSetting</td><td><a href="#bytebase.v1.TestEmailSettingRequest">TestEmailSettingRequest</a></td>@@ -8127,13 +8127,13 @@ Permissions required: bb.settings.set</p></td><td><p>Sends a test email using the provided config (without persisting).Permissions required: bb.settings.set</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -8145,132 +8145,132 @@ Permissions required: bb.settings.set</p></td></tr></thead><tbody>---+++<tr><td>ListSettings</td><td>GET</td><td>/v1/settings</td><td></td></tr>----++++<tr><td>GetSetting</td><td>GET</td><td>/v1/{name=settings/*}</td><td></td></tr>----++++<tr><td>UpdateSetting</td><td>PATCH</td><td>/v1/{setting.name=settings/*}</td><td>setting</td></tr>----++++<tr><td>TestEmailSetting</td><td>POST</td><td>/v1/{parent=workspaces/*}/settings/EMAIL:test</td><td>*</td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/actuator_service.proto">v1/actuator_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.ActuatorInfo">ActuatorInfo</h3><p>System information and configuration for the Bytebase instance.</p><p>Actuator concept is similar to the Spring Boot Actuator.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>version</td><td><a href="#string">string</a></td><td></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>The git commit hash of the build. </p></td></tr>-+<tr><td>readonly</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether the Bytebase instance is running in read-only mode. </p></td></tr>-+<tr><td>saas</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether the Bytebase instance is running in SaaS mode where some features cannot be edited by users. </p></td></tr>-+<tr><td>demo</td><td><a href="#bool">bool</a></td><td></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>The host address of the Bytebase instance. </p></td></tr>-+<tr><td>port</td><td><a href="#string">string</a></td><td></td><td><p>The port number of the Bytebase instance. </p></td></tr>-+<tr><td>external_url</td><td><a href="#string">string</a></td><td></td><td><p>The external URL where users or webhook callbacks access Bytebase. </p></td></tr>-+<tr><td>last_active_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p>The last time any API call was made, refreshed on each request. </p></td></tr>-+<tr><td>workspace</td><td><a href="#string">string</a></td>@@ -8278,70 +8278,70 @@ Permissions required: bb.settings.set</p></td><td><p>The unique identifier for the workspace.Format: workspaces/{id} </p></td></tr>-+<tr><td>unlicensed_features</td><td><a href="#string">string</a></td><td>repeated</td><td><p>List of features that are not licensed. </p></td></tr>-+<tr><td>docker</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether the Bytebase instance is running in Docker. </p></td></tr>-+<tr><td>activated_user_count</td><td><a href="#int32">int32</a></td><td></td><td><p>The number of activated users. </p></td></tr>-+<tr><td>activated_instance_count</td><td><a href="#int32">int32</a></td><td></td><td><p>The number of activated database instances. </p></td></tr>-+<tr><td>total_instance_count</td><td><a href="#int32">int32</a></td><td></td><td><p>The total number of database instances. </p></td></tr>-+<tr><td>enable_sample</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether sample data setup is enabled. </p></td></tr>-+<tr><td>external_url_from_flag</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether the external URL is set via command-line flag (and thus cannot be changed via UI). </p></td></tr>-+<tr><td>replica_count</td><td><a href="#int32">int32</a></td><td></td><td><p>The number of active replicas (servers sharing the same database). </p></td></tr>-+<tr><td>restriction</td><td><a href="#bytebase.v1.Restriction">Restriction</a></td><td></td><td><p> </p></td></tr>-+<tr><td>default_project</td><td><a href="#string">string</a></td>@@ -8349,38 +8349,38 @@ Format: workspaces/{id} </p></td><td><p>The default project for unassigned databases.Format: projects/{id} </p></td></tr>-+<tr><td>user_count_in_iam</td><td><a href="#int32">int32</a></td><td></td><td><p>The number of users in the workspace IAM (for seat limit display). </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DeleteCacheRequest">DeleteCacheRequest</h3><p>Request message for deleting cache.</p>---+++<h3 id="bytebase.v1.GetActuatorInfoRequest">GetActuatorInfoRequest</h3><p>Request message for getting actuator information.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -8390,52 +8390,52 @@ Format: workspaces/{workspace}When unset, the workspace is resolved from the request context (self-hosted)or no workspace-scoped fields are returned (SaaS). </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Restriction">Restriction</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>disallow_signup</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether self-service user signup is disabled. </p></td></tr>-+<tr><td>disallow_password_signin</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether password-based signin is disabled (except for workspace admins). </p></td></tr>-+<tr><td>password_restriction</td><td><a href="#bytebase.v1.WorkspaceProfileSetting.PasswordRestriction">WorkspaceProfileSetting.PasswordRestriction</a></td><td></td><td><p>Password complexity and restriction requirements. </p></td></tr>-+<tr><td>allow_email_code_signin</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether email + 6-digit code signin is enabled for this workspace. </p></td></tr>-+<tr><td>password_reset_enabled</td><td><a href="#bool">bool</a></td>@@ -8443,27 +8443,27 @@ or no workspace-scoped fields are returned (SaaS). </p></td><td><p>Whether password reset via email is available for this workspace.True when the workspace (or deployment) has an email setting configured. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SetupSampleRequest">SetupSampleRequest</h3><p>Request message for setting up sample data.</p>------++++++<h3 id="bytebase.v1.ActuatorService">ActuatorService</h3><p>ActuatorService manages system health and operational information.</p><table class="enum-table">@@ -8471,7 +8471,7 @@ True when the workspace (or deployment) has an email setting configured. </p></t<tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>GetActuatorInfo</td><td><a href="#bytebase.v1.GetActuatorInfoRequest">GetActuatorInfoRequest</a></td>@@ -8481,7 +8481,7 @@ When `name` is provided (or the workspace-scoped binding is used), theresponse includes workspace-scoped fields for that workspace.Permissions required: None</p></td></tr>-+<tr><td>SetupSample</td><td><a href="#bytebase.v1.SetupSampleRequest">SetupSampleRequest</a></td>@@ -8489,7 +8489,7 @@ Permissions required: None</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>@@ -8497,13 +8497,13 @@ Permissions required: bb.projects.create</p></td><td><p>Clears the system cache to force data refresh.Permissions required: None</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -8515,201 +8515,201 @@ Permissions required: None</p></td></tr></thead><tbody>---+++<tr><td>GetActuatorInfo</td><td>GET</td><td>/v1/actuator/info</td><td></td></tr>-+<tr><td>GetActuatorInfo</td><td>GET</td><td>/v1/{name=workspaces/*}/actuator/info</td><td></td></tr>----++++<tr><td>SetupSample</td><td>POST</td><td>/v1/actuator:setupSample</td><td></td></tr>----++++<tr><td>DeleteCache</td><td>DELETE</td><td>/v1/actuator/cache</td><td></td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/ai_service.proto">v1/ai_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.AIChatMessage">AIChatMessage</h3><p>A single message in the conversation.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>role</td><td><a href="#bytebase.v1.AIChatMessageRole">AIChatMessageRole</a></td><td></td><td><p>The role of the message sender. </p></td></tr>-+<tr><td>content</td><td><a href="#string">string</a></td><td>optional</td><td><p>The text content of the message. Optional for assistant messages that only contain tool calls. </p></td></tr>-+<tr><td>tool_calls</td><td><a href="#bytebase.v1.AIChatToolCall">AIChatToolCall</a></td><td>repeated</td><td><p>Tool calls made by the assistant. Only present in assistant messages. </p></td></tr>-+<tr><td>tool_call_id</td><td><a href="#string">string</a></td><td>optional</td><td><p>The ID of the tool call this message is responding to. Only present in tool messages. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AIChatRequest">AIChatRequest</h3><p>Request message for AIService.Chat.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>messages</td><td><a href="#bytebase.v1.AIChatMessage">AIChatMessage</a></td><td>repeated</td><td><p>The conversation messages. </p></td></tr>-+<tr><td>tool_definitions</td><td><a href="#bytebase.v1.AIChatToolDefinition">AIChatToolDefinition</a></td><td>repeated</td><td><p>The tool definitions available to the AI. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AIChatResponse">AIChatResponse</h3><p>Response message for AIService.Chat.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>content</td><td><a href="#string">string</a></td><td>optional</td><td><p>The text content of the AI response. Optional when the response only contains tool calls. </p></td></tr>-+<tr><td>tool_calls</td><td><a href="#bytebase.v1.AIChatToolCall">AIChatToolCall</a></td><td>repeated</td><td><p>Tool calls the AI wants to make. </p></td></tr>-+<tr><td>usage</td><td><a href="#bytebase.v1.AIChatUsage">AIChatUsage</a></td><td>optional</td><td><p>Token usage for this provider call, when available. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AIChatToolCall">AIChatToolCall</h3><p>A tool call made by the AI.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>id</td><td><a href="#string">string</a></td><td></td><td><p>The unique ID of this tool call. </p></td></tr>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the tool to call. </p></td></tr>-+<tr><td>arguments</td><td><a href="#string">string</a></td><td></td><td><p>The JSON-encoded arguments to pass to the tool. </p></td></tr>-+<tr><td>metadata</td><td><a href="#string">string</a></td>@@ -8717,78 +8717,78 @@ Permissions required: None</p></td><td><p>Opaque provider-specific metadata (e.g., Gemini thought_signature).Frontend must echo this back unchanged when sending tool results. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AIChatToolDefinition">AIChatToolDefinition</h3><p>A tool definition that the AI can invoke.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the tool. </p></td></tr>-+<tr><td>description</td><td><a href="#string">string</a></td><td></td><td><p>A description of what the tool does. </p></td></tr>-+<tr><td>parameters_schema</td><td><a href="#string">string</a></td><td></td><td><p>The JSON Schema describing the tool's parameters. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AIChatUsage">AIChatUsage</h3><p>Token usage for a single AI provider call.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>total_tokens</td><td><a href="#int32">int32</a></td><td></td><td><p>Total tokens used by the provider call. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.AIChatMessageRole">AIChatMessageRole</h3><p>Role of a chat message.</p><table class="enum-table">@@ -8796,44 +8796,44 @@ Frontend must echo this back unchanged when sending tool results. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>AI_CHAT_MESSAGE_ROLE_UNSPECIFIED</td><td>0</td><td><p>Unspecified role.</p></td></tr>-+<tr><td>AI_CHAT_MESSAGE_ROLE_SYSTEM</td><td>1</td><td><p>System message providing instructions.</p></td></tr>-+<tr><td>AI_CHAT_MESSAGE_ROLE_USER</td><td>2</td><td><p>User message.</p></td></tr>-+<tr><td>AI_CHAT_MESSAGE_ROLE_ASSISTANT</td><td>3</td><td><p>Assistant (AI) message.</p></td></tr>-+<tr><td>AI_CHAT_MESSAGE_ROLE_TOOL</td><td>4</td><td><p>Tool result message.</p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AIService">AIService</h3><p>AIService provides AI chat capabilities for the page agent.</p><table class="enum-table">@@ -8841,7 +8841,7 @@ Frontend must echo this back unchanged when sending tool results. </p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>Chat</td><td><a href="#bytebase.v1.AIChatRequest">AIChatRequest</a></td>@@ -8849,13 +8849,13 @@ Frontend must echo this back unchanged when sending tool results. </p></td><td><p>Chat sends a conversation with tool definitions to the configured AI providerand returns the AI response.</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -8867,39 +8867,39 @@ and returns the AI response.</p></td></tr></thead><tbody>---+++<tr><td>Chat</td><td>POST</td><td>/v1/ai/chat</td><td>*</td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/iam_policy.proto">v1/iam_policy.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.Binding">Binding</h3><p>Binding associates members with a role and optional conditions.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>role</td><td><a href="#string">string</a></td>@@ -8907,7 +8907,7 @@ and returns the AI response.</p></td><td><p>The role that is assigned to the members.Format: roles/{role} </p></td></tr>-+<tr><td>members</td><td><a href="#string">string</a></td>@@ -8918,7 +8918,7 @@ For groups, the member should be: group:{email}For service accounts, the member should be: serviceAccount:{email}For workload identities, the member should be: workloadIdentity:{email} </p></td></tr>-+<tr><td>condition</td><td><a href="#google.type.Expr">google.type.Expr</a></td>@@ -8941,38 +8941,38 @@ resource.database == "instances/local-pg/databases/bytebase" &&resource.database == "instances/local-pg/databases/postgres" && resource.environment_id in ["test"]request.time < timestamp("2025-04-26T11:24:48.655Z") </p></td></tr>-+<tr><td>parsed_expr</td><td><a href="#google.api.expr.v1alpha1.Expr">google.api.expr.v1alpha1.Expr</a></td><td></td><td><p>The parsed expression of the condition. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BindingDelta">BindingDelta</h3><p>A single change to a binding.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>action</td><td><a href="#bytebase.v1.BindingDelta.Action">BindingDelta.Action</a></td><td></td><td><p>The action that was performed on a Binding. </p></td></tr>-+<tr><td>role</td><td><a href="#string">string</a></td>@@ -8980,38 +8980,38 @@ request.time < timestamp("2025-04-26T11:24:48.655Z") </p></td><td><p>Role that is assigned to `members`.For example, `roles/projectOwner`. </p></td></tr>-+<tr><td>member</td><td><a href="#string">string</a></td><td></td><td><p>Follows the same format of Binding.members. </p></td></tr>-+<tr><td>condition</td><td><a href="#google.type.Expr">google.type.Expr</a></td><td></td><td><p>The condition that is associated with this binding. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetIamPolicyRequest">GetIamPolicyRequest</h3><p>Request message for getting an IAM policy.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>resource</td><td><a href="#string">string</a></td>@@ -9020,24 +9020,24 @@ For example, `roles/projectOwner`. </p></td>Format: projects/{project}Format: workspaces/{workspace} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.IamPolicy">IamPolicy</h3><p>IAM policy that binds members to roles.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>bindings</td><td><a href="#bytebase.v1.Binding">Binding</a></td>@@ -9045,7 +9045,7 @@ Format: workspaces/{workspace} </p></td><td><p>Collection of binding.A binding binds one or more project members to a single project role. </p></td></tr>-+<tr><td>etag</td><td><a href="#string">string</a></td>@@ -9054,48 +9054,48 @@ A binding binds one or more project members to a single project role. </p></td>If an etag is provided and does not match the current etag of the policy,the call will be blocked and an ABORTED error will be returned. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.PolicyDelta">PolicyDelta</h3><p>Describes changes between two IAM policies.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>binding_deltas</td><td><a href="#bytebase.v1.BindingDelta">BindingDelta</a></td><td>repeated</td><td><p>The delta for Bindings between two policies. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SetIamPolicyRequest">SetIamPolicyRequest</h3><p>Request message for setting an IAM policy.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>resource</td><td><a href="#string">string</a></td>@@ -9104,30 +9104,30 @@ the call will be blocked and an ABORTED error will be returned. </p></td>Format: projects/{project}Format: workspaces/{workspace} </p></td></tr>-+<tr><td>policy</td><td><a href="#bytebase.v1.IamPolicy">IamPolicy</a></td><td></td><td><p> </p></td></tr>-+<tr><td>etag</td><td><a href="#string">string</a></td><td></td><td><p>The current etag of the policy. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.BindingDelta.Action">BindingDelta.Action</h3><p>Type of action performed on a binding.</p><table class="enum-table">@@ -9135,74 +9135,74 @@ Format: workspaces/{workspace} </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>ACTION_UNSPECIFIED</td><td>0</td><td><p>Unspecified action.</p></td></tr>-+<tr><td>ADD</td><td>1</td><td><p>Add a binding.</p></td></tr>-+<tr><td>REMOVE</td><td>2</td><td><p>Remove a binding.</p></td></tr>-+</tbody></table>-----+++++<div class="file-heading"><h2 id="v1/audit_log_service.proto">v1/audit_log_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.AuditData">AuditData</h3><p>Additional audit data specific to certain operations.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>policy_delta</td><td><a href="#bytebase.v1.PolicyDelta">PolicyDelta</a></td><td></td><td><p>Changes to IAM policies. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AuditLog">AuditLog</h3><p>Audit log entry recording system activity or API call.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -9212,14 +9212,14 @@ Formats:- projects/{project}/auditLogs/{uid}- workspaces/{workspace}/auditLogs/{uid} </p></td></tr>-+<tr><td>create_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p>The timestamp when the audit log was created. </p></td></tr>-+<tr><td>user</td><td><a href="#string">string</a></td>@@ -9227,7 +9227,7 @@ Formats:<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>@@ -9235,28 +9235,28 @@ Format: users/{email} </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>The severity level of this audit log entry. </p></td></tr>-+<tr><td>resource</td><td><a href="#string">string</a></td><td></td><td><p>The resource associated with this audit log. </p></td></tr>-+<tr><td>request</td><td><a href="#string">string</a></td><td></td><td><p>The request payload in JSON format. </p></td></tr>-+<tr><td>response</td><td><a href="#string">string</a></td>@@ -9264,59 +9264,59 @@ For example: /bytebase.v1.SQLService/Query or bb.project.repository.push </p></t<td><p>The response payload in JSON format.Some fields may be omitted if they are too large or contain sensitive information. </p></td></tr>-+<tr><td>status</td><td><a href="#google.rpc.Status">google.rpc.Status</a></td><td></td><td><p>The status of the operation. </p></td></tr>-+<tr><td>latency</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td><td><p>The duration of the operation. </p></td></tr>-+<tr><td>service_data</td><td><a href="#google.protobuf.Any">google.protobuf.Any</a></td><td></td><td><p>Service-specific metadata about the request, response, and activities. </p></td></tr>-+<tr><td>request_metadata</td><td><a href="#bytebase.v1.RequestMetadata">RequestMetadata</a></td><td></td><td><p>Metadata about the request context. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ExportAuditLogsRequest">ExportAuditLogsRequest</h3><p>Request message for exporting audit logs.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>filter</td><td><a href="#string">string</a></td>@@ -9324,7 +9324,7 @@ Some fields may be omitted if they are too large or contain sensitive informatio<td><p>The filter of the log. It should be a valid CEL expression.Check the filter field in the SearchAuditLogsRequest message. </p></td></tr>-+<tr><td>order_by</td><td><a href="#string">string</a></td>@@ -9335,14 +9335,14 @@ For example:- order_by = "create_time asc"- order_by = "create_time desc" </p></td></tr>-+<tr><td>format</td><td><a href="#bytebase.v1.ExportFormat">ExportFormat</a></td><td></td><td><p>The export format. </p></td></tr>-+<tr><td>page_size</td><td><a href="#int32">int32</a></td>@@ -9352,7 +9352,7 @@ The service may return fewer than this value.If unspecified, at most 10 log entries will be returned.The maximum value is 5000; values above 5000 will be coerced to 5000. </p></td></tr>-+<tr><td>page_token</td><td><a href="#string">string</a></td>@@ -9360,31 +9360,31 @@ The maximum value is 5000; values above 5000 will be coerced to 5000. </p></td><td><p>A page token, received from a previous `ExportAuditLogs` call.Provide this to retrieve the subsequent page. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ExportAuditLogsResponse">ExportAuditLogsResponse</h3><p>Response message for exporting audit logs.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>content</td><td><a href="#bytes">bytes</a></td><td></td><td><p>The exported audit log content in the requested format. </p></td></tr>-+<tr><td>next_page_token</td><td><a href="#string">string</a></td>@@ -9393,31 +9393,31 @@ Provide this to retrieve the subsequent page. </p></td>Pass this value in the page_token field in the subsequent callto retrieve the next page of log entities. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.RequestMetadata">RequestMetadata</h3><p>Metadata about the incoming request.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>caller_ip</td><td><a href="#string">string</a></td><td></td><td><p>The IP address of the request originator. </p></td></tr>-+<tr><td>caller_supplied_user_agent</td><td><a href="#string">string</a></td>@@ -9425,31 +9425,31 @@ to retrieve the next page of log entities. </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></table>---+++<h3 id="bytebase.v1.SearchAuditLogsRequest">SearchAuditLogsRequest</h3><p>Request message for searching audit logs.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>filter</td><td><a href="#string">string</a></td>@@ -9469,7 +9469,7 @@ For example:- filter = "method == '/bytebase.v1.SQLService/Query' && severity == 'ERROR' && user == 'users/[email protected]'"- filter = "method == '/bytebase.v1.SQLService/Query' && severity == 'ERROR' && create_time <= '2021-01-01T00:00:00Z' && create_time >= '2020-01-01T00:00:00Z'" </p></td></tr>-+<tr><td>order_by</td><td><a href="#string">string</a></td>@@ -9480,7 +9480,7 @@ For example:- order_by = "create_time asc"- order_by = "create_time desc" </p></td></tr>-+<tr><td>page_size</td><td><a href="#int32">int32</a></td>@@ -9490,7 +9490,7 @@ The service may return fewer than this value.If unspecified, at most 10 log entries will be returned.The maximum value is 5000; values above 5000 will be coerced to 5000. </p></td></tr>-+<tr><td>page_token</td><td><a href="#string">string</a></td>@@ -9498,31 +9498,31 @@ The maximum value is 5000; values above 5000 will be coerced to 5000. </p></td><td><p>A page token, received from a previous `SearchLogs` call.Provide this to retrieve the subsequent page. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SearchAuditLogsResponse">SearchAuditLogsResponse</h3><p>Response message for searching audit logs.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>audit_logs</td><td><a href="#bytebase.v1.AuditLog">AuditLog</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>next_page_token</td><td><a href="#string">string</a></td>@@ -9531,16 +9531,16 @@ Provide this to retrieve the subsequent page. </p></td>Pass this value in the page_token field in the subsequent callto retrieve the next page of log entities. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.AuditLog.Severity">AuditLog.Severity</h3><p>Severity level for audit log entries.</p><table class="enum-table">@@ -9548,68 +9548,68 @@ to retrieve the next page of log entities. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>SEVERITY_UNSPECIFIED</td><td>0</td><td><p>Unspecified severity level.</p></td></tr>-+<tr><td>DEBUG</td><td>1</td><td><p>Debug-level information.</p></td></tr>-+<tr><td>INFO</td><td>2</td><td><p>Informational messages.</p></td></tr>-+<tr><td>NOTICE</td><td>3</td><td><p>Notable events.</p></td></tr>-+<tr><td>WARNING</td><td>4</td><td><p>Warning conditions.</p></td></tr>-+<tr><td>ERROR</td><td>5</td><td><p>Error conditions.</p></td></tr>-+<tr><td>CRITICAL</td><td>6</td><td><p>Critical conditions.</p></td></tr>-+<tr><td>ALERT</td><td>7</td><td><p>Action must be taken immediately.</p></td></tr>-+<tr><td>EMERGENCY</td><td>8</td><td><p>System is unusable.</p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AuditLogService">AuditLogService</h3><p>AuditLogService manages audit logs for system activities and API calls.</p><table class="enum-table">@@ -9617,7 +9617,7 @@ to retrieve the next page of log entities. </p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>SearchAuditLogs</td><td><a href="#bytebase.v1.SearchAuditLogsRequest">SearchAuditLogsRequest</a></td>@@ -9625,7 +9625,7 @@ to retrieve the next page of log entities. </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>@@ -9633,13 +9633,13 @@ Permissions required: bb.auditLogs.search</p></td><td><p>Exports audit logs in a specified format for external analysis.Permissions required: bb.auditLogs.export</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -9651,63 +9651,63 @@ Permissions required: bb.auditLogs.export</p></td></tr></thead><tbody>---+++<tr><td>SearchAuditLogs</td><td>POST</td><td>/v1/{parent=projects/*}/auditLogs:search</td><td>*</td></tr>-+<tr><td>SearchAuditLogs</td><td>POST</td><td>/v1/auditLogs:search</td><td>*</td></tr>----++++<tr><td>ExportAuditLogs</td><td>POST</td><td>/v1/{parent=projects/*}/auditLogs:export</td><td>*</td></tr>-+<tr><td>ExportAuditLogs</td><td>POST</td><td>/v1/auditLogs:export</td><td>*</td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/user_service.proto">v1/user_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.BatchGetUsersRequest">BatchGetUsersRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>names</td><td><a href="#string">string</a></td>@@ -9715,72 +9715,72 @@ Permissions required: bb.auditLogs.export</p></td><td><p>The user names to retrieve.Format: users/{email} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BatchGetUsersResponse">BatchGetUsersResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>users</td><td><a href="#bytebase.v1.User">User</a></td><td>repeated</td><td><p>The users from the specified request. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.CreateUserRequest">CreateUserRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>user</td><td><a href="#bytebase.v1.User">User</a></td><td></td><td><p>The user to create. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DeleteUserRequest">DeleteUserRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -9788,24 +9788,24 @@ Format: users/{email} </p></td><td><p>The name of the user to delete.Format: users/{email} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetUserRequest">GetUserRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -9813,24 +9813,24 @@ Format: users/{email} </p></td><td><p>The name of the user to retrieve.Format: users/{email} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListUsersRequest">ListUsersRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>page_size</td><td><a href="#int32">int32</a></td>@@ -9840,7 +9840,7 @@ this value.If unspecified, at most 10 users will be returned.The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td></tr>-+<tr><td>page_token</td><td><a href="#string">string</a></td>@@ -9851,14 +9851,14 @@ Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `ListUsers` must matchthe call that provided the page token. </p></td></tr>-+<tr><td>show_deleted</td><td><a href="#bool">bool</a></td><td></td><td><p>Show deleted users if specified. </p></td></tr>-+<tr><td>filter</td><td><a href="#string">string</a></td>@@ -9883,31 +9883,31 @@ You can combine filter conditions like:name.contains("ed") && project == "projects/sample-project"(name == "ed" || email == "[email protected]") && project == "projects/sample-project" </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListUsersResponse">ListUsersResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>users</td><td><a href="#bytebase.v1.User">User</a></td><td>repeated</td><td><p>The users from the specified request. </p></td></tr>-+<tr><td>next_page_token</td><td><a href="#string">string</a></td>@@ -9915,24 +9915,24 @@ name.contains("ed") && project == "projects/sample-project&#<td><p>A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UndeleteUserRequest">UndeleteUserRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -9940,24 +9940,24 @@ If this field is omitted, there are no subsequent pages. </p></td><td><p>The name of the deleted user.Format: users/{email} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdateEmailRequest">UpdateEmailRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -9966,31 +9966,31 @@ Format: users/{email} </p></td>Format: users/{email}Note: This is the current (old) email address. The new email is specified in the 'email' field. </p></td></tr>-+<tr><td>email</td><td><a href="#string">string</a></td><td></td><td><p>The new email address. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdateUserRequest">UpdateUserRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>user</td><td><a href="#bytebase.v1.User">User</a></td>@@ -10000,21 +10000,21 @@ Note: This is the current (old) email address. The new email is specified in theThe user's `name` field is used to identify the user to update.Format: users/{email} </p></td></tr>-+<tr><td>update_mask</td><td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td><td></td><td><p>The list of fields to update. </p></td></tr>-+<tr><td>otp_code</td><td><a href="#string">string</a></td><td>optional</td><td><p>The otp_code is used to verify the user's identity by MFA. </p></td></tr>-+<tr><td>regenerate_temp_mfa_secret</td><td><a href="#bool">bool</a></td>@@ -10022,14 +10022,14 @@ Format: users/{email} </p></td><td><p>The regenerate_temp_mfa_secret flag means to regenerate temporary MFA secret for user.This is used for MFA setup. The temporary MFA secret and recovery codes will be returned in the response. </p></td></tr>-+<tr><td>regenerate_recovery_codes</td><td><a href="#bool">bool</a></td><td></td><td><p>The regenerate_recovery_codes flag means to regenerate recovery codes for user. </p></td></tr>-+<tr><td>allow_missing</td><td><a href="#bool">bool</a></td>@@ -10037,24 +10037,24 @@ This is used for MFA setup. The temporary MFA secret and recovery codes will be<td><p>If set to true, and the user is not found, a new user will be created.In this situation, `update_mask` is ignored. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.User">User</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -10062,70 +10062,70 @@ In this situation, `update_mask` is ignored. </p></td><td><p>The name of the user.Format: users/{email} </p></td></tr>-+<tr><td>state</td><td><a href="#bytebase.v1.State">State</a></td><td></td><td><p>The lifecycle state of the user account. </p></td></tr>-+<tr><td>email</td><td><a href="#string">string</a></td><td></td><td><p>The email address of the user, used for login and notifications. </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>The display title or full name of the user. </p></td></tr>-+<tr><td>password</td><td><a href="#string">string</a></td><td></td><td><p>The password for authentication. Only used during user creation or password updates. </p></td></tr>-+<tr><td>service_key</td><td><a href="#string">string</a></td><td></td><td><p>The service key for service account authentication. </p></td></tr>-+<tr><td>mfa_enabled</td><td><a href="#bool">bool</a></td><td></td><td><p>The mfa_enabled flag means if the user has enabled MFA. </p></td></tr>-+<tr><td>temp_otp_secret</td><td><a href="#string">string</a></td><td></td><td><p>Temporary OTP secret used during MFA setup and regeneration. </p></td></tr>-+<tr><td>temp_recovery_codes</td><td><a href="#string">string</a></td><td>repeated</td><td><p>Temporary recovery codes used during MFA setup and regeneration. </p></td></tr>-+<tr><td>temp_otp_secret_created_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p>Timestamp when temp_otp_secret was created. Used by frontend to show countdown timer. </p></td></tr>-+<tr><td>phone</td><td><a href="#string">string</a></td>@@ -10133,14 +10133,14 @@ Format: users/{email} </p></td><td><p>Should be a valid E.164 compliant phone number.Could be empty. </p></td></tr>-+<tr><td>profile</td><td><a href="#bytebase.v1.User.Profile">User.Profile</a></td><td></td><td><p>User profile metadata. </p></td></tr>-+<tr><td>groups</td><td><a href="#string">string</a></td>@@ -10148,7 +10148,7 @@ Could be empty. </p></td><td><p>The groups for the user.Format: groups/{email} </p></td></tr>-+<tr><td>workspace</td><td><a href="#string">string</a></td>@@ -10156,58 +10156,58 @@ Format: groups/{email} </p></td><td><p>The current workspace.Format: workspaces/{id} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.User.Profile">User.Profile</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>last_login_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p>The last time the user successfully logged in. </p></td></tr>-+<tr><td>last_change_password_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p>The last time the user changed their password. </p></td></tr>-+<tr><td>source</td><td><a href="#string">string</a></td><td></td><td><p>source means where the user comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID. </p></td></tr>-+</tbody></table>------++++++<h3 id="bytebase.v1.UserService">UserService</h3><p>UserService manages user accounts and authentication.</p><table class="enum-table">@@ -10215,7 +10215,7 @@ Format: workspaces/{id} </p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>GetUser</td><td><a href="#bytebase.v1.GetUserRequest">GetUserRequest</a></td>@@ -10224,7 +10224,7 @@ Format: workspaces/{id} </p></td>Any authenticated user can get the user.Permissions required: bb.users.get</p></td></tr>-+<tr><td>BatchGetUsers</td><td><a href="#bytebase.v1.BatchGetUsersRequest">BatchGetUsersRequest</a></td>@@ -10233,7 +10233,7 @@ Permissions required: bb.users.get</p></td>Any authenticated user can batch get users.Permissions required: bb.users.get</p></td></tr>-+<tr><td>GetCurrentUser</td><td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>@@ -10241,7 +10241,7 @@ Permissions required: bb.users.get</p></td><td><p>Get the current authenticated user.Permissions required: None</p></td></tr>-+<tr><td>ListUsers</td><td><a href="#bytebase.v1.ListUsersRequest">ListUsersRequest</a></td>@@ -10250,7 +10250,7 @@ Permissions required: None</p></td>Any authenticated user can list users.Permissions required: bb.users.list</p></td></tr>-+<tr><td>CreateUser</td><td><a href="#bytebase.v1.CreateUserRequest">CreateUserRequest</a></td>@@ -10259,7 +10259,7 @@ Permissions required: bb.users.list</p></td>In SaaS mode, admins should add users via workspace IAM policy instead.Permissions required: bb.users.create</p></td></tr>-+<tr><td>UpdateUser</td><td><a href="#bytebase.v1.UpdateUserRequest">UpdateUserRequest</a></td>@@ -10268,7 +10268,7 @@ Permissions required: bb.users.create</p></td>Note: Email updates are not supported through this API. Use UpdateEmail instead.Permissions required: bb.users.update (or self)</p></td></tr>-+<tr><td>DeleteUser</td><td><a href="#bytebase.v1.DeleteUserRequest">DeleteUserRequest</a></td>@@ -10276,7 +10276,7 @@ Permissions required: bb.users.update (or self)</p></td><td><p>Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted.Permissions required: bb.users.delete</p></td></tr>-+<tr><td>UndeleteUser</td><td><a href="#bytebase.v1.UndeleteUserRequest">UndeleteUserRequest</a></td>@@ -10284,7 +10284,7 @@ Permissions required: bb.users.delete</p></td><td><p>Restores a deleted user.Permissions required: bb.users.undelete</p></td></tr>-+<tr><td>UpdateEmail</td><td><a href="#bytebase.v1.UpdateEmailRequest">UpdateEmailRequest</a></td>@@ -10292,13 +10292,13 @@ Permissions required: bb.users.undelete</p></td><td><p>Updates a user's email address.Permissions required: bb.users.updateEmail</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -10310,126 +10310,126 @@ Permissions required: bb.users.updateEmail</p></td></tr></thead><tbody>---+++<tr><td>GetUser</td><td>GET</td><td>/v1/{name=users/*}</td><td></td></tr>----++++<tr><td>BatchGetUsers</td><td>GET</td><td>/v1/users:batchGet</td><td></td></tr>----++++<tr><td>GetCurrentUser</td><td>GET</td><td>/v1/users/me</td><td></td></tr>----++++<tr><td>ListUsers</td><td>GET</td><td>/v1/users</td><td></td></tr>----++++<tr><td>CreateUser</td><td>POST</td><td>/v1/users</td><td>user</td></tr>----++++<tr><td>UpdateUser</td><td>PATCH</td><td>/v1/{user.name=users/*}</td><td>user</td></tr>----++++<tr><td>DeleteUser</td><td>DELETE</td><td>/v1/{name=users/*}</td><td></td></tr>----++++<tr><td>UndeleteUser</td><td>POST</td><td>/v1/{name=users/*}:undelete</td><td>*</td></tr>----++++<tr><td>UpdateEmail</td><td>POST</td><td>/v1/{name=users/*}:updateEmail</td><td>*</td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/auth_service.proto">v1/auth_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.ExchangeTokenRequest">ExchangeTokenRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>token</td><td><a href="#string">string</a></td><td></td><td><p>External OIDC token (JWT) from CI/CD platform. </p></td></tr>-+<tr><td>email</td><td><a href="#string">string</a></td>@@ -10437,93 +10437,93 @@ Permissions required: bb.users.updateEmail</p></td><td><p>Workload Identity email for identifying which identity to authenticate as.Format: {name}@workload.bytebase.com </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ExchangeTokenResponse">ExchangeTokenResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>access_token</td><td><a href="#string">string</a></td><td></td><td><p>Bytebase access token. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.IdentityProviderContext">IdentityProviderContext</h3><p>Context for identity provider authentication.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>oauth2_context</td><td><a href="#bytebase.v1.OAuth2IdentityProviderContext">OAuth2IdentityProviderContext</a></td><td></td><td><p>OAuth2 authentication context. </p></td></tr>-+<tr><td>oidc_context</td><td><a href="#bytebase.v1.OIDCIdentityProviderContext">OIDCIdentityProviderContext</a></td><td></td><td><p>OpenID Connect authentication context. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.LoginRequest">LoginRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>email</td><td><a href="#string">string</a></td><td></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>User's password for authentication. </p></td></tr>-+<tr><td>web</td><td><a href="#bool">bool</a></td>@@ -10531,7 +10531,7 @@ Format: {name}@workload.bytebase.com </p></td><td><p>If true, sets access token and refresh token as HTTP-only cookies instead ofreturning the token in the response body. Use for browser-based clients. </p></td></tr>-+<tr><td>idp_name</td><td><a href="#string">string</a></td>@@ -10539,35 +10539,35 @@ returning the token in the response body. Use for browser-based clients. </p></t<td><p>The name of the identity provider.Format: idps/{idp} </p></td></tr>-+<tr><td>idp_context</td><td><a href="#bytebase.v1.IdentityProviderContext">IdentityProviderContext</a></td><td></td><td><p>The idp_context is used to get the user information from identity provider. </p></td></tr>-+<tr><td>otp_code</td><td><a href="#string">string</a></td><td>optional</td><td><p>The otp_code is used to verify the user's identity by MFA. </p></td></tr>-+<tr><td>recovery_code</td><td><a href="#string">string</a></td><td>optional</td><td><p>The recovery_code is used to recovery the user's identity with MFA. </p></td></tr>-+<tr><td>mfa_temp_token</td><td><a href="#string">string</a></td><td>optional</td><td><p>The mfa_temp_token is used to verify the user's identity by MFA. </p></td></tr>-+<tr><td>email_code</td><td><a href="#string">string</a></td>@@ -10575,7 +10575,7 @@ Format: idps/{idp} </p></td><td><p>6-digit code from email for passwordless login/signup.Pairs with `email`. Mutually exclusive with `password` and `idp_name`. </p></td></tr>-+<tr><td>workspace</td><td><a href="#string">string</a></td>@@ -10586,24 +10586,24 @@ resolution (last login workspace → first membership). Typically populatedfrom the ?workspace= query parameter in invite links.Format: workspaces/{workspace} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.LoginResponse">LoginResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>token</td><td><a href="#string">string</a></td>@@ -10611,121 +10611,121 @@ Format: workspaces/{workspace} </p></td><td><p>Access token for authenticated requests.Only returned when web=false. For web=true, the token is set as an HTTP-only cookie. </p></td></tr>-+<tr><td>mfa_temp_token</td><td><a href="#string">string</a></td><td>optional</td><td><p>Temporary token for MFA verification. </p></td></tr>-+<tr><td>require_reset_password</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether user must reset password before continuing. </p></td></tr>-+<tr><td>user</td><td><a href="#bytebase.v1.User">User</a></td><td></td><td><p>The user from the successful login. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.LogoutRequest">LogoutRequest</h3><p>Request to logout current user session.</p>---+++<h3 id="bytebase.v1.OAuth2IdentityProviderContext">OAuth2IdentityProviderContext</h3><p>OAuth2 authentication context.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>code</td><td><a href="#string">string</a></td><td></td><td><p>Authorization code from OAuth2 provider. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.OIDCIdentityProviderContext">OIDCIdentityProviderContext</h3><p>OpenID Connect authentication context.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>code</td><td><a href="#string">string</a></td><td></td><td><p>Authorization code from OIDC provider. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.RefreshRequest">RefreshRequest</h3><p>Request to refresh the access token.</p>---+++<h3 id="bytebase.v1.RefreshResponse">RefreshResponse</h3><p>Response from refreshing the access token.</p>---+++<h3 id="bytebase.v1.RequestPasswordResetRequest">RequestPasswordResetRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>email</td><td><a href="#string">string</a></td><td></td><td><p>The email address of the account to reset. </p></td></tr>-+<tr><td>workspace</td><td><a href="#string">string</a></td>@@ -10735,69 +10735,69 @@ and later (at verify time) for signup gate checks and workspace assignment.Unset for SaaS brand-new signup (no workspace exists yet).Format: workspaces/{workspace} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ResetPasswordRequest">ResetPasswordRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>email</td><td><a href="#string">string</a></td><td></td><td><p>The email address of the account. </p></td></tr>-+<tr><td>code</td><td><a href="#string">string</a></td><td></td><td><p>The 6-digit code from the reset email. </p></td></tr>-+<tr><td>new_password</td><td><a href="#string">string</a></td><td></td><td><p>The new password to set. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SendEmailLoginCodeRequest">SendEmailLoginCodeRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>email</td><td><a href="#string">string</a></td><td></td><td><p>The email address to send the code to. </p></td></tr>-+<tr><td>workspace</td><td><a href="#string">string</a></td>@@ -10807,62 +10807,62 @@ and later (at verify time) for signup gate checks and workspace assignment.Unset for SaaS brand-new signup (no workspace exists yet).Format: workspaces/{workspace} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SignupRequest">SignupRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>email</td><td><a href="#string">string</a></td><td></td><td><p>The email for the new account. </p></td></tr>-+<tr><td>password</td><td><a href="#string">string</a></td><td></td><td><p>The password for the new account. </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>The display name of the user. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SwitchWorkspaceRequest">SwitchWorkspaceRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>workspace</td><td><a href="#string">string</a></td>@@ -10870,48 +10870,48 @@ Format: workspaces/{workspace} </p></td><td><p>The target workspace to switch to.Format: workspaces/{workspace} </p></td></tr>-+<tr><td>web</td><td><a href="#bool">bool</a></td><td></td><td><p>If true, sets tokens as HTTP-only cookies (browser clients). </p></td></tr>-+<tr><td>otp_code</td><td><a href="#string">string</a></td><td>optional</td><td><p>OTP code for MFA verification. Required if the target workspace enforces MFA. </p></td></tr>-+<tr><td>recovery_code</td><td><a href="#string">string</a></td><td>optional</td><td><p>Recovery code for MFA verification (alternative to otp_code). </p></td></tr>-+<tr><td>mfa_temp_token</td><td><a href="#string">string</a></td><td>optional</td><td><p>Temporary MFA token from a previous SwitchWorkspace call that returned mfa_temp_token. </p></td></tr>-+</tbody></table>------++++++<h3 id="bytebase.v1.AuthService">AuthService</h3><p>AuthService handles user authentication operations.</p><table class="enum-table">@@ -10919,7 +10919,7 @@ Format: workspaces/{workspace} </p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>Login</td><td><a href="#bytebase.v1.LoginRequest">LoginRequest</a></td>@@ -10927,7 +10927,7 @@ Format: workspaces/{workspace} </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>@@ -10935,7 +10935,7 @@ Permissions required: None</p></td><td><p>Logs out the current user session.Permissions required: None</p></td></tr>-+<tr><td>ExchangeToken</td><td><a href="#bytebase.v1.ExchangeTokenRequest">ExchangeTokenRequest</a></td>@@ -10944,7 +10944,7 @@ Permissions required: None</p></td>Used by CI/CD pipelines with Workload Identity Federation.Permissions required: None (validates via OIDC token)</p></td></tr>-+<tr><td>Signup</td><td><a href="#bytebase.v1.SignupRequest">SignupRequest</a></td>@@ -10954,7 +10954,7 @@ Permissions required: None (validates via OIDC token)</p></td>- Otherwise, creates a new workspace with the user as admin.Returns access tokens so the user is logged in immediately after signup.</p></td></tr>-+<tr><td>Refresh</td><td><a href="#bytebase.v1.RefreshRequest">RefreshRequest</a></td>@@ -10962,7 +10962,7 @@ Returns access tokens so the user is logged in immediately after signup.</p></td<td><p>Refreshes the access token using the refresh token cookie.Permissions required: None (validates via refresh token cookie)</p></td></tr>-+<tr><td>SwitchWorkspace</td><td><a href="#bytebase.v1.SwitchWorkspaceRequest">SwitchWorkspaceRequest</a></td>@@ -10970,7 +10970,7 @@ Permissions required: None (validates via refresh token cookie)</p></td><td><p>Switches the current user's active workspace and issues new tokens.The user must be a member of the target workspace.</p></td></tr>-+<tr><td>RequestPasswordReset</td><td><a href="#bytebase.v1.RequestPasswordResetRequest">RequestPasswordResetRequest</a></td>@@ -10979,7 +10979,7 @@ The user must be a member of the target workspace.</p></td>Always returns success to avoid leaking whether the email exists.Permissions required: None</p></td></tr>-+<tr><td>ResetPassword</td><td><a href="#bytebase.v1.ResetPasswordRequest">ResetPasswordRequest</a></td>@@ -10987,7 +10987,7 @@ Permissions required: None</p></td><td><p>Resets the user's password using a password reset token from email.Permissions required: None (validates via token)</p></td></tr>-+<tr><td>SendEmailLoginCode</td><td><a href="#bytebase.v1.SendEmailLoginCodeRequest">SendEmailLoginCodeRequest</a></td>@@ -10996,13 +10996,13 @@ Permissions required: None (validates via token)</p></td>Always returns success (no email enumeration). Enforces 60-sec resend cooldown.Permissions required: None</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -11014,211 +11014,211 @@ Permissions required: None</p></td></tr></thead><tbody>---+++<tr><td>Login</td><td>POST</td><td>/v1/auth/login</td><td>*</td></tr>----++++<tr><td>Logout</td><td>POST</td><td>/v1/auth/logout</td><td>*</td></tr>----++++<tr><td>ExchangeToken</td><td>POST</td><td>/v1/auth:exchangeToken</td><td>*</td></tr>----++++<tr><td>Signup</td><td>POST</td><td>/v1/auth/signup</td><td>*</td></tr>----++++<tr><td>Refresh</td><td>POST</td><td>/v1/auth/refresh</td><td>*</td></tr>----++++<tr><td>SwitchWorkspace</td><td>POST</td><td>/v1/auth:switchWorkspace</td><td>*</td></tr>----++++<tr><td>RequestPasswordReset</td><td>POST</td><td>/v1/auth:requestPasswordReset</td><td>*</td></tr>----++++<tr><td>ResetPassword</td><td>POST</td><td>/v1/auth:resetPassword</td><td>*</td></tr>----++++<tr><td>SendEmailLoginCode</td><td>POST</td><td>/v1/auth:sendEmailLoginCode</td><td>*</td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/cel_service.proto">v1/cel_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.BatchDeparseRequest">BatchDeparseRequest</h3><p>Request message for batch deparsing CEL expressions.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>expressions</td><td><a href="#google.api.expr.v1alpha1.Expr">google.api.expr.v1alpha1.Expr</a></td><td>repeated</td><td><p>The CEL expression ASTs to deparse. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BatchDeparseResponse">BatchDeparseResponse</h3><p>Response message for batch deparsing CEL expressions.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>expressions</td><td><a href="#string">string</a></td><td>repeated</td><td><p>The deparsed CEL expressions as strings. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BatchParseRequest">BatchParseRequest</h3><p>Request message for batch parsing CEL expressions.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>expressions</td><td><a href="#string">string</a></td><td>repeated</td><td><p>The CEL expression strings to parse. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BatchParseResponse">BatchParseResponse</h3><p>Response message for batch parsing CEL expressions.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>expressions</td><td><a href="#google.api.expr.v1alpha1.Expr">google.api.expr.v1alpha1.Expr</a></td><td>repeated</td><td><p>The parsed CEL expressions as AST. </p></td></tr>-+</tbody></table>------++++++<h3 id="bytebase.v1.CelService">CelService</h3><p>CelService manages CEL (Common Expression Language) parsing and formatting operations.</p><table class="enum-table">@@ -11226,7 +11226,7 @@ Permissions required: None</p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>BatchParse</td><td><a href="#bytebase.v1.BatchParseRequest">BatchParseRequest</a></td>@@ -11234,7 +11234,7 @@ 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>@@ -11242,13 +11242,13 @@ Permissions required: None</p></td><td><p>Converts multiple CEL AST representations back into expression strings.Permissions required: None</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -11260,132 +11260,132 @@ Permissions required: None</p></td></tr></thead><tbody>---+++<tr><td>BatchParse</td><td>POST</td><td>/v1/cel/batchParse</td><td>*</td></tr>----++++<tr><td>BatchDeparse</td><td>POST</td><td>/v1/cel/batchDeparse</td><td>*</td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/database_catalog_service.proto">v1/database_catalog_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.ColumnCatalog">ColumnCatalog</h3><p>Column metadata within a table.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The column name. </p></td></tr>-+<tr><td>semantic_type</td><td><a href="#string">string</a></td><td></td><td><p>The semantic type describing the data purpose. </p></td></tr>-+<tr><td>labels</td><td><a href="#bytebase.v1.ColumnCatalog.LabelsEntry">ColumnCatalog.LabelsEntry</a></td><td>repeated</td><td><p>User-defined labels for this column. </p></td></tr>-+<tr><td>classification</td><td><a href="#string">string</a></td><td></td><td><p>The data classification level for this column. </p></td></tr>-+<tr><td>object_schema</td><td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td><td>optional</td><td><p>Object schema for complex column types like JSON. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ColumnCatalog.LabelsEntry">ColumnCatalog.LabelsEntry</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DatabaseCatalog">DatabaseCatalog</h3><p>Catalog metadata for a database including schemas, tables, and columns.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -11393,31 +11393,31 @@ Permissions required: None</p></td><td><p>The name of the database catalog.Format: instances/{instance}/databases/{database}/catalog </p></td></tr>-+<tr><td>schemas</td><td><a href="#bytebase.v1.SchemaCatalog">SchemaCatalog</a></td><td>repeated</td><td><p>The schemas in the database. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetDatabaseCatalogRequest">GetDatabaseCatalogRequest</h3><p>Request message for getting a database catalog.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -11425,248 +11425,248 @@ Format: instances/{instance}/databases/{database}/catalog </p></td><td><p>The name of the database catalog to retrieve.Format: instances/{instance}/databases/{database}/catalog </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ObjectSchema">ObjectSchema</h3><p>Schema definition for object-type columns.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>type</td><td><a href="#bytebase.v1.ObjectSchema.Type">ObjectSchema.Type</a></td><td></td><td><p>The data type of this object. </p></td></tr>-+<tr><td>struct_kind</td><td><a href="#bytebase.v1.ObjectSchema.StructKind">ObjectSchema.StructKind</a></td><td></td><td><p>Struct schema. </p></td></tr>-+<tr><td>array_kind</td><td><a href="#bytebase.v1.ObjectSchema.ArrayKind">ObjectSchema.ArrayKind</a></td><td></td><td><p>Array schema. </p></td></tr>-+<tr><td>semantic_type</td><td><a href="#string">string</a></td><td></td><td><p>The semantic type of this object. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ObjectSchema.ArrayKind">ObjectSchema.ArrayKind</h3><p>Array type with element schema.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>kind</td><td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td><td></td><td><p>The schema of array elements. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ObjectSchema.StructKind">ObjectSchema.StructKind</h3><p>Structure type with named properties.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>properties</td><td><a href="#bytebase.v1.ObjectSchema.StructKind.PropertiesEntry">ObjectSchema.StructKind.PropertiesEntry</a></td><td>repeated</td><td><p>Properties of the struct. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ObjectSchema.StructKind.PropertiesEntry">ObjectSchema.StructKind.PropertiesEntry</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value</td><td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SchemaCatalog">SchemaCatalog</h3><p>Schema metadata within a database.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The schema name. </p></td></tr>-+<tr><td>tables</td><td><a href="#bytebase.v1.TableCatalog">TableCatalog</a></td><td>repeated</td><td><p>The tables in the schema. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TableCatalog">TableCatalog</h3><p>Table metadata within a schema.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></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>Regular table columns. </p></td></tr>-+<tr><td>object_schema</td><td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td><td></td><td><p>Object schema for JSON/XML columns. </p></td></tr>-+<tr><td>classification</td><td><a href="#string">string</a></td><td></td><td><p>The data classification level for this table. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TableCatalog.Columns">TableCatalog.Columns</h3><p>Column list for regular tables.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>columns</td><td><a href="#bytebase.v1.ColumnCatalog">ColumnCatalog</a></td><td>repeated</td><td><p>The columns in the table. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdateDatabaseCatalogRequest">UpdateDatabaseCatalogRequest</h3><p>Request message for updating a database catalog.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>catalog</td><td><a href="#bytebase.v1.DatabaseCatalog">DatabaseCatalog</a></td>@@ -11676,7 +11676,7 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>The catalog's `name` field is used to identify the database catalog to update.Format: instances/{instance}/databases/{database}/catalog </p></td></tr>-+<tr><td>allow_missing</td><td><a href="#bool">bool</a></td>@@ -11684,16 +11684,16 @@ Format: instances/{instance}/databases/{database}/catalog </p></td><td><p>If set to true, and the database catalog is not found, a new database catalog will be created.In this situation, `update_mask` is ignored. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.ObjectSchema.Type">ObjectSchema.Type</h3><p>Object schema data types.</p><table class="enum-table">@@ -11701,50 +11701,50 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p>Unspecified type.</p></td></tr>-+<tr><td>STRING</td><td>1</td><td><p>String type.</p></td></tr>-+<tr><td>NUMBER</td><td>2</td><td><p>Number type.</p></td></tr>-+<tr><td>BOOLEAN</td><td>3</td><td><p>Boolean type.</p></td></tr>-+<tr><td>OBJECT</td><td>4</td><td><p>Object/struct type.</p></td></tr>-+<tr><td>ARRAY</td><td>5</td><td><p>Array type.</p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DatabaseCatalogService">DatabaseCatalogService</h3><p>DatabaseCatalogService manages database schema metadata and classification.</p><table class="enum-table">@@ -11752,7 +11752,7 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>GetDatabaseCatalog</td><td><a href="#bytebase.v1.GetDatabaseCatalogRequest">GetDatabaseCatalogRequest</a></td>@@ -11760,7 +11760,7 @@ In this situation, `update_mask` is ignored. </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>@@ -11768,13 +11768,13 @@ Permissions required: bb.databaseCatalogs.get</p></td><td><p>Updates catalog metadata such as classifications and labels.Permissions required: bb.databaseCatalogs.update</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -11786,49 +11786,49 @@ Permissions required: bb.databaseCatalogs.update</p></td></tr></thead><tbody>---+++<tr><td>GetDatabaseCatalog</td><td>GET</td><td>/v1/{name=instances/*/databases/*/catalog}</td><td></td></tr>----++++<tr><td>UpdateDatabaseCatalog</td><td>PATCH</td><td>/v1/{catalog.name=instances/*/databases/*/catalog}</td><td>catalog</td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/database_group_service.proto">v1/database_group_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.CreateDatabaseGroupRequest">CreateDatabaseGroupRequest</h3><p>Request message for creating a database group.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -11836,14 +11836,14 @@ Permissions required: bb.databaseCatalogs.update</p></td><td><p>The parent resource where this database group will be created.Format: projects/{project} </p></td></tr>-+<tr><td>database_group</td><td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td><td></td><td><p>The database group to create. </p></td></tr>-+<tr><td>database_group_id</td><td><a href="#string">string</a></td>@@ -11854,31 +11854,31 @@ the database group's resource name.This value should be 4-63 characters, and valid charactersare /[a-z][0-9]-/. </p></td></tr>-+<tr><td>validate_only</td><td><a href="#bool">bool</a></td><td></td><td><p>If set, validate the create request and preview the full database group response, but do not actually create it. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DatabaseGroup">DatabaseGroup</h3><p>A group of databases matched by expressions.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -11886,14 +11886,14 @@ are /[a-z][0-9]-/. </p></td><td><p>The name of the database group.Format: projects/{project}/databaseGroups/{databaseGroup} </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>The short name used in actual databases specified by users. </p></td></tr>-+<tr><td>database_expr</td><td><a href="#google.type.Expr">google.type.Expr</a></td>@@ -11912,31 +11912,31 @@ For example:resource.environment_id == "test" && resource.database_name.startsWith("sample_")resource.database_labels["tenant"] == "tenant1" </p></td></tr>-+<tr><td>matched_databases</td><td><a href="#bytebase.v1.DatabaseGroup.Database">DatabaseGroup.Database</a></td><td>repeated</td><td><p>The list of databases that match the database group condition. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DatabaseGroup.Database">DatabaseGroup.Database</h3><p>A database within a database group.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -11944,24 +11944,24 @@ resource.database_labels["tenant"] == "tenant1" </p></td><td><p>The resource name of the database.Format: instances/{instance}/databases/{database} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DeleteDatabaseGroupRequest">DeleteDatabaseGroupRequest</h3><p>Request message for deleting a database group.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -11969,24 +11969,24 @@ Format: instances/{instance}/databases/{database} </p></td><td><p>The name of the database group to delete.Format: projects/{project}/databaseGroups/{databaseGroup} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetDatabaseGroupRequest">GetDatabaseGroupRequest</h3><p>Request message for getting a database group.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -11994,31 +11994,31 @@ Format: projects/{project}/databaseGroups/{databaseGroup} </p></td><td><p>The name of the database group to retrieve.Format: projects/{project}/databaseGroups/{databaseGroup} </p></td></tr>-+<tr><td>view</td><td><a href="#bytebase.v1.DatabaseGroupView">DatabaseGroupView</a></td><td></td><td><p>The view to return. Defaults to DATABASE_GROUP_VIEW_BASIC. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListDatabaseGroupsRequest">ListDatabaseGroupsRequest</h3><p>Request message for listing database groups.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -12026,55 +12026,55 @@ Format: projects/{project}/databaseGroups/{databaseGroup} </p></td><td><p>The parent resource whose database groups are to be listed.Format: projects/{project} </p></td></tr>-+<tr><td>view</td><td><a href="#bytebase.v1.DatabaseGroupView">DatabaseGroupView</a></td><td></td><td><p>The view to return. Defaults to DATABASE_GROUP_VIEW_BASIC. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListDatabaseGroupsResponse">ListDatabaseGroupsResponse</h3><p>Response message for listing database groups.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>database_groups</td><td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td><td>repeated</td><td><p>The database groups from the specified request. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdateDatabaseGroupRequest">UpdateDatabaseGroupRequest</h3><p>Request message for updating a database group.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>database_group</td><td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>@@ -12084,14 +12084,14 @@ Format: projects/{project} </p></td>The database group's `name` field is used to identify the database group to update.Format: projects/{project}/databaseGroups/{databaseGroup} </p></td></tr>-+<tr><td>update_mask</td><td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td><td></td><td><p>The list of fields to update. </p></td></tr>-+<tr><td>allow_missing</td><td><a href="#bool">bool</a></td>@@ -12099,16 +12099,16 @@ Format: projects/{project}/databaseGroups/{databaseGroup} </p></td><td><p>If set to true, and the database group is not found, a new database group will be created.In this situation, `update_mask` is ignored. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.DatabaseGroupView">DatabaseGroupView</h3><p>View options for database group responses.</p><table class="enum-table">@@ -12116,33 +12116,33 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>DATABASE_GROUP_VIEW_UNSPECIFIED</td><td>0</td><td><p>The default / unset value.The API will default to the BASIC view.</p></td></tr>-+<tr><td>DATABASE_GROUP_VIEW_BASIC</td><td>1</td><td><p>Include basic information about the database group, but exclude the list of matched databases and unmatched databases.</p></td></tr>-+<tr><td>DATABASE_GROUP_VIEW_FULL</td><td>2</td><td><p>Include everything.</p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DatabaseGroupService">DatabaseGroupService</h3><p>DatabaseGroupService manages database groups for organizing databases by criteria.</p><table class="enum-table">@@ -12150,7 +12150,7 @@ The API will default to the BASIC view.</p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>ListDatabaseGroups</td><td><a href="#bytebase.v1.ListDatabaseGroupsRequest">ListDatabaseGroupsRequest</a></td>@@ -12158,7 +12158,7 @@ The API will default to the BASIC view.</p></td><td><p>Lists database groups in a project.Permissions required: bb.databaseGroups.list</p></td></tr>-+<tr><td>GetDatabaseGroup</td><td><a href="#bytebase.v1.GetDatabaseGroupRequest">GetDatabaseGroupRequest</a></td>@@ -12166,7 +12166,7 @@ Permissions required: bb.databaseGroups.list</p></td><td><p>Gets a database group by name.Permissions required: bb.databaseGroups.get</p></td></tr>-+<tr><td>CreateDatabaseGroup</td><td><a href="#bytebase.v1.CreateDatabaseGroupRequest">CreateDatabaseGroupRequest</a></td>@@ -12174,7 +12174,7 @@ Permissions required: bb.databaseGroups.get</p></td><td><p>Creates a new database group.Permissions required: bb.databaseGroups.create</p></td></tr>-+<tr><td>UpdateDatabaseGroup</td><td><a href="#bytebase.v1.UpdateDatabaseGroupRequest">UpdateDatabaseGroupRequest</a></td>@@ -12183,7 +12183,7 @@ Permissions required: bb.databaseGroups.create</p></td>Permissions required: bb.databaseGroups.updateWhen allow_missing=true, also requires: bb.databaseGroups.create</p></td></tr>-+<tr><td>DeleteDatabaseGroup</td><td><a href="#bytebase.v1.DeleteDatabaseGroupRequest">DeleteDatabaseGroupRequest</a></td>@@ -12191,13 +12191,13 @@ When allow_missing=true, also requires: bb.databaseGroups.create</p></td><td><p>Deletes a database group.Permissions required: bb.databaseGroups.delete</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -12209,79 +12209,79 @@ Permissions required: bb.databaseGroups.delete</p></td></tr></thead><tbody>---+++<tr><td>ListDatabaseGroups</td><td>GET</td><td>/v1/{parent=projects/*}/databaseGroups</td><td></td></tr>----++++<tr><td>GetDatabaseGroup</td><td>GET</td><td>/v1/{name=projects/*/databaseGroups/*}</td><td></td></tr>----++++<tr><td>CreateDatabaseGroup</td><td>POST</td><td>/v1/{parent=projects/*}/databaseGroups</td><td>database_group</td></tr>----++++<tr><td>UpdateDatabaseGroup</td><td>PATCH</td><td>/v1/{database_group.name=projects/*/databaseGroups/*}</td><td>database_group</td></tr>----++++<tr><td>DeleteDatabaseGroup</td><td>DELETE</td><td>/v1/{name=projects/*/databaseGroups/*}</td><td></td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/instance_role_service.proto">v1/instance_role_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.InstanceRole">InstanceRole</h3><p>InstanceRole is the API message for instance role.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -12290,35 +12290,35 @@ Permissions required: bb.databaseGroups.delete</p></td>Format: instances/{instance}/roles/{role}The role name is the unique name for the role. </p></td></tr>-+<tr><td>role_name</td><td><a href="#string">string</a></td><td></td><td><p>The role name. It's unique within the instance. </p></td></tr>-+<tr><td>password</td><td><a href="#string">string</a></td><td>optional</td><td><p>The role password. </p></td></tr>-+<tr><td>connection_limit</td><td><a href="#int32">int32</a></td><td>optional</td><td><p>The connection count limit for this role. </p></td></tr>-+<tr><td>valid_until</td><td><a href="#string">string</a></td><td>optional</td><td><p>The expiration for the role's password. </p></td></tr>-+<tr><td>attribute</td><td><a href="#string">string</a></td>@@ -12327,24 +12327,24 @@ The role name is the unique name for the role. </p></td>For PostgreSQL, it contains super_user, no_inherit, create_role, create_db, can_login, replication, and bypass_rls. Docs: https://www.postgresql.org/docs/current/role-attributes.htmlFor MySQL, it's the global privileges as GRANT statements, which means it only contains "GRANT ... ON *.* TO ...". Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListInstanceRolesRequest">ListInstanceRolesRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -12352,7 +12352,7 @@ For MySQL, it's the global privileges as GRANT statements, which means it on<td><p>The parent, which owns this collection of roles.Format: instances/{instance} </p></td></tr>-+<tr><td>page_size</td><td><a href="#int32">int32</a></td>@@ -12363,7 +12363,7 @@ this value.If unspecified, at most 10 roles will be returned.The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td></tr>-+<tr><td>page_token</td><td><a href="#string">string</a></td>@@ -12375,38 +12375,38 @@ Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `ListInstanceRoles` must matchthe call that provided the page token. </p></td></tr>-+<tr><td>refresh</td><td><a href="#bool">bool</a></td><td></td><td><p>Refresh will refresh and return the latest data. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListInstanceRolesResponse">ListInstanceRolesResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>roles</td><td><a href="#bytebase.v1.InstanceRole">InstanceRole</a></td><td>repeated</td><td><p>The roles from the specified request. </p></td></tr>-+<tr><td>next_page_token</td><td><a href="#string">string</a></td>@@ -12414,20 +12414,20 @@ the call that provided the page token. </p></td><td><p>A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages. </p></td></tr>-+</tbody></table>------++++++<h3 id="bytebase.v1.InstanceRoleService">InstanceRoleService</h3><p>InstanceRoleService manages database roles within instances.</p><table class="enum-table">@@ -12435,7 +12435,7 @@ If this field is omitted, there are no subsequent pages. </p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>ListInstanceRoles</td><td><a href="#bytebase.v1.ListInstanceRolesRequest">ListInstanceRolesRequest</a></td>@@ -12443,13 +12443,13 @@ If this field is omitted, there are no subsequent pages. </p></td><td><p>Lists all database roles in an instance.Permissions required: bb.instanceRoles.list</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -12461,39 +12461,39 @@ Permissions required: bb.instanceRoles.list</p></td></tr></thead><tbody>---+++<tr><td>ListInstanceRoles</td><td>GET</td><td>/v1/{parent=instances/*}/roles</td><td></td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/instance_service.proto">v1/instance_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.AddDataSourceRequest">AddDataSourceRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -12501,7 +12501,7 @@ Permissions required: bb.instanceRoles.list</p></td><td><p>The name of the instance to add a data source to.Format: instances/{instance} </p></td></tr>-+<tr><td>data_source</td><td><a href="#bytebase.v1.DataSource">DataSource</a></td>@@ -12509,31 +12509,31 @@ Format: instances/{instance} </p></td><td><p>Identified by data source ID.Only READ_ONLY data source can be added. </p></td></tr>-+<tr><td>validate_only</td><td><a href="#bool">bool</a></td><td></td><td><p>Validate only also tests the data source connection. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BatchSyncInstancesRequest">BatchSyncInstancesRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>requests</td><td><a href="#bytebase.v1.SyncInstanceRequest">SyncInstanceRequest</a></td>@@ -12541,86 +12541,86 @@ Only READ_ONLY data source can be added. </p></td><td><p>The request message specifying the instances to sync.A maximum of 1000 instances can be synced in a batch. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BatchSyncInstancesResponse">BatchSyncInstancesResponse</h3><p></p>---+++<h3 id="bytebase.v1.BatchUpdateInstancesRequest">BatchUpdateInstancesRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>requests</td><td><a href="#bytebase.v1.UpdateInstanceRequest">UpdateInstanceRequest</a></td><td>repeated</td><td><p>The request message specifying the resources to update. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BatchUpdateInstancesResponse">BatchUpdateInstancesResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>instances</td><td><a href="#bytebase.v1.Instance">Instance</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.CreateInstanceRequest">CreateInstanceRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>instance</td><td><a href="#bytebase.v1.Instance">Instance</a></td><td></td><td><p>The instance to create. </p></td></tr>-+<tr><td>instance_id</td><td><a href="#string">string</a></td>@@ -12631,87 +12631,150 @@ the instance's resource name.This value should be 4-63 characters, and valid charactersare /[a-z][0-9]-/. </p></td></tr>-+<tr><td>validate_only</td><td><a href="#bool">bool</a></td><td></td><td><p>Validate only also tests the data source connection. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DataSource">DataSource</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>id</td><td><a href="#string">string</a></td><td></td><td><p>The unique identifier for this data source. </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.v1.DataSourceType">DataSourceType</a></td><td></td><td><p>The type of data source (ADMIN or READ_ONLY). </p></td></tr>-+<tr><td>username</td><td><a href="#string">string</a></td><td></td><td><p>The username for database authentication. </p></td></tr>-+<tr><td>password</td><td><a href="#string">string</a></td><td></td><td><p>The password for database authentication. </p></td></tr>-+<tr><td>use_ssl</td><td><a href="#bool">bool</a></td><td></td><td><p>Use SSL to connect to the data source. By default, we use system default SSL configuration. </p></td></tr>-+<tr><td>ssl_ca</td><td><a href="#string">string</a></td><td></td><td><p>The SSL certificate authority certificate. </p></td></tr>-+<tr><td>ssl_cert</td><td><a href="#string">string</a></td><td></td><td><p>The SSL client certificate. </p></td></tr>-+<tr><td>ssl_key</td><td><a href="#string">string</a></td><td></td>- <td><p>The SSL client private key. </p></td>+ <td><p>The SSL client private key. </p></td>+ </tr>++ <tr>+ <td>ssl_ca_path</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p>The local filesystem path to the SSL certificate authority certificate. </p></td>+ </tr>++ <tr>+ <td>ssl_cert_path</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p>The local filesystem path to the SSL client certificate. </p></td>+ </tr>++ <tr>+ <td>ssl_key_path</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p>The local filesystem path to the SSL client private key. </p></td>+ </tr>++ <tr>+ <td>ssl_ca_set</td>+ <td><a href="#bool">bool</a></td>+ <td></td>+ <td><p>Whether an SSL certificate authority certificate has been configured. </p></td>+ </tr>++ <tr>+ <td>ssl_cert_set</td>+ <td><a href="#bool">bool</a></td>+ <td></td>+ <td><p>Whether an SSL client certificate has been configured. </p></td>+ </tr>++ <tr>+ <td>ssl_key_set</td>+ <td><a href="#bool">bool</a></td>+ <td></td>+ <td><p>Whether an SSL client private key has been configured. </p></td>+ </tr>++ <tr>+ <td>ssl_ca_path_set</td>+ <td><a href="#bool">bool</a></td>+ <td></td>+ <td><p>Whether an SSL certificate authority path has been configured. </p></td>+ </tr>++ <tr>+ <td>ssl_cert_path_set</td>+ <td><a href="#bool">bool</a></td>+ <td></td>+ <td><p>Whether an SSL client certificate path has been configured. </p></td>+ </tr>++ <tr>+ <td>ssl_key_path_set</td>+ <td><a href="#bool">bool</a></td>+ <td></td>+ <td><p>Whether an SSL client private key path has been configured. </p></td></tr>-+<tr><td>verify_tls_certificate</td><td><a href="#bool">bool</a></td>@@ -12722,28 +12785,28 @@ Set to true for secure connections (recommended for production).Only set to false for development or when certificates cannot be properlyvalidated (e.g., self-signed certs, VPN environments). </p></td></tr>-+<tr><td>host</td><td><a href="#string">string</a></td><td></td><td><p>The hostname or IP address of the database server. </p></td></tr>-+<tr><td>port</td><td><a href="#string">string</a></td><td></td><td><p>The port number of the database server. </p></td></tr>-+<tr><td>database</td><td><a href="#string">string</a></td><td></td><td><p>The name of the database to connect to. </p></td></tr>-+<tr><td>srv</td><td><a href="#bool">bool</a></td>@@ -12751,35 +12814,35 @@ validated (e.g., self-signed certs, VPN environments). </p></td><td><p>srv, authentication_database and replica_set are used for MongoDB.srv is a boolean flag that indicates whether the host is a DNS SRV record. </p></td></tr>-+<tr><td>authentication_database</td><td><a href="#string">string</a></td><td></td><td><p>authentication_database is the database name to authenticate against, which stores the user credentials. </p></td></tr>-+<tr><td>replica_set</td><td><a href="#string">string</a></td><td></td><td><p>replica_set is used for MongoDB replica set. </p></td></tr>-+<tr><td>sid</td><td><a href="#string">string</a></td><td></td><td><p>sid and service_name are used for Oracle. </p></td></tr>-+<tr><td>service_name</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>ssh_host</td><td><a href="#string">string</a></td>@@ -12788,7 +12851,7 @@ srv is a boolean flag that indicates whether the host is a DNS SRV record. </p><The hostname of the SSH server agent.Required. </p></td></tr>-+<tr><td>ssh_port</td><td><a href="#string">string</a></td>@@ -12796,7 +12859,7 @@ Required. </p></td><td><p>The port of the SSH server agent. It's 22 typically.Required. </p></td></tr>-+<tr><td>ssh_user</td><td><a href="#string">string</a></td>@@ -12804,21 +12867,21 @@ Required. </p></td><td><p>The user to login the server.Required. </p></td></tr>-+<tr><td>ssh_password</td><td><a href="#string">string</a></td><td></td><td><p>The password to login the server. If it's empty string, no password is required. </p></td></tr>-+<tr><td>ssh_private_key</td><td><a href="#string">string</a></td><td></td><td><p>The private key to login the server. If it's empty string, we will use the system default private key from os.Getenv("SSH_AUTH_SOCK"). </p></td></tr>-+<tr><td>authentication_private_key</td><td><a href="#string">string</a></td>@@ -12826,119 +12889,119 @@ Required. </p></td><td><p>PKCS#8 private key in PEM format. If it's empty string, no private key is required.Used for authentication when connecting to the data source. </p></td></tr>-+<tr><td>authentication_private_key_passphrase</td><td><a href="#string">string</a></td><td></td><td><p>Passphrase for the encrypted PKCS#8 private key. Only used when the private key is encrypted. </p></td></tr>-+<tr><td>external_secret</td><td><a href="#bytebase.v1.DataSourceExternalSecret">DataSourceExternalSecret</a></td><td></td><td><p> </p></td></tr>-+<tr><td>authentication_type</td><td><a href="#bytebase.v1.DataSource.AuthenticationType">DataSource.AuthenticationType</a></td><td></td><td><p> </p></td></tr>-+<tr><td>azure_credential</td><td><a href="#bytebase.v1.DataSource.AzureCredential">DataSource.AzureCredential</a></td><td></td><td><p> </p></td></tr>-+<tr><td>aws_credential</td><td><a href="#bytebase.v1.DataSource.AWSCredential">DataSource.AWSCredential</a></td><td></td><td><p> </p></td></tr>-+<tr><td>gcp_credential</td><td><a href="#bytebase.v1.DataSource.GCPCredential">DataSource.GCPCredential</a></td><td></td><td><p> </p></td></tr>-+<tr><td>sasl_config</td><td><a href="#bytebase.v1.SASLConfig">SASLConfig</a></td><td></td><td><p> </p></td></tr>-+<tr><td>additional_addresses</td><td><a href="#bytebase.v1.DataSource.Address">DataSource.Address</a></td><td>repeated</td><td><p>additional_addresses is used for MongoDB replica set. </p></td></tr>-+<tr><td>direct_connection</td><td><a href="#bool">bool</a></td><td></td><td><p>direct_connection is used for MongoDB to dispatch all the operations to the node specified in the connection string. </p></td></tr>-+<tr><td>region</td><td><a href="#string">string</a></td><td></td><td><p>region is the location of where the DB is, works for AWS RDS. For example, us-east-1. </p></td></tr>-+<tr><td>warehouse_id</td><td><a href="#string">string</a></td><td></td><td><p>warehouse_id is used by Databricks. </p></td></tr>-+<tr><td>master_name</td><td><a href="#string">string</a></td><td></td><td><p>master_name is the master name used by connecting redis-master via redis sentinel. </p></td></tr>-+<tr><td>master_username</td><td><a href="#string">string</a></td><td></td><td><p>master_username and master_password are master credentials used by redis sentinel mode. </p></td></tr>-+<tr><td>master_password</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>redis_type</td><td><a href="#bytebase.v1.DataSource.RedisType">DataSource.RedisType</a></td><td></td><td><p> </p></td></tr>-+<tr><td>cluster</td><td><a href="#string">string</a></td><td></td><td><p>Cluster is the cluster name for the data source. Used by CockroachDB. </p></td></tr>-+<tr><td>extra_connection_parameters</td><td><a href="#bytebase.v1.DataSource.ExtraConnectionParametersEntry">DataSource.ExtraConnectionParametersEntry</a></td>@@ -12946,45 +13009,45 @@ Used for authentication when connecting to the data source. </p></td><td><p>Extra connection parameters for the database connection.For PostgreSQL HA, this can be used to set target_session_attrs=read-write </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DataSource.AWSCredential">DataSource.AWSCredential</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>access_key_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>secret_access_key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>session_token</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>role_arn</td><td><a href="#string">string</a></td>@@ -12992,7 +13055,7 @@ For PostgreSQL HA, this can be used to set target_session_attrs=read-write </p><<td><p>ARN of IAM role to assume for cross-account access.See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html </p></td></tr>-+<tr><td>external_id</td><td><a href="#string">string</a></td>@@ -13000,204 +13063,204 @@ See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html </p></td<td><p>Optional external ID for additional security when assuming role.See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DataSource.Address">DataSource.Address</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>host</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>port</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DataSource.AzureCredential">DataSource.AzureCredential</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>tenant_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>client_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>client_secret</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DataSource.ExtraConnectionParametersEntry">DataSource.ExtraConnectionParametersEntry</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DataSource.GCPCredential">DataSource.GCPCredential</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>content</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DataSourceExternalSecret">DataSourceExternalSecret</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>secret_type</td><td><a href="#bytebase.v1.DataSourceExternalSecret.SecretType">DataSourceExternalSecret.SecretType</a></td><td></td><td><p>The type of external secret store. </p></td></tr>-+<tr><td>url</td><td><a href="#string">string</a></td><td></td><td><p>The URL of the external secret store. </p></td></tr>-+<tr><td>auth_type</td><td><a href="#bytebase.v1.DataSourceExternalSecret.AuthType">DataSourceExternalSecret.AuthType</a></td><td></td><td><p>The authentication method for accessing the secret store. </p></td></tr>-+<tr><td>app_role</td><td><a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption">DataSourceExternalSecret.AppRoleAuthOption</a></td><td></td><td><p>AppRole authentication configuration. </p></td></tr>-+<tr><td>token</td><td><a href="#string">string</a></td><td></td><td><p>Token for direct authentication. </p></td></tr>-+<tr><td>engine_name</td><td><a href="#string">string</a></td><td></td><td><p>engine name is the name for secret engine. </p></td></tr>-+<tr><td>secret_name</td><td><a href="#string">string</a></td><td></td><td><p>the secret name in the engine to store the password. </p></td></tr>-+<tr><td>password_key_name</td><td><a href="#string">string</a></td><td></td><td><p>the key name for the password. </p></td></tr>-+<tr><td>skip_vault_tls_verification</td><td><a href="#bool">bool</a></td>@@ -13208,90 +13271,90 @@ skip_vault_tls_verification disables TLS certificate verification for Vault connDefault is false (verification enabled) for security.Only set to true for development or when certificates cannot be properly validated. </p></td></tr>-+<tr><td>vault_ssl_ca</td><td><a href="#string">string</a></td><td></td><td><p>CA certificate for Vault server verification. </p></td></tr>-+<tr><td>vault_ssl_cert</td><td><a href="#string">string</a></td><td></td><td><p>Client certificate for mutual TLS authentication with Vault. </p></td></tr>-+<tr><td>vault_ssl_key</td><td><a href="#string">string</a></td><td></td><td><p>Client private key for mutual TLS authentication with Vault. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption">DataSourceExternalSecret.AppRoleAuthOption</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>role_id</td><td><a href="#string">string</a></td><td></td><td><p>The role ID for Vault AppRole authentication. </p></td></tr>-+<tr><td>secret_id</td><td><a href="#string">string</a></td><td></td><td><p>the secret id for the role without ttl. </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption.SecretType">DataSourceExternalSecret.AppRoleAuthOption.SecretType</a></td><td></td><td><p>The type of secret for AppRole authentication. </p></td></tr>-+<tr><td>mount_path</td><td><a href="#string">string</a></td><td></td><td><p>The path where the approle auth method is mounted. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DeleteInstanceRequest">DeleteInstanceRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -13299,14 +13362,14 @@ Only set to true for development or when certificates cannot be properly validat<td><p>The name of the instance to delete.Format: instances/{instance} </p></td></tr>-+<tr><td>force</td><td><a href="#bool">bool</a></td><td></td><td><p>If set to true, any databases and sheets from this project will also be moved to default project, and all open issues will be closed. </p></td></tr>-+<tr><td>purge</td><td><a href="#bool">bool</a></td>@@ -13316,24 +13379,24 @@ This operation is irreversible. Following AIP-165, this should only be used foradministrative cleanup of old soft-deleted instances.The instance must already be soft-deleted for this to work. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetInstanceRequest">GetInstanceRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -13341,24 +13404,24 @@ The instance must already be soft-deleted for this to work. </p></td><td><p>The name of the instance to retrieve.Format: instances/{instance} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Instance">Instance</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -13366,49 +13429,49 @@ Format: instances/{instance} </p></td><td><p>The name of the instance.Format: instances/{instance} </p></td></tr>-+<tr><td>state</td><td><a href="#bytebase.v1.State">State</a></td><td></td><td><p>The lifecycle state of the instance. </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>The display title of the instance. </p></td></tr>-+<tr><td>engine</td><td><a href="#bytebase.v1.Engine">Engine</a></td><td></td><td><p>The database engine type. </p></td></tr>-+<tr><td>engine_version</td><td><a href="#string">string</a></td><td></td><td><p>The version of the database engine. </p></td></tr>-+<tr><td>external_link</td><td><a href="#string">string</a></td><td></td><td><p>External URL to the database instance console. </p></td></tr>-+<tr><td>data_sources</td><td><a href="#bytebase.v1.DataSource">DataSource</a></td><td>repeated</td><td><p>Data source configurations for connecting to the instance. </p></td></tr>-+<tr><td>environment</td><td><a href="#string">string</a></td>@@ -13416,28 +13479,28 @@ Format: instances/{instance} </p></td><td><p>The environment resource.Format: environments/prod where prod is the environment resource ID. </p></td></tr>-+<tr><td>activation</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether the instance is activated for use. </p></td></tr>-+<tr><td>roles</td><td><a href="#bytebase.v1.InstanceRole">InstanceRole</a></td><td>repeated</td><td><p>Database roles available in this instance. </p></td></tr>-+<tr><td>sync_interval</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td><td><p>How often the instance is synced. </p></td></tr>-+<tr><td>sync_databases</td><td><a href="#string">string</a></td>@@ -13445,14 +13508,14 @@ Format: environments/prod where prod is the environment resource ID. </p></td><td><p>Enable sync for following databases.Default empty, means sync all schemas & databases. </p></td></tr>-+<tr><td>last_sync_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p>The last time the instance was synced. </p></td></tr>-+<tr><td>labels</td><td><a href="#bytebase.v1.Instance.LabelsEntry">Instance.LabelsEntry</a></td>@@ -13460,90 +13523,90 @@ Default empty, means sync all schemas & databases. </p></td><td><p>Labels are key-value pairs that can be attached to the instance.For example, { "org_group": "infrastructure", "environment": "production" } </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Instance.LabelsEntry">Instance.LabelsEntry</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.InstanceResource">InstanceResource</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>The display title of the instance. </p></td></tr>-+<tr><td>engine</td><td><a href="#bytebase.v1.Engine">Engine</a></td><td></td><td><p>The database engine type. </p></td></tr>-+<tr><td>engine_version</td><td><a href="#string">string</a></td><td></td><td><p>The version of the database engine. </p></td></tr>-+<tr><td>data_sources</td><td><a href="#bytebase.v1.DataSource">DataSource</a></td><td>repeated</td><td><p>Data source configurations for the instance. </p></td></tr>-+<tr><td>activation</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether the instance is activated. </p></td></tr>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -13551,7 +13614,7 @@ For example, { "org_group": "infrastructure", "environment&#<td><p>The name of the instance.Format: instances/{instance} </p></td></tr>-+<tr><td>environment</td><td><a href="#string">string</a></td>@@ -13559,90 +13622,90 @@ Format: instances/{instance} </p></td><td><p>The environment resource.Format: environments/prod where prod is the environment resource ID. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.KerberosConfig">KerberosConfig</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>primary</td><td><a href="#string">string</a></td><td></td><td><p>The primary component of the Kerberos principal. </p></td></tr>-+<tr><td>instance</td><td><a href="#string">string</a></td><td></td><td><p>The instance component of the Kerberos principal. </p></td></tr>-+<tr><td>realm</td><td><a href="#string">string</a></td><td></td><td><p>The Kerberos realm. </p></td></tr>-+<tr><td>keytab</td><td><a href="#bytes">bytes</a></td><td></td><td><p>The keytab file contents for authentication. </p></td></tr>-+<tr><td>kdc_host</td><td><a href="#string">string</a></td><td></td><td><p>The hostname of the Key Distribution Center (KDC). </p></td></tr>-+<tr><td>kdc_port</td><td><a href="#string">string</a></td><td></td><td><p>The port of the Key Distribution Center (KDC). </p></td></tr>-+<tr><td>kdc_transport_protocol</td><td><a href="#string">string</a></td><td></td><td><p>The transport protocol for KDC communication (tcp or udp). </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListInstanceDatabaseRequest">ListInstanceDatabaseRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -13650,55 +13713,55 @@ Format: environments/prod where prod is the environment resource ID. </p></td><td><p>The name of the instance.Format: instances/{instance} </p></td></tr>-+<tr><td>instance</td><td><a href="#bytebase.v1.Instance">Instance</a></td><td>optional</td><td><p>The target instance. We need to set this field if the target instance is not created yet. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListInstanceDatabaseResponse">ListInstanceDatabaseResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>databases</td><td><a href="#string">string</a></td><td>repeated</td><td><p>All database name list in the instance. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListInstancesRequest">ListInstancesRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>page_size</td><td><a href="#int32">int32</a></td>@@ -13708,7 +13771,7 @@ this value.If unspecified, at most 10 instances will be returned.The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td></tr>-+<tr><td>page_token</td><td><a href="#string">string</a></td>@@ -13719,14 +13782,14 @@ Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `ListInstances` must matchthe call that provided the page token. </p></td></tr>-+<tr><td>show_deleted</td><td><a href="#bool">bool</a></td><td></td><td><p>Show deleted instances if specified. </p></td></tr>-+<tr><td>filter</td><td><a href="#string">string</a></td>@@ -13767,7 +13830,7 @@ You can combine filter conditions like:name.contains("sample") && environment == "environments/test"host == "127.0.0.1" && port == "54321" </p></td></tr>-+<tr><td>order_by</td><td><a href="#string">string</a></td>@@ -13779,31 +13842,31 @@ For example:- order_by = "title desc"- order_by = "title desc, environment asc" </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListInstancesResponse">ListInstancesResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>instances</td><td><a href="#bytebase.v1.Instance">Instance</a></td><td>repeated</td><td><p>The instances from the specified request. </p></td></tr>-+<tr><td>next_page_token</td><td><a href="#string">string</a></td>@@ -13811,24 +13874,24 @@ For example:<td><p>A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.RemoveDataSourceRequest">RemoveDataSourceRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -13836,7 +13899,7 @@ If this field is omitted, there are no subsequent pages. </p></td><td><p>The name of the instance to remove a data source from.Format: instances/{instance} </p></td></tr>-+<tr><td>data_source</td><td><a href="#bytebase.v1.DataSource">DataSource</a></td>@@ -13844,48 +13907,48 @@ Format: instances/{instance} </p></td><td><p>Identified by data source ID.Only READ_ONLY data source can be removed. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SASLConfig">SASLConfig</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>krb_config</td><td><a href="#bytebase.v1.KerberosConfig">KerberosConfig</a></td><td></td><td><p>Kerberos authentication configuration. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SyncInstanceRequest">SyncInstanceRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -13893,7 +13956,7 @@ Only READ_ONLY data source can be removed. </p></td><td><p>The name of instance.Format: instances/{instance} </p></td></tr>-+<tr><td>enable_full_sync</td><td><a href="#bool">bool</a></td>@@ -13901,48 +13964,48 @@ Format: instances/{instance} </p></td><td><p>When full sync is enabled, all databases in the instance will be synchronized. Otherwise, onlythe instance metadata (such as the database list) and any newly discovered databases will be synced. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SyncInstanceResponse">SyncInstanceResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>databases</td><td><a href="#string">string</a></td><td>repeated</td><td><p>All database name list in the instance. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UndeleteInstanceRequest">UndeleteInstanceRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -13950,24 +14013,24 @@ the instance metadata (such as the database list) and any newly discovered datab<td><p>The name of the deleted instance.Format: instances/{instance} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdateDataSourceRequest">UpdateDataSourceRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -13975,28 +14038,28 @@ Format: instances/{instance} </p></td><td><p>The name of the instance to update a data source.Format: instances/{instance} </p></td></tr>-+<tr><td>data_source</td><td><a href="#bytebase.v1.DataSource">DataSource</a></td><td></td><td><p>Identified by data source ID. </p></td></tr>-+<tr><td>update_mask</td><td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td><td></td><td><p>The list of fields to update. </p></td></tr>-+<tr><td>validate_only</td><td><a href="#bool">bool</a></td><td></td><td><p>Validate only also tests the data source connection. </p></td></tr>-+<tr><td>allow_missing</td><td><a href="#bool">bool</a></td>@@ -14004,24 +14067,24 @@ Format: instances/{instance} </p></td><td><p>If set to true, and the data source is not found, a new data source will be created.In this situation, `update_mask` is ignored. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdateInstanceRequest">UpdateInstanceRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>instance</td><td><a href="#bytebase.v1.Instance">Instance</a></td>@@ -14031,14 +14094,14 @@ In this situation, `update_mask` is ignored. </p></td>The instance's `name` field is used to identify the instance to update.Format: instances/{instance} </p></td></tr>-+<tr><td>update_mask</td><td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td><td></td><td><p>The list of fields to update. </p></td></tr>-+<tr><td>allow_missing</td><td><a href="#bool">bool</a></td>@@ -14046,16 +14109,16 @@ Format: instances/{instance} </p></td><td><p>If set to true, and the instance is not found, a new instance will be created.In this situation, `update_mask` is ignored. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.DataSource.AuthenticationType">DataSource.AuthenticationType</h3><p></p><table class="enum-table">@@ -14063,40 +14126,40 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>AUTHENTICATION_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>PASSWORD</td><td>1</td><td><p></p></td></tr>-+<tr><td>GOOGLE_CLOUD_SQL_IAM</td><td>2</td><td><p></p></td></tr>-+<tr><td>AWS_RDS_IAM</td><td>3</td><td><p></p></td></tr>-+<tr><td>AZURE_IAM</td><td>4</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.DataSource.RedisType">DataSource.RedisType</h3><p></p><table class="enum-table">@@ -14104,34 +14167,34 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>REDIS_TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>STANDALONE</td><td>1</td><td><p></p></td></tr>-+<tr><td>SENTINEL</td><td>2</td><td><p></p></td></tr>-+<tr><td>CLUSTER</td><td>3</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption.SecretType">DataSourceExternalSecret.AppRoleAuthOption.SecretType</h3><p></p><table class="enum-table">@@ -14139,28 +14202,28 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>SECRET_TYPE_UNSPECIFIED</td><td>0</td><td><p>Unspecified secret type.</p></td></tr>-+<tr><td>PLAIN</td><td>1</td><td><p>Plain text secret.</p></td></tr>-+<tr><td>ENVIRONMENT</td><td>2</td><td><p>Secret from environment variable.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.DataSourceExternalSecret.AuthType">DataSourceExternalSecret.AuthType</h3><p></p><table class="enum-table">@@ -14168,28 +14231,28 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>AUTH_TYPE_UNSPECIFIED</td><td>0</td><td><p>Unspecified authentication type.</p></td></tr>-+<tr><td>TOKEN</td><td>1</td><td><p>ref: https://developer.hashicorp.com/vault/docs/auth/token</p></td></tr>-+<tr><td>VAULT_APP_ROLE</td><td>2</td><td><p>ref: https://developer.hashicorp.com/vault/docs/auth/approle</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.DataSourceExternalSecret.SecretType">DataSourceExternalSecret.SecretType</h3><p></p><table class="enum-table">@@ -14197,40 +14260,40 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>SECRET_TYPE_UNSPECIFIED</td><td>0</td><td><p>Unspecified secret type.</p></td></tr>-+<tr><td>VAULT_KV_V2</td><td>1</td><td><p>ref: https://developer.hashicorp.com/vault/api-docs/secret/kv/kv-v2</p></td></tr>-+<tr><td>AWS_SECRETS_MANAGER</td><td>2</td><td><p>ref: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html</p></td></tr>-+<tr><td>GCP_SECRET_MANAGER</td><td>3</td><td><p>ref: https://cloud.google.com/secret-manager/docs</p></td></tr>-+<tr><td>AZURE_KEY_VAULT</td><td>4</td><td><p>ref: https://learn.microsoft.com/en-us/azure/key-vault/secrets/about-secrets</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.DataSourceType">DataSourceType</h3><p></p><table class="enum-table">@@ -14238,32 +14301,32 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>DATA_SOURCE_UNSPECIFIED</td><td>0</td><td><p>Unspecified data source type.</p></td></tr>-+<tr><td>ADMIN</td><td>1</td><td><p>Admin data source with write permissions.</p></td></tr>-+<tr><td>READ_ONLY</td><td>2</td><td><p>Read-only data source for query operations.</p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.InstanceService">InstanceService</h3><p>InstanceService manages database instances and their connections.</p><table class="enum-table">@@ -14271,7 +14334,7 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>GetInstance</td><td><a href="#bytebase.v1.GetInstanceRequest">GetInstanceRequest</a></td>@@ -14279,7 +14342,7 @@ In this situation, `update_mask` is ignored. </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>@@ -14287,7 +14350,7 @@ Permissions required: bb.instances.get</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>@@ -14295,7 +14358,7 @@ Permissions required: bb.instances.list</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>@@ -14303,7 +14366,7 @@ Permissions required: bb.instances.create</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>@@ -14311,7 +14374,7 @@ Permissions required: bb.instances.update</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>@@ -14319,7 +14382,7 @@ Permissions required: bb.instances.delete</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>@@ -14327,7 +14390,7 @@ Permissions required: bb.instances.undelete</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>@@ -14335,7 +14398,7 @@ Permissions required: bb.instances.sync</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>@@ -14343,7 +14406,7 @@ Permissions required: bb.instances.get</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>@@ -14351,7 +14414,7 @@ Permissions required: bb.instances.sync</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>@@ -14359,7 +14422,7 @@ 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>@@ -14367,7 +14430,7 @@ 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>@@ -14375,13 +14438,13 @@ Permissions required: bb.instances.update</p></td><td><p>Updates a data source configuration.Permissions required: bb.instances.update</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -14393,159 +14456,159 @@ Permissions required: bb.instances.update</p></td></tr></thead><tbody>---+++<tr><td>GetInstance</td><td>GET</td><td>/v1/{name=instances/*}</td><td></td></tr>----++++<tr><td>ListInstances</td><td>GET</td><td>/v1/instances</td><td></td></tr>----++++<tr><td>CreateInstance</td><td>POST</td><td>/v1/instances</td><td>instance</td></tr>----++++<tr><td>UpdateInstance</td><td>PATCH</td><td>/v1/{instance.name=instances/*}</td><td>instance</td></tr>----++++<tr><td>DeleteInstance</td><td>DELETE</td><td>/v1/{name=instances/*}</td><td></td></tr>----++++<tr><td>UndeleteInstance</td><td>POST</td><td>/v1/{name=instances/*}:undelete</td><td>*</td></tr>----++++<tr><td>SyncInstance</td><td>POST</td><td>/v1/{name=instances/*}:sync</td><td>*</td></tr>----++++<tr><td>ListInstanceDatabase</td><td>POST</td><td>/v1/{name=instances/*}:databases</td><td>*</td></tr>----++++<tr><td>BatchSyncInstances</td><td>POST</td><td>/v1/instances:batchSync</td><td>*</td></tr>----++++<tr><td>BatchUpdateInstances</td><td>POST</td><td>/v1/instances:batchUpdate</td><td>*</td></tr>----++++<tr><td>AddDataSource</td><td>POST</td><td>/v1/{name=instances/*}:addDataSource</td><td>*</td></tr>----++++<tr><td>RemoveDataSource</td><td>POST</td><td>/v1/{name=instances/*}:removeDataSource</td><td>*</td></tr>----++++<tr><td>UpdateDataSource</td><td>PATCH</td><td>/v1/{name=instances/*}:updateDataSource</td><td>data_source</td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/database_service.proto">v1/database_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.BatchGetDatabasesRequest">BatchGetDatabasesRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -14555,55 +14618,55 @@ Permissions required: bb.instances.update</p></td>- instances/{instances}: batch get databases in a instance;Use "-" as wildcard to batch get databases across parent. </p></td></tr>-+<tr><td>names</td><td><a href="#string">string</a></td><td>repeated</td><td><p>The list of database names to retrieve. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BatchGetDatabasesResponse">BatchGetDatabasesResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>databases</td><td><a href="#bytebase.v1.Database">Database</a></td><td>repeated</td><td><p>The databases from the specified request. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BatchSyncDatabasesRequest">BatchSyncDatabasesRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -14612,38 +14675,38 @@ Use "-" as wildcard to batch get databases across parent. </p></td>Format: instances/{instance}If the operation spans parents, a dash (-) may be accepted as a wildcard. </p></td></tr>-+<tr><td>names</td><td><a href="#string">string</a></td><td>repeated</td><td><p>The list of database names to sync. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BatchSyncDatabasesResponse">BatchSyncDatabasesResponse</h3><p></p>---+++<h3 id="bytebase.v1.BatchUpdateDatabasesRequest">BatchUpdateDatabasesRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -14653,7 +14716,7 @@ Format: instances/{instance}If the operation spans parents, a dash (-) may be accepted as a wildcard.We only support updating the project of databases for now. </p></td></tr>-+<tr><td>requests</td><td><a href="#bytebase.v1.UpdateDatabaseRequest">UpdateDatabaseRequest</a></td>@@ -14661,135 +14724,135 @@ We only support updating the project of databases for now. </p></td><td><p>The request message specifying the resources to update.A maximum of 1000 databases can be modified in a batch. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BatchUpdateDatabasesResponse">BatchUpdateDatabasesResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>databases</td><td><a href="#bytebase.v1.Database">Database</a></td><td>repeated</td><td><p>Databases updated. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BoundingBox">BoundingBox</h3><p>BoundingBox defines the spatial bounds for GEOMETRY spatial indexes.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>xmin</td><td><a href="#double">double</a></td><td></td><td><p>Minimum X coordinate </p></td></tr>-+<tr><td>ymin</td><td><a href="#double">double</a></td><td></td><td><p>Minimum Y coordinate </p></td></tr>-+<tr><td>xmax</td><td><a href="#double">double</a></td><td></td><td><p>Maximum X coordinate </p></td></tr>-+<tr><td>ymax</td><td><a href="#double">double</a></td><td></td><td><p>Maximum Y coordinate </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Changelog">Changelog</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>Format: instances/{instance}/databases/{database}/changelogs/{changelog} </p></td></tr>-+<tr><td>create_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>status</td><td><a href="#bytebase.v1.Changelog.Status">Changelog.Status</a></td><td></td><td><p> </p></td></tr>-+<tr><td>schema</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>schema_size</td><td><a href="#int64">int64</a></td><td></td><td><p> </p></td></tr>-+<tr><td>task_run</td><td><a href="#string">string</a></td><td></td><td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td></tr>-+<tr><td>plan_title</td><td><a href="#string">string</a></td>@@ -14797,83 +14860,83 @@ A maximum of 1000 databases can be modified in a batch. </p></td><td><p>The title of the plan associated with this changelog's task run.This field is populated by deriving the plan from task_run for display purposes. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.CheckConstraintMetadata">CheckConstraintMetadata</h3><p>CheckConstraintMetadata is the metadata for check constraints.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name is the name of a check constraint. </p></td></tr>-+<tr><td>expression</td><td><a href="#string">string</a></td><td></td><td><p>The expression is the expression of a check constraint. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ColumnMetadata">ColumnMetadata</h3><p>ColumnMetadata is the metadata for columns.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name is the name of a column. </p></td></tr>-+<tr><td>position</td><td><a href="#int32">int32</a></td><td></td><td><p>The position is the position in columns. </p></td></tr>-+<tr><td>has_default</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>default</td><td><a href="#string">string</a></td><td></td><td><p>The default value of column. </p></td></tr>-+<tr><td>default_on_null</td><td><a href="#bool">bool</a></td>@@ -14881,7 +14944,7 @@ This field is populated by deriving the plan from task_run for display purposes.<td><p>Oracle specific metadata.The default_on_null is the default on null of a column. </p></td></tr>-+<tr><td>on_update</td><td><a href="#string">string</a></td>@@ -14890,77 +14953,77 @@ The default_on_null is the default on null of a column. </p></td>For MySQL like databases, it's only supported for TIMESTAMP columns withCURRENT_TIMESTAMP as on update value. </p></td></tr>-+<tr><td>nullable</td><td><a href="#bool">bool</a></td><td></td><td><p>The nullable is the nullable of a column. </p></td></tr>-+<tr><td>type</td><td><a href="#string">string</a></td><td></td><td><p>The type is the type of a column. </p></td></tr>-+<tr><td>character_set</td><td><a href="#string">string</a></td><td></td><td><p>The character_set is the character_set of a column. </p></td></tr>-+<tr><td>collation</td><td><a href="#string">string</a></td><td></td><td><p>The collation is the collation of a column. </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment is the comment of a column. </p></td></tr>-+<tr><td>generation</td><td><a href="#bytebase.v1.GenerationMetadata">GenerationMetadata</a></td><td></td><td><p>The generation is the generation of a column. </p></td></tr>-+<tr><td>is_identity</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>identity_generation</td><td><a href="#bytebase.v1.ColumnMetadata.IdentityGeneration">ColumnMetadata.IdentityGeneration</a></td><td></td><td><p>The identity_generation is for identity columns, PG only. </p></td></tr>-+<tr><td>identity_seed</td><td><a href="#int64">int64</a></td><td></td><td><p>The identity_seed is for identity columns, MSSQL only. </p></td></tr>-+<tr><td>identity_increment</td><td><a href="#int64">int64</a></td><td></td><td><p>The identity_increment is for identity columns, MSSQL only. </p></td></tr>-+<tr><td>default_constraint_name</td><td><a href="#string">string</a></td>@@ -14986,24 +15049,24 @@ To modify the default, you must first drop the existing constraint by name:This field is populated when syncing from the database. When empty (e.g., when parsingfrom SQL files), the system cannot automatically drop the constraint. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Database">Database</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -15012,21 +15075,21 @@ from SQL files), the system cannot automatically drop the constraint. </p></td>Format: instances/{instance}/databases/{database}{database} is the database name in the instance. </p></td></tr>-+<tr><td>state</td><td><a href="#bytebase.v1.State">State</a></td><td></td><td><p>The existence of a database. </p></td></tr>-+<tr><td>successful_sync_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p>The latest synchronization time. </p></td></tr>-+<tr><td>project</td><td><a href="#string">string</a></td>@@ -15034,7 +15097,7 @@ Format: instances/{instance}/databases/{database}<td><p>The project for a database.Format: projects/{project} </p></td></tr>-+<tr><td>release</td><td><a href="#string">string</a></td>@@ -15043,7 +15106,7 @@ Format: projects/{project} </p></td>Format: projects/{project}/releases/{release_id}Example: projects/my-project/releases/release_20260115-RC00 </p></td></tr>-+<tr><td>environment</td><td><a href="#string">string</a></td>@@ -15051,7 +15114,7 @@ Example: projects/my-project/releases/release_20260115-RC00 </p></td><td><p>The environment resource.Format: environments/prod where prod is the environment resource ID. </p></td></tr>-+<tr><td>effective_environment</td><td><a href="#string">string</a></td>@@ -15060,90 +15123,90 @@ Format: environments/prod where prod is the environment resource ID. </p></td>tag on the instance. Inheritance followshttps://cloud.google.com/resource-manager/docs/tags/tags-overview. </p></td></tr>-+<tr><td>labels</td><td><a href="#bytebase.v1.Database.LabelsEntry">Database.LabelsEntry</a></td><td>repeated</td><td><p>Labels will be used for deployment and policy control. </p></td></tr>-+<tr><td>instance_resource</td><td><a href="#bytebase.v1.InstanceResource">InstanceResource</a></td><td></td><td><p>The instance resource. </p></td></tr>-+<tr><td>backup_available</td><td><a href="#bool">bool</a></td><td></td><td><p>The database is available for DML prior backup. </p></td></tr>-+<tr><td>sync_status</td><td><a href="#bytebase.v1.SyncStatus">SyncStatus</a></td><td></td><td><p>The sync status of the database. </p></td></tr>-+<tr><td>sync_error</td><td><a href="#string">string</a></td><td></td><td><p>The error message if sync failed. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Database.LabelsEntry">Database.LabelsEntry</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DatabaseMetadata">DatabaseMetadata</h3><p>DatabaseMetadata is the metadata for databases.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -15152,66 +15215,66 @@ https://cloud.google.com/resource-manager/docs/tags/tags-overview. </p></td>Format: instances/{instance}/databases/{database}/metadata </p></td></tr>-+<tr><td>schemas</td><td><a href="#bytebase.v1.SchemaMetadata">SchemaMetadata</a></td><td>repeated</td><td><p>The schemas is the list of schemas in a database. </p></td></tr>-+<tr><td>character_set</td><td><a href="#string">string</a></td><td></td><td><p>The character_set is the character set of a database. </p></td></tr>-+<tr><td>collation</td><td><a href="#string">string</a></td><td></td><td><p>The collation is the collation of a database. </p></td></tr>-+<tr><td>extensions</td><td><a href="#bytebase.v1.ExtensionMetadata">ExtensionMetadata</a></td><td>repeated</td><td><p>The extensions is the list of extensions in a database. </p></td></tr>-+<tr><td>owner</td><td><a href="#string">string</a></td><td></td><td><p>The owner of the database. </p></td></tr>-+<tr><td>search_path</td><td><a href="#string">string</a></td><td></td><td><p>The search_path is the search path of a PostgreSQL database. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DatabaseSDLSchema">DatabaseSDLSchema</h3><p>DatabaseSDLSchema contains the schema in SDL format.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>schema</td><td><a href="#bytes">bytes</a></td>@@ -15220,7 +15283,7 @@ Format: instances/{instance}/databases/{database}/metadata </p></td>- For SINGLE_FILE format: contains the complete SDL schema as a text string.- For MULTI_FILE format: contains the ZIP archive as binary data. </p></td></tr>-+<tr><td>content_type</td><td><a href="#string">string</a></td>@@ -15231,117 +15294,117 @@ Examples:- "text/plain; charset=utf-8" for SINGLE_FILE format- "application/zip" for MULTI_FILE format </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DatabaseSchema">DatabaseSchema</h3><p>DatabaseSchema is the metadata for databases.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>schema</td><td><a href="#string">string</a></td><td></td><td><p>The schema dump from database. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DependencyColumn">DependencyColumn</h3><p>DependencyColumn is the metadata for dependency columns.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>schema</td><td><a href="#string">string</a></td><td></td><td><p>The schema is the schema of a reference column. </p></td></tr>-+<tr><td>table</td><td><a href="#string">string</a></td><td></td><td><p>The table is the table of a reference column. </p></td></tr>-+<tr><td>column</td><td><a href="#string">string</a></td><td></td><td><p>The column is the name of a reference column. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DependencyTable">DependencyTable</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>schema</td><td><a href="#string">string</a></td><td></td><td><p>The schema is the schema of a reference table. </p></td></tr>-+<tr><td>table</td><td><a href="#string">string</a></td><td></td><td><p>The table is the name of a reference table. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DiffSchemaRequest">DiffSchemaRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -15351,14 +15414,14 @@ Format:database: instances/{instance}/databases/{database}changelog: instances/{instance}/databases/{database}/changelogs/{changelog} </p></td></tr>-+<tr><td>schema</td><td><a href="#string">string</a></td><td></td><td><p>The target schema. </p></td></tr>-+<tr><td>changelog</td><td><a href="#string">string</a></td>@@ -15367,256 +15430,256 @@ changelog: instances/{instance}/databases/{database}/changelogs/{changelog} </p>Format:instances/{instance}/databases/{database}/changelogs/{changelog} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DiffSchemaResponse">DiffSchemaResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>diff</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DimensionConstraint">DimensionConstraint</h3><p>DimensionConstraint defines constraints for a spatial dimension.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>dimension</td><td><a href="#string">string</a></td><td></td><td><p>Dimension name/type (X, Y, Z, M, etc.) </p></td></tr>-+<tr><td>min_value</td><td><a href="#double">double</a></td><td></td><td><p>Minimum value for this dimension </p></td></tr>-+<tr><td>max_value</td><td><a href="#double">double</a></td><td></td><td><p>Maximum value for this dimension </p></td></tr>-+<tr><td>tolerance</td><td><a href="#double">double</a></td><td></td><td><p>Tolerance for this dimension </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DimensionalConfig">DimensionalConfig</h3><p>DimensionalConfig defines dimensional and constraint parameters for spatial indexes.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>dimensions</td><td><a href="#int32">int32</a></td><td></td><td><p>Number of dimensions (2-4, default 2) </p></td></tr>-+<tr><td>data_type</td><td><a href="#string">string</a></td><td></td><td><p>Spatial data type (GEOMETRY, GEOGRAPHY, POINT, POLYGON, etc.) </p></td></tr>-+<tr><td>srid</td><td><a href="#int32">int32</a></td><td></td><td><p>Spatial reference system identifier (SRID) </p></td></tr>-+<tr><td>constraints</td><td><a href="#bytebase.v1.DimensionConstraint">DimensionConstraint</a></td><td>repeated</td><td><p>Coordinate system constraints </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.EnumTypeMetadata">EnumTypeMetadata</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of a type. </p></td></tr>-+<tr><td>values</td><td><a href="#string">string</a></td><td>repeated</td><td><p>The enum values of a type. </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment describing the enum type. </p></td></tr>-+<tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether to skip this enum type during schema dump operations. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.EventMetadata">EventMetadata</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of the event. </p></td></tr>-+<tr><td>definition</td><td><a href="#string">string</a></td><td></td><td><p>The schedule of the event. </p></td></tr>-+<tr><td>time_zone</td><td><a href="#string">string</a></td><td></td><td><p>The time zone of the event. </p></td></tr>-+<tr><td>sql_mode</td><td><a href="#string">string</a></td><td></td><td><p>The SQL mode setting for the event. </p></td></tr>-+<tr><td>character_set_client</td><td><a href="#string">string</a></td><td></td><td><p>The character set used by the client creating the event. </p></td></tr>-+<tr><td>collation_connection</td><td><a href="#string">string</a></td><td></td><td><p>The collation used for the connection when creating the event. </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment is the comment of an event. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ExtensionMetadata">ExtensionMetadata</h3><p>ExtensionMetadata is the metadata for extensions.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name is the name of an extension. </p></td></tr>-+<tr><td>schema</td><td><a href="#string">string</a></td>@@ -15624,97 +15687,97 @@ instances/{instance}/databases/{database}/changelogs/{changelog} </p></td><td><p>The schema is the extension that is installed to. But the extension usageis not limited to the schema. </p></td></tr>-+<tr><td>version</td><td><a href="#string">string</a></td><td></td><td><p>The version is the version of an extension. </p></td></tr>-+<tr><td>description</td><td><a href="#string">string</a></td><td></td><td><p>The description is the description of an extension. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ExternalTableMetadata">ExternalTableMetadata</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name is the name of a external table. </p></td></tr>-+<tr><td>external_server_name</td><td><a href="#string">string</a></td><td></td><td><p>The external_server_name is the name of the external server. </p></td></tr>-+<tr><td>external_database_name</td><td><a href="#string">string</a></td><td></td><td><p>The external_database_name is the name of the external database. </p></td></tr>-+<tr><td>columns</td><td><a href="#bytebase.v1.ColumnMetadata">ColumnMetadata</a></td><td>repeated</td><td><p>The columns is the ordered list of columns in a foreign table. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ForeignKeyMetadata">ForeignKeyMetadata</h3><p>ForeignKeyMetadata is the metadata for foreign keys.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name is the name of a foreign key. </p></td></tr>-+<tr><td>columns</td><td><a href="#string">string</a></td><td>repeated</td><td><p>The columns are the ordered referencing columns of a foreign key. </p></td></tr>-+<tr><td>referenced_schema</td><td><a href="#string">string</a></td>@@ -15722,35 +15785,35 @@ is not limited to the schema. </p></td><td><p>The referenced_schema is the referenced schema name of a foreign key.It is an empty string for databases without such concept such as MySQL. </p></td></tr>-+<tr><td>referenced_table</td><td><a href="#string">string</a></td><td></td><td><p>The referenced_table is the referenced table name of a foreign key. </p></td></tr>-+<tr><td>referenced_columns</td><td><a href="#string">string</a></td><td>repeated</td><td><p>The referenced_columns are the ordered referenced columns of a foreign key. </p></td></tr>-+<tr><td>on_delete</td><td><a href="#string">string</a></td><td></td><td><p>The on_delete is the on delete action of a foreign key. </p></td></tr>-+<tr><td>on_update</td><td><a href="#string">string</a></td><td></td><td><p>The on_update is the on update action of a foreign key. </p></td></tr>-+<tr><td>match_type</td><td><a href="#string">string</a></td>@@ -15759,38 +15822,38 @@ It is an empty string for databases without such concept such as MySQL. </p></tdThe match_type is the PostgreSQL specific field.It's empty string for other databases. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.FunctionMetadata">FunctionMetadata</h3><p>FunctionMetadata is the metadata for functions.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name is the name of a function. </p></td></tr>-+<tr><td>definition</td><td><a href="#string">string</a></td><td></td><td><p>The definition is the definition of a function. </p></td></tr>-+<tr><td>signature</td><td><a href="#string">string</a></td>@@ -15798,42 +15861,42 @@ It's empty string for other databases. </p></td><td><p>The signature is the name with the number and type of input arguments thefunction takes. </p></td></tr>-+<tr><td>character_set_client</td><td><a href="#string">string</a></td><td></td><td><p>MySQL specific metadata. </p></td></tr>-+<tr><td>collation_connection</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>database_collation</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>sql_mode</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>dependency_tables</td><td><a href="#bytebase.v1.DependencyTable">DependencyTable</a></td>@@ -15841,62 +15904,62 @@ function takes. </p></td><td><p>The dependency_tables is the list of dependency tables of a function.For PostgreSQL, it's the list of tables that the function depends on the return type definition. </p></td></tr>-+<tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GenerationMetadata">GenerationMetadata</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>type</td><td><a href="#bytebase.v1.GenerationMetadata.Type">GenerationMetadata.Type</a></td><td></td><td><p> </p></td></tr>-+<tr><td>expression</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetChangelogRequest">GetChangelogRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -15904,31 +15967,31 @@ For PostgreSQL, it's the list of tables that the function depends on the ret<td><p>The name of the changelog to retrieve.Format: instances/{instance}/databases/{database}/changelogs/{changelog} </p></td></tr>-+<tr><td>view</td><td><a href="#bytebase.v1.ChangelogView">ChangelogView</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetDatabaseMetadataRequest">GetDatabaseMetadataRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -15936,7 +15999,7 @@ Format: instances/{instance}/databases/{database}/changelogs/{changelog} </p></t<td><p>The name of the database to retrieve metadata.Format: instances/{instance}/databases/{database}/metadata </p></td></tr>-+<tr><td>filter</td><td><a href="#string">string</a></td>@@ -15956,7 +16019,7 @@ schema == "schema-a" && table.contains("sample")The filter is used to search for tables containing "sample" in the schema "schemas/schema-a".The column masking level will only be returned when a table filter is used. </p></td></tr>-+<tr><td>limit</td><td><a href="#int32">int32</a></td>@@ -15966,24 +16029,24 @@ For example, if the database has 3 schemas, and each schema has 100 tables,if limit is 20, then only 20 tables will be returned for each schema, total 60 tables.Default 0, means no limit. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetDatabaseRequest">GetDatabaseRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -15991,24 +16054,24 @@ Default 0, means no limit. </p></td><td><p>The name of the database to retrieve.Format: instances/{instance}/databases/{database} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetDatabaseSDLSchemaRequest">GetDatabaseSDLSchemaRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -16016,31 +16079,31 @@ Format: instances/{instance}/databases/{database} </p></td><td><p>The name of the database to retrieve SDL schema.Format: instances/{instance}/databases/{database}/sdlSchema </p></td></tr>-+<tr><td>format</td><td><a href="#bytebase.v1.GetDatabaseSDLSchemaRequest.SDLFormat">GetDatabaseSDLSchemaRequest.SDLFormat</a></td><td></td><td><p>The format of the SDL schema output. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetDatabaseSchemaRequest">GetDatabaseSchemaRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -16048,24 +16111,24 @@ Format: instances/{instance}/databases/{database}/sdlSchema </p></td><td><p>The name of the database to retrieve schema.Format: instances/{instance}/databases/{database}/schema </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetSchemaStringRequest">GetSchemaStringRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -16073,28 +16136,28 @@ Format: instances/{instance}/databases/{database}/schema </p></td><td><p>The name of the database.Format: instances/{instance}/databases/{database} </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.v1.GetSchemaStringRequest.ObjectType">GetSchemaStringRequest.ObjectType</a></td><td></td><td><p> </p></td></tr>-+<tr><td>schema</td><td><a href="#string">string</a></td><td></td><td><p>It's empty for DATABASE. </p></td></tr>-+<tr><td>object</td><td><a href="#string">string</a></td><td></td><td><p>It's empty for DATABASE and SCHEMA. </p></td></tr>-+<tr><td>metadata</td><td><a href="#bytebase.v1.DatabaseMetadata">DatabaseMetadata</a></td>@@ -16102,86 +16165,86 @@ Format: instances/{instance}/databases/{database} </p></td><td><p>If use the metadata to generate the schema string, the type is OBJECT_TYPE_UNSPECIFIED.Also the schema and object are empty. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetSchemaStringResponse">GetSchemaStringResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>schema_string</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GridLevel">GridLevel</h3><p>GridLevel defines a tessellation grid level with its density.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>level</td><td><a href="#int32">int32</a></td><td></td><td><p>Grid level number (1-4 for SQL Server) </p></td></tr>-+<tr><td>density</td><td><a href="#string">string</a></td><td></td><td><p>Grid density (LOW, MEDIUM, HIGH) </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.IndexMetadata">IndexMetadata</h3><p>IndexMetadata is the metadata for indexes.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name is the name of an index. </p></td></tr>-+<tr><td>expressions</td><td><a href="#string">string</a></td>@@ -16189,7 +16252,7 @@ Also the schema and object are empty. </p></td><td><p>The expressions are the ordered columns or expressions of an index.This could refer to a column or an expression. </p></td></tr>-+<tr><td>key_length</td><td><a href="#int64">int64</a></td>@@ -16197,77 +16260,77 @@ This could refer to a column or an expression. </p></td><td><p>The key_lengths are the ordered key lengths of an index.If the key length is not specified, it's -1. </p></td></tr>-+<tr><td>descending</td><td><a href="#bool">bool</a></td><td>repeated</td><td><p>The descending is the ordered descending of an index. </p></td></tr>-+<tr><td>type</td><td><a href="#string">string</a></td><td></td><td><p>The type is the type of an index. </p></td></tr>-+<tr><td>unique</td><td><a href="#bool">bool</a></td><td></td><td><p>The unique is whether the index is unique. </p></td></tr>-+<tr><td>primary</td><td><a href="#bool">bool</a></td><td></td><td><p>The primary is whether the index is a primary key index. </p></td></tr>-+<tr><td>visible</td><td><a href="#bool">bool</a></td><td></td><td><p>The visible is whether the index is visible. </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment is the comment of an index. </p></td></tr>-+<tr><td>definition</td><td><a href="#string">string</a></td><td></td><td><p>The definition of an index. </p></td></tr>-+<tr><td>parent_index_schema</td><td><a href="#string">string</a></td><td></td><td><p>The schema name of the parent index. </p></td></tr>-+<tr><td>parent_index_name</td><td><a href="#string">string</a></td><td></td><td><p>The index name of the parent index. </p></td></tr>-+<tr><td>granularity</td><td><a href="#int64">int64</a></td><td></td><td><p>The number of granules in the block. It's a ClickHouse specific field. </p></td></tr>-+<tr><td>is_constraint</td><td><a href="#bool">bool</a></td>@@ -16275,14 +16338,14 @@ If the key length is not specified, it's -1. </p></td><td><p>It's a PostgreSQL specific field.The unique constraint and unique index are not the same thing in PostgreSQL. </p></td></tr>-+<tr><td>spatial_config</td><td><a href="#bytebase.v1.SpatialIndexConfig">SpatialIndexConfig</a></td><td></td><td><p>Spatial index configuration for spatial databases like SQL Server, PostgreSQL with PostGIS, etc. </p></td></tr>-+<tr><td>opclass_names</td><td><a href="#string">string</a></td>@@ -16290,31 +16353,31 @@ The unique constraint and unique index are not the same thing in PostgreSQL. </p<td><p>https://www.postgresql.org/docs/current/catalog-pg-opclass.htmlName of the operator class for each column. (PostgreSQL specific). </p></td></tr>-+<tr><td>opclass_defaults</td><td><a href="#bool">bool</a></td><td>repeated</td><td><p>True if the operator class is the default. (PostgreSQL specific). </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListChangelogsRequest">ListChangelogsRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -16322,7 +16385,7 @@ Name of the operator class for each column. (PostgreSQL specific). </p></td><td><p>The parent of the changelogs.Format: instances/{instance}/databases/{database} </p></td></tr>-+<tr><td>page_size</td><td><a href="#int32">int32</a></td>@@ -16331,7 +16394,7 @@ Format: instances/{instance}/databases/{database} </p></td>than this value. If unspecified, at most 10 changelogs will be returned.The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td></tr>-+<tr><td>page_token</td><td><a href="#string">string</a></td>@@ -16342,14 +16405,14 @@ Provide this to retrieve the subsequent page.When paginating, all other parameters provided must matchthe call that provided the page token. </p></td></tr>-+<tr><td>view</td><td><a href="#bytebase.v1.ChangelogView">ChangelogView</a></td><td></td><td><p> </p></td></tr>-+<tr><td>filter</td><td><a href="#string">string</a></td>@@ -16366,31 +16429,31 @@ status == "DONE"status == "FAILED" && type == "SDL"create_time >= "2024-01-01T00:00:00Z" && create_time <= "2024-01-02T00:00:00Z" </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListChangelogsResponse">ListChangelogsResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>changelogs</td><td><a href="#bytebase.v1.Changelog">Changelog</a></td><td>repeated</td><td><p>The list of changelogs. </p></td></tr>-+<tr><td>next_page_token</td><td><a href="#string">string</a></td>@@ -16398,24 +16461,24 @@ create_time >= "2024-01-01T00:00:00Z" && create_time <= &#<td><p>A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListDatabasesRequest">ListDatabasesRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -16424,7 +16487,7 @@ If this field is omitted, there are no subsequent pages. </p></td>- workspaces/{id}: list databases in the workspace, require "bb.databases.list" permission.- instances/{instances}: list databases in a instance, require "bb.instances.get" permission </p></td></tr>-+<tr><td>page_size</td><td><a href="#int32">int32</a></td>@@ -16434,7 +16497,7 @@ than this value.If unspecified, at most 10 databases will be returned.The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td></tr>-+<tr><td>page_token</td><td><a href="#string">string</a></td>@@ -16445,7 +16508,7 @@ Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `ListDatabases` mustmatch the call that provided the page token. </p></td></tr>-+<tr><td>filter</td><td><a href="#string">string</a></td>@@ -16482,14 +16545,14 @@ labels.region in ["asia", "europe"]You can combine filter conditions like:environment == "environments/prod" && name.contains("employee") </p></td></tr>-+<tr><td>show_deleted</td><td><a href="#bool">bool</a></td><td></td><td><p>Show deleted database if specified. </p></td></tr>-+<tr><td>order_by</td><td><a href="#string">string</a></td>@@ -16501,31 +16564,31 @@ For example:- order_by = "name desc"- order_by = "name desc, project asc" </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListDatabasesResponse">ListDatabasesResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>databases</td><td><a href="#bytebase.v1.Database">Database</a></td><td>repeated</td><td><p>The databases from the specified request. </p></td></tr>-+<tr><td>next_page_token</td><td><a href="#string">string</a></td>@@ -16533,45 +16596,45 @@ For example:<td><p>A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.MaterializedViewMetadata">MaterializedViewMetadata</h3><p>MaterializedViewMetadata is the metadata for materialized views.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name is the name of a materialized view. </p></td></tr>-+<tr><td>definition</td><td><a href="#string">string</a></td><td></td><td><p>The definition is the definition of a materialized view. </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment is the comment of a materialized view. </p></td></tr>-+<tr><td>dependency_columns</td><td><a href="#bytebase.v1.DependencyColumn">DependencyColumn</a></td>@@ -16579,90 +16642,90 @@ If this field is omitted, there are no subsequent pages. </p></td><td><p>The dependency_columns is the list of dependency columns of a materializedview. </p></td></tr>-+<tr><td>triggers</td><td><a href="#bytebase.v1.TriggerMetadata">TriggerMetadata</a></td><td>repeated</td><td><p>The columns is the ordered list of columns in a table. </p></td></tr>-+<tr><td>indexes</td><td><a href="#bytebase.v1.IndexMetadata">IndexMetadata</a></td><td>repeated</td><td><p>The indexes is the list of indexes in a table. </p></td></tr>-+<tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.PackageMetadata">PackageMetadata</h3><p>PackageMetadata is the metadata for packages.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name is the name of a package. </p></td></tr>-+<tr><td>definition</td><td><a href="#string">string</a></td><td></td><td><p>The definition is the definition of a package. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ProcedureMetadata">ProcedureMetadata</h3><p>ProcedureMetadata is the metadata for procedures.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name is the name of a procedure. </p></td></tr>-+<tr><td>definition</td><td><a href="#string">string</a></td><td></td><td><p>The definition is the definition of a procedure. </p></td></tr>-+<tr><td>signature</td><td><a href="#string">string</a></td>@@ -16670,66 +16733,66 @@ view. </p></td><td><p>The signature is the name with the number and type of input arguments theprocedure takes. </p></td></tr>-+<tr><td>character_set_client</td><td><a href="#string">string</a></td><td></td><td><p>MySQL specific metadata. </p></td></tr>-+<tr><td>collation_connection</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>database_collation</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>sql_mode</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment is the comment of a procedure. </p></td></tr>-+<tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SchemaMetadata">SchemaMetadata</h3><p>SchemaMetadata is the metadata for schemas.</p><p>This is the concept of schema in Postgres, but it's a no-op for MySQL.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -16737,42 +16800,42 @@ procedure takes. </p></td><td><p>The name is the schema name.It is an empty string for databases without such concept such as MySQL. </p></td></tr>-+<tr><td>tables</td><td><a href="#bytebase.v1.TableMetadata">TableMetadata</a></td><td>repeated</td><td><p>The tables is the list of tables in a schema. </p></td></tr>-+<tr><td>external_tables</td><td><a href="#bytebase.v1.ExternalTableMetadata">ExternalTableMetadata</a></td><td>repeated</td><td><p>The external_tables is the list of external tables in a schema. </p></td></tr>-+<tr><td>views</td><td><a href="#bytebase.v1.ViewMetadata">ViewMetadata</a></td><td>repeated</td><td><p>The views is the list of views in a schema. </p></td></tr>-+<tr><td>functions</td><td><a href="#bytebase.v1.FunctionMetadata">FunctionMetadata</a></td><td>repeated</td><td><p>The functions is the list of functions in a schema. </p></td></tr>-+<tr><td>procedures</td><td><a href="#bytebase.v1.ProcedureMetadata">ProcedureMetadata</a></td><td>repeated</td><td><p>The procedures is the list of procedures in a schema. </p></td></tr>-+<tr><td>streams</td><td><a href="#bytebase.v1.StreamMetadata">StreamMetadata</a></td>@@ -16780,7 +16843,7 @@ It is an empty string for databases without such concept such as MySQL. </p></td<td><p>The streams is the list of streams in a schema, currently, only used forSnowflake. </p></td></tr>-+<tr><td>tasks</td><td><a href="#bytebase.v1.TaskMetadata">TaskMetadata</a></td>@@ -16788,421 +16851,421 @@ Snowflake. </p></td><td><p>The routines is the list of routines in a schema, currently, only used forSnowflake. </p></td></tr>-+<tr><td>materialized_views</td><td><a href="#bytebase.v1.MaterializedViewMetadata">MaterializedViewMetadata</a></td><td>repeated</td><td><p>The materialized_views is the list of materialized views in a schema. </p></td></tr>-+<tr><td>packages</td><td><a href="#bytebase.v1.PackageMetadata">PackageMetadata</a></td><td>repeated</td><td><p>The packages is the list of packages in a schema. </p></td></tr>-+<tr><td>owner</td><td><a href="#string">string</a></td><td></td><td><p>The owner of the schema. </p></td></tr>-+<tr><td>sequences</td><td><a href="#bytebase.v1.SequenceMetadata">SequenceMetadata</a></td><td>repeated</td><td><p>The sequences is the list of sequences in a schema, sorted by name. </p></td></tr>-+<tr><td>events</td><td><a href="#bytebase.v1.EventMetadata">EventMetadata</a></td><td>repeated</td><td><p>The events is the list of scheduled events in a schema. </p></td></tr>-+<tr><td>enum_types</td><td><a href="#bytebase.v1.EnumTypeMetadata">EnumTypeMetadata</a></td><td>repeated</td><td><p>The enum_types is the list of user-defined enum types in a schema. </p></td></tr>-+<tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether to skip this schema during schema dump operations. </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment is the comment of a schema. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SequenceMetadata">SequenceMetadata</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name of a sequence. </p></td></tr>-+<tr><td>data_type</td><td><a href="#string">string</a></td><td></td><td><p>The data type of a sequence. </p></td></tr>-+<tr><td>start</td><td><a href="#string">string</a></td><td></td><td><p>The start value of a sequence. </p></td></tr>-+<tr><td>min_value</td><td><a href="#string">string</a></td><td></td><td><p>The minimum value of a sequence. </p></td></tr>-+<tr><td>max_value</td><td><a href="#string">string</a></td><td></td><td><p>The maximum value of a sequence. </p></td></tr>-+<tr><td>increment</td><td><a href="#string">string</a></td><td></td><td><p>Increment value of a sequence. </p></td></tr>-+<tr><td>cycle</td><td><a href="#bool">bool</a></td><td></td><td><p>Cycle is whether the sequence cycles. </p></td></tr>-+<tr><td>cache_size</td><td><a href="#string">string</a></td><td></td><td><p>Cache size of a sequence. </p></td></tr>-+<tr><td>last_value</td><td><a href="#string">string</a></td><td></td><td><p>Last value of a sequence. </p></td></tr>-+<tr><td>owner_table</td><td><a href="#string">string</a></td><td></td><td><p>The owner table of the sequence. </p></td></tr>-+<tr><td>owner_column</td><td><a href="#string">string</a></td><td></td><td><p>The owner column of the sequence. </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment describing the sequence. </p></td></tr>-+<tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether to skip this sequence during schema dump operations. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SpatialIndexConfig">SpatialIndexConfig</h3><p>SpatialIndexConfig defines the spatial index configuration for spatial databases.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>method</td><td><a href="#string">string</a></td><td></td><td><p>Spatial indexing method (e.g., "SPATIAL", "R-TREE", "GIST") </p></td></tr>-+<tr><td>tessellation</td><td><a href="#bytebase.v1.TessellationConfig">TessellationConfig</a></td><td></td><td><p>Tessellation configuration for grid-based spatial indexes </p></td></tr>-+<tr><td>storage</td><td><a href="#bytebase.v1.StorageConfig">StorageConfig</a></td><td></td><td><p>Storage and performance configuration </p></td></tr>-+<tr><td>dimensional</td><td><a href="#bytebase.v1.DimensionalConfig">DimensionalConfig</a></td><td></td><td><p>Dimensional configuration </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.StorageConfig">StorageConfig</h3><p>StorageConfig defines storage and performance parameters for spatial indexes.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>fillfactor</td><td><a href="#int32">int32</a></td><td></td><td><p>Fill factor percentage (1-100) </p></td></tr>-+<tr><td>buffering</td><td><a href="#string">string</a></td><td></td><td><p>Buffering mode for PostgreSQL (auto, on, off) </p></td></tr>-+<tr><td>tablespace</td><td><a href="#string">string</a></td><td></td><td><p>Tablespace configuration for Oracle </p></td></tr>-+<tr><td>work_tablespace</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>sdo_level</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>commit_interval</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>pad_index</td><td><a href="#bool">bool</a></td><td></td><td><p>SQL Server specific parameters </p></td></tr>-+<tr><td>sort_in_tempdb</td><td><a href="#string">string</a></td><td></td><td><p>ON, OFF </p></td></tr>-+<tr><td>drop_existing</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>online</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>allow_row_locks</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>allow_page_locks</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>maxdop</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>data_compression</td><td><a href="#string">string</a></td><td></td><td><p>NONE, ROW, PAGE </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.StreamMetadata">StreamMetadata</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name is the name of a stream. </p></td></tr>-+<tr><td>table_name</td><td><a href="#string">string</a></td><td></td><td><p>The table_name is the name of the table/view that the stream is created on. </p></td></tr>-+<tr><td>owner</td><td><a href="#string">string</a></td><td></td><td><p>The owner of the stream. </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment of the stream. </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.v1.StreamMetadata.Type">StreamMetadata.Type</a></td><td></td><td><p>The type of the stream. </p></td></tr>-+<tr><td>stale</td><td><a href="#bool">bool</a></td><td></td><td><p>Indicates whether the stream was last read before the `stale_after` time. </p></td></tr>-+<tr><td>mode</td><td><a href="#bytebase.v1.StreamMetadata.Mode">StreamMetadata.Mode</a></td><td></td><td><p>The mode of the stream. </p></td></tr>-+<tr><td>definition</td><td><a href="#string">string</a></td><td></td><td><p>The definition of the stream. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SyncDatabaseRequest">SyncDatabaseRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -17210,143 +17273,143 @@ Snowflake. </p></td><td><p>The name of the database to sync.Format: instances/{instance}/databases/{database} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SyncDatabaseResponse">SyncDatabaseResponse</h3><p></p>---+++<h3 id="bytebase.v1.TableMetadata">TableMetadata</h3><p>TableMetadata is the metadata for tables.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name is the name of a table. </p></td></tr>-+<tr><td>columns</td><td><a href="#bytebase.v1.ColumnMetadata">ColumnMetadata</a></td><td>repeated</td><td><p>The columns is the ordered list of columns in a table. </p></td></tr>-+<tr><td>indexes</td><td><a href="#bytebase.v1.IndexMetadata">IndexMetadata</a></td><td>repeated</td><td><p>The indexes is the list of indexes in a table. </p></td></tr>-+<tr><td>engine</td><td><a href="#string">string</a></td><td></td><td><p>The engine is the engine of a table. </p></td></tr>-+<tr><td>collation</td><td><a href="#string">string</a></td><td></td><td><p>The collation is the collation of a table. </p></td></tr>-+<tr><td>charset</td><td><a href="#string">string</a></td><td></td><td><p>The character set of table. </p></td></tr>-+<tr><td>row_count</td><td><a href="#int64">int64</a></td><td></td><td><p>The row_count is the estimated number of rows of a table. </p></td></tr>-+<tr><td>data_size</td><td><a href="#int64">int64</a></td><td></td><td><p>The data_size is the estimated data size of a table. </p></td></tr>-+<tr><td>index_size</td><td><a href="#int64">int64</a></td><td></td><td><p>The index_size is the estimated index size of a table. </p></td></tr>-+<tr><td>data_free</td><td><a href="#int64">int64</a></td><td></td><td><p>The data_free is the estimated free data size of a table. </p></td></tr>-+<tr><td>create_options</td><td><a href="#string">string</a></td><td></td><td><p>The create_options is the create option of a table. </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment is the comment of a table. </p></td></tr>-+<tr><td>foreign_keys</td><td><a href="#bytebase.v1.ForeignKeyMetadata">ForeignKeyMetadata</a></td><td>repeated</td><td><p>The foreign_keys is the list of foreign keys in a table. </p></td></tr>-+<tr><td>partitions</td><td><a href="#bytebase.v1.TablePartitionMetadata">TablePartitionMetadata</a></td><td>repeated</td><td><p>The partitions is the list of partitions in a table. </p></td></tr>-+<tr><td>check_constraints</td><td><a href="#bytebase.v1.CheckConstraintMetadata">CheckConstraintMetadata</a></td><td>repeated</td><td><p>The check_constraints is the list of check constraints in a table. </p></td></tr>-+<tr><td>owner</td><td><a href="#string">string</a></td><td></td><td><p>The owner of the table. </p></td></tr>-+<tr><td>sorting_keys</td><td><a href="#string">string</a></td>@@ -17354,28 +17417,28 @@ Format: instances/{instance}/databases/{database} </p></td><td><p>The sorting_keys is a tuple of column names or arbitrary expressions. ClickHouse specific field.Reference: https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/mergetree#order_by </p></td></tr>-+<tr><td>triggers</td><td><a href="#bytebase.v1.TriggerMetadata">TriggerMetadata</a></td><td>repeated</td><td><p>The triggers is the list of triggers associated with the table. </p></td></tr>-+<tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether to skip this table during schema dump operations. </p></td></tr>-+<tr><td>sharding_info</td><td><a href="#string">string</a></td><td></td><td><p>https://docs.pingcap.com/tidb/stable/information-schema-tables/ </p></td></tr>-+<tr><td>primary_key_type</td><td><a href="#string">string</a></td>@@ -17383,38 +17446,38 @@ Reference: https://clickhouse.com/docs/en/engines/table-engines/mergetree-family<td><p>https://docs.pingcap.com/tidb/stable/clustered-indexes/#clustered-indexesCLUSTERED or NONCLUSTERED. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TablePartitionMetadata">TablePartitionMetadata</h3><p>TablePartitionMetadata is the metadata for table partitions.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name is the name of a table partition. </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.v1.TablePartitionMetadata.Type">TablePartitionMetadata.Type</a></td><td></td><td><p>The type of a table partition. </p></td></tr>-+<tr><td>expression</td><td><a href="#string">string</a></td>@@ -17430,7 +17493,7 @@ PARTITION BY| RANGE{(expr) | COLUMNS(column_list)}| LIST{(expr) | COLUMNS(column_list)} }. </p></td></tr>-+<tr><td>value</td><td><a href="#string">string</a></td>@@ -17444,7 +17507,7 @@ partition's VALUES IN clause, which is a list of comma-separated integervalues.- For others, it's an empty string. </p></td></tr>-+<tr><td>use_default</td><td><a href="#string">string</a></td>@@ -17454,52 +17517,52 @@ the different value for different database engines. For MySQL, it's [INT]type, 0 means not use default partition, otherwise, it's equals to numberin syntax [SUB]PARTITION {number}. </p></td></tr>-+<tr><td>subpartitions</td><td><a href="#bytebase.v1.TablePartitionMetadata">TablePartitionMetadata</a></td><td>repeated</td><td><p>The subpartitions is the list of subpartitions in a table partition. </p></td></tr>-+<tr><td>indexes</td><td><a href="#bytebase.v1.IndexMetadata">IndexMetadata</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>check_constraints</td><td><a href="#bytebase.v1.CheckConstraintMetadata">CheckConstraintMetadata</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TaskMetadata">TaskMetadata</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name is the name of a task. </p></td></tr>-+<tr><td>id</td><td><a href="#string">string</a></td>@@ -17507,132 +17570,132 @@ in syntax [SUB]PARTITION {number}. </p></td><td><p>The id is the snowflake-generated id of a task.Example: 01ad32a0-1bb6-5e93-0000-000000000001 </p></td></tr>-+<tr><td>owner</td><td><a href="#string">string</a></td><td></td><td><p>The owner of the task. </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment of the task. </p></td></tr>-+<tr><td>warehouse</td><td><a href="#string">string</a></td><td></td><td><p>The warehouse of the task. </p></td></tr>-+<tr><td>schedule</td><td><a href="#string">string</a></td><td></td><td><p>The schedule interval of the task. </p></td></tr>-+<tr><td>predecessors</td><td><a href="#string">string</a></td><td>repeated</td><td><p>The predecessor tasks of the task. </p></td></tr>-+<tr><td>state</td><td><a href="#bytebase.v1.TaskMetadata.State">TaskMetadata.State</a></td><td></td><td><p>The state of the task. </p></td></tr>-+<tr><td>condition</td><td><a href="#string">string</a></td><td></td><td><p>The condition of the task. </p></td></tr>-+<tr><td>definition</td><td><a href="#string">string</a></td><td></td><td><p>The definition of the task. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TessellationConfig">TessellationConfig</h3><p>TessellationConfig defines tessellation parameters for spatial indexes.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>scheme</td><td><a href="#string">string</a></td><td></td><td><p>Tessellation scheme (e.g., "GEOMETRY_GRID", "GEOGRAPHY_GRID", "GEOMETRY_AUTO_GRID") </p></td></tr>-+<tr><td>grid_levels</td><td><a href="#bytebase.v1.GridLevel">GridLevel</a></td><td>repeated</td><td><p>Grid levels and densities for multi-level tessellation </p></td></tr>-+<tr><td>cells_per_object</td><td><a href="#int32">int32</a></td><td></td><td><p>Number of cells per object (1-8192 for SQL Server) </p></td></tr>-+<tr><td>bounding_box</td><td><a href="#bytebase.v1.BoundingBox">BoundingBox</a></td><td></td><td><p>Bounding box for GEOMETRY tessellation (not used for GEOGRAPHY) </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TriggerMetadata">TriggerMetadata</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name is the name of the trigger. </p></td></tr>-+<tr><td>event</td><td><a href="#string">string</a></td>@@ -17640,73 +17703,73 @@ Example: 01ad32a0-1bb6-5e93-0000-000000000001 </p></td><td><p>The event is the event of the trigger, such as INSERT, UPDATE, DELETE,TRUNCATE. </p></td></tr>-+<tr><td>timing</td><td><a href="#string">string</a></td><td></td><td><p>The timing is the timing of the trigger, such as BEFORE, AFTER. </p></td></tr>-+<tr><td>body</td><td><a href="#string">string</a></td><td></td><td><p>The body is the body of the trigger. </p></td></tr>-+<tr><td>sql_mode</td><td><a href="#string">string</a></td><td></td><td><p>The SQL mode setting for the trigger. </p></td></tr>-+<tr><td>character_set_client</td><td><a href="#string">string</a></td><td></td><td><p>The character set used by the client creating the trigger. </p></td></tr>-+<tr><td>collation_connection</td><td><a href="#string">string</a></td><td></td><td><p>The collation used for the connection when creating the trigger. </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment describing the trigger. </p></td></tr>-+<tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether to skip this trigger during schema dump operations. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdateDatabaseRequest">UpdateDatabaseRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>database</td><td><a href="#bytebase.v1.Database">Database</a></td>@@ -17716,14 +17779,14 @@ TRUNCATE. </p></td>The database's `name` field is used to identify the database to update.Format: instances/{instance}/databases/{database} </p></td></tr>-+<tr><td>update_mask</td><td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td><td></td><td><p>The list of fields to update. </p></td></tr>-+<tr><td>allow_missing</td><td><a href="#bool">bool</a></td>@@ -17731,82 +17794,82 @@ Format: instances/{instance}/databases/{database} </p></td><td><p>If set to true, and the database is not found, a new database will be created.In this situation, `update_mask` is ignored. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ViewMetadata">ViewMetadata</h3><p>ViewMetadata is the metadata for views.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>The name is the name of a view. </p></td></tr>-+<tr><td>definition</td><td><a href="#string">string</a></td><td></td><td><p>The definition is the definition of a view. </p></td></tr>-+<tr><td>comment</td><td><a href="#string">string</a></td><td></td><td><p>The comment is the comment of a view. </p></td></tr>-+<tr><td>dependency_columns</td><td><a href="#bytebase.v1.DependencyColumn">DependencyColumn</a></td><td>repeated</td><td><p>The dependency_columns is the list of dependency columns of a view. </p></td></tr>-+<tr><td>columns</td><td><a href="#bytebase.v1.ColumnMetadata">ColumnMetadata</a></td><td>repeated</td><td><p>The columns is the ordered list of columns in a table. </p></td></tr>-+<tr><td>triggers</td><td><a href="#bytebase.v1.TriggerMetadata">TriggerMetadata</a></td><td>repeated</td><td><p>The triggers is the list of triggers in a view. </p></td></tr>-+<tr><td>skip_dump</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.Changelog.Status">Changelog.Status</h3><p></p><table class="enum-table">@@ -17814,34 +17877,34 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>STATUS_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>PENDING</td><td>1</td><td><p></p></td></tr>-+<tr><td>DONE</td><td>2</td><td><p></p></td></tr>-+<tr><td>FAILED</td><td>3</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.ChangelogView">ChangelogView</h3><p></p><table class="enum-table">@@ -17849,29 +17912,29 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>CHANGELOG_VIEW_UNSPECIFIED</td><td>0</td><td><p>The default / unset value.The API will default to the BASIC view.</p></td></tr>-+<tr><td>CHANGELOG_VIEW_BASIC</td><td>1</td><td><p></p></td></tr>-+<tr><td>CHANGELOG_VIEW_FULL</td><td>2</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.ColumnMetadata.IdentityGeneration">ColumnMetadata.IdentityGeneration</h3><p></p><table class="enum-table">@@ -17879,28 +17942,28 @@ The API will default to the BASIC view.</p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>IDENTITY_GENERATION_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>ALWAYS</td><td>1</td><td><p></p></td></tr>-+<tr><td>BY_DEFAULT</td><td>2</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.GenerationMetadata.Type">GenerationMetadata.Type</h3><p></p><table class="enum-table">@@ -17908,28 +17971,28 @@ The API will default to the BASIC view.</p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>VIRTUAL</td><td>1</td><td><p></p></td></tr>-+<tr><td>STORED</td><td>2</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.GetDatabaseSDLSchemaRequest.SDLFormat">GetDatabaseSDLSchemaRequest.SDLFormat</h3><p>SDLFormat specifies the output format for SDL schema.</p><table class="enum-table">@@ -17937,29 +18000,29 @@ The API will default to the BASIC view.</p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>SDL_FORMAT_UNSPECIFIED</td><td>0</td><td><p>Unspecified format. Defaults to SINGLE_FILE.</p></td></tr>-+<tr><td>SINGLE_FILE</td><td>1</td><td><p>Single file format: returns the complete SDL schema as a single file.</p></td></tr>-+<tr><td>MULTI_FILE</td><td>2</td><td><p>Multi-file format: returns the SDL schema as a ZIP archive containingmultiple files organized by schema objects (tables, views, functions, etc.).</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.GetSchemaStringRequest.ObjectType">GetSchemaStringRequest.ObjectType</h3><p></p><table class="enum-table">@@ -17967,64 +18030,64 @@ multiple files organized by schema objects (tables, views, functions, etc.).</p><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>OBJECT_TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>DATABASE</td><td>1</td><td><p></p></td></tr>-+<tr><td>SCHEMA</td><td>2</td><td><p></p></td></tr>-+<tr><td>TABLE</td><td>3</td><td><p></p></td></tr>-+<tr><td>VIEW</td><td>4</td><td><p></p></td></tr>-+<tr><td>MATERIALIZED_VIEW</td><td>5</td><td><p></p></td></tr>-+<tr><td>FUNCTION</td><td>6</td><td><p></p></td></tr>-+<tr><td>PROCEDURE</td><td>7</td><td><p></p></td></tr>-+<tr><td>SEQUENCE</td><td>8</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.StreamMetadata.Mode">StreamMetadata.Mode</h3><p></p><table class="enum-table">@@ -18032,34 +18095,34 @@ multiple files organized by schema objects (tables, views, functions, etc.).</p><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>MODE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>DEFAULT</td><td>1</td><td><p></p></td></tr>-+<tr><td>APPEND_ONLY</td><td>2</td><td><p></p></td></tr>-+<tr><td>INSERT_ONLY</td><td>3</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.StreamMetadata.Type">StreamMetadata.Type</h3><p></p><table class="enum-table">@@ -18067,22 +18130,22 @@ multiple files organized by schema objects (tables, views, functions, etc.).</p><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>DELTA</td><td>1</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.SyncStatus">SyncStatus</h3><p>SyncStatus is the status of the database sync operation.</p><table class="enum-table">@@ -18090,28 +18153,28 @@ multiple files organized by schema objects (tables, views, functions, etc.).</p><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>SYNC_STATUS_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>OK</td><td>1</td><td><p>The database was synced successfully.</p></td></tr>-+<tr><td>FAILED</td><td>2</td><td><p>The database sync failed.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.TablePartitionMetadata.Type">TablePartitionMetadata.Type</h3><p>Type is the type of a table partition, some database engines may not</p><p>support all types. Only avilable for the following database engines now:</p><p>MySQL: RANGE, RANGE COLUMNS, LIST, LIST COLUMNS, HASH, LINEAR HASH, KEY,</p><p>LINEAR_KEY</p><p>(https://dev.mysql.com/doc/refman/8.0/en/partitioning-types.html) TiDB:</p><p>RANGE, RANGE COLUMNS, LIST, LIST COLUMNS, HASH, KEY PostgreSQL: RANGE,</p><p>LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)</p><table class="enum-table">@@ -18119,64 +18182,64 @@ multiple files organized by schema objects (tables, views, functions, etc.).</p><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>RANGE</td><td>1</td><td><p></p></td></tr>-+<tr><td>RANGE_COLUMNS</td><td>2</td><td><p></p></td></tr>-+<tr><td>LIST</td><td>3</td><td><p></p></td></tr>-+<tr><td>LIST_COLUMNS</td><td>4</td><td><p></p></td></tr>-+<tr><td>HASH</td><td>5</td><td><p></p></td></tr>-+<tr><td>LINEAR_HASH</td><td>6</td><td><p></p></td></tr>-+<tr><td>KEY</td><td>7</td><td><p></p></td></tr>-+<tr><td>LINEAR_KEY</td><td>8</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.TaskMetadata.State">TaskMetadata.State</h3><p></p><table class="enum-table">@@ -18184,32 +18247,32 @@ multiple files organized by schema objects (tables, views, functions, etc.).</p><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>STATE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>STARTED</td><td>1</td><td><p></p></td></tr>-+<tr><td>SUSPENDED</td><td>2</td><td><p></p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DatabaseService">DatabaseService</h3><p>DatabaseService manages databases and their schemas.</p><table class="enum-table">@@ -18217,7 +18280,7 @@ multiple files organized by schema objects (tables, views, functions, etc.).</p><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>GetDatabase</td><td><a href="#bytebase.v1.GetDatabaseRequest">GetDatabaseRequest</a></td>@@ -18225,7 +18288,7 @@ multiple files organized by schema objects (tables, views, functions, etc.).</p><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>@@ -18233,7 +18296,7 @@ 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>@@ -18241,7 +18304,7 @@ Permissions required: bb.databases.get</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>@@ -18249,7 +18312,7 @@ Permissions required: bb.projects.get (for project parent), bb.databases.list (f<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>@@ -18257,7 +18320,7 @@ 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>@@ -18265,7 +18328,7 @@ Permissions required: bb.databases.update</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>@@ -18273,7 +18336,7 @@ 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>@@ -18281,7 +18344,7 @@ Permissions required: bb.databases.sync</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>@@ -18289,7 +18352,7 @@ 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>GetDatabaseSDLSchema</td><td><a href="#bytebase.v1.GetDatabaseSDLSchemaRequest">GetDatabaseSDLSchemaRequest</a></td>@@ -18297,7 +18360,7 @@ Permissions required: bb.databases.getSchema</p></td><td><p>Retrieves database schema in SDL (Schema Definition Language) format.Permissions required: bb.databases.getSchema</p></td></tr>-+<tr><td>DiffSchema</td><td><a href="#bytebase.v1.DiffSchemaRequest">DiffSchemaRequest</a></td>@@ -18305,7 +18368,7 @@ Permissions required: bb.databases.getSchema</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>@@ -18313,7 +18376,7 @@ Permissions required: bb.databases.get</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>@@ -18321,7 +18384,7 @@ Permissions required: bb.changelogs.list</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>@@ -18329,13 +18392,13 @@ Permissions required: bb.changelogs.get</p></td><td><p>Generates schema DDL for a database object.Permissions required: bb.databases.getSchema</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -18347,197 +18410,197 @@ Permissions required: bb.databases.getSchema</p></td></tr></thead><tbody>---+++<tr><td>GetDatabase</td><td>GET</td><td>/v1/{name=instances/*/databases/*}</td><td></td></tr>----++++<tr><td>BatchGetDatabases</td><td>GET</td><td>/v1/{parent=projects/*}/databases:batchGet</td><td></td></tr>-+<tr><td>BatchGetDatabases</td><td>GET</td><td>/v1/{parent=instances/*}/databases:batchGet</td><td></td></tr>----++++<tr><td>ListDatabases</td><td>GET</td><td>/v1/{parent=projects/*}/databases</td><td></td></tr>-+<tr><td>ListDatabases</td><td>GET</td><td>/v1/{parent=instances/*}/databases</td><td></td></tr>-+<tr><td>ListDatabases</td><td>GET</td><td>/v1/{parent=workspaces/*}/databases</td><td></td></tr>----++++<tr><td>UpdateDatabase</td><td>PATCH</td><td>/v1/{database.name=instances/*/databases/*}</td><td>database</td></tr>----++++<tr><td>BatchUpdateDatabases</td><td>POST</td><td>/v1/{parent=instances/*}/databases:batchUpdate</td><td>*</td></tr>----++++<tr><td>SyncDatabase</td><td>POST</td><td>/v1/{name=instances/*/databases/*}:sync</td><td>*</td></tr>----++++<tr><td>BatchSyncDatabases</td><td>POST</td><td>/v1/{parent=instances/*}/databases:batchSync</td><td>*</td></tr>----++++<tr><td>GetDatabaseMetadata</td><td>GET</td><td>/v1/{name=instances/*/databases/*/metadata}</td><td></td></tr>----++++<tr><td>GetDatabaseSchema</td><td>GET</td><td>/v1/{name=instances/*/databases/*/schema}</td><td></td></tr>----++++<tr><td>GetDatabaseSDLSchema</td><td>GET</td><td>/v1/{name=instances/*/databases/*/sdlSchema}</td><td></td></tr>----++++<tr><td>DiffSchema</td><td>POST</td><td>/v1/{name=instances/*/databases/*}:diffSchema</td><td>*</td></tr>-+<tr><td>DiffSchema</td><td>POST</td><td>/v1/{name=instances/*/databases/*/changelogs/*}:diffSchema</td><td>*</td></tr>----++++<tr><td>ListChangelogs</td><td>GET</td><td>/v1/{parent=instances/*/databases/*}/changelogs</td><td></td></tr>----++++<tr><td>GetChangelog</td><td>GET</td><td>/v1/{name=instances/*/databases/*/changelogs/*}</td><td></td></tr>----++++<tr><td>GetSchemaString</td><td>GET</td><td>/v1/{name=instances/*/databases/*/schemaString}</td><td></td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/group_service.proto">v1/group_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.BatchGetGroupsRequest">BatchGetGroupsRequest</h3><p>Request message for batch getting groups.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>names</td><td><a href="#string">string</a></td>@@ -18545,55 +18608,55 @@ Permissions required: bb.databases.getSchema</p></td><td><p>The group names to retrieve.Format: groups/{email} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BatchGetGroupsResponse">BatchGetGroupsResponse</h3><p>Response message for batch getting groups.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>groups</td><td><a href="#bytebase.v1.Group">Group</a></td><td>repeated</td><td><p>The groups from the specified request. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.CreateGroupRequest">CreateGroupRequest</h3><p>Request message for creating a group.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>group</td><td><a href="#bytebase.v1.Group">Group</a></td><td></td><td><p>The group to create. </p></td></tr>-+<tr><td>group_email</td><td><a href="#string">string</a></td>@@ -18601,24 +18664,24 @@ Format: groups/{email} </p></td><td><p>The email to use for the group, which will become the final componentof the group's resource name. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DeleteGroupRequest">DeleteGroupRequest</h3><p>Request message for deleting a group.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -18626,24 +18689,24 @@ of the group's resource name. </p></td><td><p>The name of the group to delete.Format: groups/{email} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetGroupRequest">GetGroupRequest</h3><p>Request message for getting a group.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -18651,24 +18714,24 @@ Format: groups/{email} </p></td><td><p>The name of the group to retrieve.Format: groups/{email} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Group">Group</h3><p>A group of users within the workspace.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -18676,59 +18739,59 @@ Format: groups/{email} </p></td><td><p>The name of the group to retrieve.Format: groups/{group}, the group should be email or uuid. </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>The display title of the group. </p></td></tr>-+<tr><td>description</td><td><a href="#string">string</a></td><td></td><td><p>The description of the group. </p></td></tr>-+<tr><td>members</td><td><a href="#bytebase.v1.GroupMember">GroupMember</a></td><td>repeated</td><td><p>The members of the group. </p></td></tr>-+<tr><td>source</td><td><a href="#string">string</a></td><td></td><td><p>The source system where the group originated (e.g., Entra ID for SCIM sync). </p></td></tr>-+<tr><td>email</td><td><a href="#string">string</a></td><td></td><td><p>The unique email for the group. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GroupMember">GroupMember</h3><p>A member of a group with a role.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>member</td><td><a href="#string">string</a></td>@@ -18737,31 +18800,31 @@ Format: groups/{group}, the group should be email or uuid. </p></td>Format: users/[email protected] </p></td></tr>-+<tr><td>role</td><td><a href="#bytebase.v1.GroupMember.Role">GroupMember.Role</a></td><td></td><td><p>The member's role in the group. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListGroupsRequest">ListGroupsRequest</h3><p>Request message for listing groups.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>page_size</td><td><a href="#int32">int32</a></td>@@ -18771,7 +18834,7 @@ this value.If unspecified, at most 10 groups will be returned.The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td></tr>-+<tr><td>page_token</td><td><a href="#string">string</a></td>@@ -18782,7 +18845,7 @@ Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `ListGroups` must matchthe call that provided the page token. </p></td></tr>-+<tr><td>filter</td><td><a href="#string">string</a></td>@@ -18804,31 +18867,31 @@ project == "projects/sample-project"You can combine filter conditions like:title.contains("dba") || email.contains("dba") </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListGroupsResponse">ListGroupsResponse</h3><p>Response message for listing groups.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>groups</td><td><a href="#bytebase.v1.Group">Group</a></td><td>repeated</td><td><p>The groups from the specified request. </p></td></tr>-+<tr><td>next_page_token</td><td><a href="#string">string</a></td>@@ -18836,24 +18899,24 @@ title.contains("dba") || email.contains("dba") </p></td><td><p>A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdateGroupRequest">UpdateGroupRequest</h3><p>Request message for updating a group.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>group</td><td><a href="#bytebase.v1.Group">Group</a></td>@@ -18863,14 +18926,14 @@ If this field is omitted, there are no subsequent pages. </p></td>The group's `name` field is used to identify the group to update.Format: groups/{email} </p></td></tr>-+<tr><td>update_mask</td><td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td><td></td><td><p>The list of fields to update. </p></td></tr>-+<tr><td>allow_missing</td><td><a href="#bool">bool</a></td>@@ -18878,16 +18941,16 @@ Format: groups/{email} </p></td><td><p>If set to true, and the group is not found, a new group will be created.In this situation, `update_mask` is ignored. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.GroupMember.Role">GroupMember.Role</h3><p>The role of a group member.</p><table class="enum-table">@@ -18895,32 +18958,32 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>ROLE_UNSPECIFIED</td><td>0</td><td><p>Unspecified role.</p></td></tr>-+<tr><td>OWNER</td><td>1</td><td><p>Group owner.</p></td></tr>-+<tr><td>MEMBER</td><td>2</td><td><p>Group member.</p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GroupService">GroupService</h3><p>GroupService manages user groups for organizing users and permissions.</p><table class="enum-table">@@ -18928,7 +18991,7 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>GetGroup</td><td><a href="#bytebase.v1.GetGroupRequest">GetGroupRequest</a></td>@@ -18937,7 +19000,7 @@ In this situation, `update_mask` is ignored. </p></td>Group members or users with bb.groups.get permission can get the group.Permissions required: bb.groups.get OR caller is the group member</p></td></tr>-+<tr><td>BatchGetGroups</td><td><a href="#bytebase.v1.BatchGetGroupsRequest">BatchGetGroupsRequest</a></td>@@ -18946,7 +19009,7 @@ Permissions required: bb.groups.get OR caller is the group member</p></td>Group members or users with bb.groups.get permission can get the group.Permissions required: bb.groups.get OR caller is the group member</p></td></tr>-+<tr><td>ListGroups</td><td><a href="#bytebase.v1.ListGroupsRequest">ListGroupsRequest</a></td>@@ -18954,7 +19017,7 @@ Permissions required: bb.groups.get OR caller is the group member</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>@@ -18962,7 +19025,7 @@ Permissions required: bb.groups.list</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>@@ -18971,7 +19034,7 @@ Permissions required: bb.groups.create</p></td>Permissions required: bb.groups.update OR caller is group ownerWhen allow_missing=true, also requires: bb.groups.create</p></td></tr>-+<tr><td>DeleteGroup</td><td><a href="#bytebase.v1.DeleteGroupRequest">DeleteGroupRequest</a></td>@@ -18979,13 +19042,13 @@ When allow_missing=true, also requires: bb.groups.create</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></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -18997,96 +19060,96 @@ Permissions required: bb.groups.delete OR caller is group owner</p></td></tr></thead><tbody>---+++<tr><td>GetGroup</td><td>GET</td><td>/v1/{name=groups/*}</td><td></td></tr>----++++<tr><td>BatchGetGroups</td><td>GET</td><td>/v1/groups:batchGet</td><td></td></tr>----++++<tr><td>ListGroups</td><td>GET</td><td>/v1/groups</td><td></td></tr>----++++<tr><td>CreateGroup</td><td>POST</td><td>/v1/groups</td><td>group</td></tr>----++++<tr><td>UpdateGroup</td><td>PATCH</td><td>/v1/{group.name=groups/*}</td><td>group</td></tr>----++++<tr><td>DeleteGroup</td><td>DELETE</td><td>/v1/{name=groups/*}</td><td></td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/idp_service.proto">v1/idp_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.CreateIdentityProviderRequest">CreateIdentityProviderRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>identity_provider</td><td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td><td></td><td><p>The identity provider to create. </p></td></tr>-+<tr><td>identity_provider_id</td><td><a href="#string">string</a></td>@@ -19097,31 +19160,31 @@ the identity provider's resource name.This value should be 4-63 characters, and valid charactersare /[a-z][0-9]-/. </p></td></tr>-+<tr><td>validate_only</td><td><a href="#bool">bool</a></td><td></td><td><p>If set to true, the request will be validated without actually creating the identity provider. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DeleteIdentityProviderRequest">DeleteIdentityProviderRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -19129,45 +19192,45 @@ are /[a-z][0-9]-/. </p></td><td><p>The name of the identity provider to delete.Format: idps/{identity_provider} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.FieldMapping">FieldMapping</h3><p>FieldMapping saves the field names from user info API of identity provider.</p><p>As we save all raw json string of user info response data into `principal.idp_user_info`,</p><p>we can extract the relevant data based with `FieldMapping`.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>identifier</td><td><a href="#string">string</a></td><td></td><td><p>Identifier is the field name of the unique identifier in 3rd-party idp user info. Required. </p></td></tr>-+<tr><td>display_name</td><td><a href="#string">string</a></td><td></td><td><p>DisplayName is the field name of display name in 3rd-party idp user info. Optional. </p></td></tr>-+<tr><td>phone</td><td><a href="#string">string</a></td><td></td><td><p>Phone is the field name of primary phone in 3rd-party idp user info. Optional. </p></td></tr>-+<tr><td>groups</td><td><a href="#string">string</a></td>@@ -19175,24 +19238,24 @@ Format: idps/{identity_provider} </p></td><td><p>Groups is the field name of groups in 3rd-party idp user info. Optional.Mainly used for OIDC: https://developer.okta.com/docs/guides/customize-tokens-groups-claim/main/ </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetIdentityProviderRequest">GetIdentityProviderRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -19200,24 +19263,24 @@ Mainly used for OIDC: https://developer.okta.com/docs/guides/customize-tokens-gr<td><p>The name of the identity provider to retrieve.Format: idps/{idp} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.IdentityProvider">IdentityProvider</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -19225,90 +19288,90 @@ Format: idps/{idp} </p></td><td><p>The name of the identity provider.Format: idps/{idp} </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>The display title of the identity provider. </p></td></tr>-+<tr><td>domain</td><td><a href="#string">string</a></td><td></td><td><p>The domain for email matching when using this identity provider. </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.v1.IdentityProviderType">IdentityProviderType</a></td><td></td><td><p>The type of identity provider protocol. </p></td></tr>-+<tr><td>config</td><td><a href="#bytebase.v1.IdentityProviderConfig">IdentityProviderConfig</a></td><td></td><td><p>The configuration details for the identity provider. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.IdentityProviderConfig">IdentityProviderConfig</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>oauth2_config</td><td><a href="#bytebase.v1.OAuth2IdentityProviderConfig">OAuth2IdentityProviderConfig</a></td><td></td><td><p>OAuth2 protocol configuration. </p></td></tr>-+<tr><td>oidc_config</td><td><a href="#bytebase.v1.OIDCIdentityProviderConfig">OIDCIdentityProviderConfig</a></td><td></td><td><p>OIDC protocol configuration. </p></td></tr>-+<tr><td>ldap_config</td><td><a href="#bytebase.v1.LDAPIdentityProviderConfig">LDAPIdentityProviderConfig</a></td><td></td><td><p>LDAP protocol configuration. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.LDAPIdentityProviderConfig">LDAPIdentityProviderConfig</h3><p>LDAPIdentityProviderConfig is the structure for LDAP identity provider config.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>host</td><td><a href="#string">string</a></td>@@ -19316,7 +19379,7 @@ Format: idps/{idp} </p></td><td><p>Host is the hostname or IP address of the LDAP server, e.g.,"ldap.example.com". </p></td></tr>-+<tr><td>port</td><td><a href="#int32">int32</a></td>@@ -19325,14 +19388,14 @@ Format: idps/{idp} </p></td>default port of the corresponding security protocol will be used, i.e. 389for StartTLS and 636 for LDAPS. </p></td></tr>-+<tr><td>skip_tls_verify</td><td><a href="#bool">bool</a></td><td></td><td><p>SkipTLSVerify controls whether to skip TLS certificate verification. </p></td></tr>-+<tr><td>bind_dn</td><td><a href="#string">string</a></td>@@ -19340,28 +19403,28 @@ for StartTLS and 636 for LDAPS. </p></td><td><p>BindDN is the DN of the user to bind as a service account to performsearch requests. </p></td></tr>-+<tr><td>bind_password</td><td><a href="#string">string</a></td><td></td><td><p>BindPassword is the password of the user to bind as a service account. </p></td></tr>-+<tr><td>base_dn</td><td><a href="#string">string</a></td><td></td><td><p>BaseDN is the base DN to search for users, e.g., "ou=users,dc=example,dc=com". </p></td></tr>-+<tr><td>user_filter</td><td><a href="#string">string</a></td><td></td><td><p>UserFilter is the filter to search for users, e.g., "(uid=%s)". </p></td></tr>-+<tr><td>security_protocol</td><td><a href="#bytebase.v1.LDAPIdentityProviderConfig.SecurityProtocol">LDAPIdentityProviderConfig.SecurityProtocol</a></td>@@ -19369,7 +19432,7 @@ search requests. </p></td><td><p>SecurityProtocol is the security protocol to be used for establishingconnections with the LDAP server. </p></td></tr>-+<tr><td>field_mapping</td><td><a href="#bytebase.v1.FieldMapping">FieldMapping</a></td>@@ -19377,24 +19440,24 @@ connections with the LDAP server. </p></td><td><p>FieldMapping is the mapping of the user attributes returned by the LDAPserver. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListIdentityProvidersRequest">ListIdentityProvidersRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -19403,173 +19466,173 @@ server. </p></td>Format: workspaces/{workspace}When unset, the workspace is resolved from the request context. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListIdentityProvidersResponse">ListIdentityProvidersResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>identity_providers</td><td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td><td>repeated</td><td><p>The identity providers from the specified request. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.OAuth2IdentityProviderConfig">OAuth2IdentityProviderConfig</h3><p>OAuth2IdentityProviderConfig is the structure for OAuth2 identity provider config.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>auth_url</td><td><a href="#string">string</a></td><td></td><td><p>The authorization endpoint URL for OAuth2 flow. </p></td></tr>-+<tr><td>token_url</td><td><a href="#string">string</a></td><td></td><td><p>The token endpoint URL for exchanging authorization code. </p></td></tr>-+<tr><td>user_info_url</td><td><a href="#string">string</a></td><td></td><td><p>The user information endpoint URL. </p></td></tr>-+<tr><td>client_id</td><td><a href="#string">string</a></td><td></td><td><p>The OAuth2 client identifier. </p></td></tr>-+<tr><td>client_secret</td><td><a href="#string">string</a></td><td></td><td><p>The OAuth2 client secret for authentication. </p></td></tr>-+<tr><td>scopes</td><td><a href="#string">string</a></td><td>repeated</td><td><p>The list of OAuth2 scopes to request. </p></td></tr>-+<tr><td>field_mapping</td><td><a href="#bytebase.v1.FieldMapping">FieldMapping</a></td><td></td><td><p>Mapping configuration for user attributes from OAuth2 response. </p></td></tr>-+<tr><td>skip_tls_verify</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether to skip TLS certificate verification. </p></td></tr>-+<tr><td>auth_style</td><td><a href="#bytebase.v1.OAuth2AuthStyle">OAuth2AuthStyle</a></td><td></td><td><p>The authentication style for client credentials. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.OAuth2IdentityProviderTestRequestContext">OAuth2IdentityProviderTestRequestContext</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>code</td><td><a href="#string">string</a></td><td></td><td><p>Authorize code from website. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.OIDCIdentityProviderConfig">OIDCIdentityProviderConfig</h3><p>OIDCIdentityProviderConfig is the structure for OIDC identity provider config.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>issuer</td><td><a href="#string">string</a></td><td></td><td><p>The OIDC issuer URL for the identity provider. </p></td></tr>-+<tr><td>client_id</td><td><a href="#string">string</a></td><td></td><td><p>The OIDC client identifier. </p></td></tr>-+<tr><td>client_secret</td><td><a href="#string">string</a></td><td></td><td><p>The OIDC client secret for authentication. </p></td></tr>-+<tr><td>scopes</td><td><a href="#string">string</a></td>@@ -19577,28 +19640,28 @@ When unset, the workspace is resolved from the request context. </p></td><td><p>The scopes that the OIDC provider supports.Should be fetched from the well-known configuration file of the OIDC provider. </p></td></tr>-+<tr><td>field_mapping</td><td><a href="#bytebase.v1.FieldMapping">FieldMapping</a></td><td></td><td><p>Mapping configuration for user attributes from OIDC claims. </p></td></tr>-+<tr><td>skip_tls_verify</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether to skip TLS certificate verification. </p></td></tr>-+<tr><td>auth_style</td><td><a href="#bytebase.v1.OAuth2AuthStyle">OAuth2AuthStyle</a></td><td></td><td><p>The authentication style for client credentials. </p></td></tr>-+<tr><td>auth_endpoint</td><td><a href="#string">string</a></td>@@ -19606,179 +19669,179 @@ Should be fetched from the well-known configuration file of the OIDC provider. <<td><p>The authorization endpoint of the OIDC provider.Should be fetched from the well-known configuration file of the OIDC provider. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.OIDCIdentityProviderTestRequestContext">OIDCIdentityProviderTestRequestContext</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>code</td><td><a href="#string">string</a></td><td></td><td><p>Authorize code from OIDC provider. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TestIdentityProviderRequest">TestIdentityProviderRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>identity_provider</td><td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td><td></td><td><p>The identity provider to test connection including uncreated. </p></td></tr>-+<tr><td>oauth2_context</td><td><a href="#bytebase.v1.OAuth2IdentityProviderTestRequestContext">OAuth2IdentityProviderTestRequestContext</a></td><td></td><td><p> </p></td></tr>-+<tr><td>oidc_context</td><td><a href="#bytebase.v1.OIDCIdentityProviderTestRequestContext">OIDCIdentityProviderTestRequestContext</a></td><td></td><td><p>OIDC authentication context for test connection. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TestIdentityProviderResponse">TestIdentityProviderResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>claims</td><td><a href="#bytebase.v1.TestIdentityProviderResponse.ClaimsEntry">TestIdentityProviderResponse.ClaimsEntry</a></td><td>repeated</td><td><p>The map of claims returned by the identity provider. </p></td></tr>-+<tr><td>user_info</td><td><a href="#bytebase.v1.TestIdentityProviderResponse.UserInfoEntry">TestIdentityProviderResponse.UserInfoEntry</a></td><td>repeated</td><td><p>The matched user info from the claims. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TestIdentityProviderResponse.ClaimsEntry">TestIdentityProviderResponse.ClaimsEntry</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TestIdentityProviderResponse.UserInfoEntry">TestIdentityProviderResponse.UserInfoEntry</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdateIdentityProviderRequest">UpdateIdentityProviderRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>identity_provider</td><td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>@@ -19788,14 +19851,14 @@ Should be fetched from the well-known configuration file of the OIDC provider. <The identity provider's `name` field is used to identify the identity provider to update.Format: idps/{identity_provider} </p></td></tr>-+<tr><td>update_mask</td><td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td><td></td><td><p>The list of fields to update. </p></td></tr>-+<tr><td>allow_missing</td><td><a href="#bool">bool</a></td>@@ -19803,16 +19866,16 @@ Format: idps/{identity_provider} </p></td><td><p>If set to true, and the identity provider is not found, a new identity provider will be created.In this situation, `update_mask` is ignored. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.IdentityProviderType">IdentityProviderType</h3><p></p><table class="enum-table">@@ -19820,34 +19883,34 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>IDENTITY_PROVIDER_TYPE_UNSPECIFIED</td><td>0</td><td><p>Unspecified identity provider type.</p></td></tr>-+<tr><td>OAUTH2</td><td>1</td><td><p>OAuth 2.0 authentication protocol.</p></td></tr>-+<tr><td>OIDC</td><td>2</td><td><p>OpenID Connect authentication protocol.</p></td></tr>-+<tr><td>LDAP</td><td>3</td><td><p>LDAP directory service authentication.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.LDAPIdentityProviderConfig.SecurityProtocol">LDAPIdentityProviderConfig.SecurityProtocol</h3><p></p><table class="enum-table">@@ -19855,28 +19918,28 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>SECURITY_PROTOCOL_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>START_TLS</td><td>1</td><td><p>StartTLS is the security protocol that starts with an unencrypted connection and then upgrades to TLS.</p></td></tr>-+<tr><td>LDAPS</td><td>2</td><td><p>LDAPS is the security protocol that uses TLS from the beginning.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.OAuth2AuthStyle">OAuth2AuthStyle</h3><p></p><table class="enum-table">@@ -19884,34 +19947,34 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>OAUTH2_AUTH_STYLE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>IN_PARAMS</td><td>1</td><td><p>IN_PARAMS sends the "client_id" and "client_secret" in the POST bodyas application/x-www-form-urlencoded parameters.</p></td></tr>-+<tr><td>IN_HEADER</td><td>2</td><td><p>IN_HEADER sends the client_id and client_password using HTTP Basic Authorization.This is an optional style described in the OAuth2 RFC 6749 section 2.3.1.</p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.IdentityProviderService">IdentityProviderService</h3><p>IdentityProviderService manages external identity providers for SSO authentication.</p><table class="enum-table">@@ -19919,7 +19982,7 @@ This is an optional style described in the OAuth2 RFC 6749 section 2.3.1.</p></t<tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>GetIdentityProvider</td><td><a href="#bytebase.v1.GetIdentityProviderRequest">GetIdentityProviderRequest</a></td>@@ -19927,7 +19990,7 @@ This is an optional style described in the OAuth2 RFC 6749 section 2.3.1.</p></t<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>@@ -19935,7 +19998,7 @@ Permissions required: bb.identityProviders.get</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>@@ -19943,7 +20006,7 @@ Permissions required: None</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>@@ -19952,7 +20015,7 @@ Permissions required: bb.identityProviders.create</p></td>Permissions required: bb.identityProviders.updateWhen allow_missing=true, also requires: bb.identityProviders.create</p></td></tr>-+<tr><td>DeleteIdentityProvider</td><td><a href="#bytebase.v1.DeleteIdentityProviderRequest">DeleteIdentityProviderRequest</a></td>@@ -19960,7 +20023,7 @@ When allow_missing=true, also requires: bb.identityProviders.create</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>@@ -19968,13 +20031,13 @@ Permissions required: bb.identityProviders.delete</p></td><td><p>Tests the connection and configuration of an identity provider.Permissions required: bb.identityProviders.update</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -19986,96 +20049,96 @@ Permissions required: bb.identityProviders.update</p></td></tr></thead><tbody>---+++<tr><td>GetIdentityProvider</td><td>GET</td><td>/v1/{name=idps/*}</td><td></td></tr>----++++<tr><td>ListIdentityProviders</td><td>GET</td><td>/v1/idps</td><td></td></tr>-+<tr><td>ListIdentityProviders</td><td>GET</td><td>/v1/{parent=workspaces/*}/idps</td><td></td></tr>----++++<tr><td>CreateIdentityProvider</td><td>POST</td><td>/v1/idps</td><td>identity_provider</td></tr>----++++<tr><td>UpdateIdentityProvider</td><td>PATCH</td><td>/v1/{identity_provider.name=idps/*}</td><td>identity_provider</td></tr>----++++<tr><td>DeleteIdentityProvider</td><td>DELETE</td><td>/v1/{name=idps/*}</td><td></td></tr>----++++<tr><td>TestIdentityProvider</td><td>POST</td><td>/v1/idps/*:test</td><td>*</td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/org_policy_service.proto">v1/org_policy_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.CreatePolicyRequest">CreatePolicyRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -20086,38 +20149,38 @@ Environment resource name: environments/environment-id.Instance resource name: instances/instance-id.Database resource name: instances/instance-id/databases/database-name. </p></td></tr>-+<tr><td>policy</td><td><a href="#bytebase.v1.Policy">Policy</a></td><td></td><td><p>The policy to create. </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.v1.PolicyType">PolicyType</a></td><td></td><td><p>The type of policy to create. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DeletePolicyRequest">DeletePolicyRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -20129,24 +20192,24 @@ Environment resource name: environments/environment-id.Instance resource name: instances/instance-id.Database resource name: instances/instance-id/databases/database-name. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetPolicyRequest">GetPolicyRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -20154,24 +20217,24 @@ Database resource name: instances/instance-id/databases/database-name. </p></td><td><p>The name of the policy to retrieve.Format: {resource type}/{resource id}/policies/{policy type} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListPoliciesRequest">ListPoliciesRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -20179,86 +20242,86 @@ Format: {resource type}/{resource id}/policies/{policy type} </p></td><td><p>The parent, which owns this collection of policies.Format: {resource type}/{resource id} </p></td></tr>-+<tr><td>policy_type</td><td><a href="#bytebase.v1.PolicyType">PolicyType</a></td><td>optional</td><td><p>Filter by specific policy type. </p></td></tr>-+<tr><td>show_deleted</td><td><a href="#bool">bool</a></td><td></td><td><p>Show deleted policies if specified. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListPoliciesResponse">ListPoliciesResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>policies</td><td><a href="#bytebase.v1.Policy">Policy</a></td><td>repeated</td><td><p>The policies from the specified request. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.MaskingExemptionPolicy">MaskingExemptionPolicy</h3><p>MaskingExemptionPolicy is the allowlist of users who can access sensitive data.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>exemptions</td><td><a href="#bytebase.v1.MaskingExemptionPolicy.Exemption">MaskingExemptionPolicy.Exemption</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.MaskingExemptionPolicy.Exemption">MaskingExemptionPolicy.Exemption</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>members</td><td><a href="#string">string</a></td>@@ -20269,7 +20332,7 @@ For groups, the member should be: group:{email}For service accounts, the member should be: serviceAccount:{email}For workload identities, the member should be: workloadIdentity:{email} </p></td></tr>-+<tr><td>condition</td><td><a href="#google.type.Expr">google.type.Expr</a></td>@@ -20291,55 +20354,55 @@ For example:resource.instance_id == "local" && resource.database_name == "employee" && request.time < timestamp("2025-04-30T11:10:39.000Z")resource.instance_id == "local" && resource.database_name == "employee" </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.MaskingRulePolicy">MaskingRulePolicy</h3><p>Policy for configuring data masking rules.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>rules</td><td><a href="#bytebase.v1.MaskingRulePolicy.MaskingRule">MaskingRulePolicy.MaskingRule</a></td><td>repeated</td><td><p>The list of masking rules. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.MaskingRulePolicy.MaskingRule">MaskingRulePolicy.MaskingRule</h3><p>A rule that defines when and how to mask data.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>id</td><td><a href="#string">string</a></td><td></td><td><p>A unique identifier for the rule in UUID format. </p></td></tr>-+<tr><td>condition</td><td><a href="#google.type.Expr">google.type.Expr</a></td>@@ -20369,31 +20432,31 @@ resource.instance_id == "sample-instance" && resource.database_nresource.environment_id != "test" || !(resource.project_id in ["poject1", "prject2"])resource.instance_id == "sample-instance" && (resource.database_name == "db1" || resource.database_name == "db2") </p></td></tr>-+<tr><td>semantic_type</td><td><a href="#string">string</a></td><td></td><td><p>The semantic type of data to mask (e.g., "SSN", "EMAIL"). </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Policy">Policy</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -20405,87 +20468,87 @@ Environment resource name: environments/environment-id.Instance resource name: instances/instance-id.Database resource name: instances/instance-id/databases/database-name. </p></td></tr>-+<tr><td>inherit_from_parent</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether this policy inherits from its parent resource. </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.v1.PolicyType">PolicyType</a></td><td></td><td><p>The type of policy. </p></td></tr>-+<tr><td>rollout_policy</td><td><a href="#bytebase.v1.RolloutPolicy">RolloutPolicy</a></td><td></td><td><p> </p></td></tr>-+<tr><td>masking_rule_policy</td><td><a href="#bytebase.v1.MaskingRulePolicy">MaskingRulePolicy</a></td><td></td><td><p> </p></td></tr>-+<tr><td>masking_exemption_policy</td><td><a href="#bytebase.v1.MaskingExemptionPolicy">MaskingExemptionPolicy</a></td><td></td><td><p> </p></td></tr>-+<tr><td>tag_policy</td><td><a href="#bytebase.v1.TagPolicy">TagPolicy</a></td><td></td><td><p> </p></td></tr>-+<tr><td>query_data_policy</td><td><a href="#bytebase.v1.QueryDataPolicy">QueryDataPolicy</a></td><td></td><td><p> </p></td></tr>-+<tr><td>enforce</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether the policy is enforced. </p></td></tr>-+<tr><td>resource_type</td><td><a href="#bytebase.v1.PolicyResourceType">PolicyResourceType</a></td><td></td><td><p>The resource type for the policy. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.QueryDataPolicy">QueryDataPolicy</h3><p>QueryDataPolicy is the policy configuration for querying data in the SQL Editor.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>maximum_result_rows</td><td><a href="#int32">int32</a></td>@@ -20494,7 +20557,7 @@ Database resource name: instances/instance-id/databases/database-name. </p></td>The maximum number of rows to return in the SQL editor.The default value <= 0, means no limit. </p></td></tr>-+<tr><td>disable_export</td><td><a href="#bool">bool</a></td>@@ -20502,7 +20565,7 @@ The default value <= 0, means no limit. </p></td><td><p>workspace-level policyDisable data export in the SQL editor. </p></td></tr>-+<tr><td>disable_copy_data</td><td><a href="#bool">bool</a></td>@@ -20510,7 +20573,7 @@ Disable data export in the SQL editor. </p></td><td><p>workspace-level policyDisable copying query results in the SQL editor. </p></td></tr>-+<tr><td>allow_admin_data_source</td><td><a href="#bool">bool</a></td>@@ -20522,55 +20585,55 @@ If false,1. when read-only data source is configured, users're force to use the read-only data source2. otherwise fallback to use the admin data source. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.RolloutPolicy">RolloutPolicy</h3><p>Rollout policy configuration.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>automatic</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether rollout is automatic without manual approval. </p></td></tr>-+<tr><td>roles</td><td><a href="#string">string</a></td><td>repeated</td><td><p>The roles that can approve rollout execution. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TagPolicy">TagPolicy</h3><p>Policy for tagging resources with metadata.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>tags</td><td><a href="#bytebase.v1.TagPolicy.TagsEntry">TagPolicy.TagsEntry</a></td>@@ -20578,55 +20641,55 @@ If false,<td><p>tags is the key - value map for resources.for example, the environment resource can have the sql review config tag, like "bb.tag.review_config": "reviewConfigs/{review config resource id}" </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TagPolicy.TagsEntry">TagPolicy.TagsEntry</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdatePolicyRequest">UpdatePolicyRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>policy</td><td><a href="#bytebase.v1.Policy">Policy</a></td>@@ -20640,14 +20703,14 @@ Environment resource name: environments/environment-id.Instance resource name: instances/instance-id.Database resource name: instances/instance-id/databases/database-name. </p></td></tr>-+<tr><td>update_mask</td><td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td><td></td><td><p>The list of fields to update. </p></td></tr>-+<tr><td>allow_missing</td><td><a href="#bool">bool</a></td>@@ -20655,16 +20718,16 @@ Database resource name: instances/instance-id/databases/database-name. </p></td><td><p>If set to true, and the policy is not found, a new policy will be created.In this situation, `update_mask` is ignored. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.PolicyResourceType">PolicyResourceType</h3><p>The resource type that a policy can be attached to.</p><table class="enum-table">@@ -20672,34 +20735,34 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>RESOURCE_TYPE_UNSPECIFIED</td><td>0</td><td><p>Unspecified resource type.</p></td></tr>-+<tr><td>WORKSPACE</td><td>1</td><td><p>Workspace-level policy.</p></td></tr>-+<tr><td>ENVIRONMENT</td><td>2</td><td><p>Environment-level policy.</p></td></tr>-+<tr><td>PROJECT</td><td>3</td><td><p>Project-level policy.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.PolicyType">PolicyType</h3><p>The type of organizational policy.</p><table class="enum-table">@@ -20707,50 +20770,50 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>POLICY_TYPE_UNSPECIFIED</td><td>0</td><td><p>Unspecified policy type.</p></td></tr>-+<tr><td>MASKING_RULE</td><td>1</td><td><p>Data masking rule policy.</p></td></tr>-+<tr><td>MASKING_EXEMPTION</td><td>2</td><td><p>Data masking exemption policy.</p></td></tr>-+<tr><td>ROLLOUT_POLICY</td><td>3</td><td><p>Rollout deployment policy.</p></td></tr>-+<tr><td>TAG</td><td>4</td><td><p>Resource tag policy.</p></td></tr>-+<tr><td>DATA_QUERY</td><td>6</td><td><p>Query data access policy.</p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.OrgPolicyService">OrgPolicyService</h3><p>OrgPolicyService manages organizational policies at various resource levels.</p><table class="enum-table">@@ -20758,7 +20821,7 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>GetPolicy</td><td><a href="#bytebase.v1.GetPolicyRequest">GetPolicyRequest</a></td>@@ -20766,7 +20829,7 @@ In this situation, `update_mask` is ignored. </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>@@ -20774,7 +20837,7 @@ Permissions required: bb.policies.get</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>@@ -20782,7 +20845,7 @@ Permissions required: bb.policies.list</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>@@ -20790,7 +20853,7 @@ Permissions required: bb.policies.create</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>@@ -20798,13 +20861,13 @@ Permissions required: bb.policies.update</p></td><td><p>Deletes an organizational policy.Permissions required: bb.policies.delete</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -20816,219 +20879,219 @@ Permissions required: bb.policies.delete</p></td></tr></thead><tbody>---+++<tr><td>GetPolicy</td><td>GET</td><td>/v1/{name=workspaces/*/policies/*}</td><td></td></tr>-+<tr><td>GetPolicy</td><td>GET</td><td>/v1/{name=projects/*/policies/*}</td><td></td></tr>-+<tr><td>GetPolicy</td><td>GET</td><td>/v1/{name=environments/*/policies/*}</td><td></td></tr>-+<tr><td>GetPolicy</td><td>GET</td><td>/v1/{name=instances/*/policies/*}</td><td></td></tr>-+<tr><td>GetPolicy</td><td>GET</td><td>/v1/{name=instances/*/databases/*/policies/*}</td><td></td></tr>----++++<tr><td>ListPolicies</td><td>GET</td><td>/v1/{parent=workspaces/*}/policies</td><td></td></tr>-+<tr><td>ListPolicies</td><td>GET</td><td>/v1/{parent=projects/*}/policies</td><td></td></tr>-+<tr><td>ListPolicies</td><td>GET</td><td>/v1/{parent=environments/*}/policies</td><td></td></tr>-+<tr><td>ListPolicies</td><td>GET</td><td>/v1/{parent=instances/*}/policies</td><td></td></tr>-+<tr><td>ListPolicies</td><td>GET</td><td>/v1/{parent=instances/*/databases/*}/policies</td><td></td></tr>----++++<tr><td>CreatePolicy</td><td>POST</td><td>/v1/{parent=workspaces/*}/policies</td><td>policy</td></tr>-+<tr><td>CreatePolicy</td><td>POST</td><td>/v1/{parent=projects/*}/policies</td><td>policy</td></tr>-+<tr><td>CreatePolicy</td><td>POST</td><td>/v1/{parent=environments/*}/policies</td><td>policy</td></tr>-+<tr><td>CreatePolicy</td><td>POST</td><td>/v1/{parent=instances/*}/policies</td><td>policy</td></tr>-+<tr><td>CreatePolicy</td><td>POST</td><td>/v1/{parent=instances/*/databases/*}/policies</td><td>policy</td></tr>----++++<tr><td>UpdatePolicy</td><td>PATCH</td><td>/v1/{policy.name=workspaces/*/policies/*}</td><td>policy</td></tr>-+<tr><td>UpdatePolicy</td><td>PATCH</td><td>/v1/{policy.name=projects/*/policies/*}</td><td>policy</td></tr>-+<tr><td>UpdatePolicy</td><td>PATCH</td><td>/v1/{policy.name=environments/*/policies/*}</td><td>policy</td></tr>-+<tr><td>UpdatePolicy</td><td>PATCH</td><td>/v1/{policy.name=instances/*/policies/*}</td><td>policy</td></tr>-+<tr><td>UpdatePolicy</td><td>PATCH</td><td>/v1/{policy.name=instances/*/databases/*/policies/*}</td><td>policy</td></tr>----++++<tr><td>DeletePolicy</td><td>DELETE</td><td>/v1/{name=workspaces/*/policies/*}</td><td></td></tr>-+<tr><td>DeletePolicy</td><td>DELETE</td><td>/v1/{name=projects/*/policies/*}</td><td></td></tr>-+<tr><td>DeletePolicy</td><td>DELETE</td><td>/v1/{name=environments/*/policies/*}</td><td></td></tr>-+<tr><td>DeletePolicy</td><td>DELETE</td><td>/v1/{name=instances/*/policies/*}</td><td></td></tr>-+<tr><td>DeletePolicy</td><td>DELETE</td><td>/v1/{name=instances/*/databases/*/policies/*}</td><td></td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/rollout_service.proto">v1/rollout_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.BatchCancelTaskRunsRequest">BatchCancelTaskRunsRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -21037,7 +21100,7 @@ Permissions required: bb.policies.delete</p></td>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}Use `projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/-` to cancel task runs under the same stage. </p></td></tr>-+<tr><td>task_runs</td><td><a href="#string">string</a></td>@@ -21045,31 +21108,31 @@ Use `projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/-` to cancel t<td><p>The taskRuns to cancel.Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BatchCancelTaskRunsResponse">BatchCancelTaskRunsResponse</h3><p></p>---+++<h3 id="bytebase.v1.BatchRunTasksRequest">BatchRunTasksRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -21077,7 +21140,7 @@ Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/task<td><p>The stage name for the tasks.Format: projects/{project}/plans/{plan}/rollout/stages/{stage} </p></td></tr>-+<tr><td>tasks</td><td><a href="#string">string</a></td>@@ -21085,45 +21148,45 @@ Format: projects/{project}/plans/{plan}/rollout/stages/{stage} </p></td><td><p>The tasks to run.Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} </p></td></tr>-+<tr><td>run_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td>optional</td><td><p>The task run should run after run_time. </p></td></tr>-+<tr><td>skip_prior_backup</td><td><a href="#bool">bool</a></td><td></td><td><p>If true, skip prior backup for this run even if the task has prior backup enabled. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BatchRunTasksResponse">BatchRunTasksResponse</h3><p></p>---+++<h3 id="bytebase.v1.BatchSkipTasksRequest">BatchSkipTasksRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -21131,7 +21194,7 @@ Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} </p><td><p>The stage name for the tasks.Format: projects/{project}/plans/{plan}/rollout/stages/{stage} </p></td></tr>-+<tr><td>tasks</td><td><a href="#string">string</a></td>@@ -21139,38 +21202,38 @@ Format: projects/{project}/plans/{plan}/rollout/stages/{stage} </p></td><td><p>The tasks to skip.Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} </p></td></tr>-+<tr><td>reason</td><td><a href="#string">string</a></td><td></td><td><p>The reason for skipping the tasks. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BatchSkipTasksResponse">BatchSkipTasksResponse</h3><p></p>---+++<h3 id="bytebase.v1.CreateRolloutRequest">CreateRolloutRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -21178,7 +21241,7 @@ Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} </p><td><p>The parent plan for which this rollout will be created.Format: projects/{project}/plans/{plan} </p></td></tr>-+<tr><td>target</td><td><a href="#string">string</a></td>@@ -21188,24 +21251,24 @@ Format: environments/{environment}If unspecified, all stages are created.If set to "", no stages are created. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetRolloutRequest">GetRolloutRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -21214,96 +21277,96 @@ If set to "", no stages are created. </p></td>This is the rollout resource name, which is the plan name plus /rollout suffix.Format: projects/{project}/plans/{plan}/rollout </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetTaskRunLogRequest">GetTaskRunLogRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td><td></td><td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetTaskRunRequest">GetTaskRunRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetTaskRunSessionRequest">GetTaskRunSessionRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td><td></td><td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListRolloutsRequest">ListRolloutsRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -21312,7 +21375,7 @@ Format: projects/{project}/plans/{plan}/rollout </p></td>Format: projects/{project}Use "projects/-" to list all rollouts from all projects. </p></td></tr>-+<tr><td>page_size</td><td><a href="#int32">int32</a></td>@@ -21322,7 +21385,7 @@ this value.If unspecified, at most 10 rollouts will be returned.The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td></tr>-+<tr><td>page_token</td><td><a href="#string">string</a></td>@@ -21333,7 +21396,7 @@ Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `ListRollouts` must matchthe call that provided the page token. </p></td></tr>-+<tr><td>filter</td><td><a href="#string">string</a></td>@@ -21349,31 +21412,31 @@ For example:update_time >= "2025-01-02T15:04:05Z07:00"task_type in ["DATABASE_MIGRATE", "DATABASE_EXPORT"] </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListRolloutsResponse">ListRolloutsResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>rollouts</td><td><a href="#bytebase.v1.Rollout">Rollout</a></td><td>repeated</td><td><p>The rollouts from the specified request. </p></td></tr>-+<tr><td>next_page_token</td><td><a href="#string">string</a></td>@@ -21381,24 +21444,24 @@ task_type in ["DATABASE_MIGRATE", "DATABASE_EXPORT"] </p></td><td><p>A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListTaskRunsRequest">ListTaskRunsRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -21407,96 +21470,96 @@ If this field is omitted, there are no subsequent pages. </p></td>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}Use "projects/{project}/plans/{plan}/rollout/stages/-/tasks/-" to list all taskRuns from a rollout. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListTaskRunsResponse">ListTaskRunsResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>task_runs</td><td><a href="#bytebase.v1.TaskRun">TaskRun</a></td><td>repeated</td><td><p>The taskRuns from the specified request. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.PreviewTaskRunRollbackRequest">PreviewTaskRunRollbackRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.PreviewTaskRunRollbackResponse">PreviewTaskRunRollbackResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>statement</td><td><a href="#string">string</a></td><td></td><td><p>The rollback SQL statement that would undo the task run. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Rollout">Rollout</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -21504,7 +21567,7 @@ Use "projects/{project}/plans/{plan}/rollout/stages/-/tasks/-" to list a<td><p>The resource name of the rollout.Format: projects/{project}/plans/{plan}/rollout </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td>@@ -21512,45 +21575,45 @@ Format: projects/{project}/plans/{plan}/rollout </p></td><td><p>The title of the rollout, inherited from the associated plan.This field is output only and cannot be directly set. </p></td></tr>-+<tr><td>stages</td><td><a href="#bytebase.v1.Stage">Stage</a></td><td>repeated</td><td><p>Stages and thus tasks of the rollout. </p></td></tr>-+<tr><td>create_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>update_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Stage">Stage</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -21558,7 +21621,7 @@ This field is output only and cannot be directly set. </p></td><td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}Use "-" for {stage} when the stage has no environment or deleted environment. </p></td></tr>-+<tr><td>id</td><td><a href="#string">string</a></td>@@ -21567,7 +21630,7 @@ Use "-" for {stage} when the stage has no environment or deleted environe.g., "prod".Use "-" when the stage has no environment or deleted environment. </p></td></tr>-+<tr><td>environment</td><td><a href="#string">string</a></td>@@ -21575,66 +21638,66 @@ Use "-" when the stage has no environment or deleted environment. </p></<td><p>environment is the environment of the stage.Format: environments/{environment} for valid environments, or "environments/-" for stages without environment or with deleted environments. </p></td></tr>-+<tr><td>tasks</td><td><a href="#bytebase.v1.Task">Task</a></td><td>repeated</td><td><p>The tasks within this stage. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Task">Task</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} </p></td></tr>-+<tr><td>spec_id</td><td><a href="#string">string</a></td><td></td><td><p>A UUID4 string that uniquely identifies the Spec. </p></td></tr>-+<tr><td>status</td><td><a href="#bytebase.v1.Task.Status">Task.Status</a></td><td></td><td><p>Status is the status of the task. </p></td></tr>-+<tr><td>skipped_reason</td><td><a href="#string">string</a></td><td></td><td><p>The reason why the task was skipped. </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.v1.Task.Type">Task.Type</a></td><td></td><td><p> </p></td></tr>-+<tr><td>target</td><td><a href="#string">string</a></td>@@ -21642,28 +21705,28 @@ Format: environments/{environment} for valid environments, or "environments/<td><p>Format: instances/{instance} if the task is DatabaseCreate.Format: instances/{instance}/databases/{database} </p></td></tr>-+<tr><td>database_create</td><td><a href="#bytebase.v1.Task.DatabaseCreate">Task.DatabaseCreate</a></td><td></td><td><p> </p></td></tr>-+<tr><td>database_update</td><td><a href="#bytebase.v1.Task.DatabaseUpdate">Task.DatabaseUpdate</a></td><td></td><td><p> </p></td></tr>-+<tr><td>database_data_export</td><td><a href="#bytebase.v1.Task.DatabaseDataExport">Task.DatabaseDataExport</a></td><td></td><td><p> </p></td></tr>-+<tr><td>update_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>@@ -21671,7 +21734,7 @@ Format: instances/{instance}/databases/{database} </p></td><td><p>The update_time is the update time of latest task run.If there are no task runs, it will be empty. </p></td></tr>-+<tr><td>run_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>@@ -21679,48 +21742,48 @@ If there are no task runs, it will be empty. </p></td><td><p>The run_time is the scheduled run time of latest task run.If there are no task runs or the task run is not scheduled, it will be empty. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Task.DatabaseCreate">Task.DatabaseCreate</h3><p>Payload for creating a new database.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>sheet</td><td><a href="#string">string</a></td><td></td><td><p>Format: projects/{project}/sheets/{sheet} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Task.DatabaseDataExport">Task.DatabaseDataExport</h3><p>Payload for exporting database data.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>sheet</td><td><a href="#string">string</a></td>@@ -21728,90 +21791,90 @@ If there are no task runs or the task run is not scheduled, it will be empty. </<td><p>The resource name of the sheet.Format: projects/{project}/sheets/{sheet} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Task.DatabaseUpdate">Task.DatabaseUpdate</h3><p>Payload for updating a database schema.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>sheet</td><td><a href="#string">string</a></td><td></td><td><p>Format: projects/{project}/sheets/{sheet} </p></td></tr>-+<tr><td>release</td><td><a href="#string">string</a></td><td></td><td><p>Format: projects/{project}/releases/{release} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TaskRun">TaskRun</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td></tr>-+<tr><td>creator</td><td><a href="#string">string</a></td><td></td><td><p>Format: users/[email protected] </p></td></tr>-+<tr><td>create_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>update_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>status</td><td><a href="#bytebase.v1.TaskRun.Status">TaskRun.Status</a></td><td></td><td><p>The current execution status of the task run. </p></td></tr>-+<tr><td>detail</td><td><a href="#string">string</a></td>@@ -21819,21 +21882,21 @@ Format: projects/{project}/sheets/{sheet} </p></td><td><p>Below are the results of a task run.Detailed information about the task run result. </p></td></tr>-+<tr><td>start_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p>The time when the task run started execution. </p></td></tr>-+<tr><td>export_archive_status</td><td><a href="#bytebase.v1.TaskRun.ExportArchiveStatus">TaskRun.ExportArchiveStatus</a></td><td></td><td><p>The export archive status for data export tasks. </p></td></tr>-+<tr><td>has_prior_backup</td><td><a href="#bool">bool</a></td>@@ -21842,14 +21905,14 @@ Detailed information about the task run result. </p></td>When true, rollback SQL can be generated via PreviewTaskRunRollback.Backup details are available in the task run logs. </p></td></tr>-+<tr><td>scheduler_info</td><td><a href="#bytebase.v1.TaskRun.SchedulerInfo">TaskRun.SchedulerInfo</a></td><td></td><td><p>Scheduling information about the task run. </p></td></tr>-+<tr><td>run_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>@@ -21857,211 +21920,211 @@ Backup details are available in the task run logs. </p></td><td><p>The task run should run after run_time.This can only be set when creating the task run calling BatchRunTasks. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TaskRun.SchedulerInfo">TaskRun.SchedulerInfo</h3><p>Information about task run scheduling.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>report_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p>The time when the scheduling info was reported. </p></td></tr>-+<tr><td>waiting_cause</td><td><a href="#bytebase.v1.TaskRun.SchedulerInfo.WaitingCause">TaskRun.SchedulerInfo.WaitingCause</a></td><td></td><td><p>The cause for the task run waiting. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TaskRun.SchedulerInfo.WaitingCause">TaskRun.SchedulerInfo.WaitingCause</h3><p>Information about why a task run is waiting.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parallel_tasks_limit</td><td><a href="#bool">bool</a></td><td></td><td><p>Waiting due to parallel tasks limit. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TaskRunLog">TaskRunLog</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/log </p></td></tr>-+<tr><td>entries</td><td><a href="#bytebase.v1.TaskRunLogEntry">TaskRunLogEntry</a></td><td>repeated</td><td><p>The log entries for this task run. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TaskRunLogEntry">TaskRunLogEntry</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>type</td><td><a href="#bytebase.v1.TaskRunLogEntry.Type">TaskRunLogEntry.Type</a></td><td></td><td><p>The type of this log entry. </p></td></tr>-+<tr><td>log_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p>The time when the log was recorded. </p></td></tr>-+<tr><td>replica_id</td><td><a href="#string">string</a></td><td></td><td><p>The replica ID for this log entry. </p></td></tr>-+<tr><td>schema_dump</td><td><a href="#bytebase.v1.TaskRunLogEntry.SchemaDump">TaskRunLogEntry.SchemaDump</a></td><td></td><td><p>Schema dump details (if type is SCHEMA_DUMP). </p></td></tr>-+<tr><td>command_execute</td><td><a href="#bytebase.v1.TaskRunLogEntry.CommandExecute">TaskRunLogEntry.CommandExecute</a></td><td></td><td><p>Command execution details (if type is COMMAND_EXECUTE). </p></td></tr>-+<tr><td>database_sync</td><td><a href="#bytebase.v1.TaskRunLogEntry.DatabaseSync">TaskRunLogEntry.DatabaseSync</a></td><td></td><td><p>Database sync details (if type is DATABASE_SYNC). </p></td></tr>-+<tr><td>transaction_control</td><td><a href="#bytebase.v1.TaskRunLogEntry.TransactionControl">TaskRunLogEntry.TransactionControl</a></td><td></td><td><p>Transaction control details (if type is TRANSACTION_CONTROL). </p></td></tr>-+<tr><td>prior_backup</td><td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup">TaskRunLogEntry.PriorBackup</a></td><td></td><td><p>Prior backup details (if type is PRIOR_BACKUP). </p></td></tr>-+<tr><td>retry_info</td><td><a href="#bytebase.v1.TaskRunLogEntry.RetryInfo">TaskRunLogEntry.RetryInfo</a></td><td></td><td><p>Retry information details (if type is RETRY_INFO). </p></td></tr>-+<tr><td>compute_diff</td><td><a href="#bytebase.v1.TaskRunLogEntry.ComputeDiff">TaskRunLogEntry.ComputeDiff</a></td><td></td><td><p>Compute diff details (if type is COMPUTE_DIFF). </p></td></tr>-+<tr><td>release_file_execute</td><td><a href="#bytebase.v1.TaskRunLogEntry.ReleaseFileExecute">TaskRunLogEntry.ReleaseFileExecute</a></td><td></td><td><p>Release file execution details (if type is RELEASE_FILE_EXECUTE). </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TaskRunLogEntry.CommandExecute">TaskRunLogEntry.CommandExecute</h3><p>Command execution details.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>log_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p>When the command was logged. </p></td></tr>-+<tr><td>range</td><td><a href="#bytebase.v1.Range">Range</a></td>@@ -22070,59 +22133,59 @@ This can only be set when creating the task run calling BatchRunTasks. </p></td>Uses byte offsets (not character indices) for efficient slicing of sheet content bytes.Example: For "SELECT 你好;" in a UTF-8 sheet, range [0, 13) represents all 13 bytes. </p></td></tr>-+<tr><td>statement</td><td><a href="#string">string</a></td><td></td><td><p>The executed statement. </p></td></tr>-+<tr><td>response</td><td><a href="#bytebase.v1.TaskRunLogEntry.CommandExecute.CommandResponse">TaskRunLogEntry.CommandExecute.CommandResponse</a></td><td></td><td><p>The response from executing the command. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TaskRunLogEntry.CommandExecute.CommandResponse">TaskRunLogEntry.CommandExecute.CommandResponse</h3><p>Command execution response.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>log_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p>When the response was logged. </p></td></tr>-+<tr><td>error</td><td><a href="#string">string</a></td><td></td><td><p>Error message if command execution failed. </p></td></tr>-+<tr><td>affected_rows</td><td><a href="#int64">int64</a></td><td></td><td><p>Total affected rows. </p></td></tr>-+<tr><td>all_affected_rows</td><td><a href="#int64">int64</a></td>@@ -22130,214 +22193,214 @@ Example: For "SELECT 你好;" in a UTF-8 sheet, range [0, 13) represents<td><p>`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. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TaskRunLogEntry.ComputeDiff">TaskRunLogEntry.ComputeDiff</h3><p>Schema diff computation details.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>start_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></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>When diff computation ended. </p></td></tr>-+<tr><td>error</td><td><a href="#string">string</a></td><td></td><td><p>Error message if computation failed. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TaskRunLogEntry.DatabaseSync">TaskRunLogEntry.DatabaseSync</h3><p>Database synchronization details.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>start_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p>When the database sync started. </p></td></tr>-+<tr><td>end_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p>When the database sync ended. </p></td></tr>-+<tr><td>error</td><td><a href="#string">string</a></td><td></td><td><p>Error message if sync failed. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TaskRunLogEntry.PriorBackup">TaskRunLogEntry.PriorBackup</h3><p>Prior backup operation details.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>start_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></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>When the backup ended. </p></td></tr>-+<tr><td>prior_backup_detail</td><td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail">TaskRunLogEntry.PriorBackup.PriorBackupDetail</a></td><td></td><td><p>The backup details. </p></td></tr>-+<tr><td>error</td><td><a href="#string">string</a></td><td></td><td><p>Error message if the backup failed. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail">TaskRunLogEntry.PriorBackup.PriorBackupDetail</h3><p>Prior backup detail for rollback purposes.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>items</td><td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item</a></td><td>repeated</td><td><p>The list of backed up tables. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item</h3><p>A single backup table mapping.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>source_table</td><td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table</a></td><td></td><td><p>The original table information. </p></td></tr>-+<tr><td>target_table</td><td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table</a></td><td></td><td><p>The target backup table information. </p></td></tr>-+<tr><td>start_position</td><td><a href="#bytebase.v1.Position">Position</a></td><td></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>The end position in the SQL statement. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table</h3><p>Table information.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>database</td><td><a href="#string">string</a></td>@@ -22345,352 +22408,352 @@ Example: For "SELECT 你好;" in a UTF-8 sheet, range [0, 13) represents<td><p>The database information.Format: instances/{instance}/databases/{database} </p></td></tr>-+<tr><td>schema</td><td><a href="#string">string</a></td><td></td><td><p>The schema name. </p></td></tr>-+<tr><td>table</td><td><a href="#string">string</a></td><td></td><td><p>The table name. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TaskRunLogEntry.ReleaseFileExecute">TaskRunLogEntry.ReleaseFileExecute</h3><p>Release file execution details.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>version</td><td><a href="#string">string</a></td><td></td><td><p>The version of the file being executed (e.g., "0001"). </p></td></tr>-+<tr><td>file_path</td><td><a href="#string">string</a></td><td></td><td><p>The file path within the release (e.g., "2.2/V0001_create_table.sql"). </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TaskRunLogEntry.RetryInfo">TaskRunLogEntry.RetryInfo</h3><p>Retry information for failed operations.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>error</td><td><a href="#string">string</a></td><td></td><td><p>The error that triggered the retry. </p></td></tr>-+<tr><td>retry_count</td><td><a href="#int32">int32</a></td><td></td><td><p>Current retry attempt number. </p></td></tr>-+<tr><td>maximum_retries</td><td><a href="#int32">int32</a></td><td></td><td><p>Maximum number of retries allowed. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TaskRunLogEntry.SchemaDump">TaskRunLogEntry.SchemaDump</h3><p>Schema dump operation details.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>start_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p>When the schema dump started. </p></td></tr>-+<tr><td>end_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p>When the schema dump ended. </p></td></tr>-+<tr><td>error</td><td><a href="#string">string</a></td><td></td><td><p>Error message if the schema dump failed. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TaskRunLogEntry.TransactionControl">TaskRunLogEntry.TransactionControl</h3><p>Transaction control operation details.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>type</td><td><a href="#bytebase.v1.TaskRunLogEntry.TransactionControl.Type">TaskRunLogEntry.TransactionControl.Type</a></td><td></td><td><p>The type of transaction control. </p></td></tr>-+<tr><td>error</td><td><a href="#string">string</a></td><td></td><td><p>Error message if the operation failed. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TaskRunSession">TaskRunSession</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/session </p></td></tr>-+<tr><td>postgres</td><td><a href="#bytebase.v1.TaskRunSession.Postgres">TaskRunSession.Postgres</a></td><td></td><td><p>PostgreSQL session information. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TaskRunSession.Postgres">TaskRunSession.Postgres</h3><p>PostgreSQL session information.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>session</td><td><a href="#bytebase.v1.TaskRunSession.Postgres.Session">TaskRunSession.Postgres.Session</a></td><td></td><td><p>`session` is the session of the task run executing commands. </p></td></tr>-+<tr><td>blocking_sessions</td><td><a href="#bytebase.v1.TaskRunSession.Postgres.Session">TaskRunSession.Postgres.Session</a></td><td>repeated</td><td><p>`blocking_sessions` block `session`. </p></td></tr>-+<tr><td>blocked_sessions</td><td><a href="#bytebase.v1.TaskRunSession.Postgres.Session">TaskRunSession.Postgres.Session</a></td><td>repeated</td><td><p>`blocked_sessions` are blocked by `session`. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TaskRunSession.Postgres.Session">TaskRunSession.Postgres.Session</h3><p>PostgreSQL session information read from `pg_stat_activity`.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>pid</td><td><a href="#string">string</a></td><td></td><td><p>Process ID of the session. </p></td></tr>-+<tr><td>blocked_by_pids</td><td><a href="#string">string</a></td><td>repeated</td><td><p>PIDs of sessions blocking this session. </p></td></tr>-+<tr><td>query</td><td><a href="#string">string</a></td><td></td><td><p>Current query being executed. </p></td></tr>-+<tr><td>state</td><td><a href="#string">string</a></td><td>optional</td><td><p>Session state (active, idle, etc.). </p></td></tr>-+<tr><td>wait_event_type</td><td><a href="#string">string</a></td><td>optional</td><td><p>Wait event type if session is waiting. </p></td></tr>-+<tr><td>wait_event</td><td><a href="#string">string</a></td><td>optional</td><td><p>Specific wait event if session is waiting. </p></td></tr>-+<tr><td>datname</td><td><a href="#string">string</a></td><td>optional</td><td><p>Database name. </p></td></tr>-+<tr><td>usename</td><td><a href="#string">string</a></td><td>optional</td><td><p>User name. </p></td></tr>-+<tr><td>application_name</td><td><a href="#string">string</a></td><td></td><td><p>Application name. </p></td></tr>-+<tr><td>client_addr</td><td><a href="#string">string</a></td><td>optional</td><td><p>Client IP address. </p></td></tr>-+<tr><td>client_port</td><td><a href="#string">string</a></td><td>optional</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>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>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>When the current query started. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.Task.Status">Task.Status</h3><p></p><table class="enum-table">@@ -22698,58 +22761,58 @@ Format: instances/{instance}/databases/{database} </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>STATUS_UNSPECIFIED</td><td>0</td><td><p>Unspecified status.</p></td></tr>-+<tr><td>NOT_STARTED</td><td>1</td><td><p>Task has not started and is awaiting its turn in the deployment sequence.</p></td></tr>-+<tr><td>PENDING</td><td>2</td><td><p>Task is ready to run and waiting for approval or scheduled time.</p></td></tr>-+<tr><td>RUNNING</td><td>3</td><td><p>Task is currently executing.</p></td></tr>-+<tr><td>DONE</td><td>4</td><td><p>Task completed successfully.</p></td></tr>-+<tr><td>FAILED</td><td>5</td><td><p>Task execution failed with errors.</p></td></tr>-+<tr><td>CANCELED</td><td>6</td><td><p>Task execution was canceled by a user.</p></td></tr>-+<tr><td>SKIPPED</td><td>7</td><td><p>Task was skipped and will not be executed.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.Task.Type">Task.Type</h3><p></p><table class="enum-table">@@ -22757,43 +22820,43 @@ Format: instances/{instance}/databases/{database} </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p>Unspecified task type.</p></td></tr>-+<tr><td>GENERAL</td><td>1</td><td><p>General task for miscellaneous operations.</p></td></tr>-+<tr><td>DATABASE_CREATE</td><td>2</td><td><p>Database creation task that creates a new database.Use payload DatabaseCreate.</p></td></tr>-+<tr><td>DATABASE_MIGRATE</td><td>3</td><td><p>Database migration task that applies versioned schema changes.Use payload DatabaseUpdate.</p></td></tr>-+<tr><td>DATABASE_EXPORT</td><td>4</td><td><p>Database export task that exports query results or table data.Use payload DatabaseDataExport.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.TaskRun.ExportArchiveStatus">TaskRun.ExportArchiveStatus</h3><p></p><table class="enum-table">@@ -22801,28 +22864,28 @@ Use payload DatabaseDataExport.</p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>EXPORT_ARCHIVE_STATUS_UNSPECIFIED</td><td>0</td><td><p>Unspecified export archive status.</p></td></tr>-+<tr><td>READY</td><td>1</td><td><p>Export archive is ready for download.</p></td></tr>-+<tr><td>EXPORTED</td><td>2</td><td><p>Export archive has been downloaded by the user.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.TaskRun.Status">TaskRun.Status</h3><p></p><table class="enum-table">@@ -22830,52 +22893,52 @@ Use payload DatabaseDataExport.</p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>STATUS_UNSPECIFIED</td><td>0</td><td><p>Unspecified status.</p></td></tr>-+<tr><td>PENDING</td><td>1</td><td><p>Task run is queued and waiting to start execution.</p></td></tr>-+<tr><td>RUNNING</td><td>2</td><td><p>Task run is currently executing.</p></td></tr>-+<tr><td>DONE</td><td>3</td><td><p>Task run completed successfully.</p></td></tr>-+<tr><td>FAILED</td><td>4</td><td><p>Task run execution failed with errors.</p></td></tr>-+<tr><td>CANCELED</td><td>5</td><td><p>Task run execution was canceled by a user.</p></td></tr>-+<tr><td>AVAILABLE</td><td>6</td><td><p>Task run is ready for immediate execution.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.TaskRunLogEntry.TransactionControl.Type">TaskRunLogEntry.TransactionControl.Type</h3><p>Transaction control type.</p><table class="enum-table">@@ -22883,34 +22946,34 @@ Use payload DatabaseDataExport.</p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p>Unspecified type.</p></td></tr>-+<tr><td>BEGIN</td><td>1</td><td><p>Begin transaction.</p></td></tr>-+<tr><td>COMMIT</td><td>2</td><td><p>Commit transaction.</p></td></tr>-+<tr><td>ROLLBACK</td><td>3</td><td><p>Rollback transaction.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.TaskRunLogEntry.Type">TaskRunLogEntry.Type</h3><p>The type of log entry.</p><table class="enum-table">@@ -22918,68 +22981,68 @@ Use payload DatabaseDataExport.</p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p>Unspecified type.</p></td></tr>-+<tr><td>SCHEMA_DUMP</td><td>1</td><td><p>Schema dump operation.</p></td></tr>-+<tr><td>COMMAND_EXECUTE</td><td>2</td><td><p>Command execution.</p></td></tr>-+<tr><td>DATABASE_SYNC</td><td>3</td><td><p>Database synchronization.</p></td></tr>-+<tr><td>TRANSACTION_CONTROL</td><td>5</td><td><p>Transaction control (BEGIN, COMMIT, ROLLBACK).</p></td></tr>-+<tr><td>PRIOR_BACKUP</td><td>6</td><td><p>Prior backup operation.</p></td></tr>-+<tr><td>RETRY_INFO</td><td>7</td><td><p>Retry information.</p></td></tr>-+<tr><td>COMPUTE_DIFF</td><td>8</td><td><p>Schema diff computation.</p></td></tr>-+<tr><td>RELEASE_FILE_EXECUTE</td><td>9</td><td><p>Release file execution.</p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.RolloutService">RolloutService</h3><p>RolloutService manages the execution of deployment plans.</p><table class="enum-table">@@ -22987,7 +23050,7 @@ Use payload DatabaseDataExport.</p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>GetRollout</td><td><a href="#bytebase.v1.GetRolloutRequest">GetRolloutRequest</a></td>@@ -22995,7 +23058,7 @@ Use payload DatabaseDataExport.</p></td><td><p>Retrieves a rollout by its plan name.Permissions required: bb.rollouts.get</p></td></tr>-+<tr><td>ListRollouts</td><td><a href="#bytebase.v1.ListRolloutsRequest">ListRolloutsRequest</a></td>@@ -23003,7 +23066,7 @@ Permissions required: bb.rollouts.get</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>@@ -23011,7 +23074,7 @@ Permissions required: bb.rollouts.list</p></td><td><p>Creates a new rollout for a plan.Permissions required: bb.rollouts.create (or issue creator for data export issues)</p></td></tr>-+<tr><td>ListTaskRuns</td><td><a href="#bytebase.v1.ListTaskRunsRequest">ListTaskRunsRequest</a></td>@@ -23019,7 +23082,7 @@ Permissions required: bb.rollouts.create (or issue creator for data export issue<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>@@ -23027,7 +23090,7 @@ 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>@@ -23035,7 +23098,7 @@ 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>@@ -23043,7 +23106,7 @@ 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>@@ -23051,7 +23114,7 @@ Permissions required: bb.taskRuns.list</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>@@ -23059,7 +23122,7 @@ Permissions required: bb.taskRuns.create (or issue creator for data export issue<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>@@ -23067,7 +23130,7 @@ Permissions required: bb.taskRuns.create (or issue creator for data export issue<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>@@ -23075,13 +23138,13 @@ Permissions required: bb.taskRuns.create (or issue creator for data export issue<td><p>Generates rollback SQL for a completed task run.Permissions required: bb.taskRuns.list</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -23093,194 +23156,194 @@ Permissions required: bb.taskRuns.list</p></td></tr></thead><tbody>---+++<tr><td>GetRollout</td><td>GET</td><td>/v1/{name=projects/*/plans/*/rollout}</td><td></td></tr>----++++<tr><td>ListRollouts</td><td>GET</td><td>/v1/{parent=projects/*}/rollouts</td><td></td></tr>----++++<tr><td>CreateRollout</td><td>POST</td><td>/v1/{parent=projects/*/plans/*}/rollout</td><td>*</td></tr>----++++<tr><td>ListTaskRuns</td><td>GET</td><td>/v1/{parent=projects/*/plans/*/rollout/stages/*/tasks/*}/taskRuns</td><td></td></tr>----++++<tr><td>GetTaskRun</td><td>GET</td><td>/v1/{name=projects/*/plans/*/rollout/stages/*/tasks/*/taskRuns/*}</td><td></td></tr>----++++<tr><td>GetTaskRunLog</td><td>GET</td><td>/v1/{parent=projects/*/plans/*/rollout/stages/*/tasks/*/taskRuns/*}/log</td><td></td></tr>----++++<tr><td>GetTaskRunSession</td><td>GET</td><td>/v1/{parent=projects/*/plans/*/rollout/stages/*/tasks/*/taskRuns/*}/session</td><td></td></tr>----++++<tr><td>BatchRunTasks</td><td>POST</td><td>/v1/{parent=projects/*/plans/*/rollout/stages/*}/tasks:batchRun</td><td>*</td></tr>----++++<tr><td>BatchSkipTasks</td><td>POST</td><td>/v1/{parent=projects/*/plans/*/rollout/stages/*}/tasks:batchSkip</td><td>*</td></tr>----++++<tr><td>BatchCancelTaskRuns</td><td>POST</td><td>/v1/{parent=projects/*/plans/*/rollout/stages/*/tasks/*}/taskRuns:batchCancel</td><td>*</td></tr>----++++<tr><td>PreviewTaskRunRollback</td><td>POST</td><td>/v1/{name=projects/*/plans/*/rollout/stages/*/tasks/*/taskRuns/*}:previewRollback</td><td>*</td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/sql_service.proto">v1/sql_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.AICompletionRequest">AICompletionRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>messages</td><td><a href="#bytebase.v1.AICompletionRequest.Message">AICompletionRequest.Message</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AICompletionRequest.Message">AICompletionRequest.Message</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>role</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>content</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AICompletionResponse">AICompletionResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>candidates</td><td><a href="#bytebase.v1.AICompletionResponse.Candidate">AICompletionResponse.Candidate</a></td>@@ -23288,96 +23351,96 @@ Permissions required: bb.taskRuns.list</p></td><td><p>candidates is used for results with multiple choices and candidates. Usedfor OpenAI and Gemini. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AICompletionResponse.Candidate">AICompletionResponse.Candidate</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>content</td><td><a href="#bytebase.v1.AICompletionResponse.Candidate.Content">AICompletionResponse.Candidate.Content</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AICompletionResponse.Candidate.Content">AICompletionResponse.Candidate.Content</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parts</td><td><a href="#bytebase.v1.AICompletionResponse.Candidate.Content.Part">AICompletionResponse.Candidate.Content.Part</a></td><td>repeated</td><td><p>parts is used for a result content with multiple parts. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AICompletionResponse.Candidate.Content.Part">AICompletionResponse.Candidate.Content.Part</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>text</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AdminExecuteRequest">AdminExecuteRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -23385,21 +23448,21 @@ for OpenAI and Gemini. </p></td><td><p>The name is the instance name to execute the query against.Format: instances/{instance}/databases/{databaseName} </p></td></tr>-+<tr><td>statement</td><td><a href="#string">string</a></td><td></td><td><p>The SQL statement to execute. </p></td></tr>-+<tr><td>limit</td><td><a href="#int32">int32</a></td><td></td><td><p>The maximum number of rows to return. </p></td></tr>-+<tr><td>schema</td><td><a href="#string">string</a></td>@@ -23407,7 +23470,7 @@ Format: instances/{instance}/databases/{databaseName} </p></td><td><p>The default schema to execute the statement. Equals to the current schemain Oracle and search path in Postgres. </p></td></tr>-+<tr><td>container</td><td><a href="#string">string</a></td>@@ -23415,76 +23478,76 @@ in Oracle and search path in Postgres. </p></td><td><p>Container is the container name to execute the query against, used forCosmosDB only. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.AdminExecuteResponse">AdminExecuteResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>results</td><td><a href="#bytebase.v1.QueryResult">QueryResult</a></td><td>repeated</td><td><p>The query results. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Advice">Advice</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>status</td><td><a href="#bytebase.v1.Advice.Level">Advice.Level</a></td><td></td><td><p>The advice level. </p></td></tr>-+<tr><td>code</td><td><a href="#int32">int32</a></td><td></td><td><p>The advice code. </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>The advice title. </p></td></tr>-+<tr><td>content</td><td><a href="#string">string</a></td><td></td><td><p>The advice content. </p></td></tr>-+<tr><td>start_position</td><td><a href="#bytebase.v1.Position">Position</a></td>@@ -23492,100 +23555,100 @@ CosmosDB only. </p></td><td><p>The start_position is inclusive and the end_position is exclusive.TODO: use range instead </p></td></tr>-+<tr><td>end_position</td><td><a href="#bytebase.v1.Position">Position</a></td><td></td><td><p> </p></td></tr>-+<tr><td>rule_type</td><td><a href="#bytebase.v1.Advice.RuleType">Advice.RuleType</a></td><td></td><td><p>The type of linting rule that generated this advice. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DiffMetadataRequest">DiffMetadataRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>source_metadata</td><td><a href="#bytebase.v1.DatabaseMetadata">DatabaseMetadata</a></td><td></td><td><p>The metadata of the source schema. </p></td></tr>-+<tr><td>target_metadata</td><td><a href="#bytebase.v1.DatabaseMetadata">DatabaseMetadata</a></td><td></td><td><p>The metadata of the target schema. </p></td></tr>-+<tr><td>engine</td><td><a href="#bytebase.v1.Engine">Engine</a></td><td></td><td><p>The database engine of the schema. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DiffMetadataResponse">DiffMetadataResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>diff</td><td><a href="#string">string</a></td><td></td><td><p>The diff of the metadata. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ExportRequest">ExportRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -23596,28 +23659,28 @@ Format: instances/{instance}Format: projects/{project}/plans/{plan}/rolloutFormat: projects/{project}/plans/{plan}/rollout/stages/{stage} </p></td></tr>-+<tr><td>statement</td><td><a href="#string">string</a></td><td></td><td><p>The SQL statement to execute. </p></td></tr>-+<tr><td>limit</td><td><a href="#int32">int32</a></td><td></td><td><p>The maximum number of rows to return. </p></td></tr>-+<tr><td>format</td><td><a href="#bytebase.v1.ExportFormat">ExportFormat</a></td><td></td><td><p>The export format. </p></td></tr>-+<tr><td>admin</td><td><a href="#bool">bool</a></td>@@ -23625,14 +23688,14 @@ Format: projects/{project}/plans/{plan}/rollout/stages/{stage} </p></td><td><p>The admin is used for workspace owner and DBA for exporting data from SQLEditor Admin mode. The exported data is not masked. </p></td></tr>-+<tr><td>password</td><td><a href="#string">string</a></td><td></td><td><p>The zip password provide by users. </p></td></tr>-+<tr><td>data_source_id</td><td><a href="#string">string</a></td>@@ -23643,7 +23706,7 @@ single read-only data source when exactly one exists, or the admin datasource otherwise. It can also be set explicitly to export from the admindata source or a specific read-only data source. </p></td></tr>-+<tr><td>schema</td><td><a href="#string">string</a></td>@@ -23651,114 +23714,114 @@ data source or a specific read-only data source. </p></td><td><p>The default schema to search objects. Equals to the current schema inOracle and search path in Postgres. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ExportResponse">ExportResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>content</td><td><a href="#bytes">bytes</a></td><td></td><td><p>The export file content. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.MaskingReason">MaskingReason</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>semantic_type_id</td><td><a href="#string">string</a></td><td></td><td><p>The semantic type that triggered masking (e.g., "SSN", "email", "phone"). </p></td></tr>-+<tr><td>semantic_type_title</td><td><a href="#string">string</a></td><td></td><td><p>Human-readable semantic type title. </p></td></tr>-+<tr><td>masking_rule_id</td><td><a href="#string">string</a></td><td></td><td><p>The masking rule ID that matched (if applicable). </p></td></tr>-+<tr><td>algorithm</td><td><a href="#string">string</a></td><td></td><td><p>The masking algorithm used. </p></td></tr>-+<tr><td>context</td><td><a href="#string">string</a></td><td></td><td><p>Additional context (e.g., "Matched global rule: PII Protection"). </p></td></tr>-+<tr><td>classification_level</td><td><a href="#int32">int32</a></td><td></td><td><p>The classification level that triggered masking. </p></td></tr>-+<tr><td>semantic_type_icon</td><td><a href="#string">string</a></td><td></td><td><p>Icon associated with the semantic type (if any). </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.QueryHistory">QueryHistory</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -23766,7 +23829,7 @@ Oracle and search path in Postgres. </p></td><td><p>The name for the query history.Format: projects/{project}/queryHistories/{id} </p></td></tr>-+<tr><td>database</td><td><a href="#string">string</a></td>@@ -23774,97 +23837,97 @@ Format: projects/{project}/queryHistories/{id} </p></td><td><p>The database name to execute the query.Format: instances/{instance}/databases/{databaseName} </p></td></tr>-+<tr><td>creator</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>create_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>statement</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>error</td><td><a href="#string">string</a></td><td>optional</td><td><p> </p></td></tr>-+<tr><td>duration</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td><td><p> </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.v1.QueryHistory.Type">QueryHistory.Type</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.QueryOption">QueryOption</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>redis_run_commands_on</td><td><a href="#bytebase.v1.QueryOption.RedisRunCommandsOn">QueryOption.RedisRunCommandsOn</a></td><td></td><td><p> </p></td></tr>-+<tr><td>mssql_explain_format</td><td><a href="#bytebase.v1.QueryOption.MSSQLExplainFormat">QueryOption.MSSQLExplainFormat</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.QueryRequest">QueryRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -23872,21 +23935,21 @@ Format: instances/{instance}/databases/{databaseName} </p></td><td><p>The name is the instance name to execute the query against.Format: instances/{instance}/databases/{databaseName} </p></td></tr>-+<tr><td>statement</td><td><a href="#string">string</a></td><td></td><td><p>The SQL statement to execute. </p></td></tr>-+<tr><td>limit</td><td><a href="#int32">int32</a></td><td></td><td><p>The maximum number of rows to return. </p></td></tr>-+<tr><td>data_source_id</td><td><a href="#string">string</a></td>@@ -23897,14 +23960,14 @@ read-only data source when exactly one exists, or the admin data sourceotherwise. It can also be set explicitly to query the admin data source ora specific read-only data source. </p></td></tr>-+<tr><td>explain</td><td><a href="#bool">bool</a></td><td></td><td><p>Explain the statement. </p></td></tr>-+<tr><td>schema</td><td><a href="#string">string</a></td>@@ -23912,14 +23975,14 @@ a specific read-only data source. </p></td><td><p>The default schema to search objects. Equals to the current schema inOracle and search path in Postgres. </p></td></tr>-+<tr><td>query_option</td><td><a href="#bytebase.v1.QueryOption">QueryOption</a></td><td></td><td><p> </p></td></tr>-+<tr><td>container</td><td><a href="#string">string</a></td>@@ -23927,55 +23990,55 @@ Oracle and search path in Postgres. </p></td><td><p>Container is the container name to execute the query against, used forCosmosDB only. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.QueryResponse">QueryResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>results</td><td><a href="#bytebase.v1.QueryResult">QueryResult</a></td><td>repeated</td><td><p>The query results. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.QueryResult">QueryResult</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>column_names</td><td><a href="#string">string</a></td><td>repeated</td><td><p>Column names of the query result. </p></td></tr>-+<tr><td>column_type_names</td><td><a href="#string">string</a></td>@@ -23983,70 +24046,70 @@ CosmosDB only. </p></td><td><p>Column types of the query result.The types come from the Golang SQL driver. </p></td></tr>-+<tr><td>rows</td><td><a href="#bytebase.v1.QueryRow">QueryRow</a></td><td>repeated</td><td><p>Rows of the query result. </p></td></tr>-+<tr><td>rows_count</td><td><a href="#int64">int64</a></td><td></td><td><p> </p></td></tr>-+<tr><td>error</td><td><a href="#string">string</a></td><td></td><td><p>The error message if the query failed. </p></td></tr>-+<tr><td>latency</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td><td><p>The time it takes to execute the query. </p></td></tr>-+<tr><td>statement</td><td><a href="#string">string</a></td><td></td><td><p>The query statement for the result. </p></td></tr>-+<tr><td>postgres_error</td><td><a href="#bytebase.v1.QueryResult.PostgresError">QueryResult.PostgresError</a></td><td></td><td><p> </p></td></tr>-+<tr><td>syntax_error</td><td><a href="#bytebase.v1.QueryResult.SyntaxError">QueryResult.SyntaxError</a></td><td></td><td><p> </p></td></tr>-+<tr><td>permission_denied</td><td><a href="#bytebase.v1.PermissionDeniedDetail">PermissionDeniedDetail</a></td><td></td><td><p> </p></td></tr>-+<tr><td>command_error</td><td><a href="#bytebase.v1.QueryResult.CommandError">QueryResult.CommandError</a></td><td></td><td><p> </p></td></tr>-+<tr><td>messages</td><td><a href="#bytebase.v1.QueryResult.Message">QueryResult.Message</a></td>@@ -24054,347 +24117,347 @@ The types come from the Golang SQL driver. </p></td><td><p>Informational or debug messages returned by the database engine during query execution.Examples include PostgreSQL's RAISE NOTICE, MSSQL's PRINT, or Oracle's DBMS_OUTPUT.PUT_LINE. </p></td></tr>-+<tr><td>masked</td><td><a href="#bytebase.v1.MaskingReason">MaskingReason</a></td><td>repeated</td><td><p>Masking reasons for each column (empty for non-masked columns). </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.QueryResult.CommandError">QueryResult.CommandError</h3><p>Permission denied with resource information or disallowed command_type.</p><p>Either resources or command_type is available.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>command_type</td><td><a href="#bytebase.v1.QueryResult.CommandError.Type">QueryResult.CommandError.Type</a></td><td></td><td><p>Disallowed command_type. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.QueryResult.Message">QueryResult.Message</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>level</td><td><a href="#bytebase.v1.QueryResult.Message.Level">QueryResult.Message.Level</a></td><td></td><td><p> </p></td></tr>-+<tr><td>content</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.QueryResult.PostgresError">QueryResult.PostgresError</h3><p>refer https://www.postgresql.org/docs/11/protocol-error-fields.html</p><p>for field description.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>severity</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>code</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>message</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>detail</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>hint</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>position</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>internal_position</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>internal_query</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>where</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>schema_name</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>table_name</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>column_name</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>data_type_name</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>constraint_name</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>file</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>line</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>routine</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.QueryResult.SyntaxError">QueryResult.SyntaxError</h3><p>Syntax error with position information for editor highlighting</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>start_position</td><td><a href="#bytebase.v1.Position">Position</a></td><td></td><td><p>Position information for highlighting in editor </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.QueryRow">QueryRow</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>values</td><td><a href="#bytebase.v1.RowValue">RowValue</a></td><td>repeated</td><td><p>Row values of the query result. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.RowValue">RowValue</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>null_value</td><td><a href="#google.protobuf.NullValue">google.protobuf.NullValue</a></td><td></td><td><p> </p></td></tr>-+<tr><td>bool_value</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>bytes_value</td><td><a href="#bytes">bytes</a></td><td></td><td><p> </p></td></tr>-+<tr><td>double_value</td><td><a href="#double">double</a></td><td></td><td><p> </p></td></tr>-+<tr><td>float_value</td><td><a href="#float">float</a></td><td></td><td><p> </p></td></tr>-+<tr><td>int32_value</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>int64_value</td><td><a href="#int64">int64</a></td><td></td><td><p> </p></td></tr>-+<tr><td>string_value</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>uint32_value</td><td><a href="#uint32">uint32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>uint64_value</td><td><a href="#uint64">uint64</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value_value</td><td><a href="#google.protobuf.Value">google.protobuf.Value</a></td><td></td><td><p>value_value is used for Spanner and TUPLE ARRAY MAP in Clickhouse only. </p></td></tr>-+<tr><td>timestamp_value</td><td><a href="#bytebase.v1.RowValue.Timestamp">RowValue.Timestamp</a></td>@@ -24404,7 +24467,7 @@ meaning it only includes the timestamp without any time zone or locationinfo. Although it may be expressed as a UTC value, it should be seen as atimestamp missing location context. </p></td></tr>-+<tr><td>timestamp_tz_value</td><td><a href="#bytebase.v1.RowValue.TimestampTZ">RowValue.TimestampTZ</a></td>@@ -24412,62 +24475,62 @@ timestamp missing location context. </p></td><td><p>timestamp_tz_value is used for the timestamptz data type, whichaccurately represents the timestamp with location information. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.RowValue.Timestamp">RowValue.Timestamp</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>google_timestamp</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>accuracy</td><td><a href="#int32">int32</a></td><td></td><td><p>The accuracy is the number of digits after the decimal point. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.RowValue.TimestampTZ">RowValue.TimestampTZ</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>google_timestamp</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>zone</td><td><a href="#string">string</a></td>@@ -24479,38 +24542,38 @@ database. A timestamp is in UTC or epoch time, and with zone info, we canconvert it to a local time string. Zone and offset are returned bytime.Time.Zone() </p></td></tr>-+<tr><td>offset</td><td><a href="#int32">int32</a></td><td></td><td><p>The offset is in seconds east of UTC </p></td></tr>-+<tr><td>accuracy</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SearchQueryHistoriesRequest">SearchQueryHistoriesRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>page_size</td><td><a href="#int32">int32</a></td>@@ -24520,7 +24583,7 @@ The service may return fewer than this value.If unspecified, at most 10 history entries will be returned.The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td></tr>-+<tr><td>page_token</td><td><a href="#string">string</a></td>@@ -24528,7 +24591,7 @@ The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td><td><p>A page token, received from a previous `ListQueryHistory` call.Provide this to retrieve the subsequent page. </p></td></tr>-+<tr><td>filter</td><td><a href="#string">string</a></td>@@ -24552,31 +24615,31 @@ type == "EXPORT"statement.contains("select")type == "QUERY" && statement.contains("select") </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SearchQueryHistoriesResponse">SearchQueryHistoriesResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>query_histories</td><td><a href="#bytebase.v1.QueryHistory">QueryHistory</a></td><td>repeated</td><td><p>The list of history. </p></td></tr>-+<tr><td>next_page_token</td><td><a href="#string">string</a></td>@@ -24585,16 +24648,16 @@ type == "QUERY" && statement.contains("select") </p></tdPass this value in the page_token field in the subsequent call to`ListQueryHistory` method to retrieve the next page of history. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.Advice.Level">Advice.Level</h3><p>Level represents the severity level of the advice.</p><table class="enum-table">@@ -24602,34 +24665,34 @@ Pass this value in the page_token field in the subsequent call to<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>ADVICE_LEVEL_UNSPECIFIED</td><td>0</td><td><p>Unspecified advice level.</p></td></tr>-+<tr><td>SUCCESS</td><td>1</td><td><p>Success status indicating the check passed without issues.</p></td></tr>-+<tr><td>WARNING</td><td>2</td><td><p>Warning status indicating potential issues that should be reviewed.</p></td></tr>-+<tr><td>ERROR</td><td>3</td><td><p>Error status indicating critical issues that must be addressed.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.Advice.RuleType">Advice.RuleType</h3><p>RuleType indicates the source of the linting rule.</p><table class="enum-table">@@ -24637,30 +24700,30 @@ Pass this value in the page_token field in the subsequent call to<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>RULE_TYPE_UNSPECIFIED</td><td>0</td><td><p>Unspecified rule type.</p></td></tr>-+<tr><td>PARSER_BASED</td><td>1</td><td><p>Parser-based rule enforced by the built-in SQL parser.These are non-configurable, mandatory checks for schema health.</p></td></tr>-+<tr><td>AI_POWERED</td><td>2</td><td><p>AI-powered rule defined by user in natural language.These are custom, flexible checks powered by AI models.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.QueryHistory.Type">QueryHistory.Type</h3><p></p><table class="enum-table">@@ -24668,28 +24731,28 @@ These are custom, flexible checks powered by AI models.</p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p>Unspecified query history type.</p></td></tr>-+<tr><td>QUERY</td><td>1</td><td><p>Query execution for data retrieval.</p></td></tr>-+<tr><td>EXPORT</td><td>2</td><td><p>Data export operation to file.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.QueryOption.MSSQLExplainFormat">QueryOption.MSSQLExplainFormat</h3><p></p><table class="enum-table">@@ -24697,28 +24760,28 @@ These are custom, flexible checks powered by AI models.</p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>MSSQL_EXPLAIN_FORMAT_UNSPECIFIED</td><td>0</td><td><p>defaults to SHOWPLAN_ALL</p></td></tr>-+<tr><td>MSSQL_EXPLAIN_FORMAT_ALL</td><td>1</td><td><p>SHOWPLAN_ALL</p></td></tr>-+<tr><td>MSSQL_EXPLAIN_FORMAT_XML</td><td>2</td><td><p>SHOWPLAN_XML</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.QueryOption.RedisRunCommandsOn">QueryOption.RedisRunCommandsOn</h3><p></p><table class="enum-table">@@ -24726,28 +24789,28 @@ These are custom, flexible checks powered by AI models.</p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>REDIS_RUN_COMMANDS_ON_UNSPECIFIED</td><td>0</td><td><p>UNSPECIFIED defaults to SINGLE_NODE.</p></td></tr>-+<tr><td>SINGLE_NODE</td><td>1</td><td><p>Execute Redis commands on a single node in the cluster.</p></td></tr>-+<tr><td>ALL_NODES</td><td>2</td><td><p>Execute Redis commands on all nodes in the cluster for cluster-wide operations.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.QueryResult.CommandError.Type">QueryResult.CommandError.Type</h3><p></p><table class="enum-table">@@ -24755,34 +24818,34 @@ These are custom, flexible checks powered by AI models.</p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>DDL</td><td>1</td><td><p></p></td></tr>-+<tr><td>DML</td><td>2</td><td><p></p></td></tr>-+<tr><td>NON_READ_ONLY</td><td>3</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.QueryResult.Message.Level">QueryResult.Message.Level</h3><p></p><table class="enum-table">@@ -24790,56 +24853,56 @@ These are custom, flexible checks powered by AI models.</p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>LEVEL_UNSPECIFIED</td><td>0</td><td><p>Unspecified message level.</p></td></tr>-+<tr><td>INFO</td><td>1</td><td><p>Informational message.</p></td></tr>-+<tr><td>WARNING</td><td>2</td><td><p>Warning message indicating potential issues.</p></td></tr>-+<tr><td>DEBUG</td><td>3</td><td><p>Debug message for development and troubleshooting.</p></td></tr>-+<tr><td>LOG</td><td>4</td><td><p>General log message.</p></td></tr>-+<tr><td>NOTICE</td><td>5</td><td><p>Notice message for important information.</p></td></tr>-+<tr><td>EXCEPTION</td><td>6</td><td><p>Exception message indicating error conditions.</p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SQLService">SQLService</h3><p>SQLService executes SQL queries and manages query operations.</p><table class="enum-table">@@ -24847,7 +24910,7 @@ These are custom, flexible checks powered by AI models.</p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>Query</td><td><a href="#bytebase.v1.QueryRequest">QueryRequest</a></td>@@ -24855,7 +24918,7 @@ These are custom, flexible checks powered by AI models.</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>@@ -24863,7 +24926,7 @@ Permissions required: bb.databases.get</p></td><td><p>Executes SQL with admin privileges via streaming connection.Permissions required: bb.sql.admin</p></td></tr>-+<tr><td>SearchQueryHistories</td><td><a href="#bytebase.v1.SearchQueryHistoriesRequest">SearchQueryHistoriesRequest</a></td>@@ -24871,7 +24934,7 @@ Permissions required: bb.sql.admin</p></td><td><p>SearchQueryHistories searches query histories for the caller.Permissions required: None (only returns caller's own query histories)</p></td></tr>-+<tr><td>Export</td><td><a href="#bytebase.v1.ExportRequest">ExportRequest</a></td>@@ -24879,7 +24942,7 @@ Permissions required: None (only returns caller's own query histories)</p></<td><p>Exports query results to a file format.Permissions required: bb.databases.get</p></td></tr>-+<tr><td>DiffMetadata</td><td><a href="#bytebase.v1.DiffMetadataRequest">DiffMetadataRequest</a></td>@@ -24887,7 +24950,7 @@ Permissions required: bb.databases.get</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>@@ -24895,13 +24958,13 @@ 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></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -24913,103 +24976,103 @@ Permissions required: None (authenticated users only, requires AI to be enabled)</tr></thead><tbody>---+++<tr><td>Query</td><td>POST</td><td>/v1/{name=instances/*/databases/*}:query</td><td>*</td></tr>----++++<tr><td>AdminExecute</td><td>GET</td><td>/v1:adminExecute</td><td></td></tr>----++++<tr><td>SearchQueryHistories</td><td>POST</td><td>/v1/queryHistories:search</td><td>*</td></tr>----++++<tr><td>Export</td><td>POST</td><td>/v1/{name=instances/*/databases/*}:export</td><td>*</td></tr>-+<tr><td>Export</td><td>POST</td><td>/v1/{name=projects/*/plans/*/rollout}:export</td><td>*</td></tr>-+<tr><td>Export</td><td>POST</td><td>/v1/{name=projects/*/plans/*/rollout/stages/*}:export</td><td>*</td></tr>----++++<tr><td>DiffMetadata</td><td>POST</td><td>/v1/schemaDesign:diffMetadata</td><td>*</td></tr>----++++<tr><td>AICompletion</td><td>POST</td><td>/v1/sql/aiCompletion</td><td>*</td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/plan_service.proto">v1/plan_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.CancelPlanCheckRunRequest">CancelPlanCheckRunRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -25017,31 +25080,31 @@ Permissions required: None (authenticated users only, requires AI to be enabled)<td><p>The name of the plan check run to cancel.Format: projects/{project}/plans/{plan}/planCheckRun </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.CancelPlanCheckRunResponse">CancelPlanCheckRunResponse</h3><p></p>---+++<h3 id="bytebase.v1.CreatePlanRequest">CreatePlanRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -25049,31 +25112,31 @@ Format: projects/{project}/plans/{plan}/planCheckRun </p></td><td><p>The parent project where this plan will be created.Format: projects/{project} </p></td></tr>-+<tr><td>plan</td><td><a href="#bytebase.v1.Plan">Plan</a></td><td></td><td><p>The plan to create. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetPlanCheckRunRequest">GetPlanCheckRunRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -25081,24 +25144,24 @@ Format: projects/{project} </p></td><td><p>The name of the plan check run to retrieve.Format: projects/{project}/plans/{plan}/planCheckRun </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetPlanRequest">GetPlanRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -25106,24 +25169,24 @@ Format: projects/{project}/plans/{plan}/planCheckRun </p></td><td><p>The name of the plan to retrieve.Format: projects/{project}/plans/{plan} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListPlansRequest">ListPlansRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -25132,7 +25195,7 @@ Format: projects/{project}/plans/{plan} </p></td>Format: projects/{project}Use "projects/-" to list all plans from all projects. </p></td></tr>-+<tr><td>page_size</td><td><a href="#int32">int32</a></td>@@ -25142,7 +25205,7 @@ this value.If unspecified, at most 10 plans will be returned.The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td></tr>-+<tr><td>page_token</td><td><a href="#string">string</a></td>@@ -25153,7 +25216,7 @@ Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `ListPlans` must matchthe call that provided the page token. </p></td></tr>-+<tr><td>filter</td><td><a href="#string">string</a></td>@@ -25178,31 +25241,31 @@ title.contains("database migration")spec_type == "change_database_config"state == "ACTIVE" </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListPlansResponse">ListPlansResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>plans</td><td><a href="#bytebase.v1.Plan">Plan</a></td><td>repeated</td><td><p>The plans from the specified request. </p></td></tr>-+<tr><td>next_page_token</td><td><a href="#string">string</a></td>@@ -25210,24 +25273,24 @@ state == "ACTIVE" </p></td><td><p>A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Plan">Plan</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -25236,14 +25299,14 @@ If this field is omitted, there are no subsequent pages. </p></td>`plan` is a system generated ID.Format: projects/{project}/plans/{plan} </p></td></tr>-+<tr><td>state</td><td><a href="#bytebase.v1.State">State</a></td><td></td><td><p>The state of the plan. </p></td></tr>-+<tr><td>issue</td><td><a href="#string">string</a></td>@@ -25252,49 +25315,49 @@ Format: projects/{project}/plans/{plan} </p></td>Can be empty.Format: projects/{project}/issues/{issue} </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>The title of the plan. </p></td></tr>-+<tr><td>description</td><td><a href="#string">string</a></td><td></td><td><p>The description of the plan. </p></td></tr>-+<tr><td>specs</td><td><a href="#bytebase.v1.Plan.Spec">Plan.Spec</a></td><td>repeated</td><td><p>The deployment specs for the plan. </p></td></tr>-+<tr><td>creator</td><td><a href="#string">string</a></td><td></td><td><p>Format: users/[email protected] </p></td></tr>-+<tr><td>create_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>update_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>plan_check_run_status_count</td><td><a href="#bytebase.v1.Plan.PlanCheckRunStatusCountEntry">Plan.PlanCheckRunStatusCountEntry</a></td>@@ -25306,14 +25369,14 @@ Keys are:- ERROR- RUNNING </p></td></tr>-+<tr><td>has_rollout</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether the plan has started the rollout. </p></td></tr>-+<tr><td>approval_status</td><td><a href="#bytebase.v1.Issue.ApprovalStatus">Issue.ApprovalStatus</a></td>@@ -25321,7 +25384,7 @@ Keys are:<td><p>The approval status of the linked issue.Unspecified when no linked issue exists. </p></td></tr>-+<tr><td>rollout_stage_summaries</td><td><a href="#bytebase.v1.Plan.RolloutStageSummary">Plan.RolloutStageSummary</a></td>@@ -25329,24 +25392,24 @@ Unspecified when no linked issue exists. </p></td><td><p>Per-stage rollout status summary.Ordered by environment deployment order. Empty when no rollout exists. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Plan.ChangeDatabaseConfig">Plan.ChangeDatabaseConfig</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>targets</td><td><a href="#string">string</a></td>@@ -25355,7 +25418,7 @@ Ordered by environment deployment order. Empty when no rollout exists. </p></td>Multi-database format: [instances/{instance-id}/databases/{database-name}].Single database group format: [projects/{project}/databaseGroups/{databaseGroup}]. </p></td></tr>-+<tr><td>sheet</td><td><a href="#string">string</a></td>@@ -25363,7 +25426,7 @@ Single database group format: [projects/{project}/databaseGroups/{databaseGroup}<td><p>The resource name of the sheet.Format: projects/{project}/sheets/{sheet} </p></td></tr>-+<tr><td>release</td><td><a href="#string">string</a></td>@@ -25371,31 +25434,31 @@ Format: projects/{project}/sheets/{sheet} </p></td><td><p>The resource name of the release.Format: projects/{project}/releases/{release} </p></td></tr>-+<tr><td>enable_prior_backup</td><td><a href="#bool">bool</a></td><td></td><td><p>If set, a backup of the modified data will be created automatically before any changes are applied. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Plan.CreateDatabaseConfig">Plan.CreateDatabaseConfig</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>target</td><td><a href="#string">string</a></td>@@ -25403,14 +25466,14 @@ Format: projects/{project}/releases/{release} </p></td><td><p>The resource name of the instance on which the database is created.Format: instances/{instance} </p></td></tr>-+<tr><td>database</td><td><a href="#string">string</a></td><td></td><td><p>The name of the database to create. </p></td></tr>-+<tr><td>table</td><td><a href="#string">string</a></td>@@ -25418,35 +25481,35 @@ Format: instances/{instance} </p></td><td><p>table is the name of the table, if it is not empty, Bytebase should create a table after creating the database.For example, in MongoDB, it only creates the database when we first store data in that database. </p></td></tr>-+<tr><td>character_set</td><td><a href="#string">string</a></td><td></td><td><p>character_set is the character set of the database. </p></td></tr>-+<tr><td>collation</td><td><a href="#string">string</a></td><td></td><td><p>collation is the collation of the database. </p></td></tr>-+<tr><td>cluster</td><td><a href="#string">string</a></td><td></td><td><p>cluster is the cluster of the database. This is only applicable to ClickHouse for "ON CLUSTER <<cluster>>". </p></td></tr>-+<tr><td>owner</td><td><a href="#string">string</a></td><td></td><td><p>owner is the owner of the database. This is only applicable to Postgres for "WITH OWNER <<owner>>". </p></td></tr>-+<tr><td>environment</td><td><a href="#string">string</a></td>@@ -25454,24 +25517,24 @@ For example, in MongoDB, it only creates the database when we first store data i<td><p>The environment resource.Format: environments/prod where prod is the environment resource ID. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Plan.ExportDataConfig">Plan.ExportDataConfig</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>targets</td><td><a href="#string">string</a></td>@@ -25480,7 +25543,7 @@ Format: environments/prod where prod is the environment resource ID. </p></td>Multi-database format: [instances/{instance-id}/databases/{database-name}].Single database group format: [projects/{project}/databaseGroups/{databaseGroup}]. </p></td></tr>-+<tr><td>sheet</td><td><a href="#string">string</a></td>@@ -25488,14 +25551,14 @@ Single database group format: [projects/{project}/databaseGroups/{databaseGroup}<td><p>The resource name of the sheet.Format: projects/{project}/sheets/{sheet} </p></td></tr>-+<tr><td>format</td><td><a href="#bytebase.v1.ExportFormat">ExportFormat</a></td><td></td><td><p>The format of the exported file. </p></td></tr>-+<tr><td>password</td><td><a href="#string">string</a></td>@@ -25503,55 +25566,55 @@ Format: projects/{project}/sheets/{sheet} </p></td><td><p>The zip password provide by users.Leave it empty if no needs to encrypt the zip file. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Plan.PlanCheckRunStatusCountEntry">Plan.PlanCheckRunStatusCountEntry</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Plan.RolloutStageSummary">Plan.RolloutStageSummary</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>stage</td><td><a href="#string">string</a></td>@@ -25559,187 +25622,187 @@ Leave it empty if no needs to encrypt the zip file. </p></td><td><p>The stage resource name.Format: projects/{project}/plans/{plan}/rollout/stages/{stage} </p></td></tr>-+<tr><td>task_status_counts</td><td><a href="#bytebase.v1.Plan.TaskStatusCount">Plan.TaskStatusCount</a></td><td>repeated</td><td><p>Task status counts for this stage. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Plan.Spec">Plan.Spec</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>id</td><td><a href="#string">string</a></td><td></td><td><p>A UUID4 string that uniquely identifies the Spec. </p></td></tr>-+<tr><td>create_database_config</td><td><a href="#bytebase.v1.Plan.CreateDatabaseConfig">Plan.CreateDatabaseConfig</a></td><td></td><td><p> </p></td></tr>-+<tr><td>change_database_config</td><td><a href="#bytebase.v1.Plan.ChangeDatabaseConfig">Plan.ChangeDatabaseConfig</a></td><td></td><td><p> </p></td></tr>-+<tr><td>export_data_config</td><td><a href="#bytebase.v1.Plan.ExportDataConfig">Plan.ExportDataConfig</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Plan.TaskStatusCount">Plan.TaskStatusCount</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>status</td><td><a href="#bytebase.v1.Task.Status">Task.Status</a></td><td></td><td><p>The task status. </p></td></tr>-+<tr><td>count</td><td><a href="#int32">int32</a></td><td></td><td><p>The number of tasks in the status. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.PlanCheckRun">PlanCheckRun</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>Format: projects/{project}/plans/{plan}/planCheckRun </p></td></tr>-+<tr><td>status</td><td><a href="#bytebase.v1.PlanCheckRun.Status">PlanCheckRun.Status</a></td><td></td><td><p> </p></td></tr>-+<tr><td>results</td><td><a href="#bytebase.v1.PlanCheckRun.Result">PlanCheckRun.Result</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>error</td><td><a href="#string">string</a></td><td></td><td><p>error is set if the Status is FAILED. </p></td></tr>-+<tr><td>create_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.PlanCheckRun.Result">PlanCheckRun.Result</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>status</td><td><a href="#bytebase.v1.Advice.Level">Advice.Level</a></td><td></td><td><p> </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>content</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>code</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>target</td><td><a href="#string">string</a></td>@@ -25747,107 +25810,107 @@ Format: projects/{project}/plans/{plan}/rollout/stages/{stage} </p></td><td><p>Target identification for consolidated results.Format: instances/{instance}/databases/{database} </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.v1.PlanCheckRun.Result.Type">PlanCheckRun.Result.Type</a></td><td></td><td><p> </p></td></tr>-+<tr><td>sql_summary_report</td><td><a href="#bytebase.v1.PlanCheckRun.Result.SqlSummaryReport">PlanCheckRun.Result.SqlSummaryReport</a></td><td></td><td><p> </p></td></tr>-+<tr><td>sql_review_report</td><td><a href="#bytebase.v1.PlanCheckRun.Result.SqlReviewReport">PlanCheckRun.Result.SqlReviewReport</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.PlanCheckRun.Result.SqlReviewReport">PlanCheckRun.Result.SqlReviewReport</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>start_position</td><td><a href="#bytebase.v1.Position">Position</a></td><td></td><td><p>Position of the SQL statement. </p></td></tr>-+<tr><td>end_position</td><td><a href="#bytebase.v1.Position">Position</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.PlanCheckRun.Result.SqlSummaryReport">PlanCheckRun.Result.SqlSummaryReport</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>statement_types</td><td><a href="#bytebase.v1.StatementType">StatementType</a></td><td>repeated</td><td><p>statement_types are the types of statements that are found in the sql. </p></td></tr>-+<tr><td>affected_rows</td><td><a href="#int64">int64</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.RunPlanChecksRequest">RunPlanChecksRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -25855,7 +25918,7 @@ Format: instances/{instance}/databases/{database} </p></td><td><p>The plan to run plan checks.Format: projects/{project}/plans/{plan} </p></td></tr>-+<tr><td>spec_id</td><td><a href="#string">string</a></td>@@ -25864,31 +25927,31 @@ Format: projects/{project}/plans/{plan} </p></td>This should match the spec.id field in Plan.Spec.If not set, all specs in the plan will be used. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.RunPlanChecksResponse">RunPlanChecksResponse</h3><p></p>---+++<h3 id="bytebase.v1.UpdatePlanRequest">UpdatePlanRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>plan</td><td><a href="#bytebase.v1.Plan">Plan</a></td>@@ -25898,14 +25961,14 @@ If not set, all specs in the plan will be used. </p></td>The plan's `name` field is used to identify the plan to update.Format: projects/{project}/plans/{plan} </p></td></tr>-+<tr><td>update_mask</td><td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td><td></td><td><p>The list of fields to update. </p></td></tr>-+<tr><td>allow_missing</td><td><a href="#bool">bool</a></td>@@ -25913,16 +25976,16 @@ Format: projects/{project}/plans/{plan} </p></td><td><p>If set to true, and the plan is not found, a new plan will be created.In this situation, `update_mask` is ignored. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.PlanCheckRun.Result.Type">PlanCheckRun.Result.Type</h3><p></p><table class="enum-table">@@ -25930,34 +25993,34 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>STATEMENT_ADVISE</td><td>1</td><td><p></p></td></tr>-+<tr><td>STATEMENT_SUMMARY_REPORT</td><td>2</td><td><p></p></td></tr>-+<tr><td>GHOST_SYNC</td><td>3</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.PlanCheckRun.Status">PlanCheckRun.Status</h3><p></p><table class="enum-table">@@ -25965,44 +26028,44 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>STATUS_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>RUNNING</td><td>1</td><td><p></p></td></tr>-+<tr><td>DONE</td><td>2</td><td><p></p></td></tr>-+<tr><td>FAILED</td><td>3</td><td><p></p></td></tr>-+<tr><td>CANCELED</td><td>4</td><td><p></p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.PlanService">PlanService</h3><p>PlanService manages deployment plans for database changes.</p><table class="enum-table">@@ -26010,7 +26073,7 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>GetPlan</td><td><a href="#bytebase.v1.GetPlanRequest">GetPlanRequest</a></td>@@ -26018,7 +26081,7 @@ In this situation, `update_mask` is ignored. </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>@@ -26026,7 +26089,7 @@ Permissions required: bb.plans.get</p></td><td><p>Lists deployment plans in a project.Permissions required: bb.plans.list</p></td></tr>-+<tr><td>CreatePlan</td><td><a href="#bytebase.v1.CreatePlanRequest">CreatePlanRequest</a></td>@@ -26034,7 +26097,7 @@ Permissions required: bb.plans.list</p></td><td><p>Creates a new deployment plan.Permissions required: bb.plans.create</p></td></tr>-+<tr><td>UpdatePlan</td><td><a href="#bytebase.v1.UpdatePlanRequest">UpdatePlanRequest</a></td>@@ -26043,7 +26106,7 @@ Permissions required: bb.plans.create</p></td>The plan creator and the user with bb.plans.update permission on the project can update the plan.Permissions required: bb.plans.update (or creator)</p></td></tr>-+<tr><td>GetPlanCheckRun</td><td><a href="#bytebase.v1.GetPlanCheckRunRequest">GetPlanCheckRunRequest</a></td>@@ -26051,7 +26114,7 @@ Permissions required: bb.plans.update (or creator)</p></td><td><p>Gets the plan check run for a deployment plan.Permissions required: bb.planCheckRuns.get</p></td></tr>-+<tr><td>RunPlanChecks</td><td><a href="#bytebase.v1.RunPlanChecksRequest">RunPlanChecksRequest</a></td>@@ -26059,7 +26122,7 @@ Permissions required: bb.planCheckRuns.get</p></td><td><p>Executes validation checks on a deployment plan.Permissions required: bb.planCheckRuns.run</p></td></tr>-+<tr><td>CancelPlanCheckRun</td><td><a href="#bytebase.v1.CancelPlanCheckRunRequest">CancelPlanCheckRunRequest</a></td>@@ -26067,13 +26130,13 @@ Permissions required: bb.planCheckRuns.run</p></td><td><p>Cancels the plan check run for a deployment plan.Permissions required: bb.planCheckRuns.run</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -26085,106 +26148,106 @@ Permissions required: bb.planCheckRuns.run</p></td></tr></thead><tbody>---+++<tr><td>GetPlan</td><td>GET</td><td>/v1/{name=projects/*/plans/*}</td><td></td></tr>----++++<tr><td>ListPlans</td><td>GET</td><td>/v1/{parent=projects/*}/plans</td><td></td></tr>----++++<tr><td>CreatePlan</td><td>POST</td><td>/v1/{parent=projects/*}/plans</td><td>plan</td></tr>----++++<tr><td>UpdatePlan</td><td>PATCH</td><td>/v1/{plan.name=projects/*/plans/*}</td><td>plan</td></tr>----++++<tr><td>GetPlanCheckRun</td><td>GET</td><td>/v1/{name=projects/*/plans/*/planCheckRun}</td><td></td></tr>----++++<tr><td>RunPlanChecks</td><td>POST</td><td>/v1/{name=projects/*/plans/*}:runPlanChecks</td><td>*</td></tr>----++++<tr><td>CancelPlanCheckRun</td><td>POST</td><td>/v1/{name=projects/*/plans/*/planCheckRun}:cancel</td><td>*</td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/project_service.proto">v1/project_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.Activity">Activity</h3><p>Activity types for webhook notifications.</p>---+++<h3 id="bytebase.v1.AddWebhookRequest">AddWebhookRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>project</td><td><a href="#string">string</a></td>@@ -26192,31 +26255,31 @@ Permissions required: bb.planCheckRuns.run</p></td><td><p>The name of the project to add the webhook to.Format: projects/{project} </p></td></tr>-+<tr><td>webhook</td><td><a href="#bytebase.v1.Webhook">Webhook</a></td><td></td><td><p>The webhook to add. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BatchDeleteProjectsRequest">BatchDeleteProjectsRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>names</td><td><a href="#string">string</a></td>@@ -26224,7 +26287,7 @@ Format: projects/{project} </p></td><td><p>The names of the projects to delete.Format: projects/{project} </p></td></tr>-+<tr><td>purge</td><td><a href="#bool">bool</a></td>@@ -26236,24 +26299,24 @@ All projects must already be soft-deleted for this to work.When purge=true, all databases will be moved to the default project before deletion.When purge=false (soft delete/archive), the projects and their databases/issues remain unchanged. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BatchGetProjectsRequest">BatchGetProjectsRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>names</td><td><a href="#string">string</a></td>@@ -26261,55 +26324,55 @@ When purge=false (soft delete/archive), the projects and their databases/issues<td><p>The names of projects to retrieve.Format: projects/{project} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BatchGetProjectsResponse">BatchGetProjectsResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>projects</td><td><a href="#bytebase.v1.Project">Project</a></td><td>repeated</td><td><p>The projects from the specified request. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.CreateProjectRequest">CreateProjectRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>project</td><td><a href="#bytebase.v1.Project">Project</a></td><td></td><td><p>The project to create. </p></td></tr>-+<tr><td>project_id</td><td><a href="#string">string</a></td>@@ -26320,24 +26383,24 @@ the project's resource name.This value should be 4-63 characters, and valid charactersare /[a-z][0-9]-/. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DeleteProjectRequest">DeleteProjectRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -26345,7 +26408,7 @@ are /[a-z][0-9]-/. </p></td><td><p>The name of the project to delete.Format: projects/{project} </p></td></tr>-+<tr><td>purge</td><td><a href="#bool">bool</a></td>@@ -26357,24 +26420,24 @@ The project must already be soft-deleted for this to work.When purge=true, all databases will be moved to the default project before deletion.When purge=false (soft delete/archive), the project and its databases/issues remain unchanged. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetProjectRequest">GetProjectRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -26382,62 +26445,62 @@ When purge=false (soft delete/archive), the project and its databases/issues rem<td><p>The name of the project to retrieve.Format: projects/{project} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Label">Label</h3><p>A label for categorizing and organizing issues.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>value</td><td><a href="#string">string</a></td><td></td><td><p>The label value/name. </p></td></tr>-+<tr><td>color</td><td><a href="#string">string</a></td><td></td><td><p>The color code for the label (e.g., hex color). </p></td></tr>-+<tr><td>group</td><td><a href="#string">string</a></td><td></td><td><p>The group this label belongs to. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListProjectsRequest">ListProjectsRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>page_size</td><td><a href="#int32">int32</a></td>@@ -26447,7 +26510,7 @@ this value.If unspecified, at most 10 projects will be returned.The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td></tr>-+<tr><td>page_token</td><td><a href="#string">string</a></td>@@ -26458,14 +26521,14 @@ Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `ListProjects` must matchthe call that provided the page token. </p></td></tr>-+<tr><td>show_deleted</td><td><a href="#bool">bool</a></td><td></td><td><p>Show deleted projects if specified. </p></td></tr>-+<tr><td>filter</td><td><a href="#string">string</a></td>@@ -26474,7 +26537,7 @@ the call that provided the page token. </p></td>Check filter for SearchProjectsRequest for details.Supports filtering by name, resource_id, state, and labels (e.g., labels.environment == "production"). </p></td></tr>-+<tr><td>order_by</td><td><a href="#string">string</a></td>@@ -26486,31 +26549,31 @@ For example:- order_by = "title desc"- order_by = "title asc" </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListProjectsResponse">ListProjectsResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>projects</td><td><a href="#bytebase.v1.Project">Project</a></td><td>repeated</td><td><p>The projects from the specified request. </p></td></tr>-+<tr><td>next_page_token</td><td><a href="#string">string</a></td>@@ -26518,24 +26581,24 @@ For example:<td><p>A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Project">Project</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -26543,56 +26606,56 @@ If this field is omitted, there are no subsequent pages. </p></td><td><p>The name of the project.Format: projects/{project} </p></td></tr>-+<tr><td>state</td><td><a href="#bytebase.v1.State">State</a></td><td></td><td><p>The lifecycle state of the project. </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>The title or name of a project. It's not unique within the workspace. </p></td></tr>-+<tr><td>webhooks</td><td><a href="#bytebase.v1.Webhook">Webhook</a></td><td>repeated</td><td><p>The list of webhooks configured for the project. </p></td></tr>-+<tr><td>data_classification_config_id</td><td><a href="#string">string</a></td><td></td><td><p>The data classification configuration ID for the project. </p></td></tr>-+<tr><td>issue_labels</td><td><a href="#bytebase.v1.Label">Label</a></td><td>repeated</td><td><p>Labels available for tagging issues in this project. </p></td></tr>-+<tr><td>force_issue_labels</td><td><a href="#bool">bool</a></td><td></td><td><p>Force issue labels to be used when creating an issue. </p></td></tr>-+<tr><td>enforce_issue_title</td><td><a href="#bool">bool</a></td><td></td><td><p>Enforce issue title to be created by user instead of generated by Bytebase. </p></td></tr>-+<tr><td>postgres_database_tenant_mode</td><td><a href="#bool">bool</a></td>@@ -26600,21 +26663,21 @@ Format: projects/{project} </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 issue creators to self-approve their own issues. </p></td></tr>-+<tr><td>execution_retry_policy</td><td><a href="#bytebase.v1.Project.ExecutionRetryPolicy">Project.ExecutionRetryPolicy</a></td><td></td><td><p>Execution retry policy for task runs. </p></td></tr>-+<tr><td>ci_sampling_size</td><td><a href="#int32">int32</a></td>@@ -26622,14 +26685,14 @@ If enabled, issues will include "set role <db_owner>" statement. <<td><p>The maximum number of database rows to sample during CI data validation.Without specification, sampling is disabled, resulting in full validation. </p></td></tr>-+<tr><td>parallel_tasks_per_rollout</td><td><a href="#int32">int32</a></td><td></td><td><p>The maximum number of parallel tasks allowed during rollout execution. </p></td></tr>-+<tr><td>labels</td><td><a href="#bytebase.v1.Project.LabelsEntry">Project.LabelsEntry</a></td>@@ -26637,7 +26700,7 @@ Without specification, sampling is disabled, resulting in full validation. </p><<td><p>Labels are key-value pairs that can be attached to the project.For example, { "environment": "production", "team": "backend" } </p></td></tr>-+<tr><td>enforce_sql_review</td><td><a href="#bool">bool</a></td>@@ -26645,138 +26708,138 @@ For example, { "environment": "production", "team": "<td><p>Whether to enforce SQL review checks to pass before issue creation.If enabled, issues cannot be created when SQL review finds errors. </p></td></tr>-+<tr><td>require_issue_approval</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether to require issue approval before rollout. </p></td></tr>-+<tr><td>require_plan_check_no_error</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether to require plan check to have no error before rollout. </p></td></tr>-+<tr><td>allow_request_role</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>allow_just_in_time_access</td><td><a href="#bool">bool</a></td><td></td><td><p>Once enabled, users can request and use the just-in-time access in the SQL Editor. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Project.ExecutionRetryPolicy">Project.ExecutionRetryPolicy</h3><p>Execution retry policy configuration.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>maximum_retries</td><td><a href="#int32">int32</a></td><td></td><td><p>The maximum number of retries for lock timeout errors. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Project.LabelsEntry">Project.LabelsEntry</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>key</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.RemoveWebhookRequest">RemoveWebhookRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>webhook</td><td><a href="#bytebase.v1.Webhook">Webhook</a></td><td></td><td><p>The webhook to remove. Identified by its url. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SearchProjectsRequest">SearchProjectsRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>show_deleted</td><td><a href="#bool">bool</a></td><td></td><td><p>Show deleted projects if specified. </p></td></tr>-+<tr><td>filter</td><td><a href="#string">string</a></td>@@ -26806,7 +26869,7 @@ name == "project name" && resource_id.contains("project id&#name.contains("project name") || resource_id == "project id"labels.environment == "production" && labels.tier == "critical" </p></td></tr>-+<tr><td>page_size</td><td><a href="#int32">int32</a></td>@@ -26816,7 +26879,7 @@ this value.If unspecified, at most 10 projects will be returned.The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td></tr>-+<tr><td>page_token</td><td><a href="#string">string</a></td>@@ -26827,7 +26890,7 @@ Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `SearchProjects` must matchthe call that provided the page token. </p></td></tr>-+<tr><td>order_by</td><td><a href="#string">string</a></td>@@ -26839,31 +26902,31 @@ For example:- order_by = "title desc"- order_by = "title asc" </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SearchProjectsResponse">SearchProjectsResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>projects</td><td><a href="#bytebase.v1.Project">Project</a></td><td>repeated</td><td><p>The projects from the specified request. </p></td></tr>-+<tr><td>next_page_token</td><td><a href="#string">string</a></td>@@ -26871,24 +26934,24 @@ For example:<td><p>A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TestWebhookRequest">TestWebhookRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>project</td><td><a href="#string">string</a></td>@@ -26896,55 +26959,55 @@ If this field is omitted, there are no subsequent pages. </p></td><td><p>The name of the project which owns the webhook to test.Format: projects/{project} </p></td></tr>-+<tr><td>webhook</td><td><a href="#bytebase.v1.Webhook">Webhook</a></td><td></td><td><p>The webhook to test. Identified by its url. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.TestWebhookResponse">TestWebhookResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>error</td><td><a href="#string">string</a></td><td></td><td><p>The result of the test, empty if the test is successful. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UndeleteProjectRequest">UndeleteProjectRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -26952,24 +27015,24 @@ Format: projects/{project} </p></td><td><p>The name of the deleted project.Format: projects/{project} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdateProjectRequest">UpdateProjectRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>project</td><td><a href="#bytebase.v1.Project">Project</a></td>@@ -26979,14 +27042,14 @@ Format: projects/{project} </p></td>The project's `name` field is used to identify the project to update.Format: projects/{project} </p></td></tr>-+<tr><td>update_mask</td><td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td><td></td><td><p>The list of fields to update. </p></td></tr>-+<tr><td>allow_missing</td><td><a href="#bool">bool</a></td>@@ -26994,38 +27057,38 @@ Format: projects/{project} </p></td><td><p>If set to true, and the project is not found, a new project will be created.In this situation, `update_mask` is ignored. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdateWebhookRequest">UpdateWebhookRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>webhook</td><td><a href="#bytebase.v1.Webhook">Webhook</a></td><td></td><td><p>The webhook to modify. </p></td></tr>-+<tr><td>update_mask</td><td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td><td></td><td><p>The list of fields to update. </p></td></tr>-+<tr><td>allow_missing</td><td><a href="#bool">bool</a></td>@@ -27033,24 +27096,24 @@ In this situation, `update_mask` is ignored. </p></td><td><p>If set to true, and the webhook is not found, a new webhook will be created.In this situation, `update_mask` is ignored. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Webhook">Webhook</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -27058,7 +27121,7 @@ In this situation, `update_mask` is ignored. </p></td><td><p>name is the name of the webhook, generated by the server.format: projects/{project}/webhooks/{webhook} </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.v1.WebhookType">WebhookType</a></td>@@ -27066,21 +27129,21 @@ format: projects/{project}/webhooks/{webhook} </p></td><td><p>Webhook integration type.type is the type of the webhook. </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>title is the title of the webhook. </p></td></tr>-+<tr><td>url</td><td><a href="#string">string</a></td><td></td><td><p>url is the url of the webhook, should be unique within the project. </p></td></tr>-+<tr><td>direct_message</td><td><a href="#bool">bool</a></td>@@ -27089,7 +27152,7 @@ type is the type of the webhook. </p></td>to the persons and url will be ignored.IM integration setting should be set for this function to work. </p></td></tr>-+<tr><td>notification_types</td><td><a href="#bytebase.v1.Activity.Type">Activity.Type</a></td>@@ -27104,16 +27167,16 @@ It should not be empty, and should be a subset of the following:- PIPELINE_FAILED- PIPELINE_COMPLETED </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.Activity.Type">Activity.Type</h3><p>Activity type enumeration.</p><table class="enum-table">@@ -27121,56 +27184,56 @@ It should not be empty, and should be a subset of the following:<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p>Unspecified type.</p></td></tr>-+<tr><td>ISSUE_CREATED</td><td>10</td><td><p>ISSUE_CREATED represents a new issue creation event.</p></td></tr>-+<tr><td>ISSUE_APPROVAL_REQUESTED</td><td>11</td><td><p>ISSUE_APPROVAL_REQUESTED represents an approval request event.</p></td></tr>-+<tr><td>ISSUE_SENT_BACK</td><td>12</td><td><p>ISSUE_SENT_BACK represents an issue being sent back by an approver.</p></td></tr>-+<tr><td>PIPELINE_FAILED</td><td>13</td><td><p>PIPELINE_FAILED represents a pipeline failure event.</p></td></tr>-+<tr><td>PIPELINE_COMPLETED</td><td>14</td><td><p>PIPELINE_COMPLETED represents a pipeline completion event.</p></td></tr>-+<tr><td>ISSUE_APPROVED</td><td>15</td><td><p>ISSUE_APPROVED represents an issue being fully approved.</p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ProjectService">ProjectService</h3><p>ProjectService manages projects that group databases and changes.</p><table class="enum-table">@@ -27178,7 +27241,7 @@ It should not be empty, and should be a subset of the following:<tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>GetProject</td><td><a href="#bytebase.v1.GetProjectRequest">GetProjectRequest</a></td>@@ -27187,7 +27250,7 @@ It should not be empty, and should be a subset of the following:Users with "bb.projects.get" permission on the workspace or the project owner can access this method.Permissions required: bb.projects.get</p></td></tr>-+<tr><td>BatchGetProjects</td><td><a href="#bytebase.v1.BatchGetProjectsRequest">BatchGetProjectsRequest</a></td>@@ -27195,7 +27258,7 @@ Permissions required: bb.projects.get</p></td><td><p>BatchGetProjects retrieves multiple projects by their names.Permissions required: bb.projects.get</p></td></tr>-+<tr><td>ListProjects</td><td><a href="#bytebase.v1.ListProjectsRequest">ListProjectsRequest</a></td>@@ -27203,7 +27266,7 @@ Permissions required: bb.projects.get</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>@@ -27211,7 +27274,7 @@ Permissions required: bb.projects.list</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>@@ -27219,7 +27282,7 @@ Permissions required: bb.projects.get (or project-level bb.projects.get for spec<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>@@ -27227,7 +27290,7 @@ Permissions required: bb.projects.create</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>@@ -27235,7 +27298,7 @@ Permissions required: bb.projects.update</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>@@ -27243,7 +27306,7 @@ Permissions required: bb.projects.delete</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>@@ -27251,7 +27314,7 @@ Permissions required: bb.projects.undelete</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>@@ -27259,7 +27322,7 @@ Permissions required: bb.projects.delete</p></td><td><p>Retrieves the IAM policy for a project.Permissions required: bb.projects.getIamPolicy</p></td></tr>-+<tr><td>SetIamPolicy</td><td><a href="#bytebase.v1.SetIamPolicyRequest">SetIamPolicyRequest</a></td>@@ -27267,7 +27330,7 @@ Permissions required: bb.projects.getIamPolicy</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>@@ -27275,7 +27338,7 @@ Permissions required: bb.projects.setIamPolicy</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>@@ -27283,7 +27346,7 @@ 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>@@ -27291,7 +27354,7 @@ 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>@@ -27299,13 +27362,13 @@ 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></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -27317,193 +27380,193 @@ Permissions required: bb.projects.update</p></td></tr></thead><tbody>---+++<tr><td>GetProject</td><td>GET</td><td>/v1/{name=projects/*}</td><td></td></tr>----++++<tr><td>BatchGetProjects</td><td>GET</td><td>/v1/projects:batchGet</td><td></td></tr>----++++<tr><td>ListProjects</td><td>GET</td><td>/v1/projects</td><td></td></tr>----++++<tr><td>SearchProjects</td><td>POST</td><td>/v1/projects:search</td><td>*</td></tr>----++++<tr><td>CreateProject</td><td>POST</td><td>/v1/projects</td><td>project</td></tr>----++++<tr><td>UpdateProject</td><td>PATCH</td><td>/v1/{project.name=projects/*}</td><td>project</td></tr>----++++<tr><td>DeleteProject</td><td>DELETE</td><td>/v1/{name=projects/*}</td><td></td></tr>----++++<tr><td>UndeleteProject</td><td>POST</td><td>/v1/{name=projects/*}:undelete</td><td>*</td></tr>----++++<tr><td>BatchDeleteProjects</td><td>POST</td><td>/v1/projects:batchDelete</td><td>*</td></tr>----++++<tr><td>GetIamPolicy</td><td>GET</td><td>/v1/{resource=projects/*}:getIamPolicy</td><td></td></tr>----++++<tr><td>SetIamPolicy</td><td>POST</td><td>/v1/{resource=projects/*}:setIamPolicy</td><td>*</td></tr>----++++<tr><td>AddWebhook</td><td>POST</td><td>/v1/{project=projects/*}:addWebhook</td><td>*</td></tr>----++++<tr><td>UpdateWebhook</td><td>PATCH</td><td>/v1/{webhook.name=projects/*/webhooks/*}:updateWebhook</td><td>webhook</td></tr>----++++<tr><td>RemoveWebhook</td><td>POST</td><td>/v1/{webhook.name=projects/*/webhooks/*}:removeWebhook</td><td>*</td></tr>----++++<tr><td>TestWebhook</td><td>POST</td><td>/v1/{project=projects/*}:testWebhook</td><td>*</td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/release_service.proto">v1/release_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.CheckReleaseRequest">CheckReleaseRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td><td></td><td><p>Format: projects/{project} </p></td></tr>-+<tr><td>release</td><td><a href="#bytebase.v1.Release">Release</a></td><td></td><td><p>The release to check. </p></td></tr>-+<tr><td>targets</td><td><a href="#string">string</a></td>@@ -27514,7 +27577,7 @@ Format:projects/{project}/databaseGroups/{databaseGroup}instances/{instance}/databases/{database} </p></td></tr>-+<tr><td>custom_rules</td><td><a href="#string">string</a></td>@@ -27524,69 +27587,69 @@ Each rule should be a clear statement describing the desired schema constraint.Example: "All tables must have a primary key"Example: "VARCHAR columns should specify a maximum length" </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.CheckReleaseResponse">CheckReleaseResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>results</td><td><a href="#bytebase.v1.CheckReleaseResponse.CheckResult">CheckReleaseResponse.CheckResult</a></td><td>repeated</td><td><p>The check results for each file and target combination. </p></td></tr>-+<tr><td>affected_rows</td><td><a href="#int64">int64</a></td><td></td><td><p>The total affected rows across all checks. </p></td></tr>-+<tr><td>risk_level</td><td><a href="#bytebase.v1.RiskLevel">RiskLevel</a></td><td></td><td><p>The aggregated risk level of the check. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.CheckReleaseResponse.CheckResult">CheckReleaseResponse.CheckResult</h3><p>Check result for a single release file on a target database.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>file</td><td><a href="#string">string</a></td><td></td><td><p>The file path that is being checked. </p></td></tr>-+<tr><td>target</td><td><a href="#string">string</a></td>@@ -27594,59 +27657,59 @@ Example: "VARCHAR columns should specify a maximum length" </p></td><td><p>The target that the check is performed on.Should be a database. Format: instances/{instance}/databases/{database} </p></td></tr>-+<tr><td>advices</td><td><a href="#bytebase.v1.Advice">Advice</a></td><td>repeated</td><td><p>The list of advice for the file and the target. </p></td></tr>-+<tr><td>affected_rows</td><td><a href="#int64">int64</a></td><td></td><td><p>The count of affected rows of the statement on the target. </p></td></tr>-+<tr><td>risk_level</td><td><a href="#bytebase.v1.RiskLevel">RiskLevel</a></td><td></td><td><p>The risk level of the statement on the target. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.CreateReleaseRequest">CreateReleaseRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td><td></td><td><p>Format: projects/{project} </p></td></tr>-+<tr><td>release</td><td><a href="#bytebase.v1.Release">Release</a></td><td></td><td><p>The release to create. </p></td></tr>-+<tr><td>release_id_template</td><td><a href="#string">string</a></td>@@ -27656,7 +27719,7 @@ Available variables: {date}, {time}, {timestamp}, {iteration}.Example: "release_{date}-RC{iteration}" generates "release_20260119-RC00".Default: "release_{date}-RC{iteration}". </p></td></tr>-+<tr><td>release_id_timezone</td><td><a href="#string">string</a></td>@@ -27665,24 +27728,24 @@ Default: "release_{date}-RC{iteration}". </p></td>Must be a valid IANA timezone (e.g., "UTC", "America/Los_Angeles").Default: "UTC". </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DeleteReleaseRequest">DeleteReleaseRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -27690,103 +27753,103 @@ Default: "UTC". </p></td><td><p>The name of the release to delete.Format: projects/{project}/releases/{release} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetReleaseRequest">GetReleaseRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>Format: projects/{project}/releases/{release} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListReleaseCategoriesRequest">ListReleaseCategoriesRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td><td></td><td><p>Format: projects/{project} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListReleaseCategoriesResponse">ListReleaseCategoriesResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>categories</td><td><a href="#string">string</a></td><td>repeated</td><td><p>The unique category values in the project. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListReleasesRequest">ListReleasesRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td><td></td><td><p>Format: projects/{project} </p></td></tr>-+<tr><td>page_size</td><td><a href="#int32">int32</a></td>@@ -27795,7 +27858,7 @@ Format: projects/{project}/releases/{release} </p></td>If unspecified, at most 10 releases will be returned.The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td></tr>-+<tr><td>page_token</td><td><a href="#string">string</a></td>@@ -27806,14 +27869,14 @@ Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `ListReleases` must matchthe call that provided the page token. </p></td></tr>-+<tr><td>show_deleted</td><td><a href="#bool">bool</a></td><td></td><td><p>Show deleted releases if specified. </p></td></tr>-+<tr><td>filter</td><td><a href="#string">string</a></td>@@ -27827,31 +27890,31 @@ Supported filters:For example:category == "webapp" </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListReleasesResponse">ListReleasesResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>releases</td><td><a href="#bytebase.v1.Release">Release</a></td><td>repeated</td><td><p>The releases from the specified request. </p></td></tr>-+<tr><td>next_page_token</td><td><a href="#string">string</a></td>@@ -27859,31 +27922,31 @@ category == "webapp" </p></td><td><p>A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Release">Release</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>Format: projects/{project}/releases/{release} </p></td></tr>-+<tr><td>category</td><td><a href="#string">string</a></td>@@ -27891,80 +27954,80 @@ If this field is omitted, there are no subsequent pages. </p></td><td><p>Category extracted from release name (e.g., "webapp", "analytics").Set by Bytebase action during release creation. </p></td></tr>-+<tr><td>files</td><td><a href="#bytebase.v1.Release.File">Release.File</a></td><td>repeated</td><td><p>The SQL files included in the release. </p></td></tr>-+<tr><td>vcs_source</td><td><a href="#bytebase.v1.Release.VCSSource">Release.VCSSource</a></td><td></td><td><p>The version control source of the release. </p></td></tr>-+<tr><td>creator</td><td><a href="#string">string</a></td><td></td><td><p>Format: users/[email protected] </p></td></tr>-+<tr><td>create_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>state</td><td><a href="#bytebase.v1.State">State</a></td><td></td><td><p>The lifecycle state of the release. </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.v1.Release.Type">Release.Type</a></td><td></td><td><p>The type of schema change for all files in this release. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Release.File">Release.File</h3><p>A SQL file in a release.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>path</td><td><a href="#string">string</a></td><td></td><td><p>The path of the file. e.g., `2.2/V0001_create_table.sql`. </p></td></tr>-+<tr><td>version</td><td><a href="#string">string</a></td><td></td><td><p>The version identifier for the file. </p></td></tr>-+<tr><td>sheet</td><td><a href="#string">string</a></td>@@ -27975,69 +28038,69 @@ For outputs, we always use `sheet`. `statement` is the preview of the sheet contThe sheet that holds the content.Format: projects/{project}/sheets/{sheet} </p></td></tr>-+<tr><td>statement</td><td><a href="#bytes">bytes</a></td><td></td><td><p>The raw SQL statement content. </p></td></tr>-+<tr><td>sheet_sha256</td><td><a href="#string">string</a></td><td></td><td><p>The SHA256 hash value of the sheet content or the statement. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Release.VCSSource">Release.VCSSource</h3><p>Version control system source information.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>vcs_type</td><td><a href="#bytebase.v1.VCSType">VCSType</a></td><td></td><td><p>The type of VCS. </p></td></tr>-+<tr><td>url</td><td><a href="#string">string</a></td><td></td><td><p>The url link to the e.g., GitHub commit or pull request. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UndeleteReleaseRequest">UndeleteReleaseRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -28045,47 +28108,47 @@ Format: projects/{project}/sheets/{sheet} </p></td><td><p>The name of the deleted release.Format: projects/{project}/releases/{release} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdateReleaseRequest">UpdateReleaseRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>release</td><td><a href="#bytebase.v1.Release">Release</a></td><td></td><td><p>The release to update. </p></td></tr>-+<tr><td>update_mask</td><td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td><td></td><td><p>The list of fields to be updated. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.Release.Type">Release.Type</h3><p>The type of schema change.</p><table class="enum-table">@@ -28093,32 +28156,32 @@ Format: projects/{project}/releases/{release} </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p>Unspecified type.</p></td></tr>-+<tr><td>VERSIONED</td><td>1</td><td><p>Versioned schema migration.</p></td></tr>-+<tr><td>DECLARATIVE</td><td>2</td><td><p>Declarative schema definition.</p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ReleaseService">ReleaseService</h3><p>ReleaseService manages releases for coordinating deployments.</p><table class="enum-table">@@ -28126,7 +28189,7 @@ Format: projects/{project}/releases/{release} </p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>GetRelease</td><td><a href="#bytebase.v1.GetReleaseRequest">GetReleaseRequest</a></td>@@ -28134,7 +28197,7 @@ Format: projects/{project}/releases/{release} </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>@@ -28142,7 +28205,7 @@ Permissions required: bb.releases.get</p></td><td><p>Lists releases in a project.Permissions required: bb.releases.list</p></td></tr>-+<tr><td>CreateRelease</td><td><a href="#bytebase.v1.CreateReleaseRequest">CreateReleaseRequest</a></td>@@ -28150,7 +28213,7 @@ Permissions required: bb.releases.list</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>@@ -28159,7 +28222,7 @@ Permissions required: bb.releases.create</p></td>Permissions required: bb.releases.updateWhen allow_missing=true, also requires: bb.releases.create</p></td></tr>-+<tr><td>DeleteRelease</td><td><a href="#bytebase.v1.DeleteReleaseRequest">DeleteReleaseRequest</a></td>@@ -28167,7 +28230,7 @@ When allow_missing=true, also requires: bb.releases.create</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>@@ -28175,7 +28238,7 @@ Permissions required: bb.releases.delete</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>@@ -28183,7 +28246,7 @@ Permissions required: bb.releases.undelete</p></td><td><p>Validates a release by dry-running checks on target databases.Permissions required: bb.releases.check</p></td></tr>-+<tr><td>ListReleaseCategories</td><td><a href="#bytebase.v1.ListReleaseCategoriesRequest">ListReleaseCategoriesRequest</a></td>@@ -28191,13 +28254,13 @@ Permissions required: bb.releases.check</p></td><td><p>Lists all unique categories in a project.Permissions required: bb.releases.list</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -28209,133 +28272,133 @@ Permissions required: bb.releases.list</p></td></tr></thead><tbody>---+++<tr><td>GetRelease</td><td>GET</td><td>/v1/{name=projects/*/releases/*}</td><td></td></tr>----++++<tr><td>ListReleases</td><td>GET</td><td>/v1/{parent=projects/*}/releases</td><td></td></tr>----++++<tr><td>CreateRelease</td><td>POST</td><td>/v1/{parent=projects/*}/releases</td><td>release</td></tr>----++++<tr><td>UpdateRelease</td><td>PATCH</td><td>/v1/{release.name=projects/*/releases/*}</td><td>release</td></tr>----++++<tr><td>DeleteRelease</td><td>DELETE</td><td>/v1/{name=projects/*/releases/*}</td><td></td></tr>----++++<tr><td>UndeleteRelease</td><td>POST</td><td>/v1/{name=projects/*/releases/*}:undelete</td><td></td></tr>----++++<tr><td>CheckRelease</td><td>POST</td><td>/v1/{parent=projects/*}/releases:check</td><td>*</td></tr>----++++<tr><td>ListReleaseCategories</td><td>GET</td><td>/v1/{parent=projects/*}/releases:listCategories</td><td></td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/review_config_service.proto">v1/review_config_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.CreateReviewConfigRequest">CreateReviewConfigRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>review_config</td><td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td><td></td><td><p>The SQL review config to create. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DeleteReviewConfigRequest">DeleteReviewConfigRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -28343,24 +28406,24 @@ Permissions required: bb.releases.list</p></td><td><p>The name of the SQL review config to delete.Format: reviewConfigs/{reviewConfig} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetReviewConfigRequest">GetReviewConfigRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -28368,55 +28431,55 @@ Format: reviewConfigs/{reviewConfig} </p></td><td><p>The name of the SQL review config to retrieve.Format: reviewConfigs/{reviewConfig} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListReviewConfigsRequest">ListReviewConfigsRequest</h3><p></p>---+++<h3 id="bytebase.v1.ListReviewConfigsResponse">ListReviewConfigsResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>review_configs</td><td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td><td>repeated</td><td><p>The SQL review configs from the specified request. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ReviewConfig">ReviewConfig</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -28424,28 +28487,28 @@ Format: reviewConfigs/{reviewConfig} </p></td><td><p>The name of the SQL review config.Format: reviewConfigs/{reviewConfig} </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>The title of the review configuration. </p></td></tr>-+<tr><td>enabled</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether the review configuration is enabled. </p></td></tr>-+<tr><td>rules</td><td><a href="#bytebase.v1.SQLReviewRule">SQLReviewRule</a></td><td>repeated</td><td><p>The SQL review rules to enforce. </p></td></tr>-+<tr><td>resources</td><td><a href="#string">string</a></td>@@ -28453,262 +28516,262 @@ Format: reviewConfigs/{reviewConfig} </p></td><td><p>Resources using the config.Format: {resource}/{resource id}, e.g., environments/test. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SQLReviewRule">SQLReviewRule</h3><p>SQL review rule configuration. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>type</td><td><a href="#bytebase.v1.SQLReviewRule.Type">SQLReviewRule.Type</a></td><td></td><td><p>The type of SQL review rule. </p></td></tr>-+<tr><td>level</td><td><a href="#bytebase.v1.SQLReviewRule.Level">SQLReviewRule.Level</a></td><td></td><td><p>The severity level of the rule. </p></td></tr>-+<tr><td>naming_payload</td><td><a href="#bytebase.v1.SQLReviewRule.NamingRulePayload">SQLReviewRule.NamingRulePayload</a></td><td></td><td><p> </p></td></tr>-+<tr><td>number_payload</td><td><a href="#bytebase.v1.SQLReviewRule.NumberRulePayload">SQLReviewRule.NumberRulePayload</a></td><td></td><td><p> </p></td></tr>-+<tr><td>string_array_payload</td><td><a href="#bytebase.v1.SQLReviewRule.StringArrayRulePayload">SQLReviewRule.StringArrayRulePayload</a></td><td></td><td><p> </p></td></tr>-+<tr><td>comment_convention_payload</td><td><a href="#bytebase.v1.SQLReviewRule.CommentConventionRulePayload">SQLReviewRule.CommentConventionRulePayload</a></td><td></td><td><p> </p></td></tr>-+<tr><td>string_payload</td><td><a href="#bytebase.v1.SQLReviewRule.StringRulePayload">SQLReviewRule.StringRulePayload</a></td><td></td><td><p> </p></td></tr>-+<tr><td>naming_case_payload</td><td><a href="#bytebase.v1.SQLReviewRule.NamingCaseRulePayload">SQLReviewRule.NamingCaseRulePayload</a></td><td></td><td><p> </p></td></tr>-+<tr><td>engine</td><td><a href="#bytebase.v1.Engine">Engine</a></td><td></td><td><p>The database engine this rule applies to. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SQLReviewRule.CommentConventionRulePayload">SQLReviewRule.CommentConventionRulePayload</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>required</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>max_length</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SQLReviewRule.NamingCaseRulePayload">SQLReviewRule.NamingCaseRulePayload</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>upper</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SQLReviewRule.NamingRulePayload">SQLReviewRule.NamingRulePayload</h3><p>Payload message types for SQL review rules</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>max_length</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>format</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SQLReviewRule.NumberRulePayload">SQLReviewRule.NumberRulePayload</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>number</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SQLReviewRule.StringArrayRulePayload">SQLReviewRule.StringArrayRulePayload</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>list</td><td><a href="#string">string</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SQLReviewRule.StringRulePayload">SQLReviewRule.StringRulePayload</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>value</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdateReviewConfigRequest">UpdateReviewConfigRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>review_config</td><td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>@@ -28717,14 +28780,14 @@ Format: {resource}/{resource id}, e.g., environments/test. </p></td>The name field is used to identify the SQL review config to update. </p></td></tr>-+<tr><td>update_mask</td><td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td><td></td><td><p>The list of fields to update. </p></td></tr>-+<tr><td>allow_missing</td><td><a href="#bool">bool</a></td>@@ -28732,16 +28795,16 @@ The name field is used to identify the SQL review config to update. </p></td><td><p>If set to true, and the config is not found, a new config will be created.In this situation, `update_mask` is ignored. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.SQLReviewRule.Level">SQLReviewRule.Level</h3><p>The severity level for SQL review rules.</p><table class="enum-table">@@ -28749,28 +28812,28 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>LEVEL_UNSPECIFIED</td><td>0</td><td><p>Unspecified level.</p></td></tr>-+<tr><td>ERROR</td><td>1</td><td><p>Rule violation is an error.</p></td></tr>-+<tr><td>WARNING</td><td>2</td><td><p>Rule violation is a warning.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.SQLReviewRule.Type">SQLReviewRule.Type</h3><p></p><table class="enum-table">@@ -28778,686 +28841,686 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>ENGINE_MYSQL_USE_INNODB</td><td>1</td><td><p></p></td></tr>-+<tr><td>NAMING_FULLY_QUALIFIED</td><td>2</td><td><p></p></td></tr>-+<tr><td>NAMING_TABLE</td><td>3</td><td><p></p></td></tr>-+<tr><td>NAMING_COLUMN</td><td>4</td><td><p></p></td></tr>-+<tr><td>NAMING_INDEX_PK</td><td>5</td><td><p></p></td></tr>-+<tr><td>NAMING_INDEX_UK</td><td>6</td><td><p></p></td></tr>-+<tr><td>NAMING_INDEX_FK</td><td>7</td><td><p></p></td></tr>-+<tr><td>NAMING_INDEX_IDX</td><td>8</td><td><p></p></td></tr>-+<tr><td>NAMING_COLUMN_AUTO_INCREMENT</td><td>9</td><td><p></p></td></tr>-+<tr><td>NAMING_TABLE_NO_KEYWORD</td><td>10</td><td><p></p></td></tr>-+<tr><td>NAMING_IDENTIFIER_NO_KEYWORD</td><td>11</td><td><p></p></td></tr>-+<tr><td>NAMING_IDENTIFIER_CASE</td><td>12</td><td><p></p></td></tr>-+<tr><td>STATEMENT_SELECT_NO_SELECT_ALL</td><td>13</td><td><p></p></td></tr>-+<tr><td>STATEMENT_WHERE_REQUIRE_SELECT</td><td>14</td><td><p></p></td></tr>-+<tr><td>STATEMENT_WHERE_REQUIRE_UPDATE_DELETE</td><td>15</td><td><p></p></td></tr>-+<tr><td>STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE</td><td>16</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_ON_DEL_CASCADE</td><td>17</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_RM_TBL_CASCADE</td><td>18</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_COMMIT</td><td>19</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_LIMIT</td><td>20</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_ORDER_BY</td><td>21</td><td><p></p></td></tr>-+<tr><td>STATEMENT_MERGE_ALTER_TABLE</td><td>22</td><td><p></p></td></tr>-+<tr><td>STATEMENT_INSERT_ROW_LIMIT</td><td>23</td><td><p></p></td></tr>-+<tr><td>STATEMENT_INSERT_MUST_SPECIFY_COLUMN</td><td>24</td><td><p></p></td></tr>-+<tr><td>STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND</td><td>25</td><td><p></p></td></tr>-+<tr><td>STATEMENT_AFFECTED_ROW_LIMIT</td><td>26</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DML_DRY_RUN</td><td>27</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_ADD_COLUMN_WITH_DEFAULT</td><td>28</td><td><p></p></td></tr>-+<tr><td>STATEMENT_ADD_CHECK_NOT_VALID</td><td>29</td><td><p></p></td></tr>-+<tr><td>STATEMENT_ADD_FOREIGN_KEY_NOT_VALID</td><td>30</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_ADD_NOT_NULL</td><td>31</td><td><p></p></td></tr>-+<tr><td>STATEMENT_SELECT_FULL_TABLE_SCAN</td><td>32</td><td><p></p></td></tr>-+<tr><td>STATEMENT_CREATE_SPECIFY_SCHEMA</td><td>33</td><td><p></p></td></tr>-+<tr><td>STATEMENT_CHECK_SET_ROLE_VARIABLE</td><td>34</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_USING_FILESORT</td><td>35</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_USING_TEMPORARY</td><td>36</td><td><p></p></td></tr>-+<tr><td>STATEMENT_WHERE_NO_EQUAL_NULL</td><td>37</td><td><p></p></td></tr>-+<tr><td>STATEMENT_WHERE_DISALLOW_FUNCTIONS_AND_CALCULATIONS</td><td>38</td><td><p></p></td></tr>-+<tr><td>STATEMENT_QUERY_MINIMUM_PLAN_LEVEL</td><td>39</td><td><p></p></td></tr>-+<tr><td>STATEMENT_WHERE_MAXIMUM_LOGICAL_OPERATOR_COUNT</td><td>40</td><td><p></p></td></tr>-+<tr><td>STATEMENT_MAXIMUM_LIMIT_VALUE</td><td>41</td><td><p></p></td></tr>-+<tr><td>STATEMENT_MAXIMUM_JOIN_TABLE_COUNT</td><td>42</td><td><p></p></td></tr>-+<tr><td>STATEMENT_MAXIMUM_STATEMENTS_IN_TRANSACTION</td><td>43</td><td><p></p></td></tr>-+<tr><td>STATEMENT_JOIN_STRICT_COLUMN_ATTRS</td><td>44</td><td><p></p></td></tr>-+<tr><td>STATEMENT_NON_TRANSACTIONAL</td><td>45</td><td><p></p></td></tr>-+<tr><td>STATEMENT_ADD_COLUMN_WITHOUT_POSITION</td><td>46</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_OFFLINE_DDL</td><td>47</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_CROSS_DB_QUERIES</td><td>48</td><td><p></p></td></tr>-+<tr><td>STATEMENT_MAX_EXECUTION_TIME</td><td>49</td><td><p></p></td></tr>-+<tr><td>STATEMENT_REQUIRE_ALGORITHM_OPTION</td><td>50</td><td><p></p></td></tr>-+<tr><td>STATEMENT_REQUIRE_LOCK_OPTION</td><td>51</td><td><p></p></td></tr>-+<tr><td>STATEMENT_OBJECT_OWNER_CHECK</td><td>52</td><td><p></p></td></tr>-+<tr><td>TABLE_REQUIRE_PK</td><td>53</td><td><p></p></td></tr>-+<tr><td>TABLE_NO_FOREIGN_KEY</td><td>54</td><td><p></p></td></tr>-+<tr><td>TABLE_DROP_NAMING_CONVENTION</td><td>55</td><td><p></p></td></tr>-+<tr><td>TABLE_COMMENT</td><td>56</td><td><p></p></td></tr>-+<tr><td>TABLE_DISALLOW_PARTITION</td><td>57</td><td><p></p></td></tr>-+<tr><td>TABLE_DISALLOW_TRIGGER</td><td>58</td><td><p></p></td></tr>-+<tr><td>TABLE_NO_DUPLICATE_INDEX</td><td>59</td><td><p></p></td></tr>-+<tr><td>TABLE_TEXT_FIELDS_TOTAL_LENGTH</td><td>60</td><td><p></p></td></tr>-+<tr><td>TABLE_DISALLOW_SET_CHARSET</td><td>61</td><td><p></p></td></tr>-+<tr><td>TABLE_DISALLOW_DDL</td><td>62</td><td><p></p></td></tr>-+<tr><td>TABLE_DISALLOW_DML</td><td>63</td><td><p></p></td></tr>-+<tr><td>TABLE_LIMIT_SIZE</td><td>64</td><td><p></p></td></tr>-+<tr><td>TABLE_REQUIRE_CHARSET</td><td>65</td><td><p></p></td></tr>-+<tr><td>TABLE_REQUIRE_COLLATION</td><td>66</td><td><p></p></td></tr>-+<tr><td>COLUMN_REQUIRED</td><td>67</td><td><p></p></td></tr>-+<tr><td>COLUMN_NO_NULL</td><td>68</td><td><p></p></td></tr>-+<tr><td>COLUMN_DISALLOW_CHANGE_TYPE</td><td>69</td><td><p></p></td></tr>-+<tr><td>COLUMN_SET_DEFAULT_FOR_NOT_NULL</td><td>70</td><td><p></p></td></tr>-+<tr><td>COLUMN_DISALLOW_CHANGE</td><td>71</td><td><p></p></td></tr>-+<tr><td>COLUMN_DISALLOW_CHANGING_ORDER</td><td>72</td><td><p></p></td></tr>-+<tr><td>COLUMN_DISALLOW_DROP</td><td>73</td><td><p></p></td></tr>-+<tr><td>COLUMN_DISALLOW_DROP_IN_INDEX</td><td>74</td><td><p></p></td></tr>-+<tr><td>COLUMN_COMMENT</td><td>75</td><td><p></p></td></tr>-+<tr><td>COLUMN_AUTO_INCREMENT_MUST_INTEGER</td><td>76</td><td><p></p></td></tr>-+<tr><td>COLUMN_TYPE_DISALLOW_LIST</td><td>77</td><td><p></p></td></tr>-+<tr><td>COLUMN_DISALLOW_SET_CHARSET</td><td>78</td><td><p></p></td></tr>-+<tr><td>COLUMN_MAXIMUM_CHARACTER_LENGTH</td><td>79</td><td><p></p></td></tr>-+<tr><td>COLUMN_MAXIMUM_VARCHAR_LENGTH</td><td>80</td><td><p></p></td></tr>-+<tr><td>COLUMN_AUTO_INCREMENT_INITIAL_VALUE</td><td>81</td><td><p></p></td></tr>-+<tr><td>COLUMN_AUTO_INCREMENT_MUST_UNSIGNED</td><td>82</td><td><p></p></td></tr>-+<tr><td>COLUMN_CURRENT_TIME_COUNT_LIMIT</td><td>83</td><td><p></p></td></tr>-+<tr><td>COLUMN_REQUIRE_DEFAULT</td><td>84</td><td><p></p></td></tr>-+<tr><td>COLUMN_DEFAULT_DISALLOW_VOLATILE</td><td>85</td><td><p></p></td></tr>-+<tr><td>COLUMN_ADD_NOT_NULL_REQUIRE_DEFAULT</td><td>86</td><td><p></p></td></tr>-+<tr><td>COLUMN_REQUIRE_CHARSET</td><td>87</td><td><p></p></td></tr>-+<tr><td>COLUMN_REQUIRE_COLLATION</td><td>88</td><td><p></p></td></tr>-+<tr><td>SCHEMA_BACKWARD_COMPATIBILITY</td><td>89</td><td><p></p></td></tr>-+<tr><td>DATABASE_DROP_EMPTY_DATABASE</td><td>90</td><td><p></p></td></tr>-+<tr><td>INDEX_NO_DUPLICATE_COLUMN</td><td>91</td><td><p></p></td></tr>-+<tr><td>INDEX_KEY_NUMBER_LIMIT</td><td>92</td><td><p></p></td></tr>-+<tr><td>INDEX_PK_TYPE_LIMIT</td><td>93</td><td><p></p></td></tr>-+<tr><td>INDEX_TYPE_NO_BLOB</td><td>94</td><td><p></p></td></tr>-+<tr><td>INDEX_TOTAL_NUMBER_LIMIT</td><td>95</td><td><p></p></td></tr>-+<tr><td>INDEX_PRIMARY_KEY_TYPE_ALLOWLIST</td><td>96</td><td><p></p></td></tr>-+<tr><td>INDEX_CREATE_CONCURRENTLY</td><td>97</td><td><p></p></td></tr>-+<tr><td>INDEX_TYPE_ALLOW_LIST</td><td>98</td><td><p></p></td></tr>-+<tr><td>INDEX_NOT_REDUNDANT</td><td>99</td><td><p></p></td></tr>-+<tr><td>SYSTEM_CHARSET_ALLOWLIST</td><td>100</td><td><p></p></td></tr>-+<tr><td>SYSTEM_COLLATION_ALLOWLIST</td><td>101</td><td><p></p></td></tr>-+<tr><td>SYSTEM_COMMENT_LENGTH</td><td>102</td><td><p></p></td></tr>-+<tr><td>SYSTEM_PROCEDURE_DISALLOW_CREATE</td><td>103</td><td><p></p></td></tr>-+<tr><td>SYSTEM_EVENT_DISALLOW_CREATE</td><td>104</td><td><p></p></td></tr>-+<tr><td>SYSTEM_VIEW_DISALLOW_CREATE</td><td>105</td><td><p></p></td></tr>-+<tr><td>SYSTEM_FUNCTION_DISALLOW_CREATE</td><td>106</td><td><p></p></td></tr>-+<tr><td>SYSTEM_FUNCTION_DISALLOWED_LIST</td><td>107</td><td><p></p></td></tr>-+<tr><td>ADVICE_ONLINE_MIGRATION</td><td>108</td><td><p></p></td></tr>-+<tr><td>BUILTIN_PRIOR_BACKUP_CHECK</td><td>109</td><td><p></p></td></tr>-+<tr><td>BUILTIN_WALK_THROUGH_CHECK</td><td>110</td><td><p></p></td></tr>-+<tr><td>STATEMENT_DISALLOW_TRUNCATE</td><td>111</td><td><p></p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ReviewConfigService">ReviewConfigService</h3><p>ReviewConfigService manages approval flow configurations.</p><table class="enum-table">@@ -29465,7 +29528,7 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>CreateReviewConfig</td><td><a href="#bytebase.v1.CreateReviewConfigRequest">CreateReviewConfigRequest</a></td>@@ -29473,7 +29536,7 @@ In this situation, `update_mask` is ignored. </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>@@ -29481,7 +29544,7 @@ Permissions required: bb.reviewConfigs.create</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>@@ -29489,7 +29552,7 @@ Permissions required: bb.reviewConfigs.list</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>@@ -29498,7 +29561,7 @@ Permissions required: bb.reviewConfigs.get</p></td>Permissions required: bb.reviewConfigs.updateWhen allow_missing=true, also requires: bb.reviewConfigs.create</p></td></tr>-+<tr><td>DeleteReviewConfig</td><td><a href="#bytebase.v1.DeleteReviewConfigRequest">DeleteReviewConfigRequest</a></td>@@ -29506,13 +29569,13 @@ When allow_missing=true, also requires: bb.reviewConfigs.create</p></td><td><p>Deletes a SQL review configuration.Permissions required: bb.reviewConfigs.delete</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -29524,79 +29587,79 @@ Permissions required: bb.reviewConfigs.delete</p></td></tr></thead><tbody>---+++<tr><td>CreateReviewConfig</td><td>POST</td><td>/v1/reviewConfigs</td><td>review_config</td></tr>----++++<tr><td>ListReviewConfigs</td><td>GET</td><td>/v1/reviewConfigs</td><td></td></tr>----++++<tr><td>GetReviewConfig</td><td>GET</td><td>/v1/{name=reviewConfigs/*}</td><td></td></tr>----++++<tr><td>UpdateReviewConfig</td><td>PATCH</td><td>/v1/{review_config.name=reviewConfigs/*}</td><td>review_config</td></tr>----++++<tr><td>DeleteReviewConfig</td><td>DELETE</td><td>/v1/{name=reviewConfigs/*}</td><td></td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/revision_service.proto">v1/revision_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.BatchCreateRevisionsRequest">BatchCreateRevisionsRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -29604,7 +29667,7 @@ Permissions required: bb.reviewConfigs.delete</p></td><td><p>The parent resource shared by all revisions being created.Format: instances/{instance}/databases/{database} </p></td></tr>-+<tr><td>requests</td><td><a href="#bytebase.v1.CreateRevisionRequest">CreateRevisionRequest</a></td>@@ -29612,79 +29675,79 @@ Format: instances/{instance}/databases/{database} </p></td><td><p>The request message specifying the revisions to create.A maximum of 100 revisions can be created in a batch. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BatchCreateRevisionsResponse">BatchCreateRevisionsResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>revisions</td><td><a href="#bytebase.v1.Revision">Revision</a></td><td>repeated</td><td><p>The created revisions. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.CreateRevisionRequest">CreateRevisionRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td><td></td><td><p>Format: instances/{instance}/databases/{database} </p></td></tr>-+<tr><td>revision</td><td><a href="#bytebase.v1.Revision">Revision</a></td><td></td><td><p>The revision to create. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DeleteRevisionRequest">DeleteRevisionRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -29692,24 +29755,24 @@ A maximum of 100 revisions can be created in a batch. </p></td><td><p>The name of the revision to delete.Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetRevisionRequest">GetRevisionRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -29717,24 +29780,24 @@ Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td><td><p>The name of the revision.Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListRevisionsRequest">ListRevisionsRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -29742,7 +29805,7 @@ Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td><td><p>The parent of the revisions.Format: instances/{instance}/databases/{database} </p></td></tr>-+<tr><td>page_size</td><td><a href="#int32">int32</a></td>@@ -29751,7 +29814,7 @@ Format: instances/{instance}/databases/{database} </p></td>than this value. If unspecified, at most 10 revisions will be returned. Themaximum value is 1000; values above 1000 will be coerced to 1000. </p></td></tr>-+<tr><td>page_token</td><td><a href="#string">string</a></td>@@ -29762,38 +29825,38 @@ Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `ListRevisions` mustmatch the call that provided the page token. </p></td></tr>-+<tr><td>show_deleted</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether to include deleted revisions in the results. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListRevisionsResponse">ListRevisionsResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>revisions</td><td><a href="#bytebase.v1.Revision">Revision</a></td><td>repeated</td><td><p>The revisions from the specified request. </p></td></tr>-+<tr><td>next_page_token</td><td><a href="#string">string</a></td>@@ -29801,31 +29864,31 @@ match the call that provided the page token. </p></td><td><p>A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Revision">Revision</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td></tr>-+<tr><td>release</td><td><a href="#string">string</a></td>@@ -29833,14 +29896,14 @@ If this field is omitted, there are no subsequent pages. </p></td><td><p>Format: projects/{project}/releases/{release}Can be empty. </p></td></tr>-+<tr><td>create_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>deleter</td><td><a href="#string">string</a></td>@@ -29848,14 +29911,14 @@ Can be empty. </p></td><td><p>Format: users/[email protected]Can be empty. </p></td></tr>-+<tr><td>delete_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p>Can be empty. </p></td></tr>-+<tr><td>file</td><td><a href="#string">string</a></td>@@ -29864,14 +29927,14 @@ Can be empty. </p></td>The file_path segment is URL-encoded since file paths may contain "/".Can be empty. </p></td></tr>-+<tr><td>version</td><td><a href="#string">string</a></td><td></td><td><p>The schema version string for this revision. </p></td></tr>-+<tr><td>sheet</td><td><a href="#string">string</a></td>@@ -29879,14 +29942,14 @@ Can be empty. </p></td><td><p>The sheet that holds the content.Format: projects/{project}/sheets/{sheet} </p></td></tr>-+<tr><td>sheet_sha256</td><td><a href="#string">string</a></td><td></td><td><p>The SHA256 hash value of the sheet. </p></td></tr>-+<tr><td>task_run</td><td><a href="#string">string</a></td>@@ -29895,23 +29958,23 @@ Format: projects/{project}/sheets/{sheet} </p></td>Can be empty.Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.v1.Revision.Type">Revision.Type</a></td><td></td><td><p>The type of the revision. </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.Revision.Type">Revision.Type</h3><p>The type of schema revision.</p><table class="enum-table">@@ -29919,32 +29982,32 @@ Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/task<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p>Unspecified type.</p></td></tr>-+<tr><td>VERSIONED</td><td>1</td><td><p>Versioned schema migration.</p></td></tr>-+<tr><td>DECLARATIVE</td><td>2</td><td><p>Declarative schema definition.</p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.RevisionService">RevisionService</h3><p>RevisionService manages schema revision history.</p><table class="enum-table">@@ -29952,7 +30015,7 @@ Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/task<tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>ListRevisions</td><td><a href="#bytebase.v1.ListRevisionsRequest">ListRevisionsRequest</a></td>@@ -29960,7 +30023,7 @@ Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/task<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>@@ -29968,7 +30031,7 @@ Permissions required: bb.revisions.list</p></td><td><p>Retrieves a schema revision by name.Permissions required: bb.revisions.get</p></td></tr>-+<tr><td>BatchCreateRevisions</td><td><a href="#bytebase.v1.BatchCreateRevisionsRequest">BatchCreateRevisionsRequest</a></td>@@ -29976,7 +30039,7 @@ Permissions required: bb.revisions.get</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>@@ -29984,13 +30047,13 @@ Permissions required: bb.revisions.create</p></td><td><p>Deletes a schema revision.Permissions required: bb.revisions.delete</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -30002,76 +30065,76 @@ Permissions required: bb.revisions.delete</p></td></tr></thead><tbody>---+++<tr><td>ListRevisions</td><td>GET</td><td>/v1/{parent=instances/*/databases/*}/revisions</td><td></td></tr>----++++<tr><td>GetRevision</td><td>GET</td><td>/v1/{name=instances/*/databases/*/revisions/*}</td><td></td></tr>----++++<tr><td>BatchCreateRevisions</td><td>POST</td><td>/v1/{parent=instances/*/databases/*}/revisions:batchCreate</td><td>*</td></tr>----++++<tr><td>DeleteRevision</td><td>DELETE</td><td>/v1/{name=instances/*/databases/*/revisions/*}</td><td></td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/role_service.proto">v1/role_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.CreateRoleRequest">CreateRoleRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>role</td><td><a href="#bytebase.v1.Role">Role</a></td><td></td><td><p>The role to create. </p></td></tr>-+<tr><td>role_id</td><td><a href="#string">string</a></td>@@ -30082,24 +30145,24 @@ of the role's resource name.This value should be 4-63 characters, and valid charactersare /[a-z][A-Z][0-9]/. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DeleteRoleRequest">DeleteRoleRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -30107,24 +30170,24 @@ are /[a-z][A-Z][0-9]/. </p></td><td><p>The name of the role to delete.Format: roles/{role} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetRoleRequest">GetRoleRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -30132,121 +30195,121 @@ Format: roles/{role} </p></td><td><p>The name of the role to retrieve.Format: roles/{role} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListRolesRequest">ListRolesRequest</h3><p></p>---+++<h3 id="bytebase.v1.ListRolesResponse">ListRolesResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>roles</td><td><a href="#bytebase.v1.Role">Role</a></td><td>repeated</td><td><p>The roles from the specified request. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Role">Role</h3><p>Role defines a set of permissions that can be assigned to users.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>Resource name. Format: roles/{role} </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>Human-readable title. </p></td></tr>-+<tr><td>description</td><td><a href="#string">string</a></td><td></td><td><p>Optional description of the role. </p></td></tr>-+<tr><td>permissions</td><td><a href="#string">string</a></td><td>repeated</td><td><p>List of permission identifiers granted by this role. </p></td></tr>-+<tr><td>type</td><td><a href="#bytebase.v1.Role.Type">Role.Type</a></td><td></td><td><p>Role type indicating if it's built-in or custom. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdateRoleRequest">UpdateRoleRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>role</td><td><a href="#bytebase.v1.Role">Role</a></td><td></td><td><p>The role to update. </p></td></tr>-+<tr><td>update_mask</td><td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td><td></td><td><p>The list of fields to update. </p></td></tr>-+<tr><td>allow_missing</td><td><a href="#bool">bool</a></td>@@ -30254,16 +30317,16 @@ Format: roles/{role} </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></table>----++++<h3 id="bytebase.v1.Role.Type">Role.Type</h3><p></p><table class="enum-table">@@ -30271,32 +30334,32 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>BUILT_IN</td><td>1</td><td><p>System-defined role that cannot be modified.</p></td></tr>-+<tr><td>CUSTOM</td><td>2</td><td><p>User-defined role that can be modified.</p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.RoleService">RoleService</h3><p>RoleService manages workspace roles and permissions.</p><table class="enum-table">@@ -30304,7 +30367,7 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>ListRoles</td><td><a href="#bytebase.v1.ListRolesRequest">ListRolesRequest</a></td>@@ -30312,7 +30375,7 @@ In this situation, `update_mask` is ignored. </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>@@ -30320,7 +30383,7 @@ Permissions required: bb.roles.list</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>@@ -30328,7 +30391,7 @@ Permissions required: bb.roles.get</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>@@ -30337,7 +30400,7 @@ Permissions required: bb.roles.create</p></td>Permissions required: bb.roles.updateWhen allow_missing=true, also requires: bb.roles.create</p></td></tr>-+<tr><td>DeleteRole</td><td><a href="#bytebase.v1.DeleteRoleRequest">DeleteRoleRequest</a></td>@@ -30345,13 +30408,13 @@ When allow_missing=true, also requires: bb.roles.create</p></td><td><p>Deletes a custom role.Permissions required: bb.roles.delete</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -30363,79 +30426,79 @@ Permissions required: bb.roles.delete</p></td></tr></thead><tbody>---+++<tr><td>ListRoles</td><td>GET</td><td>/v1/roles</td><td></td></tr>----++++<tr><td>GetRole</td><td>GET</td><td>/v1/{name=roles/*}</td><td></td></tr>----++++<tr><td>CreateRole</td><td>POST</td><td>/v1/roles</td><td>role</td></tr>----++++<tr><td>UpdateRole</td><td>PATCH</td><td>/v1/{role.name=roles/*}</td><td>role</td></tr>----++++<tr><td>DeleteRole</td><td>DELETE</td><td>/v1/{name=roles/*}</td><td></td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/service_account_service.proto">v1/service_account_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.CreateServiceAccountRequest">CreateServiceAccountRequest</h3><p>Request message for creating a service account.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -30443,7 +30506,7 @@ Permissions required: bb.roles.delete</p></td><td><p>The parent resource where this service account will be created.Format: projects/{project} for project-level, workspaces/{id} for workspace-level. </p></td></tr>-+<tr><td>service_account_id</td><td><a href="#string">string</a></td>@@ -30452,31 +30515,31 @@ Format: projects/{project} for project-level, workspaces/{id} for workspace-leveof the service account's email in the format: {service_account_id}@service.bytebase.comor {service_account_id}@{project-id}.service.bytebase.com </p></td></tr>-+<tr><td>service_account</td><td><a href="#bytebase.v1.ServiceAccount">ServiceAccount</a></td><td></td><td><p>The service account to create. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DeleteServiceAccountRequest">DeleteServiceAccountRequest</h3><p>Request message for deleting a service account.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -30484,24 +30547,24 @@ or {service_account_id}@{project-id}.service.bytebase.com </p></td><td><p>The name of the service account to delete.Format: serviceAccounts/{email} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetServiceAccountRequest">GetServiceAccountRequest</h3><p>Request message for getting a service account.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -30509,24 +30572,24 @@ Format: serviceAccounts/{email} </p></td><td><p>The name of the service account to retrieve.Format: serviceAccounts/{email} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListServiceAccountsRequest">ListServiceAccountsRequest</h3><p>Request message for listing service accounts.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -30534,7 +30597,7 @@ Format: serviceAccounts/{email} </p></td><td><p>The parent resource.Format: projects/{project} for project-level, workspaces/{id} for workspace-level. </p></td></tr>-+<tr><td>page_size</td><td><a href="#int32">int32</a></td>@@ -30544,7 +30607,7 @@ this value.If unspecified, at most 10 service accounts will be returned.The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td></tr>-+<tr><td>page_token</td><td><a href="#string">string</a></td>@@ -30555,14 +30618,14 @@ Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `ListServiceAccounts` must matchthe call that provided the page token. </p></td></tr>-+<tr><td>show_deleted</td><td><a href="#bool">bool</a></td><td></td><td><p>Show deleted service accounts if specified. </p></td></tr>-+<tr><td>filter</td><td><a href="#string">string</a></td>@@ -30582,31 +30645,31 @@ state == "DELETED"email == "[email protected]"email.contains("ed") </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListServiceAccountsResponse">ListServiceAccountsResponse</h3><p>Response message for listing service accounts.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>service_accounts</td><td><a href="#bytebase.v1.ServiceAccount">ServiceAccount</a></td><td>repeated</td><td><p>The service accounts from the specified request. </p></td></tr>-+<tr><td>next_page_token</td><td><a href="#string">string</a></td>@@ -30614,24 +30677,24 @@ email.contains("ed") </p></td><td><p>A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ServiceAccount">ServiceAccount</h3><p>ServiceAccount represents an API integration account.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -30639,14 +30702,14 @@ If this field is omitted, there are no subsequent pages. </p></td><td><p>The name of the service account.Format: serviceAccounts/{email} </p></td></tr>-+<tr><td>state</td><td><a href="#bytebase.v1.State">State</a></td><td></td><td><p>The state of the service account. </p></td></tr>-+<tr><td>email</td><td><a href="#string">string</a></td>@@ -30655,45 +30718,45 @@ Format: serviceAccounts/{email} </p></td>For workspace-level: {name}@service.bytebase.comFor project-level: {name}@{project-id}.service.bytebase.com </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>The display title of the service account. </p></td></tr>-+<tr><td>service_key</td><td><a href="#string">string</a></td><td></td><td><p>The service key for authentication. Only returned on creation or key rotation. </p></td></tr>-+<tr><td>create_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p>The timestamp when the service account was created. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UndeleteServiceAccountRequest">UndeleteServiceAccountRequest</h3><p>Request message for restoring a deleted service account.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -30701,24 +30764,24 @@ For project-level: {name}@{project-id}.service.bytebase.com </p></td><td><p>The name of the deleted service account.Format: serviceAccounts/{email} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdateServiceAccountRequest">UpdateServiceAccountRequest</h3><p>Request message for updating a service account.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>service_account</td><td><a href="#bytebase.v1.ServiceAccount">ServiceAccount</a></td>@@ -30728,7 +30791,7 @@ Format: serviceAccounts/{email} </p></td>The service account's `name` field is used to identify the service account to update.Format: serviceAccounts/{email} </p></td></tr>-+<tr><td>update_mask</td><td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>@@ -30736,20 +30799,20 @@ Format: serviceAccounts/{email} </p></td><td><p>The list of fields to update.Supported fields: title, service_key (triggers key rotation) </p></td></tr>-+</tbody></table>------++++++<h3 id="bytebase.v1.ServiceAccountService">ServiceAccountService</h3><p>ServiceAccountService manages service accounts for API integrations.</p><table class="enum-table">@@ -30757,7 +30820,7 @@ Supported fields: title, service_key (triggers key rotation) </p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>CreateServiceAccount</td><td><a href="#bytebase.v1.CreateServiceAccountRequest">CreateServiceAccountRequest</a></td>@@ -30766,7 +30829,7 @@ Supported fields: title, service_key (triggers key rotation) </p></td>For workspace-level: parent is workspaces/{id}, permission bb.serviceAccounts.create on workspace.For project-level: parent is projects/{project}, permission bb.serviceAccounts.create on project.</p></td></tr>-+<tr><td>GetServiceAccount</td><td><a href="#bytebase.v1.GetServiceAccountRequest">GetServiceAccountRequest</a></td>@@ -30774,7 +30837,7 @@ For project-level: parent is projects/{project}, permission bb.serviceAccounts.c<td><p>Gets a service account by name.Permissions required: bb.serviceAccounts.get</p></td></tr>-+<tr><td>ListServiceAccounts</td><td><a href="#bytebase.v1.ListServiceAccountsRequest">ListServiceAccountsRequest</a></td>@@ -30783,7 +30846,7 @@ Permissions required: bb.serviceAccounts.get</p></td>For workspace-level: parent is workspaces/{id}, permission bb.serviceAccounts.list on workspace.For project-level: parent is projects/{project}, permission bb.serviceAccounts.list on project.</p></td></tr>-+<tr><td>UpdateServiceAccount</td><td><a href="#bytebase.v1.UpdateServiceAccountRequest">UpdateServiceAccountRequest</a></td>@@ -30791,7 +30854,7 @@ For project-level: parent is projects/{project}, permission bb.serviceAccounts.l<td><p>Updates a service account.Permissions required: bb.serviceAccounts.update</p></td></tr>-+<tr><td>DeleteServiceAccount</td><td><a href="#bytebase.v1.DeleteServiceAccountRequest">DeleteServiceAccountRequest</a></td>@@ -30799,7 +30862,7 @@ Permissions required: bb.serviceAccounts.update</p></td><td><p>Deletes a service account.Permissions required: bb.serviceAccounts.delete</p></td></tr>-+<tr><td>UndeleteServiceAccount</td><td><a href="#bytebase.v1.UndeleteServiceAccountRequest">UndeleteServiceAccountRequest</a></td>@@ -30807,13 +30870,13 @@ Permissions required: bb.serviceAccounts.delete</p></td><td><p>Restores a deleted service account.Permissions required: bb.serviceAccounts.undelete</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -30825,103 +30888,103 @@ Permissions required: bb.serviceAccounts.undelete</p></td></tr></thead><tbody>---+++<tr><td>CreateServiceAccount</td><td>POST</td><td>/v1/{parent=projects/*}/serviceAccounts</td><td>service_account</td></tr>-+<tr><td>CreateServiceAccount</td><td>POST</td><td>/v1/{parent=workspaces/*}/serviceAccounts</td><td>service_account</td></tr>----++++<tr><td>GetServiceAccount</td><td>GET</td><td>/v1/{name=serviceAccounts/*}</td><td></td></tr>----++++<tr><td>ListServiceAccounts</td><td>GET</td><td>/v1/{parent=projects/*}/serviceAccounts</td><td></td></tr>-+<tr><td>ListServiceAccounts</td><td>GET</td><td>/v1/{parent=workspaces/*}/serviceAccounts</td><td></td></tr>----++++<tr><td>UpdateServiceAccount</td><td>PATCH</td><td>/v1/{service_account.name=serviceAccounts/*}</td><td>service_account</td></tr>----++++<tr><td>DeleteServiceAccount</td><td>DELETE</td><td>/v1/{name=serviceAccounts/*}</td><td></td></tr>----++++<tr><td>UndeleteServiceAccount</td><td>POST</td><td>/v1/{name=serviceAccounts/*}:undelete</td><td>*</td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/sheet_service.proto">v1/sheet_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.BatchCreateSheetsRequest">BatchCreateSheetsRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -30929,55 +30992,55 @@ Permissions required: bb.serviceAccounts.undelete</p></td><td><p>The parent resource where all sheets will be created.Format: projects/{project} </p></td></tr>-+<tr><td>requests</td><td><a href="#bytebase.v1.CreateSheetRequest">CreateSheetRequest</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BatchCreateSheetsResponse">BatchCreateSheetsResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>sheets</td><td><a href="#bytebase.v1.Sheet">Sheet</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.CreateSheetRequest">CreateSheetRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -30985,31 +31048,31 @@ Format: projects/{project} </p></td><td><p>The parent resource where this sheet will be created.Format: projects/{project} </p></td></tr>-+<tr><td>sheet</td><td><a href="#bytebase.v1.Sheet">Sheet</a></td><td></td><td><p>The sheet to create. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetSheetRequest">GetSheetRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -31017,31 +31080,31 @@ Format: projects/{project} </p></td><td><p>The name of the sheet to retrieve.Format: projects/{project}/sheets/{sheet} </p></td></tr>-+<tr><td>raw</td><td><a href="#bool">bool</a></td><td></td><td><p>By default, the content of the sheet is cut off, set the `raw` to true to retrieve the full content. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Sheet">Sheet</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -31050,7 +31113,7 @@ Format: projects/{project}/sheets/{sheet} </p></td>Format: projects/{project}/sheets/{sheet}The sheet ID is generated by the server on creation and cannot be changed. </p></td></tr>-+<tr><td>content</td><td><a href="#bytes">bytes</a></td>@@ -31059,27 +31122,27 @@ The sheet ID is generated by the server on creation and cannot be changed. </p><By default, it will be cut off, if it doesn't match the `content_size`, you canset the `raw` to true in GetSheet request to retrieve the full content. </p></td></tr>-+<tr><td>content_size</td><td><a href="#int64">int64</a></td><td></td><td><p>content_size is the full size of the content, may not match the size of the `content` field. </p></td></tr>-+</tbody></table>------++++++<h3 id="bytebase.v1.SheetService">SheetService</h3><p>SheetService manages SQL scripts and saved queries.</p><table class="enum-table">@@ -31087,7 +31150,7 @@ set the `raw` to true in GetSheet request to retrieve the full content. </p></td<tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>CreateSheet</td><td><a href="#bytebase.v1.CreateSheetRequest">CreateSheetRequest</a></td>@@ -31095,7 +31158,7 @@ set the `raw` to true in GetSheet request to retrieve the full content. </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>@@ -31103,7 +31166,7 @@ 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>@@ -31111,13 +31174,13 @@ Permissions required: bb.sheets.create</p></td><td><p>Retrieves a SQL sheet by name.Permissions required: bb.sheets.get</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -31129,443 +31192,443 @@ Permissions required: bb.sheets.get</p></td></tr></thead><tbody>---+++<tr><td>CreateSheet</td><td>POST</td><td>/v1/{parent=projects/*}/sheets</td><td>sheet</td></tr>----++++<tr><td>BatchCreateSheets</td><td>POST</td><td>/v1/{parent=projects/*}/sheets:batchCreate</td><td>*</td></tr>----++++<tr><td>GetSheet</td><td>GET</td><td>/v1/{name=projects/*/sheets/*}</td><td></td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/subscription_service.proto">v1/subscription_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.CancelPurchaseRequest">CancelPurchaseRequest</h3><p></p>---+++<h3 id="bytebase.v1.CreatePurchaseRequest">CreatePurchaseRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>plan</td><td><a href="#bytebase.v1.PlanType">PlanType</a></td><td></td><td><p> </p></td></tr>-+<tr><td>interval</td><td><a href="#bytebase.v1.BillingInterval">BillingInterval</a></td><td></td><td><p> </p></td></tr>-+<tr><td>seats</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetPaymentInfoRequest">GetPaymentInfoRequest</h3><p></p>---+++<h3 id="bytebase.v1.GetSubscriptionRequest">GetSubscriptionRequest</h3><p></p>---+++<h3 id="bytebase.v1.ListPurchasePlansRequest">ListPurchasePlansRequest</h3><p></p>---+++<h3 id="bytebase.v1.ListPurchasePlansResponse">ListPurchasePlansResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>plans</td><td><a href="#bytebase.v1.PurchasePlan">PurchasePlan</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.PaymentInfo">PaymentInfo</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>total_price</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>currency</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>period_start</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>period_end</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>invoice_url</td><td><a href="#string">string</a></td><td></td><td><p>Stripe Billing Portal URL for invoice management. </p></td></tr>-+<tr><td>cancel_at_period_end</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether the subscription is scheduled to cancel at the end of the current billing period. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.PlanConfig">PlanConfig</h3><p>PlanConfig represents the configuration for all plans loaded from plan.yaml</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>plans</td><td><a href="#bytebase.v1.PlanLimitConfig">PlanLimitConfig</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>instance_features</td><td><a href="#bytebase.v1.PlanFeature">PlanFeature</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.PlanLimitConfig">PlanLimitConfig</h3><p>PlanLimitConfig represents a single plan's configuration</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>type</td><td><a href="#bytebase.v1.PlanType">PlanType</a></td><td></td><td><p> </p></td></tr>-+<tr><td>maximum_instance_count</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>maximum_seat_count</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>features</td><td><a href="#bytebase.v1.PlanFeature">PlanFeature</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.PurchaseBillingMethod">PurchaseBillingMethod</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>interval</td><td><a href="#bytebase.v1.BillingInterval">BillingInterval</a></td><td></td><td><p> </p></td></tr>-+<tr><td>discount</td><td><a href="#bytebase.v1.PurchaseDiscount">PurchaseDiscount</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.PurchaseDiscount">PurchaseDiscount</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>type</td><td><a href="#bytebase.v1.PurchaseDiscount.Type">PurchaseDiscount.Type</a></td><td></td><td><p> </p></td></tr>-+<tr><td>value</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.PurchasePlan">PurchasePlan</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>type</td><td><a href="#bytebase.v1.PlanType">PlanType</a></td><td></td><td><p> </p></td></tr>-+<tr><td>self_service_purchase</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>additionals</td><td><a href="#bytebase.v1.PurchasePlanAdditional">PurchasePlanAdditional</a></td><td>repeated</td><td><p> </p></td></tr>-+<tr><td>billing_methods</td><td><a href="#bytebase.v1.PurchaseBillingMethod">PurchaseBillingMethod</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.PurchasePlanAdditional">PurchasePlanAdditional</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>type</td><td><a href="#bytebase.v1.PurchasePlanAdditional.Type">PurchasePlanAdditional.Type</a></td><td></td><td><p> </p></td></tr>-+<tr><td>unit_price</td><td><a href="#int32">int32</a></td><td></td><td><p>Price in USD cents per month. </p></td></tr>-+<tr><td>free_count</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>minimum_count</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>maximum_count</td><td><a href="#int32">int32</a></td><td></td><td><p>-1 means unlimited. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.PurchaseResponse">PurchaseResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>payment_url</td><td><a href="#string">string</a></td>@@ -31573,220 +31636,220 @@ Permissions required: bb.sheets.get</p></td><td><p>If set, redirect to this Stripe Checkout URL.If empty, the update was applied directly using the existing payment method. </p></td></tr>-+<tr><td>session_id</td><td><a href="#string">string</a></td><td></td><td><p>Stripe Checkout Session ID. Used to verify the session after redirect. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Subscription">Subscription</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>plan</td><td><a href="#bytebase.v1.PlanType">PlanType</a></td><td></td><td><p> </p></td></tr>-+<tr><td>seats</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>instances</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>active_instances</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>expires_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p> </p></td></tr>-+<tr><td>trialing</td><td><a href="#bool">bool</a></td><td></td><td><p> </p></td></tr>-+<tr><td>org_name</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>ha</td><td><a href="#bool">bool</a></td><td></td><td><p>Whether high availability (multiple replicas) is enabled. </p></td></tr>-+<tr><td>etag</td><td><a href="#string">string</a></td><td></td><td><p>Etag for optimistic concurrency on purchase updates. Only set in SaaS mode. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdatePurchaseRequest">UpdatePurchaseRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>plan</td><td><a href="#bytebase.v1.PlanType">PlanType</a></td><td></td><td><p> </p></td></tr>-+<tr><td>interval</td><td><a href="#bytebase.v1.BillingInterval">BillingInterval</a></td><td></td><td><p> </p></td></tr>-+<tr><td>seats</td><td><a href="#int32">int32</a></td><td></td><td><p> </p></td></tr>-+<tr><td>etag</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UploadLicenseRequest">UploadLicenseRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>license</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.VerifyCheckoutSessionRequest">VerifyCheckoutSessionRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>session_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.VerifyCheckoutSessionResponse">VerifyCheckoutSessionResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>status</td><td><a href="#string">string</a></td><td></td><td><p>Stripe Checkout Session status: "complete", "expired", or "open". </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.BillingInterval">BillingInterval</h3><p></p><table class="enum-table">@@ -31794,28 +31857,28 @@ If empty, the update was applied directly using the existing payment method. </p<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>BILLING_INTERVAL_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>MONTH</td><td>1</td><td><p></p></td></tr>-+<tr><td>YEAR</td><td>2</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.PlanFeature">PlanFeature</h3><p>PlanFeature represents the available features in Bytebase</p><table class="enum-table">@@ -31823,442 +31886,442 @@ If empty, the update was applied directly using the existing payment method. </p<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>FEATURE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>FEATURE_DATABASE_CHANGE</td><td>1</td><td><p>Database Change Management</p></td></tr>-+<tr><td>FEATURE_GIT_BASED_SCHEMA_VERSION_CONTROL</td><td>2</td><td><p></p></td></tr>-+<tr><td>FEATURE_DECLARATIVE_SCHEMA_MIGRATION</td><td>3</td><td><p></p></td></tr>-+<tr><td>FEATURE_COMPARE_AND_SYNC_SCHEMA</td><td>4</td><td><p></p></td></tr>-+<tr><td>FEATURE_ONLINE_SCHEMA_CHANGE</td><td>5</td><td><p></p></td></tr>-+<tr><td>FEATURE_PRE_DEPLOYMENT_SQL_REVIEW</td><td>6</td><td><p></p></td></tr>-+<tr><td>FEATURE_AUTOMATIC_BACKUP_BEFORE_DATA_CHANGES</td><td>7</td><td><p></p></td></tr>-+<tr><td>FEATURE_ONE_CLICK_DATA_ROLLBACK</td><td>8</td><td><p></p></td></tr>-+<tr><td>FEATURE_MULTI_DATABASE_BATCH_CHANGES</td><td>9</td><td><p></p></td></tr>-+<tr><td>FEATURE_PROGRESSIVE_ENVIRONMENT_DEPLOYMENT</td><td>10</td><td><p></p></td></tr>-+<tr><td>FEATURE_SCHEDULED_ROLLOUT_TIME</td><td>11</td><td><p></p></td></tr>-+<tr><td>FEATURE_DATABASE_CHANGELOG</td><td>12</td><td><p></p></td></tr>-+<tr><td>FEATURE_SCHEMA_DRIFT_DETECTION</td><td>13</td><td><p></p></td></tr>-+<tr><td>FEATURE_ROLLOUT_POLICY</td><td>14</td><td><p></p></td></tr>-+<tr><td>FEATURE_WEB_BASED_SQL_EDITOR</td><td>15</td><td><p>SQL Editor & Development</p></td></tr>-+<tr><td>FEATURE_SQL_EDITOR_ADMIN_MODE</td><td>16</td><td><p></p></td></tr>-+<tr><td>FEATURE_NATURAL_LANGUAGE_TO_SQL</td><td>17</td><td><p></p></td></tr>-+<tr><td>FEATURE_AI_QUERY_EXPLANATION</td><td>18</td><td><p></p></td></tr>-+<tr><td>FEATURE_AI_QUERY_SUGGESTIONS</td><td>19</td><td><p></p></td></tr>-+<tr><td>FEATURE_AUTO_COMPLETE</td><td>20</td><td><p></p></td></tr>-+<tr><td>FEATURE_SCHEMA_DIAGRAM</td><td>21</td><td><p></p></td></tr>-+<tr><td>FEATURE_SCHEMA_EDITOR</td><td>22</td><td><p></p></td></tr>-+<tr><td>FEATURE_DATA_EXPORT</td><td>23</td><td><p></p></td></tr>-+<tr><td>FEATURE_DATA_OFFLINE_EXPORT</td><td>24</td><td><p></p></td></tr>-+<tr><td>FEATURE_QUERY_HISTORY</td><td>25</td><td><p></p></td></tr>-+<tr><td>FEATURE_SAVED_AND_SHARED_SQL_SCRIPTS</td><td>26</td><td><p></p></td></tr>-+<tr><td>FEATURE_BATCH_QUERY</td><td>27</td><td><p></p></td></tr>-+<tr><td>FEATURE_INSTANCE_READ_ONLY_CONNECTION</td><td>28</td><td><p></p></td></tr>-+<tr><td>FEATURE_QUERY_POLICY</td><td>29</td><td><p></p></td></tr>-+<tr><td>FEATURE_RESTRICT_COPYING_DATA</td><td>30</td><td><p></p></td></tr>-+<tr><td>FEATURE_IAM</td><td>31</td><td><p>Security & Compliance</p></td></tr>-+<tr><td>FEATURE_INSTANCE_SSL_CONNECTION</td><td>32</td><td><p></p></td></tr>-+<tr><td>FEATURE_INSTANCE_CONNECTION_OVER_SSH_TUNNEL</td><td>33</td><td><p></p></td></tr>-+<tr><td>FEATURE_INSTANCE_CONNECTION_IAM_AUTHENTICATION</td><td>34</td><td><p></p></td></tr>-+<tr><td>FEATURE_GOOGLE_AND_GITHUB_SSO</td><td>35</td><td><p></p></td></tr>-+<tr><td>FEATURE_USER_GROUPS</td><td>36</td><td><p></p></td></tr>-+<tr><td>FEATURE_DISALLOW_SELF_SERVICE_SIGNUP</td><td>37</td><td><p></p></td></tr>-+<tr><td>FEATURE_CUSTOM_INSTANCE_SYNC_TIME</td><td>38</td><td><p></p></td></tr>-+<tr><td>FEATURE_CUSTOM_INSTANCE_CONNECTION_LIMIT</td><td>39</td><td><p></p></td></tr>-+<tr><td>FEATURE_RISK_ASSESSMENT</td><td>40</td><td><p></p></td></tr>-+<tr><td>FEATURE_APPROVAL_WORKFLOW</td><td>41</td><td><p></p></td></tr>-+<tr><td>FEATURE_AUDIT_LOG</td><td>42</td><td><p></p></td></tr>-+<tr><td>FEATURE_ENTERPRISE_SSO</td><td>43</td><td><p></p></td></tr>-+<tr><td>FEATURE_TWO_FA</td><td>44</td><td><p></p></td></tr>-+<tr><td>FEATURE_PASSWORD_RESTRICTIONS</td><td>45</td><td><p></p></td></tr>-+<tr><td>FEATURE_DISALLOW_PASSWORD_SIGNIN</td><td>46</td><td><p></p></td></tr>-+<tr><td>FEATURE_CUSTOM_ROLES</td><td>47</td><td><p></p></td></tr>-+<tr><td>FEATURE_REQUEST_ROLE_WORKFLOW</td><td>48</td><td><p></p></td></tr>-+<tr><td>FEATURE_JIT</td><td>49</td><td><p></p></td></tr>-+<tr><td>FEATURE_DATA_MASKING</td><td>50</td><td><p></p></td></tr>-+<tr><td>FEATURE_DATA_CLASSIFICATION</td><td>51</td><td><p></p></td></tr>-+<tr><td>FEATURE_SCIM</td><td>52</td><td><p></p></td></tr>-+<tr><td>FEATURE_DIRECTORY_SYNC</td><td>53</td><td><p></p></td></tr>-+<tr><td>FEATURE_TOKEN_DURATION_CONTROL</td><td>54</td><td><p></p></td></tr>-+<tr><td>FEATURE_EXTERNAL_SECRET_MANAGER</td><td>55</td><td><p></p></td></tr>-+<tr><td>FEATURE_USER_EMAIL_DOMAIN_RESTRICTION</td><td>56</td><td><p></p></td></tr>-+<tr><td>FEATURE_PROJECT_MANAGEMENT</td><td>57</td><td><p>Administration & Support</p></td></tr>-+<tr><td>FEATURE_ENVIRONMENT_MANAGEMENT</td><td>58</td><td><p></p></td></tr>-+<tr><td>FEATURE_IM_NOTIFICATIONS</td><td>59</td><td><p></p></td></tr>-+<tr><td>FEATURE_TERRAFORM_PROVIDER</td><td>60</td><td><p></p></td></tr>-+<tr><td>FEATURE_DATABASE_GROUPS</td><td>61</td><td><p></p></td></tr>-+<tr><td>FEATURE_ENVIRONMENT_TIERS</td><td>62</td><td><p></p></td></tr>-+<tr><td>FEATURE_DASHBOARD_ANNOUNCEMENT</td><td>63</td><td><p></p></td></tr>-+<tr><td>FEATURE_API_INTEGRATION_GUIDANCE</td><td>64</td><td><p></p></td></tr>-+<tr><td>FEATURE_CUSTOM_LOGO</td><td>65</td><td><p></p></td></tr>-+<tr><td>FEATURE_WATERMARK</td><td>66</td><td><p></p></td></tr>-+<tr><td>FEATURE_ROADMAP_PRIORITIZATION</td><td>67</td><td><p></p></td></tr>-+<tr><td>FEATURE_CUSTOM_MSA</td><td>68</td><td><p></p></td></tr>-+<tr><td>FEATURE_COMMUNITY_SUPPORT</td><td>69</td><td><p></p></td></tr>-+<tr><td>FEATURE_EMAIL_SUPPORT</td><td>70</td><td><p></p></td></tr>-+<tr><td>FEATURE_DEDICATED_SUPPORT_WITH_SLA</td><td>71</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.PlanType">PlanType</h3><p></p><table class="enum-table">@@ -32266,34 +32329,34 @@ If empty, the update was applied directly using the existing payment method. </p<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>PLAN_TYPE_UNSPECIFIED</td><td>0</td><td><p>Unspecified plan type.</p></td></tr>-+<tr><td>FREE</td><td>1</td><td><p>Free plan with basic features and no cost.</p></td></tr>-+<tr><td>TEAM</td><td>2</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>Enterprise plan with advanced features and dedicated support.</p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.PurchaseDiscount.Type">PurchaseDiscount.Type</h3><p></p><table class="enum-table">@@ -32301,34 +32364,34 @@ If empty, the update was applied directly using the existing payment method. </p<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>PERCENTAGE_OFF</td><td>1</td><td><p></p></td></tr>-+<tr><td>FIXED_MONTH_OFF</td><td>2</td><td><p></p></td></tr>-+<tr><td>FIXED_PRICE_OFF</td><td>3</td><td><p></p></td></tr>-+</tbody></table>-+<h3 id="bytebase.v1.PurchasePlanAdditional.Type">PurchasePlanAdditional.Type</h3><p></p><table class="enum-table">@@ -32336,26 +32399,26 @@ If empty, the update was applied directly using the existing payment method. </p<tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>USER</td><td>1</td><td><p></p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SubscriptionService">SubscriptionService</h3><p>SubscriptionService manages enterprise subscriptions and licensing.</p><table class="enum-table">@@ -32363,7 +32426,7 @@ If empty, the update was applied directly using the existing payment method. </p<tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>GetSubscription</td><td><a href="#bytebase.v1.GetSubscriptionRequest">GetSubscriptionRequest</a></td>@@ -32372,14 +32435,14 @@ If empty, the update was applied directly using the existing payment method. </pIf 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.</p></td></tr>-+<tr><td>UploadLicense</td><td><a href="#bytebase.v1.UploadLicenseRequest">UploadLicenseRequest</a></td><td><a href="#bytebase.v1.Subscription">Subscription</a></td><td><p>Uploads an enterprise license (self-hosted only).</p></td></tr>-+<tr><td>CreatePurchase</td><td><a href="#bytebase.v1.CreatePurchaseRequest">CreatePurchaseRequest</a></td>@@ -32387,7 +32450,7 @@ If there is expired license, we will return a free plan subscription with the ex<td><p>CreatePurchase creates a new subscription purchase (SaaS only).Returns a Stripe Checkout URL for the user to complete payment.</p></td></tr>-+<tr><td>UpdatePurchase</td><td><a href="#bytebase.v1.UpdatePurchaseRequest">UpdatePurchaseRequest</a></td>@@ -32395,41 +32458,41 @@ Returns a Stripe Checkout URL for the user to complete payment.</p></td><td><p>UpdatePurchase updates an existing subscription (SaaS only).May return a Stripe Checkout URL if payment method change is needed.</p></td></tr>-+<tr><td>CancelPurchase</td><td><a href="#bytebase.v1.CancelPurchaseRequest">CancelPurchaseRequest</a></td><td><a href="#bytebase.v1.PurchaseResponse">PurchaseResponse</a></td><td><p>CancelPurchase cancels an active subscription (SaaS only).</p></td></tr>-+<tr><td>GetPaymentInfo</td><td><a href="#bytebase.v1.GetPaymentInfoRequest">GetPaymentInfoRequest</a></td><td><a href="#bytebase.v1.PaymentInfo">PaymentInfo</a></td><td><p>GetPaymentInfo returns payment details for the current subscription (SaaS only).</p></td></tr>-+<tr><td>VerifyCheckoutSession</td><td><a href="#bytebase.v1.VerifyCheckoutSessionRequest">VerifyCheckoutSessionRequest</a></td><td><a href="#bytebase.v1.VerifyCheckoutSessionResponse">VerifyCheckoutSessionResponse</a></td><td><p>VerifyCheckoutSession verifies a Stripe Checkout Session status (SaaS only).</p></td></tr>-+<tr><td>ListPurchasePlans</td><td><a href="#bytebase.v1.ListPurchasePlansRequest">ListPurchasePlansRequest</a></td><td><a href="#bytebase.v1.ListPurchasePlansResponse">ListPurchasePlansResponse</a></td><td><p>ListPurchasePlans returns available plans for self-service purchase.</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -32441,109 +32504,109 @@ May return a Stripe Checkout URL if payment method change is needed.</p></td></tr></thead><tbody>---+++<tr><td>GetSubscription</td><td>GET</td><td>/v1/subscription</td><td></td></tr>----++++<tr><td>UploadLicense</td><td>PATCH</td><td>/v1/subscription/license</td><td>*</td></tr>----++++<tr><td>CreatePurchase</td><td>POST</td><td>/v1/subscription:purchase</td><td>*</td></tr>----++++<tr><td>UpdatePurchase</td><td>POST</td><td>/v1/subscription:updatePurchase</td><td>*</td></tr>----++++<tr><td>CancelPurchase</td><td>POST</td><td>/v1/subscription:cancelPurchase</td><td>*</td></tr>----++++<tr><td>GetPaymentInfo</td><td>GET</td><td>/v1/subscription/paymentInfo</td><td></td></tr>----++++<tr><td>VerifyCheckoutSession</td><td>GET</td><td>/v1/subscription/checkoutSession/{session_id}</td><td></td></tr>----++++<tr><td>ListPurchasePlans</td><td>GET</td><td>/v1/subscription/plans</td><td></td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/workload_identity_service.proto">v1/workload_identity_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.CreateWorkloadIdentityRequest">CreateWorkloadIdentityRequest</h3><p>Request message for creating a workload identity.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -32551,7 +32614,7 @@ May return a Stripe Checkout URL if payment method change is needed.</p></td><td><p>The parent resource where this workload identity will be created.Format: projects/{project} for project-level, workspaces/{id} for workspace-level. </p></td></tr>-+<tr><td>workload_identity_id</td><td><a href="#string">string</a></td>@@ -32560,31 +32623,31 @@ Format: projects/{project} for project-level, workspaces/{id} for workspace-leveof the workload identity's email in the format: {workload_identity_id}@workload.bytebase.comor {workload_identity_id}@{project-id}.workload.bytebase.com </p></td></tr>-+<tr><td>workload_identity</td><td><a href="#bytebase.v1.WorkloadIdentity">WorkloadIdentity</a></td><td></td><td><p>The workload identity to create. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DeleteWorkloadIdentityRequest">DeleteWorkloadIdentityRequest</h3><p>Request message for deleting a workload identity.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -32592,24 +32655,24 @@ or {workload_identity_id}@{project-id}.workload.bytebase.com </p></td><td><p>The name of the workload identity to delete.Format: workloadIdentities/{email} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetWorkloadIdentityRequest">GetWorkloadIdentityRequest</h3><p>Request message for getting a workload identity.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -32617,24 +32680,24 @@ Format: workloadIdentities/{email} </p></td><td><p>The name of the workload identity to retrieve.Format: workloadIdentities/{email} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListWorkloadIdentitiesRequest">ListWorkloadIdentitiesRequest</h3><p>Request message for listing workload identities.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -32642,7 +32705,7 @@ Format: workloadIdentities/{email} </p></td><td><p>The parent resource.Format: projects/{project} for project-level, workspaces/{id} for workspace-level. </p></td></tr>-+<tr><td>page_size</td><td><a href="#int32">int32</a></td>@@ -32652,7 +32715,7 @@ this value.If unspecified, at most 10 workload identities will be returned.The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td></tr>-+<tr><td>page_token</td><td><a href="#string">string</a></td>@@ -32663,14 +32726,14 @@ Provide this to retrieve the subsequent page.When paginating, all other parameters provided to `ListWorkloadIdentities` must matchthe call that provided the page token. </p></td></tr>-+<tr><td>show_deleted</td><td><a href="#bool">bool</a></td><td></td><td><p>Show deleted workload identities if specified. </p></td></tr>-+<tr><td>filter</td><td><a href="#string">string</a></td>@@ -32690,31 +32753,31 @@ state == "DELETED"email == "[email protected]"email.contains("ed") </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListWorkloadIdentitiesResponse">ListWorkloadIdentitiesResponse</h3><p>Response message for listing workload identities.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>workload_identities</td><td><a href="#bytebase.v1.WorkloadIdentity">WorkloadIdentity</a></td><td>repeated</td><td><p>The workload identities from the specified request. </p></td></tr>-+<tr><td>next_page_token</td><td><a href="#string">string</a></td>@@ -32722,24 +32785,24 @@ email.contains("ed") </p></td><td><p>A token, which can be sent as `page_token` to retrieve the next page.If this field is omitted, there are no subsequent pages. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UndeleteWorkloadIdentityRequest">UndeleteWorkloadIdentityRequest</h3><p>Request message for restoring a deleted workload identity.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -32747,24 +32810,24 @@ If this field is omitted, there are no subsequent pages. </p></td><td><p>The name of the deleted workload identity.Format: workloadIdentities/{email} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdateWorkloadIdentityRequest">UpdateWorkloadIdentityRequest</h3><p>Request message for updating a workload identity.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>workload_identity</td><td><a href="#bytebase.v1.WorkloadIdentity">WorkloadIdentity</a></td>@@ -32774,7 +32837,7 @@ Format: workloadIdentities/{email} </p></td>The workload identity's `name` field is used to identify the workload identity to update.Format: workloadIdentities/{email} </p></td></tr>-+<tr><td>update_mask</td><td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>@@ -32782,24 +32845,24 @@ Format: workloadIdentities/{email} </p></td><td><p>The list of fields to update.Supported fields: title, workload_identity_config </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.WorkloadIdentity">WorkloadIdentity</h3><p>WorkloadIdentity represents an external CI/CD workload identity.</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -32807,14 +32870,14 @@ Supported fields: title, workload_identity_config </p></td><td><p>The name of the workload identity.Format: workloadIdentities/{email} </p></td></tr>-+<tr><td>state</td><td><a href="#bytebase.v1.State">State</a></td><td></td><td><p>The state of the workload identity. </p></td></tr>-+<tr><td>email</td><td><a href="#string">string</a></td>@@ -32823,82 +32886,82 @@ Format: workloadIdentities/{email} </p></td>For workspace-level: {name}@workload.bytebase.comFor project-level: {name}@{project-id}.workload.bytebase.com </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>The display title of the workload identity. </p></td></tr>-+<tr><td>create_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p>The timestamp when the workload identity was created. </p></td></tr>-+<tr><td>workload_identity_config</td><td><a href="#bytebase.v1.WorkloadIdentityConfig">WorkloadIdentityConfig</a></td><td></td><td><p>The workload identity configuration for OIDC token validation. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.WorkloadIdentityConfig">WorkloadIdentityConfig</h3><p>WorkloadIdentityConfig for API layer</p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>provider_type</td><td><a href="#bytebase.v1.WorkloadIdentityConfig.ProviderType">WorkloadIdentityConfig.ProviderType</a></td><td></td><td><p>Platform type (currently only GITHUB is supported) </p></td></tr>-+<tr><td>issuer_url</td><td><a href="#string">string</a></td><td></td><td><p>OIDC Issuer URL (auto-filled based on provider_type, can be overridden) </p></td></tr>-+<tr><td>allowed_audiences</td><td><a href="#string">string</a></td><td>repeated</td><td><p>Allowed audiences for token validation </p></td></tr>-+<tr><td>subject_pattern</td><td><a href="#string">string</a></td><td></td><td><p>Subject pattern to match (e.g., "repo:owner/repo:ref:refs/heads/main") </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.WorkloadIdentityConfig.ProviderType">WorkloadIdentityConfig.ProviderType</h3><p>ProviderType identifies the CI/CD platform.</p><table class="enum-table">@@ -32906,32 +32969,32 @@ For project-level: {name}@{project-id}.workload.bytebase.com </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>PROVIDER_TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>GITHUB</td><td>1</td><td><p></p></td></tr>-+<tr><td>GITLAB</td><td>2</td><td><p></p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.WorkloadIdentityService">WorkloadIdentityService</h3><p>WorkloadIdentityService manages workload identities for external CI/CD integrations.</p><table class="enum-table">@@ -32939,7 +33002,7 @@ For project-level: {name}@{project-id}.workload.bytebase.com </p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>CreateWorkloadIdentity</td><td><a href="#bytebase.v1.CreateWorkloadIdentityRequest">CreateWorkloadIdentityRequest</a></td>@@ -32948,7 +33011,7 @@ For project-level: {name}@{project-id}.workload.bytebase.com </p></td>For workspace-level: parent is workspaces/{id}, permission bb.workloadIdentities.create on workspace.For project-level: parent is projects/{project}, permission bb.workloadIdentities.create on project.</p></td></tr>-+<tr><td>GetWorkloadIdentity</td><td><a href="#bytebase.v1.GetWorkloadIdentityRequest">GetWorkloadIdentityRequest</a></td>@@ -32956,7 +33019,7 @@ For project-level: parent is projects/{project}, permission bb.workloadIdentitie<td><p>Gets a workload identity by name.Permissions required: bb.workloadIdentities.get</p></td></tr>-+<tr><td>ListWorkloadIdentities</td><td><a href="#bytebase.v1.ListWorkloadIdentitiesRequest">ListWorkloadIdentitiesRequest</a></td>@@ -32965,7 +33028,7 @@ Permissions required: bb.workloadIdentities.get</p></td>For workspace-level: parent is workspaces/{id}, permission bb.workloadIdentities.list on workspace.For project-level: parent is projects/{project}, permission bb.workloadIdentities.list on project.</p></td></tr>-+<tr><td>UpdateWorkloadIdentity</td><td><a href="#bytebase.v1.UpdateWorkloadIdentityRequest">UpdateWorkloadIdentityRequest</a></td>@@ -32973,7 +33036,7 @@ For project-level: parent is projects/{project}, permission bb.workloadIdentitie<td><p>Updates a workload identity.Permissions required: bb.workloadIdentities.update</p></td></tr>-+<tr><td>DeleteWorkloadIdentity</td><td><a href="#bytebase.v1.DeleteWorkloadIdentityRequest">DeleteWorkloadIdentityRequest</a></td>@@ -32981,7 +33044,7 @@ Permissions required: bb.workloadIdentities.update</p></td><td><p>Deletes a workload identity.Permissions required: bb.workloadIdentities.delete</p></td></tr>-+<tr><td>UndeleteWorkloadIdentity</td><td><a href="#bytebase.v1.UndeleteWorkloadIdentityRequest">UndeleteWorkloadIdentityRequest</a></td>@@ -32989,13 +33052,13 @@ Permissions required: bb.workloadIdentities.delete</p></td><td><p>Restores a deleted workload identity.Permissions required: bb.workloadIdentities.undelete</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -33007,151 +33070,151 @@ Permissions required: bb.workloadIdentities.undelete</p></td></tr></thead><tbody>---+++<tr><td>CreateWorkloadIdentity</td><td>POST</td><td>/v1/{parent=projects/*}/workloadIdentities</td><td>workload_identity</td></tr>-+<tr><td>CreateWorkloadIdentity</td><td>POST</td><td>/v1/{parent=workspaces/*}/workloadIdentities</td><td>workload_identity</td></tr>----++++<tr><td>GetWorkloadIdentity</td><td>GET</td><td>/v1/{name=workloadIdentities/*}</td><td></td></tr>----++++<tr><td>ListWorkloadIdentities</td><td>GET</td><td>/v1/{parent=projects/*}/workloadIdentities</td><td></td></tr>-+<tr><td>ListWorkloadIdentities</td><td>GET</td><td>/v1/{parent=workspaces/*}/workloadIdentities</td><td></td></tr>----++++<tr><td>UpdateWorkloadIdentity</td><td>PATCH</td><td>/v1/{workload_identity.name=workloadIdentities/*}</td><td>workload_identity</td></tr>----++++<tr><td>DeleteWorkloadIdentity</td><td>DELETE</td><td>/v1/{name=workloadIdentities/*}</td><td></td></tr>----++++<tr><td>UndeleteWorkloadIdentity</td><td>POST</td><td>/v1/{name=workloadIdentities/*}:undelete</td><td>*</td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/worksheet_service.proto">v1/worksheet_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.BatchUpdateWorksheetOrganizerRequest">BatchUpdateWorksheetOrganizerRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>requests</td><td><a href="#bytebase.v1.UpdateWorksheetOrganizerRequest">UpdateWorksheetOrganizerRequest</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.BatchUpdateWorksheetOrganizerResponse">BatchUpdateWorksheetOrganizerResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>worksheet_organizers</td><td><a href="#bytebase.v1.WorksheetOrganizer">WorksheetOrganizer</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.CreateWorksheetRequest">CreateWorksheetRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -33159,31 +33222,31 @@ Permissions required: bb.workloadIdentities.undelete</p></td><td><p>The parent resource where this worksheet will be created.Format: projects/{project} </p></td></tr>-+<tr><td>worksheet</td><td><a href="#bytebase.v1.Worksheet">Worksheet</a></td><td></td><td><p>The worksheet to create. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.DeleteWorksheetRequest">DeleteWorksheetRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -33191,24 +33254,24 @@ Format: projects/{project} </p></td><td><p>The name of the worksheet to delete.Format: projects/{project}/worksheets/{worksheet} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.GetWorksheetRequest">GetWorksheetRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -33216,24 +33279,24 @@ Format: projects/{project}/worksheets/{worksheet} </p></td><td><p>The name of the worksheet to retrieve.Format: projects/{project}/worksheets/{worksheet} </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SearchWorksheetsRequest">SearchWorksheetsRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>parent</td><td><a href="#string">string</a></td>@@ -33241,7 +33304,7 @@ Format: projects/{project}/worksheets/{worksheet} </p></td><td><p>The parent resource of the worksheets.Format: projects/{project} </p></td></tr>-+<tr><td>filter</td><td><a href="#string">string</a></td>@@ -33262,48 +33325,48 @@ starred == falsevisibility in ["PRIVATE", "PROJECT_READ", "PROJECT_WRITE"]visibility == "PRIVATE" </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.SearchWorksheetsResponse">SearchWorksheetsResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>worksheets</td><td><a href="#bytebase.v1.Worksheet">Worksheet</a></td><td>repeated</td><td><p>The worksheets that matched the search criteria. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdateWorksheetOrganizerRequest">UpdateWorksheetOrganizerRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>organizer</td><td><a href="#bytebase.v1.WorksheetOrganizer">WorksheetOrganizer</a></td>@@ -33313,7 +33376,7 @@ visibility == "PRIVATE" </p></td>The organizer's `worksheet` field is used to identify the worksheet.Format: projects/{project}/worksheets/{worksheet} </p></td></tr>-+<tr><td>update_mask</td><td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>@@ -33323,7 +33386,7 @@ Fields are specified relative to the worksheet organizer.Only support update the following fields for now:- `starred` </p></td></tr>-+<tr><td>allow_missing</td><td><a href="#bool">bool</a></td>@@ -33331,24 +33394,24 @@ Only support update the following fields for now:<td><p>If set to true, and the worksheet organizer is not found, a new worksheet organizer will be created.In this situation, `update_mask` is ignored. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdateWorksheetRequest">UpdateWorksheetRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>worksheet</td><td><a href="#bytebase.v1.Worksheet">Worksheet</a></td>@@ -33358,7 +33421,7 @@ In this situation, `update_mask` is ignored. </p></td>The worksheet's `name` field is used to identify the worksheet to update.Format: projects/{project}/worksheets/{worksheet} </p></td></tr>-+<tr><td>update_mask</td><td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>@@ -33372,24 +33435,24 @@ Only support update the following fields for now:- `starred`- `visibility` </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Worksheet">Worksheet</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -33398,7 +33461,7 @@ Only support update the following fields for now:Canonical parent is project.Format: projects/{project}/worksheets/{worksheet} </p></td></tr>-+<tr><td>project</td><td><a href="#string">string</a></td>@@ -33406,7 +33469,7 @@ Format: projects/{project}/worksheets/{worksheet} </p></td><td><p>The project resource name.Format: projects/{project} </p></td></tr>-+<tr><td>database</td><td><a href="#string">string</a></td>@@ -33415,14 +33478,14 @@ Format: projects/{project} </p></td>Format: instances/{instance}/databases/{database}If the database parent doesn't exist, the database field is empty. </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p>The title of the worksheet. </p></td></tr>-+<tr><td>creator</td><td><a href="#string">string</a></td>@@ -33430,21 +33493,21 @@ If the database parent doesn't exist, the database field is empty. </p></td><td><p>The creator of the Worksheet.Format: users/{email} </p></td></tr>-+<tr><td>create_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td><td><p>The create time of the worksheet. </p></td></tr>-+<tr><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 worksheet. </p></td></tr>-+<tr><td>content</td><td><a href="#bytes">bytes</a></td>@@ -33453,52 +33516,52 @@ Format: users/{email} </p></td>By default, it will be cut off in SearchWorksheet() method. If it doesn't match the `content_size`, you canuse GetWorksheet() request to retrieve the full content. </p></td></tr>-+<tr><td>content_size</td><td><a href="#int64">int64</a></td><td></td><td><p>content_size is the full size of the content, may not match the size of the `content` field. </p></td></tr>-+<tr><td>visibility</td><td><a href="#bytebase.v1.Worksheet.Visibility">Worksheet.Visibility</a></td><td></td><td><p> </p></td></tr>-+<tr><td>starred</td><td><a href="#bool">bool</a></td><td></td><td><p>starred indicates whether the worksheet is starred by the current authenticated user. </p></td></tr>-+<tr><td>folders</td><td><a href="#string">string</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.WorksheetOrganizer">WorksheetOrganizer</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>worksheet</td><td><a href="#string">string</a></td>@@ -33506,30 +33569,30 @@ use GetWorksheet() request to retrieve the full content. </p></td><td><p>The name of the worksheet.Format: projects/{project}/worksheets/{worksheet} </p></td></tr>-+<tr><td>starred</td><td><a href="#bool">bool</a></td><td></td><td><p>starred means if the worksheet is starred. </p></td></tr>-+<tr><td>folders</td><td><a href="#string">string</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>----++++<h3 id="bytebase.v1.Worksheet.Visibility">Worksheet.Visibility</h3><p></p><table class="enum-table">@@ -33537,38 +33600,38 @@ Format: projects/{project}/worksheets/{worksheet} </p></td><tr><td>Name</td><td>Number</td><td>Description</td></tr></thead><tbody>-+<tr><td>VISIBILITY_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>-+<tr><td>PROJECT_READ</td><td>1</td><td><p>Read access in project scope, worksheet OWNER/DBA and project OWNER can read/write, other project members can read.</p></td></tr>-+<tr><td>PROJECT_WRITE</td><td>2</td><td><p>Write access in project scope, worksheet OWNER/DBA and all members in the project can write the worksheet.</p></td></tr>-+<tr><td>PRIVATE</td><td>3</td><td><p>Private, only worksheet OWNER can read/write.</p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.WorksheetService">WorksheetService</h3><p>WorksheetService manages SQL worksheets for query development.</p><table class="enum-table">@@ -33576,7 +33639,7 @@ Format: projects/{project}/worksheets/{worksheet} </p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>CreateWorksheet</td><td><a href="#bytebase.v1.CreateWorksheetRequest">CreateWorksheetRequest</a></td>@@ -33584,7 +33647,7 @@ Format: projects/{project}/worksheets/{worksheet} </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><td>GetWorksheet</td><td><a href="#bytebase.v1.GetWorksheetRequest">GetWorksheetRequest</a></td>@@ -33596,7 +33659,7 @@ The users can access this method if,- 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)</p></td></tr>-+<tr><td>SearchWorksheets</td><td><a href="#bytebase.v1.SearchWorksheetsRequest">SearchWorksheetsRequest</a></td>@@ -33606,7 +33669,7 @@ 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)</p></td></tr>-+<tr><td>UpdateWorksheet</td><td><a href="#bytebase.v1.UpdateWorksheetRequest">UpdateWorksheetRequest</a></td>@@ -33618,7 +33681,7 @@ The users can access this method if,- 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)</p></td></tr>-+<tr><td>UpdateWorksheetOrganizer</td><td><a href="#bytebase.v1.UpdateWorksheetOrganizerRequest">UpdateWorksheetOrganizerRequest</a></td>@@ -33627,7 +33690,7 @@ Permissions required: bb.worksheets.manage (or creator, or project member for PRThe access is the same as UpdateWorksheet method.Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)</p></td></tr>-+<tr><td>BatchUpdateWorksheetOrganizer</td><td><a href="#bytebase.v1.BatchUpdateWorksheetOrganizerRequest">BatchUpdateWorksheetOrganizerRequest</a></td>@@ -33636,7 +33699,7 @@ Permissions required: bb.worksheets.get (or creator, or project member for shareThe access is the same as UpdateWorksheet method.Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)</p></td></tr>-+<tr><td>DeleteWorksheet</td><td><a href="#bytebase.v1.DeleteWorksheetRequest">DeleteWorksheetRequest</a></td>@@ -33645,13 +33708,13 @@ Permissions required: bb.worksheets.get (or creator, or project member for shareThe access is the same as UpdateWorksheet method.Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -33663,99 +33726,99 @@ Permissions required: bb.worksheets.manage (or creator, or project member for PR</tr></thead><tbody>---+++<tr><td>CreateWorksheet</td><td>POST</td><td>/v1/{parent=projects/*}/worksheets</td><td>worksheet</td></tr>----++++<tr><td>GetWorksheet</td><td>GET</td><td>/v1/{name=projects/*/worksheets/*}</td><td></td></tr>----++++<tr><td>SearchWorksheets</td><td>POST</td><td>/v1/{parent=projects/*}/worksheets:search</td><td>*</td></tr>----++++<tr><td>UpdateWorksheet</td><td>PATCH</td><td>/v1/{worksheet.name=projects/*/worksheets/*}</td><td>worksheet</td></tr>----++++<tr><td>UpdateWorksheetOrganizer</td><td>PATCH</td><td>/v1/{organizer.worksheet=projects/*/worksheets/*}/organizer</td><td>organizer</td></tr>----++++<tr><td>BatchUpdateWorksheetOrganizer</td><td>PATCH</td><td>/v1/worksheets/organizer:batchUpdate</td><td>*</td></tr>----++++<tr><td>DeleteWorksheet</td><td>DELETE</td><td>/v1/{name=projects/*/worksheets/*}</td><td></td></tr>--++</tbody></table>----++++<div class="file-heading"><h2 id="v1/workspace_service.proto">v1/workspace_service.proto</h2><a href="#title">Top</a></div><p></p>-+<h3 id="bytebase.v1.GetWorkspaceRequest">GetWorkspaceRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td>@@ -33763,120 +33826,120 @@ Permissions required: bb.worksheets.manage (or creator, or project member for PR<td><p>The workspace name, format: workspaces/{workspace}.Use "workspaces/-" to get the current/default workspace. </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.ListWorkspacesRequest">ListWorkspacesRequest</h3><p></p>---+++<h3 id="bytebase.v1.ListWorkspacesResponse">ListWorkspacesResponse</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>workspaces</td><td><a href="#bytebase.v1.Workspace">Workspace</a></td><td>repeated</td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.UpdateWorkspaceRequest">UpdateWorkspaceRequest</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>workspace</td><td><a href="#bytebase.v1.Workspace">Workspace</a></td><td></td><td><p> </p></td></tr>-+<tr><td>update_mask</td><td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td><td></td><td><p> </p></td></tr>-+</tbody></table>---+++<h3 id="bytebase.v1.Workspace">Workspace</h3><p></p>-+<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr></thead><tbody>-+<tr><td>name</td><td><a href="#string">string</a></td><td></td><td><p>Format: workspaces/{workspace} </p></td></tr>-+<tr><td>title</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr>-+<tr><td>logo</td><td><a href="#string">string</a></td><td></td><td><p>The branding logo. </p></td></tr>-+</tbody></table>------++++++<h3 id="bytebase.v1.WorkspaceService">WorkspaceService</h3><p>WorkspaceService manages workspace-level operations and profile.</p><table class="enum-table">@@ -33884,7 +33947,7 @@ Use "workspaces/-" to get the current/default workspace. </p></td><tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr></thead><tbody>-+<tr><td>GetWorkspace</td><td><a href="#bytebase.v1.GetWorkspaceRequest">GetWorkspaceRequest</a></td>@@ -33895,21 +33958,21 @@ Supports "workspaces/-" to resolve the current workspace:- Self-hosted unauthenticated: returns the single workspace- SaaS unauthenticated: returns minimal response</p></td></tr>-+<tr><td>ListWorkspaces</td><td><a href="#bytebase.v1.ListWorkspacesRequest">ListWorkspacesRequest</a></td><td><a href="#bytebase.v1.ListWorkspacesResponse">ListWorkspacesResponse</a></td><td><p>Lists all workspaces the current user is a member of.</p></td></tr>-+<tr><td>UpdateWorkspace</td><td><a href="#bytebase.v1.UpdateWorkspaceRequest">UpdateWorkspaceRequest</a></td><td><a href="#bytebase.v1.Workspace">Workspace</a></td><td><p>Updates a workspace. Currently only title can be updated.</p></td></tr>-+<tr><td>GetIamPolicy</td><td><a href="#bytebase.v1.GetIamPolicyRequest">GetIamPolicyRequest</a></td>@@ -33917,7 +33980,7 @@ Supports "workspaces/-" to resolve the current workspace:<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>@@ -33925,13 +33988,13 @@ Permissions required: bb.workspaces.getIamPolicy</p></td><td><p>Sets IAM policy for the workspace.Permissions required: bb.workspaces.setIamPolicy</p></td></tr>-+</tbody></table>---+++<h4>Methods with HTTP bindings</h4><table><thead>@@ -33943,62 +34006,62 @@ Permissions required: bb.workspaces.setIamPolicy</p></td></tr></thead><tbody>---+++<tr><td>GetWorkspace</td><td>GET</td><td>/v1/{name=workspaces/*}</td><td></td></tr>----++++<tr><td>ListWorkspaces</td><td>GET</td><td>/v1/workspaces</td><td></td></tr>----++++<tr><td>UpdateWorkspace</td><td>PATCH</td><td>/v1/{workspace.name=workspaces/*}</td><td>*</td></tr>----++++<tr><td>GetIamPolicy</td><td>GET</td><td>/v1/{resource=workspaces/*}:getIamPolicy</td><td></td></tr>----++++<tr><td>SetIamPolicy</td><td>POST</td><td>/v1/{resource=workspaces/*}:setIamPolicy</td><td>*</td></tr>--++</tbody></table>---+++<h2 id="scalar-value-types">Scalar Value Types</h2><table class="scalar-value-types-table">@@ -34006,7 +34069,7 @@ Permissions required: bb.workspaces.setIamPolicy</p></td><tr><td>.proto Type</td><td>Notes</td><td>C++</td><td>Java</td><td>Python</td><td>Go</td><td>C#</td><td>PHP</td><td>Ruby</td></tr></thead><tbody>-+<tr id="double"><td>double</td><td></td>@@ -34018,7 +34081,7 @@ Permissions required: bb.workspaces.setIamPolicy</p></td><td>float</td><td>Float</td></tr>-+<tr id="float"><td>float</td><td></td>@@ -34030,7 +34093,7 @@ Permissions required: bb.workspaces.setIamPolicy</p></td><td>float</td><td>Float</td></tr>-+<tr id="int32"><td>int32</td><td>Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.</td>@@ -34042,7 +34105,7 @@ Permissions required: bb.workspaces.setIamPolicy</p></td><td>integer</td><td>Bignum or Fixnum (as required)</td></tr>-+<tr id="int64"><td>int64</td><td>Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.</td>@@ -34054,7 +34117,7 @@ Permissions required: bb.workspaces.setIamPolicy</p></td><td>integer/string</td><td>Bignum</td></tr>-+<tr id="uint32"><td>uint32</td><td>Uses variable-length encoding.</td>@@ -34066,7 +34129,7 @@ Permissions required: bb.workspaces.setIamPolicy</p></td><td>integer</td><td>Bignum or Fixnum (as required)</td></tr>-+<tr id="uint64"><td>uint64</td><td>Uses variable-length encoding.</td>@@ -34078,7 +34141,7 @@ Permissions required: bb.workspaces.setIamPolicy</p></td><td>integer/string</td><td>Bignum or Fixnum (as required)</td></tr>-+<tr id="sint32"><td>sint32</td><td>Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.</td>@@ -34090,7 +34153,7 @@ Permissions required: bb.workspaces.setIamPolicy</p></td><td>integer</td><td>Bignum or Fixnum (as required)</td></tr>-+<tr id="sint64"><td>sint64</td><td>Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.</td>@@ -34102,7 +34165,7 @@ Permissions required: bb.workspaces.setIamPolicy</p></td><td>integer/string</td><td>Bignum</td></tr>-+<tr id="fixed32"><td>fixed32</td><td>Always four bytes. More efficient than uint32 if values are often greater than 2^28.</td>@@ -34114,7 +34177,7 @@ Permissions required: bb.workspaces.setIamPolicy</p></td><td>integer</td><td>Bignum or Fixnum (as required)</td></tr>-+<tr id="fixed64"><td>fixed64</td><td>Always eight bytes. More efficient than uint64 if values are often greater than 2^56.</td>@@ -34126,7 +34189,7 @@ Permissions required: bb.workspaces.setIamPolicy</p></td><td>integer/string</td><td>Bignum</td></tr>-+<tr id="sfixed32"><td>sfixed32</td><td>Always four bytes.</td>@@ -34138,7 +34201,7 @@ Permissions required: bb.workspaces.setIamPolicy</p></td><td>integer</td><td>Bignum or Fixnum (as required)</td></tr>-+<tr id="sfixed64"><td>sfixed64</td><td>Always eight bytes.</td>@@ -34150,7 +34213,7 @@ Permissions required: bb.workspaces.setIamPolicy</p></td><td>integer/string</td><td>Bignum</td></tr>-+<tr id="bool"><td>bool</td><td></td>@@ -34162,7 +34225,7 @@ Permissions required: bb.workspaces.setIamPolicy</p></td><td>boolean</td><td>TrueClass/FalseClass</td></tr>-+<tr id="string"><td>string</td><td>A string must always contain UTF-8 encoded or 7-bit ASCII text.</td>@@ -34174,7 +34237,7 @@ Permissions required: bb.workspaces.setIamPolicy</p></td><td>string</td><td>String (UTF-8)</td></tr>-+<tr id="bytes"><td>bytes</td><td>May contain any arbitrary sequence of bytes.</td>@@ -34186,7 +34249,7 @@ Permissions required: bb.workspaces.setIamPolicy</p></td><td>string</td><td>String (ASCII-8BIT)</td></tr>-+</tbody></table></body>diff --git a/proto/store/store/instance.proto b/proto/store/store/instance.protoindex c4e9dd8ccb..6f9178876f 100644--- a/proto/store/store/instance.proto+++ b/proto/store/store/instance.proto@@ -69,6 +69,12 @@ message DataSource {string obfuscated_ssl_cert = 6;string ssl_key = 40;string obfuscated_ssl_key = 7;+ string ssl_ca_path = 50;+ string obfuscated_ssl_ca_path = 51;+ string ssl_cert_path = 52;+ string obfuscated_ssl_cert_path = 53;+ string ssl_key_path = 54;+ string obfuscated_ssl_key_path = 55;// 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).diff --git a/proto/v1/v1/instance_service.proto b/proto/v1/v1/instance_service.protoindex b2751131a0..a17f993c4f 100644--- a/proto/v1/v1/instance_service.proto+++ b/proto/v1/v1/instance_service.proto@@ -558,6 +558,24 @@ message DataSource {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];+ // The local filesystem path to the SSL certificate authority certificate.+ string ssl_ca_path = 41 [(google.api.field_behavior) = INPUT_ONLY];+ // The local filesystem path to the SSL client certificate.+ string ssl_cert_path = 42 [(google.api.field_behavior) = INPUT_ONLY];+ // The local filesystem path to the SSL client private key.+ string ssl_key_path = 43 [(google.api.field_behavior) = INPUT_ONLY];+ // Whether an SSL certificate authority certificate has been configured.+ bool ssl_ca_set = 44 [(google.api.field_behavior) = OUTPUT_ONLY];+ // Whether an SSL client certificate has been configured.+ bool ssl_cert_set = 45 [(google.api.field_behavior) = OUTPUT_ONLY];+ // Whether an SSL client private key has been configured.+ bool ssl_key_set = 46 [(google.api.field_behavior) = OUTPUT_ONLY];+ // Whether an SSL certificate authority path has been configured.+ bool ssl_ca_path_set = 47 [(google.api.field_behavior) = OUTPUT_ONLY];+ // Whether an SSL client certificate path has been configured.+ bool ssl_cert_path_set = 48 [(google.api.field_behavior) = OUTPUT_ONLY];+ // Whether an SSL client private key path has been configured.+ bool ssl_key_path_set = 49 [(google.api.field_behavior) = OUTPUT_ONLY];// 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).