Tables

Export table rows

Exports the matching table rows as a downloadable file stream. Takes the same JSON query body as the query endpoint (select, filter, sort, limit, offset, exclude_nulls); the format query parameter chooses the file type (ndjson, json, csv, xlsx or parquet).

Last updated on

POST
/namespaces/{namespace}/tables/{tableName}/export

Path Parameters

namespace*string
tableName*string

Query Parameters

format?string

Output file format: ndjson (default), json, csv, xlsx (Excel, capped at 1,000,000 rows) or parquet.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Query definition sent as the JSON request body. All fields are optional; an empty body {} returns the first page of all columns.

Response Body

curl -X POST "https://example.com/namespaces/string/tables/string/export?format=ndjson" \  -H "Content-Type: application/json" \  -d '{    "limit": 10,    "offset": 0,    "select": "lytis,mirties_metai,pavadinimas",    "filter": "lytis=Moteris",    "sort": "-mirties_metai",    "exclude_nulls": [      "m_konc"    ]  }'
Empty
{
  "error": "string",
  "error_code": "string"
}
{
  "message": "string",
  "error_code": "string"
}
{
  "detail": [
    {
      "loc": [
        null
      ],
      "msg": "string",
      "type": "string",
      "input": "string",
      "ctx": {
        "property1": null,
        "property2": null
      }
    }
  ]
}
{
  "error": "string",
  "error_code": "string"
}
{
  "error": "string",
  "error_code": "string"
}

See also

How is this guide?