Documentation
¶
Index ¶
- Variables
- type Client
- type Session
- type SessionBuilder
- type SessionProvider
- type SessionProviderFunc
- func (f SessionProviderFunc) Close(ctx context.Context) error
- func (f SessionProviderFunc) CloseSession(ctx context.Context, s Session) error
- func (f SessionProviderFunc) Do(ctx context.Context, op table.Operation, opts ...table.Option) (err error)
- func (f SessionProviderFunc) Get(ctx context.Context) (Session, error)
- func (f SessionProviderFunc) Put(ctx context.Context, s Session) error
- type Statement
- type Transaction
- func (tx *Transaction) CommitTx(ctx context.Context, opts ...options.CommitTransactionOption) (r resultset.Result, err error)
- func (tx *Transaction) Execute(ctx context.Context, query string, params *table.QueryParameters, ...) (r resultset.Result, err error)
- func (tx *Transaction) ExecuteStatement(ctx context.Context, stmt table.Statement, params *table.QueryParameters, ...) (r resultset.Result, err error)
- func (tx *Transaction) ID() string
- func (tx *Transaction) IsNil() bool
- func (tx *Transaction) Rollback(ctx context.Context) (err error)
Constants ¶
This section is empty.
Variables ¶
var ( // ErrSessionPoolClosed is returned by a client instance to indicate // that client is closed and not able to complete requested operation. ErrSessionPoolClosed = errors.New("ydb: table: build client is closed") // ErrSessionPoolOverflow is returned by a client instance to indicate // that the client is full and requested operation is not able to complete. ErrSessionPoolOverflow = errors.New("ydb: table: build client overflow") // ErrSessionUnknown is returned by a client instance to indicate that // requested build does not exist within the client. ErrSessionUnknown = errors.New("ydb: table: unknown build") // ErrNoProgress is returned by a client instance to indicate that // operation could not be completed. ErrNoProgress = errors.New("ydb: table: no progress") )
var (
ErrNilConnection = errors.New("build with nil connection")
)
Functions ¶
This section is empty.
Types ¶
type Client ¶
type SessionBuilder ¶
SessionBuilder is the interface that holds logic of creating sessions.
type SessionProvider ¶
type SessionProvider interface {
// Get returns alive idle build or creates new one.
Get(context.Context) (Session, error)
// Put takes no longer needed build for reuse or deletion depending
// on implementation.
// Put must be fast, if necessary must be async
Put(context.Context, Session) (err error)
// CloseSession provides the most effective way of build closing
// instead of plain build.Close.
// CloseSession must be fast. If necessary, can be async.
CloseSession(ctx context.Context, s Session) error
// Close provide cleanup sessions
Close(ctx context.Context) 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 table.Operation, opts ...table.Option) (err error)
}
SessionProvider is the interface that holds build lifecycle logic.
func SingleSession ¶
func SingleSession(s Session, b retry.Backoff) SessionProvider
SingleSession returns SessionProvider that uses only given build during retries.
type SessionProviderFunc ¶
type SessionProviderFunc struct {
OnGet func(context.Context) (Session, error)
OnPut func(context.Context, Session) error
OnDo func(context.Context, table.Operation, ...table.Option) error
OnClose func(context.Context) error
}
func (SessionProviderFunc) CloseSession ¶
func (f SessionProviderFunc) CloseSession(ctx context.Context, s Session) error
type Statement ¶
type Statement struct {
// contains filtered or unexported fields
}
Statement is a prepared statement. Like a single build, it is not safe for concurrent use by multiple goroutines.
func (*Statement) Execute ¶
func (s *Statement) Execute( ctx context.Context, tx *table.TransactionControl, params *table.QueryParameters, opts ...options.ExecuteDataQueryOption, ) ( txr table.Transaction, r resultset.Result, err error, )
Execute executes prepared data query.
type Transaction ¶
type Transaction struct {
// contains filtered or unexported fields
}
Transaction is a database transaction. Hence build methods are not goroutine safe, Transaction is not goroutine safe either.
func (*Transaction) CommitTx ¶
func (tx *Transaction) CommitTx(ctx context.Context, opts ...options.CommitTransactionOption) (r resultset.Result, err error)
CommitTx commits specified active transaction.
func (*Transaction) Execute ¶
func (tx *Transaction) Execute( ctx context.Context, query string, params *table.QueryParameters, opts ...options.ExecuteDataQueryOption, ) (r resultset.Result, err error)
Execute executes query represented by text within transaction tx.
func (*Transaction) ExecuteStatement ¶
func (tx *Transaction) ExecuteStatement( ctx context.Context, stmt table.Statement, params *table.QueryParameters, opts ...options.ExecuteDataQueryOption, ) (r resultset.Result, err error)
ExecuteStatement executes prepared statement stmt within transaction tx.
func (*Transaction) ID ¶
func (tx *Transaction) ID() string
func (*Transaction) IsNil ¶
func (tx *Transaction) IsNil() bool