Skip to content

test long documentation

Peter edited this page Oct 29, 2022 · 1 revision
Function / Description / Example
_postgis_deprecate(text, text, text) void

Argument names: oldname text, newname text, version text

_postgis_index_extent(regclass, text) box2d

Argument names: tbl regclass, col text

_postgis_join_selectivity(regclass, text, regclass, text, text) float8

Argument names: regclass, text, regclass, text, text DEFAULT '2'::text

_postgis_pgsql_version() text
_postgis_scripts_pgsql_version() text
_postgis_selectivity(regclass, text, USER-DEFINED, text) float8

Argument names: tbl regclass, att_name text, geom geometry, mode text DEFAULT '2'::text

_postgis_stats(regclass, text, text) text

Argument names: tbl regclass, att_name text, text DEFAULT '2'::text

_st_3ddfullywithin(USER-DEFINED, USER-DEFINED, double precision) bool

Argument names: geom1 geometry, geom2 geometry, double precision

_st_3ddwithin(USER-DEFINED, USER-DEFINED, double precision) bool

Argument names: geom1 geometry, geom2 geometry, double precision

_st_3dintersects(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

_st_asgml(integer, USER-DEFINED, integer, integer, text, text) text

Argument names: integer, geometry, integer, integer, text, text

_st_asx3d(integer, USER-DEFINED, integer, integer, text) text

Argument names: integer, geometry, integer, integer, text

_st_bestsrid(USER-DEFINED, USER-DEFINED) int4

Argument names: geography, geography

_st_bestsrid(USER-DEFINED) int4

Argument names: geography

_st_concavehull(USER-DEFINED) geometry

Argument names: param_inputgeom geometry

_st_contains(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

_st_containsproperly(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

_st_coveredby(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

_st_coveredby(USER-DEFINED, USER-DEFINED) bool

Argument names: geog1 geography, geog2 geography

_st_covers(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

_st_covers(USER-DEFINED, USER-DEFINED) bool

Argument names: geog1 geography, geog2 geography

_st_crosses(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

_st_dfullywithin(USER-DEFINED, USER-DEFINED, double precision) bool

Argument names: geom1 geometry, geom2 geometry, double precision

_st_distancetree(USER-DEFINED, USER-DEFINED, double precision, boolean) float8

Argument names: geography, geography, double precision, boolean

_st_distancetree(USER-DEFINED, USER-DEFINED) float8

Argument names: geography, geography

_st_distanceuncached(USER-DEFINED, USER-DEFINED, double precision, boolean) float8

Argument names: geography, geography, double precision, boolean

_st_distanceuncached(USER-DEFINED, USER-DEFINED, boolean) float8

Argument names: geography, geography, boolean

_st_distanceuncached(USER-DEFINED, USER-DEFINED) float8

Argument names: geography, geography

_st_dwithin(USER-DEFINED, USER-DEFINED, double precision) bool

Argument names: geom1 geometry, geom2 geometry, double precision

_st_dwithin(USER-DEFINED, USER-DEFINED, double precision, boolean) bool

Argument names: geog1 geography, geog2 geography, tolerance double precision, use_spheroid boolean DEFAULT true

_st_dwithinuncached(USER-DEFINED, USER-DEFINED, double precision, boolean) bool

Argument names: geography, geography, double precision, boolean

_st_dwithinuncached(USER-DEFINED, USER-DEFINED, double precision) bool

Argument names: geography, geography, double precision

_st_equals(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

_st_expand(USER-DEFINED, double precision) geography

Argument names: geography, double precision

_st_geomfromgml(text, integer) geometry
_st_intersects(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

_st_linecrossingdirection(USER-DEFINED, USER-DEFINED) int4

Argument names: line1 geometry, line2 geometry

_st_longestline(USER-DEFINED, USER-DEFINED) geometry

Argument names: geom1 geometry, geom2 geometry

_st_maxdistance(USER-DEFINED, USER-DEFINED) float8

Argument names: geom1 geometry, geom2 geometry

_st_orderingequals(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

_st_overlaps(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

_st_pointoutside(USER-DEFINED) geography

Argument names: geography

_st_sortablehash(USER-DEFINED) int8

Argument names: geom geometry

_st_touches(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

_st_voronoi(USER-DEFINED, USER-DEFINED, double precision, boolean) geometry

Argument names: g1 geometry, clip geometry DEFAULT NULL::geometry, tolerance double precision DEFAULT 0.0, return_polygons boolean DEFAULT true

_st_within(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

addauth(text) bool

args: auth_token - Adds an authorization token to be used in the current transaction.

addgeometrycolumn(character varying, character varying, character varying, character varying, integer, character varying, integer, boolean) text

args: catalog_name, schema_name, table_name, column_name, srid, type, dimension, use_typmod=true - Adds a geometry column to an existing table.

Argument names: catalog_name character varying, schema_name character varying, table_name character varying, column_name character varying, new_srid_in integer, new_type character varying, new_dim integer, use_typmod boolean DEFAULT true

addgeometrycolumn(character varying, character varying, character varying, integer, character varying, integer, boolean) text

args: schema_name, table_name, column_name, srid, type, dimension, use_typmod=true - Adds a geometry column to an existing table.

Argument names: schema_name character varying, table_name character varying, column_name character varying, new_srid integer, new_type character varying, new_dim integer, use_typmod boolean DEFAULT true

addgeometrycolumn(character varying, character varying, integer, character varying, integer, boolean) text

args: table_name, column_name, srid, type, dimension, use_typmod=true - Adds a geometry column to an existing table.

Argument names: table_name character varying, column_name character varying, new_srid integer, new_type character varying, new_dim integer, use_typmod boolean DEFAULT true

array_agg_cat_distinct(anyarray) anyarray
array_cat_distinct(anyarray, anyarray) anyarray

Argument names: a anyarray, b anyarray

array_concat_agg(anyarray) anyarray
array_distinct_sort(anyarray, boolean) anyarray

Argument names: anyarray, p_no_null boolean DEFAULT true

array_fastsort(anyarray) anyarray
array_fillto(anyarray, integer, anyelement) anyarray

Argument names: p_array anyarray, p_len integer, p_null anyelement DEFAULT NULL::unknown

array_fillto_duo(anyarray, anyarray, anyelement, anyarray, anyarray) record

Argument names: anyarray, anyarray, anyelement DEFAULT NULL::unknown

array_is_allsame(anyarray) bool
array_last(anyarray) anyelement

Argument names: p_input anyarray

array_last_butnot(anyarray, anyarray) anyelement

Argument names: p_input anyarray, p_not anyarray

array_last_butnot(anyarray, anyelement) anyelement

Argument names: p_input anyarray, p_not anyelement

array_merge_sort(anycompatiblearray, anycompatiblearray, boolean) anycompatiblearray

Argument names: anycompatiblearray, anycompatiblearray, boolean DEFAULT true

array_reduce_dim(anyarray) anyarray
array_sample(anyarray, integer) anyarray

Argument names: p_items anyarray, p_qt integer DEFAULT NULL::integer

array_subtract(anyarray, anyarray, boolean) anyarray

Argument names: p_a anyarray, p_b anyarray, p_empty_to_null boolean DEFAULT true

base36_encode(bigint) text

Argument names: digits bigint

baseh_to_vbit(text, integer) varbit

Argument names: p_val text, p_base integer DEFAULT 4

box(USER-DEFINED) box

Argument names: geometry

box(USER-DEFINED) box

Argument names: box3d

box2d(USER-DEFINED) box2d

args: geom - Returns a BOX2D representing the 2D extent of a geometry.

Argument names: geometry

box2d(USER-DEFINED) box2d

Argument names: box3d

box2d_in(cstring) box2d
box2d_out(USER-DEFINED) cstring

Argument names: box2d

box2df_in(cstring) box2df
box2df_out(USER-DEFINED) cstring

Argument names: box2df

box3d(USER-DEFINED) box3d

args: geom - Returns a BOX3D representing the 3D extent of a geometry.

Argument names: geometry

box3d(USER-DEFINED) box3d

Argument names: box2d

box3d_in(cstring) box3d
box3d_out(USER-DEFINED) cstring

Argument names: box3d

box3dtobox(USER-DEFINED) box

Argument names: box3d

bytea(USER-DEFINED) bytea

Argument names: geometry

bytea(USER-DEFINED) bytea

Argument names: geography

checkauth(text, text, text) int4

args: a_schema_name, a_table_name, a_key_column_name - Creates a trigger on a table to prevent/allow updates and deletes of rows based on authorization token.

checkauth(text, text) int4

args: a_table_name, a_key_column_name - Creates a trigger on a table to prevent/allow updates and deletes of rows based on authorization token.

checkauthtrigger() trigger
contains_2d(USER-DEFINED, USER-DEFINED) bool

Argument names: box2df, geometry

contains_2d(USER-DEFINED, USER-DEFINED) bool

Argument names: box2df, box2df

contains_2d(USER-DEFINED, USER-DEFINED) bool

Argument names: geometry, box2df

csv_to_jsonb(text, ARRAY, text) jsonb

Atomic SQL-to-JSON datatypes convertions, starting from CSV lines and its column definition

Argument names: p_info text, coltypes_sql text[], rgx_sep text DEFAULT '\|'::text

decimal_zeros(double precision, integer) int4

Argument names: x double precision, d_correction integer DEFAULT 1

disablelongtransactions() text

Disables long transaction support.

doc_udf_show(text, text, text, oid, oid, text, text, text, text, text, text, text, text) record

Show all information about an User Defined Function (UDF), by its OID, or listing all functions by LIKE filter.

Argument names: p_schema_name text DEFAULT NULL::text, p_name_like text DEFAULT ''::text, p_name_notlike text DEFAULT ''::text, p_oid oid DEFAULT NULL::oid

doc_udf_show_simple(text, text, text, oid, text, oid, text, text, ARRAY, text, text, text, text) record

Argument names: p_schema_name text DEFAULT NULL::text, p_name_like text DEFAULT ''::text, p_name_notlike text DEFAULT ''::text, p_oid oid DEFAULT NULL::oid

doc_udf_show_simplified_signature(text, text, text, text, USER-DEFINED, USER-DEFINED, ARRAY) record

Show name and simplified argument list about an User Defined Function (UDF), by its name or listing all functions by LIKE filter. Useful for namespace analyses

Argument names: p_schema_name text DEFAULT NULL::text, p_name_like text DEFAULT ''::text, p_name_notlike text DEFAULT ''::text

doc_udf_transparent_id(text, integer) text

Offers a public eternal identifier for a function, important to JOINS in the documentation schema.

Argument names: name_expression text, md5_digits integer DEFAULT 6

doc_udf_transparent_id(text, text, ARRAY, integer) text

Prepare the standard parameters for doc_UDF_transparent_id().

Argument names: schema_name text, name text, arguments_simplified text[], md5_digits integer DEFAULT 6

doc_udf_transparent_id(text, ARRAY, integer) text

Prepare parameters for doc_UDF_transparent_id().

Argument names: name text, arguments_simplified text[], md5_digits integer DEFAULT 6

dropgeometrycolumn(character varying, character varying, character varying, character varying) text

args: catalog_name, schema_name, table_name, column_name - Removes a geometry column from a spatial table.

Argument names: catalog_name character varying, schema_name character varying, table_name character varying, column_name character varying

dropgeometrycolumn(character varying, character varying, character varying) text

args: schema_name, table_name, column_name - Removes a geometry column from a spatial table.

Argument names: schema_name character varying, table_name character varying, column_name character varying

dropgeometrycolumn(character varying, character varying) text

args: table_name, column_name - Removes a geometry column from a spatial table.

Argument names: table_name character varying, column_name character varying

dropgeometrytable(character varying, character varying, character varying) text

args: catalog_name, schema_name, table_name - Drops a table and all its references in geometry_columns.

Argument names: catalog_name character varying, schema_name character varying, table_name character varying

dropgeometrytable(character varying, character varying) text

args: schema_name, table_name - Drops a table and all its references in geometry_columns.

Argument names: schema_name character varying, table_name character varying

dropgeometrytable(character varying) text

args: table_name - Drops a table and all its references in geometry_columns.

Argument names: table_name character varying

enablelongtransactions() text

Enables long transaction support.

equals(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

file_exists(text) bool

Argument names: p_file text

find_srid(character varying, character varying, character varying) int4

args: a_schema_name, a_table_name, a_geomfield_name - Returns the SRID defined for a geometry column.

geocode_distribution_generate(text, integer, boolean) jsonb

Argument names: p_relation text, p_geocode_size integer, p_sum boolean DEFAULT false

geocode_distribution_generate(text, boolean, text, integer, text, boolean) jsonb

Argument names: p_tabname text, p_ispoint boolean DEFAULT false, p_geom_col text DEFAULT 'geom'::text, p_geocode_size integer DEFAULT 5, p_geocode_function text DEFAULT 'ST_Geohash'::text, p_sum boolean DEFAULT false

geog_brin_inclusion_add_value(internal, internal, internal, internal) bool
geography(USER-DEFINED, integer, boolean) geography

Argument names: geography, integer, boolean

geography(bytea) geography
geography(USER-DEFINED) geography

Argument names: geometry

geography_analyze(internal) bool
geography_cmp(USER-DEFINED, USER-DEFINED) int4

Argument names: geography, geography

geography_distance_knn(USER-DEFINED, USER-DEFINED) float8

Argument names: geography, geography

geography_eq(USER-DEFINED, USER-DEFINED) bool

Argument names: geography, geography

geography_ge(USER-DEFINED, USER-DEFINED) bool

Argument names: geography, geography

geography_gist_compress(internal) internal
geography_gist_consistent(internal, USER-DEFINED, integer) bool

Argument names: internal, geography, integer

geography_gist_decompress(internal) internal
geography_gist_distance(internal, USER-DEFINED, integer) float8

Argument names: internal, geography, integer

geography_gist_penalty(internal, internal, internal) internal
geography_gist_picksplit(internal, internal) internal
geography_gist_same(USER-DEFINED, USER-DEFINED, internal) internal

Argument names: box2d, box2d, internal

geography_gist_union(bytea, internal) internal
geography_gt(USER-DEFINED, USER-DEFINED) bool

Argument names: geography, geography

geography_in(cstring, oid, integer) geography
geography_le(USER-DEFINED, USER-DEFINED) bool

Argument names: geography, geography

geography_lt(USER-DEFINED, USER-DEFINED) bool

Argument names: geography, geography

geography_out(USER-DEFINED) cstring

Argument names: geography

geography_overlaps(USER-DEFINED, USER-DEFINED) bool

Argument names: geography, geography

geography_recv(internal, oid, integer) geography
geography_send(USER-DEFINED) bytea

Argument names: geography

geography_spgist_choose_nd(internal, internal) void
geography_spgist_compress_nd(internal) internal
geography_spgist_config_nd(internal, internal) void
geography_spgist_inner_consistent_nd(internal, internal) void
geography_spgist_leaf_consistent_nd(internal, internal) bool
geography_spgist_picksplit_nd(internal, internal) void
geography_typmod_in(ARRAY) int4

Argument names: cstring[]

geography_typmod_out(integer) cstring
geohash_adjacent(text, integer) text

Optimizing.

Argument names: geohash text, direction integer

geohash_adjacent(text, text) text

wrap for geohash_adjacent(text,int).

Argument names: geohash text, direction text

geohash_adjacent2(text, integer) text

Argument names: p_geohash text, direction integer

geohash_cover_geoms(USER-DEFINED, text, boolean, boolean, text, boolean, USER-DEFINED, USER-DEFINED) record

Geometry of geohash_cover() list, assuming a region delimited by the prefix.

Argument names: input_geom geometry, input_prefix text DEFAULT ''::text, onlycontained boolean DEFAULT false, force_scan boolean DEFAULT true

geohash_cover_list(USER-DEFINED, text, boolean, boolean) _text

Geohash list of covering Geohashes, assuming a region delimited by the prefix. Returns null for incompatible prefixes, and 32 itens from prefix-contained geometry.

Argument names: input_geom geometry, input_prefix text DEFAULT ''::text, onlycontained boolean DEFAULT NULL::boolean, force_scan boolean DEFAULT true

geohash_cover_testlist(USER-DEFINED, text, boolean) jsonb

Geohash jsonb object (geocode-is_contained pairs) of covering Geohashes, a wrap for geohash_cover_geoms function.

Argument names: input_geom geometry, input_prefix text DEFAULT ''::text, force_scan boolean DEFAULT true

geohash_covercontour_geoms(USER-DEFINED, integer, text, text, USER-DEFINED, USER-DEFINED) record

Geohash cover of the contour.

Argument names: input_geom geometry, ghs_len integer DEFAULT 3, prefix0 text DEFAULT ''::text

geohash_covercontour_geoms_splitarea(USER-DEFINED, integer, double precision, text, text, USER-DEFINED, USER-DEFINED, double precision) record

Argument names: input_geom geometry, ghs_len integer DEFAULT 3, max_area_factor double precision DEFAULT 0.8, prefix0 text DEFAULT ''::text

geohash_geomsfromprefix(text, text, USER-DEFINED) record

Return a Geohash grid, the quadrilateral geometry of each child-cell and its geocode. The parameter is the Geohash the parent-cell, that will be a prefix for all child-cells.

Argument names: prefix text DEFAULT ''::text

geohash_geomsmosaic(ARRAY, USER-DEFINED, text, integer, USER-DEFINED) record

Return a mosaic the geometries of an arbitrary set of Geohashes, cuting, when exists, contained cells from its parent-cell.

Argument names: ghs_array text[], geom_mask geometry DEFAULT NULL::geometry

geohash_geomsmosaic(jsonb, USER-DEFINED, text, integer, text, USER-DEFINED) record

Wrap for geohash_GeomsMosaic(text[]), adding a val column of text-type from input key-value pairs.

Argument names: ghs_set jsonb, geom_mask geometry DEFAULT NULL::geometry

geohash_geomsmosaic_jinfo(jsonb, USER-DEFINED, text, jsonb, USER-DEFINED) record

Wrap for geohash_GeomMosaic(text[]), adding a val column of jsonb-type from input key-value pairs.

Argument names: ghs_set jsonb, geom_mask geometry DEFAULT NULL::geometry

geohash_geomsmosaic_jinfo(jsonb, jsonb, USER-DEFINED, double precision, text, jsonb, USER-DEFINED) record

Wrap for geohash_GeomsMosaic_jinfo, adding optional area and density values

Argument names: ghs_set jsonb, opts jsonb, geom_mask geometry DEFAULT NULL::geometry, minimal_area double precision DEFAULT 1.0

geohash_neighbors_brute(text) _text

Obtains Geohash neighbors by a brute-force algorithm. With erros, see https://gis.stackexchange.com/a/431410/7505

Argument names: hash text

geohash_neighbours(text) _text

Argument names: geohash text

geojson_readfile_features(text, text, integer, text, text, jsonb, USER-DEFINED) record

Reads a small GeoJSON file and transforms it into a table with a geometry column.

Argument names: f text

geojson_readfile_features_jgeom(text, integer, integer, integer, text, jsonb, jsonb) record

Reads a big GeoJSON file and transforms it into a table with a json-geometry column.

Argument names: file text, file_id integer DEFAULT NULL::integer

geojson_readfile_headers(text, boolean) jsonb

Argument names: f text, missing_ok boolean DEFAULT false

geom2d_brin_inclusion_add_value(internal, internal, internal, internal) bool
geom3d_brin_inclusion_add_value(internal, internal, internal, internal) bool
geom4d_brin_inclusion_add_value(internal, internal, internal, internal) bool
geometry(USER-DEFINED, integer, boolean) geometry

Argument names: geometry, integer, boolean

geometry(point) geometry
geometry(path) geometry
geometry(polygon) geometry
geometry(USER-DEFINED) geometry

Argument names: box2d

geometry(USER-DEFINED) geometry

Argument names: box3d

geometry(text) geometry
geometry(bytea) geometry
geometry(USER-DEFINED) geometry

Argument names: geography

geometry_above(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

geometry_analyze(internal) bool
geometry_below(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

geometry_cmp(USER-DEFINED, USER-DEFINED) int4

Argument names: geom1 geometry, geom2 geometry

geometry_contained_3d(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

geometry_contains(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

geometry_contains_3d(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

geometry_contains_nd(USER-DEFINED, USER-DEFINED) bool

Argument names: geometry, geometry

geometry_distance_box(USER-DEFINED, USER-DEFINED) float8

Argument names: geom1 geometry, geom2 geometry

geometry_distance_centroid(USER-DEFINED, USER-DEFINED) float8

Argument names: geom1 geometry, geom2 geometry

geometry_distance_centroid_nd(USER-DEFINED, USER-DEFINED) float8

Argument names: geometry, geometry

geometry_distance_cpa(USER-DEFINED, USER-DEFINED) float8

Argument names: geometry, geometry

geometry_eq(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

geometry_ge(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

geometry_gist_compress_2d(internal) internal
geometry_gist_compress_nd(internal) internal
geometry_gist_consistent_2d(internal, USER-DEFINED, integer) bool

Argument names: internal, geometry, integer

geometry_gist_consistent_nd(internal, USER-DEFINED, integer) bool

Argument names: internal, geometry, integer

geometry_gist_decompress_2d(internal) internal
geometry_gist_decompress_nd(internal) internal
geometry_gist_distance_2d(internal, USER-DEFINED, integer) float8

Argument names: internal, geometry, integer

geometry_gist_distance_nd(internal, USER-DEFINED, integer) float8

Argument names: internal, geometry, integer

geometry_gist_penalty_2d(internal, internal, internal) internal
geometry_gist_penalty_nd(internal, internal, internal) internal
geometry_gist_picksplit_2d(internal, internal) internal
geometry_gist_picksplit_nd(internal, internal) internal
geometry_gist_same_2d(USER-DEFINED, USER-DEFINED, internal) internal

Argument names: geom1 geometry, geom2 geometry, internal

geometry_gist_same_nd(USER-DEFINED, USER-DEFINED, internal) internal

Argument names: geometry, geometry, internal

geometry_gist_sortsupport_2d(internal) void
geometry_gist_union_2d(bytea, internal) internal
geometry_gist_union_nd(bytea, internal) internal
geometry_gt(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

geometry_hash(USER-DEFINED) int4

Argument names: geometry

geometry_in(cstring) geometry
geometry_le(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

geometry_left(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

geometry_lt(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

geometry_out(USER-DEFINED) cstring

Argument names: geometry

geometry_overabove(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

geometry_overbelow(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

geometry_overlaps(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

geometry_overlaps_3d(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

geometry_overlaps_nd(USER-DEFINED, USER-DEFINED) bool

Argument names: geometry, geometry

geometry_overleft(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

geometry_overright(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

geometry_recv(internal) geometry
geometry_right(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

geometry_same(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

geometry_same_3d(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

geometry_same_nd(USER-DEFINED, USER-DEFINED) bool

Argument names: geometry, geometry

geometry_send(USER-DEFINED) bytea

Argument names: geometry

geometry_sortsupport(internal) void
geometry_spgist_choose_2d(internal, internal) void
geometry_spgist_choose_3d(internal, internal) void
geometry_spgist_choose_nd(internal, internal) void
geometry_spgist_compress_2d(internal) internal
geometry_spgist_compress_3d(internal) internal
geometry_spgist_compress_nd(internal) internal
geometry_spgist_config_2d(internal, internal) void
geometry_spgist_config_3d(internal, internal) void
geometry_spgist_config_nd(internal, internal) void
geometry_spgist_inner_consistent_2d(internal, internal) void
geometry_spgist_inner_consistent_3d(internal, internal) void
geometry_spgist_inner_consistent_nd(internal, internal) void
geometry_spgist_leaf_consistent_2d(internal, internal) bool
geometry_spgist_leaf_consistent_3d(internal, internal) bool
geometry_spgist_leaf_consistent_nd(internal, internal) bool
geometry_spgist_picksplit_2d(internal, internal) void
geometry_spgist_picksplit_3d(internal, internal) void
geometry_spgist_picksplit_nd(internal, internal) void
geometry_typmod_in(ARRAY) int4

Argument names: cstring[]

geometry_typmod_out(integer) cstring
geometry_within(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

geometry_within_nd(USER-DEFINED, USER-DEFINED) bool

Argument names: geometry, geometry

geometrytype(USER-DEFINED) text

args: geomA - Returns the type of a geometry as text.

Argument names: geometry

geometrytype(USER-DEFINED) text

Argument names: geography

geomfromewkb(bytea) geometry
geomfromewkt(text) geometry
get_proj4_from_srid(integer) text
gettransactionid() xid
gidx_in(cstring) gidx
gidx_out(USER-DEFINED) cstring

Argument names: gidx

gserialized_gist_joinsel_2d(internal, oid, internal, smallint) float8
gserialized_gist_joinsel_nd(internal, oid, internal, smallint) float8
gserialized_gist_sel_2d(internal, oid, internal, integer) float8
gserialized_gist_sel_nd(internal, oid, internal, integer) float8
hcode_distribution_format(jsonb, boolean, text, text) text

Argument names: p_j jsonb, p_perc boolean DEFAULT true, p_glink text DEFAULT ''::text, p_sep text DEFAULT ', '::text

hcode_distribution_kpis(jsonb) jsonb

Argument names: p_j jsonb

hcode_distribution_reduce(jsonb, integer, integer, integer, integer, integer) jsonb

Argument names: p_j jsonb, p_left_erode integer DEFAULT 1, p_size_min integer DEFAULT 1, p_threshold integer DEFAULT NULL::integer, p_threshold_sum integer DEFAULT NULL::integer, p_heuristic integer DEFAULT 1

hcode_distribution_reduce(jsonb, integer, integer, jsonb) jsonb

Argument names: p_j jsonb, p_left_erode integer DEFAULT 1, p_size_min integer DEFAULT 1, hcode_parameters jsonb DEFAULT NULL::jsonb

hcode_distribution_reduce_pre_raw(jsonb, integer, integer, integer, integer, double precision, text, integer, integer, integer, jsonb) record

Argument names: p_j jsonb, p_left_erode integer DEFAULT 1, p_size_min integer DEFAULT 1, p_threshold integer DEFAULT NULL::integer, p_threshold_sum integer DEFAULT NULL::integer, p_percentile double precision DEFAULT 0.5

hcode_distribution_reduce_pre_raw_alt(jsonb, integer, integer, integer, integer, text, integer, integer, integer, boolean, ARRAY) record

Argument names: p_j jsonb, p_left_erode integer DEFAULT 1, p_size_min integer DEFAULT 1, p_size_max integer DEFAULT 1, p_threshold_sum integer DEFAULT NULL::integer

hcode_distribution_reduce_recursive_pre_raw_alt(jsonb, integer, integer, integer, integer, text, integer, integer, integer, boolean, ARRAY) record

Argument names: p_j jsonb, p_left_erode integer DEFAULT 1, p_size_min integer DEFAULT 1, p_size_max integer DEFAULT 1, p_threshold_sum integer DEFAULT NULL::integer

hcode_distribution_reduce_recursive_raw(jsonb, integer, integer, integer, integer, integer, smallint, text, integer, integer, integer, jsonb) record

Argument names: p_j jsonb, p_left_erode integer DEFAULT 1, p_size_min integer DEFAULT 1, p_threshold integer DEFAULT NULL::integer, p_threshold_sum integer DEFAULT NULL::integer, p_heuristic integer DEFAULT 1, ctrl_recursions smallint DEFAULT 1

hcode_distribution_reduce_recursive_raw(jsonb, integer, integer, jsonb, smallint, text, integer, integer, integer, jsonb) record

Argument names: p_j jsonb, p_left_erode integer DEFAULT 1, p_size_min integer DEFAULT 1, hcode_parameters jsonb DEFAULT NULL::jsonb, ctrl_recursions smallint DEFAULT 1

hcode_distribution_reduce_recursive_raw_alt(jsonb, integer, integer, integer, integer, integer, text, bigint, bigint, bigint, boolean, ARRAY) record

Argument names: p_j jsonb, p_left_erode integer DEFAULT 1, p_size_min integer DEFAULT 1, p_size_max integer DEFAULT 1, p_threshold_sum integer DEFAULT NULL::integer, p_threshold_min integer DEFAULT 1000

hcode_prefixset_element(text, ARRAY) text

Argument names: p_check text, p_prefixes text[]

hcode_prefixset_element(text, text) text

Argument names: p_check text, p_prefixeset_regex text

hcode_prefixset_element_slower(text, ARRAY) text

Argument names: p_check text, p_prefixes text[]

hcode_prefixset_isin(text, text) bool

Argument names: p_check text, p_prefixeset_regex text

hcode_prefixset_parse(ARRAY) text

Argument names: p_prefixes text[]

hcode_signature_reduce(jsonb, integer, integer, real, integer) jsonb

Argument names: p_j jsonb, p_left_erode integer DEFAULT 1, p_size_min integer DEFAULT 1, p_percentile real DEFAULT 0.75, p_heuristic integer DEFAULT 1

hcode_signature_reduce(jsonb, integer, integer, jsonb) jsonb

Argument names: p_j jsonb, p_left_erode integer DEFAULT 1, p_size_min integer DEFAULT 1, hcode_parameters jsonb DEFAULT NULL::jsonb

hcode_signature_reduce_pre_raw(jsonb, integer, integer, double precision, text, integer, integer, integer, jsonb) record

Argument names: p_j jsonb, p_left_erode integer DEFAULT 1, p_size_min integer DEFAULT 1, p_percentile double precision DEFAULT 0.5

hcode_signature_reduce_recursive_raw(jsonb, integer, integer, real, integer, smallint, text, integer, integer, integer, jsonb) record

Argument names: p_j jsonb, p_left_erode integer DEFAULT 1, p_size_min integer DEFAULT 1, p_percentile real DEFAULT 0.75, p_heuristic integer DEFAULT 1, ctrl_recursions smallint DEFAULT 0

hcodes_common_prefix(ARRAY) text

Longest Common Prefix of a set of hcodes, sorting array

Argument names: a text[]

iif(boolean, anyelement, anyelement) anyelement

Immediate IF. Sintax sugar for the most frequent CASE-WHEN. Avoid with text, need explicit cast.

Argument names: condition boolean, true_result anyelement, false_result anyelement

is_contained_2d(USER-DEFINED, USER-DEFINED) bool

Argument names: box2df, geometry

is_contained_2d(USER-DEFINED, USER-DEFINED) bool

Argument names: box2df, box2df

is_contained_2d(USER-DEFINED, USER-DEFINED) bool

Argument names: geometry, box2df

json(USER-DEFINED) json

Argument names: geometry

json_pretty_lines(json, integer) text

Format JSON like jsonB_pretty() to return one item per line: 0 = to_text with no formating, 1=standard Pretty, 2=GeoJSON preserving type, 3=GeoJSON removing type, 4=compact form

Argument names: j_input json, opt integer DEFAULT 0

jsonb(USER-DEFINED) jsonb

Argument names: geometry

jsonb_mustache_render(text, jsonb, text) text

Argument names: tpl text, i jsonb, partials_path text DEFAULT '/var/gits/_dg/preserv/src/maketemplates/'::text

jsonb_object_keys_asarray(jsonb) _text

Argument names: j jsonb

jsonb_object_length(jsonb) int4
jsonb_objslice(text, jsonb, text) jsonb

Get the first path-result as keyname-result object.

Argument names: key text, j jsonb, rename text DEFAULT NULL::text

jsonb_objslice(ARRAY, jsonb, ARRAY) jsonb

Argument names: keys text[], j jsonb, renames text[] DEFAULT NULL::text[]

jsonb_objslice(jsonpath, jsonb, text) jsonb

Argument names: keypath jsonpath, j jsonb, keyname text

jsonb_pg_stat_file(text, boolean, boolean) jsonb

Convert pg_stat_file() information in JSONb, adding option to include MD5 digest and filename.

Argument names: f text, add_md5 boolean DEFAULT false, missing_ok boolean DEFAULT false

jsonb_pretty(jsonb, boolean) text

Extends jsonb_pretty() to return canonical compact form when true

Argument names: jsonb, compact boolean

jsonb_pretty_lines(jsonb, integer) text

Argument names: j_input jsonb, opt integer DEFAULT 0

jsonb_rename(jsonb, text, text) jsonb

Argument names: js jsonb, nmold text, nmnew text

jsonb_strip_nulls(jsonb, boolean) jsonb

Extends jsonb_strip_nulls to return NULL instead empty

Argument names: p_input jsonb, p_ret_empty boolean

jsonb_summable_aggmerge(jsonb) jsonb
jsonb_summable_check(jsonb, text) bool

Argument names: jsonb, text DEFAULT 'numeric'::text

jsonb_summable_maxval(jsonb) int8
jsonb_summable_merge(jsonb, jsonb) jsonb
jsonb_summable_merge(ARRAY) jsonb

Argument names: jsonb[]

jsonb_summable_output(jsonb, text, text) text

Argument names: p_j jsonb, p_sep text DEFAULT ', '::text, p_prefix text DEFAULT ''::text

jsonb_summable_values(jsonb) _int4
jsonb_to_bigints(jsonb) _int8

Casts JSON array of non-floating numbers to SQL array of bigints.

Argument names: p_j jsonb

jsonb_to_yaml(text) text

Argument names: p_jsonb text

jsonb_to_yaml(text, boolean) text

Argument names: p_jsonb text, flow_style boolean

lexname_to_unix(text) text

Convert URN LEX jurisdiction string to camel-case filename for Unix-like file systems.

Argument names: p_lexname text

lockrow(text, text, text, text, timestamp without time zone) int4

args: a_schema_name, a_table_name, a_row_key, an_auth_token, expire_dt - Sets lock/authorization for a row in a table.

lockrow(text, text, text, text) int4
lockrow(text, text, text) int4

args: a_table_name, a_row_key, an_auth_token - Sets lock/authorization for a row in a table.

lockrow(text, text, text, timestamp without time zone) int4

args: a_table_name, a_row_key, an_auth_token, expire_dt - Sets lock/authorization for a row in a table.

longtransactionsenabled() bool
overlaps_2d(USER-DEFINED, USER-DEFINED) bool

Argument names: box2df, geometry

overlaps_2d(USER-DEFINED, USER-DEFINED) bool

Argument names: box2df, box2df

overlaps_2d(USER-DEFINED, USER-DEFINED) bool

Argument names: geometry, box2df

overlaps_geog(USER-DEFINED, USER-DEFINED) bool

Argument names: gidx, geography

overlaps_geog(USER-DEFINED, USER-DEFINED) bool

Argument names: gidx, gidx

overlaps_geog(USER-DEFINED, USER-DEFINED) bool

Argument names: geography, gidx

overlaps_nd(USER-DEFINED, USER-DEFINED) bool

Argument names: gidx, geometry

overlaps_nd(USER-DEFINED, USER-DEFINED) bool

Argument names: gidx, gidx

overlaps_nd(USER-DEFINED, USER-DEFINED) bool

Argument names: geometry, gidx

path(USER-DEFINED) path

Argument names: geometry

pg_csv_head(text, text, bigint) _text

Devolve array do header de um arquivo CSV com separador estrito, lendo apenas primeiros bytes.

Argument names: filename text, separator text DEFAULT ','::text, linesize bigint DEFAULT 9000

pg_csv_head_tojsonb(text, boolean, text, bigint, boolean) jsonb

Argument names: filename text, tolower boolean DEFAULT false, separator text DEFAULT ','::text, linesize bigint DEFAULT 9000, is_idx_json boolean DEFAULT true

pg_relation_lines(text) int8

run COUNT(*), a complement for pg_relation_size() function.

Argument names: p_tablename text

pg_tablestruct_dump_totext(text, ARRAY, ARRAY) _text

Extraxcts column descriptors of a table. Used in ingest.fdw_generate_getclone() function. Optional adds to the end.

Argument names: p_tabname text, p_ignore text[] DEFAULT NULL::text[], p_add text[] DEFAULT NULL::text[]

pgis_asflatgeobuf_finalfn(internal) bytea
pgis_asflatgeobuf_transfn(internal, anyelement) internal
pgis_asflatgeobuf_transfn(internal, anyelement, boolean) internal
pgis_asflatgeobuf_transfn(internal, anyelement, boolean, text) internal
pgis_asgeobuf_finalfn(internal) bytea
pgis_asgeobuf_transfn(internal, anyelement) internal
pgis_asgeobuf_transfn(internal, anyelement, text) internal
pgis_asmvt_combinefn(internal, internal) internal
pgis_asmvt_deserialfn(bytea, internal) internal
pgis_asmvt_finalfn(internal) bytea
pgis_asmvt_serialfn(internal) bytea
pgis_asmvt_transfn(internal, anyelement) internal
pgis_asmvt_transfn(internal, anyelement, text) internal
pgis_asmvt_transfn(internal, anyelement, text, integer) internal
pgis_asmvt_transfn(internal, anyelement, text, integer, text) internal
pgis_asmvt_transfn(internal, anyelement, text, integer, text, text) internal
pgis_geometry_accum_transfn(internal, USER-DEFINED) internal

Argument names: internal, geometry

pgis_geometry_accum_transfn(internal, USER-DEFINED, double precision) internal

Argument names: internal, geometry, double precision

pgis_geometry_accum_transfn(internal, USER-DEFINED, double precision, integer) internal

Argument names: internal, geometry, double precision, integer

pgis_geometry_clusterintersecting_finalfn(internal) _geometry
pgis_geometry_clusterwithin_finalfn(internal) _geometry
pgis_geometry_collect_finalfn(internal) geometry
pgis_geometry_makeline_finalfn(internal) geometry
pgis_geometry_polygonize_finalfn(internal) geometry
pgis_geometry_union_finalfn(internal) geometry
point(USER-DEFINED) point

Argument names: geometry

polygon(USER-DEFINED) polygon

Argument names: geometry

populate_geometry_columns(boolean) text

args: use_typmod=true - Ensures geometry columns are defined with type modifiers or have appropriate spatial constraints.

Argument names: use_typmod boolean DEFAULT true

populate_geometry_columns(oid, boolean) int4

args: relation_oid, use_typmod=true - Ensures geometry columns are defined with type modifiers or have appropriate spatial constraints.

Argument names: tbl_oid oid, use_typmod boolean DEFAULT true

postgis_addbbox(USER-DEFINED) geometry

args: geomA - Add bounding box to the geometry.

Argument names: geometry

postgis_cache_bbox() trigger
postgis_constraint_dims(text, text, text) int4

Argument names: geomschema text, geomtable text, geomcolumn text

postgis_constraint_srid(text, text, text) int4

Argument names: geomschema text, geomtable text, geomcolumn text

postgis_constraint_type(text, text, text) varchar

Argument names: geomschema text, geomtable text, geomcolumn text

postgis_dropbbox(USER-DEFINED) geometry

args: geomA - Drop the bounding box cache from the geometry.

Argument names: geometry

postgis_extensions_upgrade() text

Packages and upgrades PostGIS extensions (e.g. postgis_raster,postgis_topology, postgis_sfcgal) to latest available version.

postgis_full_version() text

Reports full PostGIS version and build configuration infos.

postgis_geos_noop(USER-DEFINED) geometry

Argument names: geometry

postgis_geos_version() text

Returns the version number of the GEOS library.

postgis_getbbox(USER-DEFINED) box2d

Argument names: geometry

postgis_hasbbox(USER-DEFINED) bool

args: geomA - Returns TRUE if the bbox of this geometry is cached, FALSE otherwise.

Argument names: geometry

postgis_index_supportfn(internal) internal
postgis_lib_build_date() text

Returns build date of the PostGIS library.

postgis_lib_revision() text
postgis_lib_version() text

Returns the version number of the PostGIS library.

postgis_libjson_version() text
postgis_liblwgeom_version() text

Returns the version number of the liblwgeom library. This should match the version of PostGIS.

postgis_libprotobuf_version() text
postgis_libxml_version() text

Returns the version number of the libxml2 library.

postgis_noop(USER-DEFINED) geometry

Argument names: geometry

postgis_proj_version() text

Returns the version number of the PROJ4 library.

postgis_scripts_build_date() text

Returns build date of the PostGIS scripts.

postgis_scripts_installed() text

Returns version of the PostGIS scripts installed in this database.

postgis_scripts_released() text

Returns the version number of the postgis.sql script released with the installed PostGIS lib.

postgis_svn_version() text
postgis_transform_geometry(USER-DEFINED, text, text, integer) geometry

Argument names: geom geometry, text, text, integer

postgis_type_name(character varying, integer, boolean) varchar

Argument names: geomname character varying, coord_dimension integer, use_new_name boolean DEFAULT true

postgis_typmod_dims(integer) int4
postgis_typmod_srid(integer) int4
postgis_typmod_type(integer) text
postgis_version() text

Returns PostGIS version number and compile-time options.

postgis_wagyu_version() text

Returns the version number of the internal Wagyu library.

py3_return_version() text
rel_columns(text, text) _text

Argument names: p_relname text, p_schemaname text DEFAULT NULL::text

round(double precision, integer) numeric

Cast for ROUND(float,x). Useful for SUM, AVG, etc. See also https://stackoverflow.com/a/20934099/287948.

round(double precision, double precision) float8

ROUND by accuracy. See Round9 at https://stackoverflow.com/a/20933882/287948

Argument names: input double precision, accuracy double precision

round(ARRAY, double precision) _float8

ROUND array of floats by accuracy. A wrap for ROUND(float,float).

Argument names: input double precision[], accuracy double precision

round_minutes(timestamp without time zone, integer) timestamp

Argument names: input timestamp without time zone, countunit_minutes integer

round_minutes(timestamp without time zone, integer, text) text

Argument names: input timestamp without time zone, countunit_minutes integer, str_format text

spheroid_in(cstring) spheroid
spheroid_out(USER-DEFINED) cstring

Argument names: spheroid

sql_parse_selectcols(ARRAY) _text

Argument names: selcols text[]

sql_parse_selectcols_simple(text) text

Argument names: s text

srid_utmzone_from4326(USER-DEFINED) int4

Argument names: p_geom geometry

srid_utmzone_title(integer) text

Argument names: p_srid integer

srid_utmzone_title(USER-DEFINED) text

Argument names: p_geom geometry

st_3dclosestpoint(USER-DEFINED, USER-DEFINED) geometry

args: g1, g2 - Returns the 3D point on g1 that is closest to g2. This is the first point of the 3D shortest line.

Argument names: geom1 geometry, geom2 geometry

st_3ddfullywithin(USER-DEFINED, USER-DEFINED, double precision) bool

Argument names: geom1 geometry, geom2 geometry, double precision

st_3ddistance(USER-DEFINED, USER-DEFINED) float8

args: g1, g2 - Returns the 3D cartesian minimum distance (based on spatial ref) between two geometries in projected units.

Argument names: geom1 geometry, geom2 geometry

st_3ddwithin(USER-DEFINED, USER-DEFINED, double precision) bool

Argument names: geom1 geometry, geom2 geometry, double precision

st_3dextent(USER-DEFINED) box3d

args: geomfield - Aggregate function that returns the 3D bounding box of geometries.

Argument names: geometry

st_3dintersects(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

st_3dlength(USER-DEFINED) float8

args: a_3dlinestring - Returns the 3D length of a linear geometry.

Argument names: geometry

st_3dlineinterpolatepoint(USER-DEFINED, double precision) geometry

args: a_linestring, a_fraction - Returns a point interpolated along a 3D line at a fractional location.

Argument names: geometry, double precision

st_3dlongestline(USER-DEFINED, USER-DEFINED) geometry

args: g1, g2 - Returns the 3D longest line between two geometries

Argument names: geom1 geometry, geom2 geometry

st_3dmakebox(USER-DEFINED, USER-DEFINED) box3d

args: point3DLowLeftBottom, point3DUpRightTop - Creates a BOX3D defined by two 3D point geometries.

Argument names: geom1 geometry, geom2 geometry

st_3dmaxdistance(USER-DEFINED, USER-DEFINED) float8

args: g1, g2 - Returns the 3D cartesian maximum distance (based on spatial ref) between two geometries in projected units.

Argument names: geom1 geometry, geom2 geometry

st_3dperimeter(USER-DEFINED) float8

args: geomA - Returns the 3D perimeter of a polygonal geometry.

Argument names: geometry

st_3dshortestline(USER-DEFINED, USER-DEFINED) geometry

args: g1, g2 - Returns the 3D shortest line between two geometries

Argument names: geom1 geometry, geom2 geometry

st_addmeasure(USER-DEFINED, double precision, double precision) geometry

args: geom_mline, measure_start, measure_end - Interpolates measures along a linear geometry.

Argument names: geometry, double precision, double precision

st_addpoint(USER-DEFINED, USER-DEFINED) geometry

args: linestring, point - Add a point to a LineString.

Argument names: geom1 geometry, geom2 geometry

st_addpoint(USER-DEFINED, USER-DEFINED, integer) geometry

args: linestring, point, position = -1 - Add a point to a LineString.

Argument names: geom1 geometry, geom2 geometry, integer

st_affine(USER-DEFINED, double precision, double precision, double precision, double precision, double precision, double precision, double precision, double precision, double precision, double precision, double precision, double precision) geometry

args: geomA, a, b, c, d, e, f, g, h, i, xoff, yoff, zoff - Apply a 3D affine transformation to a geometry.

Argument names: geometry, double precision, double precision, double precision, double precision, double precision, double precision, double precision, double precision, double precision, double precision, double precision, double precision

st_affine(USER-DEFINED, double precision, double precision, double precision, double precision, double precision, double precision) geometry

args: geomA, a, b, d, e, xoff, yoff - Apply a 3D affine transformation to a geometry.

Argument names: geometry, double precision, double precision, double precision, double precision, double precision, double precision

st_angle(USER-DEFINED, USER-DEFINED, USER-DEFINED, USER-DEFINED) float8

args: point1, point2, point3, point4 - Returns the angle between two vectors defined by 3 or 4 points, or 2 lines.

Argument names: pt1 geometry, pt2 geometry, pt3 geometry, pt4 geometry DEFAULT '0101000000000000000000F87F000000000000F87F'::geometry

st_angle(USER-DEFINED, USER-DEFINED) float8

args: line1, line2 - Returns the angle between two vectors defined by 3 or 4 points, or 2 lines.

Argument names: line1 geometry, line2 geometry

st_area(USER-DEFINED) float8

args: g1 - Returns the area of a polygonal geometry.

Argument names: geometry

st_area(USER-DEFINED, boolean) float8

args: geog, use_spheroid=true - Returns the area of a polygonal geometry.

Argument names: geog geography, use_spheroid boolean DEFAULT true

st_area(text) float8
st_area2d(USER-DEFINED) float8

Argument names: geometry

st_asbinary(USER-DEFINED, text) bytea

Argument names: geometry, text

st_asbinary(USER-DEFINED) bytea

Argument names: geometry

st_asbinary(USER-DEFINED) bytea

Argument names: geography

st_asbinary(USER-DEFINED, text) bytea

Argument names: geography, text

st_asencodedpolyline(USER-DEFINED, integer) text

Argument names: geom geometry, nprecision integer DEFAULT 5

st_asewkb(USER-DEFINED) bytea

Argument names: geometry

st_asewkb(USER-DEFINED, text) bytea

Argument names: geometry, text

st_asewkt(USER-DEFINED) text

Argument names: geometry

st_asewkt(USER-DEFINED, integer) text

Argument names: geometry, integer

st_asewkt(USER-DEFINED) text

Argument names: geography

st_asewkt(USER-DEFINED, integer) text

Argument names: geography, integer

st_asewkt(text) text
st_asflatgeobuf(anyelement) bytea
st_asflatgeobuf(anyelement, boolean) bytea
st_asflatgeobuf(anyelement, boolean, text) bytea
st_asgeobuf(anyelement) bytea
st_asgeobuf(anyelement, text) bytea
st_asgeojson(USER-DEFINED, integer, integer) text

Argument names: geom geometry, maxdecimaldigits integer DEFAULT 9, options integer DEFAULT 8

st_asgeojson(record, text, integer, boolean) text

Argument names: r record, geom_column text DEFAULT ''::text, maxdecimaldigits integer DEFAULT 9, pretty_bool boolean DEFAULT false

st_asgeojson(USER-DEFINED, integer, integer) text

Argument names: geog geography, maxdecimaldigits integer DEFAULT 9, options integer DEFAULT 0

st_asgeojson(text) text
st_asgeojsonb(USER-DEFINED, integer, integer, text, jsonb, text, text, boolean) jsonb

Enhances ST_AsGeoJSON() PostGIS function. Use ST_AsGeoJSONb( geom, 6, 1, osm_id::text, stable.element_properties(osm_id) - 'name:' ).

Argument names: p_geom geometry, p_decimals integer DEFAULT 6, p_options integer DEFAULT 0, p_id text DEFAULT NULL::text, p_properties jsonb DEFAULT NULL::jsonb, p_name text DEFAULT NULL::text, p_title text DEFAULT NULL::text, p_id_as_int boolean DEFAULT false

st_asgml(USER-DEFINED, integer, integer) text

Argument names: geom geometry, maxdecimaldigits integer DEFAULT 15, options integer DEFAULT 0

st_asgml(integer, USER-DEFINED, integer, integer, text, text) text

Argument names: version integer, geom geometry, maxdecimaldigits integer DEFAULT 15, options integer DEFAULT 0, nprefix text DEFAULT NULL::text, id text DEFAULT NULL::text

st_asgml(integer, USER-DEFINED, integer, integer, text, text) text

Argument names: version integer, geog geography, maxdecimaldigits integer DEFAULT 15, options integer DEFAULT 0, nprefix text DEFAULT 'gml'::text, id text DEFAULT ''::text

st_asgml(USER-DEFINED, integer, integer, text, text) text

Argument names: geog geography, maxdecimaldigits integer DEFAULT 15, options integer DEFAULT 0, nprefix text DEFAULT 'gml'::text, id text DEFAULT ''::text

st_asgml(text) text
st_ashexewkb(USER-DEFINED) text

Argument names: geometry

st_ashexewkb(USER-DEFINED, text) text

Argument names: geometry, text

st_askml(USER-DEFINED, integer, text) text

Argument names: geom geometry, maxdecimaldigits integer DEFAULT 15, nprefix text DEFAULT ''::text

st_askml(USER-DEFINED, integer, text) text

Argument names: geog geography, maxdecimaldigits integer DEFAULT 15, nprefix text DEFAULT ''::text

st_askml(text) text
st_aslatlontext(USER-DEFINED, text) text

Argument names: geom geometry, tmpl text DEFAULT ''::text

st_asmvt(anyelement) bytea
st_asmvt(anyelement, text) bytea
st_asmvt(anyelement, text, integer) bytea
st_asmvt(anyelement, text, integer, text) bytea
st_asmvt(anyelement, text, integer, text, text) bytea
st_asmvtgeom(USER-DEFINED, USER-DEFINED, integer, integer, boolean) geometry

Argument names: geom geometry, bounds box2d, extent integer DEFAULT 4096, buffer integer DEFAULT 256, clip_geom boolean DEFAULT true

st_assvg(USER-DEFINED, integer, integer) text

Argument names: geom geometry, rel integer DEFAULT 0, maxdecimaldigits integer DEFAULT 15

st_assvg(USER-DEFINED, integer, integer) text

Argument names: geog geography, rel integer DEFAULT 0, maxdecimaldigits integer DEFAULT 15

st_assvg(text) text
st_astext(USER-DEFINED) text

Argument names: geometry

st_astext(USER-DEFINED, integer) text

Argument names: geometry, integer

st_astext(USER-DEFINED) text

Argument names: geography

st_astext(USER-DEFINED, integer) text

Argument names: geography, integer

st_astext(text) text
st_astwkb(USER-DEFINED, integer, integer, integer, boolean, boolean) bytea

Argument names: geom geometry, prec integer DEFAULT NULL::integer, prec_z integer DEFAULT NULL::integer, prec_m integer DEFAULT NULL::integer, with_sizes boolean DEFAULT NULL::boolean, with_boxes boolean DEFAULT NULL::boolean

st_astwkb(ARRAY, ARRAY, integer, integer, integer, boolean, boolean) bytea

Argument names: geom geometry[], ids bigint[], prec integer DEFAULT NULL::integer, prec_z integer DEFAULT NULL::integer, prec_m integer DEFAULT NULL::integer, with_sizes boolean DEFAULT NULL::boolean, with_boxes boolean DEFAULT NULL::boolean

st_asx3d(USER-DEFINED, integer, integer) text

Argument names: geom geometry, maxdecimaldigits integer DEFAULT 15, options integer DEFAULT 0

st_azimuth(USER-DEFINED, USER-DEFINED) float8

args: pointA, pointB - Returns the north-based azimuth of a line between two points.

Argument names: geom1 geometry, geom2 geometry

st_azimuth(USER-DEFINED, USER-DEFINED) float8

args: pointA, pointB - Returns the north-based azimuth of a line between two points.

Argument names: geog1 geography, geog2 geography

st_bdmpolyfromtext(text, integer) geometry
st_bdpolyfromtext(text, integer) geometry
st_boundary(USER-DEFINED) geometry

args: geomA - Returns the boundary of a geometry.

Argument names: geometry

st_boundingdiagonal(USER-DEFINED, boolean) geometry

args: geom, fits=false - Returns the diagonal of a geometrys bounding box.

Argument names: geom geometry, fits boolean DEFAULT false

st_box2dfromgeohash(text, integer) box2d

Argument names: text, integer DEFAULT NULL::integer

st_buffer(USER-DEFINED, double precision, text) geometry

args: g1, radius_of_buffer, buffer_style_parameters = ' - Computes a geometry covering all points within a given distance from a geometry.

Argument names: geom geometry, radius double precision, options text DEFAULT ''::text

st_buffer(USER-DEFINED, double precision, integer) geometry

args: g1, radius_of_buffer, num_seg_quarter_circle - Computes a geometry covering all points within a given distance from a geometry.

Argument names: geom geometry, radius double precision, quadsegs integer

st_buffer(USER-DEFINED, double precision) geography

Argument names: geography, double precision

st_buffer(USER-DEFINED, double precision, integer) geography

args: g1, radius_of_buffer, num_seg_quarter_circle - Computes a geometry covering all points within a given distance from a geometry.

Argument names: geography, double precision, integer

st_buffer(USER-DEFINED, double precision, text) geography

args: g1, radius_of_buffer, buffer_style_parameters - Computes a geometry covering all points within a given distance from a geometry.

Argument names: geography, double precision, text

st_buffer(text, double precision) geometry
st_buffer(text, double precision, integer) geometry
st_buffer(text, double precision, text) geometry
st_buildarea(USER-DEFINED) geometry

args: geom - Creates a polygonal geometry formed by the linework of a geometry.

Argument names: geometry

st_centroid(USER-DEFINED) geometry

args: g1 - Returns the geometric center of a geometry.

Argument names: geometry

st_centroid(USER-DEFINED, boolean) geography

args: g1, use_spheroid=true - Returns the geometric center of a geometry.

Argument names: geography, use_spheroid boolean DEFAULT true

st_centroid(text) geometry
st_chaikinsmoothing(USER-DEFINED, integer, boolean) geometry

args: geom, nIterations = 1, preserveEndPoints = false - Returns a smoothed version of a geometry, using the Chaikin algorithm

Argument names: geometry, integer DEFAULT 1, boolean DEFAULT false

st_cleangeometry(USER-DEFINED) geometry

Argument names: geometry

st_clipbybox2d(USER-DEFINED, USER-DEFINED) geometry

args: geom, box - Computes the portion of a geometry falling within a rectangle.

Argument names: geom geometry, box box2d

st_closestpoint(USER-DEFINED, USER-DEFINED) geometry

args: g1, g2 - Returns the 2D point on g1 that is closest to g2. This is the first point of the shortest line.

Argument names: geom1 geometry, geom2 geometry

st_closestpointofapproach(USER-DEFINED, USER-DEFINED) float8

args: track1, track2 - Returns a measure at the closest point of approach of two trajectories.

Argument names: geometry, geometry

st_clusterdbscan(USER-DEFINED, double precision, integer) int4

args: geom, eps, minpoints - Window function that returns a cluster id for each input geometry using the DBSCAN algorithm.

Argument names: geometry, eps double precision, minpoints integer

st_clusterintersecting(ARRAY) _geometry

Argument names: geometry[]

st_clusterintersecting(USER-DEFINED) _geometry

args: g - Aggregate function that clusters the input geometries into connected sets.

Argument names: geometry

st_clusterkmeans(USER-DEFINED, integer, double precision) int4

args: geom, number_of_clusters, max_radius - Window function that returns a cluster id for each input geometry using the K-means algorithm.

Argument names: geom geometry, k integer, max_radius double precision DEFAULT NULL::double precision

st_clusterwithin(ARRAY, double precision) _geometry

Argument names: geometry[], double precision

st_clusterwithin(USER-DEFINED, double precision) _geometry

args: g, distance - Aggregate function that clusters the input geometries by separation distance.

Argument names: geometry, double precision

st_collect(USER-DEFINED, USER-DEFINED) geometry

args: g1, g2 - Creates a GeometryCollection or Multi* geometry from a set of geometries.

Argument names: geom1 geometry, geom2 geometry

st_collect(ARRAY) geometry

args: g1_array - Creates a GeometryCollection or Multi* geometry from a set of geometries.

Argument names: geometry[]

st_collect(USER-DEFINED) geometry

args: g1field - Creates a GeometryCollection or Multi* geometry from a set of geometries.

Argument names: geometry

st_collectionextract(USER-DEFINED, integer) geometry

args: collection, type - Given a geometry collection, returns a multi-geometry containing only elements of a specified type.

Argument names: geometry, integer

st_collectionextract(USER-DEFINED) geometry

args: collection - Given a geometry collection, returns a multi-geometry containing only elements of a specified type.

Argument names: geometry

st_collectionhomogenize(USER-DEFINED) geometry

args: collection - Returns the simplest representation of a geometry collection.

Argument names: geometry

st_combinebbox(USER-DEFINED, USER-DEFINED) box3d

Argument names: box3d, geometry

st_combinebbox(USER-DEFINED, USER-DEFINED) box3d

Argument names: box3d, box3d

st_combinebbox(USER-DEFINED, USER-DEFINED) box2d

Argument names: box2d, geometry

st_concavehull(USER-DEFINED, double precision, boolean) geometry

args: geom, target_percent, allow_holes = false - Computes a possibly concave geometry that encloses all input geometry vertices

Argument names: param_geom geometry, param_pctconvex double precision, param_allow_holes boolean DEFAULT false

st_contains(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

st_containsproperly(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

st_convexhull(USER-DEFINED) geometry

args: geomA - Computes the convex hull of a geometry.

Argument names: geometry

st_coorddim(USER-DEFINED) int2

args: geomA - Return the coordinate dimension of a geometry.

Argument names: geometry geometry

st_coveredby(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

st_coveredby(USER-DEFINED, USER-DEFINED) bool

Argument names: geog1 geography, geog2 geography

st_coveredby(text, text) bool
st_covers(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

st_covers(USER-DEFINED, USER-DEFINED) bool

Argument names: geog1 geography, geog2 geography

st_covers(text, text) bool
st_cpawithin(USER-DEFINED, USER-DEFINED, double precision) bool

args: track1, track2, dist - Tests if the closest point of approach of two trajectoriesis within the specified distance.

Argument names: geometry, geometry, double precision

st_crosses(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

st_curvetoline(USER-DEFINED, double precision, integer, integer) geometry

args: curveGeom, tolerance, tolerance_type, flags - Converts a geometry containing curves to a linear geometry.

Argument names: geom geometry, tol double precision DEFAULT 32, toltype integer DEFAULT 0, flags integer DEFAULT 0

st_delaunaytriangles(USER-DEFINED, double precision, integer) geometry

args: g1, tolerance, flags - Returns the Delaunay triangulation of the vertices of a geometry.

Argument names: g1 geometry, tolerance double precision DEFAULT 0.0, flags integer DEFAULT 0

st_dfullywithin(USER-DEFINED, USER-DEFINED, double precision) bool

Argument names: geom1 geometry, geom2 geometry, double precision

st_difference(USER-DEFINED, USER-DEFINED, double precision) geometry

args: geomA, geomB, gridSize = -1 - Computes a geometry representing the part of geometry A that does not intersect geometry B.

Argument names: geom1 geometry, geom2 geometry, gridsize double precision DEFAULT '-1.0'::numeric

st_dimension(USER-DEFINED) int4

args: g - Returns the topological dimension of a geometry.

Argument names: geometry

st_disjoint(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

st_distance(USER-DEFINED, USER-DEFINED) float8

args: g1, g2 - Returns the distance between two geometry or geography values.

Argument names: geom1 geometry, geom2 geometry

st_distance(USER-DEFINED, USER-DEFINED, boolean) float8

args: geog1, geog2, use_spheroid=true - Returns the distance between two geometry or geography values.

Argument names: geog1 geography, geog2 geography, use_spheroid boolean DEFAULT true

st_distance(text, text) float8
st_distancecpa(USER-DEFINED, USER-DEFINED) float8

args: track1, track2 - Returns the distance between the closest point of approach of two trajectories.

Argument names: geometry, geometry

st_distancesphere(USER-DEFINED, USER-DEFINED) float8

args: geomlonlatA, geomlonlatB - Returns minimum distance in meters between two lon/lat geometries using a spherical earth model.

Argument names: geom1 geometry, geom2 geometry

st_distancespheroid(USER-DEFINED, USER-DEFINED, USER-DEFINED) float8

args: geomlonlatA, geomlonlatB, measurement_spheroid - Returns the minimum distance between two lon/lat geometries using a spheroidal earth model.

Argument names: geom1 geometry, geom2 geometry, spheroid

st_dump(USER-DEFINED) geometry_dump

args: g1 - Returns a set of geometry_dump rows for the components of a geometry.

Argument names: geometry

st_dumppoints(USER-DEFINED) geometry_dump

args: geom - Returns a set of geometry_dump rows for the coordinates in a geometry.

Argument names: geometry

st_dumprings(USER-DEFINED) geometry_dump

args: a_polygon - Returns a set of geometry_dump rows for the exterior and interior rings of a Polygon.

Argument names: geometry

st_dumpsegments(USER-DEFINED) geometry_dump

args: geom - Returns a set of geometry_dump rows for the segments in a geometry.

Argument names: geometry

st_dwithin(USER-DEFINED, USER-DEFINED, double precision) bool

Argument names: geom1 geometry, geom2 geometry, double precision

st_dwithin(USER-DEFINED, USER-DEFINED, double precision, boolean) bool

Argument names: geog1 geography, geog2 geography, tolerance double precision, use_spheroid boolean DEFAULT true

st_dwithin(text, text, double precision) bool
st_endpoint(USER-DEFINED) geometry

args: g - Returns the last point of a LineString or CircularLineString.

Argument names: geometry

st_envelope(USER-DEFINED) geometry

args: g1 - Returns a geometry representing the bounding box of a geometry.

Argument names: geometry

st_equals(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

st_estimatedextent(text, text, text, boolean) box2d

args: schema_name, table_name, geocolumn_name, parent_only - Returns the estimated extent of a spatial table.

st_estimatedextent(text, text, text) box2d

args: schema_name, table_name, geocolumn_name - Returns the estimated extent of a spatial table.

st_estimatedextent(text, text) box2d

args: table_name, geocolumn_name - Returns the estimated extent of a spatial table.

st_expand(USER-DEFINED, double precision) box2d

args: box, units_to_expand - Returns a bounding box expanded from another bounding box or a geometry.

Argument names: box2d, double precision

st_expand(USER-DEFINED, double precision, double precision) box2d

args: box, dx, dy - Returns a bounding box expanded from another bounding box or a geometry.

Argument names: box box2d, dx double precision, dy double precision

st_expand(USER-DEFINED, double precision) box3d

args: box, units_to_expand - Returns a bounding box expanded from another bounding box or a geometry.

Argument names: box3d, double precision

st_expand(USER-DEFINED, double precision, double precision, double precision) box3d

args: box, dx, dy, dz=0 - Returns a bounding box expanded from another bounding box or a geometry.

Argument names: box box3d, dx double precision, dy double precision, dz double precision DEFAULT 0

st_expand(USER-DEFINED, double precision) geometry

args: geom, units_to_expand - Returns a bounding box expanded from another bounding box or a geometry.

Argument names: geometry, double precision

st_expand(USER-DEFINED, double precision, double precision, double precision, double precision) geometry

args: geom, dx, dy, dz=0, dm=0 - Returns a bounding box expanded from another bounding box or a geometry.

Argument names: geom geometry, dx double precision, dy double precision, dz double precision DEFAULT 0, dm double precision DEFAULT 0

st_extent(USER-DEFINED) box2d

args: geomfield - Aggregate function that returns the bounding box of geometries.

Argument names: geometry

st_exteriorring(USER-DEFINED) geometry

args: a_polygon - Returns a LineString representing the exterior ring of a Polygon.

Argument names: geometry

st_filterbym(USER-DEFINED, double precision, double precision, boolean) geometry

args: geom, min, max = null, returnM = false - Removes vertices based on their M value

Argument names: geometry, double precision, double precision DEFAULT NULL::double precision, boolean DEFAULT false

st_findextent(text, text, text) box2d
st_findextent(text, text) box2d
st_flipcoordinates(USER-DEFINED) geometry

args: geom - Returns a version of a geometry with X and Y axis flipped.

Argument names: geometry

st_force2d(USER-DEFINED) geometry

args: geomA - Force the geometries into a "2-dimensional mode".

Argument names: geometry

st_force3d(USER-DEFINED, double precision) geometry

args: geomA, Zvalue = 0.0 - Force the geometries into XYZ mode. This is an alias for ST_Force3DZ.

Argument names: geom geometry, zvalue double precision DEFAULT 0.0

st_force3dm(USER-DEFINED, double precision) geometry

args: geomA, Mvalue = 0.0 - Force the geometries into XYM mode.

Argument names: geom geometry, mvalue double precision DEFAULT 0.0

st_force3dz(USER-DEFINED, double precision) geometry

args: geomA, Zvalue = 0.0 - Force the geometries into XYZ mode.

Argument names: geom geometry, zvalue double precision DEFAULT 0.0

st_force4d(USER-DEFINED, double precision, double precision) geometry

args: geomA, Zvalue = 0.0, Mvalue = 0.0 - Force the geometries into XYZM mode.

Argument names: geom geometry, zvalue double precision DEFAULT 0.0, mvalue double precision DEFAULT 0.0

st_forcecollection(USER-DEFINED) geometry

args: geomA - Convert the geometry into a GEOMETRYCOLLECTION.

Argument names: geometry

st_forcecurve(USER-DEFINED) geometry

args: g - Upcast a geometry into its curved type, if applicable.

Argument names: geometry

st_forcepolygonccw(USER-DEFINED) geometry

args: geom - Orients all exterior rings counter-clockwise and all interior rings clockwise.

Argument names: geometry

st_forcepolygoncw(USER-DEFINED) geometry

args: geom - Orients all exterior rings clockwise and all interior rings counter-clockwise.

Argument names: geometry

st_forcerhr(USER-DEFINED) geometry

args: g - Force the orientation of the vertices in a polygon to follow the Right-Hand-Rule.

Argument names: geometry

st_forcesfs(USER-DEFINED) geometry

args: geomA - Force the geometries to use SFS 1.1 geometry types only.

Argument names: geometry

st_forcesfs(USER-DEFINED, text) geometry

args: geomA, version - Force the geometries to use SFS 1.1 geometry types only.

Argument names: geometry, version text

st_frechetdistance(USER-DEFINED, USER-DEFINED, double precision) float8

args: g1, g2, densifyFrac = -1 - Returns the Fréchet distance between two geometries.

Argument names: geom1 geometry, geom2 geometry, double precision DEFAULT '-1'::integer

st_fromflatgeobuf(anyelement, bytea) anyelement
st_fromflatgeobuftotable(text, text, bytea) void
st_generatepoints(USER-DEFINED, integer) geometry

args: g, npoints - Generates random points contained in a Polygon or MultiPolygon.

Argument names: area geometry, npoints integer

st_generatepoints(USER-DEFINED, integer, integer) geometry

args: g, npoints, seed - Generates random points contained in a Polygon or MultiPolygon.

Argument names: area geometry, npoints integer, seed integer

st_geogfromtext(text) geography
st_geogfromwkb(bytea) geography
st_geographyfromtext(text) geography
st_geohash(USER-DEFINED, integer) text

Argument names: geom geometry, maxchars integer DEFAULT 0

st_geohash(USER-DEFINED, integer) text

Argument names: geog geography, maxchars integer DEFAULT 0

st_geomcollfromtext(text, integer) geometry
st_geomcollfromtext(text) geometry
st_geomcollfromwkb(bytea, integer) geometry
st_geomcollfromwkb(bytea) geometry
st_geometricmedian(USER-DEFINED, double precision, integer, boolean) geometry

args: geom, tolerance = NULL, max_iter = 10000, fail_if_not_converged = false - Returns the geometric median of a MultiPoint.

Argument names: g geometry, tolerance double precision DEFAULT NULL::double precision, max_iter integer DEFAULT 10000, fail_if_not_converged boolean DEFAULT false

st_geometryfromtext(text) geometry
st_geometryfromtext(text, integer) geometry
st_geometryn(USER-DEFINED, integer) geometry

args: geomA, n - Return an element of a geometry collection.

Argument names: geometry, integer

st_geometrytype(USER-DEFINED) text

args: g1 - Returns the SQL-MM type of a geometry as text.

Argument names: geometry

st_geomfromewkb(bytea) geometry
st_geomfromewkt(text) geometry
st_geomfromgeohash(text, integer) geometry

Argument names: text, integer DEFAULT NULL::integer

st_geomfromgeojson(text) geometry
st_geomfromgeojson(json) geometry
st_geomfromgeojson(jsonb) geometry
st_geomfromgml(text, integer) geometry
st_geomfromgml(text) geometry
st_geomfromkml(text) geometry
st_geomfromtext(text) geometry
st_geomfromtext(text, integer) geometry
st_geomfromtwkb(bytea) geometry
st_geomfromwkb(bytea) geometry
st_geomfromwkb(bytea, integer) geometry
st_gmltosql(text) geometry
st_gmltosql(text, integer) geometry
st_hasarc(USER-DEFINED) bool

args: geomA - Tests if a geometry contains a circular arc

Argument names: geometry geometry

st_hausdorffdistance(USER-DEFINED, USER-DEFINED) float8

args: g1, g2 - Returns the Hausdorff distance between two geometries.

Argument names: geom1 geometry, geom2 geometry

st_hausdorffdistance(USER-DEFINED, USER-DEFINED, double precision) float8

args: g1, g2, densifyFrac - Returns the Hausdorff distance between two geometries.

Argument names: geom1 geometry, geom2 geometry, double precision

st_hexagon(double precision, integer, integer, USER-DEFINED) geometry

args: size, cell_i, cell_j, origin - Returns a single hexagon, using the provided edge size and cell coordinate within the hexagon grid space.

Argument names: size double precision, cell_i integer, cell_j integer, origin geometry DEFAULT '010100000000000000000000000000000000000000'::geometry

st_hexagongrid(double precision, USER-DEFINED, USER-DEFINED, integer, integer) record

args: size, bounds - Returns a set of hexagons and cell indices that completely cover the bounds of the geometry argument.

Argument names: size double precision, bounds geometry, OUT geom geometry, OUT i integer, OUT j integer

st_interiorringn(USER-DEFINED, integer) geometry

args: a_polygon, n - Returns the Nth interior ring (hole) of a Polygon.

Argument names: geometry, integer

st_interpolatepoint(USER-DEFINED, USER-DEFINED) float8

args: line, point - Returns the interpolated measure of a geometry closest to a point.

Argument names: line geometry, point geometry

st_intersection(USER-DEFINED, USER-DEFINED, double precision) geometry

args: geomA, geomB, gridSize = -1 - Computes a geometry representing the shared portion of geometries A and B.

Argument names: geom1 geometry, geom2 geometry, gridsize double precision DEFAULT '-1'::integer

st_intersection(USER-DEFINED, USER-DEFINED) geography

args: geogA, geogB - Computes a geometry representing the shared portion of geometries A and B.

Argument names: geography, geography

st_intersection(text, text) geometry
st_intersects(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

st_intersects(USER-DEFINED, USER-DEFINED) bool

Argument names: geog1 geography, geog2 geography

st_intersects(text, text) bool
st_isclosed(USER-DEFINED) bool

args: g - Tests if a LineStringss start and end points are coincident. For a PolyhedralSurface tests if it is closed (volumetric).

Argument names: geometry

st_iscollection(USER-DEFINED) bool

args: g - Tests if a geometry is a geometry collection type.

Argument names: geometry

st_isempty(USER-DEFINED) bool

args: geomA - Tests if a geometry is empty.

Argument names: geometry

st_ispolygonccw(USER-DEFINED) bool

args: geom - Tests if Polygons have exterior rings oriented counter-clockwise and interior rings oriented clockwise.

Argument names: geometry

st_ispolygoncw(USER-DEFINED) bool

args: geom - Tests if Polygons have exterior rings oriented clockwise and interior rings oriented counter-clockwise.

Argument names: geometry

st_isring(USER-DEFINED) bool

args: g - Tests if a LineString is closed and simple.

Argument names: geometry

st_issimple(USER-DEFINED) bool

args: geomA - Tests if a geometry has no points of self-intersection or self-tangency.

Argument names: geometry

st_isvalid(USER-DEFINED, integer) bool

args: g, flags - Tests if a geometry is well-formed in 2D.

Argument names: geometry, integer

st_isvalid(USER-DEFINED) bool

args: g - Tests if a geometry is well-formed in 2D.

Argument names: geometry

st_isvaliddetail(USER-DEFINED, integer) valid_detail

args: geom, flags - Returns a valid_detail row stating if a geometry is valid or if not a reason and a location.

Argument names: geom geometry, flags integer DEFAULT 0

st_isvalidreason(USER-DEFINED) text

args: geomA - Returns text stating if a geometry is valid, or a reason for invalidity.

Argument names: geometry

st_isvalidreason(USER-DEFINED, integer) text

args: geomA, flags - Returns text stating if a geometry is valid, or a reason for invalidity.

Argument names: geometry, integer

st_isvalidtrajectory(USER-DEFINED) bool

args: line - Tests if the geometry is a valid trajectory.

Argument names: geometry

st_length(USER-DEFINED) float8

args: a_2dlinestring - Returns the 2D length of a linear geometry.

Argument names: geometry

st_length(USER-DEFINED, boolean) float8

args: geog, use_spheroid=true - Returns the 2D length of a linear geometry.

Argument names: geog geography, use_spheroid boolean DEFAULT true

st_length(text) float8
st_length2d(USER-DEFINED) float8

args: a_2dlinestring - Returns the 2D length of a linear geometry. Alias for ST_Length

Argument names: geometry

st_length2dspheroid(USER-DEFINED, USER-DEFINED) float8

Argument names: geometry, spheroid

st_lengthspheroid(USER-DEFINED, USER-DEFINED) float8

args: a_geometry, a_spheroid - Returns the 2D or 3D length/perimeter of a lon/lat geometry on a spheroid.

Argument names: geometry, spheroid

st_linecrossingdirection(USER-DEFINED, USER-DEFINED) int4

Argument names: line1 geometry, line2 geometry

st_linefromencodedpolyline(text, integer) geometry

Argument names: txtin text, nprecision integer DEFAULT 5

st_linefrommultipoint(USER-DEFINED) geometry

args: aMultiPoint - Creates a LineString from a MultiPoint geometry.

Argument names: geometry

st_linefromtext(text) geometry
st_linefromtext(text, integer) geometry
st_linefromwkb(bytea, integer) geometry
st_linefromwkb(bytea) geometry
st_lineinterpolatepoint(USER-DEFINED, double precision) geometry

args: a_linestring, a_fraction - Returns a point interpolated along a line at a fractional location.

Argument names: geometry, double precision

st_lineinterpolatepoints(USER-DEFINED, double precision, boolean) geometry

args: a_linestring, a_fraction, repeat - Returns points interpolated along a line at a fractional interval.

Argument names: geometry, double precision, repeat boolean DEFAULT true

st_linelocatepoint(USER-DEFINED, USER-DEFINED) float8

args: a_linestring, a_point - Returns the fractional location of the closest point on a line to a point.

Argument names: geom1 geometry, geom2 geometry

st_linemerge(USER-DEFINED) geometry

args: amultilinestring - Return the lines formed by sewing together a MultiLineString.

Argument names: geometry

st_linestringfromwkb(bytea, integer) geometry
st_linestringfromwkb(bytea) geometry
st_linesubstring(USER-DEFINED, double precision, double precision) geometry

args: a_linestring, startfraction, endfraction - Returns the part of a line between two fractional locations.

Argument names: geometry, double precision, double precision

st_linetocurve(USER-DEFINED) geometry

args: geomANoncircular - Converts a linear geometry to a curved geometry.

Argument names: geometry geometry

st_locatealong(USER-DEFINED, double precision, double precision) geometry

args: geom_with_measure, measure, offset = 0 - Returns the point(s) on a geometry that match a measure value.

Argument names: geometry geometry, measure double precision, leftrightoffset double precision DEFAULT 0.0

st_locatebetween(USER-DEFINED, double precision, double precision, double precision) geometry

args: geom, measure_start, measure_end, offset = 0 - Returns the portions of a geometry that match a measure range.

Argument names: geometry geometry, frommeasure double precision, tomeasure double precision, leftrightoffset double precision DEFAULT 0.0

st_locatebetweenelevations(USER-DEFINED, double precision, double precision) geometry

args: geom, elevation_start, elevation_end - Returns the portions of a geometry that lie in an elevation (Z) range.

Argument names: geometry geometry, fromelevation double precision, toelevation double precision

st_longestline(USER-DEFINED, USER-DEFINED) geometry

args: g1, g2 - Returns the 2D longest line between two geometries.

Argument names: geom1 geometry, geom2 geometry

st_m(USER-DEFINED) float8

args: a_point - Returns the M coordinate of a Point.

Argument names: geometry

st_makebox2d(USER-DEFINED, USER-DEFINED) box2d

args: pointLowLeft, pointUpRight - Creates a BOX2D defined by two 2D point geometries.

Argument names: geom1 geometry, geom2 geometry

st_makeenvelope(double precision, double precision, double precision, double precision, integer) geometry

args: xmin, ymin, xmax, ymax, srid=unknown - Creates a rectangular Polygon from minimum and maximum coordinates.

Argument names: double precision, double precision, double precision, double precision, integer DEFAULT 0

st_makeline(ARRAY) geometry

args: geoms_array - Creates a LineString from Point, MultiPoint, or LineString geometries.

Argument names: geometry[]

st_makeline(USER-DEFINED, USER-DEFINED) geometry

args: geom1, geom2 - Creates a LineString from Point, MultiPoint, or LineString geometries.

Argument names: geom1 geometry, geom2 geometry

st_makeline(USER-DEFINED) geometry

args: geoms - Creates a LineString from Point, MultiPoint, or LineString geometries.

Argument names: geometry

st_makepoint(double precision, double precision) geometry

args: x, y - Creates a 2D, 3DZ or 4D Point.

st_makepoint(double precision, double precision, double precision) geometry

args: x, y, z - Creates a 2D, 3DZ or 4D Point.

st_makepoint(double precision, double precision, double precision, double precision) geometry

args: x, y, z, m - Creates a 2D, 3DZ or 4D Point.

st_makepointm(double precision, double precision, double precision) geometry

args: x, y, m - Creates a Point from X, Y and M values.

st_makepolygon(USER-DEFINED, ARRAY) geometry

args: outerlinestring, interiorlinestrings - Creates a Polygon from a shell and optional list of holes.

Argument names: geometry, geometry[]

st_makepolygon(USER-DEFINED) geometry

args: linestring - Creates a Polygon from a shell and optional list of holes.

Argument names: geometry

st_makevalid(USER-DEFINED) geometry

args: input - Attempts to make an invalid geometry valid without losing vertices.

Argument names: geometry

st_makevalid(USER-DEFINED, text) geometry

args: input, params - Attempts to make an invalid geometry valid without losing vertices.

Argument names: geom geometry, params text

st_maxdistance(USER-DEFINED, USER-DEFINED) float8

args: g1, g2 - Returns the 2D largest distance between two geometries in projected units.

Argument names: geom1 geometry, geom2 geometry

st_maximuminscribedcircle(USER-DEFINED, USER-DEFINED, USER-DEFINED, double precision) record

args: geom - Computes the largest circle that is fully contained within a geometry.

Argument names: geometry, OUT center geometry, OUT nearest geometry, OUT radius double precision

st_memcollect(USER-DEFINED) geometry

Argument names: geometry

st_memsize(USER-DEFINED) int4

args: geomA - Returns the amount of memory space a geometry takes.

Argument names: geometry

st_memunion(USER-DEFINED) geometry

args: geomfield - Aggregate function which unions geometries in a memory-efficent but slower way

Argument names: geometry

st_minimumboundingcircle(USER-DEFINED, integer) geometry

args: geomA, num_segs_per_qt_circ=48 - Returns the smallest circle polygon that contains a geometry.

Argument names: inputgeom geometry, segs_per_quarter integer DEFAULT 48

st_minimumboundingradius(USER-DEFINED, USER-DEFINED, double precision) record

args: geom - Returns the center point and radius of the smallest circle that contains a geometry.

Argument names: geometry, OUT center geometry, OUT radius double precision

st_minimumclearance(USER-DEFINED) float8

args: g - Returns the minimum clearance of a geometry, a measure of a geometrys robustness.

Argument names: geometry

st_minimumclearanceline(USER-DEFINED) geometry

args: g - Returns the two-point LineString spanning a geometrys minimum clearance.

Argument names: geometry

st_mlinefromtext(text, integer) geometry
st_mlinefromtext(text) geometry
st_mlinefromwkb(bytea, integer) geometry
st_mlinefromwkb(bytea) geometry
st_mpointfromtext(text, integer) geometry
st_mpointfromtext(text) geometry
st_mpointfromwkb(bytea, integer) geometry
st_mpointfromwkb(bytea) geometry
st_mpolyfromtext(text, integer) geometry
st_mpolyfromtext(text) geometry
st_mpolyfromwkb(bytea, integer) geometry
st_mpolyfromwkb(bytea) geometry
st_multi(USER-DEFINED) geometry

args: geom - Return the geometry as a MULTI* geometry.

Argument names: geometry

st_multilinefromwkb(bytea) geometry
st_multilinestringfromtext(text) geometry
st_multilinestringfromtext(text, integer) geometry
st_multipointfromtext(text) geometry
st_multipointfromwkb(bytea, integer) geometry
st_multipointfromwkb(bytea) geometry
st_multipolyfromwkb(bytea, integer) geometry
st_multipolyfromwkb(bytea) geometry
st_multipolygonfromtext(text, integer) geometry
st_multipolygonfromtext(text) geometry
st_ndims(USER-DEFINED) int2

args: g1 - Returns the coordinate dimension of a geometry.

Argument names: geometry

st_node(USER-DEFINED) geometry

args: geom - Nodes a collection of lines.

Argument names: g geometry

st_normalize(USER-DEFINED) geometry

args: geom - Return the geometry in its canonical form.

Argument names: geom geometry

st_npoints(USER-DEFINED) int4

args: g1 - Returns the number of points (vertices) in a geometry.

Argument names: geometry

st_nrings(USER-DEFINED) int4

args: geomA - Returns the number of rings in a polygonal geometry.

Argument names: geometry

st_numgeometries(USER-DEFINED) int4

args: geom - Returns the number of elements in a geometry collection.

Argument names: geometry

st_numinteriorring(USER-DEFINED) int4

args: a_polygon - Returns the number of interior rings (holes) of a Polygon. Aias for ST_NumInteriorRings

Argument names: geometry

st_numinteriorrings(USER-DEFINED) int4

args: a_polygon - Returns the number of interior rings (holes) of a Polygon.

Argument names: geometry

st_numpatches(USER-DEFINED) int4

args: g1 - Return the number of faces on a Polyhedral Surface. Will return null for non-polyhedral geometries.

Argument names: geometry

st_numpoints(USER-DEFINED) int4

args: g1 - Returns the number of points in a LineString or CircularString.

Argument names: geometry

st_offsetcurve(USER-DEFINED, double precision, text) geometry

args: line, signed_distance, style_parameters=' - Returns an offset line at a given distance and side from an input line.

Argument names: line geometry, distance double precision, params text DEFAULT ''::text

st_orderingequals(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

st_orientedenvelope(USER-DEFINED) geometry

args: geom - Returns a minimum-area rectangle containing a geometry.

Argument names: geometry

st_overlaps(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

st_patchn(USER-DEFINED, integer) geometry

args: geomA, n - Returns the Nth geometry (face) of a PolyhedralSurface.

Argument names: geometry, integer

st_perimeter(USER-DEFINED) float8

args: g1 - Returns the length of the boundary of a polygonal geometry or geography.

Argument names: geometry

st_perimeter(USER-DEFINED, boolean) float8

args: geog, use_spheroid=true - Returns the length of the boundary of a polygonal geometry or geography.

Argument names: geog geography, use_spheroid boolean DEFAULT true

st_perimeter2d(USER-DEFINED) float8

args: geomA - Returns the 2D perimeter of a polygonal geometry. Alias for ST_Perimeter.

Argument names: geometry

st_point(double precision, double precision) geometry

args: x, y - Creates a Point with the given coordinate values. Alias for ST_MakePoint.

st_point(double precision, double precision, integer) geometry

args: x, y, srid=unknown - Creates a Point with the given coordinate values. Alias for ST_MakePoint.

Argument names: double precision, double precision, srid integer

st_pointfromgeohash(text, integer) geometry

Argument names: text, integer DEFAULT NULL::integer

st_pointfromtext(text) geometry
st_pointfromtext(text, integer) geometry
st_pointfromwkb(bytea, integer) geometry
st_pointfromwkb(bytea) geometry
st_pointinsidecircle(USER-DEFINED, double precision, double precision, double precision) bool

Argument names: geometry, double precision, double precision, double precision

st_pointm(double precision, double precision, double precision, integer) geometry

Argument names: xcoordinate double precision, ycoordinate double precision, mcoordinate double precision, srid integer DEFAULT 0

st_pointn(USER-DEFINED, integer) geometry

args: a_linestring, n - Returns the Nth point in the first LineString or circular LineString in a geometry.

Argument names: geometry, integer

st_pointonsurface(USER-DEFINED) geometry

args: g1 - Computes a point guaranteed to lie in a polygon, or on a geometry.

Argument names: geometry

st_points(USER-DEFINED) geometry

args: geom - Returns a MultiPoint containing the coordinates of a geometry.

Argument names: geometry

st_pointz(double precision, double precision, double precision, integer) geometry

args: x, y, m, srid=unknown - Creates a Point with the given coordinate and SRID values.

Argument names: xcoordinate double precision, ycoordinate double precision, zcoordinate double precision, srid integer DEFAULT 0

st_pointzm(double precision, double precision, double precision, double precision, integer) geometry

args: x, y, z, m, srid=unknown - Creates a Point with the given coordinate and SRID values.

Argument names: xcoordinate double precision, ycoordinate double precision, zcoordinate double precision, mcoordinate double precision, srid integer DEFAULT 0

st_polyfromtext(text) geometry
st_polyfromtext(text, integer) geometry
st_polyfromwkb(bytea, integer) geometry
st_polyfromwkb(bytea) geometry
st_polygon(USER-DEFINED, integer) geometry

args: lineString, srid - Creates a Polygon from a LineString with a specified SRID.

Argument names: geometry, integer

st_polygonfromtext(text, integer) geometry
st_polygonfromtext(text) geometry
st_polygonfromwkb(bytea, integer) geometry
st_polygonfromwkb(bytea) geometry
st_polygonize(ARRAY) geometry

args: geom_array - Computes a collection of polygons formed from the linework of a set of geometries.

Argument names: geometry[]

st_polygonize(USER-DEFINED) geometry

args: geomfield - Computes a collection of polygons formed from the linework of a set of geometries.

Argument names: geometry

st_project(USER-DEFINED, double precision, double precision) geography

args: g1, distance, azimuth - Returns a point projected from a start point by a distance and bearing (azimuth).

Argument names: geog geography, distance double precision, azimuth double precision

st_quantizecoordinates(USER-DEFINED, integer, integer, integer, integer) geometry

args: g, prec_x, prec_y, prec_z, prec_m - Sets least significant bits of coordinates to zero

Argument names: g geometry, prec_x integer, prec_y integer DEFAULT NULL::integer, prec_z integer DEFAULT NULL::integer, prec_m integer DEFAULT NULL::integer

st_reduceprecision(USER-DEFINED, double precision) geometry

args: g, gridsize - Returns a valid geometry with points rounded to a grid tolerance.

Argument names: geom geometry, gridsize double precision

st_relate(USER-DEFINED, USER-DEFINED) text

Argument names: geom1 geometry, geom2 geometry

st_relate(USER-DEFINED, USER-DEFINED, integer) text

Argument names: geom1 geometry, geom2 geometry, integer

st_relate(USER-DEFINED, USER-DEFINED, text) bool

Argument names: geom1 geometry, geom2 geometry, text

st_relatematch(text, text) bool
st_removepoint(USER-DEFINED, integer) geometry

args: linestring, offset - Remove a point from a linestring.

Argument names: geometry, integer

st_removerepeatedpoints(USER-DEFINED, double precision) geometry

args: geom, tolerance - Returns a version of the given geometry with duplicated points removed.

Argument names: geom geometry, tolerance double precision DEFAULT 0.0

st_reverse(USER-DEFINED) geometry

args: g1 - Return the geometry with vertex order reversed.

Argument names: geometry

st_rotate(USER-DEFINED, double precision) geometry

args: geomA, rotRadians - Rotates a geometry about an origin point.

Argument names: geometry, double precision

st_rotate(USER-DEFINED, double precision, double precision, double precision) geometry

args: geomA, rotRadians, x0, y0 - Rotates a geometry about an origin point.

Argument names: geometry, double precision, double precision, double precision

st_rotate(USER-DEFINED, double precision, USER-DEFINED) geometry

args: geomA, rotRadians, pointOrigin - Rotates a geometry about an origin point.

Argument names: geometry, double precision, geometry

st_rotatex(USER-DEFINED, double precision) geometry

args: geomA, rotRadians - Rotates a geometry about the X axis.

Argument names: geometry, double precision

st_rotatey(USER-DEFINED, double precision) geometry

args: geomA, rotRadians - Rotates a geometry about the Y axis.

Argument names: geometry, double precision

st_rotatez(USER-DEFINED, double precision) geometry

args: geomA, rotRadians - Rotates a geometry about the Z axis.

Argument names: geometry, double precision

st_scale(USER-DEFINED, USER-DEFINED) geometry

args: geom, factor - Scales a geometry by given factors.

Argument names: geometry, geometry

st_scale(USER-DEFINED, USER-DEFINED, USER-DEFINED) geometry

args: geom, factor, origin - Scales a geometry by given factors.

Argument names: geometry, geometry, origin geometry

st_scale(USER-DEFINED, double precision, double precision, double precision) geometry

args: geomA, XFactor, YFactor, ZFactor - Scales a geometry by given factors.

Argument names: geometry, double precision, double precision, double precision

st_scale(USER-DEFINED, double precision, double precision) geometry

args: geomA, XFactor, YFactor - Scales a geometry by given factors.

Argument names: geometry, double precision, double precision

st_scroll(USER-DEFINED, USER-DEFINED) geometry

args: linestring, point - Change start point of a closed LineString.

Argument names: geometry, geometry

st_segmentize(USER-DEFINED, double precision) geometry

args: geom, max_segment_length - Return a modified geometry/geography having no segment longer than the given distance.

Argument names: geometry, double precision

st_segmentize(USER-DEFINED, double precision) geography

args: geog, max_segment_length - Return a modified geometry/geography having no segment longer than the given distance.

Argument names: geog geography, max_segment_length double precision

st_seteffectivearea(USER-DEFINED, double precision, integer) geometry

args: geomA, threshold = 0, set_area = 1 - Sets the effective area for each vertex, using the Visvalingam-Whyatt algorithm.

Argument names: geometry, double precision DEFAULT '-1'::integer, integer DEFAULT 1

st_setpoint(USER-DEFINED, integer, USER-DEFINED) geometry

args: linestring, zerobasedposition, point - Replace point of a linestring with a given point.

Argument names: geometry, integer, geometry

st_setsrid(USER-DEFINED, integer) geometry

args: geom, srid - Set the SRID on a geometry.

Argument names: geom geometry, srid integer

st_setsrid(USER-DEFINED, integer) geography

Argument names: geog geography, srid integer

st_sharedpaths(USER-DEFINED, USER-DEFINED) geometry

args: lineal1, lineal2 - Returns a collection containing paths shared by the two input linestrings/multilinestrings.

Argument names: geom1 geometry, geom2 geometry

st_shiftlongitude(USER-DEFINED) geometry

args: geom - Shifts the longitude coordinates of a geometry between -180..180 and 0..360.

Argument names: geometry

st_shortestline(USER-DEFINED, USER-DEFINED) geometry

args: g1, g2 - Returns the 2D shortest line between two geometries

Argument names: geom1 geometry, geom2 geometry

st_simplify(USER-DEFINED, double precision) geometry

Argument names: geometry, double precision

st_simplify(USER-DEFINED, double precision, boolean) geometry

args: geomA, tolerance, preserveCollapsed - Returns a simplified version of a geometry, using the Douglas-Peucker algorithm.

Argument names: geometry, double precision, boolean

st_simplifypreservetopology(USER-DEFINED, double precision) geometry

args: geomA, tolerance - Returns a simplified and valid version of a geometry, using the Douglas-Peucker algorithm.

Argument names: geometry, double precision

st_simplifyvw(USER-DEFINED, double precision) geometry

args: geomA, tolerance - Returns a simplified version of a geometry, using the Visvalingam-Whyatt algorithm

Argument names: geometry, double precision

st_snap(USER-DEFINED, USER-DEFINED, double precision) geometry

args: input, reference, tolerance - Snap segments and vertices of input geometry to vertices of a reference geometry.

Argument names: geom1 geometry, geom2 geometry, double precision

st_snaptogrid(USER-DEFINED, double precision, double precision, double precision, double precision) geometry

args: geomA, originX, originY, sizeX, sizeY - Snap all points of the input geometry to a regular grid.

Argument names: geometry, double precision, double precision, double precision, double precision

st_snaptogrid(USER-DEFINED, double precision, double precision) geometry

args: geomA, sizeX, sizeY - Snap all points of the input geometry to a regular grid.

Argument names: geometry, double precision, double precision

st_snaptogrid(USER-DEFINED, double precision) geometry

args: geomA, size - Snap all points of the input geometry to a regular grid.

Argument names: geometry, double precision

st_snaptogrid(USER-DEFINED, USER-DEFINED, double precision, double precision, double precision, double precision) geometry

args: geomA, pointOrigin, sizeX, sizeY, sizeZ, sizeM - Snap all points of the input geometry to a regular grid.

Argument names: geom1 geometry, geom2 geometry, double precision, double precision, double precision, double precision

st_split(USER-DEFINED, USER-DEFINED) geometry

args: input, blade - Returns a collection of geometries created by splitting a geometry by another geometry.

Argument names: geom1 geometry, geom2 geometry

st_square(double precision, integer, integer, USER-DEFINED) geometry

args: size, cell_i, cell_j, origin - Returns a single square, using the provided edge size and cell coordinate within the square grid space.

Argument names: size double precision, cell_i integer, cell_j integer, origin geometry DEFAULT '010100000000000000000000000000000000000000'::geometry

st_squaregrid(double precision, USER-DEFINED, USER-DEFINED, integer, integer) record

args: size, bounds - Returns a set of grid squares and cell indices that completely cover the bounds of the geometry argument.

Argument names: size double precision, bounds geometry, OUT geom geometry, OUT i integer, OUT j integer

st_srid(USER-DEFINED) int4

args: g1 - Returns the spatial reference identifier for a geometry.

Argument names: geom geometry

st_srid(USER-DEFINED) int4

Argument names: geog geography

st_startpoint(USER-DEFINED) geometry

args: geomA - Returns the first point of a LineString.

Argument names: geometry

st_subdivide(USER-DEFINED, integer, double precision) geometry

args: geom, max_vertices=256, gridSize = -1 - Computes a rectilinear subdivision of a geometry.

Argument names: geom geometry, maxvertices integer DEFAULT 256, gridsize double precision DEFAULT '-1.0'::numeric

st_summary(USER-DEFINED) text

args: g - Returns a text summary of the contents of a geometry.

Argument names: geometry

st_summary(USER-DEFINED) text

args: g - Returns a text summary of the contents of a geometry.

Argument names: geography

st_swapordinates(USER-DEFINED, cstring) geometry

args: geom, ords - Returns a version of the given geometry with given ordinate values swapped.

Argument names: geom geometry, ords cstring

st_symdifference(USER-DEFINED, USER-DEFINED, double precision) geometry

args: geomA, geomB, gridSize = -1 - Computes a geometry representing the portions of geometries A and B that do not intersect.

Argument names: geom1 geometry, geom2 geometry, gridsize double precision DEFAULT '-1.0'::numeric

st_symmetricdifference(USER-DEFINED, USER-DEFINED) geometry

Argument names: geom1 geometry, geom2 geometry

st_tileenvelope(integer, integer, integer, USER-DEFINED, double precision) geometry

args: tileZoom, tileX, tileY, bounds=SRID=3857;LINESTRING(-20037508.342789 -20037508.342789,20037508.342789 20037508.342789), margin=0.0 - Creates a rectangular Polygon in Web Mercator (SRID:3857) using the XYZ tile system.

Argument names: zoom integer, x integer, y integer, bounds geometry DEFAULT '0102000020110F00000200000093107C45F81B73C193107C45F81B73C193107C45F81B734193107C45F81B7341'::geometry, margin double precision DEFAULT 0.0

st_touches(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

st_transform(USER-DEFINED, integer) geometry

args: g1, srid - Return a new geometry with coordinates transformed to a different spatial reference system.

Argument names: geometry, integer

st_transform(USER-DEFINED, text) geometry

args: geom, to_proj - Return a new geometry with coordinates transformed to a different spatial reference system.

Argument names: geom geometry, to_proj text

st_transform(USER-DEFINED, text, text) geometry

args: geom, from_proj, to_proj - Return a new geometry with coordinates transformed to a different spatial reference system.

Argument names: geom geometry, from_proj text, to_proj text

st_transform(USER-DEFINED, text, integer) geometry

args: geom, from_proj, to_srid - Return a new geometry with coordinates transformed to a different spatial reference system.

Argument names: geom geometry, from_proj text, to_srid integer

st_transform_resilient(USER-DEFINED, integer, double precision) geometry

Argument names: g geometry, srid integer, density double precision DEFAULT 0.05

st_transform_to_utmzone(USER-DEFINED) geometry

Argument names: p_geom geometry

st_translate(USER-DEFINED, double precision, double precision, double precision) geometry

args: g1, deltax, deltay, deltaz - Translates a geometry by given offsets.

Argument names: geometry, double precision, double precision, double precision

st_translate(USER-DEFINED, double precision, double precision) geometry

args: g1, deltax, deltay - Translates a geometry by given offsets.

Argument names: geometry, double precision, double precision

st_transscale(USER-DEFINED, double precision, double precision, double precision, double precision) geometry

args: geomA, deltaX, deltaY, XFactor, YFactor - Translates and scales a geometry by given offsets and factors.

Argument names: geometry, double precision, double precision, double precision, double precision

st_unaryunion(USER-DEFINED, double precision) geometry

args: geom, gridSize = -1 - Computes the union of the components of a single geometry.

Argument names: geometry, gridsize double precision DEFAULT '-1.0'::numeric

st_union(USER-DEFINED, USER-DEFINED) geometry

args: g1, g2 - Computes a geometry representing the point-set union of the input geometries.

Argument names: geom1 geometry, geom2 geometry

st_union(USER-DEFINED, USER-DEFINED, double precision) geometry

args: g1, g2, gridSize - Computes a geometry representing the point-set union of the input geometries.

Argument names: geom1 geometry, geom2 geometry, gridsize double precision

st_union(ARRAY) geometry

args: g1_array - Computes a geometry representing the point-set union of the input geometries.

Argument names: geometry[]

st_union(USER-DEFINED) geometry

args: g1field - Computes a geometry representing the point-set union of the input geometries.

Argument names: geometry

st_union(USER-DEFINED, double precision) geometry

args: g1field, gridSize - Computes a geometry representing the point-set union of the input geometries.

Argument names: geometry, gridsize double precision

st_voronoilines(USER-DEFINED, double precision, USER-DEFINED) geometry

args: g1, tolerance, extend_to - Returns the boundaries of the Voronoi diagram of the vertices of a geometry.

Argument names: g1 geometry, tolerance double precision DEFAULT 0.0, extend_to geometry DEFAULT NULL::geometry

st_voronoipolygons(USER-DEFINED, double precision, USER-DEFINED) geometry

args: g1, tolerance, extend_to - Returns the cells of the Voronoi diagram of the vertices of a geometry.

Argument names: g1 geometry, tolerance double precision DEFAULT 0.0, extend_to geometry DEFAULT NULL::geometry

st_within(USER-DEFINED, USER-DEFINED) bool

Argument names: geom1 geometry, geom2 geometry

st_wkbtosql(bytea) geometry

Argument names: wkb bytea

st_wkttosql(text) geometry
st_wrapx(USER-DEFINED, double precision, double precision) geometry

args: geom, wrap, move - Wrap a geometry around an X value.

Argument names: geom geometry, wrap double precision, move double precision

st_x(USER-DEFINED) float8

args: a_point - Returns the X coordinate of a Point.

Argument names: geometry

st_xmax(USER-DEFINED) float8

args: aGeomorBox2DorBox3D - Returns the X maxima of a 2D or 3D bounding box or a geometry.

Argument names: box3d

st_xmin(USER-DEFINED) float8

args: aGeomorBox2DorBox3D - Returns the X minima of a 2D or 3D bounding box or a geometry.

Argument names: box3d

st_y(USER-DEFINED) float8

args: a_point - Returns the Y coordinate of a Point.

Argument names: geometry

st_ymax(USER-DEFINED) float8

args: aGeomorBox2DorBox3D - Returns the Y maxima of a 2D or 3D bounding box or a geometry.

Argument names: box3d

st_ymin(USER-DEFINED) float8

args: aGeomorBox2DorBox3D - Returns the Y minima of a 2D or 3D bounding box or a geometry.

Argument names: box3d

st_z(USER-DEFINED) float8

args: a_point - Returns the Z coordinate of a Point.

Argument names: geometry

st_zmax(USER-DEFINED) float8

args: aGeomorBox2DorBox3D - Returns the Z maxima of a 2D or 3D bounding box or a geometry.

Argument names: box3d

st_zmflag(USER-DEFINED) int2

args: geomA - Returns a code indicating the ZM coordinate dimension of a geometry.

Argument names: geometry

st_zmin(USER-DEFINED) float8

args: aGeomorBox2DorBox3D - Returns the Z minima of a 2D or 3D bounding box or a geometry.

Argument names: box3d

str_abbrev_minscore(text, text, text, text) text

Argument names: abbrev text, name text, lexlabel text DEFAULT ''::text, old_score text DEFAULT ''::text

str_abbrev_regex(text) text

Argument names: abbrev text

str_geohash_decode(text, boolean) _float8

Argument names: code text, witherror boolean DEFAULT false

str_geohash_encode(double precision, double precision, integer) text

Decodes classic Geohash (of Niemeyer 2008) to latitude and longitude, optionally adding error to the array.

Argument names: latitude double precision, longitude double precision, code_size integer DEFAULT NULL::integer

str_geohash_encode(text) text

Wrap for str_geohash_encode() with text GeoURI input.

Argument names: latlon text

str_geohash_encode(ARRAY, integer) text

Wrap for str_geohash_encode() with array input.

Argument names: latlon double precision[], code_size integer DEFAULT NULL::integer

str_geouri_decode(text) _float8

Decodes standard GeoURI of latitude and longitude into float array.

Argument names: uri text

str_ggeohash_decode_box(text, integer, jsonb, double precision, double precision, double precision, double precision) _float8

Decodes string of a Generalized Geohash into a bounding Box that matches it. Returns a four-element array: [minlat, minlon, maxlat, maxlon]. Algorithm adapted from https://github.com/ppKrauss/node-geohash/blob/master/main.js

Argument names: code text, code_digit_bits integer DEFAULT 5, code_digits_lookup jsonb DEFAULT '{"0": 0, "1": 1, "2": 2, "3": 3, "4": 4, "5": 5, "6": 6, "7": 7, "8": 8, "9": 9, "b": 10, "c": 11, "d": 12, "e": 13, "f": 14, "g": 15, "h": 16, "j": 17, "k": 18, "m": 19, "n": 20, "p": 21, "q": 22, "r": 23, "s": 24, "t": 25, "u": 26, "v": 27, "w": 28, "x": 29, "y": 30, "z": 31}'::jsonb, min_x double precision DEFAULT '-90'::numeric, min_y double precision DEFAULT '-180'::numeric, max_x double precision DEFAULT '90'::numeric, max_y double precision DEFAULT '180'::numeric

str_ggeohash_decode_box(text, integer, jsonb, ARRAY) _float8

Wrap for str_ggeohash_decode_box(...,float,float,float,float).

Argument names: code text, code_digit_bits integer, code_digits_lookup jsonb, bbox double precision[]

str_ggeohash_decode_box2(bit varying, double precision, double precision, double precision, double precision, boolean) _float8

Decodes string of a Generalized Geohash into a bounding Box that matches it. Returns a four-element array: [minlat, minlon, maxlat, maxlon]. Algorithm adapted from https://github.com/ppKrauss/node-geohash/blob/master/main.js

Argument names: code bit varying, min_x double precision DEFAULT '-90'::numeric, min_y double precision DEFAULT '-180'::numeric, max_x double precision DEFAULT '90'::numeric, max_y double precision DEFAULT '180'::numeric, lonlat boolean DEFAULT false

str_ggeohash_decode_box2(bit varying, ARRAY, boolean) _float8

Wrap for str_ggeohash_decode_box(...,float,float,float,float).

Argument names: code bit varying, bbox double precision[], lonlat boolean DEFAULT false

str_ggeohash_draw_cell_bybox(ARRAY, boolean, integer) geometry

Draws a square-cell from BBOX.

Argument names: b double precision[], p_translate boolean DEFAULT false, p_srid integer DEFAULT 4326

str_ggeohash_draw_cell_bycenter(integer, integer, integer, boolean, integer) geometry

Draws a square-cell centered on the requested point, with requested radius (half side) and optional translation and SRID.

Argument names: cx integer, cy integer, r integer, p_translate boolean DEFAULT false, p_srid integer DEFAULT 4326

str_ggeohash_encode(double precision, double precision, integer, integer, text, double precision, double precision, double precision, double precision) text

Encondes LatLon WGS84 as Generalized Geohash. Algorithm adapted from https://github.com/ppKrauss/node-geohash/blob/master/main.js

Argument names: x double precision, y double precision, code_size integer DEFAULT NULL::integer, code_digit_bits integer DEFAULT 5, code_digits_alphabet text DEFAULT '0123456789BCDFGHJKLMNPQRSTUVWXYZ'::text, min_x double precision DEFAULT '-90'::numeric, min_y double precision DEFAULT '-180'::numeric, max_x double precision DEFAULT '90'::numeric, max_y double precision DEFAULT '180'::numeric

str_ggeohash_encode(double precision, double precision, integer, integer, text, ARRAY) text

Wrap for str_ggeohash_encode(...,float,float,float,float).

Argument names: x double precision, y double precision, code_size integer, code_digit_bits integer, code_digits_alphabet text, bbox double precision[]

str_ggeohash_encode2(double precision, double precision, integer, integer, text, double precision, double precision, double precision, double precision) jsonb

Argument names: x double precision, y double precision, code_size integer DEFAULT NULL::integer, code_digit_bits integer DEFAULT 5, code_digits_alphabet text DEFAULT '0123456789BCDFGHJKLMNPQRSTUVWXYZ'::text, min_x double precision DEFAULT '-90'::numeric, min_y double precision DEFAULT '-180'::numeric, max_x double precision DEFAULT '90'::numeric, max_y double precision DEFAULT '180'::numeric

str_ggeohash_encode2(double precision, double precision, integer, integer, text, ARRAY) jsonb

Argument names: x double precision, y double precision, code_size integer, code_digit_bits integer, code_digits_alphabet text, bbox double precision[]

str_ggeohash_encode3(double precision, double precision, double precision, double precision, double precision, double precision, integer, boolean) varbit

Argument names: x double precision, y double precision, min_x double precision DEFAULT '-90'::numeric, min_y double precision DEFAULT '-180'::numeric, max_x double precision DEFAULT '90'::numeric, max_y double precision DEFAULT '180'::numeric, bit_length integer DEFAULT 40, lonlat boolean DEFAULT false

str_ggeohash_encode3(double precision, double precision, ARRAY, integer, boolean) varbit

Argument names: x double precision, y double precision, bbox double precision[], bit_length integer, lonlat boolean DEFAULT false

str_ggeohash_uv_decode_box(text, integer, jsonb) _float8

Wrap for str_ggeohash_decode_box(), returning normalized UV coordinates.

Argument names: code text, code_digit_bits integer DEFAULT 5, code_digits_lookup jsonb DEFAULT '{"0": 0, "1": 1, "2": 2, "3": 3, "4": 4, "5": 5, "6": 6, "7": 7, "8": 8, "9": 9, "b": 10, "c": 11, "d": 12, "f": 13, "g": 14, "h": 15, "j": 16, "k": 17, "l": 18, "m": 19, "n": 20, "p": 21, "q": 22, "r": 23, "s": 24, "t": 25, "u": 26, "v": 27, "w": 28, "x": 29, "y": 30, "z": 31}'::jsonb

str_ggeohash_uv_encode(double precision, double precision, integer, integer, text) text

Wrap for str_ggeohash_encode() with normalized UV coordinates.

Argument names: u double precision, v double precision, code_size integer DEFAULT NULL::integer, code_digit_bits integer DEFAULT 5, code_digits_alphabet text DEFAULT '0123456789BCDFGHJKLMNPQRSTUVWXYZ'::text

str_to_normalized_unicode(text) text

Argument names: str text

str_urldecode(text) text

Argument names: p text

stragg_prefix(text, ARRAY, text) text

Argument names: prefix text, s text[], sep text DEFAULT ','::text

text(USER-DEFINED) text

Argument names: geometry

to_bigint(text) int8

Argument names: str text

to_hex(ARRAY, integer) _text

Argument names: p_x bigint[], p_fill_zeros integer DEFAULT NULL::integer

to_integer(text) int4

Argument names: str text

trunc(double precision, text, integer) float8

Argument names: x double precision, xtype text, xdigits integer DEFAULT 0

trunc_bin(bigint, integer) int8

Argument names: x bigint, bits integer

unaccent(regdictionary, text) text
unaccent(text) text
unaccent_init(internal) internal
unaccent_lexize(internal, internal, internal, internal) internal
unlockrows(text) int4

args: auth_token - Removes all locks held by an authorization token.

unnest_2d_1d(anyarray, anyarray) anyarray

Argument names: anyarray, OUT a anyarray

updategeometrysrid(character varying, character varying, character varying, character varying, integer) text

args: catalog_name, schema_name, table_name, column_name, srid - Updates the SRID of all features in a geometry column, and the table metadata.

Argument names: catalogn_name character varying, schema_name character varying, table_name character varying, column_name character varying, new_srid_in integer

updategeometrysrid(character varying, character varying, character varying, integer) text

args: schema_name, table_name, column_name, srid - Updates the SRID of all features in a geometry column, and the table metadata.

updategeometrysrid(character varying, character varying, integer) text

args: table_name, column_name, srid - Updates the SRID of all features in a geometry column, and the table metadata.

utmgrid_from4326(USER-DEFINED) _int4

Argument names: p_geom geometry

utmgrid_from4326_coverlabels(USER-DEFINED, integer) _text

Argument names: p_geom geometry, p_samples integer DEFAULT 1000

utmgrid_from4326_label(USER-DEFINED) text

Argument names: p_geom geometry

utmzone_from4326(USER-DEFINED) _int4

Argument names: p_geom geometry

utmzone_from4326_label(USER-DEFINED) text

Argument names: p_geom geometry

varbit_to_int(bit varying, integer) int4

Argument names: b bit varying, blen integer DEFAULT NULL::integer

vbit_to_baseh(bit varying, integer, integer) text

Encodes varbit (string of bits) into Base4h, Base8h, Base16h or Base32. See http://osm.codes/_foundations/art1.pdf

Argument names: p_val bit varying, p_base integer DEFAULT 4, p_size integer DEFAULT 0

volat_file_write(text, text, text, boolean) text

Do lazy coalesce. To use in a "only write when null" condiction of COALESCE(x,volat_file_write()).

Argument names: file text, fcontent text, msg text DEFAULT 'Ok'::text, append boolean DEFAULT false

write_geojsonb_features(text, text, text, text, ARRAY, text, integer, integer, integer, text, text, boolean) text

run file_write() dynamically to save specified relation as GeoJSONb FeatureCollection.

Argument names: sql_tablename text, p_file text, sql_geom text DEFAULT 't1.geom'::text, p_cols text DEFAULT NULL::text, p_cols_orderby text[] DEFAULT NULL::text[], col_id text DEFAULT NULL::text, p_pretty_opt integer DEFAULT 0, p_decimals integer DEFAULT 6, p_options integer DEFAULT 0, p_name text DEFAULT NULL::text, p_title text DEFAULT NULL::text, p_id_as_int boolean DEFAULT false

xml_encode_special_chars(text) text
xml_pretty(xml, integer) xml

Argument names: x xml, mode integer DEFAULT 0

xml_to_dec(text) int4
xml_unescape(xml) text
xml_valid(text) bool
xpath_bool(text, text) bool
xpath_list(text, text, text) text
xpath_list(text, text) text
xpath_nodeset(text, text, text, text) text
xpath_nodeset(text, text) text
xpath_nodeset(text, text, text) text
xpath_number(text, text) float4
xpath_string(text, text) text
xpath_table(text, text, text, text, text) record
xslt_process(text, text, text) text
xslt_process(text, text) text
yaml_to_jsonb(text) jsonb

Argument names: p_yaml text

yamlfile_to_jsonb(text) jsonb

Argument names: file text

Clone this wiki locally