Skip to content

Commit

Permalink
refactor(docs): expand limitations section
Browse files Browse the repository at this point in the history
  • Loading branch information
gabrielcorado committed Dec 23, 2024
1 parent b536bd9 commit 9d6e31a
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions docs/pages/connect-your-client/web-ui.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,20 @@ limitations.
![Database session terminal](../../img/connect-your-client/webui-db-sessions/session-terminal.png)

<Admonition type="note" title="Database CLI compatibility">
While the terminal interface looks similar to database CLIs like `psql`, it is
a custom implementation provided by Teleport. As a result, it may give
different behaviors and a distinct feature set compared to commonly used
database CLI tools.
While the terminal interface provided in the Teleport Web UI is designed to
resemble popular database CLIs such as `psql`, it is a custom implementation
with some differences and limitations:
- **Feature Set:** Not all features available in `psql` are implemented.
For instance, scripting capabilities, query cancelation, or informational
commands like `\d` or `\dt` are currently unsupported.
- **Error Handling:** Error messages and diagnostics might differ from what
users are accustomed to in `psql`.

These distinctions are designed to maintain a lightweight and secure interface
directly in your browser. For more complex operations, you may prefer
accessing your database from your terminal using `tsh` and your preferred
tool.

Future updates may expand functionality or address feedback based on user
needs and supported databases.
</Admonition>

0 comments on commit 9d6e31a

Please sign in to comment.