AXHubAXHub
⌘K

Gateway & resources

External data connectors, resources, catalog, and gateway query commands

axhub connectors

Manage external database connectors.

axhub connectors create

Register a connector.

FlagTypeDescriptionDefault
--config-filestring——
--config-jsonstring——
--credentials-filestring——
--credentials-stdinbooleanRead connector credentials JSON object from stdin instead of argv—
--descriptionstring——
--dry-runboolean—true
--enginestring——
--executeboolean——
--namestring——
--tenantstring——

axhub connectors credentials-set

Set or refresh connector credentials.

FlagTypeDescriptionDefault
--connector_idstring——
--credentials-filestring——
--credentials-stdinbooleanRead connector credentials JSON object from stdin instead of argv—
--dry-runboolean—true
--executeboolean——
--tenantstring——

axhub connectors delete

Delete a connector.

FlagTypeDescriptionDefault
--connector_idstring——
--dry-runboolean—true
--executeboolean——
--tenantstring——

axhub connectors discover

Discover queryable resources in a connector.

FlagTypeDescriptionDefault
--connector_idstring——
--tenantstring——

axhub connectors list

List connectors.

FlagTypeDescriptionDefault
--enabled-onlyboolean——
--tenantstring——

axhub connectors update

Update a connector.

FlagTypeDescriptionDefault
--config-filestring——
--config-jsonstring——
--connector_idstring——
--descriptionstring——
--disabledboolean——
--dry-runboolean—true
--enabledboolean——
--executeboolean——
--tenantstring——

axhub resources

Organize gateway resources (external tables/views).

axhub resources bulk-register

Bulk-register resources.

FlagTypeDescriptionDefault
--connector-idstring——
--dry-runboolean—true
--executeboolean——
--include-columnsboolean——
--items-filestring——
--items-jsonstring——
--tenantstring——

axhub resources delete

Delete a resource.

FlagTypeDescriptionDefault
--cascadebooleanAlso delete the entire descendant subtree (backend DB CASCADE: descendant resource rows + resource_tags). Without it, deleting a resource that still has children returns 409.—
--dry-runboolean—true
--executeboolean——
--resource_idstring——
--tenantstring——

axhub resources list

List resources.

FlagTypeDescriptionDefault
--parent-idstring——
--tenantstring——

axhub resources move

Move a resource between namespaces.

FlagTypeDescriptionDefault
--dry-runboolean—true
--executeboolean——
--parent-idstring——
--resource_idstring——
--rootboolean——
--tenantstring——

axhub resources namespace

Manage resource namespaces.

axhub resources namespace create

Create a namespace.

FlagTypeDescriptionDefault
--dry-runboolean—true
--executeboolean——
--namestring——
--parent-idstring——
--tenantstring——

axhub resources rename

Rename a resource.

FlagTypeDescriptionDefault
--dry-runboolean—true
--executeboolean——
--namestring——
--resource_idstring——
--tenantstring——

axhub resources tag-attach

Attach a tag to a resource.

FlagTypeDescriptionDefault
--dry-runboolean—true
--executeboolean——
--resource_idstring——
--tag-idstring——
--tenantstring——

axhub resources tag-detach

Detach a tag from a resource.

FlagTypeDescriptionDefault
--dry-runboolean—true
--executeboolean——
--resource_idstring——
--tag-idstring——
--tenantstring——

axhub catalog

Browse the queryable data catalog.

axhub catalog connectors

List catalog connectors.

FlagTypeDescriptionDefault
--tenantstring——

axhub catalog get

Get a catalog resource.

FlagTypeDescriptionDefault
--connectorstring——
--pathstring——
--tenantstring——

axhub catalog invoke

Run an allowed catalog read.

FlagTypeDescriptionDefault
--actionstring—read
--connectorstring——
--dry-runboolean—true
--executeboolean——
--params-filestring——
--params-jsonstring——
--pathstring——
--row-limitstring——
--sqlstring——
--sql-filestring——
--tenantstring——

axhub catalog kinds

List resource kinds.

(no options)

axhub catalog resources

List catalog resources.

FlagTypeDescriptionDefault
--allbooleanFollow next_cursor up to 10 pages / 2000 rows—
--connectorstring——
--connector-idstring——
--cursorstring——
--kindstring——
--limitinteger—50
--searchstring——
--tenantstring——

Search the catalog.

FlagTypeDescriptionDefault
--allbooleanFollow next_cursor up to 10 pages / 2000 rows—
--connectorstring——
--connector-idstring——
--cursorstring——
--kindstring——
--limitinteger—50
--searchstring——
--tenantstring——

axhub gateway

Safely query connected external data.

axhub gateway query

Run a read query through the gateway.

FlagTypeDescriptionDefault
--allow-non-selectbooleanAllow non-SELECT statements. Disabled by default for defense-in-depth—
--connector-idstring——
--dry-runboolean—true
--executeboolean——
--params-filestring——
--params-jsonstring——
--pathstring——
--row-limitstring——
--sqlstring——
--sql-filestring——
--tenantstring——