A PostgreSQL-compatible server for Apache DataFusion, supporting authentication, role-based access control, and SSL/TLS encryption. Available as both a library and CLI tool.
Built on pgwire to provide PostgreSQL wire protocol compatibility for analytical workloads. It was originally an example of the pgwire project.
- π Full PostgreSQL Wire Protocol - Compatible with all PostgreSQL clients and drivers
- π‘οΈ Security Features - Authentication, RBAC, and SSL/TLS encryption
- ποΈ Complete System Catalogs - Real
pg_catalog
tables with accurate metadata - π Advanced Data Types - Comprehensive Arrow β PostgreSQL type mapping
- π Transaction Support - ACID transaction lifecycle (BEGIN/COMMIT/ROLLBACK)
- β‘ High Performance - Apache DataFusion's columnar query execution
- β Library and CLI tool
- β PostgreSQL wire protocol compatibility
- β
Complete
pg_catalog
system tables - β Arrow β PostgreSQL data type mapping
- β PostgreSQL functions (version, current_schema, has_table_privilege, etc.)
- β User authentication and RBAC
- β Granular permissions (SELECT, INSERT, UPDATE, DELETE, CREATE, DROP)
- β Role inheritance and grant management
- β SSL/TLS encryption
- β Query-level permission checking
- β ACID transaction lifecycle
- β BEGIN/COMMIT/ROLLBACK with all variants
- β Failed transaction handling and recovery
- β³ Connection pooling optimizations
- β³ Advanced authentication (LDAP, certificates)
- β³ COPY protocol for bulk data loading
Supports standard pgwire authentication methods:
- Cleartext:
CleartextStartupHandler
for simple password authentication - MD5:
MD5StartupHandler
for MD5-hashed passwords - SCRAM:
SASLScramAuthStartupHandler
for secure authentication
See auth.rs
for complete implementation examples using DfAuthSource
.
The high-level entrypoint of datafusion-postgres
library is the serve
function which takes a datafusion SessionContext
and some server configuration
options.
use std::sync::Arc;
use datafusion::prelude::SessionContext;
use datafusion_postgres::{serve, ServerOptions};
// Create datafusion SessionContext
let session_context = Arc::new(SessionContext::new());
// Configure your `session_context`
// ...
// Start the Postgres compatible server with SSL/TLS
let server_options = ServerOptions::new()
.with_host("127.0.0.1".to_string())
.with_port(5432)
.with_tls_cert_path(Some("server.crt".to_string()))
.with_tls_key_path(Some("server.key".to_string()));
serve(session_context, &server_options).await
// The server automatically includes:
// - User authentication (default postgres superuser)
// - Role-based access control with predefined roles:
// - readonly: SELECT permissions
// - readwrite: SELECT, INSERT, UPDATE, DELETE permissions
// - dbadmin: Full administrative permissions
// - SSL/TLS encryption when certificates are provided
// - Query-level permission checking
Command-line tool to serve JSON/CSV/Arrow/Parquet/Avro files as PostgreSQL-compatible tables.
datafusion-postgres-cli 0.6.1
A PostgreSQL interface for DataFusion. Serve CSV/JSON/Arrow/Parquet files as tables.
USAGE:
datafusion-postgres-cli [OPTIONS]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
--arrow <arrow-tables>... Arrow files to register as table, using syntax `table_name:file_path`
--avro <avro-tables>... Avro files to register as table, using syntax `table_name:file_path`
--csv <csv-tables>... CSV files to register as table, using syntax `table_name:file_path`
-d, --dir <directory> Directory to serve, all supported files will be registered as tables
--host <host> Host address the server listens to [default: 127.0.0.1]
--json <json-tables>... JSON files to register as table, using syntax `table_name:file_path`
--parquet <parquet-tables>... Parquet files to register as table, using syntax `table_name:file_path`
-p <port> Port the server listens to [default: 5432]
--tls-cert <tls-cert> Path to TLS certificate file for SSL/TLS encryption
--tls-key <tls-key> Path to TLS private key file for SSL/TLS encryption
# Run with SSL/TLS encryption
datafusion-postgres-cli \
--csv data:sample.csv \
--tls-cert server.crt \
--tls-key server.key
# Run without encryption (development only)
datafusion-postgres-cli --csv data:sample.csv
Host a CSV dataset as a PostgreSQL-compatible table:
datafusion-postgres-cli --csv climate:delhiclimate.csv
Loaded delhiclimate.csv as table climate
TLS not configured. Running without encryption.
Listening on 127.0.0.1:5432 (unencrypted)
π Authentication: The default setup allows connections without authentication for development. For secure deployments, use
DfAuthSource
with standard pgwire authentication handlers (cleartext, MD5, or SCRAM). Seeauth.rs
for implementation examples.
psql -h 127.0.0.1 -p 5432 -U postgres
postgres=> SELECT COUNT(*) FROM climate;
count
-------
1462
(1 row)
postgres=> SELECT date, meantemp FROM climate WHERE meantemp > 35 LIMIT 5;
date | meantemp
------------+----------
2017-05-15 | 36.9
2017-05-16 | 37.9
2017-05-17 | 38.6
2017-05-18 | 37.4
2017-05-19 | 35.4
(5 rows)
postgres=> BEGIN;
BEGIN
postgres=> SELECT AVG(meantemp) FROM climate;
avg
------------------
25.4955206557617
(1 row)
postgres=> COMMIT;
COMMIT
# Generate SSL certificates
openssl req -x509 -newkey rsa:4096 -keyout server.key -out server.crt \
-days 365 -nodes -subj "/C=US/ST=CA/L=SF/O=MyOrg/CN=localhost"
# Start secure server
datafusion-postgres-cli \
--csv climate:delhiclimate.csv \
--tls-cert server.crt \
--tls-key server.key
Loaded delhiclimate.csv as table climate
TLS enabled using cert: server.crt and key: server.key
Listening on 127.0.0.1:5432 with TLS encryption
This library is released under Apache license.