Support shortName table property for Markdown templates

[reteps]

Currently, there is no good way to distinguish the full table name from the schema for certain database types. The table name is reported as schema.table_name. I would propose a ShortName property that resolves to table_name. This is useful for custom markdown templates where you would like additional flexibility in what you are rendering.

Part of #727

[k1LoW]

Thank you for your proposal!

We cannot accept the proposal as this would complicate implementation.

Consider a workaround such as modifying the generated Markdown or generating documentation from the modified schema.json.

[reteps]

Can you elaborate more on how this complicates implementation? This is a 1 line diff in each provider.

[k1LoW]

It affects schema.json, and the condition of whether or not shortName is issued appears in various places. It also affects third-party tools that use tbls as a package.

[reteps]

It affects schema.json

Yes, but how is that an issue? AFAIK schema.json is not a stable format, and receives updates.

the condition of whether or not shortName is issued appears in various places.

Yes, that is the change I have already made.

It also affects third-party tools that use TBLs as a package.

Can you please provide any example of a tool that uses TBLS as a package that would break because of this change?

[k1LoW]

Can you please provide any example of a tool that uses TBLS as a package that would break because of this change?

• https://liambx.com/
• https://github.com/k1LoW/tbls-meta
• https://github.com/shellyln/tbls-driver-sf-cli-meta
• https://github.com/k1LoW/tbls-ask

These use the tbls and schema.json mechanisms.

See #732 (comment)