Documentation
¶
Overview ¶
Package datasource reads a repo's data_sources.yml. The host owns this (it holds connection config / credentials and runs queries); only the name->dbtype mapping is ever passed to the sidecar for SQL-dialect selection, so secrets never cross the IPC boundary.
Index ¶
Constants ¶
const FileName = "data_sources.yml"
FileName is the data source manifest, inside the repo's config dir (repo.Repo.ConfigDir()).
Variables ¶
var ErrUnknown = errors.New("no such data source")
ErrUnknown is Connection's answer for a name the repo has no data source by.
Functions ¶
This section is empty.
Types ¶
type DataPermMode ¶ added in v0.11.1
type DataPermMode int
DataPermMode is how the SQL a connection carries reads the data: a fact about the statement, which the engine states and a host may check, never a decision. Every statement the engine runs is one of the two (internal/query). The zero value is no mode, which a host refuses.
const ( // DataPermModeGoverned: SQL the engine compiled from a dataset, with the // invocation's DataPerms in it. DataPermModeGoverned DataPermMode = iota + 1 // DataPermModeUngoverned: SQL as written, which nothing applies DataPerms // to; run only for an invocation whose DataPerms are Ungoverned. DataPermModeUngoverned )
func (DataPermMode) String ¶ added in v0.11.1
func (m DataPermMode) String() string
String is the mode as logs name it.
type DataSource ¶
type DataSource struct {
Name string `json:"name"`
DBType string `json:"dbtype"`
Connection map[string]any `json:"-"`
Settings map[string]any `json:"-"`
}
DataSource describes one data source. Name/DBType are what the sidecar needs to compile SQL (dialect). Connection holds the host-side connection config (passed to canal-query as dbconfig) and is never serialized to the sidecar. Settings are how canal-query connects and queries (timeouts, SSL, the type's own options), passed to it as dbsetting; none leaves each at canal's default.
type DataSources ¶ added in v0.9.0
type DataSources interface {
// Dialects is the data sources the caller may compile against, by name and
// type.
Dialects(ctx context.Context) ([]Dialect, error)
// Connection is the data source by name, connection included, for SQL that
// reads the data as mode says. A host may refuse a mode it did not grant the
// call on that data source: a second gate, behind its authorization and the
// invocation's DataPerms, which must be right on their own. A name the repo
// has no data source by is ErrUnknown; any other error is the host's, and
// reaches the caller as it is.
Connection(ctx context.Context, name string, mode DataPermMode) (DataSource, error)
}
DataSources is how the engine reaches a repo's data sources, asking for no more than a command needs: every data source's dialect, to compile (the engine cannot know which one a dataset uses until it is compiled); one connection, to run a query on the data source it targets. validate asks for neither.
A host serving a managed repo implements it over its own store: Dialects is metadata, and Connection is where one data source's connection is retrieved. A local repo's is its data_sources.yml (Load).
type Dialect ¶ added in v0.9.0
Dialect is a data source as compiling needs it: its name and its type (the SQL dialect). No connection.
type Set ¶ added in v0.9.0
type Set map[string]DataSource
Set is data sources held in memory, by name: what data_sources.yml loads into, or what a host that already holds them all passes. It is a DataSources.
func (Set) Connection ¶ added in v0.9.0
func (s Set) Connection(_ context.Context, name string, _ DataPermMode) (DataSource, error)
Connection is the data source named name in s, whatever the mode: a Set holds no grants.