doc/user: add LibreDB Studio to SQL clients - #38687
Open
kaya-abdullah wants to merge 3 commits into
Open
Conversation
LibreDB Studio connects to Materialize over the PostgreSQL wire protocol. The SQL editor works fully, including Materialize specific statements. The object browser and monitoring dashboard both depend on PostgreSQL catalog objects Materialize does not have, so those two are called out as not working rather than left to be discovered.
The object browser and monitoring dashboard restrictions documented here were bugs in LibreDB Studio, fixed upstream in libredb/libredb-studio#578. Update the tip to describe current behavior instead of the outdated restrictions.
Author
|
Linking back for context: this is the same branch as #38680, which I could not reopen after pushing the fix (the reopen API rejected it and there was no reopen button available to me either). Opened this instead of leaving the fix unseen on a closed PR. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
LibreDB Studio is an open source, browser-based SQL IDE that connects to Materialize over the PostgreSQL wire protocol. This adds it to the SQL clients page alongside DataGrip, DBeaver and TablePlus.
This reopens #38680, which I could not reopen directly through GitHub (the API rejected the reopen and no reopen button showed up for me either). Same branch, with the fix described below on top.
Description
Added a
### LibreDB Studiosection after TablePlus. The SQL editor works fully, including Materialize specific statements likeSHOW MATERIALIZED VIEWSandSHOW SOURCES. The object browser lists real tables, views and materialized views with their columns.@sjwiesman closed #38680 because the object browser and monitoring dashboard both failed outright. That turned out to be a bug in LibreDB Studio, not a gap in Materialize:
MATERIALIZEDis a reserved keyword that broke the schema introspection query, and the monitoring dashboard errored on connect instead of degrading. Both are fixed in libredb/libredb-studio#578, and the tip in this PR is updated to describe current behavior instead of the old restrictions.