Some of you pointed out that documentation progress tracking should not include certain types of elements, namely primary and unique keys, foreign keys/relations and triggers. Here is your request.
We are investigating options to change this functionality to better suit your needs and to keep our tool simple at the same time. We can't seem to find a solution that would fit both requirements. Let us know on our forum if you came up with any idea.
However, there is a workaround. If you don't want the certain type to lower your documentation progress, you can set its description to an empty string (' '). You can do it programmatically with an SQL query run on your repository. You need to keep in mind that this will artificially increase documentation progress of your documentation.
Queries
- Please run queries below against your repository database
- Those queries will not remove your existing descriptions
Primary and unique keys
update unique_constraints
set description = ' '
from unique_constraints c
inner join tables t on c.table_id = t.table_id
inner join databases d on d.database_id = t.database_id
where d.title = 'AdventureWorks' -- your documentation title
and (c.description is null or c.description = '')
Relations
update tables_relations
set description = ' '
from tables_relations r
inner join tables t on r.pk_table_id = t.table_id
inner join databases d on d.database_id = t.database_id
where d.title = 'AdventureWorks' -- your documentation title
and (r.description is null or r.description = '')
Triggers
update triggers
set description = ' '
from triggers g
inner join tables t on g.table_id = t.table_id
inner join databases d on d.database_id = t.database_id
where d.title = 'AdventureWorks' -- your documentation title
and (g.description is null or g.description = '')