Query Documentation

[Felgar]

This is something that I've been sort of struggling with for a while now. I work at a software company, and so the situation often arises where we need to tweak someone else's query or where down the road our own queries will need to be completely understood by others.

So I'm wondering if anyone has any good solutions in terms of how a query/view can be documented. Views are even a more complex issue because they often cascade down a number of levels. But even some recursive queries can be fairly tough to fully understand by just looking the query itself over.

Any thoughts/ideas?

 

[sem]

The most popular way of documenting views (as well as tables) is adding COMMENTS.

COMMENT ON COLUMN foo.bar IS 'This is bar colum of table foo and its meaning is outstanding'

View code may be queried from all_views, thus in this way it's self-documented (using comments in code).

Though to use this comments your customer should at least be aware of their existence Regards, Dima