Directories
¶
| Path | Synopsis |
|---|---|
|
Package admin serves the admin API under /admin: sign-in with local accounts, cookie sessions with CSRF tokens, the GraphQL endpoint, and the configuration MCP endpoint at /admin/mcp for administrators' tokens.
|
Package admin serves the admin API under /admin: sign-in with local accounts, cookie sessions with CSRF tokens, the GraphQL endpoint, and the configuration MCP endpoint at /admin/mcp for administrators' tokens. |
|
accounts
Package accounts holds the business rules for administrator accounts.
|
Package accounts holds the business rules for administrator accounts. |
|
auth
Package auth holds what the admin HTTP layer and the GraphQL resolvers share: argon2id password hashing, admin permissions and the signed-in principal on a request context.
|
Package auth holds what the admin HTTP layer and the GraphQL resolvers share: argon2id password hashing, admin permissions and the signed-in principal on a request context. |
|
configapp
Package configapp is the configuration service of the admin plane: the scanned catalog, schema scans and scan batches, plans and their previews, plan templates, pending work and administrators' MCP tokens.
|
Package configapp is the configuration service of the admin plane: the scanned catalog, schema scans and scan batches, plans and their previews, plan templates, pending work and administrators' MCP tokens. |
|
configmcp
Package configmcp serves the configuration MCP endpoint at /admin/mcp: an agent, signed in with one of an administrator's tokens, acts for the administrator: it searches the scanned catalog, scans schemas, previews plans against the administrator's workspace and writes them into it (the one copy the administrator edits in the console, so they see the changes as if made there), and diffs and simulates configurations.
|
Package configmcp serves the configuration MCP endpoint at /admin/mcp: an agent, signed in with one of an administrator's tokens, acts for the administrator: it searches the scanned catalog, scans schemas, previews plans against the administrator's workspace and writes them into it (the one copy the administrator edits in the console, so they see the changes as if made there), and diffs and simulates configurations. |
|
graph
Package graph implements the admin GraphQL API.
|
Package graph implements the admin GraphQL API. |
|
scanjobs
Package scanjobs runs long administrative work, such as schema scans, on the Scan lane of the execution bus, off the request path: a request starts a job and polls it, so a slow database ties up neither the request nor the service.
|
Package scanjobs runs long administrative work, such as schema scans, on the Scan lane of the execution bus, off the request path: a request starts a job and polls it, so a slow database ties up neither the request nor the service. |
|
ui
Package ui embeds the built admin console (web/admin).
|
Package ui embeds the built admin console (web/admin). |
|
Package bootstrap loads configuration and assembles the application: it resolves secret placeholders, opens the database provider, converts config entities to the core entity model, and wires the registry, authorizer, cost gate, engine, and tools.
|
Package bootstrap loads configuration and assembles the application: it resolves secret placeholders, opens the database provider, converts config entities to the core entity model, and wires the registry, authorizer, cost gate, engine, and tools. |
|
Package catalog keeps what schema scans found, per database a datasource reads, so the console can search and plan over every scanned schema after a restart and on every replica.
|
Package catalog keeps what schema scans found, per database a datasource reads, so the console can search and plan over every scanned schema after a restart and on every replica. |
|
catalogtest
Package catalogtest provides the conformance suite every catalog.Store implementation must pass, so SQL stores keep the MemoryStore semantics.
|
Package catalogtest provides the conformance suite every catalog.Store implementation must pass, so SQL stores keep the MemoryStore semantics. |
|
Package configedit applies edits to a stored configuration: it replaces whole sections of a base configuration with typed values and runs the result through the same chain as `store import` (defaults, validation, the store secret rule and the deterministic encoding).
|
Package configedit applies edits to a stored configuration: it replaces whole sections of a base configuration with typed values and runs the result through the same chain as `store import` (defaults, validation, the store secret rule and the deterministic encoding). |
|
Package configplan turns a plan, a scope of scanned tables and rules to apply to them, into a proposal: the configuration changes and a report of what they cover, what changes, the exceptions to look at, and when the changes take effect.
|
Package configplan turns a plan, a scope of scanned tables and rules to apply to them, into a proposal: the configuration changes and a report of what they cover, what changes, the exceptions to look at, and when the changes take effect. |
|
Package configrefs holds the rules for references among a configuration's entities as entities change: what an existing reference names afterwards and how it is written.
|
Package configrefs holds the rules for references among a configuration's entities as entities change: what an existing reference names afterwards and how it is written. |
|
Package configstore persists configuration revisions in SQLite or in a PostgreSQL, MySQL or OceanBase database.
|
Package configstore persists configuration revisions in SQLite or in a PostgreSQL, MySQL or OceanBase database. |
|
Package configyaml decodes YAML runtime configuration.
|
Package configyaml decodes YAML runtime configuration. |
|
Package leasing runs scan batches across processes.
|
Package leasing runs scan batches across processes. |
|
Package mcpserver bridges core DML tools to the MCP go-sdk.
|
Package mcpserver bridges core DML tools to the MCP go-sdk. |
|
Package otel adapts the core hook.Hooks callbacks to OpenTelemetry spans and attributes.
|
Package otel adapts the core hook.Hooks callbacks to OpenTelemetry spans and attributes. |
|
Package providerregistry maps database driver names to provider factories.
|
Package providerregistry maps database driver names to provider factories. |
|
providers
|
|
|
all
Package all registers every database provider built into the server binary.
|
Package all registers every database provider built into the server binary. |
|
mysql
Package mysql adapts a MySQL database to the core interfaces.
|
Package mysql adapts a MySQL database to the core interfaces. |
|
oceanbase
Package oceanbase adapts an OceanBase database (MySQL protocol) to the core interfaces.
|
Package oceanbase adapts an OceanBase database (MySQL protocol) to the core interfaces. |
|
postgres
Package postgres adapts a PostgreSQL database to the core interfaces: store.DB/Tx, dialect.Dialect, cost.Explainer, and introspect.Introspector.
|
Package postgres adapts a PostgreSQL database to the core interfaces: store.DB/Tx, dialect.Dialect, cost.Explainer, and introspect.Introspector. |
|
sqladapter
Package sqladapter adapts a database/sql pool to the core store interfaces.
|
Package sqladapter adapts a database/sql pool to the core store interfaces. |
|
Package revisionops holds the configuration store operations shared by the `store`/`migrate` CLI and the admin API: normalizing payloads, creating drafts, publishing, rolling back and diffing.
|
Package revisionops holds the configuration store operations shared by the `store`/`migrate` CLI and the admin API: normalizing payloads, creating drafts, publishing, rolling back and diffing. |
|
revisionopstest
Package revisionopstest stresses the revision operations on a store: many administrators editing and publishing at once, and the edge cases of the fast-forward rule.
|
Package revisionopstest stresses the revision operations on a store: many administrators editing and publishing at once, and the edge cases of the fast-forward rule. |
|
Package telemetry provides the metrics of tool calls: a call counter by tool and outcome, a duration histogram by tool, and the audit events dropped, as OpenTelemetry instruments on a meter provider of their own, served in the Prometheus exposition format at /metrics.
|
Package telemetry provides the metrics of tool calls: a call counter by tool and outcome, a duration histogram by tool, and the audit events dropped, as OpenTelemetry instruments on a meter provider of their own, served in the Prometheus exposition format at /metrics. |
|
Package workspaceops is the working-copy half of configuration versioning as a service: reading a workspace, writing items of it (several writers racing merge three ways), updating it onto a newer published revision, taking a draft in, resolving conflicts, saving a checkpoint (a draft to share) and committing (publishing it as a new revision), each write logged.
|
Package workspaceops is the working-copy half of configuration versioning as a service: reading a workspace, writing items of it (several writers racing merge three ways), updating it onto a newer published revision, taking a draft in, resolving conflicts, saving a checkpoint (a draft to share) and committing (publishing it as a new revision), each write logged. |
Click to show internal directories.
Click to hide internal directories.