Urgent.News

What's breaking now, across thousands of outlets.

Tech

What getting into thirteen database projects' docs actually took

Thirteen database projects now list LibreDB Studio, our open source browser SQL IDE, in their official documentation: PostgreSQL , Redis , ClickHouse , MariaDB , DuckDB , Trino , YugabyteDB , StarRocks , DragonflyDB , OpenSearch , Apache Cloudberry , Apache Druid and Aiven ( PostgreSQL , MySQL ). Each listing went through that project's own review. Here is what that looked like. How long it took…

Thirteen distinct database projects now acknowledge LibreDB Studio, the open-source browser SQL IDE, within their official documentation: PostgreSQL, Redis, ClickHouse, MariaDB, DuckDB, Trino, YugabyteDB, StarRocks, DragonflyDB, OpenSearch, Apache Cloudberry, Apache Druid, and Aiven (PostgreSQL and MySQL). Each listing underwent a unique review process specific to the respective project.

The duration for each project to integrate LibreDB Studio varied. For instance, DuckDB and Aiven's second guide were merged on the same day the pull request was submitted, while Aiven's initial guide took under three days. Conversely, Apache Cloudberry required approximately five days, OpenSearch consumed about two weeks, YugabyteDB took around two and a half days, and Apache Druid merged after a week but had to wait nearly six weeks for its site to be republished alongside the Druid 38.0.0 release.

Before adding a documentation page, each project adheres to a specific format: a YAML row, a comprehensive guide page, or a single line within a list. Leveraging existing templates from other tools proved to be the most efficient approach. Before proceeding with a pull request, it is essential to test the documentation page against the targeted database engine, as it serves as evidence of the tool's compatibility.

Furthermore, it is crucial to be precise about compatibility; the compatibility table lists 28 engines that connect through an intermediary driver, with 18 fully compatible, 9 partially compatible, and 1 compatible solely in the query editor. This specificity streamlines the review process, resulting in shorter and more focused discussions.

The primary purpose of a documentation page is to provide a relevant resource for users who have already selected a database and are seeking compatible tools. This approach offers a more compelling first impression than mere advertising and becomes more likely if the maintainers of the database project agree to include the integration.

LibreDB Studio is released under the MIT license, allowing it to be deployed alongside any database and accessed through a web browser. To set it up, users can execute the following command: docker run -p 3000:3000 ghcr.io/libredb/libredb-studio:latest. For more information, visit the repository at https://github.com/libredb/libredb-studio.

Written by urgent.news from Dev.to's reporting — not their text. Machine-written — may contain errors; check the original before relying on it.

Read the original at dev.to →

More in Tech

🚀 Starting my Hacktoberfest journey!

This is my first time participating in Hacktoberfest , and I'm excited to dive deeper into open source. I’m looking forward to: 🔹 Contributing to real-world projects 🔹 Exploring new repositories and…

More from Friday 2 October →