github/genai-toolbox
1
0
Fork 0
mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-01-09 23:48:04 -05:00
Code Issues Packages Projects Releases 14 Wiki Activity

docs(mssql): add docs for source (#256)

Browse Source 
Add docs for `mssql` source, and update for `mssql-sql` tool.
This commit is contained in:
Yuan
2025-02-03 10:34:01 -08:00
committed by GitHub
parent 2a7a1eb49c
commit b578e6ce89
2 changed files with 52 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
docs/en/resources/sources/mssql.md Normal file
View File

@@ -0,0 +1,49 @@
---
title: "SQL Server"
type: docs
weight: 1
description: >
SQL Server is a relational database management system (RDBMS).
---
## About
[SQL Server][mssql-docs] is a relational database management system (RDBMS)
developed by Microsoft that allows users to store, retrieve, and manage large
amount of data through a structured format.
[mssql-docs]: https://www.microsoft.com/en-us/sql-server
## Requirements
### Database User
This source only uses standard authentication. You will need to [create a
SQL Server user][mssql-users] to login to the database with.
[mssql-users]: https://learn.microsoft.com/en-us/sql/relational-databases/security/authentication-access/create-a-database-user?view=sql-server-ver16
## Example
```yaml
sources:
my-mssql-source:
kind: "mssql"
host: "127.0.0.1"
port: "1433"
database: "my_db"
user: "my-user"
password: "my-password"
```
## Reference
| **field** | **type** | **required** | **description** |
|-----------|:--------:|:------------:|------------------------------------------------------------------------|
| kind | string | true | Must be "mssql". |
| host | string | true | IP address to connect to (e.g. "127.0.0.1"). |
| port | string | true | Port to connect to (e.g. "1433"). |
| database | string | true | Name of the SQL Server database to connect to (e.g. "my_db"). |
| user | string | true | Name of the SQL Server user to connect as (e.g. "my-user"). |
| password | string | true | Password of the SQL Server user (e.g. "my-password"). |