feat: expose underlying *spanner.Client (#313)

* feat: expose underlying *spanner.Client

Sometimes the exposed features of go-sql-spanner are not sufficient to
get the necessary response. This adds an escape hatch to access the
underlying client.

Fixes #312

* Update driver.go

Co-authored-by: Knut Olav Løite <koloite@gmail.com>

* Update driver.go

---------

Co-authored-by: Knut Olav Løite <koloite@gmail.com>

Author: egonelbre

driver.go

@@ -479,6 +479,15 @@ type SpannerConn interface {
 	// was executed on the connection, or an error if the connection has not executed a read/write transaction
 	// that committed successfully. The timestamp is in the local timezone.
 	CommitTimestamp() (commitTimestamp time.Time, err error)
+
+	// UnderlyingClient returns the underlying Spanner client for the database.
+	// The client cannot be used to access the current transaction or batch on
+	// this connection. Executing a transaction or batch using the client that is
+	// returned, does not affect this connection.
+	// Note that multiple connections share the same Spanner client. Calling
+	// this function on different connections to the same database, can
+	// return the same Spanner client.
+	UnderlyingClient() (client *spanner.Client, err error)
 }
 
 type conn struct {
@@ -542,6 +551,10 @@ const (
 	PartitionedNonAtomic
 )
 
+func (c *conn) UnderlyingClient() (*spanner.Client, error) {
+	return c.client, nil
+}
+
 func (c *conn) CommitTimestamp() (time.Time, error) {
 	if c.commitTs == nil {
 		return time.Time{}, spanner.ToSpannerError(status.Error(codes.FailedPrecondition, "this connection has not executed a read/write transaction that committed successfully"))
@@ -1150,8 +1163,8 @@ var valuerReflectType = reflect.TypeOf((*driver.Valuer)(nil)).Elem()
 // to those types to mean nil/NULL, just like the Go database/sql package.
 func callValuerValue(vr driver.Valuer) (v driver.Value, err error) {
 	if rv := reflect.ValueOf(vr); rv.Kind() == reflect.Ptr &&
-			rv.IsNil() &&
-			rv.Type().Elem().Implements(valuerReflectType) {
+		rv.IsNil() &&
+		rv.Type().Elem().Implements(valuerReflectType) {
 		return nil, nil
 	}
 	return vr.Value()

examples/underlying-client/main.go

@@ -0,0 +1,71 @@
+// 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
+//
+//     https://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 main
+
+import (
+	"context"
+	"database/sql"
+	"fmt"
+
+	"cloud.google.com/go/spanner"
+	_ "github.com/googleapis/go-sql-spanner"
+	spannerdriver "github.com/googleapis/go-sql-spanner"
+	"github.com/googleapis/go-sql-spanner/examples"
+)
+
+// Example of using the underlying *spanner.Client.
+func underlyingClient(projectId, instanceId, databaseId string) error {
+	ctx := context.Background()
+	db, err := sql.Open("spanner", fmt.Sprintf("projects/%s/instances/%s/databases/%s", projectId, instanceId, databaseId))
+	if err != nil {
+		return fmt.Errorf("failed to open database connection: %v\n", err)
+	}
+	defer db.Close()
+
+	conn, err := db.Conn(ctx)
+	if err != nil {
+		return err
+	}
+	defer conn.Close()
+
+	if err := conn.Raw(func(driverConn any) error {
+		spannerConn, ok := driverConn.(spannerdriver.SpannerConn)
+		if !ok {
+			return fmt.Errorf("unexpected driver connection %v, expected SpannerConn", driverConn)
+		}
+		client, err := spannerConn.UnderlyingClient()
+		if err != nil {
+			return fmt.Errorf("unable to access underlying client: %w", err)
+		}
+
+		row := client.Single().Query(ctx, spanner.Statement{SQL: "SELECT 1"})
+		return row.Do(func(r *spanner.Row) error {
+			var value int64
+			err := r.Columns(&value)
+			if err != nil {
+				return fmt.Errorf("failed to read column: %w", err)
+			}
+			fmt.Println(value)
+			return nil
+		})
+	}); err != nil {
+		return err
+	}
+	return nil
+}
+
+func main() {
+	examples.RunSampleOnEmulator(underlyingClient)
+}