Postgres

Create a connection between Faraday and Postgres so that your data is always up to date to make predictions, and your predictions can seamlessly sync back to your database.

In this tutorial, we'll show you how to:

  • Connect your Postgres account to Faraday using a connection.

Let's dive in.

  1. You'll need a Faraday account — signup is free!

Prerequisites

You'll need the following details to create your connection to Postgres:

  • Host requiredtext
  • Load balancer DNS name optionaltextIn case the host is deployed behind a load balancer.
  • Port requiredinteger
  • SSH bastion optionaltextIn case the host is deployed behind an SSH bastion / jump server. Uses the Faraday SSH public key. This is the address of the bastion including username. For example, faraday@mybastion.example.com
  • User requiredtext
  • Password requiredtext
  • Database requiredtext
  • Schema requiredtext

Granting access

First, you'll need Faraday access to your Postgres account.

Postgres connections are host-based and require a user and password. We suggest that you create a Faraday-only schema to both send and receive data. Within this schema, Faraday would have full read and write access. Alternatively, you can give Faraday access to certain tables in a shared schema.

Example commands:

  • CREATE USER faraday_user WITH PASSWORD '***'
  • CREATE SCHEMA faraday_schema
  • ALTER DEFAULT PRIVILEGES IN SCHEMA faraday_schema GRANT ALL ON TABLES TO faraday_user
  • GRANT USAGE, CREATE ON SCHEMA faraday_schema TO faraday_user

This connection type can be placed behind an SSH bastion (aka jump server). In that case, specify the user and host of the SSH bastion.

This connection type can also be placed behind a load balancer. In that case, specify the host of the load balancer. Faraday suggests that you use an unguessable string somewhere in the path to your data. This avoids what is called the Confused deputy problem

For example, let's say you were using S3. Instead of naming an S3 bucket s3://faraday-acme/, name it s3://faraday-acme-pwiiprz162ez. This guarantees that malicious actors cannot guess the name and request that Faraday import data from it into their account. The same logic applies to any path that is used to locate data.

Connecting

API via cURL
Dashboard

Use a POST /connections request:

curl https://api.faraday.ai/connections --json '{
  "name": "Postgres",
  "options": {
    "type": "postgres",
    "host": "...",
    "user": "...",
    "password": "...",
    "database": "...",
    "schema": "..."
  }
}'
  1. Wait briefly while Faraday establishes your connection. It shouldn't take long.

Your new connection is now ready to use.