xsql

Documentation

Index

• Constants
• Variables
• func GenerateDeclareSection(args []sql.NamedArg) (string, error)
• func WithDataQueryOptions(ctx context.Context, opts ...options.ExecuteDataQueryOption) context.Context
• func WithQueryMode(ctx context.Context, m QueryMode) context.Context
• func WithScanQueryOptions(ctx context.Context, opts ...options.ExecuteScanQueryOption) context.Context
• func WithTxControl(ctx context.Context, txc *table.TransactionControl) context.Context
• type Connector
  • func Open(d Driver, connection connection, 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) Connection() connection
  • func (c *Connector) Driver() driver.Driver
• type ConnectorOption
  • func Parse(dataSourceName string) (opts []config.Option, connectorOpts []ConnectorOption, err 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 WithTrace(t trace.DatabaseSQL, opts ...trace.DatabaseSQLComposeOption) ConnectorOption
• type Driver
• type QueryMode
  • func QueryModeFromString(s string) QueryMode
  • func (t QueryMode) String() string

Constants

const (
	UnknownQueryMode = iota
	DataQueryMode
	ExplainQueryMode
	ScanQueryMode
	SchemeQueryMode
	ScriptingQueryMode

	DefaultQueryMode = DataQueryMode
)

Variables

var (
	ErrUnsupported = driver.ErrSkip
)

Functions

func GenerateDeclareSection

func GenerateDeclareSection(args []sql.NamedArg) (string, error)

GenerateDeclareSection generates DECLARE section text in YQL query by params

Warning: This is an experimental feature and could change at any time

func WithDataQueryOptions

func WithDataQueryOptions(ctx context.Context, opts ...options.ExecuteDataQueryOption) context.Context

func WithQueryMode

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

WithQueryMode returns a copy of context with given QueryMode

func WithScanQueryOptions

func WithScanQueryOptions(ctx context.Context, opts ...options.ExecuteScanQueryOption) context.Context

func WithTxControl

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

Types

type Connector

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

Connector is a producer of database/sql connections

func Open

func Open(d Driver, connection connection, 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) Connection

func (c *Connector) Connection() connection

func (*Connector) Driver

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

type ConnectorOption

type ConnectorOption func(c *Connector) error

func Parse

func Parse(dataSourceName string) (opts []config.Option, connectorOpts []ConnectorOption, err 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 WithTrace

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

type Driver

type Driver interface {
	driver.Driver

	Attach(c *Connector)
	Detach(c *Connector)
}

type QueryMode

type QueryMode int

func QueryModeFromString

func QueryModeFromString(s string) QueryMode

func (QueryMode) String

func (t QueryMode) String() string