$dump-sql

Dump results of the sql query

$dump-sql operation takes the sql query and responds with the Chunked Encoded stream in CSV format or in NDJSON format. Useful to export data for analytics.

POST [base]/$dump-sql

Headers

Parameter

Required?

Type

Description

content-type

true

String

Content-type of the query body

Query parameters

Parameter

Required?

Type

Description

_format

false

String

  • json/ndjson: return output as ndjosn

  • otherwise: return output as TSV

Body parameters

Parameter

Required?

Type

Description

query

true

String

Sql query to execute

Example

Get id and name of each patient

REST Console

POST /$dump-sql
Content-Type: text/yaml

query: select id, resource#>>'{name,0,given,0}' from patient

Curl

curl -u bulk-client:secret $AIDBOX_BASE_URL/\$dump-sql \
    -H 'Content-Type: text/yaml' -d@- <<EOF
query: select id, resource#>>'{name,0,given,0}' from patient
EOF

Last updated