Exporter
This package is part of a collection of tools to work more effectively with data using GraphCMS.
Usage
The exportData
function supports both CommonJS and ESM modules, and takes two objects as arguments:
P.s. environment variables should never be committed.
property | type | where? |
---|---|---|
projectId | string | GraphCMS Settings > General > Project |
permanentAccessToken | string | GraphCMS Settings > General > API Access |
contentApi | string | GraphCMS Settings > General > API Access |
property | sub-property | type | default | |
---|---|---|---|---|
concurrency | number | 1 | Controls how many requests to run in each batch | |
target | object | |||
⎿ | contentStage | string | 'DRAFT' | Controls which content stage to import content from |
⎿ | locales | string[] | Controls which locales to export from | |
include | object | |||
⎿ | includeSystemModels | boolean | true |
Controls filtering system models |
⎿ | includeSystemFields | boolean | true |
Controls filtering system fields |
⎿ | includeHiddenFields | boolean | true |
Controls filtering hidden fields |
⎿ | includeApiOnlyFields | boolean | true |
Controls filtering fields marked as api-only |
exclude | object | |||
⎿ | model | Controls excluding content models by name | ||
⎿ | field | Controls excluding fields by name | ||
⎿ | type | Controls excluding fields by type | ||
⎿ | subType | Controls excluding fields by sub-type |
See also
Importer
Upsert JSON data in bulk, with controls to filter the input
Publisher
Publish JSON data in bulk, with controls to filter the input