 Documentation
      ¶
      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 WithIssuesHandler(callback func(issues []*Ydb_Issue.IssueMessage)) issuesOption
- func WithParameters(params params.Parameters) parametersOption
- func WithResourcePool(id string) resourcePool
- func WithResponsePartLimitSizeBytes(size int64) responsePartLimitBytes
- 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
- type FetchScriptResult
- type FetchScriptResultsRequest
- type LabelOption
- type MetadataExecuteQuery
- type RetryOptionsOption
- type StatsMode
- type Syntax
- type TraceOption
- type TxControl
Constants ¶
      View Source
      
  
    const ( SyntaxYQL = Syntax(Ydb_Query.Syntax_SYNTAX_YQL_V1) SyntaxPostgreSQL = Syntax(Ydb_Query.Syntax_SYNTAX_PG) )
      View Source
      
  
    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) )
      View Source
      
  
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) )
Variables ¶
This section is empty.
Functions ¶
func ExecuteSettings ¶
func ExecuteSettings(opts ...Execute) *executeSettings
func ParseDoOpts ¶
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 WithIssuesHandler ¶ added in v3.118.0
func WithIssuesHandler(callback func(issues []*Ydb_Issue.IssueMessage)) issuesOption
func WithParameters ¶
func WithParameters(params params.Parameters) parametersOption
func WithResourcePool ¶ added in v3.85.3
func WithResourcePool(id string) resourcePool
func WithResponsePartLimitSizeBytes ¶ added in v3.92.3
func WithResponsePartLimitSizeBytes(size int64) responsePartLimitBytes
func WithStatsMode ¶
func WithStatsMode(mode StatsMode, callback func(stats.QueryStats)) statsModeOption
func WithSyntax ¶
func WithSyntax(syntax Syntax) syntaxOption
func WithTxControl ¶
func WithTxSettings ¶
Types ¶
type DoTxOption ¶
type DoTxOption interface {
	// contains filtered or unexported methods
}
    type Execute ¶
type Execute interface {
	// contains filtered or unexported methods
}
    Execute is an interface for execute method options
type ExecuteNoTx ¶ added in v3.78.0
type ExecuteNoTx interface {
	// contains filtered or unexported methods
}
    type ExecuteScriptOperation ¶ added in v3.77.0
type ExecuteScriptOperation struct {
	ID            string
	ConsumedUnits float64
	Metadata      *MetadataExecuteQuery
}
    type FetchScriptOption ¶ added in v3.77.0
type FetchScriptOption func(request *FetchScriptResultsRequest)
func WithFetchToken ¶ added in v3.77.0
func WithFetchToken(fetchToken string) FetchScriptOption
func WithResultSetIndex ¶ added in v3.77.0
func WithResultSetIndex(resultSetIndex int64) FetchScriptOption
func WithRowsLimit ¶ added in v3.77.0
func WithRowsLimit(rowsLimit int64) FetchScriptOption
type FetchScriptResult ¶ added in v3.77.0
type FetchScriptResultsRequest ¶ added in v3.77.0
type FetchScriptResultsRequest struct {
	Ydb_Query.FetchScriptResultsRequest
	Trace *trace.Query
}
    type LabelOption ¶ added in v3.104.1
type LabelOption string
func WithLabel ¶
func WithLabel(lbl string) LabelOption
type MetadataExecuteQuery ¶ added in v3.77.1
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 ¶ added in v3.77.1
func ToMetadataExecuteQuery(metadata *anypb.Any) *MetadataExecuteQuery
type RetryOptionsOption ¶ added in v3.74.0
func WithIdempotent ¶
func WithIdempotent() RetryOptionsOption
func WithRetryBudget ¶ added in v3.66.0
func WithRetryBudget(b budget.Budget) RetryOptionsOption
type TraceOption ¶ added in v3.74.0
type TraceOption struct {
	// contains filtered or unexported fields
}
    func WithTrace ¶
func WithTrace(t *trace.Query) TraceOption
type TxControl ¶ added in v3.99.9
type TxControl interface {
	ToYdbQueryTransactionControl() *Ydb_Query.TransactionControl
	Commit() bool
}
     Click to show internal directories. 
   Click to hide internal directories.