SQL clients
Materialize is wire-compatible with PostgreSQL, which means it integrates with many SQL clients that support PostgreSQL (see Tools and Integrations). In this guide, we’ll cover how to connect to your Materialize region using common SQL clients.
psql
psql
are supported by Materialize yet, including some backslash meta-commands (#9721).
Start by double-checking whether you already have psql
installed:
psql --version
Assuming you’ve installed Homebrew:
brew install libpq
Then symlink the psql
binary to your /usr/local/bin
directory:
brew link --force libpq
Start by double-checking whether you already have psql
installed:
psql --version
sudo apt-get update
sudo apt-get install postgresql-client
The postgresql-client
package includes only the client binaries, not the PostgreSQL server.
For other Linux distributions, check out the PostgreSQL documentation.
Start by double-checking whether you already have psql
installed:
psql --version
Download and install the PostgreSQL installer certified by EDB.
DBeaver
Minimum requirements: DBeaver 23.1.3
To connect to Materialize using DBeaver, follow the documentation to create a connection and use the Materialize database driver with the credentials provided in the Materialize console.
The Materialize database driver depends on the PostgreSQL JDBC driver. If you don’t have the driver installed locally, DBeaver will prompt you to automatically download and install the most recent version.
Connect to a specific cluster
By default, Materialize connects to the pre-installed default
cluster.
To connect to a specific cluster, you must
define a bootstrap query in the connection initialization settings.
-
Click on Connection details.
-
Click on Connection initialization settings.
-
Under Bootstrap queries, click Configure and add a new SQL query that sets the active cluster for the connection:
SET cluster = other_cluster;
DataGrip
To connect to Materialize using DataGrip, follow the documentation to create a connection and use the PostgreSQL database driver with the credentials provided in the Materialize UI.
pg_catalog
in Materialize (#9720), you must turn off automatic database introspection in DataGrip to connect.
