config

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 22, 2023 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ELogLevel_name = map[int32]string{
		0: "TRACE",
		1: "DEBUG",
		2: "INFO",
		3: "WARN",
		4: "ERROR",
		5: "FATAL",
	}
	ELogLevel_value = map[string]int32{
		"TRACE": 0,
		"DEBUG": 1,
		"INFO":  2,
		"WARN":  3,
		"ERROR": 4,
		"FATAL": 5,
	}
)

Enum value maps for ELogLevel.

View Source
var File_ydb_library_yql_providers_generic_connector_app_config_client_proto protoreflect.FileDescriptor
View Source
var File_ydb_library_yql_providers_generic_connector_app_config_server_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type ClientConfig

type ClientConfig struct {

	// Connector service instance network address we connect to
	Endpoint *common.TEndpoint `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// TLS credentials for Connector
	Tls *ClientTLSConfig `protobuf:"bytes,2,opt,name=tls,proto3" json:"tls,omitempty"`
	// Data source instance we read data from
	DataSourceInstance *common.TDataSourceInstance `protobuf:"bytes,3,opt,name=data_source_instance,json=dataSourceInstance,proto3" json:"data_source_instance,omitempty"`
	// contains filtered or unexported fields
}

Connector client configuration

func (*ClientConfig) Descriptor deprecated

func (*ClientConfig) Descriptor() ([]byte, []int)

Deprecated: Use ClientConfig.ProtoReflect.Descriptor instead.

func (*ClientConfig) GetDataSourceInstance

func (x *ClientConfig) GetDataSourceInstance() *common.TDataSourceInstance

func (*ClientConfig) GetEndpoint

func (x *ClientConfig) GetEndpoint() *common.TEndpoint

func (*ClientConfig) GetTls

func (x *ClientConfig) GetTls() *ClientTLSConfig

func (*ClientConfig) ProtoMessage

func (*ClientConfig) ProtoMessage()

func (*ClientConfig) ProtoReflect

func (x *ClientConfig) ProtoReflect() protoreflect.Message

func (*ClientConfig) Reset

func (x *ClientConfig) Reset()

func (*ClientConfig) String

func (x *ClientConfig) String() string

type ClientTLSConfig

type ClientTLSConfig struct {

	// CA certificate path
	Ca string `protobuf:"bytes,1,opt,name=ca,proto3" json:"ca,omitempty"`
	// contains filtered or unexported fields
}

func (*ClientTLSConfig) Descriptor deprecated

func (*ClientTLSConfig) Descriptor() ([]byte, []int)

Deprecated: Use ClientTLSConfig.ProtoReflect.Descriptor instead.

func (*ClientTLSConfig) GetCa

func (x *ClientTLSConfig) GetCa() string

func (*ClientTLSConfig) ProtoMessage

func (*ClientTLSConfig) ProtoMessage()

func (*ClientTLSConfig) ProtoReflect

func (x *ClientTLSConfig) ProtoReflect() protoreflect.Message

func (*ClientTLSConfig) Reset

func (x *ClientTLSConfig) Reset()

func (*ClientTLSConfig) String

func (x *ClientTLSConfig) String() string

type ELogLevel

type ELogLevel int32

ELogLevel enumerates standard levels of logging

const (
	ELogLevel_TRACE ELogLevel = 0
	ELogLevel_DEBUG ELogLevel = 1
	ELogLevel_INFO  ELogLevel = 2
	ELogLevel_WARN  ELogLevel = 3
	ELogLevel_ERROR ELogLevel = 4
	ELogLevel_FATAL ELogLevel = 5
)

func (ELogLevel) Descriptor

func (ELogLevel) Descriptor() protoreflect.EnumDescriptor

func (ELogLevel) Enum

func (x ELogLevel) Enum() *ELogLevel

func (ELogLevel) EnumDescriptor deprecated

func (ELogLevel) EnumDescriptor() ([]byte, []int)

Deprecated: Use ELogLevel.Descriptor instead.

func (ELogLevel) Number

func (x ELogLevel) Number() protoreflect.EnumNumber

func (ELogLevel) String

func (x ELogLevel) String() string

func (ELogLevel) Type

type TConnectorServerConfig

type TConnectorServerConfig struct {

	// Network address server will be listening on
	Endpoint *common.TEndpoint `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// TLS settings.
	// Leave it empty for insecure connections.
	Tls *TServerTLSConfig `protobuf:"bytes,2,opt,name=tls,proto3" json:"tls,omitempty"`
	// contains filtered or unexported fields
}

TConnectorServerConfig - configuration of the main GRPC server

func (*TConnectorServerConfig) Descriptor deprecated

func (*TConnectorServerConfig) Descriptor() ([]byte, []int)

Deprecated: Use TConnectorServerConfig.ProtoReflect.Descriptor instead.

func (*TConnectorServerConfig) GetEndpoint

func (x *TConnectorServerConfig) GetEndpoint() *common.TEndpoint

func (*TConnectorServerConfig) GetTls

func (*TConnectorServerConfig) ProtoMessage

func (*TConnectorServerConfig) ProtoMessage()

func (*TConnectorServerConfig) ProtoReflect

func (x *TConnectorServerConfig) ProtoReflect() protoreflect.Message

func (*TConnectorServerConfig) Reset

func (x *TConnectorServerConfig) Reset()

func (*TConnectorServerConfig) String

func (x *TConnectorServerConfig) String() string

type TLoggerConfig

type TLoggerConfig struct {

	// Level of logging
	LogLevel ELogLevel `` /* 127-byte string literal not displayed */
	// Is logging of queries enabled
	EnableSqlQueryLogging bool `` /* 129-byte string literal not displayed */
	// contains filtered or unexported fields
}

TLogger represents logger configuration

func (*TLoggerConfig) Descriptor deprecated

func (*TLoggerConfig) Descriptor() ([]byte, []int)

Deprecated: Use TLoggerConfig.ProtoReflect.Descriptor instead.

func (*TLoggerConfig) GetEnableSqlQueryLogging

func (x *TLoggerConfig) GetEnableSqlQueryLogging() bool

func (*TLoggerConfig) GetLogLevel

func (x *TLoggerConfig) GetLogLevel() ELogLevel

func (*TLoggerConfig) ProtoMessage

func (*TLoggerConfig) ProtoMessage()

func (*TLoggerConfig) ProtoReflect

func (x *TLoggerConfig) ProtoReflect() protoreflect.Message

func (*TLoggerConfig) Reset

func (x *TLoggerConfig) Reset()

func (*TLoggerConfig) String

func (x *TLoggerConfig) String() string

type TMetricsServerConfig

type TMetricsServerConfig struct {

	// Network address server will be listening on
	Endpoint *common.TEndpoint `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// TLS settings.
	// Leave it empty for insecure connections.
	Tls *TServerTLSConfig `protobuf:"bytes,2,opt,name=tls,proto3" json:"tls,omitempty"`
	// contains filtered or unexported fields
}

TMetricsConfig - configuration of the metrics service

func (*TMetricsServerConfig) Descriptor deprecated

func (*TMetricsServerConfig) Descriptor() ([]byte, []int)

Deprecated: Use TMetricsServerConfig.ProtoReflect.Descriptor instead.

func (*TMetricsServerConfig) GetEndpoint

func (x *TMetricsServerConfig) GetEndpoint() *common.TEndpoint

func (*TMetricsServerConfig) GetTls

func (*TMetricsServerConfig) ProtoMessage

func (*TMetricsServerConfig) ProtoMessage()

func (*TMetricsServerConfig) ProtoReflect

func (x *TMetricsServerConfig) ProtoReflect() protoreflect.Message

func (*TMetricsServerConfig) Reset

func (x *TMetricsServerConfig) Reset()

func (*TMetricsServerConfig) String

func (x *TMetricsServerConfig) String() string

type TPagingConfig

type TPagingConfig struct {

	// Configures the limit of a page size in rows.
	// It may override other limits. Ignored if set to zero.
	RowsPerPage uint64 `protobuf:"varint,1,opt,name=rows_per_page,json=rowsPerPage,proto3" json:"rows_per_page,omitempty"`
	// Configures the limit of a page size in bytes.
	// It may override other limits. Ignored if set to zero.
	BytesPerPage uint64 `protobuf:"varint,2,opt,name=bytes_per_page,json=bytesPerPage,proto3" json:"bytes_per_page,omitempty"`
	// Connector service can read ahead some data from the data source before returning it to the client.
	// This setting configures the number of pages that may reside in the service's address space
	// waiting for the client readiness for the data consumption.
	// Tune this carefully cause this may cause service OOMs.
	PrefetchQueueCapacity uint32 `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

TPagingConfig configures the way of splitting of the data stream into the fragments (or pages) in order to return them as separate GRPC messages to the client.

func (*TPagingConfig) Descriptor deprecated

func (*TPagingConfig) Descriptor() ([]byte, []int)

Deprecated: Use TPagingConfig.ProtoReflect.Descriptor instead.

func (*TPagingConfig) GetBytesPerPage

func (x *TPagingConfig) GetBytesPerPage() uint64

func (*TPagingConfig) GetPrefetchQueueCapacity

func (x *TPagingConfig) GetPrefetchQueueCapacity() uint32

func (*TPagingConfig) GetRowsPerPage

func (x *TPagingConfig) GetRowsPerPage() uint64

func (*TPagingConfig) ProtoMessage

func (*TPagingConfig) ProtoMessage()

func (*TPagingConfig) ProtoReflect

func (x *TPagingConfig) ProtoReflect() protoreflect.Message

func (*TPagingConfig) Reset

func (x *TPagingConfig) Reset()

func (*TPagingConfig) String

func (x *TPagingConfig) String() string

type TPprofServerConfig

type TPprofServerConfig struct {

	// Network address server will be listening on
	Endpoint *common.TEndpoint `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// TLS settings.
	// Leave it empty for insecure connections.
	Tls *TServerTLSConfig `protobuf:"bytes,2,opt,name=tls,proto3" json:"tls,omitempty"`
	// contains filtered or unexported fields
}

TPprofServerConfig configures HTTP server delivering Go runtime profiler data

func (*TPprofServerConfig) Descriptor deprecated

func (*TPprofServerConfig) Descriptor() ([]byte, []int)

Deprecated: Use TPprofServerConfig.ProtoReflect.Descriptor instead.

func (*TPprofServerConfig) GetEndpoint

func (x *TPprofServerConfig) GetEndpoint() *common.TEndpoint

func (*TPprofServerConfig) GetTls

func (x *TPprofServerConfig) GetTls() *TServerTLSConfig

func (*TPprofServerConfig) ProtoMessage

func (*TPprofServerConfig) ProtoMessage()

func (*TPprofServerConfig) ProtoReflect

func (x *TPprofServerConfig) ProtoReflect() protoreflect.Message

func (*TPprofServerConfig) Reset

func (x *TPprofServerConfig) Reset()

func (*TPprofServerConfig) String

func (x *TPprofServerConfig) String() string

type TServerConfig

type TServerConfig struct {

	// TODO: remove it after YQ-2057
	//
	// Deprecated: Marked as deprecated in ydb/library/yql/providers/generic/connector/app/config/server.proto.
	Endpoint *common.TEndpoint `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Deprecated: Marked as deprecated in ydb/library/yql/providers/generic/connector/app/config/server.proto.
	Tls             *TServerTLSConfig       `protobuf:"bytes,2,opt,name=tls,proto3" json:"tls,omitempty"`
	ConnectorServer *TConnectorServerConfig `protobuf:"bytes,5,opt,name=connector_server,json=connectorServer,proto3" json:"connector_server,omitempty"`
	// This is a rough restriction for YQ memory consumption until
	// https://st.yandex-team.ru/YQ-2057 is implemented.
	// Leave it empty if you want to avoid any memory limits.
	ReadLimit *TServerReadLimit `protobuf:"bytes,3,opt,name=read_limit,json=readLimit,proto3" json:"read_limit,omitempty"`
	// Logger config
	Logger *TLoggerConfig `protobuf:"bytes,4,opt,name=logger,proto3" json:"logger,omitempty"`
	// Go runtime profiler.
	// Disabled if this part of config is empty.
	PprofServer *TPprofServerConfig `protobuf:"bytes,6,opt,name=pprof_server,json=pprofServer,proto3" json:"pprof_server,omitempty"`
	// Metrics server config
	MetricsServer *TMetricsServerConfig `protobuf:"bytes,7,opt,name=metrics_server,json=metricsServer,proto3" json:"metrics_server,omitempty"`
	// Paging settings
	Paging *TPagingConfig `protobuf:"bytes,8,opt,name=paging,proto3" json:"paging,omitempty"`
	// contains filtered or unexported fields
}

Connector server configuration

func (*TServerConfig) Descriptor deprecated

func (*TServerConfig) Descriptor() ([]byte, []int)

Deprecated: Use TServerConfig.ProtoReflect.Descriptor instead.

func (*TServerConfig) GetConnectorServer

func (x *TServerConfig) GetConnectorServer() *TConnectorServerConfig

func (*TServerConfig) GetEndpoint deprecated

func (x *TServerConfig) GetEndpoint() *common.TEndpoint

Deprecated: Marked as deprecated in ydb/library/yql/providers/generic/connector/app/config/server.proto.

func (*TServerConfig) GetLogger

func (x *TServerConfig) GetLogger() *TLoggerConfig

func (*TServerConfig) GetMetricsServer

func (x *TServerConfig) GetMetricsServer() *TMetricsServerConfig

func (*TServerConfig) GetPaging

func (x *TServerConfig) GetPaging() *TPagingConfig

func (*TServerConfig) GetPprofServer

func (x *TServerConfig) GetPprofServer() *TPprofServerConfig

func (*TServerConfig) GetReadLimit

func (x *TServerConfig) GetReadLimit() *TServerReadLimit

func (*TServerConfig) GetTls deprecated

func (x *TServerConfig) GetTls() *TServerTLSConfig

Deprecated: Marked as deprecated in ydb/library/yql/providers/generic/connector/app/config/server.proto.

func (*TServerConfig) ProtoMessage

func (*TServerConfig) ProtoMessage()

func (*TServerConfig) ProtoReflect

func (x *TServerConfig) ProtoReflect() protoreflect.Message

func (*TServerConfig) Reset

func (x *TServerConfig) Reset()

func (*TServerConfig) String

func (x *TServerConfig) String() string

type TServerReadLimit

type TServerReadLimit struct {

	// The number of rows extracted from the data source
	Rows uint64 `protobuf:"varint,1,opt,name=rows,proto3" json:"rows,omitempty"`
	// contains filtered or unexported fields
}

ServerReadLimit limitates the amount of data extracted from the data source on every read request.

func (*TServerReadLimit) Descriptor deprecated

func (*TServerReadLimit) Descriptor() ([]byte, []int)

Deprecated: Use TServerReadLimit.ProtoReflect.Descriptor instead.

func (*TServerReadLimit) GetRows

func (x *TServerReadLimit) GetRows() uint64

func (*TServerReadLimit) ProtoMessage

func (*TServerReadLimit) ProtoMessage()

func (*TServerReadLimit) ProtoReflect

func (x *TServerReadLimit) ProtoReflect() protoreflect.Message

func (*TServerReadLimit) Reset

func (x *TServerReadLimit) Reset()

func (*TServerReadLimit) String

func (x *TServerReadLimit) String() string

type TServerTLSConfig

type TServerTLSConfig struct {

	// TLS private key path
	Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// TLS public cert path
	Cert string `protobuf:"bytes,3,opt,name=cert,proto3" json:"cert,omitempty"`
	// contains filtered or unexported fields
}

func (*TServerTLSConfig) Descriptor deprecated

func (*TServerTLSConfig) Descriptor() ([]byte, []int)

Deprecated: Use TServerTLSConfig.ProtoReflect.Descriptor instead.

func (*TServerTLSConfig) GetCert

func (x *TServerTLSConfig) GetCert() string

func (*TServerTLSConfig) GetKey

func (x *TServerTLSConfig) GetKey() string

func (*TServerTLSConfig) ProtoMessage

func (*TServerTLSConfig) ProtoMessage()

func (*TServerTLSConfig) ProtoReflect

func (x *TServerTLSConfig) ProtoReflect() protoreflect.Message

func (*TServerTLSConfig) Reset

func (x *TServerTLSConfig) Reset()

func (*TServerTLSConfig) String

func (x *TServerTLSConfig) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL