Plugins
Databases
Databases
The Databases plugin covers two separate things: the database docu.nexus itself runs on, and read-only connections to other databases you want to read inside the wiki. It is free and always on, so the admin tab is visible on every instance.
Open Admin -> Databases.
Current backend
The top card reports the instance-wide storage backend. Every nexus, space and page lives there.
It shows the engine, whether it is healthy, and the server version, for example PostgreSQL (healthy) with the version string beneath. If the check fails it says so and gives the error.
You need to be an owner or admin of a nexus to see this card.
Test a connection
The second card opens a throwaway connection to a target database and reports whether it is reachable. Nothing is saved and no data is changed.
Fill in Engine, Host, Port, Database, User, Password, and optionally Use SSL/TLS, then press Test connection. The port field pre-fills the conventional default for the engine you pick.
| Engine | Status |
|---|---|
| PostgreSQL | Connects for real and reports the server version and latency |
| MySQL | Returns “Not available yet”, pending the db-mysql entitlement and driver |
| Microsoft SQL Server | Returns “Not available yet”, pending the db-mssql entitlement and driver |
MySQL and SQL Server as the instance backend are Phase 2 work. This is different from reading an external MySQL or SQL Server database, which works today (below).
External data sources
The third card registers connections to other databases: an existing MariaDB, SQL Server or PostgreSQL your team already runs. These are entirely separate from the instance storage backend, and access is read-only.
Under Add data source, provide:
| Field | Notes |
|---|---|
| Name | How the source is labelled everywhere else, e.g. Production ecaddb |
| Engine | MariaDB / MySQL, Microsoft SQL Server, or PostgreSQL, all working today |
| Host, Port | Port defaults to the engine’s conventional value |
| Database | The database or catalog name |
| User, Password | Credentials for the connection |
| Use SSL/TLS | Optional |
Press Add data source. Each registered source then offers three actions:
- Test: opens a connection and reports
Connected: <server version> (<n> ms)or the error. - Browse: lists the source’s tables. Pick one to page through its rows, 25, 50 or 100 at a time, with Prev and Next.
- The trash button removes the source.
The Database View page
A Database View is a page that renders one table from a registered data source as a live, filterable grid. Create one from the New content menu in a space, or from the space rail.
A new view opens on a picker:
- Data source: choose from the registered sources. If none exist, the page says so and points at Admin -> Databases.
- Table: choose from that source’s tables.
- Press Create view.
Once configured, the page shows the table with:
- Search all columns, debounced, running server-side.
- Columns, a menu to show and hide columns. The choice is saved on the page.
- Rows, a page size of 25, 50 or 100, with previous and next arrows and a range readout.
Values render readably. JSON columns, and text columns that contain JSON, are summarised on one line with the full JSON in the cell tooltip. A { value, units } shape renders as “1 deg/h”. Nulls show as a dimmed dot.
The right-hand rail carries Reload rows, Change source or table, favorite, watch, and a More options menu with Copy link and Delete view.
If you can only view the page, there is no Change source or table and no Delete view, and a view with no table yet says so instead of offering the picker. Hiding columns, sorting and the plot mapping still work for you but are not saved, and the Columns menu says that changes there are not saved because you can only view the page.