Skip to content

Add documentation note about outputType json #254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fgalan merged 2 commits into from
Jul 30, 2026
Merged

Add documentation note about outputType json #254

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e2db1fa
Add documentation note about outputType json
GregorioBlazquez Jul 29, 2026
8f2302f
Apply suggestion from @fgalan
GregorioBlazquez Jul 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions doc/03_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1648,6 +1648,20 @@ None

### Data operations

> ⚠️ **Performance Note on `outputType=json`**
>
> The `json` output type (the default) requires the entire result set to be buffered in memory and serialized as a
> single JSON array before the response is sent. This can lead to:
>
> - **High latency and potential timeouts** for large datasets
> - **Blocking of other concurrent requests** while the JSON payload is being generated
>
> For large result sets, **strongly prefer** `ndjson` (streaming JSON lines) or `csv` (streaming CSV), which send data
> incrementally and avoid these issues. The default output type may change in a future release; explicitly specifying
> the desired format is recommended.
Comment thread
GregorioBlazquez marked this conversation as resolved.
>
> Moreover, `outputType=json` could be discontinued in the future, so you can have backward compatibility issues is you still use it.

#### FDA data query `GET /{visibility}/fdas/{fdaId}/data`

Runs the FDA base query directly against PostgreSQL. This endpoint is always fresh and does not use the parquet cache.
Expand Down
Loading