Comment of the database object defined in database including {@link DbObject#commentData comment data}.
If true, this index supports an exclusion constraint.
If true, this index represents the primary key of the table ({@link Index#isUnique isUnique} is always true for primary keys.)
If true, this is a unique index. Please note that all unique constraints have a unique index created by PostgreSQL automatically, but unique indexes may not have unique constraint.
Name of the database object.
Object identifier for the Schema
Parent database object this column belongs to.
If index is a partial index, partial index expression
List of columns of index, in order their ordinal position
within the index. If index does not have any columns this is empty array.
Please note that, non reference expressions such as CONCAT(name, surname) is not included. To access expressions and
columns together use columnsAndExpressions method.
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 database object including parent name.
If true, this index is a partial index.
MaterializedView which this index belongs to.
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
Separator used in database object name. Empty string for came case and underscore for (_) snake case.
Generated using TypeDoc
Class which represent a database index. Provides attributes and methods for details of the index.