experimental

Documentation

Index

• type Client
  • func (c *Client) ExecuteStreamQuery(ctx context.Context, query string, params *QueryParameters, ...) (*StreamQueryResult, error)
  • func (c *Client) GetDiskSpaceUsage(ctx context.Context, database string) (*DiskSpaceResult, error)
  • func (c *Client) UploadRows(ctx context.Context, tableName string, typ ydb.Value) (err error)
• type DiskSpaceResult
• type ParameterOption
  • func ValueParam(name string, v ydb.Value) ParameterOption
• type QueryParameters
  • func NewQueryParameters(opts ...ParameterOption) *QueryParameters
  • func (q *QueryParameters) Add(opts ...ParameterOption)
  • func (q *QueryParameters) Each(it func(name string, value ydb.Value))
  • func (q *QueryParameters) String() string
• type StreamQueryOption
  • func WithStreamQueryProfile(profile StreamQueryProfile) StreamQueryOption
• type StreamQueryProfile
  • func (s StreamQueryProfile) String() string
• type StreamQueryResult
  • func (s *StreamQueryResult) Profile() *StreamQueryResultProfile
  • func (s *StreamQueryResult) Progress() *StreamQueryResultProgress
  • func (s *StreamQueryResult) ResultSet() *StreamQueryResultResultSet
• type StreamQueryResultProfile
• type StreamQueryResultProgress
• type StreamQueryResultResultSet
• type StreamQueryResultType

Types

type Client

type Client struct {
	Driver ydb.Driver
}

func (*Client) ExecuteStreamQuery

func (c *Client) ExecuteStreamQuery(ctx context.Context, query string, params *QueryParameters, opts ...StreamQueryOption) (*StreamQueryResult, error)

ExecuteStreamQuery not fully supported yet

func (*Client) GetDiskSpaceUsage

func (c *Client) GetDiskSpaceUsage(ctx context.Context, database string) (*DiskSpaceResult, error)

GetDiskSpaceUsage return size database statistics

func (*Client) UploadRows

func (c *Client) UploadRows(ctx context.Context, tableName string, typ ydb.Value) (err error)

UploadRows not fully supported yet

type DiskSpaceResult

type DiskSpaceResult struct {
	CloudID    string
	FolderID   string
	DatabaseID string
	TotalSize  uint64
	DataSize   uint64
	IndexSize  uint64
}

type ParameterOption

type ParameterOption func(queryParams)

func ValueParam

func ValueParam(name string, v ydb.Value) ParameterOption

type QueryParameters

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

QueryParameters TODO: unite with table query parameters

func NewQueryParameters

func NewQueryParameters(opts ...ParameterOption) *QueryParameters

func (*QueryParameters) Add

func (q *QueryParameters) Add(opts ...ParameterOption)

func (*QueryParameters) Each

func (q *QueryParameters) Each(it func(name string, value ydb.Value))

func (*QueryParameters) String

func (q *QueryParameters) String() string

type StreamQueryOption

type StreamQueryOption func(s *streamQueryDesc)

func WithStreamQueryProfile

func WithStreamQueryProfile(profile StreamQueryProfile) StreamQueryOption

type StreamQueryProfile

type StreamQueryProfile uint

const (
	StreamQueryProfileUnknown StreamQueryProfile = iota
	StreamQueryProfileNone
	StreamQueryProfileBasic
	StreamQueryProfileFull
)

func (StreamQueryProfile) String

func (s StreamQueryProfile) String() string

type StreamQueryResult

type StreamQueryResult struct {
	ResultType StreamQueryResultType
	Value      interface{}
}

func (*StreamQueryResult) Profile

func (s *StreamQueryResult) Profile() *StreamQueryResultProfile

func (*StreamQueryResult) Progress

func (s *StreamQueryResult) Progress() *StreamQueryResultProgress

func (*StreamQueryResult) ResultSet

func (s *StreamQueryResult) ResultSet() *StreamQueryResultResultSet

type StreamQueryResultProfile

type StreamQueryResultProfile string

type StreamQueryResultProgress

type StreamQueryResultProgress struct{}

type StreamQueryResultResultSet

type StreamQueryResultResultSet struct{}

StreamQueryResultResultSet TODO: support return real result set

type StreamQueryResultType

type StreamQueryResultType uint

const (
	StreamQueryResultTypeResultUnknown StreamQueryResultType = iota
	StreamQueryResultTypeResultSet
	StreamQueryResultTypeProfile
	StreamQueryResultTypeProgress
)