Execute cross-table SQL query
POST /queries
Execute a SQL query across one or more dataset tables.
Request Body:
tables: Map of table names (as referenced in SQL) to table IDssql: SQL query to executemaxRows: Maximum rows to return (default: 1000, max: 10000)includeStats: Whether to include execution statistics
Response Formats (Accept header):
application/json(default): JSON response with rows, columns, and metadataapplication/vnd.apache.arrow.stream: Raw Arrow IPC binary data with metadata in headers:X-Query-Id: Unique query identifierX-Row-Count: Number of rows returnedX-Truncated: Whether results were truncatedX-Table-Versions: JSON map of table ID to dataset version queried
Phase 1 Constraint: All tables must belong to the same team.
Authorizations
Section titled “Authorizations ”Request Body
Section titled “Request Body ”object
object
Dataset table ID (backwards compatible format)
object
Dataset table ID
Optional row-level filters for this table
object
Column name to filter on
Comparison operator
Include Lance _rowid system column in table schema (default: false)
object
SQL query defining this view (references tables declared in ‘tables’)
Physical table bindings referenced by the query
object
Dataset table ID (backwards compatible format)
object
Dataset table ID
Optional row-level filters for this table
object
Column name to filter on
Comparison operator
Include Lance _rowid system column in table schema (default: false)
Optional row-level filters applied to the query result
object
Column name to filter on
Comparison operator
Responses
Section titled “ Responses ”Query executed successfully
object
object
Column name
Arrow data type of the column
object
object
Total query execution time in milliseconds
Time spent planning the query in milliseconds
Total bytes read from storage
Total rows scanned during query execution
object
GET operations (full object fetch) - cache miss
GET operations (full object fetch) - cache hit
Range read operations - cache miss
Range read operations - cache hit
Multi-range read operations - cache miss
Multi-range read operations - cache hit
HEAD (metadata) operations - cache miss
HEAD (metadata) operations - cache hit
LIST operations (directory listing) - cache miss
LIST operations (directory listing) - cache hit
PUT operations (writes are never cached)
DELETE operations
Overall cache hit rate as a percentage (0-100)
Total bytes read from upstream storage (cache miss)
Total bytes read from L2 cache (cache hit)
Total bytes written (PUT operations)
object
Bad Request - Validation error or invalid input
object
Unauthorized - Authentication required or invalid token
object
Forbidden - Insufficient permissions
object
Not Found - Resource does not exist