Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update SQL Server guides to mention sqlcmd as default CLI #29543

Merged
merged 3 commits into from
Jul 26, 2023
Merged

Update SQL Server guides to mention sqlcmd as default CLI #29543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
540997e
docs(sqlserver): update default command to `sqlcmd`
gabrielcorado Jul 24, 2023
d36de80
docs: add `sqlcmd` to spell check dictionary
gabrielcorado Jul 26, 2023
a6c14cb
Merge branch 'master' into gabrielcorado/update-sqlserver-docs-to-sqlcmd
gabrielcorado Jul 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/cspell.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -684,6 +684,7 @@
"splunkd",
"splunkforwarder",
"sqlcl",
"sqlcmd",
"sqlnet",
"sqlserver",
"sshcacerts",
Expand Down
5 changes: 1 addition & 4 deletions docs/pages/database-access/guides/azure-sql-server-ad.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,10 +262,7 @@ $ tsh db connect --db-user=sqlserver-identity --db-name=master sqlserver

Where `--db-user` is the managed identity name.

<Admonition type="note">
The `mssql-cli` command-line client should be available in `PATH` of the machine
you're running `tsh db connect` from.
</Admonition>
(!docs/pages/includes/database-access/sql-server-connect-note.mdx!)

## Troubleshooting

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/database-access/guides/rds-proxy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ $ tsh db connect --db-user=alice --db-name=dev rds-proxy

<Admonition type="note" title="Note">
The appropriate database command-line client (`psql`, `mysql`, `mariadb`,
`mssql-cli`) should be available in `PATH` in order to connect.
`sqlcmd`) should be available in `PATH` in order to connect.
</Admonition>

To log out of the database and remove credentials:
Expand Down
12 changes: 7 additions & 5 deletions docs/pages/includes/database-access/sql-server-connect-note.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
<Admonition type="note">
When you run the `tsh db connect` command above, `tsh` attempts to execute
the `mssql-cli` command-line client, which must be available in the user's
`PATH`. If you do not have `mssql-cli` 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:
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
Expand Down
Loading