How to create table documentation which includes all the tables that are present in Schema?

Mihir Sabnis
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
September 6, 2024

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?

 

 

Example of What supposed to Look Like in Confluence Cloud:


Table: CUSTOMERS

Columns:

NameData TypeNullableDefault
CUSTOMERIDNUMBER(10)NO 
NAMEVARCHAR2(50)YES 
EMAILVARCHAR2(100)YES 
CREATEDDATEDATENOSYSDATE

Primary Key:

  • CUSTOMERID

Foreign Keys:

  • ORDERS -> CUSTOMERS (CUSTOMERID -> CUSTOMERID)

1 answer

0 votes
Laura Campbell [Seibert Group]
Community Leader
Community Leader
Community Leaders are connectors, ambassadors, and mentors. On the online community, they serve as thought leaders, product experts, and moderators.
September 9, 2024

Hi @Mihir Sabnis and welcome to Community.

Could you provide a bit more context on the schema or metadata tables on your side? For example, are you talking about a custom database you use in your company? Or a specific tool?

If I understand correctly, you are looking for a way to query some kind of database regularly (daily?weekly? every 5 minutes?) to refresh the content on a Confluence page that displays details of the tables in your database.

What comes to mind is the app Pocket Query: https://marketplace.atlassian.com/apps/1211199/pocketquery-sql-rest-for-confluence?hosting=cloud&tab=overview although I don't know if it meets your needs. You will have to research the app.

There may be other apps on the Marketplace that could help as well; I suggest you search and try out a few.

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
PRODUCT PLAN
PREMIUM
TAGS
AUG Leaders

Atlassian Community Events