API reference#

Geography types#

Point

A geography type that represents a single coordinate with lat,lon or x,y,z values.

LineString

A geography type composed of one or more arc segments.

Polygon

A geography type representing an area that is enclosed by a linear ring.

Geography properties#

GeographyType

The enumeration of Geography types

is_geography(obj)

Returns True if the object is a Geography, False otherwise.

get_dimensions(geography)

Returns the inherent dimensionality of a geography.

get_type_id(geography)

Returns the type ID of a geography.

Geography creation#

is_prepared(geography)

Returns True if the geography object is "prepared", False otherwise.

prepare(geography)

Prepare a geography, improving performance of other operations.

destroy_prepared(geography)

Destroy the prepared part of a geography, freeing up memory.

Predicates#

equals(a, b)

Returns True if A and B are spatially equal.

intersects(a, b)

Returns True if A and B share any portion of space.

contains(a, b)

Returns True if B is completely inside A.

within(a, b)

Returns True if A is completely inside B.

disjoint(a, b)

Returns True if A boundaries and interior does not intersect at all with those of B.