Skip to main content

Setting Up the Postgres SQL Tools

This guide will walk you through the steps to configure and authenticate the Postgres SQL tools and use them in agents. The instructions below should be followed to add both the

  1. Postgres SQL Query Tool
  2. Postgres Metadata Retrieval Tool

Both tools are required to properly query your Postgres Database. Currently supported versions of Postgres are:

  • Postgresql 9.3 and higher.

Adding and Configuring the Postgres SQL Query Tool​

  1. Add the Postgres SQL Query Tool Navigate to the library and select the "Postgres SQL Query" tool to add it to your project.

Add Postgres SQL Query tool

  1. Provide your Postgres credentials To add the Postgres tool to your project, you will need the following details:

    • Hostname/Endpoint
    • Port (default 5432)
    • Database name
    • Basic Credentials
      • User name
      • Password

    These details can be retrieved from your Postgres server.

  2. Retrieve your Postgres connection details from your server In order to connect your Postgres server, you will require your connection details. For example, if your Postgres server is hosted on Azure, it can be retrieved from the connection page.

Retrieve Postgres connection details

  1. Provide Postgres connection details to Tool To configure the tool, provide the values required. Your username and password should be set as a Basic authentication credential. Add Postgres connection details

Adding and Configuring the Postgres Metadata retrieval tool​

  1. Follow the instructions above to configure the Postgres Metadata retrieval tool, providing the same values to it as well. Add Postgres metadata tool

Now that the tool has been added, you can add it to an agent and use it to query your Postgres Database. See these instructions on the page: Use Postgres tools

[!NOTE] Your Postgres server must be accessible by Public IP. If you're having trouble connecting to your Postgres server, you can reach out to us at [email protected] and we can provide you any IPs you may need to whitelist on your firewall to allow the tools to connect.