Class GEOGRAPHY

Geography - for geographic/spatial data (uses WGS84 coordinate system) Unlike GEOMETRY, GEOGRAPHY performs calculations using spherical geography

Example

// Basic geography (defaults to WGS84 - SRID 4326)
location: DataTypes.GEOGRAPHY

// Geography with specific type
point: DataTypes.GEOGRAPHY('POINT')
area: DataTypes.GEOGRAPHY('POLYGON', 4326)

// Geography with type and custom SRID
// 4326 = WGS 84 (most common)
// 3857 = Web Mercator
region: DataTypes.GEOGRAPHY('MULTIPOLYGON', 4326)

Hierarchy (View Summary)

AbstractDataType
- GEOGRAPHY

Index

Constructors

constructor

new GEOGRAPHY(type?: GeometryType, srid?: number): GEOGRAPHY
Parameters
- Optionaltype: GeometryType
- Optionalsrid: number
Returns GEOGRAPHY
Overrides AbstractDataType.constructor
- Defined in models/data-types.ts:1929
new GEOGRAPHY(options?: { type?: GeometryType; srid?: number }): GEOGRAPHY
Parameters
- Optionaloptions: { type?: GeometryType; srid?: number }
Returns GEOGRAPHY
Overrides AbstractDataType.constructor
- Defined in models/data-types.ts:1930

Properties

key

key: "GEOGRAPHY" = ...

`Optional`type

type?: GeometryType

The geography type (POINT, LINESTRING, POLYGON, etc.)

`Optional`srid

srid?: number

SRID (Spatial Reference System Identifier) Default is 4326 (WGS 84) Only 4326 (WGS84) is officially supported by PostGIS for geography

Methods

toSQL

toSQL(): string
Returns string
Inherited from AbstractDataType.toSQL
- Defined in models/data-types.ts:18

toSql

toSql(): string
Returns string
Inherited from AbstractDataType.toSql
- Defined in models/data-types.ts:23

equals

equals(other: DataTypeAbstract): boolean
Compare this DataType with another DataType for equality
Parameters
- other: DataTypeAbstract
  The DataType to compare with
Returns boolean
true if the types are equal, false otherwise
Inherited from AbstractDataType.equals
- Defined in models/data-types.ts:32

serialize

serialize(value: unknown): unknown
Serialize a value for storage based on this DataType
Parameters
- value: unknown
  The value to serialize
Returns unknown
The serialized value
Inherited from AbstractDataType.serialize
- Defined in models/data-types.ts:44

getGeographyType

getGeographyType(): string | undefined
Get the geography type in uppercase

Returns string | undefined
- Defined in models/data-types.ts:1956

getSRID

getSRID(): number
Get the SRID (defaults to 4326 for WGS84)

Returns number
- Defined in models/data-types.ts:1963

toSqlString

toSqlString(dialect?: string): string
Parameters
- Optionaldialect: string
Returns string
Overrides AbstractDataType.toSqlString
- Defined in models/data-types.ts:1967

Class GEOGRAPHY

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GEOGRAPHY

Parameters

Returns GEOGRAPHY

Properties

key

`Optional`type

`Optional`srid

Methods

toSQL

Returns string

toSql

Returns string

equals

Parameters

Returns boolean

serialize

Parameters

Returns unknown

getGeographyType

Returns string | undefined

getSRID

Returns number

toSqlString

Parameters

Returns string

Settings

On This Page

Class GEOGRAPHY

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GEOGRAPHY

Parameters

Returns GEOGRAPHY

Properties

key

Optionaltype

Optionalsrid

Methods

toSQL

Returns string

toSql

Returns string

equals

Parameters

Returns boolean

serialize

Parameters

Returns unknown

getGeographyType

Returns string | undefined

getSRID

Returns number

toSqlString

Parameters

Returns string

Settings

On This Page

`Optional`type

`Optional`srid