# Class: BuiltInType

Class which represent a built-in PostgreSQL type. Provides attributes and methods for details of the built-in type.

# Hierarchy



# Properties

# category

category: TypeCategory

Defined in pg-structure/type/built-in-type.ts:39

An arbitrary classification of PostgreSQL data types that is used by the PostgreSQL parser to determine which implicit casts should be “preferred”. See related doc here

# classOid

classOid: number

Inherited from Type.classOid

Defined in pg-structure/base/type.ts:24

Object identifier of PostgreSQL class (pg_catalog.pg_class) for the Entity

# Optional comment

comment? : undefined | string

Inherited from DbObject.comment

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

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

# hasLength

hasLength: boolean

Defined in pg-structure/type/built-in-type.ts:42

Whether the type has length property.

# hasPrecision

hasPrecision: boolean

Defined in pg-structure/type/built-in-type.ts:48

Whether the type has precision property.

# hasScale

hasScale: boolean

Defined in pg-structure/type/built-in-type.ts:45

Whether the type has scale property.

# internalName

internalName: string

Defined in pg-structure/type/built-in-type.ts:31

# name

name: string

Inherited from DbObject.name

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

Name of the database object.

# oid

oid: number

Inherited from Type.oid

Defined in pg-structure/base/type.ts:21

Object identifier for the Entity

# schema

schema: Schema

Inherited from Type.schema

Overrides DbObject.schema

Defined in pg-structure/base/type.ts:29

Schema this type belongs to.

# shortName

shortName: string

Overrides Type.shortName

Defined in pg-structure/type/built-in-type.ts:32

# Accessors

# commentData

get commentData(): JSONData | undefined

Inherited from DbObject.commentData

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

Data which is extracted from database object's comment. Data is extracted from text between special case-insesitive 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: JSONData | undefined

# commentWithoutData

get commentWithoutData(): string | undefined

Inherited from DbObject.commentWithoutData

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

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: string | undefined

# db

get db(): Db

Inherited from DbObject.db

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

Database of the database object.

Returns: Db

# fullCatalogName

get fullCatalogName(): string

Inherited from DbObject.fullCatalogName

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

Full name of the database object including database name.

Returns: string

# fullName

get fullName(): string

Inherited from Type.fullName

Overrides DbObject.fullName

Defined in pg-structure/base/type.ts:37

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

# Example

const fullName = type.fullName; // public.phone_number

Returns: string

# nameCaseType

get nameCaseType(): CaseType

Inherited from DbObject.nameCaseType

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

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

Inherited from DbObject.separator

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

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

Returns: string