DuckDB Export Database

Exporting Firecache for import into DuckDB.

The underlying DuckDB database behind Firecache can be exported and downloaded via the /firecache/export API, which can be useful for local analysis and debugging.

Warning: Running export on a high-load Firecache can significantly affect its performance during the export and should be used with caution.

POST to the API to download the archive as Parquet. E.g.

curl --request POST \
  --url https://data.spiceai.io/v1/firecache/export \
  --header 'X-API-Key: <Your API Key>'
  --output firecache.zip

Then unzip the archive and import into DuckDB.

// Run in DuckDB
IMPORT DATABASE 'firecache';

Options can be passed via the body E.g.

curl --request POST \
  --url https://data.spiceai.io/v1/firecache/export \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <Your API Key>'
  --data '{
	"format": "csv"
}'
  --output firecache_csv.zip

See the DuckDB import/export documentation for all format/compression options and more information on importing to DuckDB.

Firecache Export Database

POST https://data.spiceai.io/v1/firecache/export

Export the underlying DuckDB Database as CSV or Parquet for import into DuckDB.

Request Body

Name	Type	Description
format	String	The export format. Valid values are csv or parquet. Defaults to parquet.
compression	String	Compression option for Parquet exports. Valid values are uncompressed, snappy, gzip or zstd. Defaults to zstd.

200: OK An `application/zip` binary stream of the exported archive.