Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Entity

Class which represent an entity (table, view etc.). Provides attributes and methods for details of the entity.

Hierarchy

Index

Properties

Accessors

Methods

Properties

Readonly columns

columns: default<Column, "name", "attributeNumber", true> = ...

All columns of the entity as an {@link IndexableArray indexable array} ordered by same order they are defined in database entity.

Example

 
const isAvailable  = table.columns.has('id');
const columnNames  = table.columns.map(column => column.name);
const column       = table.columns.get('user_id');
const name         = column.name;

table.columns.forEach(column => console.log(column.name));
name

Entity#columns

Optional Readonly comment

comment: undefined | string

Comment of the database object defined in database including {@link DbObject#commentData comment data}.

Readonly name

name: string

Name of the database object.

Readonly oid

oid: number

Object identifier for the Entity

Readonly schema

schema: Schema

Schema of the object.

Accessors

commentData

  • get commentData(): undefined | null | string | number | boolean | JSONObject | JSONArray

  • 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.

    Example

     
    // "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

    Returns undefined | null | string | number | boolean | JSONObject | JSONArray

commentWithoutData

  • get commentWithoutData(): undefined | string

  • Description or comment of the database object defined in database. If comment contains {@link DbObject#commentData comment data}, it is removed.

    Example

     
    // "Account details. [pg-structure]{ extraData: 2 }[/pg-structure] Also used for logging."
table.commentWithoutData;    // "Account details.  Also used for logging."

    Returns undefined | string

db

  • get db(): Db

  • Database of the database object.

    Returns Db

fullCatalogName

  • get fullCatalogName(): string

  • Full name of the database object including database name.

    Returns string

fullName

  • get fullName(): string

  • Full name of the object with '.' notation including Schema name.

    Example

     
    const fullName = entity.fullName; // public.member

    Returns string

nameCaseType

  • Letter casing (i.e snakeCase or camelCase) of the database object name.

    Example

     
    const name = entity.name;                        // ProductDetail
const caseType = entity.nameCaseType;            // camelCase

const otherEntity = otherEntity.name;            // member_protocol
const otherCaseType = otherEntity.nameCaseType;  // snakeCase

    Returns CaseType

separator

  • get separator(): string

  • Separator used in database object name. Empty string for came case and underscore for (_) snake case.

    Returns string

Methods

get

  • Returns column with given name from entity.

    Example

     
    const column = entity.get('contact'),  // Returns contact column from entity.

    Parameters

    • column: string

    Returns Column

    requested columns.

Generated using TypeDoc