// Copyright 2024 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package spanner import ( "context" "encoding/json" "fmt" "cloud.google.com/go/spanner" "github.com/goccy/go-yaml" "github.com/googleapis/genai-toolbox/internal/sources" "github.com/googleapis/genai-toolbox/internal/util" "github.com/googleapis/genai-toolbox/internal/util/orderedmap" "go.opentelemetry.io/otel/trace" "google.golang.org/api/iterator" ) const SourceType string = "spanner" // validate interface var _ sources.SourceConfig = Config{} func init() { if !sources.Register(SourceType, newConfig) { panic(fmt.Sprintf("source type %q already registered", SourceType)) } } func newConfig(ctx context.Context, name string, decoder *yaml.Decoder) (sources.SourceConfig, error) { actual := Config{Name: name, Dialect: "googlesql"} // Default dialect if err := decoder.DecodeContext(ctx, &actual); err != nil { return nil, err } return actual, nil } type Config struct { Name string `yaml:"name" validate:"required"` Type string `yaml:"type" validate:"required"` Project string `yaml:"project" validate:"required"` Instance string `yaml:"instance" validate:"required"` Dialect sources.Dialect `yaml:"dialect" validate:"required"` Database string `yaml:"database" validate:"required"` } func (r Config) SourceConfigType() string { return SourceType } func (r Config) Initialize(ctx context.Context, tracer trace.Tracer) (sources.Source, error) { client, err := initSpannerClient(ctx, tracer, r.Name, r.Project, r.Instance, r.Database) if err != nil { return nil, fmt.Errorf("unable to create client: %w", err) } s := &Source{ Config: r, Client: client, } return s, nil } var _ sources.Source = &Source{} type Source struct { Config Client *spanner.Client } func (s *Source) SourceType() string { return SourceType } func (s *Source) ToConfig() sources.SourceConfig { return s.Config } func (s *Source) SpannerClient() *spanner.Client { return s.Client } func (s *Source) DatabaseDialect() string { return s.Dialect.String() } // processRows iterates over the spanner.RowIterator and converts each row to a map[string]any. func processRows(iter *spanner.RowIterator) ([]any, error) { var out []any defer iter.Stop() for { row, err := iter.Next() if err == iterator.Done { break } if err != nil { return nil, fmt.Errorf("unable to parse row: %w", err) } rowMap := orderedmap.Row{} cols := row.ColumnNames() for i, c := range cols { if c == "object_details" { // for list graphs or list tables val := row.ColumnValue(i) if val == nil { // ColumnValue returns the Cloud Spanner Value of column i, or nil for invalid column. rowMap.Add(c, nil) } else { jsonString, ok := val.AsInterface().(string) if !ok { return nil, fmt.Errorf("column 'object_details' is not a string, but %T", val.AsInterface()) } var details map[string]any if err := json.Unmarshal([]byte(jsonString), &details); err != nil { return nil, fmt.Errorf("unable to unmarshal JSON: %w", err) } rowMap.Add(c, details) } } else { rowMap.Add(c, row.ColumnValue(i)) } } out = append(out, rowMap) } return out, nil } func (s *Source) RunSQL(ctx context.Context, readOnly bool, statement string, params map[string]any) (any, error) { var results []any var err error var opErr error stmt := spanner.Statement{ SQL: statement, } if params != nil { stmt.Params = params } if readOnly { iter := s.SpannerClient().Single().Query(ctx, stmt) results, opErr = processRows(iter) } else { _, opErr = s.SpannerClient().ReadWriteTransaction(ctx, func(ctx context.Context, txn *spanner.ReadWriteTransaction) error { iter := txn.Query(ctx, stmt) results, err = processRows(iter) if err != nil { return err } return nil }) } if opErr != nil { return nil, fmt.Errorf("unable to execute client: %w", opErr) } return results, nil } func initSpannerClient(ctx context.Context, tracer trace.Tracer, name, project, instance, dbname string) (*spanner.Client, error) { //nolint:all // Reassigned ctx ctx, span := sources.InitConnectionSpan(ctx, tracer, SourceType, name) defer span.End() // Configure the connection to the database db := fmt.Sprintf("projects/%s/instances/%s/databases/%s", project, instance, dbname) // Configure session pool to automatically clean inactive transactions sessionPoolConfig := spanner.SessionPoolConfig{ TrackSessionHandles: true, InactiveTransactionRemovalOptions: spanner.InactiveTransactionRemovalOptions{ ActionOnInactiveTransaction: spanner.WarnAndClose, }, } // Create spanner client userAgent, err := util.UserAgentFromContext(ctx) if err != nil { return nil, err } client, err := spanner.NewClientWithConfig(ctx, db, spanner.ClientConfig{SessionPoolConfig: sessionPoolConfig, UserAgent: userAgent}) if err != nil { return nil, fmt.Errorf("unable to create new client: %w", err) } return client, nil }