docs: document how to know the child tables, columns and unnest columns names
Opened this issue · 7 comments
eg in: https://open-contracting.github.io/spoonbill/cli.html#exclude-child-tables, https://open-contracting.github.io/spoonbill/cli.html#choose-columns, and https://open-contracting.github.io/spoonbill/cli.html#unnest-columns-from-child-tables-into-parent-tables document how the user can know all the available tables and columns names
I think this information is collected at the analysis stage, so perhaps we can add some commands/options to list the available tables/columns. Is that what you had in mind, @yolile ? Or were you thinking something simpler, like adding a link in the docs to the standard documentation (which would only cover core tables/fields)?
@jpmckinney for column names I was thinking of documenting the path names format pattern, referring to the standard documentation to know all the available fields, and same for the child tables (especially for this case, eg documenting that the child table name format is something like parent-object-in-plural_{object-name|array_name_in_plural}_field-name etc. But having a command option to list all the available tables and columns will be even better.
Sounds good. The longer solution might depend on #132, but you and I can do the docs changes for now.
@yshalenyk Would that depend on #132 being closed first?
Well, list of tables based on pure OCDS 1.1 by default, and I don`t see users change it too much, so probably this list is pretty much static. So I think It would do (at least for now) if we just put up simple table in documentation with table name, table description and maybe list of paths this table is constructed from and omit #132.