server

Documentation

Overview

Package server contains the code base of Connector GRPC service - the component of YDB's Federated Query system providing the unified interface to the external data sources.

Index

• Variables
• func NewEmbedded(options ...EmbeddedOption) (common.TestingServer, error)
• func NewHTTPPullerHandler(logger *zap.Logger, r MetricsStreamer, opts ...HTTPPullerOption) http.Handler
• func StreamServerMetrics(logger *zap.Logger, registry metrics.Registry) grpc.StreamServerInterceptor
• func UnaryServerMetrics(logger *zap.Logger, registry metrics.Registry) grpc.UnaryServerInterceptor
• func ValidateDescribeTableRequest(logger *zap.Logger, request *api_service_protos.TDescribeTableRequest) error
• func ValidateListSplitsRequest(logger *zap.Logger, request *api_service_protos.TListSplitsRequest) error
• func ValidateReadSplitsRequest(logger *zap.Logger, request *api_service_protos.TReadSplitsRequest) error
• type DataSourceCollection
  • func NewDataSourceCollection(queryLoggerFactory common.QueryLoggerFactory, memoryAllocator memory.Allocator, ...) (*DataSourceCollection, error)
  • func (dsc *DataSourceCollection) DescribeTable(ctx context.Context, logger *zap.Logger, ...) (*api_service_protos.TDescribeTableResponse, error)
  • func (dsc *DataSourceCollection) DoReadSplit(logger *zap.Logger, stream api_service.Connector_ReadSplitsServer, ...) error
• type EmbeddedOption
  • func WithConnectionTimeouts(open, ping string) EmbeddedOption
  • func WithConversionConfig(conversionConfig *config.TConversionConfig) EmbeddedOption
  • func WithLoggerConfig(loggerConfig *config.TLoggerConfig) EmbeddedOption
  • func WithMetricsServerConfig(metricsServerConfig *config.TMetricsServerConfig) EmbeddedOption
  • func WithPagingConfig(pagingConfig *config.TPagingConfig) EmbeddedOption
  • func WithPprofServerConfig(pprofServerConfig *config.TPprofServerConfig) EmbeddedOption
  • func WithYdbConnectorMode(mode config.TYdbConfig_Mode) EmbeddedOption
• type HTTPPullerOption
  • func WithSpack() HTTPPullerOption
• type Launcher
  • func NewLauncher(logger *zap.Logger, cfg *config.TServerConfig) (*Launcher, error)
  • func (l *Launcher) Start() <-chan error
  • func (l *Launcher) Stop()
• type MetricsStreamer

Variables

var Cmd = &cobra.Command{
	Use:   "server",
	Short: "Connector server",
	Run: func(cmd *cobra.Command, args []string) {
		if err := runFromCLI(cmd, args); err != nil {
			fmt.Println(err)
			os.Exit(1)
		}
	},
}

Functions

func NewEmbedded

func NewEmbedded(options ...EmbeddedOption) (common.TestingServer, error)

func NewHTTPPullerHandler

func NewHTTPPullerHandler(logger *zap.Logger, r MetricsStreamer, opts ...HTTPPullerOption) http.Handler

NewHTTPPullerHandler returns new HTTP handler to expose gathered metrics using metrics dumper

func StreamServerMetrics

func StreamServerMetrics(logger *zap.Logger, registry metrics.Registry) grpc.StreamServerInterceptor

func UnaryServerMetrics

func UnaryServerMetrics(logger *zap.Logger, registry metrics.Registry) grpc.UnaryServerInterceptor

func ValidateDescribeTableRequest

func ValidateDescribeTableRequest(logger *zap.Logger, request *api_service_protos.TDescribeTableRequest) error

func ValidateListSplitsRequest

func ValidateListSplitsRequest(logger *zap.Logger, request *api_service_protos.TListSplitsRequest) error

func ValidateReadSplitsRequest

func ValidateReadSplitsRequest(logger *zap.Logger, request *api_service_protos.TReadSplitsRequest) error

Types

type DataSourceCollection

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

func NewDataSourceCollection

func NewDataSourceCollection(
	queryLoggerFactory common.QueryLoggerFactory,
	memoryAllocator memory.Allocator,
	readLimiterFactory *paging.ReadLimiterFactory,
	converterCollection conversion.Collection,
	cfg *config.TServerConfig,
) (*DataSourceCollection, error)

func (*DataSourceCollection) DescribeTable

func (dsc *DataSourceCollection) DescribeTable(
	ctx context.Context,
	logger *zap.Logger,
	request *api_service_protos.TDescribeTableRequest,
) (*api_service_protos.TDescribeTableResponse, error)

func (*DataSourceCollection) DoReadSplit

func (dsc *DataSourceCollection) DoReadSplit(
	logger *zap.Logger,
	stream api_service.Connector_ReadSplitsServer,
	request *api_service_protos.TReadSplitsRequest,
	split *api_service_protos.TSplit,
) error

type EmbeddedOption

type EmbeddedOption interface {
	// contains filtered or unexported methods
}

EmbeddedOption parametrizes initialization of Connector server embedded into tests

func WithConnectionTimeouts

func WithConnectionTimeouts(open, ping string) EmbeddedOption

func WithConversionConfig

func WithConversionConfig(conversionConfig *config.TConversionConfig) EmbeddedOption

func WithLoggerConfig

func WithLoggerConfig(loggerConfig *config.TLoggerConfig) EmbeddedOption

func WithMetricsServerConfig

func WithMetricsServerConfig(metricsServerConfig *config.TMetricsServerConfig) EmbeddedOption

func WithPagingConfig

func WithPagingConfig(pagingConfig *config.TPagingConfig) EmbeddedOption

func WithPprofServerConfig

func WithPprofServerConfig(pprofServerConfig *config.TPprofServerConfig) EmbeddedOption

func WithYdbConnectorMode

func WithYdbConnectorMode(mode config.TYdbConfig_Mode) EmbeddedOption

type HTTPPullerOption

type HTTPPullerOption interface {
	// contains filtered or unexported methods
}

func WithSpack

func WithSpack() HTTPPullerOption

type Launcher

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

func NewLauncher

func NewLauncher(logger *zap.Logger, cfg *config.TServerConfig) (*Launcher, error)

func (*Launcher) Start

func (l *Launcher) Start() <-chan error

func (*Launcher) Stop

func (l *Launcher) Stop()

type MetricsStreamer

type MetricsStreamer interface {
	StreamJSON(context.Context, io.Writer) (int, error)
	StreamSpack(context.Context, io.Writer, solomon.CompressionType) (int, error)
}