pg-api 0.1.0

A high-performance PostgreSQL REST API driver with rate limiting, connection pooling, and observability
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

# pg-api Examples

This directory contains example code demonstrating how to use the pg-api PostgreSQL REST API driver.

## Examples

### Rust Examples

- **basic_query.rs** - Simple SELECT query with parameters
- **batch_operations.rs** - Execute multiple queries in a single request
- **transaction.rs** - Execute queries within a transaction
- **schema_introspection.rs** - List databases, tables, and inspect schema

### Python Example

- **python_client.py** - Complete Python client library with usage examples

## Running the Examples

### Prerequisites

1. Start the pg-api server:
```bash
cargo run --release
```

2. Configure your API token in the examples (replace `sk_live_your_token_here`)

### Running Rust Examples

```bash
# Install dependencies
cargo add reqwest tokio serde_json

# Run an example
cargo run --example basic_query
cargo run --example batch_operations
cargo run --example transaction
cargo run --example schema_introspection
```

### Running Python Example

```bash
# Install dependencies
pip install requests

# Run the example
python examples/python_client.py
```

## Configuration

All examples expect:
- pg-api server running on `http://localhost:8580`
- Valid API token configured in your accounts.json
- PostgreSQL database accessible with proper permissions

## Creating Your Own Client

The examples demonstrate the basic patterns for interacting with pg-api:

1. **Authentication**: Include API token in Authorization header
2. **Request Format**: Send JSON payload with query, params, and database
3. **Response Handling**: Parse JSON response containing rows and metadata
4. **Error Handling**: Check HTTP status codes and handle errors appropriately

## API Endpoints

- `POST /v1/query` - Execute single query
- `POST /v1/batch` - Execute multiple queries
- `POST /v1/transaction` - Execute queries in transaction
- `GET /v1/databases` - List databases
- `GET /v1/databases/{db}/tables` - List tables
- `GET /v1/databases/{db}/schema` - Get schema
- `GET /health` - Health check