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
incrementalCacheScheduleto periodically sync only the changes (inserts, updates, deletes) since the last sync. - Scheduled full refresh + incremental: Provide both
fullRefreshCacheScheduleandincrementalCacheSchedule. 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).
Authorizations
Use the Authorization header with the value 'Bearer ' to authenticate. Partner API Keys have full access; Project API Keys are limited to their project scope. Learn more: https://docs.peaka.com/api-reference/authentication
Path Parameters
The unique identifier of the project that owns the data source
Body
Cache creation request specifying the target table and optional sync schedules
This class represents a request to cache data. It contains the catalog ID, schema name, table name, and schedule of the cache request.
The ID of the catalog for the cache request.
The name of the schema for the cache request.
The name of the table for the cache request.
This class represents a schedule for a cache request. It contains the type and expression of the schedule.
This class represents a schedule for a cache request. It contains the type and expression of the schedule.
Response
Cache created successfully. Returns the created cache configuration including its generated ID and schedules.
The ID of the cache.
The ID of the catalog for the cache request.
The name of the schema for the cache request.
The name of the table for the cache request.
This class represents a schedule for a cache request. It contains the type and expression of the schedule.
This class represents a schedule for a cache request. It contains the type and expression of the schedule.
The ID of the project for the cache request.