Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cloudquery/pg_gpt
Experimental extension that brings OpenAI API to your PostgreSQL to run queries in human language.
https://github.com/cloudquery/pg_gpt
chatgpt cloudquery postgresql rust sql
Last synced: about 2 months ago
JSON representation
Experimental extension that brings OpenAI API to your PostgreSQL to run queries in human language.
- Host: GitHub
- URL: https://github.com/cloudquery/pg_gpt
- Owner: cloudquery
- License: apache-2.0
- Created: 2023-03-26T11:12:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-06-04T10:19:08.000Z (over 1 year ago)
- Last Synced: 2024-06-15T09:35:38.181Z (3 months ago)
- Topics: chatgpt, cloudquery, postgresql, rust, sql
- Language: Rust
- Homepage:
- Size: 22.5 KB
- Stars: 456
- Watchers: 10
- Forks: 19
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ChatGPT-repositories - pg_gpt - Experimental extension that brings OpenAI API to your PostgreSQL to run queries in human language. (Browser-extensions)
README
# Postgres <> ChatGPT
Experimental PostgreSQL extension that enables the use of OpenAI GPT API inside PostgreSQL, allowing for queries to be written using natural language.
## Demo
https://user-images.githubusercontent.com/1121616/228234378-40c796d3-0a38-465a-92da-9370fb21b93b.mp4
(This demo uses data from the [Hacker News](https://www.cloudquery.io/integrations/hackernews/postgresql) and [Azure](https://www.cloudquery.io/integrations/azure/postgresql) CloudQuery plugins)
## How does it work?
The extension sends a subset of the database schema to ChatGPT and asks it to generate a query based on this and the user input.
## Before you start
- **Note**: This plugins sends schema (without the data) to OpenAI GPT API, so it is not recommended to use it on production databases.
- **Note**: This is an experimental plugin and not officially supported by CloudQuery.
## Installation
Requires [pgx](https://github.com/tcdi/pgx). Install this first:
```bash
cargo install --locked cargo-pgx
cargo pgx init
```
Now you can install the extension:
```bash
git clone https://github.com/cloudquery/pg_gpt
cd pg_gpt
export OPENAI_KEY=
cargo pgx run
# will drop into psql shell
```
```sql
create extension pg_gpt;
set openai.key = ''; -- set your key
select gpt('show me all open aws s3 buckets');
-- will output the following query, so you can execute it
-- select * from aws_s3_bucket;
```
## Available Functions
- `gpt(text)` - Generates a query based on the user input and the full database schema. This works fine for databases with small schemas.
- `gpt_tables(table_pattern, text)` - Similar to gpt, but only uses the tables that match the pattern. The pattern is passed to a `table_name LIKE` query, so `%` can be used as wildcard.
## Installing the extension on an existing Postgres instance
First run:
```bash
cargo pgx install
```
This places the extension in the postgres extensions directory. Then, in your postgres instance, run:
```sql
create extension pg_gpt;
set openai.key = '';
-- proceed to use the extension
```
## Limitations
* Schema Size - Currently we use gpt-3.5-turbo, which is limited to 4096 tokens. Use `gpt_tables` to narrow down the set of tables.