Data -- Cache

Create Cache

Creates a new cache for a specific table in a catalog. Caching copies data from an external data source into the internal Peaka BigTable store for faster query performance.

Not every table can be cached: check isCacheable and supportedCacheTypes in the List Tables response before creating a cache. supportedCacheTypes tells which of the modes below are available for the table (FULL_REFRESH, INCREMENTAL).

The cache can be configured in three modes:

  • One-time cache: No schedules provided. Data is cached once during creation and never automatically refreshed.
  • Scheduled incremental updates: Provide incrementalCacheSchedule to periodically sync only the changes (inserts, updates, deletes) since the last sync.
  • Scheduled full refresh + incremental: Provide both fullRefreshCacheSchedule and incrementalCacheSchedule. Full refresh drops and rebuilds the entire cached table periodically, while incremental updates run more frequently between full refreshes.

After creation, the initial sync is triggered automatically based on the provided schedules. If only an incremental schedule is given, an incremental sync starts immediately. If a full refresh schedule is given, a full refresh starts immediately.

The schedule expression uses ISO-8601 duration format (e.g. PT6H = every 6 hours, PT15M = every 15 minutes, P1D = every day).

post/data/projects/{projectId}/cache

Request

  • Base URL: https://partner.peaka.studio/api/v1
  • URL: https://partner.peaka.studio/api/v1/data/projects/{projectId}/cache
  • Auth: HTTP bearer

Path parameters

projectIdstring required

The unique identifier of the project that owns the data source

Request body

catalogIdstring

The ID of the catalog for the cache request.

schemaNamestring

The name of the schema for the cache request.

tableNamestring

The name of the table for the cache request.

Response

Cache created successfully. Returns the created cache configuration including its generated ID and schedules.

Changes

No recorded changes to this operation across all 1 revision of this API.