Authentication
This provider requires authentication.
- username: Postgres username (required: True, sensitive: False)
- password: Postgres password (required: True, sensitive: True)
- host: Postgres hostname (required: True, sensitive: False)
- database: Postgres database name (required: False, sensitive: False)
- port: Postgres port (required: False, sensitive: False)
Certain scopes may be required to perform specific actions or queries via the provider. Below is a summary of relevant scopes and their use cases:
- connect_to_server: The user can connect to the server (mandatory)
In workflows
This provider can be used in workflows.
As “step” to query data, example:
steps:
- name: Query postgres
provider: postgres
config: "{{ provider.my_provider_name }}"
with:
query: {value}
As “action” to make changes or update data, example:
actions:
- name: Query postgres
provider: postgres
config: "{{ provider.my_provider_name }}"
with:
query: {value}
Check the following workflow example:
Provider Methods
The provider exposes the following Provider Methods. They are available in the AI Assistant.
- execute_query Query the Postgres database (view, scopes: no additional scopes)
Connecting with the Provider
In order to connect to the Postgres database, you will need to create a new user with the required permissions. Here’s how you can do this:
- Connect to the Postgresql server as a user with sufficient privileges to create a new user.
- Run the following command to create a new user:
CREATE USER '<username>' WITH ENCRYPTED PASSWORD '<password>'
;
- Run the following command to create a database:
CREATE DATABASE '<yourdbname>';
;
- Grant the necessary permissions to the new user by running the following command:
GRANT ALL PRIVILEGES ON <database>.* TO '<username>'
;
Notes
Useful Links
Responses are generated using AI and may contain mistakes.