Merge pull request #1574 from ydb-platform/options-execute

publish options.Execute

Author: asmyasnikov

CHANGELOG.md

@@ -1,3 +1,5 @@
+* Published `query.ExecuteOption` as alias to `internal/query/options.Execute`
+
 ## v3.93.0
 * Added `ydb.WithStaticCredentialsLogin` and `ydb.WithStaticCredentialsPassword` options
 
@@ -6,7 +8,7 @@
 * Added `database/sql/driver.Value` as type destination for almost ydb values
 
 ## v3.92.5
-* Avoid retrying requests finished with 'UNAUTHORIZED' errors
+* Avoid retrying requests finished with `UNAUTHORIZED` errors
 
 ## v3.92.4
 * Fixed connections pool leak on closing

query/client.go

@@ -17,25 +17,25 @@ type (
 		//
 		// Exec used by default:
 		// - DefaultTxControl
-		Exec(ctx context.Context, query string, opts ...options.Execute) error
+		Exec(ctx context.Context, query string, opts ...ExecuteOption) error
 
 		// Query execute query with result
 		//
 		// Exec used by default:
 		// - DefaultTxControl
-		Query(ctx context.Context, query string, opts ...options.Execute) (Result, error)
+		Query(ctx context.Context, query string, opts ...ExecuteOption) (Result, error)
 
 		// QueryResultSet execute query and take the exactly single materialized result set from result
 		//
 		// Exec used by default:
 		// - DefaultTxControl
-		QueryResultSet(ctx context.Context, query string, opts ...options.Execute) (ClosableResultSet, error)
+		QueryResultSet(ctx context.Context, query string, opts ...ExecuteOption) (ClosableResultSet, error)
 
 		// QueryRow execute query and take the exactly single row from exactly single result set from result
 		//
 		// Exec used by default:
 		// - DefaultTxControl
-		QueryRow(ctx context.Context, query string, opts ...options.Execute) (Row, error)
+		QueryRow(ctx context.Context, query string, opts ...ExecuteOption) (Row, error)
 	}
 	// Client defines API of query client
 	Client interface {
@@ -68,31 +68,31 @@ type (
 		//
 		// Exec used by default:
 		// - DefaultTxControl
-		Exec(ctx context.Context, query string, opts ...options.Execute) error
+		Exec(ctx context.Context, query string, opts ...ExecuteOption) error
 
 		// Query execute query with materialized result
 		//
 		// Warning: the large result from query will be materialized and can happened to "OOM killed" problem
 		//
 		// Exec used by default:
 		// - DefaultTxControl
-		Query(ctx context.Context, query string, opts ...options.Execute) (Result, error)
+		Query(ctx context.Context, query string, opts ...ExecuteOption) (Result, error)
 
 		// QueryResultSet is a helper which read all rows from first result set in result
 		//
 		// Warning: the large result set from query will be materialized and can happened to "OOM killed" problem
-		QueryResultSet(ctx context.Context, query string, opts ...options.Execute) (ClosableResultSet, error)
+		QueryResultSet(ctx context.Context, query string, opts ...ExecuteOption) (ClosableResultSet, error)
 
 		// QueryRow is a helper which read only one row from first result set in result
 		//
 		// ReadRow returns error if result contains more than one result set or more than one row
-		QueryRow(ctx context.Context, query string, opts ...options.Execute) (Row, error)
+		QueryRow(ctx context.Context, query string, opts ...ExecuteOption) (Row, error)
 
 		// ExecuteScript starts long executing script with polling results later
 		//
 		// Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental
 		ExecuteScript(
-			ctx context.Context, query string, ttl time.Duration, ops ...options.Execute,
+			ctx context.Context, query string, ttl time.Duration, ops ...ExecuteOption,
 		) (*options.ExecuteScriptOperation, error)
 
 		// FetchScriptResults fetching the script results

query/execute_options.go

@@ -8,6 +8,8 @@ import (
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/query/tx"
 )
 
+type ExecuteOption = options.Execute
+
 const (
 	SyntaxYQL        = options.SyntaxYQL
 	SyntaxPostgreSQL = options.SyntaxPostgreSQL
@@ -27,47 +29,47 @@ const (
 	StatsModeProfile = options.StatsModeProfile
 )
 
-func WithParameters(parameters *params.Parameters) options.Execute {
+func WithParameters(parameters *params.Parameters) ExecuteOption {
 	return options.WithParameters(parameters)
 }
 
-func WithTxControl(txControl *tx.Control) options.Execute {
+func WithTxControl(txControl *tx.Control) ExecuteOption {
 	return options.WithTxControl(txControl)
 }
 
 func WithTxSettings(txSettings tx.Settings) options.DoTxOption {
 	return options.WithTxSettings(txSettings)
 }
 
-func WithCommit() options.Execute {
+func WithCommit() ExecuteOption {
 	return options.WithCommit()
 }
 
-func WithExecMode(mode options.ExecMode) options.Execute {
+func WithExecMode(mode options.ExecMode) ExecuteOption {
 	return options.WithExecMode(mode)
 }
 
-func WithSyntax(syntax options.Syntax) options.Execute {
+func WithSyntax(syntax options.Syntax) ExecuteOption {
 	return options.WithSyntax(syntax)
 }
 
-func WithStatsMode(mode options.StatsMode, callback func(Stats)) options.Execute {
+func WithStatsMode(mode options.StatsMode, callback func(Stats)) ExecuteOption {
 	return options.WithStatsMode(mode, callback)
 }
 
 // WithResponsePartLimitSizeBytes limit size of each part (data portion) in stream for query service resoponse
 // it isn't limit total size of answer
-func WithResponsePartLimitSizeBytes(size int64) options.Execute {
+func WithResponsePartLimitSizeBytes(size int64) ExecuteOption {
 	return options.WithResponsePartLimitSizeBytes(size)
 }
 
-func WithCallOptions(opts ...grpc.CallOption) options.Execute {
+func WithCallOptions(opts ...grpc.CallOption) ExecuteOption {
 	return options.WithCallOptions(opts...)
 }
 
 // WithResourcePool is an option for define resource pool for execute query
 //
 // Read more https://ydb.tech/docs/ru/dev/resource-consumption-management
-func WithResourcePool(id string) options.Execute {
+func WithResourcePool(id string) ExecuteOption {
 	return options.WithResourcePool(id)
 }