Class GEOGRAPHY

A geography datatype represents two dimensional spacial objects in an elliptic coord system.

The difference from geometry and geography type:

PostGIS 1.5 introduced a new spatial type called geography, which uses geodetic measurement instead of Cartesian measurement. Coordinate points in the geography type are always represented in WGS 84 lon lat degrees (SRID 4326), but measurement functions and relationships STDistance, STDWithin, STLength, and STArea always return answers in meters or assume inputs in meters.

What is best to use? It depends:

When choosing between the geometry and geography type for data storage, you should consider what you’ll be using it for. If all you do are simple measurements and relationship checks on your data, and your data covers a fairly large area, then most likely you’ll be better off storing your data using the new geography type. Although the new geography data type can cover the globe, the geometry type is far from obsolete. The geometry type has a much richer set of functions than geography, relationship checks are generally faster, and it has wider support currently across desktop and web-mapping tools

Fallback policy: If this type is not supported, an error will be raised.

Example: Defining a Geography type attribute

DataTypes.GEOGRAPHY
DataTypes.GEOGRAPHY('POINT')
DataTypes.GEOGRAPHY('POINT', 4326)

Hierarchy (View Summary)

GEOMETRY
- GEOGRAPHY

Constructors

constructor

new GEOGRAPHY(type?: GeoJsonType, srid?: number): GEOGRAPHY
Parameters
- Optionaltype: GeoJsonType
  Type of geometry data
- Optionalsrid: number
  SRID of type
Returns GEOGRAPHY
Inherited from GEOMETRY.constructor
- Defined in packages/core/src/abstract-dialect/data-types.ts:2572
new GEOGRAPHY(options: GeometryOptions): GEOGRAPHY
Parameters
- options: GeometryOptions
Returns GEOGRAPHY
Inherited from GEOMETRY.constructor
- Defined in packages/core/src/abstract-dialect/data-types.ts:2573

Properties

`Readonly`options

options: GeometryOptions

usageContext

usageContext: undefined | DataTypeUseContext

Where this DataType is being used.

Methods

`Protected`_checkOptionSupport

_checkOptionSupport(dialect: AbstractDialect): void
Override this method to emit an error or a warning if the Data Type, as it is configured, is not compatible with the current dialect.
Parameters
- dialect: AbstractDialect
  The dialect using this data type.
Returns void
Overrides GEOMETRY._checkOptionSupport
- Defined in packages/core/src/abstract-dialect/data-types.ts:2646

`Protected`_construct

_construct<Constructor extends new () => ABSTRACT<any>>(
...args: ConstructorParameters<Constructor>,
): this
Type Parameters
- Constructor extends new () => ABSTRACT<any>
Parameters
- ...args: ConstructorParameters<Constructor>
Returns this
Inherited from GEOMETRY._construct
- Defined in packages/core/src/abstract-dialect/data-types.ts:159

`Protected`_getDialect

_getDialect(): AbstractDialect
Returns AbstractDialect
Inherited from GEOMETRY._getDialect
- Defined in packages/core/src/abstract-dialect/data-types.ts:108

acceptsNull

acceptsNull(): boolean
Whether this DataType wishes to handle NULL values itself. This is almost exclusively used by JSON and JSONB which serialize null as the JSON string 'null'.

Returns boolean
Inherited from GEOMETRY.acceptsNull
- Defined in packages/core/src/abstract-dialect/data-types.ts:177

areValuesEqual

areValuesEqual(value: GeoJson, originalValue: GeoJson): boolean
Parameters
- value: GeoJson
- originalValue: GeoJson
Returns boolean
Inherited from GEOMETRY.areValuesEqual
- Defined in packages/core/src/abstract-dialect/data-types.ts:169

belongsToDialect

belongsToDialect(dialect: AbstractDialect): boolean
Parameters
- dialect: AbstractDialect
Returns boolean
Inherited from GEOMETRY.belongsToDialect
- Defined in packages/core/src/abstract-dialect/data-types.ts:291

clone

clone(): this
Returns a copy of this DataType, without usage context. Designed to re-use a DataType on another Model.

Returns this
Inherited from GEOMETRY.clone
- Defined in packages/core/src/abstract-dialect/data-types.ts:333

escape

escape(value: GeoJson): string
Escapes a value for the purposes of inlining it in a SQL query. The resulting value will be inlined as-is with no further escaping.
Parameters
- value: GeoJson
  The value to escape.
Returns string
Inherited from GEOMETRY.escape
- Defined in packages/core/src/abstract-dialect/data-types.ts:219

getBindParamSql

getBindParamSql(value: GeoJson, options: BindParamOptions): string
This method is called when AbstractQueryGenerator needs to add a bind parameter to a query it is building. This method allows for customizing both the SQL to add to the query, and convert the bind parameter value to a DB-compatible value.

If you only need to prepare the bind param value, implement toBindableValue instead.

This method must return the SQL to add to the query. You can obtain a bind parameter ID by calling BindParamOptions#bindParam with the value associated to that bind parameter.

An example of a data type that requires customizing the SQL is the GEOMETRY data type.
Parameters
- value: GeoJson
  The value to bind.
- options: BindParamOptions
  Options.
Returns string
Inherited from GEOMETRY.getBindParamSql
- Defined in packages/core/src/abstract-dialect/data-types.ts:245

getDataTypeId

getDataTypeId(): string
Returns string
Inherited from GEOMETRY.getDataTypeId
- Defined in packages/core/src/abstract-dialect/data-types.ts:97

parseDatabaseValue

parseDatabaseValue(value: unknown): unknown
Called when a value is retrieved from the Database, and its DataType is specified. Used to normalize values from the database.

Note: It is also possible to do an initial parsing of a Database value using AbstractDialect#registerDataTypeParser. That normalization uses the type ID from the database instead of a Sequelize Data Type to determine which parser to use, and is called before this method.
Parameters
- value: unknown
  The value to parse.
Returns unknown
Inherited from GEOMETRY.parseDatabaseValue
- Defined in packages/core/src/abstract-dialect/data-types.ts:191

sanitize

sanitize(value: unknown): unknown
Used to normalize a value when Model#set is called. That is, when a user sets a value on a Model instance.
Parameters
- value: unknown
Returns unknown
Inherited from GEOMETRY.sanitize
- Defined in packages/core/src/abstract-dialect/data-types.ts:201

toBindableValue

toBindableValue(value: GeoJson): unknown
Converts a JS value to a value compatible with the connector library for this Data Type. Unlike escape, this value does not need to be escaped. It is passed separately to the database, which will handle escaping.
Parameters
- value: GeoJson
  The value to convert.
Returns unknown
Inherited from GEOMETRY.toBindableValue
- Defined in packages/core/src/abstract-dialect/data-types.ts:257

toDialectDataType

toDialectDataType(dialect: AbstractDialect): this
Returns this DataType, using its dialect-specific subclass.
Parameters
- dialect: AbstractDialect
Returns this
Inherited from GEOMETRY.toDialectDataType
- Defined in packages/core/src/abstract-dialect/data-types.ts:300

toSql

toSql(): string
Returns a SQL declaration of this data type. e.g. 'VARCHAR(255)', 'TEXT', etc…

Returns string
Overrides GEOMETRY.toSql
- Defined in packages/core/src/abstract-dialect/data-types.ts:2652

toString

toString(): string
Returns string
Inherited from GEOMETRY.toString
- Defined in packages/core/src/abstract-dialect/data-types.ts:261

validate

validate(value: unknown): asserts value is GeoJson
Checks whether the JS value is compatible with (or can be converted to) the SQL data type. Throws if that is not the case.
Parameters
- value: unknown
Returns asserts value is GeoJson
Inherited from GEOMETRY.validate
- Defined in packages/core/src/abstract-dialect/data-types.ts:2594

Class GEOGRAPHY

Example: Defining a Geography type attribute

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GEOGRAPHY

Parameters

Returns GEOGRAPHY

Properties

Readonlyoptions

usageContext

Methods

Protected_checkOptionSupport

Parameters

Returns void

Protected_construct

Type Parameters

Parameters

Returns this

Protected_getDialect

Returns AbstractDialect

acceptsNull

Returns boolean

areValuesEqual

Parameters

Returns boolean

belongsToDialect

Parameters

Returns boolean

clone

Returns this

escape

Parameters

Returns string

getBindParamSql

Parameters

Returns string

getDataTypeId

Returns string

parseDatabaseValue

Parameters

Returns unknown

sanitize

Parameters

Returns unknown

toBindableValue

Parameters

Returns unknown

toDialectDataType

Parameters

Returns this

toSql

Returns string

toString

Returns string

validate

Parameters

Returns asserts value is GeoJson

withUsageContext

Parameters

Returns this

StaticgetDataTypeId

Returns string

StatictoString

Returns string

Settings

On This Page

`Readonly`options

`Protected`_checkOptionSupport

`Protected`_construct

`Protected`_getDialect

`Static`getDataTypeId

`Static`toString