Documentation ¶
Index ¶
- Variables
- type EDataSourceKind
- func (EDataSourceKind) Descriptor() protoreflect.EnumDescriptor
- func (x EDataSourceKind) Enum() *EDataSourceKind
- func (EDataSourceKind) EnumDescriptor() ([]byte, []int)deprecated
- func (x EDataSourceKind) Number() protoreflect.EnumNumber
- func (x EDataSourceKind) String() string
- func (EDataSourceKind) Type() protoreflect.EnumType
- type EProtocol
- type TClickhouseDataSourceOptions
- func (*TClickhouseDataSourceOptions) Descriptor() ([]byte, []int)deprecated
- func (*TClickhouseDataSourceOptions) ProtoMessage()
- func (x *TClickhouseDataSourceOptions) ProtoReflect() protoreflect.Message
- func (x *TClickhouseDataSourceOptions) Reset()
- func (x *TClickhouseDataSourceOptions) String() string
- type TCredentials
- func (*TCredentials) Descriptor() ([]byte, []int)deprecated
- func (x *TCredentials) GetBasic() *TCredentials_TBasic
- func (m *TCredentials) GetPayload() isTCredentials_Payload
- func (*TCredentials) ProtoMessage()
- func (x *TCredentials) ProtoReflect() protoreflect.Message
- func (x *TCredentials) Reset()
- func (x *TCredentials) String() string
- type TCredentials_Basic
- type TCredentials_TBasic
- func (*TCredentials_TBasic) Descriptor() ([]byte, []int)deprecated
- func (x *TCredentials_TBasic) GetPassword() string
- func (x *TCredentials_TBasic) GetUsername() string
- func (*TCredentials_TBasic) ProtoMessage()
- func (x *TCredentials_TBasic) ProtoReflect() protoreflect.Message
- func (x *TCredentials_TBasic) Reset()
- func (x *TCredentials_TBasic) String() string
- type TDataSourceInstance
- func (*TDataSourceInstance) Descriptor() ([]byte, []int)deprecated
- func (x *TDataSourceInstance) GetChOptions() *TClickhouseDataSourceOptions
- func (x *TDataSourceInstance) GetCredentials() *TCredentials
- func (x *TDataSourceInstance) GetDatabase() string
- func (x *TDataSourceInstance) GetEndpoint() *TEndpoint
- func (x *TDataSourceInstance) GetKind() EDataSourceKind
- func (m *TDataSourceInstance) GetOptions() isTDataSourceInstance_Options
- func (x *TDataSourceInstance) GetPgOptions() *TPostgreSQLDataSourceOptions
- func (x *TDataSourceInstance) GetProtocol() EProtocol
- func (x *TDataSourceInstance) GetUseTls() bool
- func (*TDataSourceInstance) ProtoMessage()
- func (x *TDataSourceInstance) ProtoReflect() protoreflect.Message
- func (x *TDataSourceInstance) Reset()
- func (x *TDataSourceInstance) String() string
- type TDataSourceInstance_ChOptions
- type TDataSourceInstance_PgOptions
- type TEndpoint
- type TPostgreSQLDataSourceOptions
- func (*TPostgreSQLDataSourceOptions) Descriptor() ([]byte, []int)deprecated
- func (x *TPostgreSQLDataSourceOptions) GetSchema() string
- func (*TPostgreSQLDataSourceOptions) ProtoMessage()
- func (x *TPostgreSQLDataSourceOptions) ProtoReflect() protoreflect.Message
- func (x *TPostgreSQLDataSourceOptions) Reset()
- func (x *TPostgreSQLDataSourceOptions) String() string
Constants ¶
This section is empty.
Variables ¶
var ( EDataSourceKind_name = map[int32]string{ 0: "DATA_SOURCE_KIND_UNSPECIFIED", 1: "CLICKHOUSE", 2: "POSTGRESQL", } EDataSourceKind_value = map[string]int32{ "DATA_SOURCE_KIND_UNSPECIFIED": 0, "CLICKHOUSE": 1, "POSTGRESQL": 2, } )
Enum value maps for EDataSourceKind.
var ( EProtocol_name = map[int32]string{ 0: "PROTOCOL_UNSPECIFIED", 1: "NATIVE", 2: "HTTP", } EProtocol_value = map[string]int32{ "PROTOCOL_UNSPECIFIED": 0, "NATIVE": 1, "HTTP": 2, } )
Enum value maps for EProtocol.
var File_ydb_library_yql_providers_generic_connector_api_common_data_source_proto protoreflect.FileDescriptor
var File_ydb_library_yql_providers_generic_connector_api_common_endpoint_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type EDataSourceKind ¶
type EDataSourceKind int32
EDataSourceKind enumerates the external data sources supported in the federated query system
const ( EDataSourceKind_DATA_SOURCE_KIND_UNSPECIFIED EDataSourceKind = 0 EDataSourceKind_CLICKHOUSE EDataSourceKind = 1 EDataSourceKind_POSTGRESQL EDataSourceKind = 2 )
func (EDataSourceKind) Descriptor ¶
func (EDataSourceKind) Descriptor() protoreflect.EnumDescriptor
func (EDataSourceKind) Enum ¶
func (x EDataSourceKind) Enum() *EDataSourceKind
func (EDataSourceKind) EnumDescriptor
deprecated
func (EDataSourceKind) EnumDescriptor() ([]byte, []int)
Deprecated: Use EDataSourceKind.Descriptor instead.
func (EDataSourceKind) Number ¶
func (x EDataSourceKind) Number() protoreflect.EnumNumber
func (EDataSourceKind) String ¶
func (x EDataSourceKind) String() string
func (EDataSourceKind) Type ¶
func (EDataSourceKind) Type() protoreflect.EnumType
type EProtocol ¶
type EProtocol int32
EProtocol generalizes various kinds of network protocols supported by different databases.
func (EProtocol) Descriptor ¶
func (EProtocol) Descriptor() protoreflect.EnumDescriptor
func (EProtocol) EnumDescriptor
deprecated
func (EProtocol) Number ¶
func (x EProtocol) Number() protoreflect.EnumNumber
func (EProtocol) Type ¶
func (EProtocol) Type() protoreflect.EnumType
type TClickhouseDataSourceOptions ¶
type TClickhouseDataSourceOptions struct {
// contains filtered or unexported fields
}
TClickhouseDataSourceOptions represents settings specific to Clickhouse
func (*TClickhouseDataSourceOptions) Descriptor
deprecated
func (*TClickhouseDataSourceOptions) Descriptor() ([]byte, []int)
Deprecated: Use TClickhouseDataSourceOptions.ProtoReflect.Descriptor instead.
func (*TClickhouseDataSourceOptions) ProtoMessage ¶
func (*TClickhouseDataSourceOptions) ProtoMessage()
func (*TClickhouseDataSourceOptions) ProtoReflect ¶
func (x *TClickhouseDataSourceOptions) ProtoReflect() protoreflect.Message
func (*TClickhouseDataSourceOptions) Reset ¶
func (x *TClickhouseDataSourceOptions) Reset()
func (*TClickhouseDataSourceOptions) String ¶
func (x *TClickhouseDataSourceOptions) String() string
type TCredentials ¶
type TCredentials struct { // Types that are assignable to Payload: // *TCredentials_Basic Payload isTCredentials_Payload `protobuf_oneof:"payload"` // contains filtered or unexported fields }
TCredentials represents various ways of user authentication in the data source instance
func (*TCredentials) Descriptor
deprecated
func (*TCredentials) Descriptor() ([]byte, []int)
Deprecated: Use TCredentials.ProtoReflect.Descriptor instead.
func (*TCredentials) GetBasic ¶
func (x *TCredentials) GetBasic() *TCredentials_TBasic
func (*TCredentials) GetPayload ¶
func (m *TCredentials) GetPayload() isTCredentials_Payload
func (*TCredentials) ProtoMessage ¶
func (*TCredentials) ProtoMessage()
func (*TCredentials) ProtoReflect ¶
func (x *TCredentials) ProtoReflect() protoreflect.Message
func (*TCredentials) Reset ¶
func (x *TCredentials) Reset()
func (*TCredentials) String ¶
func (x *TCredentials) String() string
type TCredentials_Basic ¶
type TCredentials_Basic struct {
Basic *TCredentials_TBasic `protobuf:"bytes,1,opt,name=basic,proto3,oneof"`
}
type TCredentials_TBasic ¶
type TCredentials_TBasic struct { Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"` Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"` // contains filtered or unexported fields }
func (*TCredentials_TBasic) Descriptor
deprecated
func (*TCredentials_TBasic) Descriptor() ([]byte, []int)
Deprecated: Use TCredentials_TBasic.ProtoReflect.Descriptor instead.
func (*TCredentials_TBasic) GetPassword ¶
func (x *TCredentials_TBasic) GetPassword() string
func (*TCredentials_TBasic) GetUsername ¶
func (x *TCredentials_TBasic) GetUsername() string
func (*TCredentials_TBasic) ProtoMessage ¶
func (*TCredentials_TBasic) ProtoMessage()
func (*TCredentials_TBasic) ProtoReflect ¶
func (x *TCredentials_TBasic) ProtoReflect() protoreflect.Message
func (*TCredentials_TBasic) Reset ¶
func (x *TCredentials_TBasic) Reset()
func (*TCredentials_TBasic) String ¶
func (x *TCredentials_TBasic) String() string
type TDataSourceInstance ¶
type TDataSourceInstance struct { // Data source kind Kind EDataSourceKind `protobuf:"varint,1,opt,name=kind,proto3,enum=NYql.NConnector.NApi.EDataSourceKind" json:"kind,omitempty"` // Network address Endpoint *TEndpoint `protobuf:"bytes,2,opt,name=endpoint,proto3" json:"endpoint,omitempty"` // Database name Database string `protobuf:"bytes,3,opt,name=database,proto3" json:"database,omitempty"` // Credentials to access database Credentials *TCredentials `protobuf:"bytes,4,opt,name=credentials,proto3" json:"credentials,omitempty"` // If true, Connector server will use secure connections to access remote data sources. // Certificates will be obtained from the standard system paths. UseTls bool `protobuf:"varint,5,opt,name=use_tls,json=useTls,proto3" json:"use_tls,omitempty"` // Allows to specify network protocol that should be used between // during the connection between Connector and the remote data source Protocol EProtocol `protobuf:"varint,6,opt,name=protocol,proto3,enum=NYql.NConnector.NApi.EProtocol" json:"protocol,omitempty"` // Options specific to various data sources // // Types that are assignable to Options: // *TDataSourceInstance_PgOptions // *TDataSourceInstance_ChOptions Options isTDataSourceInstance_Options `protobuf_oneof:"options"` // contains filtered or unexported fields }
TDataSourceInstance helps to identify the instance of a data source to redirect request to.
func (*TDataSourceInstance) Descriptor
deprecated
func (*TDataSourceInstance) Descriptor() ([]byte, []int)
Deprecated: Use TDataSourceInstance.ProtoReflect.Descriptor instead.
func (*TDataSourceInstance) GetChOptions ¶
func (x *TDataSourceInstance) GetChOptions() *TClickhouseDataSourceOptions
func (*TDataSourceInstance) GetCredentials ¶
func (x *TDataSourceInstance) GetCredentials() *TCredentials
func (*TDataSourceInstance) GetDatabase ¶
func (x *TDataSourceInstance) GetDatabase() string
func (*TDataSourceInstance) GetEndpoint ¶
func (x *TDataSourceInstance) GetEndpoint() *TEndpoint
func (*TDataSourceInstance) GetKind ¶
func (x *TDataSourceInstance) GetKind() EDataSourceKind
func (*TDataSourceInstance) GetOptions ¶
func (m *TDataSourceInstance) GetOptions() isTDataSourceInstance_Options
func (*TDataSourceInstance) GetPgOptions ¶
func (x *TDataSourceInstance) GetPgOptions() *TPostgreSQLDataSourceOptions
func (*TDataSourceInstance) GetProtocol ¶
func (x *TDataSourceInstance) GetProtocol() EProtocol
func (*TDataSourceInstance) GetUseTls ¶
func (x *TDataSourceInstance) GetUseTls() bool
func (*TDataSourceInstance) ProtoMessage ¶
func (*TDataSourceInstance) ProtoMessage()
func (*TDataSourceInstance) ProtoReflect ¶
func (x *TDataSourceInstance) ProtoReflect() protoreflect.Message
func (*TDataSourceInstance) Reset ¶
func (x *TDataSourceInstance) Reset()
func (*TDataSourceInstance) String ¶
func (x *TDataSourceInstance) String() string
type TDataSourceInstance_ChOptions ¶
type TDataSourceInstance_ChOptions struct {
ChOptions *TClickhouseDataSourceOptions `protobuf:"bytes,8,opt,name=ch_options,json=chOptions,proto3,oneof"`
}
type TDataSourceInstance_PgOptions ¶
type TDataSourceInstance_PgOptions struct {
PgOptions *TPostgreSQLDataSourceOptions `protobuf:"bytes,7,opt,name=pg_options,json=pgOptions,proto3,oneof"`
}
type TEndpoint ¶
type TEndpoint struct { Host string `protobuf:"bytes,1,opt,name=host,proto3" json:"host,omitempty"` Port uint32 `protobuf:"varint,2,opt,name=port,proto3" json:"port,omitempty"` // contains filtered or unexported fields }
TEndpoint represents the network address of a data source instance
func (*TEndpoint) Descriptor
deprecated
func (*TEndpoint) ProtoMessage ¶
func (*TEndpoint) ProtoMessage()
func (*TEndpoint) ProtoReflect ¶
func (x *TEndpoint) ProtoReflect() protoreflect.Message
type TPostgreSQLDataSourceOptions ¶
type TPostgreSQLDataSourceOptions struct { // PostgreSQL schema Schema string `protobuf:"bytes,1,opt,name=schema,proto3" json:"schema,omitempty"` // contains filtered or unexported fields }
TPostgreSQLDataSourceOptions represents settings specific to PostgreSQL
func (*TPostgreSQLDataSourceOptions) Descriptor
deprecated
func (*TPostgreSQLDataSourceOptions) Descriptor() ([]byte, []int)
Deprecated: Use TPostgreSQLDataSourceOptions.ProtoReflect.Descriptor instead.
func (*TPostgreSQLDataSourceOptions) GetSchema ¶
func (x *TPostgreSQLDataSourceOptions) GetSchema() string
func (*TPostgreSQLDataSourceOptions) ProtoMessage ¶
func (*TPostgreSQLDataSourceOptions) ProtoMessage()
func (*TPostgreSQLDataSourceOptions) ProtoReflect ¶
func (x *TPostgreSQLDataSourceOptions) ProtoReflect() protoreflect.Message
func (*TPostgreSQLDataSourceOptions) Reset ¶
func (x *TPostgreSQLDataSourceOptions) Reset()
func (*TPostgreSQLDataSourceOptions) String ¶
func (x *TPostgreSQLDataSourceOptions) String() string