We plan to create table documentation in Confluence. Table documentation will include all the tables present in either schema or metadata tables present at our side. This table documentation supposed to be created dynamically. That means when we enhance schema for new tables or column addition or data type changes - the documentation in confluence also updated for same.
I tried to search - but as such no direct option available? /markdown support is present in Cloud Confluence - not clear on same as well?
| Name | Data Type | Nullable | Default |
|---|---|---|---|
| CUSTOMERID | NUMBER(10) | NO | |
| NAME | VARCHAR2(50) | YES | |
| VARCHAR2(100) | YES | ||
| CREATEDDATE | DATE | NO | SYSDATE |
If you want this to look polished without building your own integration, tools like dbdocs.io or DBSchema are great. However, for a native-feeling experience in the Atlassian ecosystem:
SchemaSpy: You can run this as part of your CI/CD pipeline. It generates HTML documentation of your schema. You can then use the Confluence CLI or an HTML Macro to push that data into a page.
Dataedo: This is a popular choice that has a direct "Export to Confluence" feature. It tracks changes and updates the Confluence pages automatically.
Another way you can use this:
If I were in your shoes as a Jira Admin:
I’d avoid the manual /markdown route because it won't be "dynamic." Instead, I would look at PocketQuery or SQL for Confluence. It allow you to connect your database as a data source.
You can write a query like this to pull your documentation:
SQL
SELECT table_name, column_name, data_type, is_nullable
FROM information_schema.columns
WHERE table_schema = 'your_schema_name';
The macro will then render that table in Confluence, and it will always be accurate because it's pulling from the source of truth.
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.