https://github.com/promeduck/duckex
A DuckDB binding for Elixir via Rust port
https://github.com/promeduck/duckex
duckdb ducklake elixir rust
Last synced: about 2 months ago
JSON representation
A DuckDB binding for Elixir via Rust port
- Host: GitHub
- URL: https://github.com/promeduck/duckex
- Owner: promeduck
- Created: 2025-05-28T10:27:44.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-08-06T18:02:34.000Z (2 months ago)
- Last Synced: 2025-08-06T19:25:59.822Z (2 months ago)
- Topics: duckdb, ducklake, elixir, rust
- Language: Elixir
- Homepage:
- Size: 54.7 KB
- Stars: 3
- Watchers: 0
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Duckex
A naive DuckDB binding for Elixir via Rust port, primarily for testing DuckLake functionality.
## Installation
Add `duckex` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:duckex, github: "http://github.com/promeduck/duckex"}
]
end
```
## Usage
Start the process and execute queries:
```elixir
# Install extensions
Duckex.install_extensions([:ducklake, :postgres])
# Start Duckex with Ducklake connection
{:ok, conn} = Duckex.start_link(
attach: [
{"ducklake:postgres:dbname=ducklake_catalog",
as: :my_ducklake,
options: [
data_path: "tmp/data_files"
]
}
]
)
# Create table
Duckex.query!(conn, """
CREATE TABLE my_ducklake.my_demo_table (
id INTEGER,
name TEXT,
created_at TIMESTAMP
)
""")
# Insert data
Duckex.query!(conn, """
INSERT INTO my_ducklake.my_demo_table (id, name, created_at)
VALUES (2, 'Bob', CURRENT_TIMESTAMP), (3, 'Charlie', CURRENT_TIMESTAMP)
""", [])
# Query data
Duckex.query!(conn, "SELECT * FROM my_ducklake.my_demo_table LIMIT 100", [])
```
## Result Format
Returns `%Duckex.Result{}` struct:
```elixir
%Duckex.Result{
columns: [
["id", "Int32"],
["name", "Utf8"],
["created_at", "Timestamp(Microsecond, None)"]
],
rows: [
[2, "Bob", ~U[2025-08-06 17:38:38.512000Z]],
[3, "Charlie", ~U[2025-08-06 17:38:38.512000Z]]
],
num_rows: 2
}
```
## Error Format
Returns `%Duckex.Error{}` struct on SQL errors:
```elixir
Duckex.query(conn, "some unexisting sql", [])
{:error,
%Duckex.Error{
message: "SQL preparation error: Parser Error: syntax error at or near \"some\"\n\nLINE 1: some unexisting sql\n ^",
query: %{command: "prepare", query: "some unexisting sql"}
}}
```