Skip to main content
Peaka logo
  • Category: databases
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 9
  • Triggers: 0
  • Slug: PEAKA
  • Version: 20261101_00

Tools

Slug: PEAKA_CREATE_PROJECTCreate a project in a Peaka workspace and return its project ID and available project details for use with Peaka data and query tools.

Input Parameters

string
required
Name for the new project.
string
Optional description of the project’s purpose.
string
required
ID of the workspace that will contain the project.
string
required
ID of the organization containing the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEAKA_CREATE_WORKSPACECreate a workspace in an organization and return its workspace ID and details.

Input Parameters

string
required
Name for the new workspace.
string
Optional description of the workspace’s purpose.
string
required
ID of the organization that will contain the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEAKA_DELETE_PROJECTPermanently delete a project and its project-scoped data from a Peaka workspace.

Input Parameters

string
required
Opaque ID of the project to permanently delete.
string
required
ID of the workspace containing the project.
string
required
ID of the organization containing the project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEAKA_DELETE_WORKSPACEPermanently delete a workspace. Projects and other contents within it may become unavailable.

Input Parameters

string
required
ID of the workspace to permanently delete.
string
required
ID of the organization containing the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEAKA_EXECUTE_QUERYExecute one SQL statement beginning with SELECT or WITH and ending in LIMIT 1-1000 in a Peaka project, returning rows in SIMPLE object format.

Input Parameters

string
required
One read-only SQL statement beginning with SELECT or WITH and ending with LIMIT 1-1000. Qualify Peaka resources as catalog.schema.table.
string
required
ID of the project against which to execute the query.
integer
Optional provider-side query timeout in seconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEAKA_LIST_DATA_RESOURCESBrowse a project’s catalogs, schemas, tables, or columns to discover qualified resources for SQL queries.

Input Parameters

string
Catalog ID; required for schemas, tables, and columns.
string
required
ID of the project whose data resources to browse.
string
Table name; required for columns.
string
Schema name; required for tables and columns.
string ("catalogs" | "schemas" | "tables" | "columns")
required
Resource level to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEAKA_LIST_HIERARCHYList organizations, workspaces in an organization, or projects in a workspace, returning the IDs needed for hierarchy administration.

Input Parameters

string ("organizations" | "workspaces" | "projects")
required
Hierarchy level to list.
string
Workspace ID; required when listing projects.
string
Organization ID; required when listing workspaces or projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEAKA_UPDATE_PROJECTReplace the name and optional description of a project in its current workspace.

Input Parameters

string
required
Complete replacement name for the project.
string
required
Opaque project ID returned by create or list operations.
string
Complete replacement description; omit to leave it absent.
string
required
ID of the workspace containing the project.
string
required
ID of the organization containing the project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEAKA_UPDATE_WORKSPACEReplace the name and optional description of an existing workspace.

Input Parameters

string
required
Complete replacement name for the workspace.
string
Complete replacement description; omit to leave it absent.
string
required
ID of the workspace to update.
string
required
ID of the organization containing the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not