Skip to content

README.md

Latest commit

 

History

History
65 lines (43 loc) · 2.2 KB

README.md

File metadata and controls

65 lines (43 loc) · 2.2 KB

Connecting Rust and GizmoSQL with ADBC

Instructions

This example uses GizmoSQL, a lightweight, high-performance SQL server powered by DuckDB or SQLite that supports Arrow Flight SQL.

Tip

If you already have a GizmoSQL instance running, skip the steps to set up GizmoSQL.

Prerequisites

  1. Install dbc

Set up GizmoSQL server (if you don't already have one)

  1. Install Docker Engine

  2. Start the GizmoSQL server:

    docker run -d --rm -it --init -p 31337:31337 --name gizmosql -e DATABASE_FILENAME=adbc_quickstart.db -e TLS_ENABLED=0 -e GIZMOSQL_PASSWORD=gizmosql_password -e PRINT_QUERIES=1 -e INIT_SQL_COMMANDS='CALL dbgen(sf=0.01);' --pull always gizmodata/gizmosql:latest-slim

Connect to GizmoSQL

  1. Install the Flight SQL ADBC driver:

    dbc install flightsql

  2. Customize src/main.rs as needed

    • Change the connection arguments in opts
      • OptionDatabase::Uri is the URI of your GizmoSQL instance. The host and port will depend on your installation (the default port is 31337). The protocol scheme should be grpc or grpc+tcp if your GizmoSQL instance is not using TLS and should be grpc+tls otherwise.
      • OptionDatabase::Username and OptionDatabase::Password are the username and password of your GizmoSQL admin user (the one specified when starting the instance).

  3. Run the Rust program:

    cargo run

Clean up

  1. Stop and remove the Docker container running GizmoSQL:

    docker stop gizmosql