---
title: "CreateDatabase"
description: "Add a database"
canonical: "https://pgbeam.com/docs/go-sdk/databases/createDatabase"
last-updated: "2026-09-14T19:37:21.000Z"
---

# CreateDatabase

> Add a database

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

Registers a new upstream PostgreSQL database for the project.

## Usage

## Parameters

Parameter

Type

Required

Description

ctx

`context.Context`

Yes

Request context

projectID

`string`

Yes

Unique project identifier (prefixed, e.g. prj\_xxx).

req

`pgbeam.CreateDatabaseRequest`

Yes

Request body

req.Host

`string`

Yes

PostgreSQL host.

req.Port

`int`

Yes

PostgreSQL port.

req.Name

`string`

Yes

PostgreSQL database name.

req.Username

`string`

Yes

PostgreSQL username.

req.Password

`string`

Yes

PostgreSQL password. Stored encrypted at rest.

req.SSLMode

`*pgbeam.SSLMode`

No

PostgreSQL SSL connection mode.

req.Role

`*pgbeam.DatabaseRole`

No

Database role. Primary receives writes, replicas receive reads.

req.PoolRegion

`*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.

req.QueryTimeoutMs

`*int`

No

Query timeout in milliseconds. 0 means disabled (default).

req.AutoReadRouting

`*bool`

No

Auto-route SELECT queries to read replicas.

req.CacheConfig

`*pgbeam.CacheConfig`

No

Query cache configuration.

req.PoolConfig

`*pgbeam.PoolConfig`

No

Connection pool configuration.

## Response

`(*pgbeam.Database, error)`: database created.

## Example

## 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.