Databases
createDatabase
Add a database
Registers a new upstream PostgreSQL database for the project.
Usage
const result = await api.databases.createDatabase({
pathParams: { project_id: "prj_xxx" },
body: {
host: "db.example.com",
port: 5432,
name: "mydb",
username: "pgbeam",
password: "...",
},
});Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| pathParams.project_id | string | Yes | Unique project identifier (prefixed, e.g. prj_xxx). |
| body.host | string | Yes | PostgreSQL host. |
| body.port | number | Yes | PostgreSQL port. |
| body.name | string | Yes | PostgreSQL database name. |
| body.username | string | Yes | PostgreSQL username. |
| body.password | string | Yes | PostgreSQL password. Stored encrypted at rest. |
| body.ssl_mode | SSLMode | No | |
| body.role | DatabaseRole | No | |
| body.pool_region | string | No | Region where the connection pool is maintained (near the database). When set and different from the client's edge region, queries are relayed through the pool region's data plane. Empty means direct connection. |
| body.query_timeout_ms | number | No | Query timeout in milliseconds. 0 means disabled (default). |
| body.auto_read_routing | boolean | No | Auto-route SELECT queries to read replicas. |
| body.cache_config | CacheConfig | No | |
| body.pool_config | PoolConfig | No |
Response
Promise<Database> — database created.
Example
import { PgBeamClient } from "pgbeam";
const client = new PgBeamClient({
token: "pbk_...",
baseUrl: "https://api.pgbeam.com",
});
const result = await client.api.databases.createDatabase({
pathParams: { project_id: "prj_xxx" },
body: {
host: "db.example.com",
port: 5432,
name: "mydb",
username: "pgbeam",
password: "...",
},
});Errors
| Status | Description |
|---|---|
| 400 | Invalid request parameters. |
| 401 | Missing or invalid authentication. |
| 403 | Operation not allowed by current plan limits. |
| 404 | Resource not found. |
| 429 | Rate limited. Try again later. |