Documentation
¶
Index ¶
- func NewTimeToLiveSettings(settings *Ydb_Table.TtlSettings) *options.TimeToLiveSettings
- type Client
- func (c *Client) Close(ctx context.Context) (err error)
- func (c *Client) CreateSession(ctx context.Context, opts ...table.Option) (_ table.ClosableSession, err error)
- func (c *Client) Do(ctx context.Context, op table.Operation, opts ...table.Option) (finalErr error)
- func (c *Client) DoTx(ctx context.Context, op table.TxOperation, opts ...table.Option) (finalErr error)
- func (c *Client) Get(ctx context.Context) (s *session, err error)
- func (c *Client) Put(ctx context.Context, s *session) (err error)
- type SessionProvider
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewTimeToLiveSettings ¶ added in v3.40.1
func NewTimeToLiveSettings(settings *Ydb_Table.TtlSettings) *options.TimeToLiveSettings
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is a set of session instances that may be reused. A Client is safe for use by multiple goroutines simultaneously.
func (*Client) Close ¶
Close deletes all stored sessions inside Client. It also stops all underlying timers and goroutines. It returns first error occurred during stale sessions' deletion. Note that even on error it calls Close() on each session.
func (*Client) CreateSession ¶ added in v3.24.1
func (*Client) Do ¶ added in v3.24.1
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
func (*Client) Get ¶
Get returns first idle session from the Client and removes it from there. If no items stored in Client it creates new one returns it.
func (*Client) Put ¶
Put returns session to the Client for further reuse. If Client is already closed Put() calls s.Close(ctx) and returns errClosedClient. If Client is overflow calls s.Close(ctx) and returns errSessionPoolOverflow.
Note that Put() must be called only once after being created or received by Get() or Take() calls. In other way it will produce unexpected behavior or panic.
type SessionProvider ¶
type SessionProvider interface {
// Get returns alive idle session or creates new one.
Get(ctx context.Context) (*session, error)
// Put takes no longer needed session for reuse or deletion depending
// on implementation.
// Put must be fast, if necessary must be async
Put(ctx context.Context, s *session) (err error)
}
SessionProvider is the interface that holds session lifecycle logic.
Source Files
Directories