API Reference

Direct SQL

Coming soon: point psql, an ORM, or any BI tool at a read only PostgreSQL connection preloaded with your dataset. Not yet available. The REST API ships today.

Coming soon. Not yet available

A direct, read only SQL connection is planned but has not shipped yet. The examples below describe the design we are building toward, not a live connection. Use the REST API today. It is fully available now.

Connection String

Coming soon: a read only connection for BI tools and ORMs, preloaded with your dataset. Not yet available.

connectionpsql
# Illustration only — this host does not resolve yet.
postgres://readonly:•••@db.datlyne.com:5432/vendor_master_data_general_us

# connect with psql
psql "postgres://readonly:•••@db.datlyne.com:5432/vendor_master_data_general_us"

Run a Query

The database is a normal PostgreSQL instance with your dataset's tables, types, and indexes. Query it with the SQL you already know:

analytics.sqlsql
SELECT country_code, count(*) AS vendors, sum(spend_ytd) AS spend
FROM vendors
WHERE vendor_status = 'active'
GROUP BY country_code
ORDER BY spend DESC
LIMIT 10;

Works With Your Tools

Any client that speaks the PostgreSQL wire protocol connects without a plugin:

ToolDescription
psqlThe official PostgreSQL CLI
DBeaverCross platform database GUI
MetabaseDashboards and questions over the connection
Power BIDirect query or import via the PostgreSQL connector
Any ORMPrisma, SQLAlchemy, ActiveRecord, and more

Read Only by Design

The connection has read access only, so writes and schema changes are rejected. Long running queries time out at 30 seconds. To pull large extracts instead, use a cursor over the REST API.

Once available, a dataset update will not require a new connection string. The same one will always serve the latest data your subscription tracks.