Query Builder Import & Exports

Getting started

import { Database } from '@sluice/adbc';
import SluiceDuckDBDialect, { KyselyDuckDB } from '@sluice/kysely-duckdb-adbc';

const adbc = new Database(':memory:');
const db = new KyselyDuckDB({ dialect: new SluiceDuckDBDialect({ database: adbc }) });

Import Tables

CSV

 await db.importCSV('season', './fixtures/season.csv', {
      createTable: false,
      autoDetect: false,
      header: true,
      delimiter: '|',
      columns: {
        season: 'BIGINT',
        id: 'BIGINT',
        name: 'TEXT',
        start: 'TIMESTAMP',
        end: 'TIMESTAMP',
        years_start: 'BIGINT',
        years_end: 'BIGINT',
        created_date: 'TIMESTAMP',
        last_updated: 'TIMESTAMP',
      },
  });

JSON

await db.importJSON('season', './fixtures/season.json', {
  createTable: true,
  autoDetect: true,
  format: 'newline_delimited',
});

Parquet

await db.importParquet('season', './fixtures/season.parquet', {
  createTable: true,
});

Export Tables

CSV

await db.exportCSV('season', './out/season.csv', {
  header: true,
  delimiter: '|',
});

JSON

await db.exportJSON('season', './out/season-out.ndjson', {
  timestampformat: '%c',
});

Parquet

await db.exportParquet('season', './out/season.parquet');

Export Database

DuckDB

// creates a copy as a single duckdb file
await db.exportDuckDB('./out/export.duckdb');

SQLite

// creates a single sqlite file with all tables
await db.exportSQLite('./out/export.sqlite');

PostgreSQL

// exports all or specified tables to a hosted PostgreSQL instance
await db.exportPostgreSQL('dbname=postgres user=postgres host=127.0.0.1');

MySQL

// imports all or specified tables from a MySQL instance
await db.exportMySQL('host=localhost user=root port=0 database=mysql');

CSV

// creates a folder with CSV files for each table, schema.sql and load.sql
await db.exportDatabaseAsCSV('./out-folder-csv', { delimiter: '|' });

JSON

// creates a folder with NDJSON files for each table, schema.sql and load.sql
await db.exportDatabaseAsJSON('./out-folder-json');

Parquet

// creates a folder with parquet files for each table, schema.sql and load.sql
await db.exportDatabaseAsParquet('./out-folder-parquet');

Import Database

DuckDB

// imports all or specified tables from a duckdb file
await db.importDuckDB('./out/import.duckdb', { tables: ['season'] });

SQLite

// imports all or specified tables from a duckdb file
await db.importSQLite('./out/import.sqlite', { tables: ['season'] });

PostgreSQL

// imports all or specified tables from a PostgreSQL instance
await db.importPostgreSQL('dbname=postgres user=postgres host=127.0.0.1');

MySQL

// imports all or specified tables from a MySQL instance
await db.importMySQL('host=localhost user=root port=0 database=mysql');

CSV

// NOT CURRENTLY WORKING IN DUCKDB C DRIVER 0.10.0
// imports from a folder with CSV files for each table, schema.sql and load.sql await
db.importDatabaseFromFolder('./path-to-folder');

JSON

// NOT CURRENTLY WORKING IN DUCKDB C DRIVER 0.10.0
// creates a folder with NDJSON files for each table, schema.sql and load.sql await
db.importDatabaseFromFolder('./path-to-folder');

Parquet

// NOT CURRENTLY WORKING IN DUCKDB C DRIVER 0.10.0
// creates a folder with parquet files for each table, schema.sql and load.sql await
db.importDatabaseFromFolder('./path-to-folder');