IF Commons GitHub

sql/extensions/documentation/mod

Written to: 2 requirements: 2 proved, 0 partly, 0 failing, 0 with no test recorded. 0008-sql-documentation FR-005, 0008-sql-documentation FR-006

The documentation extensions (commons data 0008-sql-documentation): the comments, the documentation tables and the governance tables, three extensions that each contribute a statement source to the physical schema, all on by default. defaultDocumentation is the three, which a project drops from or replaces in; documentationSources gives the same sources where the engine is not used; the settings say where each is on.

import { bind } from "@intellectual-frontiers/data/sql/physical";
import { documentationSources } from "@intellectual-frontiers/data/sql/extensions/documentation";
bind(schema, { dialect, sources: documentationSources() });

Source: commons/data/sql/extensions/documentation/mod.ts

2 of 2 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

documentationSourcesfunction
function documentationSources(given?: (Partial<Omit<DocumentationSettings, "names">> & { readonly names?: Partial<TableNames> | undefined; }) | undefined): readonly StatementSource[]

The three sources, in the order their statements are added: the comments, the documentation table, the governance tables.

ParameterWhat it is
givenwhat a project says of the settings; the rest is the default

Returns: the sources

Imported by 42 tests of the run (42 passed, 0 failed): the library's results

defaultDocumentationfunction
function defaultDocumentation(given?: (Partial<Omit<DocumentationSettings, "names">> & { readonly names?: Partial<TableNames> | undefined; }) | undefined, version?: string): Result<readonly Extension[], IdError>

The three extensions, sql.documentation.comments, sql.documentation.tables and sql.documentation.governance, which are the default documentation of a project.

ParameterWhat it is
givenwhat a project says of the settings; the rest is the default
versionthe extensions' version

Returns: the extensions, or why an identifier is not one

Imported by 11 tests of the run (11 passed, 0 failed): the library's results

Titles, headings, exports, tables, columns and requirements. Esc closes.