common

package
v0.5.6-rc.1 Latest Latest
Warning

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

 Go to latest Published: Aug 26, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	EDataSourceKind_name = map[int32]string{
		0: "DATA_SOURCE_KIND_UNSPECIFIED",
		1: "CLICKHOUSE",
		2: "POSTGRESQL",
		3: "S3",
		4: "YDB",
		5: "MYSQL",
		6: "MS_SQL_SERVER",
		7: "GREENPLUM",
		8: "ORACLE",
	}
	EDataSourceKind_value = map[string]int32{
		"DATA_SOURCE_KIND_UNSPECIFIED": 0,
		"CLICKHOUSE":                   1,
		"POSTGRESQL":                   2,
		"S3":                           3,
		"YDB":                          4,
		"MYSQL":                        5,
		"MS_SQL_SERVER":                6,
		"GREENPLUM":                    7,
		"ORACLE":                       8,
	}
)

Enum value maps for EDataSourceKind.

View Source 
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.

View Source 
var File_ydb_library_yql_providers_generic_connector_api_common_data_source_proto protoreflect.FileDescriptor
View Source 
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 by the federated query system 

const (
	EDataSourceKind_DATA_SOURCE_KIND_UNSPECIFIED EDataSourceKind = 0
	EDataSourceKind_CLICKHOUSE                   EDataSourceKind = 1
	EDataSourceKind_POSTGRESQL                   EDataSourceKind = 2
	EDataSourceKind_S3                           EDataSourceKind = 3
	EDataSourceKind_YDB                          EDataSourceKind = 4
	EDataSourceKind_MYSQL                        EDataSourceKind = 5
	EDataSourceKind_MS_SQL_SERVER                EDataSourceKind = 6
	EDataSourceKind_GREENPLUM                    EDataSourceKind = 7
	EDataSourceKind_ORACLE                       EDataSourceKind = 8
)

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. 

const (
	EProtocol_PROTOCOL_UNSPECIFIED EProtocol = 0
	EProtocol_NATIVE               EProtocol = 1 // CLICKHOUSE, POSTGRESQL
	EProtocol_HTTP                 EProtocol = 2 // CLICKHOUSE, S3
)

func (EProtocol) Descriptor 

func (EProtocol) Descriptor() protoreflect.EnumDescriptor

func (EProtocol) Enum 

func (x EProtocol) Enum() *EProtocol

func (EProtocol) EnumDescriptor deprecated 

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

Deprecated: Use EProtocol.Descriptor instead.

func (EProtocol) Number 

func (x EProtocol) Number() protoreflect.EnumNumber

func (EProtocol) String 

func (x EProtocol) String() string

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
	//	*TCredentials_Token
	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) GetToken added in v0.1.2 

func (x *TCredentials) GetToken() *TCredentials_TToken

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 TCredentials_TToken added in v0.1.2 

type TCredentials_TToken struct {
	Type  string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*TCredentials_TToken) Descriptor deprecated added in v0.1.2 

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

Deprecated: Use TCredentials_TToken.ProtoReflect.Descriptor instead.

func (*TCredentials_TToken) GetType added in v0.1.2 

func (x *TCredentials_TToken) GetType() string

func (*TCredentials_TToken) GetValue added in v0.1.2 

func (x *TCredentials_TToken) GetValue() string

func (*TCredentials_TToken) ProtoMessage added in v0.1.2 

func (*TCredentials_TToken) ProtoMessage()

func (*TCredentials_TToken) ProtoReflect added in v0.1.2 

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

func (*TCredentials_TToken) Reset added in v0.1.2 

func (x *TCredentials_TToken) Reset()

func (*TCredentials_TToken) String added in v0.1.2 

func (x *TCredentials_TToken) String() string

type TCredentials_Token added in v0.1.2 

type TCredentials_Token struct {
	Token *TCredentials_TToken `protobuf:"bytes,2,opt,name=token,proto3,oneof"`
}

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
	//	*TDataSourceInstance_S3Options
	//	*TDataSourceInstance_GpOptions
	//	*TDataSourceInstance_OracleOptions
	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) GetGpOptions added in v0.4.6 

func (x *TDataSourceInstance) GetGpOptions() *TGreenplumDataSourceOptions

func (*TDataSourceInstance) GetKind 

func (x *TDataSourceInstance) GetKind() EDataSourceKind

func (*TDataSourceInstance) GetOptions 

func (m *TDataSourceInstance) GetOptions() isTDataSourceInstance_Options

func (*TDataSourceInstance) GetOracleOptions added in v0.5.1 

func (x *TDataSourceInstance) GetOracleOptions() *TOracleDataSourceOptions

func (*TDataSourceInstance) GetPgOptions 

func (x *TDataSourceInstance) GetPgOptions() *TPostgreSQLDataSourceOptions

func (*TDataSourceInstance) GetProtocol 

func (x *TDataSourceInstance) GetProtocol() EProtocol

func (*TDataSourceInstance) GetS3Options 

func (x *TDataSourceInstance) GetS3Options() *TS3DataSourceOptions

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_GpOptions added in v0.4.6 

type TDataSourceInstance_GpOptions struct {
	GpOptions *TGreenplumDataSourceOptions `protobuf:"bytes,10,opt,name=gp_options,json=gpOptions,proto3,oneof"`
}

type TDataSourceInstance_OracleOptions added in v0.5.1 

type TDataSourceInstance_OracleOptions struct {
	OracleOptions *TOracleDataSourceOptions `protobuf:"bytes,11,opt,name=oracle_options,json=oracleOptions,proto3,oneof"`
}

type TDataSourceInstance_PgOptions 

type TDataSourceInstance_PgOptions struct {
	PgOptions *TPostgreSQLDataSourceOptions `protobuf:"bytes,7,opt,name=pg_options,json=pgOptions,proto3,oneof"`
}

type TDataSourceInstance_S3Options 

type TDataSourceInstance_S3Options struct {
	S3Options *TS3DataSourceOptions `protobuf:"bytes,9,opt,name=s3_options,json=s3Options,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) Descriptor() ([]byte, []int)

Deprecated: Use TEndpoint.ProtoReflect.Descriptor instead.

func (*TEndpoint) GetHost 

func (x *TEndpoint) GetHost() string

func (*TEndpoint) GetPort 

func (x *TEndpoint) GetPort() uint32

func (*TEndpoint) ProtoMessage 

func (*TEndpoint) ProtoMessage()

func (*TEndpoint) ProtoReflect 

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

func (*TEndpoint) Reset 

func (x *TEndpoint) Reset()

func (*TEndpoint) String 

func (x *TEndpoint) String() string

type TGreenplumDataSourceOptions added in v0.4.6 

type TGreenplumDataSourceOptions struct {

	// Greenplum schema
	Schema string `protobuf:"bytes,1,opt,name=schema,proto3" json:"schema,omitempty"`
	// contains filtered or unexported fields
}

TGreenplumDataSourceOptions represents settings specific to Greenplum

func (*TGreenplumDataSourceOptions) Descriptor deprecated added in v0.4.6 

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

Deprecated: Use TGreenplumDataSourceOptions.ProtoReflect.Descriptor instead.

func (*TGreenplumDataSourceOptions) GetSchema added in v0.4.6 

func (x *TGreenplumDataSourceOptions) GetSchema() string

func (*TGreenplumDataSourceOptions) ProtoMessage added in v0.4.6 

func (*TGreenplumDataSourceOptions) ProtoMessage()

func (*TGreenplumDataSourceOptions) ProtoReflect added in v0.4.6 

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

func (*TGreenplumDataSourceOptions) Reset added in v0.4.6 

func (x *TGreenplumDataSourceOptions) Reset()

func (*TGreenplumDataSourceOptions) String added in v0.4.6 

func (x *TGreenplumDataSourceOptions) String() string

type TOracleDataSourceOptions added in v0.5.0 

type TOracleDataSourceOptions struct {

	// Oracle service_name - alias to SID of oracle INSTANCE, or SID, or PDB.
	//
	//	More about connection options in Oracle docs:
	//	https://docs.oracle.com/en/database/other-databases/essbase/21/essoa/connection-string-formats.html
	ServiceName string `protobuf:"bytes,1,opt,name=service_name,json=serviceName,proto3" json:"service_name,omitempty"`
	// contains filtered or unexported fields
}

TOracleDataSourceOptions represents settings specific to Oracle

func (*TOracleDataSourceOptions) Descriptor deprecated added in v0.5.0 

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

Deprecated: Use TOracleDataSourceOptions.ProtoReflect.Descriptor instead.

func (*TOracleDataSourceOptions) GetServiceName added in v0.5.0 

func (x *TOracleDataSourceOptions) GetServiceName() string

func (*TOracleDataSourceOptions) ProtoMessage added in v0.5.0 

func (*TOracleDataSourceOptions) ProtoMessage()

func (*TOracleDataSourceOptions) ProtoReflect added in v0.5.0 

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

func (*TOracleDataSourceOptions) Reset added in v0.5.0 

func (x *TOracleDataSourceOptions) Reset()

func (*TOracleDataSourceOptions) String added in v0.5.0 

func (x *TOracleDataSourceOptions) String() string

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

type TS3DataSourceOptions 

type TS3DataSourceOptions struct {

	// the region where data is stored
	Region string `protobuf:"bytes,1,opt,name=region,proto3" json:"region,omitempty"`
	// the bucket the object belongs to
	Bucket string `protobuf:"bytes,2,opt,name=bucket,proto3" json:"bucket,omitempty"`
	// contains filtered or unexported fields
}

TS3DataSourceOptions represents settings specific to S3 (Simple Storage Service)

func (*TS3DataSourceOptions) Descriptor deprecated 

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

Deprecated: Use TS3DataSourceOptions.ProtoReflect.Descriptor instead.

func (*TS3DataSourceOptions) GetBucket 

func (x *TS3DataSourceOptions) GetBucket() string

func (*TS3DataSourceOptions) GetRegion 

func (x *TS3DataSourceOptions) GetRegion() string

func (*TS3DataSourceOptions) ProtoMessage 

func (*TS3DataSourceOptions) ProtoMessage()

func (*TS3DataSourceOptions) ProtoReflect 

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

func (*TS3DataSourceOptions) Reset 

func (x *TS3DataSourceOptions) Reset()

func (*TS3DataSourceOptions) String 

func (x *TS3DataSourceOptions) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.