Query

import { createClient } from '@tinybirdco/sdk';

const client = createClient({
  baseUrl: 'https://api.tinybird.co',
  token: process.env.TINYBIRD_TOKEN,
});

const result = await client.query('top_events', {
  start_date: '2024-01-01',
  end_date: '2024-01-31',
});

import { tinybird } from '@tinybird/client';

// Fully typed with autocomplete for parameters and response
const result = await tinybird.topPages.query({
  start_date: '2024-01-01 00:00:00',
  end_date: '2024-01-31 23:59:59',
  limit: 5,
});

// result.data is typed: { pathname: string, views: bigint }[]

client.query<T = unknown>(
  pipeName: string,
  params?: Record<string, unknown>,
  options?: QueryOptions
): Promise<QueryResult<T>>

interface QueryResult<T> {
  data: T[];           // Query result data
  meta: ColumnMeta[];  // Column metadata
  rows: number;        // Number of rows returned
  statistics: QueryStatistics; // Query statistics
}

interface ColumnMeta {
  name: string;  // Column name
  type: string;  // Tinybird/ClickHouse type
}

interface QueryStatistics {
  elapsed: number;      // Time elapsed in seconds
  rows_read: number;    // Number of rows read
  bytes_read: number;   // Number of bytes read
}

const result = await client.query('top_pages', {
  start_date: '2024-01-01',
  end_date: '2024-01-31',
  limit: 10,
});

console.log(`Returned ${result.rows} rows`);
console.log(`Query took ${result.statistics.elapsed}s`);

for (const row of result.data) {
  console.log(row);
}

interface TopPage {
  pathname: string;
  views: number;
}

const result = await client.query<TopPage>('top_pages', {
  start_date: '2024-01-01',
  end_date: '2024-01-31',
});

// result.data is now typed as TopPage[]
const topPath = result.data[0].pathname;
const topViews = result.data[0].views;

const result = await client.query(
  'expensive_query',
  { year: 2024 },
  { timeout: 60000 } // 60 seconds
);

const controller = new AbortController();

// Cancel after 5 seconds
setTimeout(() => controller.abort(), 5000);

try {
  const result = await client.query(
    'long_running_query',
    { year: 2024 },
    { signal: controller.signal }
  );
} catch (error) {
  if (error.name === 'AbortError') {
    console.log('Query was cancelled');
  }
}

const result = await client.query('top_events', {
  start_date: '2024-01-01',
  end_date: '2024-01-31',
});

// Inspect column types
for (const column of result.meta) {
  console.log(`${column.name}: ${column.type}`);
}
// Output:
// event_name: String
// event_count: UInt64

const result = await client.query('system_status');

import { TinybirdError } from '@tinybirdco/sdk';

try {
  const result = await client.query('top_events', {
    start_date: '2024-01-01',
    end_date: '2024-01-31',
  });
} catch (error) {
  if (error instanceof TinybirdError) {
    console.error(`Tinybird API error: ${error.message}`);
    console.error(`Status code: ${error.statusCode}`);
    
    if (error.isAuthError()) {
      console.error('Authentication failed');
    } else if (error.isRateLimitError()) {
      console.error('Rate limit exceeded');
    } else if (error.isNotFoundError()) {
      console.error('Pipe not found');
    }
  } else {
    throw error;
  }
}