# Class: Table

# Hierarchy

Entity

Table

# Properties

# columns

columns: IndexableArray‹Column, "name", "attributeNumber", true› = IndexableArray.throwingFrom( [], "name", "attributeNumber" )

Inherited from Entity.columns

Defined in pg-structure/base/entity.ts:55


# Optional comment

comment? : undefined | string

Inherited from DbObject.comment

Defined in pg-structure/base/db-object.ts:75


# constraints

constraints: IndexableArray‹Constraint, "name", never, true› = IndexableArray.throwingFrom([], "name")

Defined in pg-structure/entity/table.ts:29


# foreignKeysToThis

foreignKeysToThis: IndexableArray‹ForeignKey, "name", never, true› = IndexableArray.throwingFrom([], "name")

Defined in pg-structure/entity/table.ts:36


# indexes

indexes: IndexableArray‹Index, "name", never, true› = IndexableArray.throwingFrom([], "name")

Defined in pg-structure/entity/table.ts:41


# name

name: string

Inherited from DbObject.name

Defined in pg-structure/base/db-object.ts:42


# oid

oid: number

Inherited from Entity.oid

Defined in pg-structure/base/entity.ts:25


# schema

schema: Schema

Inherited from Entity.schema

Overrides DbObject.schema

Defined in pg-structure/base/entity.ts:40

# Accessors

# belongsToManyTables

belongsToManyTables:

Defined in pg-structure/entity/table.ts:161


# belongsToManyTablesPk

belongsToManyTablesPk:

Defined in pg-structure/entity/table.ts:178


# belongsToTables

belongsToTables:

Defined in pg-structure/entity/table.ts:145


# checkConstraints

checkConstraints:

Defined in pg-structure/entity/table.ts:98


# commentData

commentData:

Inherited from DbObject.commentData

Defined in pg-structure/base/db-object.ts:102


# commentWithoutData

commentWithoutData:

Inherited from DbObject.commentWithoutData

Defined in pg-structure/base/db-object.ts:85


# db

db:

Inherited from DbObject.db

Defined in pg-structure/base/db-object.ts:68


# exclusionConstraints

exclusionConstraints:

Defined in pg-structure/entity/table.ts:105


# foreignKeys

foreignKeys:

Defined in pg-structure/entity/table.ts:84


# fullCatalogName

fullCatalogName:

Inherited from DbObject.fullCatalogName

Defined in pg-structure/base/db-object.ts:35


# fullName

fullName:

Inherited from Entity.fullName

Overrides DbObject.fullName

Defined in pg-structure/base/entity.ts:33


# hasManyTables

hasManyTables:

Defined in pg-structure/entity/table.ts:130


# m2mRelations

m2mRelations:

Defined in pg-structure/entity/table.ts:188


# m2mRelationsPk

m2mRelationsPk:

Defined in pg-structure/entity/table.ts:200


# m2oRelations

m2oRelations:

Defined in pg-structure/entity/table.ts:218


# nameCaseType

nameCaseType:

Inherited from DbObject.nameCaseType

Defined in pg-structure/base/db-object.ts:54


# o2mRelations

o2mRelations:

Defined in pg-structure/entity/table.ts:209


# primaryKey

primaryKey:

Defined in pg-structure/entity/table.ts:116


# relations

relations:

Defined in pg-structure/entity/table.ts:226


# separator

separator:

Inherited from DbObject.separator

Defined in pg-structure/base/db-object.ts:61


# uniqueConstraints

uniqueConstraints:

Defined in pg-structure/entity/table.ts:91

# Methods

# get

get(column: string): Column

Overrides Entity.get

Defined in pg-structure/entity/table.ts:274

Parameters:

Name Type
column string

Returns: Column

requested columns.


# getForeignKeysFrom

getForeignKeysFrom(from: Table | string): IndexableArray‹ForeignKey, "name", never, true›

Defined in pg-structure/entity/table.ts:60

Parameters:

Name Type Description
from Table | string is table to get foreign keys targeting this table. It could be name, full name or table object.

Returns: IndexableArray‹ForeignKey, "name", never, true›

foreign keys from given table to this table.


# getForeignKeysTo

getForeignKeysTo(target: Table | string): IndexableArray‹ForeignKey, "name", never, true›

Defined in pg-structure/entity/table.ts:49

Parameters:

Name Type Description
target Table | string is target table to get foreign keys for. It could be name, full name or table object.

Returns: IndexableArray‹ForeignKey, "name", never, true›

foreign keys from this table to target table.


# getJoinTablesTo

getJoinTablesTo(target: Table | string): IndexableArray‹Table, "name", never, true›

Defined in pg-structure/entity/table.ts:70

Parameters:

Name Type Description
target Table | string is target table to get join tables for. It could be name, full name or table object.

Returns: IndexableArray‹Table, "name", never, true›