-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update SQL Server guides to mention
sqlcmd
as default CLI (#29543)
* docs(sqlserver): update default command to `sqlcmd` * docs: add `sqlcmd` to spell check dictionary
- Loading branch information
1 parent
d04c167
commit d92dd74
Showing
4 changed files
with
19 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -678,6 +678,7 @@ | |
"splunkd", | ||
"splunkforwarder", | ||
"sqlcl", | ||
"sqlcmd", | ||
"sqlnet", | ||
"sqlserver", | ||
"sshcacerts", | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
16 changes: 16 additions & 0 deletions
16
docs/pages/includes/database-access/sql-server-connect-note.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
<Admonition type="note"> | ||
Either the `sqlcmd` or `mssql-cli` command-line clients should be available in | ||
`PATH` in order to be able to connect. `tsh` attempts to run `sqlcmd` first and, | ||
if it's not present on the `PATH`, runs `mssql-cli`. | ||
|
||
If you have neither command-line clients available on your system, you can run | ||
the following command to start a local proxy server that you can connect to with | ||
your SQL Server client: | ||
|
||
```code | ||
$ tsh proxy db --db-user=teleport --tunnel sqlserver | ||
``` | ||
|
||
Read the [Database Access GUI Clients](../../connect-your-client/gui-clients.mdx#sql-server-with-azure-data-studio) | ||
guide for how to connect your DB GUI client to the local proxy. | ||
</Admonition> |