> For the complete documentation index, see [llms.txt](https://piramal-swasthya.gitbook.io/uba/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://piramal-swasthya.gitbook.io/uba/toasters/beneficiary-toaster/developer-guide/backend-guide/database-schema-setup.md).

# Database Schema Setup

Once the database service is running, you must create the schema before using the backend. ⚠️ This step is mandatory. The backend will not function until the schema is loaded.

This document explains how to set up the **Beneficiary Backend Database Schema** in PostgreSQL.

## Schema File

The schema is defined in: [schema.pgsql](https://github.com/PSMRI/ubi-beneficiary-backend/blob/main/schema.pgsql)

This file contains:

* Table definitions
* Indexes
* Constraints
* Relationships

## Applying the Schema

You can either use pgAdmin or psql CLI tool to import. Ensure to create a blank database named `uba_beneficiary_mw` before trying one of the options.

### Option A - Using pgAdmin

1. Open pgAdmin at <http://localhost:8082>
2. Login with credentials from .`env`
   * **Email**: `PGADMIN_DEFAULT_EMAIL`
   * **Password**: `PGADMIN_DEFAULT_PASSWORD`
3. Connect to the `Postgres` server
4. Right-click on the database (`uba_beneficiary_mw`) → **Query Tool**
5. Load and execute `schema.pgsql`

### Option B - Using psql CLI

Run the following command (from the project root):

```bash
docker exec -i <postgres_container_name> psql -U <db-user-name> -d uba_beneficiary_mw < schema.pgsql
```

Replace `<postgres_container_name>` with the container name (Use `docker ps` to get DB container name).<br>

## ⚠️ Note

* In the `schema.pgsql` file, replace:<br>

  ```
  Owner: <replace_with_your_db_user>
  ```

  \
  with your actual DB username.

## Verifying Schema

After running the script:

* Tables should be visible in pgAdmin under `uba_beneficiary_mw → Schemas → public → Tables`
* Indexes can be found under each table’s **Indexes** section

## Schema Updates

If schema changes are required:

1. Update `schema.pgsql` file
2. Re-run the script as described above


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://piramal-swasthya.gitbook.io/uba/toasters/beneficiary-toaster/developer-guide/backend-guide/database-schema-setup.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.