Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
// Package cockroachdb is the plugin for CockroachDB driver.
package cockroachdb
import (
"bytes"
"compress/zlib"
"context"
"database/sql"
"encoding/base64"
"fmt"
"io"
"log/slog"
"net"
"regexp"
"strings"
"time"
"unicode"
metadatapb "github.com/bytebase/omni/metadata"
"github.com/cockroachdb/cockroach-go/v2/crdb"
"github.com/jackc/pgx/v5"
"github.com/jackc/pgx/v5/stdlib"
"github.com/pkg/errors"
"go.uber.org/multierr"
"golang.org/x/crypto/ssh"
"google.golang.org/protobuf/types/known/durationpb"
"github.com/bytebase/bytebase/backend/common"
"github.com/bytebase/bytebase/backend/common/log"
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"
"github.com/bytebase/bytebase/backend/plugin/db/transaction"
"github.com/bytebase/bytebase/backend/plugin/db/util"
"github.com/bytebase/bytebase/backend/plugin/parser/base"
crdbparser "github.com/bytebase/bytebase/backend/plugin/parser/cockroachdb"
pgparser "github.com/bytebase/bytebase/backend/plugin/parser/pg"
)
var (
// driverName is the driver name that our driver dependence register, now is "pgx".
driverName = "pgx"
_ db.Driver = (*Driver)(nil)
)
func init() {
db.Register(storepb.Engine_COCKROACHDB, newDriver)
}
// Driver is the Postgres driver.
type Driver struct {
config db.ConnectionConfig
db *sql.DB
sshClient *ssh.Client
// connectionString is the connection string registered by pgx.
// Unregister connectionString if we don't need it.
connectionString string
databaseName string
connectionCtx db.ConnectionContext
}
func newDriver() db.Driver {
return &Driver{}
}
// Open opens a Postgres driver.
func (d *Driver) Open(_ context.Context, _ storepb.Engine, config db.ConnectionConfig) (db.Driver, error) {
pgxConnConfig, err := getCockroachConnectionConfig(config)
if err != nil {
return nil, err
}
if config.DataSource.GetSshHost() != "" {
sshClient, err := util.GetSSHClient(config.DataSource)
if err != nil {
return nil, err
}
d.sshClient = sshClient
pgxConnConfig.DialFunc = func(ctx context.Context, network, addr string) (net.Conn, error) {
return util.DialSSHTunnel(ctx, sshClient, network, addr)
}
}
d.databaseName = config.ConnectionContext.DatabaseName
if config.ConnectionContext.DatabaseName != "" {
pgxConnConfig.Database = config.ConnectionContext.DatabaseName
} else if config.DataSource.GetDatabase() != "" {
pgxConnConfig.Database = config.DataSource.GetDatabase()
} else {
pgxConnConfig.Database = "postgres"
}
d.config = config
d.connectionString = stdlib.RegisterConnConfig(pgxConnConfig)
db, err := sql.Open(driverName, d.connectionString)
if err != nil {
return nil, err
}
d.db = db
d.connectionCtx = config.ConnectionContext
return d, nil
}
// getRoutingIDFromCockroachCloudURL returns the routing ID from the Cockroach Cloud URL, returns empty string if not found.
func getRoutingIDFromCockroachCloudURL(host string) string {
host = strings.TrimSpace(host)
if !strings.HasSuffix(host, "cockroachlabs.cloud") {
return ""
}
parts := strings.Split(host, ".")
// routing-id[.xxx].cockroachlabs.cloud
if len(parts) > 2 {
return parts[0]
}
return ""
}
func getCockroachConnectionConfig(config db.ConnectionConfig) (*pgx.ConnConfig, error) {
if config.DataSource.Username == "" {
return nil, errors.Errorf("user must be set")
}
if (config.DataSource.GetSslCert() == "" && config.DataSource.GetSslKey() != "") ||
(config.DataSource.GetSslCert() != "" && config.DataSource.GetSslKey() == "") {
return nil, errors.Errorf("ssl-cert and ssl-key must be both set or unset")
}
connStr, err := util.PGHostPort(config.DataSource.Host, config.DataSource.Port)
if err != nil {
return nil, err
}
if config.DataSource.GetUseSsl() {
connStr += fmt.Sprintf(" sslmode=%s", util.GetPGSSLMode(config.DataSource))
}
routingID := getRoutingIDFromCockroachCloudURL(config.DataSource.Host)
if routingID != "" {
connStr += " options=" + util.QuotePGValue("--cluster="+routingID)
}
connConfig, err := pgx.ParseConfig(connStr)
if err != nil {
return nil, err
}
connConfig.User = config.DataSource.Username
connConfig.Password = config.Password
connConfig.Database = config.ConnectionContext.DatabaseName
tlscfg, err := util.GetTLSConfig(config.DataSource)
if err != nil {
return nil, err
}
if tlscfg != nil {
connConfig.TLSConfig = tlscfg
util.ApplyPGTLSConfig(tlscfg, connConfig.Host, connConfig.Fallbacks)
}
appName := "bytebase"
if config.ConnectionContext.TaskRunUID != nil {
appName = fmt.Sprintf("bytebase-taskrun-%d", *config.ConnectionContext.TaskRunUID)
}
connConfig.RuntimeParams["application_name"] = appName
if config.ConnectionContext.ReadOnly {
connConfig.RuntimeParams["default_transaction_read_only"] = "true"
}
return connConfig, nil
}
// Close closes the driver.
func (d *Driver) Close(context.Context) error {
stdlib.UnregisterConnConfig(d.connectionString)
var err error
err = multierr.Append(err, d.db.Close())
if d.sshClient != nil {
err = multierr.Append(err, d.sshClient.Close())
}
return err
}
// Ping pings the database.
func (d *Driver) Ping(ctx context.Context) error {
return d.db.PingContext(ctx)
}
// GetDB gets the database.
func (d *Driver) GetDB() *sql.DB {
return d.db
}
// getDatabases gets all databases of an instance.
func (d *Driver) getDatabases(ctx context.Context) ([]*metadatapb.DatabaseSchemaMetadata, error) {
var databases []*metadatapb.DatabaseSchemaMetadata
if err := crdb.Execute(func() error {
rows, err := d.db.QueryContext(ctx, "SELECT datname, pg_encoding_to_char(encoding), datcollate FROM pg_database;")
if err != nil {
return err
}
defer rows.Close()
for rows.Next() {
database := &metadatapb.DatabaseSchemaMetadata{}
if err := rows.Scan(&database.Name, &database.CharacterSet, &database.Collation); err != nil {
return err
}
databases = append(databases, database)
}
err = rows.Err()
return err
}); err != nil {
return nil, err
}
return databases, nil
}
func (d *Driver) getVersion(ctx context.Context) (string, error) {
// https://www.cockroachlabs.com/docs/v25.1/cluster-settings#setting-version
query := "SHOW CLUSTER SETTING version;"
var version string
if err := d.db.QueryRowContext(ctx, query).Scan(&version); err != nil {
if err == sql.ErrNoRows {
return "", common.FormatDBErrorEmptyRowWithQuery(query)
}
return "", util.FormatErrorWithQuery(err, query)
}
return version, nil
}
// Execute will execute the statement. For CREATE DATABASE statement, some types of databases such as Postgres
// will not use transactions to execute the statement but will still use transactions to execute the rest of statements.
func (d *Driver) Execute(ctx context.Context, statement string, opts db.ExecuteOptions) (int64, error) {
if opts.CreateDatabase {
if err := d.createDatabaseExecute(ctx, statement); err != nil {
return 0, err
}
return 0, nil
}
// Parse transaction mode from the script
config, cleanedStatement := base.ParseTransactionConfig(statement)
statement = cleanedStatement
transactionMode := config.Mode
// Apply default when transaction mode is not specified
if transactionMode == transaction.ModeUnspecified {
transactionMode = transaction.DefaultMode()
}
owner, err := d.GetCurrentDatabaseOwner(ctx)
if err != nil {
return 0, err
}
var commands []base.Statement
var nonTransactionAndSetRoleStmts []base.Statement
var isPlsql bool
singleSQLs, err := crdbparser.SplitSQLStatement(statement)
if err != nil {
return 0, err
}
for _, singleSQL := range singleSQLs {
commands = append(commands, base.Statement{Text: singleSQL})
}
// If the statement is a single statement and is a PL/pgSQL block,
// we should execute it as a single statement without transaction.
// If the statement is a PL/pgSQL block, we should execute it as a single statement.
// https://www.postgresql.org/docs/current/plpgsql-control-structures.html
if len(singleSQLs) == 1 && pgparser.IsPlSQLBlock(singleSQLs[0]) {
isPlsql = true
}
var tmpCommands []base.Statement
for _, command := range commands {
switch {
case isSetRoleStatement(command.Text):
nonTransactionAndSetRoleStmts = append(nonTransactionAndSetRoleStmts, command)
case IsNonTransactionStatement(command.Text):
nonTransactionAndSetRoleStmts = append(nonTransactionAndSetRoleStmts, command)
continue
case isSuperuserStatement(command.Text):
// Use superuser privilege to run privileged statements.
slog.Info("Use superuser privilege to run privileged statements", slog.String("statement", command.Text))
ct := command.Text
if !strings.HasSuffix(strings.TrimRightFunc(ct, unicode.IsSpace), ";") {
ct += ";"
}
command.Text = fmt.Sprintf("SET LOCAL ROLE NONE;%sSET LOCAL ROLE '%s';", ct, owner)
default:
// Regular statements, keep as is
}
tmpCommands = append(tmpCommands, command)
}
commands = tmpCommands
// Execute based on transaction mode
if transactionMode == transaction.ModeOff {
return d.executeInAutoCommitMode(ctx, owner, statement, commands, nonTransactionAndSetRoleStmts, opts, isPlsql)
}
return d.executeInTransactionMode(ctx, owner, statement, commands, nonTransactionAndSetRoleStmts, opts, isPlsql)
}
func (d *Driver) executeInTransactionMode(
ctx context.Context,
owner string,
statement string,
commands []base.Statement,
nonTransactionAndSetRoleStmts []base.Statement,
opts db.ExecuteOptions,
isPlsql bool,
) (int64, error) {
conn, err := d.db.Conn(ctx)
if err != nil {
return 0, errors.Wrapf(err, "failed to get connection")
}
defer conn.Close()
if isPlsql {
// USE SET SESSION ROLE to set the role for the current session.
if err := crdb.Execute(func() error {
_, err := conn.ExecContext(ctx, fmt.Sprintf("SET SESSION ROLE '%s'", owner)) // NOSONAR(go:S2077) owner is from pg_roles system catalog, not user input
return err
}); err != nil {
return 0, errors.Wrapf(err, "failed to set role to database owner %q", owner)
}
opts.LogCommandExecute(&storepb.Range{Start: 0, End: int32(len(statement))}, statement)
if err := crdb.Execute(func() error {
_, err := conn.ExecContext(ctx, statement)
return err
}); err != nil {
opts.LogCommandResponse(0, []int64{0}, err.Error())
return 0, err
}
opts.LogCommandResponse(0, []int64{0}, "")
return 0, nil
}
totalRowsAffected := int64(0)
totalCommands := len(commands)
if totalCommands > 0 {
err = conn.Raw(func(driverConn any) error {
conn := driverConn.(*stdlib.Conn).Conn()
tx, err := conn.Begin(ctx)
if err != nil {
opts.LogTransactionControl(storepb.TaskRunLog_TransactionControl_BEGIN, err.Error())
return errors.Wrapf(err, "failed to begin transaction")
}
opts.LogTransactionControl(storepb.TaskRunLog_TransactionControl_BEGIN, "")
committed := false
defer func() {
err := tx.Rollback(ctx)
if committed {
return
}
var rerr string
if err != nil {
rerr = err.Error()
}
opts.LogTransactionControl(storepb.TaskRunLog_TransactionControl_ROLLBACK, rerr)
}()
// Set the current transaction role to the database owner so that the owner of created objects will be the same as the database owner.
if _, err := tx.Exec(ctx, fmt.Sprintf("SET LOCAL ROLE '%s'", owner)); err != nil {
return err
}
for _, command := range commands {
opts.LogCommandExecute(command.Range, command.Text)
rr := tx.Conn().PgConn().Exec(ctx, command.Text)
results, err := rr.ReadAll()
if err != nil {
opts.LogCommandResponse(0, nil, err.Error())
return err
}
var rowsAffected int64
var allRowsAffected []int64
for _, result := range results {
ra := result.CommandTag.RowsAffected()
allRowsAffected = append(allRowsAffected, ra)
rowsAffected += ra
}
opts.LogCommandResponse(rowsAffected, allRowsAffected, "")
totalRowsAffected += rowsAffected
}
if err := tx.Commit(ctx); err != nil {
opts.LogTransactionControl(storepb.TaskRunLog_TransactionControl_COMMIT, err.Error())
return errors.Wrapf(err, "failed to commit transaction")
}
opts.LogTransactionControl(storepb.TaskRunLog_TransactionControl_COMMIT, "")
committed = true
return nil
})
if err != nil {
return 0, err
}
}
// USE SET SESSION ROLE to set the role for the current session.
if err := crdb.Execute(func() error {
_, err := conn.ExecContext(ctx, fmt.Sprintf("SET SESSION ROLE '%s'", owner)) // NOSONAR(go:S2077) owner is from pg_roles system catalog, not user input
return err
}); err != nil {
return 0, errors.Wrapf(err, "failed to set role to database owner %q", owner)
}
// Run non-transaction statements at the end.
for _, stmt := range nonTransactionAndSetRoleStmts {
opts.LogCommandExecute(stmt.Range, stmt.Text)
if err := crdb.Execute(func() error {
_, err := conn.ExecContext(ctx, stmt.Text)
return err
}); err != nil {
opts.LogCommandResponse(0, []int64{0}, err.Error())
return 0, err
}
opts.LogCommandResponse(0, []int64{0}, "")
}
return totalRowsAffected, nil
}
func (d *Driver) executeInAutoCommitMode(
ctx context.Context,
owner string,
statement string,
commands []base.Statement,
nonTransactionAndSetRoleStmts []base.Statement,
opts db.ExecuteOptions,
isPlsql bool,
) (int64, error) {
// For auto-commit mode, treat all statements as non-transactional
nonTransactionAndSetRoleStmts = append(nonTransactionAndSetRoleStmts, commands...)
conn, err := d.db.Conn(ctx)
if err != nil {
return 0, errors.Wrapf(err, "failed to get connection")
}
defer conn.Close()
if isPlsql {
// USE SET SESSION ROLE to set the role for the current session.
if err := crdb.Execute(func() error {
_, err := conn.ExecContext(ctx, fmt.Sprintf("SET SESSION ROLE '%s'", owner)) // NOSONAR(go:S2077) owner is from pg_roles system catalog, not user input
return err
}); err != nil {
return 0, errors.Wrapf(err, "failed to set role to database owner %q", owner)
}
opts.LogCommandExecute(&storepb.Range{Start: 0, End: int32(len(statement))}, statement)
if err := crdb.Execute(func() error {
_, err := conn.ExecContext(ctx, statement)
return err
}); err != nil {
return 0, err
}
opts.LogCommandResponse(0, []int64{0}, "")
return 0, nil
}
// USE SET SESSION ROLE to set the role for the current session.
if err := crdb.Execute(func() error {
_, err := conn.ExecContext(ctx, fmt.Sprintf("SET SESSION ROLE '%s'", owner)) // NOSONAR(go:S2077) owner is from pg_roles system catalog, not user input
return err
}); err != nil {
return 0, errors.Wrapf(err, "failed to set role to database owner %q", owner)
}
totalRowsAffected := int64(0)
// Execute all statements individually in auto-commit mode
for _, stmt := range nonTransactionAndSetRoleStmts {
opts.LogCommandExecute(stmt.Range, stmt.Text)
if err := crdb.Execute(func() error {
sqlResult, err := conn.ExecContext(ctx, stmt.Text)
if err != nil {
opts.LogCommandResponse(0, []int64{0}, err.Error())
return err
}
rowsAffected, err := sqlResult.RowsAffected()
if err != nil {
// CockroachDB returns error for statements that don't support RowsAffected
rowsAffected = 0
}
opts.LogCommandResponse(rowsAffected, []int64{rowsAffected}, "")
totalRowsAffected += rowsAffected
return nil
}); err != nil {
return totalRowsAffected, err
}
}
return totalRowsAffected, nil
}
func (d *Driver) createDatabaseExecute(ctx context.Context, statement string) error {
databaseName, err := getDatabaseInCreateDatabaseStatement(statement)
if err != nil {
return err
}
databases, err := d.getDatabases(ctx)
if err != nil {
return err
}
for _, database := range databases {
if database.Name == databaseName {
// Database already exists.
return nil
}
}
for _, s := range strings.Split(statement, "\n") {
if err := crdb.Execute(func() error {
_, err := d.db.ExecContext(ctx, s)
return err
}); err != nil {
return err
}
}
return nil
}
var (
// DROP DATABASE cannot run inside a transaction block.
// DROP DATABASE [ IF EXISTS ] name [ [ WITH ] ( option [, ...] ) ]。
dropDatabaseReg = regexp.MustCompile(`(?i)DROP DATABASE`)
// CREATE INDEX CONCURRENTLY cannot run inside a transaction block.
// CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] name ] ON [ ONLY ] table_name [ USING method ] ...
createIndexReg = regexp.MustCompile(`(?i)CREATE(\s+(UNIQUE\s+)?)INDEX(\s+)CONCURRENTLY`)
// DROP INDEX CONCURRENTLY cannot run inside a transaction block.
// DROP INDEX [ CONCURRENTLY ] [ IF EXISTS ] name [, ...] [ CASCADE | RESTRICT ].
dropIndexReg = regexp.MustCompile(`(?i)DROP(\s+)INDEX(\s+)CONCURRENTLY`)
// VACUUM cannot run inside a transaction block.
// VACUUM [ ( option [, ...] ) ] [ table_and_columns [, ...] ]
// VACUUM [ FULL ] [ FREEZE ] [ VERBOSE ] [ ANALYZE ] [ table_and_columns [, ...] ].
vacuumReg = regexp.MustCompile(`(?i)^\s*VACUUM`)
// SET ROLE is a special statement that should be run before any other statements containing inside a transaction block or not.
setRoleReg = regexp.MustCompile(`(?i)SET\s+((SESSION|LOCAL)\s+)?ROLE`)
)
func isSetRoleStatement(stmt string) bool {
return len(setRoleReg.FindString(stmt)) > 0
}
func IsNonTransactionStatement(stmt string) bool {
if len(dropDatabaseReg.FindString(stmt)) > 0 {
return true
}
if len(createIndexReg.FindString(stmt)) > 0 {
return true
}
if len(dropIndexReg.FindString(stmt)) > 0 {
return true
}
return len(vacuumReg.FindString(stmt)) > 0
}
func isSuperuserStatement(stmt string) bool {
upperCaseStmt := strings.ToUpper(strings.TrimLeftFunc(stmt, unicode.IsSpace))
if strings.HasPrefix(upperCaseStmt, "GRANT") || strings.HasPrefix(upperCaseStmt, "CREATE EXTENSION") || strings.HasPrefix(upperCaseStmt, "CREATE EVENT TRIGGER") || strings.HasPrefix(upperCaseStmt, "COMMENT ON EVENT TRIGGER") {
return true
}
return false
}
func getDatabaseInCreateDatabaseStatement(createDatabaseStatement string) (string, error) {
raw := strings.TrimRight(createDatabaseStatement, ";")
raw = strings.TrimPrefix(raw, "CREATE DATABASE")
tokens := strings.Fields(raw)
if len(tokens) == 0 {
return "", errors.Errorf("database name not found")
}
databaseName := strings.TrimLeft(tokens[0], `"`)
databaseName = strings.TrimRight(databaseName, `"`)
return databaseName, nil
}
// GetCurrentDatabaseOwner gets the role of the current database.
func (d *Driver) GetCurrentDatabaseOwner(ctx context.Context) (string, error) {
const query = `
SELECT
u.rolname
FROM
pg_roles AS u JOIN pg_database AS d ON (d.datdba = u.oid)
WHERE
d.datname = current_database();
`
var owner string
if err := d.db.QueryRowContext(ctx, query).Scan(&owner); err != nil {
return "", err
}
return owner, nil
}
// QueryConn queries a SQL statement in a given connection.
func (*Driver) QueryConn(ctx context.Context, conn *sql.Conn, statement string, queryContext db.QueryContext) ([]*v1pb.QueryResult, error) {
singleSQLs, err := crdbparser.SplitSQLStatement(statement)
if err != nil {
return nil, err
}
if len(singleSQLs) == 0 {
return nil, nil
}
var results []*v1pb.QueryResult
for _, singleSQL := range singleSQLs {
statement := singleSQL
planAsJSON := false
if queryContext.Explain {
explained, err := base.ExplainStatement(storepb.Engine_COCKROACHDB, statement, db.ExplainFormat(queryContext.Option.GetExplainFormat()))
if err != nil {
return nil, err
}
planAsJSON = db.ExplainFormat(queryContext.Option.GetExplainFormat()) == base.ExplainFormatJSON
statement = explained
} else if queryContext.Limit > 0 {
statement = base.StatementWithResultLimit(storepb.Engine_COCKROACHDB, statement, queryContext.Limit, "")
}
_, allQuery, err := base.ValidateSQLForEditor(storepb.Engine_POSTGRES, statement)
if err != nil {
return nil, err
}
// Sanitize the schema name by escaping any quotes.
safeSchemeName := strings.ReplaceAll(queryContext.Schema, "\"", "\"\"")
// If the queryContext.Schema is not empty, set the search path for the database connection to the specified schema.
if queryContext.Schema != "" {
if err := crdb.Execute(func() error {
_, err := conn.ExecContext(ctx, fmt.Sprintf(`SET search_path TO "%s";`, safeSchemeName)) // NOSONAR(go:S2077) safeSchemeName is sanitized by escaping double quotes above
return err
}); err != nil {
return nil, err
}
}
startTime := time.Now()
queryResult, err := func() (*v1pb.QueryResult, error) {
if allQuery {
location := util.PgSessionLocation(conn)
var r *v1pb.QueryResult
if err := crdb.Execute(func() error {
rows, err := conn.QueryContext(ctx, statement)
if err != nil {
return err
}
defer rows.Close()
r, err = util.RowsToQueryResult(rows, makeValueByTypeName, convertValueIn(location), queryContext.MaximumSQLResultSize)
if err != nil {
return err
}
err = rows.Err()
return err
}); err != nil {
return nil, err
}
if planAsJSON {
return planDiagram(r)
}
return r, nil
}
var sqlResult sql.Result
if err := crdb.Execute(func() error {
var err error
sqlResult, err = conn.ExecContext(ctx, statement)
return err
}); err != nil {
return nil, err
}
affectedRows, err := sqlResult.RowsAffected()
if err != nil {
slog.Info("rowsAffected returns error", log.BBError(err))
}
return util.BuildAffectedRowsResult(affectedRows, nil), nil
}()
stop := false
if err != nil {
queryResult = &v1pb.QueryResult{
Error: err.Error(),
}
stop = true
}
queryResult.Statement = statement
queryResult.Latency = durationpb.New(time.Since(startTime))
queryResult.RowsCount = int64(len(queryResult.Rows))
results = append(results, queryResult)
if stop {
break
}
}
return results, nil
}
// diagramLink is the line EXPLAIN (DISTSQL) prints after the text plan. What
// follows the fragment marker is the plan itself, deflated and base64'd.
var diagramLink = regexp.MustCompile(`https?://\S*#([A-Za-z0-9+/_=-]+)`)
// planDiagram returns the physical plan EXPLAIN (DISTSQL) encodes in the link
// it prints, as the JSON document the query-plan viewer parses.
//
// CockroachDB publishes no plan as a document: every EXPLAIN option of its own
// returns text, and the one machine-readable form it has is the payload behind
// this link, which its own diagram page decodes in the browser. Decoding it
// here is what lets the viewer draw the plan without the browser fetching
// anything, and it is the same move the Oracle driver makes in rendering the
// plan table.
func planDiagram(result *v1pb.QueryResult) (*v1pb.QueryResult, error) {
var payload string
for _, row := range result.GetRows() {
for _, value := range row.GetValues() {
if match := diagramLink.FindStringSubmatch(value.GetStringValue()); match != nil {
payload = match[1]
}
}
}
if payload == "" {
return nil, errors.New("the plan carried no diagram to read")
}
// CockroachDB encodes with the standard alphabet, but the payload rides in
// a URL fragment, so accept either spelling of the two bytes that differ.
normalized := strings.NewReplacer("-", "+", "_", "/").Replace(strings.TrimRight(payload, "="))
deflated, err := base64.RawStdEncoding.DecodeString(normalized)
if err != nil {
return nil, errors.Wrap(err, "failed to decode the query plan")
}
reader, err := zlib.NewReader(bytes.NewReader(deflated))
if err != nil {
return nil, errors.Wrap(err, "failed to read the query plan")
}
defer reader.Close()
// A plan is small; the bound keeps a corrupt payload from inflating
// without end.
plan, err := io.ReadAll(io.LimitReader(reader, maxPlanBytes))
if err != nil {
return nil, errors.Wrap(err, "failed to read the query plan")
}
return &v1pb.QueryResult{
ColumnNames: []string{"plan"},
ColumnTypeNames: []string{"TEXT"},
Rows: []*v1pb.QueryRow{{Values: []*v1pb.RowValue{
{Kind: &v1pb.RowValue_StringValue{StringValue: string(plan)}},
}}},
}, nil
}
// maxPlanBytes bounds the inflated plan. CockroachDB's diagrams run to a few
// tens of kilobytes; this is far above that and far below anything that would
// trouble the editor.
const maxPlanBytes = 8 << 20