Documentation
HomeRequest DemoContact
Start typing to search…

PostgreSQL

Create a PostgreSQL Source

Prepare credentials and permission in PostgreSQL

Certain credentials and permission are required for Validio to validate your data. For detailed information about permissions in PostgreSQL, refer to Privileges.

❗️

Credential Permission Requirements

Validio Credentials require VIEWER access rights when connecting to sources to read and access data. Admins must ensure that they do not provide EDITOR access rights to their credentials.

You can use this SQL script to set up a user and grant the necessary permissions for the Source in Validio:

  1. Copy this script to a SQL worksheet.
  2. Follow the steps described in the script.
/*--------------------------------------- Parameters used in this script -------------------------------------------------
Search/replace all instances of these parameters in the script with names of your choice.

<validio_user>                                          -- Name of validio-user. It's not recommended to use an alread existing user.
<Some_Password123>                                      -- Password for vaidio-user.
<database_to_monitor>                                   -- Database to monitor.
<user_creating_tables> [, <user2_creating_tables>...]   -- One or more users who will create future tables validio-user should immediately get access to.
<schema_to_monitor> [, <schema2_to_monitor>...]         -- Optionally filter access to one or more schemas 

*/------------------------------------------------ Script -----------------------------------------------------

-- An admin-user, such as postgres, is necessary to perform this setup. 
SET SESSION AUTHORIZATION 'postgres';

-- Create Validio-user with necessary grants
CREATE USER <validio_user> PASSWORD '<Some_Password123>';

-- Grant monitor-role to user
GRANT pg_monitor TO <validio_user>; 

-- Grant Validio-user right to connect to the database to monitor
GRANT CONNECT ON DATABASE <database_to_monitor> TO <validio_user>;

-- Grant access to the data to validate. You can either write your own statements, or to simplify the process use the following query which generates grant statements for all
-- existing and future tables in your database, or filtered only to specific schemas if you like. Run the query and then copy&paste the result (the generated statements) into a worksheet. 
-- Review the generated statements before you run them, to ensure the grants will apply as you prefer.
SELECT p1 || schema_name || p2 || CASE WHEN o = 0 THEN ':    --------------' ELSE ' TO <validio_user>;' END AS statement
FROM (
    SELECT 0 AS o, '--------------    Privileges for schema ' AS p1, '' AS p2 UNION ALL
    SELECT 1, 'GRANT USAGE ON SCHEMA ', '' UNION ALL
    SELECT 2, 'GRANT SELECT ON ALL TABLES IN SCHEMA ', '' UNION ALL
    SELECT 3, 'ALTER DEFAULT PRIVILEGES FOR USER <user_creating_tables> [, <user2_creating_tables...>...] IN SCHEMA ', ' GRANT SELECT ON TABLES'
) AS s,
information_schema.schemata
--    WHERE schema_name IN ('<schema_to_monitor>' [, '<schema2_to_monitor>'...]) -- Uncomment and edit this line to limit the result to specific schemas
ORDER BY schema_name, o;

Add a PostgreSQL Credential

To add a credential for PostgreSQL,

  1. Navigate to Credentials and click + New Credential.
  2. Under Namespace, select a namespace where the resources will be created.
  3. For Credential Type, select PostgreSQL Credential.
  4. Fill in the credential parameter fields. Refer to the PostgreSQL Credential Parameters table.
  5. Check Use for catalog to automatically discover credentials and add them to the catalog page.
  6. Click Create.

Validio will validate the connection to the PostgreSQL account. If validation passes, Validio will automatically start fetching data. If validation fails, check that you provided the correct parameter values and try again.

Once the credential is created, you can add a source to monitor PostgreSQL data.

PostgreSQL Credential Parameters

FieldDescription
NameIdentifier for the credentials. Used when accessing Sources.
HostDNS hostname or IP address to the PostgreSQL database server.
PortPort number of the PostgreSQL database server.
UserUsername of PostgreSQL account with read access to the desired table.
PasswordPassword of the specified PostgreSQL user.
Default databaseName of the default PostgreSQL database where the table to read is included.

Add a PostgreSQL Source

To add a source for PostgreSQL,

  1. Navigate to Sources and click + New source.
  2. Under Source type, select PostgreSQL.
  3. Under Config,
    1. Select the valid Credential or create a new credential to authenticate your connection to the data warehouse.
    2. Enter the Database, Schema, and Table to specify where the data comes from. Selecting more than one table will create a new source for each table. Refer to the Configuration Parameters table.
    3. Set how many days of Historic data to use when you start the source.
    4. Set the Polling schedule, which is how frequently the validators on the source will check for changes.
  4. Under Schema, click Continue to automatically infer the schema fields from the tables you selected. If you select many tables, this operation can take a few minutes to complete.
  5. Under Source details,
    1. Add Tags to help group related sources or to use for routing notifications.
    2. Add an Owner who will be the contact for incident notifications.
  6. Click Continue to create the source.
    Source names are generated automatically and will be displayed when the source creation completes. If there are more than 5 sources, you will see the names for the first five and a count of the remaining sources.

Configuration Parameters

ParameterDescription
DatabaseName of the PostgreSQL database.
SchemaName of the schema that contains the table.
TableName of the table to read data from.

Remove Source permissions

You can use this SQL script to remove configured permissions for the Source in Validio:

  1. Copy this script to a SQL worksheet.
  2. Follow the steps described in the script.
/*--------------------------------------- Parameters used in this script -------------------------------------------------
Search/replace all instances of these parameters in the script with names of your choice.

<validio_user>       -- Name of validio-user you want to remove.
<validio_group>      -- Name of validio-group you want to remove (if you have set up a group for Validio)

*/------------------------------------------------ Script -----------------------------------------------------

-- An admin-user, such as postgres, is necessary to perform this setup. 
SET SESSION AUTHORIZATION 'postgres';

-- This script generates statements to remove Validio. Run the script, then copy&paste the statements into a worksheet and run them to remove all Validio-related entities (see inline-comments below for more details) from this Catalog. We recommend you to carefully look through the statements before you run then to make sure you really want to remove each entity.
SELECT 'REASSIGN OWNED BY <validio_user> TO CURRENT_ROLE;' AS statement UNION ALL  -- Reassign ownership from Validio-user to you.
SELECT 'DROP OWNED BY <validio_user>;' UNION ALL  -- Revoke all privileges from Validio-user
SELECT 'DROP USER <validio_user>;' UNION ALL  -- DROP Validio-user
SELECT 'DROP GROUP <validio_group>;'  -- DROP Validio-group (Remove this row if you haven't set up a Validio-group)
;

Updated 2 months ago