Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
anfra
command
|
|
|
Package engine is the anfra engine's public Go API: with the shared packages hosts build on (shared/apperr, appstep and apptracing, which classify its errors; shared/apikit, httpkit and requestid, the API framework its operations are served by), the only packages outside internal/ that another module may import.
|
Package engine is the anfra engine's public Go API: with the shared packages hosts build on (shared/apperr, appstep and apptracing, which classify its errors; shared/apikit, httpkit and requestid, the API framework its operations are served by), the only packages outside internal/ that another module may import. |
|
internal
|
|
|
aml
Package aml is the engine's work on the repo's AML as a whole: validating it, and showing its objects.
|
Package aml is the engine's work on the repo's AML as a whole: validating it, and showing its objects. |
|
app
Package app is the single registry of anfra operations.
|
Package app is the single registry of anfra operations. |
|
appserve
Package appserve is anfra serve's Data App component, its backend: the pages a browser opens (/apps/<path>, the appserve frontend), the Data Apps under the repo's apps/ (their tree, and the files themselves), who reads them, and live reload.
|
Package appserve is anfra serve's Data App component, its backend: the pages a browser opens (/apps/<path>, the appserve frontend), the Data Apps under the repo's apps/ (their tree, and the files themselves), who reads them, and live reload. |
|
attribution
Package attribution carries who an invocation is for, so that a log line, a span or an audit record can name them.
|
Package attribution carries who an invocation is for, so that a log line, a span or an audit record can name them. |
|
cliauth
Package cliauth owns browser OAuth login and durable, machine-local credentials.
|
Package cliauth owns browser OAuth login and durable, machine-local credentials. |
|
cliui
Package cliui owns inline terminal presentation, not authentication or storage.
|
Package cliui owns inline terminal presentation, not authentication or storage. |
|
cloudapi
Package cloudapi is the anfra CLI's client of anfra-cloud: the ops `anfra publish` calls, with types written here for them.
|
Package cloudapi is the anfra CLI's client of anfra-cloud: the ops `anfra publish` calls, with types written here for them. |
|
command
Package command is the framework anfra's commands are written in: a Def declares one, Define checks it, and the Command it makes is what every surface reads: the CLI builds its flags from it, `anfra serve` serves it as the op core.<name>, and the registry (internal/app) describes it.
|
Package command is the framework anfra's commands are written in: a Def declares one, Define checks it, and the Command it makes is what every surface reads: the CLI builds its flags from it, `anfra serve` serves it as the op core.<name>, and the registry (internal/app) describes it. |
|
command/catalog
Package catalog is the commands over the local search catalog: ingest builds it from the repo's context sources, search queries it, and lineage traces fields through it.
|
Package catalog is the commands over the local search catalog: ingest builds it from the repo's context sources, search queries it, and lineage traces fields through it. |
|
command/query
Package query is the query commands: query runs a query, query.compile compiles one to SQL, and query.validate checks one.
|
Package query is the query commands: query runs a query, query.compile compiles one to SQL, and query.validate checks one. |
|
command/show
Package show is the show command: an object of the repo, read from its compiled AML, by the identity the semantic catalog gives it.
|
Package show is the show command: an object of the repo, read from its compiled AML, by the identity the semantic catalog gives it. |
|
command/status
Package status is the commands that report on anfra itself: version, and status of the warm server and its sidecars.
|
Package status is the commands that report on anfra itself: version, and status of the warm server and its sidecars. |
|
command/validate
Package validate is the validate command: the repo's AML, checked.
|
Package validate is the validate command: the repo's AML, checked. |
|
dataperm
Package dataperm carries the data-level permissions one invocation runs under: whether its queries are governed, and the caller attributes that row and column rules are written against.
|
Package dataperm carries the data-level permissions one invocation runs under: whether its queries are governed, and the caller attributes that row and column rules are written against. |
|
datasource
Package datasource reads a repo's data_sources.yml.
|
Package datasource reads a repo's data_sources.yml. |
|
envflag
Package envflag reads anfra's on/off environment variables.
|
Package envflag reads anfra's on/off environment variables. |
|
errcode
Package errcode is the engine's namespace, and the error codes no one domain owns: what Dispatch can fail with whatever a command does.
|
Package errcode is the engine's namespace, and the error codes no one domain owns: what Dispatch can fail with whatever a command does. |
|
exports
Package exports is anfra's own command.ExportStore: an export's file in the system's temp directory, reached by a link that expires.
|
Package exports is anfra's own command.ExportStore: an export's file in the system's temp directory, reached by a link that expires. |
|
home
Package home is anfra's own folder on this machine: everything anfra keeps between runs, in one place to find, mount or delete.
|
Package home is anfra's own folder on this machine: everything anfra keeps between runs, in one place to find, mount or delete. |
|
ingest
Package ingest is the catalog ingestion use-case layer: it builds the request anfra-node needs to ingest context sources into the local search catalog.
|
Package ingest is the catalog ingestion use-case layer: it builds the request anfra-node needs to ingest context sources into the local search catalog. |
|
logging
Package logging provides the host's structured, aggregated logger.
|
Package logging provides the host's structured, aggregated logger. |
|
meta
Package meta holds build-time metadata for the anfra binary.
|
Package meta holds build-time metadata for the anfra binary. |
|
motherduck
Package motherduck is anfra's use of a person's MotherDuck account, to copy a DuckDB file there for an org to query: MotherDuck's own CLI signs them in and uploads, and MotherDuck's REST API makes the org a token of its own (docs/designs/motherduck-copy.md).
|
Package motherduck is anfra's use of a person's MotherDuck account, to copy a DuckDB file there for an org to query: MotherDuck's own CLI signs them in and uploads, and MotherDuck's REST API makes the org a token of its own (docs/designs/motherduck-copy.md). |
|
publish
Package publish is `anfra publish`: a local repo's files published to its org, as PUBLISH.md (anfra-cloud) describes.
|
Package publish is `anfra publish`: a local repo's files published to its org, as PUBLISH.md (anfra-cloud) describes. |
|
query
Package query is the query use-case layer: it checks a (dataset, AQL) request, turns it into SQL and runs it, by loading the repo's data sources and driving the sidecars via their clients.
|
Package query is the query use-case layer: it checks a (dataset, AQL) request, turns it into SQL and runs it, by loading the repo's data sources and driving the sidecars via their clients. |
|
repo
Package repo is a command's AML repo: where its files are read from, and the identity anfra-node keys its compile cache by.
|
Package repo is a command's AML repo: where its files are read from, and the identity anfra-node keys its compile cache by. |
|
repoconfig
Package repoconfig is a repo's settings file, .anfra/config.yml: committed, written by hand, and by anfra only through SetString, which changes nothing but the value it sets.
|
Package repoconfig is a repo's settings file, .anfra/config.yml: committed, written by hand, and by anfra only through SetString, which changes nothing but the value it sets. |
|
search
Package search is the catalog search use-case layer: it builds the request anfra-node needs to search the local catalog.
|
Package search is the catalog search use-case layer: it builds the request anfra-node needs to search the local catalog. |
|
sidecar
Package sidecar is the framework anfra's sidecars are run with: the Config a host gives them, the lifecycle of one it spawns (Process), how its binary is found (Binary), and how a sidecar that does not answer is classified (Unreachable).
|
Package sidecar is the framework anfra's sidecars are run with: the Config a host gives them, the lifecycle of one it spawns (Process), how its binary is found (Binary), and how a sidecar that does not answer is classified (Unreachable). |
|
sidecar/anfranode
Package anfranode is the anfra-node sidecar, the AML/AQL engine: its supervisor, which spawns one or connects to an external one, and its JSON-RPC client.
|
Package anfranode is the anfra-node sidecar, the AML/AQL engine: its supervisor, which spawns one or connects to an external one, and its JSON-RPC client. |
|
sidecar/canalquery
Package canalquery is the canal-query sidecar, the SQL execution engine: its supervisor, which spawns one or connects to an external one, and its client.
|
Package canalquery is the canal-query sidecar, the SQL execution engine: its supervisor, which spawns one or connects to an external one, and its client. |
|
telemetry
Package telemetry installs OpenTelemetry for the anfra CLI and `anfra serve`: the global tracer provider and W3C propagation, which the spans anfra already makes (apptracing's per op, httpkit's per request) go to.
|
Package telemetry installs OpenTelemetry for the anfra CLI and `anfra serve`: the global tracer provider and W3C propagation, which the spans anfra already makes (apptracing's per op, httpkit's per request) go to. |
|
update
Package update implements anfra's self-update: discover the latest GitHub release, compare it to the compiled-in version, download the binary for this platform, and atomically replace the running executable.
|
Package update implements anfra's self-update: discover the latest GitHub release, compare it to the compiled-in version, download the binary for this platform, and atomically replace the running executable. |
|
scripts
|
|
|
cloud-url
command
cloud-url validates the optional cloud URL before embedding it in a CLI build.
|
cloud-url validates the optional cloud URL before embedding it in a CLI build. |
|
shared
|
|
|
apikit
Package apikit is the API framework the anfra hosts share: an operation is declared once, as a Def, and served by every host and transport the same way — its input validated against the schema of its type, its errors rendered from their codes, its OpenAPI derived from both.
|
Package apikit is the API framework the anfra hosts share: an operation is declared once, as a Def, and served by every host and transport the same way — its input validated against the schema of its type, its errors rendered from their codes, its OpenAPI derived from both. |
|
apikit/internal/decode
Package decode is how apikit reads an op's input and checks its output, against the schemas huma generates from the Go types.
|
Package decode is how apikit reads an op's input and checks its output, against the schemas huma generates from the Go types. |
|
apperr
Package apperr gives errors their meaning: a code a caller can handle, which side is responsible (scope), a default message for quick display, typed details for programmatic handling, and the steps the error passed through.
|
Package apperr gives errors their meaning: a code a caller can handle, which side is responsible (scope), a default message for quick display, typed details for programmatic handling, and the steps the error passed through. |
|
appstep
Package appstep defines the steps a request goes through: what a step is, and how it describes itself.
|
Package appstep defines the steps a request goes through: what a step is, and how it describes itself. |
|
apptracing
Package apptracing runs the steps appstep defines.
|
Package apptracing runs the steps appstep defines. |
|
httpkit
Package httpkit is what every HTTP server built on the anfra packages shares: the request id, the root span, the request log line, panic recovery, and the one renderer of an error, with the HTTP status of each code served.
|
Package httpkit is what every HTTP server built on the anfra packages shares: the request id, the root span, the request log line, panic recovery, and the one renderer of an error, with the HTTP status of each code served. |
|
jsonkit
Package jsonkit is how anfra reads and writes JSON: encoding/json/v2 with one set of options, used by every package, so a value is encoded the same way whichever door it leaves by.
|
Package jsonkit is how anfra reads and writes JSON: encoding/json/v2 with one set of options, used by every package, so a value is encoded the same way whichever door it leaves by. |
|
repoformat
Package repoformat is what an anfra repo is, as anything handling one outside the engine needs it: which files make up a repo (Publishable), which of them are Data Apps and what they are called (DataApp, AppLabel), and how a file's content is named (BlobID).
|
Package repoformat is what an anfra repo is, as anything handling one outside the engine needs it: which files make up a repo (Publishable), which of them are Data Apps and what they are called (DataApp, AppLabel), and how a file's content is named (BlobID). |
|
requestid
Package requestid identifies one request: the id an error body carries, and that leads to the request's log line and its trace.
|
Package requestid identifies one request: the id an error body carries, and that leads to the request's log line and its trace. |
|
routine
Package routine runs a server's background routines: the work it does beside its requests (docs/designs/background-routines.md).
|
Package routine runs a server's background routines: the work it does beside its requests (docs/designs/background-routines.md). |
Click to show internal directories.
Click to hide internal directories.




