Quick Start
To connect to Materialize, you’ll need:- Host: Your Materialize host name (e.g.,
instance.region.aws.materialize.cloud) - Port:
6875 - Database:
materialize(default) - Username: Your Materialize user email
- Password: App-specific password (prefixed with
mzp_) - SSL Mode:
require
Before connecting, make sure you’ve created an app password for your user in the Materialize console. This password is auto-generated and prefixed with
mzp_.Integration Categories
Client Libraries
Connect to Materialize using PostgreSQL drivers in your favorite programming language:- Python -
psycopg2orpsycopg3 - Node.js -
node-postgres(pg) - Java - PostgreSQL JDBC driver
- Go -
pgxdriver - Ruby -
pggem - Rust -
postgres-openssl - PHP -
pdo_pgsql
BI Tools
Create real-time dashboards and visualizations with popular BI tools:- Metabase - Native PostgreSQL connector
- Tableau - Tableau Cloud and Desktop support
- Looker - PostgreSQL 9.5+ dialect
- Power BI - DirectQuery mode
- Hex - Real-time notebooks
- Deepnote - Collaborative notebooks
- Excel - ODBC connection
dbt Integration
Use dbt (data build tool) to transform data in Materialize:- dbt-materialize adapter for dbt Core
- Support for materialized views, indexes, and sources
- Native integration with dbt’s testing and documentation features
Connection String Format
Most PostgreSQL clients accept connection strings in this format:Example Connection String
Runtime Connection Parameters
You can pass runtime connection parameters using theoptions parameter or PGOPTIONS environment variable:
cluster- Specify which cluster to usesearch_path- Set the schema search pathtransaction_isolation- Set isolation level
Additional Tools
Materialize CLI
The official Materialize command-line interface:SQL Clients
Connect using standard PostgreSQL clients:- psql - PostgreSQL command-line client
- DBeaver - Universal database tool with native Materialize driver
- DataGrip - JetBrains database IDE
- TablePlus - Modern database management tool
HTTP & WebSocket APIs
- HTTP API - Query via HTTP requests
- WebSocket API - Real-time streaming via WebSockets
Feature Compatibility
While Materialize is PostgreSQL wire-compatible, some client tools may run introspection queries that use features not yet implemented in Materialize. This includes certain system functions and
pg_catalog tables.pg_catalog and PostgreSQL compatibility, integration support continues to improve.
Need Help?
If you need assistance with a specific integration:- Check the detailed integration guide for your tool
- Review known limitations in the compatibility docs
- Submit a feature request for new integrations
Next Steps
Client Libraries
Connect using Python, Node.js, Java, and more
BI Tools
Build dashboards with Metabase, Tableau, and Looker
dbt Integration
Transform data with dbt-materialize
SQL Clients
Connect with psql, DBeaver, and other SQL clients