From 940a97a2e311a0943a909fc8a3f397888dc9d468 Mon Sep 17 00:00:00 2001 From: jemeza-codegen Date: Mon, 19 May 2025 16:09:51 -0700 Subject: [PATCH] chore: add postgres docs --- docs/docs.json | 3 ++- docs/integrations/postgres.mdx | 41 ++++++++++++++++++++++++++++++++++ 2 files changed, 43 insertions(+), 1 deletion(-) create mode 100644 docs/integrations/postgres.mdx diff --git a/docs/docs.json b/docs/docs.json index 8333377c8..2873dad1a 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -32,7 +32,8 @@ "integrations/linear", "integrations/github", "integrations/web-search", - "integrations/sandboxes" + "integrations/sandboxes", + "integrations/postgres" ] } ] diff --git a/docs/integrations/postgres.mdx b/docs/integrations/postgres.mdx new file mode 100644 index 000000000..f63bf49c2 --- /dev/null +++ b/docs/integrations/postgres.mdx @@ -0,0 +1,41 @@ +--- +title: "Postgres Integration" +sidebarTitle: "Postgres" +icon: "database" +--- + +Integrate Codegen with your Postgres (or Postgres-compatible databases) to enable database querying capabilities. + +## Installation + +Connect your database to Codegen by configuring your database credentials in the settings. + + + Set up your database connection credentials in the secure settings panel. + + + + For security reasons, it is strongly recommended to configure credentials with READ-ONLY access. + Providing write access to automated agents could potentially lead to unintended data modifications + or other negative consequences. + + +## Capabilities + +The Postgres integration provides secure database access enabling agents to: + +- **Query Data:** Execute SELECT queries to fetch information from your database +- **Analyze Schema:** View table structures, relationships, and column definitions +- **Generate Reports:** Create data summaries and analysis based on query results + +## How Agents Use Postgres + +Agents leverage the Postgres integration to assist with data-related tasks: + +- **Data Exploration:** Safely query your database to understand data structures and relationships +- **Report Generation:** Create data-driven reports and analytics +- **Schema Analysis:** Provide insights about database design and optimization \ No newline at end of file