Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Trigger

Class which represent a PostgreSQL trigger. Provides attributes and methods for details of the trigger.

Hierarchy

Index

Properties

Accessors

Properties

Optional Readonly comment

comment: undefined | string

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

Readonly condition

condition: null | string

WHEN condition of the trigger, null if none.

Readonly events

events: TriggerEvent[]

Events that fires the trigger.

Readonly function

function: NormalFunction

[[Function]] of trigger.

Readonly isDeferrable

isDeferrable: boolean

Whether constraint trigger is deferrable

Readonly isEnabled

isEnabled: TriggerEnabled

In which session_replication_role modes the trigger fires

Readonly isInitiallyDeferred

isInitiallyDeferred: boolean

Whether constraint trigger is initially deferred

Readonly name

name: string

Name of the database object.

Readonly oid

oid: number

Object identifier for the Trigger

Readonly orientation

orientation: TriggerOrientation

whether the trigger fires once for each processed row or once for each statement.

Readonly parent

parent: Table | View

Parent database object this trigger is defined in.

Readonly timing

timing: TriggerTiming

Time at which the trigger fires.

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 = trigger.fullName; // public.member.updated_at

    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

schema

  • Schema of the object.

    Returns Schema

separator

  • get separator(): string

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

    Returns string

table

  • get table(): undefined | Table

  • Table this trigger defined in if it belongs to a table.

    Example

     
    const table = trigger.table; // Table instance

    Returns undefined | Table

view

  • get view(): undefined | View

  • View this trigger defined in if it belongs to a view.

    Example

     
    const view = trigger.view; // View instance

    Returns undefined | View

Generated using TypeDoc