CTRL + K
Integrations
PostgreSQL

Postgres

Web App

Postgres Integration

Fields

FieldValueExample
NameName for connectionPostgres
NamespaceNamespace for the connection, see namespacesdefault
hostDatabase hostsample-database.cudyk77thtpt.us-west-2.rds.amazonaws.com
portDatabase port5432
Database NameDatabase Namejaffle_shop
userDatabase user
passwordDatabase password
ℹī¸

Your database will need to be accessible from wherever you are running the Grai server. If you are using Grai Cloud your database will need to be accessible from the internet.

Python Library

Installation

Install Postgres Grai package with pip

pip install grai-source-postgres

This installs the Grai postgres integration, which is now ready to run in python.

Connecting & Syncing

The integration comes equipped with the client library already but we will need a python terminal or Jupyter Notebook to execute a few commands to establish a connection and begin querying the server.

Spin up your favorite python terminal then:

import os
from grai_source_postgres.base import update_server

For now we will use the default user credentials though you are free to create a new user / api keys from the server admin interface at http://localhost:8000/admin (opens in a new tab).

client = ClientV1("localhost", "8000", username="null@grai.io", password="super_secret")

Now we can update the server with data from any postgres source. In order to do so you will need to pass credentials and namespace into the update_server function. Namespace is used to uniquely identify the nodes and when used consistently will allow you to add to the node from any source.

Using example variables, in order to update the server with your metadata, simply run:

update_server(client, dbname=[your_dbname], user=[your_db_username], password=[your_db_password], namespace=[your_grai_namespace], host=[your_db_host], port=[your_db_port])