table

Documentation

Index

• func ContextIdempotentOperation(ctx context.Context) bool
• func WithIdempotentOperation(ctx context.Context) context.Context
• func WithTransactionSettings(ctx context.Context, tx *TransactionSettings) context.Context
• type Client
• type ClosableSession
• type DataQuery
• type DataQueryExplanation
• type Operation
• type Option
  • func WithIdempotent() Option
  • func WithTxCommitOptions(opts ...options.CommitTransactionOption) Option
  • func WithTxSettings(tx *TransactionSettings) Option
• type Options
• type ParameterOption
  • func ValueParam(name string, v types.Value) ParameterOption
• type QueryParameters
  • func NewQueryParameters(opts ...ParameterOption) *QueryParameters
  • func (q *QueryParameters) Add(opts ...ParameterOption)
  • func (q *QueryParameters) Each(it func(name string, v types.Value))
  • func (q *QueryParameters) Params() queryParams
  • func (q *QueryParameters) String() string
• type Session
• type SessionInfo
• type Statement
• type Transaction
• type TransactionControl
  • func TxControl(opts ...TxControlOption) *TransactionControl
  • func (t *TransactionControl) Desc() *Ydb_Table.TransactionControl
• type TransactionSettings
  • func ContextTransactionSettings(ctx context.Context) *TransactionSettings
  • func TxSettings(opts ...TxOption) *TransactionSettings
  • func (t *TransactionSettings) Settings() *Ydb_Table.TransactionSettings
• type TxControlOption
  • func BeginTx(opts ...TxOption) TxControlOption
  • func CommitTx() TxControlOption
  • func WithTx(t Transaction) TxControlOption
• type TxOnlineReadOnlyOption
  • func WithInconsistentReads() TxOnlineReadOnlyOption
• type TxOperation
• type TxOption
  • func WithOnlineReadOnly(opts ...TxOnlineReadOnlyOption) TxOption
  • func WithSerializableReadWrite() TxOption
  • func WithStaleReadOnly() TxOption

Functions

func ContextIdempotentOperation

func ContextIdempotentOperation(ctx context.Context) bool

func WithIdempotentOperation

func WithIdempotentOperation(ctx context.Context) context.Context

func WithTransactionSettings

func WithTransactionSettings(ctx context.Context, tx *TransactionSettings) context.Context

Types

type Client

type Client interface {
	// Close closes table client
	Close(ctx context.Context) error

	// CreateSession returns session or error for manually control of session lifecycle
	// CreateSession do not provide retry loop for failed create session requests.
	// Best effort policy may be implements with outer retry loop includes CreateSession call
	CreateSession(ctx context.Context) (s ClosableSession, err error)

	// Do provide the best effort for execute operation
	// Do implements internal busy loop until one of the following conditions is met:
	// - deadline was canceled or deadlined
	// - retry operation returned nil as error
	// Warning: if deadline without deadline or cancellation func Retry will be worked infinite
	Do(ctx context.Context, op Operation, opts ...Option) error

	// DoTx provide the best effort for execute operation
	// DoTx implements internal busy loop until one of the following conditions is met:
	// - deadline was canceled or deadlined
	// - retry operation returned nil as error
	// Warning: if deadline without deadline or cancellation func Retry will be worked infinite
	DoTx(ctx context.Context, op TxOperation, opts ...Option) error
}

type ClosableSession

type ClosableSession interface {
	Session

	Close(ctx context.Context) (err error)
}

type DataQuery

type DataQuery interface {
	String() string
	ID() string
	YQL() string
}

DataQuery only for tracers

type DataQueryExplanation

type DataQueryExplanation struct {
	AST  string
	Plan string
}

DataQueryExplanation is a result of ExplainDataQuery call.

type Operation

type Operation func(context.Context, Session) error

Operation is the interface that holds an operation for retry.

type Option

type Option func(o *Options)

func WithIdempotent

func WithIdempotent() Option

func WithTxCommitOptions

func WithTxCommitOptions(opts ...options.CommitTransactionOption) Option

func WithTxSettings

func WithTxSettings(tx *TransactionSettings) Option

type Options

type Options struct {
	Idempotent      bool
	TxSettings      *TransactionSettings
	TxCommitOptions []options.CommitTransactionOption
}

type ParameterOption

type ParameterOption func(queryParams)

func ValueParam

func ValueParam(name string, v types.Value) ParameterOption

type QueryParameters

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

func NewQueryParameters

func NewQueryParameters(opts ...ParameterOption) *QueryParameters

func (*QueryParameters) Add

func (q *QueryParameters) Add(opts ...ParameterOption)

func (*QueryParameters) Each

func (q *QueryParameters) Each(it func(name string, v types.Value))

func (*QueryParameters) Params

func (q *QueryParameters) Params() queryParams

func (*QueryParameters) String

func (q *QueryParameters) String() string

type Session

type Session interface {
	SessionInfo

	CreateTable(ctx context.Context, path string, opts ...options.CreateTableOption) (err error)
	DescribeTable(ctx context.Context, path string, opts ...options.DescribeTableOption) (desc options.Description, err error)
	DropTable(ctx context.Context, path string, opts ...options.DropTableOption) (err error)
	AlterTable(ctx context.Context, path string, opts ...options.AlterTableOption) (err error)
	CopyTable(ctx context.Context, dst, src string, opts ...options.CopyTableOption) (err error)
	Explain(ctx context.Context, query string) (exp DataQueryExplanation, err error)
	Prepare(ctx context.Context, query string) (stmt Statement, err error)
	Execute(ctx context.Context, tx *TransactionControl, query string, params *QueryParameters, opts ...options.ExecuteDataQueryOption) (txr Transaction, r result.Result, err error)
	ExecuteSchemeQuery(ctx context.Context, query string, opts ...options.ExecuteSchemeQueryOption) (err error)
	DescribeTableOptions(ctx context.Context) (desc options.TableOptionsDescription, err error)
	StreamReadTable(ctx context.Context, path string, opts ...options.ReadTableOption) (r result.StreamResult, err error)
	StreamExecuteScanQuery(ctx context.Context, query string, params *QueryParameters, opts ...options.ExecuteScanQueryOption) (_ result.StreamResult, err error)
	BulkUpsert(ctx context.Context, table string, rows types.Value) (err error)
	BeginTransaction(ctx context.Context, tx *TransactionSettings) (x Transaction, err error)
	KeepAlive(ctx context.Context) error
}

type SessionInfo

type SessionInfo interface {
	ID() string
}

type Statement

type Statement interface {
	Execute(ctx context.Context, tx *TransactionControl, params *QueryParameters, opts ...options.ExecuteDataQueryOption) (txr Transaction, r result.Result, err error)
	NumInput() int
	Text() string
}

type Transaction

type Transaction interface {
	ID() string
	Execute(ctx context.Context, query string, params *QueryParameters, opts ...options.ExecuteDataQueryOption) (result.Result, error)
	ExecuteStatement(ctx context.Context, stmt Statement, params *QueryParameters, opts ...options.ExecuteDataQueryOption) (result.Result, error)
	CommitTx(ctx context.Context, opts ...options.CommitTransactionOption) (r result.Result, err error)
	Rollback(ctx context.Context) (err error)
}

type TransactionControl

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

func TxControl

func TxControl(opts ...TxControlOption) *TransactionControl

func (*TransactionControl) Desc

func (t *TransactionControl) Desc() *Ydb_Table.TransactionControl

type TransactionSettings

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

func ContextTransactionSettings

func ContextTransactionSettings(ctx context.Context) *TransactionSettings

func TxSettings

func TxSettings(opts ...TxOption) *TransactionSettings

func (*TransactionSettings) Settings

func (t *TransactionSettings) Settings() *Ydb_Table.TransactionSettings

type TxControlOption

type TxControlOption func(*txControlDesc)

func BeginTx

func BeginTx(opts ...TxOption) TxControlOption

func CommitTx

func CommitTx() TxControlOption

func WithTx

func WithTx(t Transaction) TxControlOption

type TxOnlineReadOnlyOption

type TxOnlineReadOnlyOption func(*txOnlineReadOnly)

func WithInconsistentReads

func WithInconsistentReads() TxOnlineReadOnlyOption

type TxOperation

type TxOperation func(context.Context, Transaction) error

TxOperation is the interface that holds an operation for retry.

type TxOption

type TxOption func(*txDesc)

Transaction control options

func WithOnlineReadOnly

func WithOnlineReadOnly(opts ...TxOnlineReadOnlyOption) TxOption

func WithSerializableReadWrite

func WithSerializableReadWrite() TxOption

func WithStaleReadOnly

func WithStaleReadOnly() TxOption