Xata · Schema

SQLRequest

SQL query request. Provide either `query` for a single query or `queries` for a batch.

DatabasePostgresServerlessDeveloper ToolsBranchingAI Agent

Properties

Name	Type	Description
query	string	SQL query to execute (single query mode).
params	array	Positional parameters for the query (`$1`, `$2`, ...).
queries	array	Array of queries for batch execution within a single transaction.
arrayMode	boolean	Override array mode for this query (single query mode only).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SQLRequest",
  "description": "SQL query request. Provide either `query` for a single query or `queries` for a batch.",
  "type": "object",
  "properties": {
    "query": {
      "description": "SQL query to execute (single query mode).",
      "type": "string"
    },
    "params": {
      "description": "Positional parameters for the query (`$1`, `$2`, ...).",
      "type": "array",
      "items": {}
    },
    "queries": {
      "description": "Array of queries for batch execution within a single transaction.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/QueryItem"
      }
    },
    "arrayMode": {
      "description": "Override array mode for this query (single query mode only).",
      "type": "boolean"
    }
  }
}