Geography

Angle

Takes three point GEOGRAPHY values, which represent two intersecting lines. Returns the angle between these lines. Point 2 and point 1 represent the first line and point 2 and point 3 represent the second line. The angle between these lines is in radians, in the range [0, 2pi). The angle is measured clockwise from the first line to the second line. –> learn more

ST_ANGLE(@geography, @geography_2, @geography_3)

Return type

float

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@geography_2	variable	any geography	true	-
@geography_3	variable	any geography	true	-

Area

Returns the area in square meters covered by the polygons in the input GEOGRAPHY –> learn more

ST_AREA(@geography)

Return type

float

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-

As GeoJSON

Returns the RFC 7946 compliant GeoJSON representation of the input GEOGRAPHY –> learn more

ST_ASGEOJSON(@geography)

Return type

string

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-

As text

Returns the WKT representation of an input GEOGRAPHY –> learn more

ST_ASTEXT(@geography)

Return type

string

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-

Azimuth

Takes two point GEOGRAPHY values, and returns the azimuth of the line segment formed by points 1 and 2. The azimuth is the angle in radians measured between the line from point 1 facing true North to the line segment from point 1 to point 2. –> learn more

ST_ANGLE(@geography, @geography_2)

Return type

float

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@geography_2	variable	any geography	true	-

Boundary

Returns a single GEOGRAPHY that contains the union of the boundaries of each component in the given input GEOGRAPHY. –> learn more

ST_BOUNDARY(@geography)

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-

Buffer

Returns a GEOGRAPHY that represents the buffer around the input GEOGRAPHY. This function is similar to ST_BUFFERWITHTOLERANCE, but you specify the number of segments instead of providing tolerance to determine how much the resulting geography can deviate from the ideal buffer radius. –> learn more

ST_BUFFER(@geography, @buffer_radius[, num_seg_quarter_circle => @num_seg_quarter_circle][, endcap => @endcap][, side => @side])

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@buffer_radius	variable or literal	any integer, float	true	-
@num_seg_quarter_circle	variable or literal	any integer, float	true	-
@endcap	enum	any of: ROUND, FLAT	false	(Round (default))
@side	enum	any of: BOTH, LEFT, RIGHT	false	(Both (default))

Buffer with tolerance

Returns a GEOGRAPHY that represents the buffer around the input GEOGRAPHY. This function is similar to ST_BUFFER, but you provide tolerance instead of segments to determine how much the resulting geography can deviate from the ideal buffer radius. –> learn more

ST_BUFFERWITHTOLERANCE(@geography, @buffer_radius, @tolerance_meters[, endcap => @endcap][, side => @side])

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@buffer_radius	variable or literal	any integer, float	true	-
@tolerance_meters	variable or literal	any integer, float	true	-
@endcap	enum	any of: ROUND, FLAT	false	(Round (default))
@side	enum	any of: BOTH, LEFT, RIGHT	false	(Both (default))

Centroid

Returns the centroid of the input GEOGRAPHY as a single point GEOGRAPHY. –> learn more

ST_CENTROID(@geography)

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-

Closest point

Returns a GEOGRAPHY containing a point on Geography 1 with the smallest possible distance to Geography 2. This implies that the distance between the point returned by ST_CLOSESTPOINT and Geography 2 is less than or equal to the distance between any other point on Geography 1 and Geography 2. –> learn more

ST_CLOSESTPOINT(@geography, @geography_2)

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@geography_2	variable	any geography	true	-

Contains

Returns TRUE if no point of Geography 2 is outside Geography 1, and the interiors intersect; returns FALSE otherwise. –> learn more

ST_CONTAINS(@geography, @geography_2)

Return type

boolean

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@geography_2	variable	any geography	true	-

Convex hull

Returns the convex hull for the input GEOGRAPHY. The convex hull is the smallest convex GEOGRAPHY that covers the input. A GEOGRAPHY is convex if for every pair of points in the GEOGRAPHY, the geodesic edge connecting the points are also contained in the same GEOGRAPHY. –> learn more

ST_CONVEXHULL(@geography)

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-

Covered by

Returns FALSE if Geography 1 or Geography 2 is empty. Returns TRUE if no points of Geography 1 lie in the exterior of Geography 2. –> learn more

ST_COVEREDBY(@geography, @geography_2)

Return type

boolean

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@geography_2	variable	any geography	true	-

Covers

Returns FALSE if Geography 1 or Geography 2 is empty. Returns TRUE if no points of Geography 2 lie in the exterior of Geography 1. –> learn more

ST_COVERS(@geography, @geography_2)

Return type

boolean

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@geography_2	variable	any geography	true	-

Difference

Returns a GEOGRAPHY that represents the point set difference of Geography 1 and Geography 2. Therefore, the result consists of the part of Geography 1 that does not intersect with Geography 2. –> learn more

ST_DIFFERENCE(@geography, @geography_2)

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@geography_2	variable	any geography	true	-

Dimension

Returns the dimension of the highest-dimensional element in the input GEOGRAPHY. –> learn more

ST_DIMENSION(@geography)

Return type

integer

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-

Disjoint

Returns TRUE if the intersection of Geography 1 and Geography 2 is empty, that is, no point in Geography 1 also appears in Geography 2. –> learn more

ST_DISJOINT(@geography, @geography_2)

Return type

boolean

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@geography_2	variable	any geography	true	-

Distance

Returns the shortest distance in meters between two non-empty GEOGRAPHYs. –> learn more

ST_DISTANCE(@geography, @geography_2)

Return type

float

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@geography_2	variable	any geography	true	-

DWithin

Returns TRUE if the distance between at least one point in Geography 1 and one point in Geography 2 is less than or equal to the Distance argument, otherwise, returns FALSE –> learn more

ST_DWITHIN(@geography, @geography_2, @distance)

Return type

boolean

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@geography_2	variable	any geography	true	-
@distance	variable or literal	any integer, float	true	-

Endpoint

Returns the last point of a linestring geography as a point geography. Returns an error if the input is not a linestring or if the input is empty. Use the SAFE prefix to obtain NULL for invalid input instead of an error. –> learn more

[@safe]ST_ENDPOINT(@geography)

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@safe	boolean	any boolean	true	-

Equals

Returns TRUE if Geography 1 and Geography 2 represent the same GEOGRAPHY value. More precisely, this means that one of the following conditions holds: + ST_COVERS(geography, geography_2) = TRUE and ST_COVERS(geography_2, geography) = TRUE + Both Geography 1 and Geography 2 are empty. –> learn more

ST_EQUALS(@geography, @geography_2)

Return type

boolean

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@geography_2	variable	any geography	true	-

Exterior ring

Returns a linestring geography that corresponds to the outermost ring of a polygon geography. If the input geography is a polygon, gets the outermost ring of the polygon geography and returns the corresponding linestring. If the input is the full GEOGRAPHY, returns an empty geography. Returns an error if the input is not a single polygon. Use the SAFE prefix to obtain NULL for invalid input instead of an error. –> learn more

[@safe]ST_EXTERIORRING(@geography)

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@safe	boolean	any boolean	true	-

Geo from

Converts an expression for a STRING or BYTES value into a GEOGRAPHY value. If expression represents a STRING value, it must be a valid GEOGRAPHY representation in one of the following formats: WKT, WKB, GeoJSON –> learn more

ST_GEOGFROM(@expression)

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@expression	variable or literal	any string	true	-

Geo from GeoJSON

Returns a GEOGRAPHY value that corresponds to the input GeoJSON representation. –> learn more

ST_GEOGFROMGEOJSON(@geojson[, @make_valid])

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geojson	variable or literal	any string	true	-
@make_valid	boolean	any boolean	true	-

Geo from text

Returns a GEOGRAPHY value that corresponds to the input WKT representation. –> learn more

ST_GEOGFROMTEXT(@wkt[, @oriented][, @planar][, @make_valid])

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@wkt	variable or literal	any string	true	-
@oriented	boolean	any boolean	true	-
@planar	boolean	any boolean	true	-
@make_valid	boolean	any boolean	true	-

Geo from wkb

Converts an expression for a hexadecimal-text STRING or BYTES value into a GEOGRAPHY value. The expression must be in WKB format –> learn more

ST_GEOGFROMWKB(@wkb)

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@wkb	variable or literal	any string	true	-

Geogpoint

Creates a GEOGRAPHY with a single point. ST_GEOGPOINT creates a point from the specified FLOAT64 longitude and latitude parameters and returns that point in a GEOGRAPHY value. –> learn more

ST_GEOGPOINT(@longitude, @latitude)

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@longitude	variable or literal	any integer, float	true	-
@latitude	variable or literal	any integer, float	true	-

Geogpoint from Geohash

Returns a GEOGRAPHY value that corresponds to a point in the middle of a bounding box defined in the GeoHash –> learn more

ST_GEOGPOINTFROMGEOHASH(@geohash)

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geohash	variable or literal	any string	true	-

Geohash

Returns a GeoHash representation of geography_expression. The resulting GeoHash will contain at most Max chars characters. Fewer characters corresponds to lower precision (or, described differently, to a bigger bounding box) –> learn more

ST_GEOHASH(@geography, @maxchars)

Return type

string

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@maxchars	variable or literal	any integer	true	-

Geometry type

Returns the Open Geospatial Consortium (OGC) geometry type that describes the input GEOGRAPHY as a STRING. The OGC geometry type matches the types that are used in WKT and GeoJSON formats and printed for ST_ASTEXT and ST_ASGEOJSON. ST_GEOMETRYTYPE returns the OGC geometry type with the "ST_" prefix. –> learn more

ST_GEOMETRYTYPE(@geography)

Return type

string

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-

Intersection

Returns a GEOGRAPHY that represents the point set intersection of the two input GEOGRAPHYs. Thus, every point in the intersection appears in both Geography 1 and Geography 2 –> learn more

ST_INTERSECTION(@geography, @geography_2)

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@geography_2	variable	any geography	true	-

Intersects

Returns TRUE if the point set intersection of Geography 1 and Geography 2 is non-empty. Thus, this function returns TRUE if there is at least one point that appears in both input GEOGRAPHYs. If ST_INTERSECTS returns TRUE, it implies that ST_DISJOINT returns FALSE. –> learn more

ST_INTERSECTS(@geography, @geography_2)

Return type

boolean

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@geography_2	variable	any geography	true	-

Intersects box

Returns TRUE if geography intersects the rectangle between [lng1, lng2] and [lat1, lat2]. The edges of the rectangle follow constant lines of longitude and latitude. lng1 and lng2 specify the westmost and eastmost constant longitude lines that bound the rectangle, and lat1 and lat2 specify the minimum and maximum constant latitude lines that bound the rectangle. –> learn more

ST_INTERSECTSBOX(@geography, @lng1, @lat1, @lng2, @lat2)

Return type

boolean

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@lng1	variable or literal	any integer, float	true	-
@lat1	variable or literal	any integer, float	true	-
@lng2	variable or literal	any integer, float	true	-
@lat2	variable or literal	any integer, float	true	-

Is collection

Returns TRUE if the total number of points, linestrings, and polygons is greater than one. An empty GEOGRAPHY is not a collection. –> learn more

ST_ISCOLLECTION(@geography)

Return type

boolean

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-

Is empty

Returns TRUE if the given GEOGRAPHY is empty; that is, the GEOGRAPHY does not contain any points, lines, or polygons. –> learn more

ST_ISEMPTY(@geography)

Return type

boolean

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-

Length

Returns the total length in meters of the lines in the input GEOGRAPHY. –> learn more

ST_LENGTH(@geography)

Return type

float

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-

Make line

Creates a GEOGRAPHY with a single linestring by concatenating the point or line vertices of each of the input GEOGRAPHYs in the order they are given. –> learn more

ST_MAKELINE(@geography, @geography_2)

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@geography_2	variable	any geography	true	-

Make polygon

Creates a GEOGRAPHY containing a single polygon from a linestring input, where the input linestring is used to construct a polygon ring. –> learn more

ST_MAKEPOLYGON(@geography)

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-

Max distance

Returns the longest distance in meters between two non-empty GEOGRAPHYs; that is, the distance between two vertices where the first vertex is in the first GEOGRAPHY, and the second vertex is in the second GEOGRAPHY. If Geography 1 and Geography 2 are the same GEOGRAPHY, the function returns the distance between the two most distant vertices in that GEOGRAPHY. –> learn more

ST_MAXDISTANCE(@geography, @geography_2)

Return type

float

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@geography_2	variable	any geography	true	-

Num geometries

Returns the number of geometries in the input GEOGRAPHY. For a single point, linestring, or polygon, ST_NUMGEOMETRIES returns 1. For any collection of geometries, ST_NUMGEOMETRIES returns the number of geometries making up the collection. ST_NUMGEOMETRIES returns 0 if the input is the empty GEOGRAPHY. –> learn more

ST_NUMGEOMETRIES(@geography)

Return type

integer

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-

Num points

Returns the number of vertices in the input GEOGRAPHY. This includes the number of points, the number of linestring vertices, and the number of polygon vertices. –> learn more

ST_NUMPOINTS(@geography)

Return type

integer

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-

Perimeter

Returns the length in meters of the boundary of the polygons in the input GEOGRAPHY. –> learn more

ST_PERIMETER(@geography)

Return type

float

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-

Point N

Returns the Nth point of a linestring geography as a point geography, where N is the index. The index is 1-based. Negative values are counted backwards from the end of the linestring, so that -1 is the last point. Returns an error if the input is not a linestring, if the input is empty, or if there is no vertex at the given index. Use the SAFE prefix to obtain NULL for invalid input instead of an error. –> learn more

[@safe]ST_POINTN(@geography, @index)

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@index	variable or literal	any integer	true	-
@geography	variable	any geography	true	-
@safe	boolean	any boolean	true	-

Simplify

Returns a simplified version of geography, the given input GEOGRAPHY. The input GEOGRAPHY is simplified by replacing nearly straight chains of short edges with a single long edge. The input geography will not change by more than the tolerance specified by tolerance_meters. Thus, simplified edges are guaranteed to pass within tolerance_meters of the original positions of all vertices that were removed from that edge. The given tolerance_meters is in meters on the surface of the Earth. –> learn more

ST_SIMPLIFY(@geography, @tolerance_meters)

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@tolerance_meters	variable or literal	any integer, float	true	-

Snap to grid

Returns the input GEOGRAPHY, where each vertex has been snapped to a longitude/latitude grid. The grid size is determined by the grid_size parameter which is given in degrees. –> learn more

ST_SNAPTOGRID(@geography, @grid_size)

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@grid_size	variable or literal	any integer, float	true	-

Start point

Returns the first point of a linestring geography as a point geography. Returns an error if the input is not a linestring or if the input is empty. Use the SAFE prefix to obtain NULL for invalid input instead of an error. –> learn more

[@safe]ST_STARTPOINT(@geography)

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@safe	boolean	any boolean	true	-

Touches

Returns TRUE provided the following two conditions are satisfied: (1) Geography 1 intersects Geography 2 and (2) the interior of Geography 1 and the interior of Geography 2 are disjoint. –> learn more

ST_TOUCHES(@geography, @geography_2)

Return type

boolean

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@geography_2	variable	any geography	true	-

Union

Returns a GEOGRAPHY that represents the point set union of all input GEOGRAPHYs. –> learn more

ST_UNION(@geography, @geography_2)

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@geography_2	variable	any geography	true	-

Within

Returns TRUE if no point of Geography 1 is outside of Geography 2 and the interiors of Geography 1 and Geography 2 intersect. Given two geographies a and b, ST_WITHIN(a, b) returns the same result as ST_CONTAINS(b, a). Note the opposite order of arguments. –> learn more

ST_WITHIN(@geography, @geography_2)

Return type

boolean

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@geography_2	variable	any geography	true	-

X Min

Returns a float representing the west-most constant longitude line that bounds the geometry –> learn more

ST_BOUNDINGBOX(@geography).xmin

Return type

float

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-

X Max

Returns a float representing the east-most constant longitude line that bounds the geometry –> learn more

ST_BOUNDINGBOX(@geography).xmax

Return type

float

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-

Point X

Returns the longitude in degrees of the single-point input GEOGRAPHY –> learn more

[@safe]ST_X(@geography)

Return type

float

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@safe	boolean	any boolean	true	-

Point Y

Returns the latitude in degrees of the single-point input GEOGRAPHY –> learn more

[@safe]ST_Y(@geography)

Return type

float

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@safe	boolean	any boolean	true	-

Y Min

Returns a float representing the minimum constant latitude line that bounds the geometry. –> learn more

ST_BOUNDINGBOX(@geography).ymin

Return type

float

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-

Y Max

Returns a float representing the maximum constant latitude line that bounds the geometry. –> learn more

ST_BOUNDINGBOX(@geography).ymax

Return type

float

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-

Centroid aggregate

Computes the centroid of the set of input GEOGRAPHYs as a single point GEOGRAPHY. –> learn more

ST_CENTROID_AGG(@geography)

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-

Geo aggregate

Returns a geography variable that represents the point set union of all input geographies. –> learn more

ST_UNION_AGG(@geography)

Return type

geography

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-

DBSCAN clustering

Identifies high-density geography clusters and marks outliers in low-density areas of noise –> learn more

ST_CLUSTERDBSCAN(@geography, @epsilon, @minimum_geographies)

Return type

integer

Parameters

Name	Type	Allowed values	Required	Placeholder (in UI)
@geography	variable	any geography	true	-
@epsilon	literal	any integer, float	true	-
@minimum_geographies	literal	any integer	true	-