Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ability to parse .sql files like views #72

Open
vitodcampanelli opened this issue Nov 23, 2017 · 1 comment
Open

Add ability to parse .sql files like views #72

vitodcampanelli opened this issue Nov 23, 2017 · 1 comment

Comments

@vitodcampanelli
Copy link

I would like to be able to create documentation for views as well.
It would be nice if it would be able to get the fields from the select list or the ability to add the fields manually.
I tried to use the template package.md for .sql but all that display is the description.
I would like to be able to do something like this:

/**
 * View is used for ..........
 *
 * @field field1 maybe ability to description of field
 * @field field2 maybe ability to description of field
 *
 * @author John Doe
 * @created 23-Nov-2017
 */

Thanks

@vitodcampanelli
Copy link
Author

/**
 * View is used to see the employee details. 
 *
 * @issue #123
 *
 * @field id the primary key
 * @field start_date the employee's start date
 * @field end_date the employee's end date
 *
 * @author John Doe
 * @created 23-Nov-2017
 */
create or replace view v_table
as
select    id,
          start_date,
          end_date
from table
where ....

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant