SDK Overview

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

npm install @treasuredata/tdx

import { TDX } from '@treasuredata/tdx/sdk';

// Create TDX instance (loads API key from environment if not provided)
const tdx = TDX.create({
  site: 'us01',
  apiKey: 'your_key_id/your_key_secret'  // Optional: omit to load from env
});

// List databases
const databases = await tdx.query.listDatabases();

// Run a query
const result = await tdx.query.execute('SELECT * FROM mydb.users LIMIT 10');

<script type="module">
  import { TDX, LogLevel } from 'https://unpkg.com/@treasuredata/tdx';

  // Browser: pass API key directly
  const tdx = TDX.create({
    site: 'us01',
    apiKey: 'your_key_id/your_key_secret',
    logLevel: LogLevel.INFO
  });

  const result = await tdx.query.execute('SELECT * FROM mydb.users LIMIT 10');
</script>

import { TDX, LogLevel } from '@treasuredata/tdx/sdk';

// Load API key from environment variables
const tdx = TDX.create();

// Override specific options
const tdx = TDX.create({
  site: 'jp01',
  logLevel: LogLevel.DEBUG
});

// Pass API key directly
const tdx = TDX.create({
  apiKey: 'your_key_id/your_key_secret'
});

// Use an HTTP proxy (corporate networks)
const tdx = TDX.create({
  site: 'us01',
  proxy: 'http://proxy.corp.com:8080'
});

const databases = await tdx.query.listDatabases();
for (const db of databases) {
  console.log(db.database_name);
}

// Filter by pattern
const prodDbs = await tdx.query.listDatabases('prod_*');

// List all tables in a database
const tables = await tdx.query.listTables('mydb');

// Filter by pattern
const userTables = await tdx.query.listTables('mydb', 'user_*');

const result = await tdx.query.execute('SELECT * FROM mydb.users LIMIT 10');
for (const row of result.data) {
  console.log(row);
}

// Access column metadata
console.log('Columns:', result.columns.map(c => c.name));

const columns = await tdx.query.describeTable('mydb', 'users');
for (const col of columns) {
  console.log(col.column_name, col.data_type, col.is_nullable);
}

const result = await tdx.query.showTable('mydb', 'users', 10);
for (const row of result.data) {
  console.log(row);
}

const job = await tdx.jobs.submit('mydb', 'SELECT * FROM users', 'trino');
console.log('Job ID:', job.job_id);

// Get job results
const results = await tdx.jobs.result(job.job_id);

import { SDKError, ErrorCode } from '@treasuredata/tdx/sdk';

try {
  await tdx.query.execute('INVALID SQL');
} catch (error) {
  if (error instanceof SDKError) {
    console.error('Error code:', error.code);
    console.error('Message:', error.message);

    // Check for specific error types
    if (error.code === ErrorCode.TRINO_SYNTAX_ERROR) {
      console.error('SQL syntax error');
    }
  }
}

import type {
  SDKConfig,
  DatabaseInfo,
  TableInfo,
  ColumnInfo,
  CompleteQueryResult
} from '@treasuredata/tdx/sdk';

// Typed query results
const result: CompleteQueryResult<{ id: number; name: string }> =
  await tdx.query.execute<{ id: number; name: string }>('SELECT id, name FROM users');

// result.data is typed as { id: number; name: string }[]

// Config loading function: loadConfigOnce(options) → Config
// SDK/Client constructors: constructor(config: Config)
// CLI creates config once, passes to all components