fq-connector-go

module

v0.2.21 Latest Latest Go to latest Published: Apr 25, 2024 License: Apache-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ydb-platform/fq-connector-go

Links

Open Source Insights

README ¶

Objectives

Service fq-connector-go is a part of YDB Federated Query system. It's an extension point making YDB capable of interaction with various external data sources. You can deploy fq-connector-go alongside with YDB in order to query and handle data extracted from the external sources.

Currently supported data sources:

ClickHouse
PostgreSQL
YDB

Documentation

Architecture overview
YDB Federated Query deployment:
- For quickstart
- For production environment: YDB | Connector
Contribution guide
Type mapping table

Directories ¶

Path	Synopsis
api
common
service
service/protos
app
bench
client Package client contains code of a simple CLI application that can be used for server debugging.	Package client contains code of a simple CLI application that can be used for server debugging.
client/connector
client/metrics
config
server 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.	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.
server/config
server/conversion
server/datasource Package datasource describes the interface that must be satisfied by any external data source accessible through the connector.	Package datasource describes the interface that must be satisfied by any external data source accessible through the connector.
server/datasource/rdbms Package rdbms contains generalized abstractions suitable for use with any relational database.	Package rdbms contains generalized abstractions suitable for use with any relational database.
server/datasource/rdbms/clickhouse Package clickhouse contains code specific for ClickHouse database.	Package clickhouse contains code specific for ClickHouse database.
server/datasource/rdbms/postgresql Package postgresql contains code specific for PostgreSQL database.	Package postgresql contains code specific for PostgreSQL database.
server/datasource/rdbms/utils Package utils contains helper types and functions that can be used by any relational data source.	Package utils contains helper types and functions that can be used by any relational data source.
server/datasource/rdbms/ydb Package ydb contains code specific for YDB database.	Package ydb contains code specific for YDB database.
server/datasource/s3 Package s3 contains the implementation of S3 (Simple Storage Service) based data source	Package s3 contains the implementation of S3 (Simple Storage Service) based data source
server/paging Package paging contains logic of splitting incoming data stream into the separate pages or blocks.	Package paging contains logic of splitting incoming data stream into the separate pages or blocks.
server/streaming Package streaming contains the logic of converting the data stream coming from the data source into the data stream sent over the network to the client.	Package streaming contains the logic of converting the data stream coming from the data source into the data stream sent over the network to the client.
server/utils Package utils contains various helpers and utility functions	Package utils contains various helpers and utility functions
version
common
library
go/core/buildinfo
go/core/buildinfo/test
go/core/metrics Package metrics provides interface collecting performance metrics.	Package metrics provides interface collecting performance metrics.
go/core/metrics/collect dashboard generator for these metrics can be found at: a.yandex-team.ru/arcadia/library/go/yandex/monitoring-dashboards	dashboard generator for these metrics can be found at: a.yandex-team.ru/arcadia/library/go/yandex/monitoring-dashboards
go/core/metrics/collect/policy/inflight
go/core/metrics/internal/pkg/metricsutil
go/core/metrics/internal/pkg/registryutil
go/core/metrics/mock
go/core/metrics/nop
go/core/metrics/prometheus
go/core/metrics/solomon
go/core/xerrors package xerrors is a drop in replacement for errors and golang.org/x/xerrors packages and functionally for github.com/pkg/errors.	package xerrors is a drop in replacement for errors and golang.org/x/xerrors packages and functionally for github.com/pkg/errors.
go/core/xerrors/assertxerrors
go/core/xerrors/benchxerrors
go/core/xerrors/internal/modes
go/core/xerrors/multierr
go/httputil/headers
go/ptr
go/test/assertpb
go/test/testhelpers
go/test/yatest Package yatest provides access to testing context, when running under ya make -t.	Package yatest provides access to testing context, when running under ya make -t.
go/x/xreflect
go/x/xruntime
go/x/xsync
tests
infra/datasource
infra/datasource/clickhouse
infra/datasource/postgresql
infra/datasource/ydb
infra/docker_compose
suite
utils
tools
docker_compose_update
version
ydbinit

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