Skip to content

Latest commit

 

History

History
107 lines (78 loc) · 3.66 KB

README.md

File metadata and controls

107 lines (78 loc) · 3.66 KB
Raw

DuckDB Data Connector Quickstart

Create a DuckDB instance using sample TPCH data and use it from Spice with the DuckDB data connector.

Requirements

Follow these steps

Step 1. Initialize a new Spice app.

spice init duckdb-qs
cd duckdb-qs

Step 2. Create a DuckDB database with TPCH sample data.

duckdb ./tpch.db

Using the DuckDB CLI execute the following commands to generate TPC-H data with DuckDB's TPCH extension.

INSTALL tpch;
LOAD tpch;
CALL dbgen(sf = 1);

Show the TPCH tables were correctly generated.

SHOW TABLES;

Quit the DuckDB CLI (ctrl-c, ctrl-c).

Step 3. Configure the dataset to use the DuckDB database file. Copy and paste the YAML below to spicepod.yaml in the Spice app.

version: v1beta1
kind: Spicepod
name: duckdb-qs
datasets:
  - from: duckdb:customer
    name: tpch_customer
    params:
      duckdb_open: ./tpch.db

Step 4. Start the Spice runtime.

spice run

Confirm in the terminal output the tpch_customer dataset has been loaded:

Spice.ai runtime starting...
2024-04-29T18:23:18.055782Z  INFO spiced: Metrics listening on 127.0.0.1:9090
2024-04-29T18:23:18.059972Z  INFO runtime: Loaded dataset: tpch_customer
2024-04-29T18:23:18.060005Z  INFO runtime::opentelemetry: Spice Runtime OpenTelemetry listening on 127.0.0.1:50052
2024-04-29T18:23:18.062230Z  INFO runtime::http: Spice Runtime HTTP listening on 127.0.0.1:8090
2024-04-29T18:23:18.062249Z  INFO runtime::flight: Spice Runtime Flight listening on 127.0.0.1:50051

Step 5. Run queries against the dataset using the Spice SQL REPL.

In a new terminal, start the Spice SQL REPL

spice sql

Query the tpch_customer dataset.

select c_name, c_address, c_acctbal, c_mktsegment from tpch_customer limit 10;
+--------------------+---------------------------------------+-----------+--------------+
| c_name             | c_address                             | c_acctbal | c_mktsegment |
+--------------------+---------------------------------------+-----------+--------------+
| Customer#000000001 | j5JsirBM9PsCy0O1m                     | 711.56    | BUILDING     |
| Customer#000000002 | 487LW1dovn6Q4dMVymKwwLE9OKf3QG        | 121.65    | AUTOMOBILE   |
| Customer#000000003 | fkRGN8nY4pkE                          | 7498.12   | AUTOMOBILE   |
| Customer#000000004 | 4u58h fqkyE                           | 2866.83   | MACHINERY    |
| Customer#000000005 | hwBtxkoBF qSW4KrIk5U 2B1AU7H          | 794.47    | HOUSEHOLD    |
| Customer#000000006 |  g1s,pzDenUEBW3O,2 pxu0f9n2g64rJrt5E  | 7638.57   | AUTOMOBILE   |
| Customer#000000007 | 8OkMVLQ1dK6Mbu6WG9 w4pLGQ n7MQ        | 9561.95   | AUTOMOBILE   |
| Customer#000000008 | j,pZ,Qp,qtFEo0r0c 92qobZtlhSuOqbE4JGV | 6819.74   | BUILDING     |
| Customer#000000009 | vgIql8H6zoyuLMFNdAMLyE7 H9            | 8324.07   | FURNITURE    |
| Customer#000000010 | Vf mQ6Ug9Ucf5OKGYq fsaX AtfsO7,rwY    | 2753.54   | HOUSEHOLD    |
+--------------------+---------------------------------------+-----------+--------------+

Time: 0.003510375 seconds. 10 rows.

Learn more