Peaka Client

Client for Peaka, a Zero-ETL data integration platform.

Requirements

• Node 12 or newer.

Install

npm install @peaka/client or yarn add @peaka/client

Usage

Create a Peaka connection

import { Peaka, connectToPeaka } from "@peaka/client";

const connection: Peaka = connectToPeaka("<YOUR_API_KEY>", options)

NOTE: options object and included items are optional.

Options Example

{
  "options": {
    "zone": "eu"
  }
}

Options

| option | default value | possible values | required | | -------- | -------: | -------: | --------:| | zone | "us" | "us" or "eu" | false |

Submit a query

import type { QueryResult } from "@peaka/client";

const iter: Iterator<QueryResult> = await connection.query(
  'select * from <CATALOG_NAME>.<SCHEMA_NAME>.<TABLE_NAME> limit 100'
);

Iterate through the query results

for await (const queryResult of iter) {
  console.log(queryResult.data);
}

Alternative: map and aggregate the data

import type { QueryData } from "@peaka/client";

const data: QueryData[] = await iter
  .map(r => r.data ?? [])
  .fold<QueryData[]>([], (row, acc) => [...acc, ...row]);