Add command switch to include/exclude schemas for which to generate documentation

[zam6ak]

Hi

In large DBs it is often desirable to specify which schemas to include (or exclude) when generating documentation.
You could have several apps that share DB but use separate schemas.
In this case each application could use this switch to produce docs that are relevant only for that app.

Additionally, with this option you could also re-run the tool with different output folders specifying different schema each time if needed.

Thanks
Z

[k1LoW]

Hi @zam6ak

Have you tried the --include/--exclude option?

[zam6ak]

@k1LoW

Have you tried the --include/--exclude option?

I tried running updated container 1.64.1
It took me couple of attempts to figure out the format, but following seems to work:
--include "public.*" (to include all tables in public schema)
--include "public.*,myapp1.*" (to include all tables in schemas: public and myapp1)
--exclude "extensions.*" (to exclude all tables from extensions schema)

When I tried tbl doc --help this is what it says for --include/--exclude

--exclude strings    tables to exclude
--include strings    tables to include

It may be beneficial to update docs/usage on how to filter entire schemas (wildcard supported?)

Thanks for including this feature!
Z