options

Documentation

Index

• Constants
• func ExecuteSettings(opts ...Execute) *executeSettings
• func ParseDoOpts(t *trace.Query, opts ...DoOption) (s *doSettings)
• func ParseDoTxOpts(t *trace.Query, opts ...DoTxOption) (s *doTxSettings)
• func WithCallOptions(opts ...grpc.CallOption) callOptionsOption
• func WithCommit() txCommitOption
• func WithExecMode(mode ExecMode) execModeOption
• func WithParameters(parameters *params.Parameters) parametersOption
• func WithStatsMode(mode StatsMode, callback func(stats.QueryStats)) statsModeOption
• func WithSyntax(syntax Syntax) syntaxOption
• func WithTxControl(txControl *tx.Control) *txControlOption
• func WithTxSettings(txSettings tx.Settings) doTxSettingsOption
• type DoOption
• type DoTxOption
• type ExecMode
• type Execute
• type ExecuteNoTx
• type ExecuteScriptOperation
• type FetchScriptOption
  • func WithFetchToken(fetchToken string) FetchScriptOption
  • func WithResultSetIndex(resultSetIndex int64) FetchScriptOption
  • func WithRowsLimit(rowsLimit int64) FetchScriptOption
• type FetchScriptResult
• type FetchScriptResultsRequest
• type MetadataExecuteQuery
  • func ToMetadataExecuteQuery(metadata *anypb.Any) *MetadataExecuteQuery
• type RetryOptionsOption
  • func WithIdempotent() RetryOptionsOption
  • func WithLabel(lbl string) RetryOptionsOption
  • func WithRetryBudget(b budget.Budget) RetryOptionsOption
• type StatsMode
• type Syntax
• type TraceOption
  • func WithTrace(t *trace.Query) TraceOption

Constants

const (
	SyntaxYQL        = Syntax(Ydb_Query.Syntax_SYNTAX_YQL_V1)
	SyntaxPostgreSQL = Syntax(Ydb_Query.Syntax_SYNTAX_PG)
)

const (
	ExecModeParse    = ExecMode(Ydb_Query.ExecMode_EXEC_MODE_PARSE)
	ExecModeValidate = ExecMode(Ydb_Query.ExecMode_EXEC_MODE_VALIDATE)
	ExecModeExplain  = ExecMode(Ydb_Query.ExecMode_EXEC_MODE_EXPLAIN)
	ExecModeExecute  = ExecMode(Ydb_Query.ExecMode_EXEC_MODE_EXECUTE)
)

const (
	StatsModeBasic   = StatsMode(Ydb_Query.StatsMode_STATS_MODE_BASIC)
	StatsModeNone    = StatsMode(Ydb_Query.StatsMode_STATS_MODE_NONE)
	StatsModeFull    = StatsMode(Ydb_Query.StatsMode_STATS_MODE_FULL)
	StatsModeProfile = StatsMode(Ydb_Query.StatsMode_STATS_MODE_PROFILE)
)

Functions

func ExecuteSettings

func ExecuteSettings(opts ...Execute) *executeSettings

func ParseDoOpts

func ParseDoOpts(t *trace.Query, opts ...DoOption) (s *doSettings)

func ParseDoTxOpts

func ParseDoTxOpts(t *trace.Query, opts ...DoTxOption) (s *doTxSettings)

func WithCallOptions

func WithCallOptions(opts ...grpc.CallOption) callOptionsOption

func WithCommit

func WithCommit() txCommitOption

func WithExecMode

func WithExecMode(mode ExecMode) execModeOption

func WithParameters

func WithParameters(parameters *params.Parameters) parametersOption

func WithStatsMode

func WithStatsMode(mode StatsMode, callback func(stats.QueryStats)) statsModeOption

func WithSyntax

func WithSyntax(syntax Syntax) syntaxOption

func WithTxControl

func WithTxControl(txControl *tx.Control) *txControlOption

func WithTxSettings

func WithTxSettings(txSettings tx.Settings) doTxSettingsOption

Types

type DoOption

type DoOption interface {
	// contains filtered or unexported methods
}

type DoTxOption

type DoTxOption interface {
	// contains filtered or unexported methods
}

type ExecMode

type ExecMode Ydb_Query.ExecMode

type Execute

type Execute interface {
	// contains filtered or unexported methods
}

Execute is an interface for execute method options

type ExecuteNoTx

type ExecuteNoTx interface {
	// contains filtered or unexported methods
}

type ExecuteScriptOperation

type ExecuteScriptOperation struct {
	ID            string
	ConsumedUnits float64
	Metadata      *MetadataExecuteQuery
}

type FetchScriptOption

type FetchScriptOption func(request *FetchScriptResultsRequest)

func WithFetchToken

func WithFetchToken(fetchToken string) FetchScriptOption

func WithResultSetIndex

func WithResultSetIndex(resultSetIndex int64) FetchScriptOption

func WithRowsLimit

func WithRowsLimit(rowsLimit int64) FetchScriptOption

type FetchScriptResult

type FetchScriptResult struct {
	ResultSetIndex int64
	ResultSet      result.Set
	NextToken      string
}

type FetchScriptResultsRequest

type FetchScriptResultsRequest struct {
	Ydb_Query.FetchScriptResultsRequest

	Trace *trace.Query
}

type MetadataExecuteQuery

type MetadataExecuteQuery struct {
	ID     string
	Script struct {
		Syntax Syntax
		Query  string
	}
	Mode           ExecMode
	Stats          stats.QueryStats
	ResultSetsMeta []struct {
		Columns []struct {
			Name string
			Type types.Type
		}
	}
}

func ToMetadataExecuteQuery

func ToMetadataExecuteQuery(metadata *anypb.Any) *MetadataExecuteQuery

type RetryOptionsOption

type RetryOptionsOption []retry.Option

func WithIdempotent

func WithIdempotent() RetryOptionsOption

func WithLabel

func WithLabel(lbl string) RetryOptionsOption

func WithRetryBudget

func WithRetryBudget(b budget.Budget) RetryOptionsOption

type StatsMode

type StatsMode Ydb_Query.StatsMode

type Syntax

type Syntax Ydb_Query.Syntax

type TraceOption

type TraceOption struct {
	// contains filtered or unexported fields
}

func WithTrace

func WithTrace(t *trace.Query) TraceOption