Skip to content

Configuring the Postgres Tool

Introduction

The Postgres tool is a powerful feature that allows users to search and interact with PostgreSQL databases within Wabee AI. This guide will walk you through the process of configuring the Postgres tool, enabling you to connect to your database and leverage its capabilities.

Prerequisites

Before configuring the Postgres tool, ensure you have the following:

  1. Access to the Wabee tool management dashboard
  2. PostgreSQL database credentials (username, password)
  3. Database connection details (database name, host, port)

Step-by-Step Configuration Process

  1. Access the Tool Management Dashboard

  2. Log in to your account and navigate to the "Tools" section.\ \

    img
    2. Locate the PostgreSQL Tool * In the tool management dashboard, you'll see various tool cards. * Look for the “PostgreSQL” card or use the search to locate the tool.\

  3. Initiate Tool Configuration

    • Click the "Configure Tool" button on the PostgreSQL card to begin the setup process.

    img
    4. Fill in the Configuration Form * Complete the following fields in the configuration form: * Tool Name: By default, this is set to "PostgreSQL." You can keep this or customize it if needed. * Description: A brief description of the tool's purpose is pre-filled. You can modify this if desired. * User: Enter the username for your PostgreSQL database. * Password: Input the password associated with the database user.

     Note: The password field is masked for security. You can toggle visibility using the eye icon if needed.
    • Database: Enter the name of your PostgreSQL database (e.g., "verceldb").
    • Host: Specify the host address of your PostgreSQL server.
    • Port: Enter the port number for your PostgreSQL connection. The default is typically 5432.
    • Top K (Optional): Specify the maximum number of results to return in a search. The default value is 100.
    • Guide (Optional): You can add any additional notes or instructions in this field.\

  4. Review and Submit

  5. Double-check all the entered information for accuracy.

  6. Click the "Create" button at the bottom of the form to save your configuration.\ \

    img

Best Practices & Tips

  1. Security: Always use strong, unique passwords for your database connections.
  2. Host Configuration:
  3. Ensure your database has an internet-facing IP address that can be accessed by our SaaS platform.
  4. Use the domain name of your database server in the "Host" field.
  5. Do not use "localhost" as the host, as our SaaS product cannot connect to databases on your local network.
  6. Port Number: While 5432 is the default port for PostgreSQL, your setup might use a different port. Confirm the correct port with your database administrator if unsure.
  7. Top K Value: Adjust the "Top K" value based on your typical search needs. A higher value returns more results but may impact performance and result in increased cost.

Troubleshooting

If you encounter issues while configuring or using the Postgres tool:

  1. Connection Errors:
  2. Verify that all credentials (username, password) are correct.
  3. Ensure the host address and port number are accurate.
  4. Check if your database server is accessible from the SaaS product's network.
  5. Performance Issues:
  6. If searches are slow, try reducing the "Top K" value.
  7. Consult with your database administrator to optimize your PostgreSQL setup.
  8. Access Denied:
  9. Confirm that the user account has the necessary permissions to access the specified database.

Conclusion

By following these steps, you should now have successfully configured the Postgres tool in your SaaS product. This tool will allow you to efficiently search and interact with your PostgreSQL database, enhancing your data management capabilities.

For any additional assistance or advanced configurations, please consult our support team or refer to the PostgreSQL documentation.