Skip to content

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

9.9 KB
Raw Blame
package cassandra

import (
	"context"
	"database/sql"
	"encoding/json"
	"fmt"
	"log/slog"
	"math/big"
	"time"

	"connectrpc.com/connect"
	gocql "github.com/apache/cassandra-gocql-driver/v2"
	"github.com/cockroachdb/cockroachdb-parser/pkg/util/timeofday"
	"github.com/pkg/errors"
	"google.golang.org/protobuf/proto"
	"google.golang.org/protobuf/types/known/durationpb"
	"google.golang.org/protobuf/types/known/timestamppb"
	"gopkg.in/inf.v0"

	"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/util"
	"github.com/bytebase/bytebase/backend/plugin/parser/base"
)

func init() {
	db.Register(storepb.Engine_CASSANDRA, newDriver)
}

type Driver struct {
	config db.ConnectionConfig

	session *gocql.Session
}

func newDriver() db.Driver {
	return &Driver{}
}

func (*Driver) Open(_ context.Context, _ storepb.Engine, config db.ConnectionConfig) (db.Driver, error) {
	addrs := []string{
		formatAddress(config.DataSource.Host, config.DataSource.Port),
	}
	for _, addr := range config.DataSource.AdditionalAddresses {
		addrs = append(addrs, formatAddress(addr.Host, addr.Port))
	}
	cluster := gocql.NewCluster(addrs...)
	cluster.Authenticator = gocql.PasswordAuthenticator{
		Username: config.DataSource.Username,
		Password: config.Password,
	}
	cluster.Keyspace = config.ConnectionContext.DatabaseName

	if config.DataSource.GetUseSsl() {
		tlsConfig, err := util.GetTLSConfig(config.DataSource)
		if err != nil {
			return nil, errors.Wrapf(err, "failed to get ssl config")
		}
		cluster.SslOpts = &gocql.SslOptions{
			Config: tlsConfig,
		}
	}

	session, err := cluster.CreateSession()
	if err != nil {
		return nil, errors.Wrapf(err, "failed to create session")
	}

	return &Driver{
		config:  config,
		session: session,
	}, nil
}

func (d *Driver) Close(context.Context) error {
	if d.session != nil {
		d.session.Close()
	}
	return nil
}

func (d *Driver) Ping(ctx context.Context) error {
	var version string
	err := d.session.Query("SELECT release_version FROM system.local").ScanContext(ctx, &version)
	if err != nil {
		return errors.Wrapf(err, "failed to ping")
	}
	return nil
}

func (*Driver) GetDB() *sql.DB {
	return nil
}

func (d *Driver) Execute(ctx context.Context, rawStatement string, _ db.ExecuteOptions) (int64, error) {
	stmts, err := util.SanitizeSQL(rawStatement)
	if err != nil {
		return 0, errors.Wrapf(err, "failed to split sql")
	}

	for _, stmt := range stmts {
		if err := d.session.Query(stmt).ExecContext(ctx); err != nil {
			return 0, errors.Wrapf(err, "failed to execute")
		}
	}

	return 0, nil
}
func (d *Driver) QueryConn(ctx context.Context, _ *sql.Conn, rawStatement string, queryContext db.QueryContext) ([]*v1pb.QueryResult, error) {
	stmts, err := util.SanitizeSQL(rawStatement)
	if err != nil {
		return nil, errors.Wrapf(err, "failed to split sql")
	}

	var results []*v1pb.QueryResult
	for _, stmt := range stmts {
		startTime := time.Now()
		queryResult, err := func() (*v1pb.QueryResult, error) {
			if _, _, err := base.ValidateSQLForEditor(storepb.Engine_CASSANDRA, stmt); err != nil {
				return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("support Cassandra SELECT statement only, err: %s", err.Error()))
			}
			result := &v1pb.QueryResult{}
			pageSize := 0
			if queryContext.Limit > 0 {
				pageSize = queryContext.Limit
			}
			var pageState []byte
			for {
				nextPageState, err := func() ([]byte, error) {
					iter := d.session.Query(stmt).PageSize(pageSize).PageState(pageState).IterContext(ctx)
					defer iter.Close()
					nextPageState := iter.PageState()

					if len(result.ColumnNames) == 0 {
						for _, c := range iter.Columns() {
							result.ColumnNames = append(result.ColumnNames, c.Name)
							result.ColumnTypeNames = append(result.ColumnTypeNames, typeToString(c.TypeInfo.Type()))
						}
					}
					for {
						rowData, err := iter.RowData()
						if err != nil {
							return nil, errors.Wrap(err, "failed to fetch row data")
						}
						if !iter.Scan(rowData.Values...) {
							break
						}

						row := &v1pb.QueryRow{}
						for _, v := range rowData.Values {
							row.Values = append(row.Values, convertRowValue(v))
						}

						result.Rows = append(result.Rows, row)
						n := len(result.Rows)
						if (n&(n-1) == 0) && int64(proto.Size(result)) > queryContext.MaximumSQLResultSize {
							result.Error = util.FormatMaximumSQLResultSizeMessage(queryContext.MaximumSQLResultSize)
							break
						}

						if queryContext.Limit > 0 && queryContext.Limit == n {
							return nil, nil
						}
					}
					if err := iter.Close(); err != nil {
						return nil, errors.Wrapf(err, "iter close err")
					}

					return nextPageState, nil
				}()
				if err != nil {
					return nil, err
				}
				if len(nextPageState) == 0 {
					break
				}
				pageState = nextPageState
			}
			return result, nil
		}()
		stop := false
		if err != nil {
			queryResult = &v1pb.QueryResult{
				Error: err.Error(),
			}
			stop = true
		}
		queryResult.Statement = stmt
		queryResult.Latency = durationpb.New(time.Since(startTime))
		queryResult.RowsCount = int64(len(queryResult.Rows))
		results = append(results, queryResult)
		if stop {
			break
		}
	}

	return results, nil
}

func convertRowValue(v any) *v1pb.RowValue {
	switch v := v.(type) {
	case *string:
		if v == nil {
			return util.NullRowValue
		}
		return &v1pb.RowValue{
			Kind: &v1pb.RowValue_StringValue{
				StringValue: *v,
			},
		}
	case *int64:
		if v == nil {
			return util.NullRowValue
		}
		return &v1pb.RowValue{
			Kind: &v1pb.RowValue_Int64Value{
				Int64Value: *v,
			},
		}
	case *time.Duration:
		if v == nil {
			return util.NullRowValue
		}
		// time of the day
		// e.g. '08:12:54'
		s, ns := v.Nanoseconds()/1_000_000_000, v.Nanoseconds()%1_000_000_000
		display := timeofday.FromTime(time.Unix(s, ns)).String()
		return &v1pb.RowValue{
			Kind: &v1pb.RowValue_StringValue{
				StringValue: display,
			},
		}
	case *time.Time:
		if v == nil {
			return util.NullRowValue
		}
		return &v1pb.RowValue{
			Kind: &v1pb.RowValue_TimestampValue{
				TimestampValue: &v1pb.RowValue_Timestamp{
					GoogleTimestamp: timestamppb.New(*v),
					Accuracy:        3,
				},
			},
		}
	case *[]byte:
		if v == nil {
			return util.NullRowValue
		}
		return &v1pb.RowValue{
			Kind: &v1pb.RowValue_BytesValue{
				BytesValue: *v,
			},
		}
	case *bool:
		if v == nil {
			return util.NullRowValue
		}
		return &v1pb.RowValue{
			Kind: &v1pb.RowValue_BoolValue{
				BoolValue: *v,
			},
		}
	case *float32:
		if v == nil {
			return util.NullRowValue
		}
		return &v1pb.RowValue{
			Kind: &v1pb.RowValue_FloatValue{
				FloatValue: *v,
			},
		}
	case *float64:
		if v == nil {
			return util.NullRowValue
		}
		return &v1pb.RowValue{
			Kind: &v1pb.RowValue_DoubleValue{
				DoubleValue: *v,
			},
		}
	case *int:
		if v == nil {
			return util.NullRowValue
		}
		return &v1pb.RowValue{
			Kind: &v1pb.RowValue_Int64Value{
				Int64Value: int64(*v),
			},
		}
	case *int16:
		if v == nil {
			return util.NullRowValue
		}
		return &v1pb.RowValue{
			Kind: &v1pb.RowValue_Int32Value{
				Int32Value: int32(*v),
			},
		}
	case *int8:
		if v == nil {
			return util.NullRowValue
		}
		return &v1pb.RowValue{
			Kind: &v1pb.RowValue_Int32Value{
				Int32Value: int32(*v),
			},
		}
	case *gocql.UUID:
		if v == nil {
			return util.NullRowValue
		}
		return &v1pb.RowValue{
			Kind: &v1pb.RowValue_StringValue{
				StringValue: v.String(),
			},
		}
	case **inf.Dec:
		if v == nil || *v == nil {
			return util.NullRowValue
		}
		return &v1pb.RowValue{
			Kind: &v1pb.RowValue_StringValue{
				StringValue: (*v).String(),
			},
		}
	case **big.Int:
		if v == nil || *v == nil {
			return util.NullRowValue
		}
		return &v1pb.RowValue{
			Kind: &v1pb.RowValue_StringValue{
				StringValue: (*v).String(),
			},
		}
	case *gocql.Duration:
		if v == nil {
			return util.NullRowValue
		}
		display := time.Duration(v.Nanoseconds).String()
		if v.Days > 0 {
			display = fmt.Sprintf("%dd%s", v.Days, display)
		}
		if v.Months > 0 {
			display = fmt.Sprintf("%dmo%s", v.Months, display)
		}
		return &v1pb.RowValue{
			Kind: &v1pb.RowValue_StringValue{
				StringValue: display,
			},
		}

	default:
		// Handle complex types (LIST, MAP, SET, UDT) by converting to JSON strings
		jsonBytes, err := json.Marshal(v)
		if err != nil {
			slog.Error("failed to marshal Cassandra complex value", log.BBError(err))
			return &v1pb.RowValue{
				Kind: &v1pb.RowValue_StringValue{
					StringValue: fmt.Sprintf("%v", v),
				},
			}
		}
		return &v1pb.RowValue{
			Kind: &v1pb.RowValue_StringValue{
				StringValue: string(jsonBytes),
			},
		}
	}
}

func formatAddress(host, port string) string {
	if port == "" {
		return host
	}
	return host + ":" + port
}

func typeToString(t gocql.Type) string {
	switch t {
	case gocql.TypeCustom:
		return "custom"
	case gocql.TypeAscii:
		return "ascii"
	case gocql.TypeBigInt:
		return "bigint"
	case gocql.TypeBlob:
		return "blob"
	case gocql.TypeBoolean:
		return "boolean"
	case gocql.TypeCounter:
		return "counter"
	case gocql.TypeDecimal:
		return "decimal"
	case gocql.TypeDouble:
		return "double"
	case gocql.TypeFloat:
		return "float"
	case gocql.TypeInt:
		return "int"
	case gocql.TypeText:
		return "text"
	case gocql.TypeTimestamp:
		return "timestamp"
	case gocql.TypeUUID:
		return "uuid"
	case gocql.TypeVarchar:
		return "varchar"
	case gocql.TypeVarint:
		return "varint"
	case gocql.TypeTimeUUID:
		return "timeuuid"
	case gocql.TypeInet:
		return "inet"
	case gocql.TypeDate:
		return "date"
	case gocql.TypeTime:
		return "time"
	case gocql.TypeSmallInt:
		return "smallint"
	case gocql.TypeTinyInt:
		return "tinyint"
	case gocql.TypeDuration:
		return "duration"
	case gocql.TypeList:
		return "list"
	case gocql.TypeMap:
		return "map"
	case gocql.TypeSet:
		return "set"
	case gocql.TypeUDT:
		return "udt"
	case gocql.TypeTuple:
		return "tuple"
	default:
		return fmt.Sprintf("unknown(%d)", t)
	}
}