Skip to main content

Export and storage

Storage backends

storage:
storage_type: zip # zip | filesystem | sqlite
storage_path: storage
compression: true
TypeWhen to use
zipDefault. Compact single-file archive
filesystemInspect individual JSON files on disk
sqliteQueryable local database (storage_path is the .sqlite file)

SQLite example: examples/features/sqlite-storage/.

Export formats

apibackuper export data.jsonl
apibackuper export data.jsonl.gz
apibackuper export data.jsonl.zst
apibackuper export data.parquet
apibackuper export --format jsonl output.jsonl
ExtensionFormat
.jsonl / .jsonJSON Lines
.gz / .gzipgzip-compressed JSON Lines
.zstZstandard
.parquetParquet (needs pandas and pyarrow)

Field filters

apibackuper export out.jsonl --fields id,title,updated_at
apibackuper export out.jsonl --where "updated_at >= 2024-01-01"

Feature example: examples/features/export-filters/.