Interface default

Structure of the API response data from the /api/sql/query endpoint.

See

API docs

Hierarchy

  • default

Properties

column_names context? data error_code? error_message? type

Properties

column_names

column_names: string[]

Ordered database column names for the response

Optional context

context?: object

MindsDB context for database where the query is executed.

data

data: any[][]

Actual data rows returned from the SQL query. Fields are in the same order as column names.

Optional error_code

error_code?: number

Error code if the SQL API request failed.

Optional error_message

error_message?: string

Error message if the SQL API request failed.

type

type: "ok" | "error" | "table"

Type of the response. 'table' is for successful queries that return data. 'ok' is for successful queries that don't return anything. 'error' is for any queries that fail to execute.

Settings

Member Visibility

Theme

Generated using TypeDoc