utils

Documentation

Overview

Package utils contains helper types and functions that can be used by any relational data source.

Index

• func MakeReadSplitQuery(logger *zap.Logger, formatter SQLFormatter, ...) (string, []any, *api_service_protos.TSelect_TWhat, error)
• func MakeTestSplit() *api_service_protos.TSplit
• func NewColumnExpression(name string) *api_service_protos.TExpression
• func NewDefaultWhat() *api_service_protos.TSelect_TWhat
• func NewEmptyColumnWhat() *api_service_protos.TSelect_TWhat
• func NewInt32ValueExpression(val int32) *api_service_protos.TExpression
• func NewTextValueExpression(val string) *api_service_protos.TExpression
• func NewUint64ValueExpression(val uint64) *api_service_protos.TExpression
• type Connection
• type ConnectionManager
• type ConnectionManagerBase
• type ConnectionManagerMock
  • func (m *ConnectionManagerMock) Make(_ context.Context, _ *zap.Logger, ...) (Connection, error)
  • func (m *ConnectionManagerMock) Release(_ *zap.Logger, conn Connection)
• type ConnectionMock
  • func (m *ConnectionMock) Close() error
  • func (m *ConnectionMock) Query(_ context.Context, query string, params ...any) (Rows, error)
• type DataConverter
  • func (dc DataConverter) RowsToColumnBlocks(input [][]any, rowsPerBlock int) [][][]any
• type DefaultSchemaProvider
  • func (f *DefaultSchemaProvider) GetSchema(ctx context.Context, logger *zap.Logger, conn Connection, ...) (*api_service_protos.TSchema, error)
• type RowTransformerMock
  • func (t *RowTransformerMock) AppendToArrowBuilders(builder []array.Builder) error
  • func (t *RowTransformerMock) GetAcceptors() []any
  • func (*RowTransformerMock) SetAcceptors([]any)
• type Rows
• type RowsMock
  • func (m *RowsMock) Close() error
  • func (m *RowsMock) Err() error
  • func (m *RowsMock) MakeTransformer(ydbType []*Ydb.Type, _ conversion.Collection) (paging.RowTransformer[any], error)
  • func (m *RowsMock) Next() bool
  • func (m *RowsMock) NextResultSet() bool
  • func (m *RowsMock) Scan(dest ...any) error
• type SQLFormatter
• type SchemaBuilder
  • func NewSchemaBuilder(typeMapper datasource.TypeMapper, ...) *SchemaBuilder
  • func (sb *SchemaBuilder) AddColumn(columnName, columnType string) error
  • func (sb *SchemaBuilder) Build(logger *zap.Logger) (*api_service_protos.TSchema, error)
• type SchemaProvider
  • func NewDefaultSchemaProvider(typeMapper datasource.TypeMapper, ...) SchemaProvider

Functions

func MakeReadSplitQuery

func MakeReadSplitQuery(
	logger *zap.Logger,
	formatter SQLFormatter,
	request *api_service_protos.TSelect,
) (string, []any, *api_service_protos.TSelect_TWhat, error)

func MakeTestSplit

func MakeTestSplit() *api_service_protos.TSplit

func NewColumnExpression

func NewColumnExpression(name string) *api_service_protos.TExpression

func NewDefaultWhat

func NewDefaultWhat() *api_service_protos.TSelect_TWhat

NewDefaultWhat generates default What field with a pair of columns

func NewEmptyColumnWhat

func NewEmptyColumnWhat() *api_service_protos.TSelect_TWhat

NewEmptyColumnWhat generates What field with a one column of type Int32

func NewInt32ValueExpression

func NewInt32ValueExpression(val int32) *api_service_protos.TExpression

func NewTextValueExpression

func NewTextValueExpression(val string) *api_service_protos.TExpression

func NewUint64ValueExpression

func NewUint64ValueExpression(val uint64) *api_service_protos.TExpression

Types

type Connection

type Connection interface {
	Query(ctx context.Context, query string, args ...any) (Rows, error)
	Close() error
}

type ConnectionManager

type ConnectionManager interface {
	Make(ctx context.Context, logger *zap.Logger, dataSourceInstance *api_common.TDataSourceInstance) (Connection, error)
	Release(logger *zap.Logger, connection Connection)
}

type ConnectionManagerBase

type ConnectionManagerBase struct {
	QueryLoggerFactory common.QueryLoggerFactory
}

type ConnectionManagerMock

type ConnectionManagerMock struct {
	mock.Mock
}

func (*ConnectionManagerMock) Make

func (m *ConnectionManagerMock) Make(
	_ context.Context,
	_ *zap.Logger,
	dataSourceInstance *api_common.TDataSourceInstance) (Connection, error)

func (*ConnectionManagerMock) Release

func (m *ConnectionManagerMock) Release(_ *zap.Logger, conn Connection)

type ConnectionMock

type ConnectionMock struct {
	mock.Mock
}

func (*ConnectionMock) Close

func (m *ConnectionMock) Close() error

func (*ConnectionMock) Query

func (m *ConnectionMock) Query(_ context.Context, query string, params ...any) (Rows, error)

type DataConverter

type DataConverter struct{}

DataConverter should be used only from unit tests

func (DataConverter) RowsToColumnBlocks

func (dc DataConverter) RowsToColumnBlocks(input [][]any, rowsPerBlock int) [][][]any

type DefaultSchemaProvider

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

func (*DefaultSchemaProvider) GetSchema

func (f *DefaultSchemaProvider) GetSchema(
	ctx context.Context,
	logger *zap.Logger,
	conn Connection,
	request *api_service_protos.TDescribeTableRequest,
) (*api_service_protos.TSchema, error)

type RowTransformerMock

type RowTransformerMock struct {
	mock.Mock
	Acceptors []any
}

func (*RowTransformerMock) AppendToArrowBuilders

func (t *RowTransformerMock) AppendToArrowBuilders(builder []array.Builder) error

func (*RowTransformerMock) GetAcceptors

func (t *RowTransformerMock) GetAcceptors() []any

func (*RowTransformerMock) SetAcceptors

func (*RowTransformerMock) SetAcceptors([]any)

type Rows

type Rows interface {
	Close() error
	Err() error
	Next() bool
	NextResultSet() bool
	Scan(dest ...any) error
	MakeTransformer(ydbTypes []*Ydb.Type, cc conversion.Collection) (paging.RowTransformer[any], error)
}

type RowsMock

type RowsMock struct {
	mock.Mock
	PredefinedData [][]any
	// contains filtered or unexported fields
}

func (*RowsMock) Close

func (m *RowsMock) Close() error

func (*RowsMock) Err

func (m *RowsMock) Err() error

func (*RowsMock) MakeTransformer

func (m *RowsMock) MakeTransformer(ydbType []*Ydb.Type, _ conversion.Collection) (paging.RowTransformer[any], error)

func (*RowsMock) Next

func (m *RowsMock) Next() bool

func (*RowsMock) NextResultSet

func (m *RowsMock) NextResultSet() bool

func (*RowsMock) Scan

func (m *RowsMock) Scan(dest ...any) error

type SQLFormatter

type SQLFormatter interface {
	// Get placeholder for n'th argument (starting from 0) for prepared statement
	GetPlaceholder(n int) string

	// Sanitize names of databases, tables, columns, views, schemas
	SanitiseIdentifier(ident string) string

	// Support for high level expression (without subexpressions, they are checked separately)
	SupportsPushdownExpression(expression *api_service_protos.TExpression) bool

	// FormatFrom builds identifier called after FROM (`SELECT ... FROM <this>`)
	FormatFrom(tableName string) string
}

type SchemaBuilder

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

func NewSchemaBuilder

func NewSchemaBuilder(
	typeMapper datasource.TypeMapper,
	typeMappingSettings *api_service_protos.TTypeMappingSettings,
) *SchemaBuilder

func (*SchemaBuilder) AddColumn

func (sb *SchemaBuilder) AddColumn(columnName, columnType string) error

func (*SchemaBuilder) Build

func (sb *SchemaBuilder) Build(logger *zap.Logger) (*api_service_protos.TSchema, error)

type SchemaProvider

type SchemaProvider interface {
	GetSchema(
		ctx context.Context,
		logger *zap.Logger,
		conn Connection,
		request *api_service_protos.TDescribeTableRequest,
	) (*api_service_protos.TSchema, error)
}

func NewDefaultSchemaProvider

func NewDefaultSchemaProvider(
	typeMapper datasource.TypeMapper,
	getArgsAndQueryFunc func(request *api_service_protos.TDescribeTableRequest) (string, []any),
) SchemaProvider