Export one collection
export_collection
Reads every row of one collection in a single call, with the column names and types alongside.
Scopedata:readRead only
It reads up to 100,000 rows. list_rows returns 50 at a time and is for reading, while this is for taking a copy. Pass rowId to export a single row instead of the whole collection.
It needs the workspace to be on a paid plan, and is refused otherwise with a 403 and A paid plan is required to export! When the export stopped at the cap, truncated comes back true, and list_rows with offset reaches the rest. The whole database cannot be exported this way, since that is a downloadable archive in the product. See Export the whole database.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
projectId |
string | Yes | The site id. |
schema |
string | No | The schema the collection lives in, exactly as list_collections reports it. Leave it out to use the site database's own default, which is right unless list_collections showed something else. A site on the newer database always uses its default. |
entity |
string | Yes | The collection to export, exactly as list_collections reports it. |
rowId |
string | No | Exports just this one row, by its id, instead of the whole collection. |