CommentsSettingtypeno test imports ittype CommentsSetting = "dialect" | "never";Whether descriptions are written as COMMENT ON where the dialect has it.
The settings of the documentation extensions (commons data 0008-sql-documentation FR-005): a typed value, never a file. The comments are written where the dialect has COMMENT ON; the documentation tables where it has none (the default), everywhere, or nowhere; the governance tables everywhere unless they are off. A setting that is not given is its default.
CommentsSettingtypeno test imports ittype CommentsSetting = "dialect" | "never";Whether descriptions are written as COMMENT ON where the dialect has it.
defaultSettingsconstconst defaultSettings: DocumentationSettingsThe defaults: all three on, the documentation tables where there is no COMMENT ON.
DocumentationSettingsinterfaceno test imports itinterface DocumentationSettingsThe settings of the three extensions.
| Member | Type | What it is |
|---|---|---|
comments | CommentsSetting | |
documentationTables | DocumentationTablesSetting | |
governanceTables | GovernanceTablesSetting | |
names | TableNames |
DocumentationTablesSettingtypeno test imports ittype DocumentationTablesSetting = "when-no-comment" | "always" | "never";Where descriptions are also kept in a table.
GovernanceTablesSettingtypeno test imports ittype GovernanceTablesSetting = "on" | "off";Whether what governance says is kept in tables.
settingsOffunctionfunction settingsOf(given?: Partial<Omit<DocumentationSettings, "names">> & { readonly names?: Partial<TableNames> | undefined; }): DocumentationSettingsThe settings with what is given over the defaults.
| Parameter | What it is |
|---|---|
given | what a project says; the rest is the default |
Returns: the settings
TableNamesinterfaceno test imports itinterface TableNamesThe names of the tables, as governance writes a name (lower camel case); the case style writes them in the database.
| Member | Type | What it is |
|---|---|---|
documentation | string | |
governanceAnnotation | string | |
governanceTrace | string |
defaultsconstconst defaults: DocumentationSettingsThe defaults: all three on, the documentation tables where there is no COMMENT ON.