Documentation
¶
Overview ¶
Package github is a dfetch Connector backed by the GitHub REST API. It exposes the issues, pulls, repos, commits, releases, workflow_runs, and artifacts tables under the SQL schema "github" and pushes down equality filters, ORDER BY, and LIMIT to the API where it can.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func New ¶
New builds a GitHub connector. Supported params: "base_url" (override the API host, used in tests/Enterprise), "token_func" (programmatic-config Go func supplying a token), and "token_command" (argv run to fetch a token). The token resolves from $GITHUB_TOKEN / $GH_TOKEN, else token_func, else token_command, lazily on first use (see source.Credential).
Types ¶
type Connector ¶
type Connector struct {
// contains filtered or unexported fields
}
Connector talks to the GitHub REST API.
func (*Connector) Scan ¶
func (c *Connector) Scan(ctx context.Context, req source.ScanRequest, emit func(*source.Rows) error) error
Scan dispatches to the per-table fetchers, which emit one chunk per API page.
func (*Connector) Tables ¶
func (c *Connector) Tables() []source.TableSchema
Tables returns the schemas of the github.* tables.
Source Files