Welcome to Software Development on Codidact!
Will you help us build our independent community of developers helping developers? We're small and trying to grow. We welcome questions about all aspects of software development, from design to code to QA and more. Got questions? Got answers? Got code you'd like someone to review? Please join us.
Post History
I have some SQL scripts that contain DDL to create tables and schemas for a database. I'd like to be able to comment this SQL and then use those comments to generate output documentation (in HTML)...
#4: Post edited
by
Monica Cellio
·
2020-10-19T16:02:19Z (over 3 years ago)
responding to comments
What documentation-generation tools exist for SQL DDL?
- How can I generate documentation from comments in SQL DDL?
I have some SQL scripts that contain DDL to create tables and schemas for a database. I'd like to be able to comment this SQL and then use those comments to generate output documentation (in HTML) for users of the database. The specific purpose is to include schema documentation in published examples for a SQL platform -- so we want to, for example, describe a sample database and then use it to support examples of other queries, functions, etc. The consumers of the documentation are not necessarily *using* this DDL (unless they run our scripts to set it up for themselves).I'm thinking of something like Doxygen, but for SQL -- I want to be able to document the purpose of each table and table column, and have the output be nicely organized with a summary at the top and links to the specific tables (like the summary of methods on a class in Doxygen output).To what extent is this a solved problem? I'd like to use something that exists rather than writing it myself. If it matters, the SQL is a member of the PostgreSQL family.
- I have some SQL scripts that contain DDL to create tables and schemas for a database. I'd like to be able to comment this SQL and then use those comments to generate output documentation (in HTML). I want to be able to document the purpose of each table and table column, and have the output be nicely organized with a summary at the top and links to the specific tables (like the summary of methods on a class in Doxygen output). If it matters, the SQL is a member of the PostgreSQL family.
- The specific purpose is to include schema documentation in published examples for a SQL platform -- so we want to, for example, describe a sample database and then use it to support examples of other queries, functions, etc. (I could imagine this also being used to give documentation to non-DBAs who are configuring BI tools on top of a database, but that is not my use case.)
- The consumers of the documentation are not necessarily *using* this DDL (unless they run our scripts to set it up for themselves). We are currently documenting the tables by hand, which opens the door to the doc and DDL becoming out of sync in the future.
- How can I go about generating this kind of comment-driven documentation?
#3: Post edited
by
Monica Cellio
·
2020-10-19T12:49:36Z (over 3 years ago)
I have some SQL scripts that contain DDL to create tables and schemas for a database. I'd like to be able to comment this SQL and then use those comments to generate output documentation (in HTML) for users of the database. (The specific purpose is to include schema documentation in published SQL examples.)- I'm thinking of something like Doxygen, but for SQL -- I want to be able to document the purpose of each table and table column, and have the output be nicely organized with a summary at the top and links to the specific tables (like the summary of methods on a class in Doxygen output).
- To what extent is this a solved problem? I'd like to use something that exists rather than writing it myself. If it matters, the SQL is a member of the PostgreSQL family.
- I have some SQL scripts that contain DDL to create tables and schemas for a database. I'd like to be able to comment this SQL and then use those comments to generate output documentation (in HTML) for users of the database. The specific purpose is to include schema documentation in published examples for a SQL platform -- so we want to, for example, describe a sample database and then use it to support examples of other queries, functions, etc. The consumers of the documentation are not necessarily *using* this DDL (unless they run our scripts to set it up for themselves).
- I'm thinking of something like Doxygen, but for SQL -- I want to be able to document the purpose of each table and table column, and have the output be nicely organized with a summary at the top and links to the specific tables (like the summary of methods on a class in Doxygen output).
- To what extent is this a solved problem? I'd like to use something that exists rather than writing it myself. If it matters, the SQL is a member of the PostgreSQL family.
#2: Post edited
by
Monica Cellio
·
2020-10-19T03:50:46Z (over 3 years ago)
What documentation-generation tools exist for SQL?
- What documentation-generation tools exist for SQL DDL?
#1: Initial revision
by
Monica Cellio
·
2020-10-18T21:31:59Z (over 3 years ago)
What documentation-generation tools exist for SQL?
I have some SQL scripts that contain DDL to create tables and schemas for a database. I'd like to be able to comment this SQL and then use those comments to generate output documentation (in HTML) for users of the database. (The specific purpose is to include schema documentation in published SQL examples.) I'm thinking of something like Doxygen, but for SQL -- I want to be able to document the purpose of each table and table column, and have the output be nicely organized with a summary at the top and links to the specific tables (like the summary of methods on a class in Doxygen output). To what extent is this a solved problem? I'd like to use something that exists rather than writing it myself. If it matters, the SQL is a member of the PostgreSQL family.