package query

import "github.com/ydb-platform/ydb-go-sdk/v3/internal/query"

Index

Constants 

const (
	StatusUnknown = Status(iota)
	StatusIdle
	StatusInUse
	StatusClosing
	StatusClosed
	StatusError
)

Variables 

var (
	ErrTransactionRollingBack = xerrors.Wrap(errors.New("the transaction is rolling back"))

	ErrOptionNotForTxExecute = errors.New("option is not for execute on transaction")
)

Functions

func IsAlive 

func IsAlive(status Status) bool

func MaterializedResultSet 

func MaterializedResultSet(
	index int,
	columnNames []string,
	columnTypes []types.Type,
	rows []query.Row,
) *materializedResultSet

func Open 

func Open(
	ctx context.Context, client Ydb_Query_V1.QueryServiceClient, opts ...Option,
) (_ *sessionCore, finalErr error)

Types

type Client 

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

func New 

func New(ctx context.Context, cc grpc.ClientConnInterface, cfg *config.Config) *Client

func (*Client) Close 

func (c *Client) Close(ctx context.Context) error

func (*Client) Do 

func (c *Client) Do(ctx context.Context, op query.Operation, opts ...options.DoOption) (finalErr error)

func (*Client) DoTx 

func (c *Client) DoTx(ctx context.Context, op query.TxOperation, opts ...options.DoTxOption) (finalErr error)

func (*Client) Exec 

func (c *Client) Exec(ctx context.Context, q string, opts ...options.Execute) (finalErr error)

func (*Client) ExecuteScript 

func (c *Client) ExecuteScript(
	ctx context.Context, q string, ttl time.Duration, opts ...options.Execute,
) (
	op *options.ExecuteScriptOperation, err error,
)

func (*Client) FetchScriptResults 

func (c *Client) FetchScriptResults(ctx context.Context,
	opID string, opts ...options.FetchScriptOption,
) (*options.FetchScriptResult, error)

func (*Client) Query 

func (c *Client) Query(ctx context.Context, q string, opts ...options.Execute) (r query.Result, err error)

func (*Client) QueryResultSet 

func (c *Client) QueryResultSet(
	ctx context.Context, q string, opts ...options.Execute,
) (rs result.ClosableResultSet, finalErr error)

QueryResultSet is a helper which read all rows from first result set in result

func (*Client) QueryRow 

func (c *Client) QueryRow(ctx context.Context, q string, opts ...options.Execute) (_ query.Row, finalErr error)

QueryRow is a helper which read only one row from first result set in result

type Core 

type Core interface {
	query.SessionInfo
	closer.Closer
	pool.Item

	Done() <-chan struct{}
	SetStatus(code Status)
}

type Option 

type Option func(*sessionCore)

func OnChangeStatus 

func OnChangeStatus(onChangeStatus func(status Status)) Option

func WithConn 

func WithConn(cc grpc.ClientConnInterface) Option

func WithDeleteTimeout 

func WithDeleteTimeout(deleteTimeout time.Duration) Option

func WithTrace 

func WithTrace(t *trace.Query) Option

type Row 

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

func NewRow 

func NewRow(columns []*Ydb.Column, v *Ydb.Value) *Row

func (Row) Scan 

func (r Row) Scan(dst ...interface{}) (err error)

func (Row) ScanNamed 

func (r Row) ScanNamed(dst ...scanner.NamedDestination) (err error)

func (Row) ScanStruct 

func (r Row) ScanStruct(dst interface{}, opts ...scanner.ScanStructOption) (err error)

type Session 

type Session struct {
	Core
	// contains filtered or unexported fields
}

func CreateSession 

func CreateSession(ctx context.Context, c *Client) (*Session, error)

func (*Session) Begin 

func (s *Session) Begin(
	ctx context.Context,
	txSettings query.TransactionSettings,
) (
	tx query.Transaction, finalErr error,
)

func (*Session) Exec 

func (s *Session) Exec(
	ctx context.Context, q string, opts ...options.Execute,
) (finalErr error)

func (*Session) Query 

func (s *Session) Query(
	ctx context.Context, q string, opts ...options.Execute,
) (_ query.Result, finalErr error)

func (*Session) QueryResultSet 

func (s *Session) QueryResultSet(
	ctx context.Context, q string, opts ...options.Execute,
) (rs result.ClosableResultSet, finalErr error)

func (*Session) QueryRow 

func (s *Session) QueryRow(ctx context.Context, q string, opts ...options.Execute) (_ query.Row, finalErr error)

type Status 

type Status uint32

func StatusFromErr 

func StatusFromErr(err error) Status

func (Status) String 

func (s Status) String() string

type Transaction 

type Transaction struct {
	baseTx.LazyID
	// contains filtered or unexported fields
}

func (*Transaction) CommitTx 

func (tx *Transaction) CommitTx(ctx context.Context) (finalErr error)

func (*Transaction) Exec 

func (tx *Transaction) Exec(ctx context.Context, q string, opts ...options.Execute) (
	finalErr error,
)

func (*Transaction) OnBeforeCommit 

func (tx *Transaction) OnBeforeCommit(f baseTx.OnTransactionBeforeCommit)

func (*Transaction) OnCompleted 

func (tx *Transaction) OnCompleted(f baseTx.OnTransactionCompletedFunc)

func (*Transaction) Query 

func (tx *Transaction) Query(ctx context.Context, q string, opts ...options.Execute) (
	_ query.Result, finalErr error,
)

func (*Transaction) QueryResultSet 

func (tx *Transaction) QueryResultSet(
	ctx context.Context, q string, opts ...options.Execute,
) (rs result.ClosableResultSet, finalErr error)

func (*Transaction) QueryRow 

func (tx *Transaction) QueryRow(
	ctx context.Context, q string, opts ...options.Execute,
) (row query.Row, finalErr error)

func (*Transaction) Rollback 

func (tx *Transaction) Rollback(ctx context.Context) (finalErr error)

func (*Transaction) SessionID 

func (tx *Transaction) SessionID() string

func (*Transaction) UnLazy 

func (tx *Transaction) UnLazy(ctx context.Context) error

Source Files

client.go errors.go execute_query.go result.go result_set.go row.go session.go session_core.go session_status.go transaction.go

Directories

PathSynopsis
internal/query/config
internal/query/options
internal/query/result
internal/query/scanner
internal/query/tx
Version
v3.99.3
Published
Feb 3, 2025
Platform
js/wasm
Imports
37 packages
Last checked
10 minutes ago –

Tools for package owners.