tank-postgres

tank-postgres is the Postgres driver for Tank: the Rust data layer.

It maps Tank operations and queries to native Postgres commands. Use it with the main tank crate, which provides entity definitions and the query API.

📘 Docs: https://tankhq.github.io/tank

🖥️ Repo: https://github.com/TankHQ/tank

📦 Crate: https://crates.io/crates/tank-postgres

Features

• Async connection and execution via tokio-postgres
• TLS via postgres-openssl
• Fast bulk inserts using the COPY binary protocol

Install

cargo add tank
cargo add tank-postgres

Quick Start

use tank::{ConnectionPool, Driver, PoolConfig};
use tank_postgres::PostgresDriver;

let driver = PostgresDriver::new();
let pool = driver
    .connect_pool(
        "postgres://user:password@127.0.0.1:5432/database?sslmode=require&sslrootcert=root.crt&sslcert=client.crt&sslkey=client.key".into(),
        PoolConfig::new(),
    )
    .await?;
let mut connection = pool.get().await?;

Run this inside an async function. The returned connection can execute Tank entity operations.

Certificate filenames are resolved relative to the working directory. Use paths appropriate for your deployment.

Running Tests

Tests need a Postgres instance. Provide a connection URL via TANK_POSTGRES_TEST. If absent, a containerized Postgres will be launched automatically using testcontainers-modules.

1. Ensure Docker is running on Linux:

systemctl status docker

2. Add your user to the docker group if needed on Linux:

sudo usermod -aG docker $USER

[!CAUTION] Avoid aborting tests mid-run (e.g. killing the process at a breakpoint). Containers might be left running and consume resources.

List containers:

docker ps

Stop container:

docker kill <container_id_or_name>