query

POST /arrays/{namespace}/{array}/query/submit

Changed on

send a query to run against a specified array/URI registered to a group/project

Request

  • Base URL
    /v2 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    • HTTP basic
    • or API key in header X-TILEDB-REST-API-KEY

Request body

type'READ' | 'WRITE' required

Type of query

layout'row-major' | 'col-major' | 'global-order' | 'unordered' required

Layout of array

status'FAILED' | 'COMPLETED' | 'INPROGRESS' | 'INCOMPLETE' | 'UNINITIALIZED' required

Status of query

totalFixedLengthBufferBytesinteger required

Total number of bytes in fixed size attribute buffers.

totalVarLenBufferBytesinteger required

Total number of bytes in variable size attribute buffers.

totalValidityBufferBytesinteger

Total number of bytes in validity buffers

Response

query completed and results are returned in query object

string binary required

Changes