> For the complete documentation index, see [llms.txt](https://v2.dataos.info/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://v2.dataos.info/concepts/resources/depot/supported-sources/postgresql.md). # PostgreSQL To create a Postgres Depot you must have the following details: ## Pre-requisites specific to DataOS To create a Depot, you need the Data Admin role. Contact the DataOS Operator or Tenant Admin to get it. Run this command to see your assigned roles. ```bash dataos-ctl user get #Expected Output: time="2026-03-30T17:49:18+05:30" level=info msg="😃 user get..." time="2026-03-30T17:49:19+05:30" level=info msg="😃 user get...complete" NAME │ ID │ TYPE │ EMAIL │ TAGS ──────────────┼───────────────────┼────────┼──────────────────────┼──────────────────────────────────────── I Am Groot │ iamgroottmdcio │ person │ iam.groot@tmdc.io │ roles:id:ct-onboarding-data-developer, │ │ │ │ roles:id:data-dev, │ │ │ │ roles:id:system-dev, │ │ │ │ roles:id:user, │ │ │ │ users:id:iamgroottmdcio ``` ## Pre-requisites specific to the source system * **Database name**: The name of the specific PostgreSQL database you want to connect to. This can be provided by the database administrator or found in the database management system where the database was created. * **Hostname/URL of the server**: The hostname or URL of the server where the PostgreSQL database is hosted. This is typically an IP address or a fully qualified domain name (FQDN). You can obtain this from your database administrator or the team managing the PostgreSQL server. * **Parameters**: Additional optional parameters are required for the connection, such as SSL settings or timeout configurations. These can be provided by the database administrator or found in your PostgreSQL server's documentation, depending on the connection requirements. * **Username**: The username used for authentication to access the PostgreSQL database. This is created when the user account is set up and can be provided by the database administrator. * **Password**: The password associated with the PostgreSQL username for authentication. This is set during user account creation and must be securely obtained from the database administrator if forgotten. ## Create a Postgres Depot A Depot of type `POSTGRESQL` connects to a PostgreSQL database and reads from its tables. One Depot covers all schemas visible to the configured user. To create a Depot of type `POSTGRESQL`, follow these steps: ### **Step 1: Create a Secret for securing Postgres credentials** Create a Secret Resource using the [PostgreSQL](/concepts/resources/secret/data-sources/postgresql.md) guide. ### **Step 2: Create a Postgres Depot manifest file** Create a manifest file for your Postgres Depot. {% tabs %} {% tab title="Manifest file" %} ```yaml name: ${{postgres-name}} version: v2alpha type: depot tags: - PostgreSQL - depot - rdbms description: "PostgreSQL relational database depot for data storage and querying" spec: type: postgresql spec: host: ${{postgres-host}} port: 5432 database: ${{postgres-database}} subprotocol: "postgresql" secrets: - id: "${{tenant-id}}:${{postgres-secret-name}}" purpose: scan - id: "${{tenant-id}}:${{postgres-secret-name}}" purpose: query - id: "${{tenant-id}}:${{postgres-secret-name}}" purpose: rw ``` {% endtab %} {% tab title="Example" %} ```yaml name: ${{postgres-name}} version: v2alpha type: depot tags: - PostgreSQL - depot - rdbms description: "PostgreSQL relational database depot for data storage and querying" spec: type: postgresql spec: host: ${{postgres-host}} port: 5432 database: ${{postgres-database}} subprotocol: "postgresql" secrets: - id: "${{tenant-id}}:${{postgres-secret-name}}" purpose: scan - id: "${{tenant-id}}:${{postgres-secret-name}}" purpose: query - id: "${{tenant-id}}:${{postgres-secret-name}}" purpose: rw ``` {% endtab %} {% endtabs %} ### **Step 3: Apply the Depot manifest file** Apply the manifest with the DataOS CLI: ```bash dataos-ctl resource apply -f ${{manifest-file-path}} ``` ## Verify the Depot creation Verify the Depot in two ways: * List Depots where you are the owner: ```bash dataos-ctl resource get -t depot ``` * List all Depots in the current Tenant: ```bash dataos-ctl resource get -t depot -a ``` ## Delete a Depot {% hint style="warning" %} Best practice: Delete Resources that are no longer in use to save time and reduce costs. {% endhint %} To delete a Depot, use the DataOS CLI: {% tabs %} {% tab title="Command 1" %} ```bash dataos-ctl resource delete -t depot -n ${{name}} ``` {% endtab %} {% tab title="Command 2 " %} ```bash dataos-ctl resource delete -i "${{resource-name}}|v2alpha|depot" ``` {% endtab %} {% tab title="Command 3" %} ```bash dataos-ctl resource delete -f ${{manifest-file-path}} ``` {% endtab %} {% endtabs %} Specify the Resource type and Depot name in the `delete` command. **Example:** {% tabs %} {% tab title="Command 1" %} ```bash dataos-ctl resource delete -t depot -n testdepot #output time="2026-03-25T15:53:55+05:30" level=info msg="🗑 delete..." time="2026-03-25T15:53:55+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot..." time="2026-03-25T15:53:56+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot...deleted" time="2026-03-25T15:53:56+05:30" level=info msg="🗑 delete...complete" time="2026-03-25T15:53:56+05:30" level=info msg="🗑 delete...complete" ``` {% endtab %} {% tab title="Command 2" %} ```bash dataos-ctl resource delete -i "testdepot|v2alpha|depot" #output time="2026-03-25T15:55:37+05:30" level=info msg="🗑 delete..." time="2026-03-25T15:55:37+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot..." time="2026-03-25T15:55:37+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot...deleted" time="2026-03-25T15:55:37+05:30" level=info msg="🗑 delete...complete" ``` {% endtab %} {% tab title="Command 3" %} ```bash dataos-ctl resource delete -f /path/to/depot.yaml #output time="2026-03-25T15:53:55+05:30" level=info msg="🗑 delete..." time="2026-03-25T15:53:55+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot..." time="2026-03-25T15:53:56+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot...deleted" time="2026-03-25T15:53:56+05:30" level=info msg="🗑 delete...complete" ``` {% endtab %} {% endtabs %} --- # 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://v2.dataos.info/concepts/resources/depot/supported-sources/postgresql.md?ask=&goal= ``` `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.