diff --git a/docs/cspell.json b/docs/cspell.json index 6f780baaf4e0..51b3b6398e78 100644 --- a/docs/cspell.json +++ b/docs/cspell.json @@ -684,6 +684,7 @@ "splunkd", "splunkforwarder", "sqlcl", + "sqlcmd", "sqlnet", "sqlserver", "sshcacerts", diff --git a/docs/pages/database-access/guides/azure-sql-server-ad.mdx b/docs/pages/database-access/guides/azure-sql-server-ad.mdx index 85a5a1110631..c51e841bc8b4 100644 --- a/docs/pages/database-access/guides/azure-sql-server-ad.mdx +++ b/docs/pages/database-access/guides/azure-sql-server-ad.mdx @@ -262,10 +262,7 @@ $ tsh db connect --db-user=sqlserver-identity --db-name=master sqlserver Where `--db-user` is the managed identity name. - - The `mssql-cli` command-line client should be available in `PATH` of the machine - you're running `tsh db connect` from. - +(!docs/pages/includes/database-access/sql-server-connect-note.mdx!) ## Troubleshooting diff --git a/docs/pages/database-access/guides/rds-proxy.mdx b/docs/pages/database-access/guides/rds-proxy.mdx index c88b3501a8c9..ffe035dede3a 100644 --- a/docs/pages/database-access/guides/rds-proxy.mdx +++ b/docs/pages/database-access/guides/rds-proxy.mdx @@ -181,7 +181,7 @@ $ tsh db connect --db-user=alice --db-name=dev rds-proxy 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. To log out of the database and remove credentials: diff --git a/docs/pages/includes/database-access/sql-server-connect-note.mdx b/docs/pages/includes/database-access/sql-server-connect-note.mdx index 531e4279ab2c..743c250d744f 100644 --- a/docs/pages/includes/database-access/sql-server-connect-note.mdx +++ b/docs/pages/includes/database-access/sql-server-connect-note.mdx @@ -1,9 +1,11 @@ -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