Peaka serves as a powerful data source for your data warehouse, enabling you to effortlessly create and manage projects, catalogs, and caching mechanisms. Additionally, it offers a comprehensive API that allows you to execute queries and retrieve data simultaneously, enhancing your data management capabilities.

​
Key Features

  • Project Management: Effortlessly create and manage projects, catalogs, and caching through the intuitive Peaka UI
  • Query Execution: Execute queries and retrieve data seamlessly using the powerful Peaka API
  • Advanced Caching: Implement advanced caching strategies for optimized performance
  • Complex Query Handling: Execute complex queries with ease
  • Seamless Integration: Achieve seamless integration with existing systems
  • Efficient Data Operations: Perform efficient data operations to enhance productivity

​
Step-by-Step Implementation

​
1. Create a Peaka Project

  • Before you start, you need to login to your Peaka account. If you don’t have an account, you can sign up for a free trial here.
  • After you login, click on the “Create New Project” button.
Peaka projects dashboard
  • Enter the project name and click on the “Create Project” button.
Peaka projects dashboard
  • Your project will be created and you will be redirected to the project page.
For detailed guidance, please refer to the documentation on how to create a project.

​
2. Create a Catalog

Once you are redirected to the project page, locate and click the plus button on the right side panel to initiate the catalog creation process. Open Connectors Modal
  • From the list of available options, select the catalog you wish to connect to.
Select Catalog
  • Fill in the catalog name along with any other required fields to ensure proper configuration.
  • After entering the necessary information, click on the “Create” or “Sign In” button to finalize the process.
  • Your catalog will be successfully created, and you can start managing your data within it.
For detailed guidance, please refer to the documentation on how to create a catalog.

​
3. Caching

Once you have created the catalog, you will find the catalog table displayed in the right side panel under the “Tables” section.
  • Hover over the catalog item and click on the three dots icon to reveal a dropdown menu. From this menu, select the “Start Cache” option.
Start Caching
  • A modal will appear prompting you to confirm the caching action. Click on the “Start Initial Cache” button within this modal.
Note: This action may either initiate a cache job for the catalog directly or open a new modal where you can input the required fields. If prompted, fill in the necessary information and then click on the “Start Cache” button to proceed.
  • This will initiate the caching process for your catalog.
Start Caching

​
4. Creating Partner API Key

  • Before starting execution of query, you need to create a Partner API key. You will use this API key to authenticate your requests to the Peaka API.
  • Navigate to the Developer section.
  • Click on the Partner API Key button to open a dialog box.
  • Fill in the form by entering your desired API Key Name.
  • Click on the Create button.
  • You can copy the API key from the dialog box.
For detailed guidance, please refer to the documentation on how to create a partner API key. created partner api key dialog

​
5. Create Your Query

  • Now you have created your project, API key, and catalog. Also cached your catalog.
  • You are now ready to create queries that allow you to extract and refine data from your catalog based on your requirements.
For detailed guidance, please refer to the documentation on how to create a query. 
curl --request POST \
    --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/queries \
    --header 'Content-Type: application/json' \
    --data '{
    "displayName": "sampleQuery",
    "inputQuery": "SELECT * from \"mycatalog\".payment.customers"
}'

{
    "id": "<string>",
    "displayName": "<string>",
    "name": "<string>",
    "inputQuery": "<string>",
    "inputQueryRefId": "<string>",
    "queryType": "<string>",
    "schedule": {
        "expression": "<string>"
    }
}

​
6. Run Your Query

  • After creating query, you can run your query.
  • After running query is completed, you will get the data in response. You can use this data for further processing or analysis as needed.
For detailed guidance, please refer to the documentation on how to run a query. 
curl --request POST \
--url https://partner.peaka.studio/api/v1/data/projects/{projectId}/queries/execute \
--header 'Content-Type: application/json' \
--data '{
"from": [
    {
    "catalogName": "peaka",
    "schemaName": "query",
    "tableName": "samplequery"
    }
]
}'

{
  "columns": [
    {
      "catalogId": "2",
      "catalogName": "peaka",
      "schemaName": "query",
      "tableName": "samplequery",
      "columnName": "amount"
    }
  ],
  "data": [
    [
      {
        "name": "amount",
        "displayName": "amount",
        "dataType": "bigint",
        "value": "75",
        "order": 0
      }
    ],
    [
      {
        "name": "amount",
        "displayName": "amount",
        "dataType": "bigint",
        "value": "75",
        "order": 0
      }
    ],
    [
      {
        "name": "amount",
        "displayName": "amount",
        "dataType": "bigint",
        "value": "75",
        "order": 0
      }
    ]
  ]
}

​
7. Success

  • You have successfully created your project, generated your API key, established your catalog, cached the catalog, and executed your query.
  • This data is now ready for advanced processing and insightful analysis.
  • You have effectively integrated Peaka as your robust data management backend.