Peaka Studio
Support
Peaka Studio

Create Batch Cache

Documentation

API Reference

SQL Reference

API Documentation

Introduction

Projects

GET
Read Project
PUT
Update Project
DEL
Delete Project
GET
List Projects
POST
Create Project

Projects -> Api Key

GET
List API Keys
POST
Create API Key
DEL
Delete API Key

Connections

GET
Get Connection
PUT
Update Connection
DEL
Delete Connection
GET
List Connections
POST
Create Connection
GET
Get Connection Detail
GET
List Connection Config
GET
Get Connection Config

Data -> Catalogs

GET
List Catalogs
POST
Create Catalog
GET
Read Catalog
DEL
Delete Catalog
GET
List Schemas
GET
List Tables
GET
List Columns

Data -> Internal Tables

POST
Create Table
DEL
Delete Table
GET
List Tables
POST
Add Column
PUT
Update Column
DEL
Delete Column
GET
List Columns
POST
Create BI Table
DEL
Delete BI Table
GET
List BI Tables
POST
Add BI Column
PUT
Update BI Column
DEL
Delete BI Column
GET
List BI Columns

Data -> Queries

GET
Read Query
PUT
Update Query
DEL
Delete Query
GET
List Queries
POST
Create Query
POST
Execute Query

Data -> Cache

POST
Create Cache
POST
Create Batch Cache
PUT
Update Cache Settings
DEL
Delete Cache
POST
Update Cache Incrementally
POST
Full Refresh Cache
GET
Get Cache Status
GET
Get All Cache Statuses of a Project
GET
Get All Cache Statuses of a Catalog

Embedded Peaka

GET
Init Session

Supported Drivers

GET
List Supported Drivers
GET
Get SQL Alchemy Driver
GET
Get JDBC Driver

Create Batch Cache

POST

data

projects

{projectId}

cache

batch

Authorization

string

Bearer

Authorization

Required

string

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

projectId

string

projectId

Required

string

array

Path Parameters

projectId

string

required

Body

application/json · object[]

catalogId

string

The ID of the catalog for the cache request.

schemaName

string

The name of the schema for the cache request.

tableName

string

The name of the table for the cache request.

incrementalCacheSchedule

object

This class represents a schedule for a cache request. It contains the type and expression of the schedule.

incrementalCacheSchedule.type

string

The type of the schedule. BASIC or NONE.

incrementalCacheSchedule.expression

string

The expression of the schedule. Valid if the type is other than NONE. For BASIC, the expression is a duration in ISO-8601 format. "PT15M" -- parses as "15 minutes" (where a minute is 60 seconds) "PT10H" -- parses as "10 hours" (where an hour is 3600 seconds) "P2D" -- parses as "2 days" (where a day is 24 hours or 86400 seconds)

fullRefreshCacheSchedule

object

This class represents a schedule for a cache request. It contains the type and expression of the schedule.

fullRefreshCacheSchedule.type

string

The type of the schedule. BASIC or NONE.

fullRefreshCacheSchedule.expression

string

Response

200 - */*

success

boolean

error

string

cache

object

cache.id

string

The ID of the cache.

cache.appId

string

The ID of the application for the cache request.

cache.catalogId

string

The ID of the catalog for the cache request.

cache.schemaName

string

The name of the schema for the cache request.

cache.tableName

string

The name of the table for the cache request.

cache.incrementalCacheSchedule

object

This class represents a schedule for a cache request. It contains the type and expression of the schedule.

cache.incrementalCacheSchedule.type

string

The type of the schedule. BASIC or NONE.

cache.incrementalCacheSchedule.expression

string

cache.fullRefreshCacheSchedule

object

This class represents a schedule for a cache request. It contains the type and expression of the schedule.

cache.fullRefreshCacheSchedule.type

string

The type of the schedule. BASIC or NONE.

cache.fullRefreshCacheSchedule.expression

string

twitter github linkedin