---
title: "createDatabase"
description: "Add a database"
canonical: "https://pgbeam.com/docs/ts-sdk/databases/createDatabase"
last-updated: "2026-10-29T19:01:20.000Z"
---

# createDatabase

> Add a database

URL: https://pgbeam.com/docs/ts-sdk/databases/createDatabase

{/* Auto-generated from OpenAPI. Do not edit. Run `pnpm generate:sdk-docs` to regenerate. */}

Registers a new upstream PostgreSQL database for the project.

## Usage

```typescript
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       | PostgreSQL SSL connection mode.                                                                                                                                                                                    |
| body.role              | `DatabaseRole` | No       | Database role. Primary receives writes, replicas receive reads.                                                                                                                                                    |
| 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       | Query cache configuration.                                                                                                                                                                                         |
| body.pool_config       | `PoolConfig`   | No       | Connection pool configuration.                                                                                                                                                                                     |

## Response

`Promise<Database>`: database created.

## Example

```typescript
import { PgBeamClient } from "pgbeam";

const client = new PgBeamClient({
  token: "pbu_...",
  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    | The request was rejected. `code` is `INVALID_INPUT`, and `errors` names the offending fields when the failure was a validation one.                                                                                                                                                                                                   |
| 401    | Missing or invalid authentication. `code` is `UNAUTHORIZED`.                                                                                                                                                                                                                                                                          |
| 403    | The caller is authenticated but not allowed to perform this operation. `code` is `FORBIDDEN` when the caller's role is insufficient, and `PLAN_LIMIT_REACHED` when the organization's plan is what stands in the way. The two are answered differently, so branch on the code rather than the status.                                 |
| 404    | The resource does not exist, or the caller is not entitled to know that it does. `code` is `NOT_FOUND`.                                                                                                                                                                                                                               |
| 409    | The request conflicts with the current state. `code` distinguishes the cases: `RESOURCE_EXISTS` for a name or value already in use, `INVALID_STATE` for a resource that is no longer in a state that allows the operation, and `IDEMPOTENCY_KEY_REUSED` for a retry whose body does not match the request the key was first used for. |
| 413    | The request body exceeds the 2 MB limit. `code` is `PAYLOAD_TOO_LARGE`.                                                                                                                                                                                                                                                               |
| 415    | The request body is not JSON, or carries a body without declaring a Content-Type. `code` is `UNSUPPORTED_MEDIA_TYPE`.                                                                                                                                                                                                                 |
| 429    | Rate limited. `code` is `RATE_LIMITED`.                                                                                                                                                                                                                                                                                               |
| 500    | The request failed for a reason on our side. `code` is `INTERNAL_ERROR`. Quote `request_id` when reporting it.                                                                                                                                                                                                                        |