xsql

Documentation

Index

• Constants
• Variables
• func WithQueryMode(ctx context.Context, m QueryMode) context.Context
• func WithTxControl(ctx context.Context, txc *table.TransactionControl) context.Context
• func WithTxControlHook(ctx context.Context, hook txControlHook) context.Context
• type ConnAlreadyHaveTxError
  • func (err *ConnAlreadyHaveTxError) As(target interface{}) bool
  • func (err *ConnAlreadyHaveTxError) Error() string
• type Connector
  • func Open(parent ydbDriver, opts ...ConnectorOption) (_ *Connector, err error)
  • func Unwrap[T *sql.DB | *sql.Conn](v T) (connector *Connector, err error)
  • func (c *Connector) Close() (err error)
  • func (c *Connector) Connect(ctx context.Context) (_ driver.Conn, err error)
  • func (c *Connector) Driver() driver.Driver
• type ConnectorOption
  • func Parse(dataSourceName string) (opts []config.Option, connectorOpts []ConnectorOption, _ error)
  • func WithDefaultDataQueryOptions(opts ...options.ExecuteDataQueryOption) ConnectorOption
  • func WithDefaultQueryMode(mode QueryMode) ConnectorOption
  • func WithDefaultScanQueryOptions(opts ...options.ExecuteScanQueryOption) ConnectorOption
  • func WithDefaultTxControl(txControl *table.TransactionControl) ConnectorOption
  • func WithDisableServerBalancer() ConnectorOption
  • func WithFakeTx(m QueryMode) ConnectorOption
  • func WithIdleThreshold(idleThreshold time.Duration) ConnectorOption
  • func WithOnClose(f func(connector *Connector)) ConnectorOption
  • func WithTrace(t *trace.DatabaseSQL, opts ...trace.DatabaseSQLComposeOption) ConnectorOption
  • func WithTraceRetry(t *trace.Retry) ConnectorOption
• type QueryBindConnectorOption
  • func WithQueryBind(bind bind.Bind) QueryBindConnectorOption
  • func WithTablePathPrefix(tablePathPrefix string) QueryBindConnectorOption
• type QueryMode
  • func QueryModeFromString(s string) QueryMode
  • func (t QueryMode) String() string

Constants

const (
	UnknownQueryMode = QueryMode(iota)
	DataQueryMode
	ExplainQueryMode
	ScanQueryMode
	SchemeQueryMode
	ScriptingQueryMode

	DefaultQueryMode = DataQueryMode
)

Variables

var (
	ErrUnsupported = driver.ErrSkip
)

Functions

func WithQueryMode

func WithQueryMode(ctx context.Context, m QueryMode) context.Context

WithQueryMode returns a copy of context with given QueryMode

func WithTxControl

func WithTxControl(ctx context.Context, txc *table.TransactionControl) context.Context

func WithTxControlHook

func WithTxControlHook(ctx context.Context, hook txControlHook) context.Context

Types

type ConnAlreadyHaveTxError

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

func (*ConnAlreadyHaveTxError) As

func (err *ConnAlreadyHaveTxError) As(target interface{}) bool

func (*ConnAlreadyHaveTxError) Error

func (err *ConnAlreadyHaveTxError) Error() string

type Connector

type Connector struct {
	Bindings bind.Bindings
	// contains filtered or unexported fields
}

Connector is a producer of database/sql connections

func Open

func Open(parent ydbDriver, opts ...ConnectorOption) (_ *Connector, err error)

func Unwrap

func Unwrap[T *sql.DB | *sql.Conn](v T) (connector *Connector, err error)

func (*Connector) Close

func (c *Connector) Close() (err error)

func (*Connector) Connect

func (c *Connector) Connect(ctx context.Context) (_ driver.Conn, err error)

func (*Connector) Driver

func (c *Connector) Driver() driver.Driver

type ConnectorOption

type ConnectorOption interface {
	Apply(c *Connector) error
}

func Parse

func Parse(dataSourceName string) (opts []config.Option, connectorOpts []ConnectorOption, _ error)

func WithDefaultDataQueryOptions

func WithDefaultDataQueryOptions(opts ...options.ExecuteDataQueryOption) ConnectorOption

func WithDefaultQueryMode

func WithDefaultQueryMode(mode QueryMode) ConnectorOption

func WithDefaultScanQueryOptions

func WithDefaultScanQueryOptions(opts ...options.ExecuteScanQueryOption) ConnectorOption

func WithDefaultTxControl

func WithDefaultTxControl(txControl *table.TransactionControl) ConnectorOption

func WithDisableServerBalancer

func WithDisableServerBalancer() ConnectorOption

func WithFakeTx

func WithFakeTx(m QueryMode) ConnectorOption

WithFakeTx returns a copy of context with given QueryMode

func WithIdleThreshold

func WithIdleThreshold(idleThreshold time.Duration) ConnectorOption

func WithOnClose

func WithOnClose(f func(connector *Connector)) ConnectorOption

func WithTrace

func WithTrace(t *trace.DatabaseSQL, opts ...trace.DatabaseSQLComposeOption) ConnectorOption

func WithTraceRetry

func WithTraceRetry(t *trace.Retry) ConnectorOption

type QueryBindConnectorOption

type QueryBindConnectorOption interface {
	ConnectorOption
	bind.Bind
}

func WithQueryBind

func WithQueryBind(bind bind.Bind) QueryBindConnectorOption

func WithTablePathPrefix

func WithTablePathPrefix(tablePathPrefix string) QueryBindConnectorOption

type QueryMode

type QueryMode int

func QueryModeFromString

func QueryModeFromString(s string) QueryMode

func (QueryMode) String

func (t QueryMode) String() string