#api

Arrow plugin API operations.

Defines the typed API operations for the Arrow plugin. These operations are available via runtime.plugins.arrow.api when the plugin is installed.

#Available Operations

• list_connectors - List all available data connectors
• connector_list - Get details for a specific connector
• connector_list_many - Get details for multiple connectors
• list_catalogs - List available data catalogs
• list_registered - List registered connections
• register - Register a connector for use
• execute_query - Execute a SQL query

#Example

const { plugins } = useStatelyUi();

// List connectors
const { data } = await plugins.arrow.api.list_connectors();

// Execute a query
const result = await plugins.arrow.api.execute_query({
  body: { sql: 'SELECT * FROM users LIMIT 10' }
});

#Type Aliases

#ArrowApi

ArrowApi = TypedOperations<ArrowPaths, typeof ARROW_OPERATIONS>

Defined in: arrow/src/api.ts:72

Typed API client for Arrow operations.

Access via runtime.plugins.arrow.api.

#ArrowOperations

ArrowOperations = DefineOperations<operations>

Defined in: arrow/src/api.ts:42

OpenAPI operations type for the arrow plugin

#ArrowPaths

ArrowPaths = DefinePaths<paths>

Defined in: arrow/src/api.ts:39

OpenAPI paths type for the arrow plugin

#Variables

#ARROW_OPERATIONS

const ARROW_OPERATIONS: object

Defined in: arrow/src/api.ts:50

Arrow plugin operation bindings.

Maps friendly operation names to their HTTP method and path. Paths do NOT include any prefix - that's provided via plugin options.

#Type Declaration

#connector_list

readonly connector_list: object

Get details for a specific connector

#connector_list.method

readonly method: "get" = 'get'

#connector_list.path

readonly path: "/connectors/{connector_id}" = '/connectors/{connector_id}'

#connector_list_many

readonly connector_list_many: object

Get details for multiple connectors

#connector_list_many.method

readonly method: "post" = 'post'

#connector_list_many.path

readonly path: "/connectors" = '/connectors'

#execute_query

readonly execute_query: object

Execute a SQL query against connected data

#execute_query.method

readonly method: "post" = 'post'

#execute_query.path

readonly path: "/query" = '/query'

#list_catalogs

readonly list_catalogs: object

List available data catalogs

#list_catalogs.method

readonly method: "get" = 'get'

#list_catalogs.path

readonly path: "/catalogs" = '/catalogs'

#list_connectors

readonly list_connectors: object

List all available data connectors

#list_connectors.method

readonly method: "get" = 'get'

#list_connectors.path

readonly path: "/connectors" = '/connectors'

#list_registered

readonly list_registered: object

List registered connections

#list_registered.method

readonly method: "get" = 'get'

#list_registered.path

readonly path: "/register" = '/register'

#register

readonly register: object

Register a connector for use

#register.method

readonly method: "get" = 'get'

#register.path

readonly path: "/register/{connector_id}" = '/register/{connector_id}'