> 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/mssql.md). # Microsoft SQL Server (MSSQL) or Azure SQL To create a MSSQL 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 * **Host URL and Parameters**: The URL or hostname of the SQL Server where the database is hosted. This is typically provided by the database administrator. Additional connection parameters (such as encryption settings or timeout values) might be needed depending on the specific requirements of the SQL Server and the connection method. * **Database Schema**: The schema in the Microsoft SQL Server where your tables and other database objects are located. This can be provided by the database administrator, and it helps define the structure and organization of the data within the database. * **Port**: The port number used to connect to the SQL Server. The default port for Microsoft SQL Server is `1433`, but it might vary depending on the configuration. This information can be obtained from the database administrator. * **Username**: The username used for authentication to the Microsoft SQL Server. This is typically provided by the database administrator or set up by the user account when created in the SQL Server. * **Password**: The password associated with the provided username for authentication. This password is securely stored and is required for establishing the connection to the SQL Server. It can be set when the user account is created and should be securely retrieved if forgotten. ## Create a MSSQL Depot A Depot of type `SQLSERVER` connects to a Microsoft SQL Server database and reads from its tables. One Depot covers all tables within the configured schema. Create multiple Depots for multiple SQL Server servers or databases. To create a Depot of type `SQLSERVER`, follow these steps: ### **Step 1: Create a Secret for securing MSSQL credentials** Create a Secret Resource using the [Microsoft SQL Server (MSSQL) or Azure SQL](/concepts/resources/secret/data-sources/microsoft-sql-server-mssql-or-azure-sql.md) guide. ### **Step 2: Create a MSSQL Depot manifest file** Create a manifest file for your MSSQL Depot. {% tabs %} {% tab title="Manifest file" %} ```yaml name: ${{mssql-name}} version: v2alpha type: depot tags: - MSSQL - depot - rdbms description: "Microsoft SQL Server relational database depot for data storage and querying" spec: type: jdbc spec: subprotocol: "sqlserver" host: ${{mssql-host}} port: 1433 database: ${{mssql-database}} params: encrypt: "${{mssql-encrypt}}" secrets: - id: "${{tenant-id}}:${{mssql-secret-name}}" purpose: scan - id: "${{tenant-id}}:${{mssql-secret-name}}" purpose: query - id: "${{tenant-id}}:${{mssql-secret-name}}" purpose: rw ``` {% endtab %} {% tab title="Example" %} ```yaml name: ${{mssql-name}} version: v2alpha type: depot tags: - MSSQL - depot - rdbms description: "Microsoft SQL Server relational database depot for data storage and querying" spec: type: jdbc spec: subprotocol: "sqlserver" host: ${{mssql-host}} port: 1433 database: ${{mssql-database}} params: encrypt: "${{mssql-encrypt}}" secrets: - id: "${{tenant-id}}:${{mssql-secret-name}}" purpose: scan - id: "${{tenant-id}}:${{mssql-secret-name}}" purpose: query - id: "${{tenant-id}}:${{mssql-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/mssql.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.