Documentation

Clients

Client interfaces let tools and applications query the same live, governed data foundation that powers Altertable analytics and agentic workflows. Choose the interface that fits the workload: SQL compatibility for analytical tools, Arrow Flight SQL for high-throughput access, or REST for lightweight application integration.

All client interfaces require authentication with your Altertable credentials. Learn more about the SQL engine that powers these interfaces.

REST API quick start

Use the REST API clients when you want a lightweight HTTPS interface for queries, uploads, appends, and application workflows.

from altertable_lakehouse import Client
from altertable_lakehouse.models import QueryRequest
client = Client(
username="your_username",
password="your_password",
)
# Run a SQL query
req = QueryRequest(statement="""
SELECT
date_trunc('day', timestamp) AS day,
COUNT(DISTINCT user_id) AS dau
FROM events
WHERE event = 'Event Name'
AND timestamp >= NOW() - INTERVAL '30 days'
GROUP BY 1
ORDER BY 1 DESC
""")
# Accumulate all rows in memory
result = client.query_all(req)
for row in result.rows:
print(row)
# Append data to a table
client.append(
catalog="my_catalog",
schema="my_schema",
table="users",
data={"user_id": 1, "plan": "pro"}
)

SQL API quick start

Use the SQL API clients when you want Postgres wire protocol compatibility for existing tools or high-throughput Arrow Flight SQL for analytical workloads.

-- Altertable speaks the Postgres wire protocol natively.
-- No SDK needed — any Postgres client works out of the box.
-- psql
psql "postgresql://your_username:[email protected]:443/my_db"

Official Client Libraries

Client
Install
Repository
Lakehouse Python SDK
pip install altertable-lakehouse
Lakehouse Ruby SDK
gem install altertable-lakehouse (or add gem "altertable-lakehouse" to your Gemfile)
Lakehouse CLI
Copy bin/altertable from the repo to your PATH (see README)
Arrow Flight SQL Python
See repository README
DuckDB local extension
INSTALL altertable FROM community; LOAD altertable;

For protocol-specific details, see:

Crafted with <3 by former Algolia × Front × Sorare builders© 2026 AltertableTermsPrivacySecurityCookies