Skip to content

Commit 5e32ac0

Browse files
chore: add postgres docs (#1090)
1 parent 8987042 commit 5e32ac0

File tree

2 files changed

+43
-1
lines changed

2 files changed

+43
-1
lines changed

docs/docs.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@
3232
"integrations/linear",
3333
"integrations/github",
3434
"integrations/web-search",
35-
"integrations/sandboxes"
35+
"integrations/sandboxes",
36+
"integrations/postgres"
3637
]
3738
}
3839
]

docs/integrations/postgres.mdx

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: "Postgres Integration"
3+
sidebarTitle: "Postgres"
4+
icon: "database"
5+
---
6+
7+
Integrate Codegen with your Postgres (or Postgres-compatible databases) to enable database querying capabilities.
8+
9+
## Installation
10+
11+
Connect your database to Codegen by configuring your database credentials in the settings.
12+
13+
<Card
14+
title="Configure Database Access"
15+
icon="shield"
16+
href="https://codegen.com/settings/postgres"
17+
>
18+
Set up your database connection credentials in the secure settings panel.
19+
</Card>
20+
21+
<Note type="warning">
22+
For security reasons, it is strongly recommended to configure credentials with READ-ONLY access.
23+
Providing write access to automated agents could potentially lead to unintended data modifications
24+
or other negative consequences.
25+
</Note>
26+
27+
## Capabilities
28+
29+
The Postgres integration provides secure database access enabling agents to:
30+
31+
- **Query Data:** Execute SELECT queries to fetch information from your database
32+
- **Analyze Schema:** View table structures, relationships, and column definitions
33+
- **Generate Reports:** Create data summaries and analysis based on query results
34+
35+
## How Agents Use Postgres
36+
37+
Agents leverage the Postgres integration to assist with data-related tasks:
38+
39+
- **Data Exploration:** Safely query your database to understand data structures and relationships
40+
- **Report Generation:** Create data-driven reports and analytics
41+
- **Schema Analysis:** Provide insights about database design and optimization

0 commit comments

Comments
 (0)