Comment of the database object defined in database including {@link DbObject#commentData comment data}.
The @{link Index index}} supporting this constraint.
Name of the database object.
Table which this constraint defined in.
Data which is extracted from database object's comment. Data is extracted from text between special case-insensitive tag
(default: [pg-structure][/pg-structure]) and converted to JavaScript object using JSON5.
Token name can be specified by using commentDataToken arguments.
For details of JSON5, see it's web site: https://json5.org.
// "Account details. [pg-structure]{ extraData: 2 }[/pg-structure] Also used for logging."
table.comment; // "Account details. [pg-structure]{ extraData: 2 }[/pg-structure] Also used for logging."
table.commentWithoutData; // "Account details. Also used for logging."
table.commentData; // { extraData: 2 }
table.commentData.extraData; // 2
Description or comment of the database object defined in database. If comment contains {@link DbObject#commentData comment data}, it is removed.
// "Account details. [pg-structure]{ extraData: 2 }[/pg-structure] Also used for logging."
table.commentWithoutData; // "Account details. Also used for logging."
Full name of the database object including database name.
Full name of the constraint including table name.
Letter casing (i.e snakeCase or camelCase) of the database object name.
const name = entity.name; // ProductDetail
const caseType = entity.nameCaseType; // camelCase
const otherEntity = otherEntity.name; // member_protocol
const otherCaseType = otherEntity.nameCaseType; // snakeCase
Schema of the constraint's table defined in.
Separator used in database object name. Empty string for came case and underscore for (_) snake case.
Generated using TypeDoc
Class which represent a PostgreSQL exclusion constraint. Provides attributes and methods related to constraint.