Functions and Operators

Appends elem to array, returning the result.

Appends elem to array, returning the result.

Appends elem to array, returning the result.

Appends elem to array, returning the result.

Appends elem to array, returning the result.

Appends elem to array, returning the result.

Appends elem to array, returning the result.

Appends elem to array, returning the result.

Appends elem to array, returning the result.

Appends elem to array, returning the result.

Appends elem to array, returning the result.

Appends elem to array, returning the result.

Appends elem to array, returning the result.

Appends elem to array, returning the result.

Appends elem to array, returning the result.

Appends elem to array, returning the result.

Appends elem to array, returning the result.

Appends elem to array, returning the result.

Appends elem to array, returning the result.

Appends elem to array, returning the result.

Appends elem to array, returning the result.

Appends elem to array, returning the result.

Appends two arrays.

Appends two arrays.

Appends two arrays.

Appends two arrays.

Appends two arrays.

Appends two arrays.

Appends two arrays.

Appends two arrays.

Appends two arrays.

Appends two arrays.

Appends two arrays.

Appends two arrays.

Appends two arrays.

Appends two arrays.

Appends two arrays.

Appends two arrays.

Appends two arrays.

Appends two arrays.

Appends two arrays.

Appends two arrays.

Appends two arrays.

Appends two arrays.

Calculates the length of input on the provided array_dimension. However, because CockroachDB doesn’t yet support multi-dimensional arrays, the only supported array_dimension is 1.

Calculates the minimum value of input on the provided array_dimension. However, because CockroachDB doesn’t yet support multi-dimensional arrays, the only supported array_dimension is 1.

Return the index of the first occurrence of elem in array.

Return the index of the first occurrence of elem in array.

Return the index of the first occurrence of elem in array.

Return the index of the first occurrence of elem in array.

Return the index of the first occurrence of elem in array.

Return the index of the first occurrence of elem in array.

Return the index of the first occurrence of elem in array.

Return the index of the first occurrence of elem in array.

Return the index of the first occurrence of elem in array.

Return the index of the first occurrence of elem in array.

Return the index of the first occurrence of elem in array.

Return the index of the first occurrence of elem in array.

Return the index of the first occurrence of elem in array.

Return the index of the first occurrence of elem in array.

Return the index of the first occurrence of elem in array.

Return the index of the first occurrence of elem in array.

Return the index of the first occurrence of elem in array.

Return the index of the first occurrence of elem in array.

Return the index of the first occurrence of elem in array.

Return the index of the first occurrence of elem in array.

Return the index of the first occurrence of elem in array.

Return the index of the first occurrence of elem in array.

Returns and array of indexes of all occurrences of elem in array.

Returns and array of indexes of all occurrences of elem in array.

Returns and array of indexes of all occurrences of elem in array.

Returns and array of indexes of all occurrences of elem in array.

Returns and array of indexes of all occurrences of elem in array.

Returns and array of indexes of all occurrences of elem in array.

Returns and array of indexes of all occurrences of elem in array.

Returns and array of indexes of all occurrences of elem in array.

Returns and array of indexes of all occurrences of elem in array.

Returns and array of indexes of all occurrences of elem in array.

Returns and array of indexes of all occurrences of elem in array.

Returns and array of indexes of all occurrences of elem in array.

Returns and array of indexes of all occurrences of elem in array.

Returns and array of indexes of all occurrences of elem in array.

Returns and array of indexes of all occurrences of elem in array.

Returns and array of indexes of all occurrences of elem in array.

Returns and array of indexes of all occurrences of elem in array.

Returns and array of indexes of all occurrences of elem in array.

Returns and array of indexes of all occurrences of elem in array.

Returns and array of indexes of all occurrences of elem in array.

Returns and array of indexes of all occurrences of elem in array.

Returns and array of indexes of all occurrences of elem in array.

Prepends elem to array, returning the result.

Prepends elem to array, returning the result.

Prepends elem to array, returning the result.

Prepends elem to array, returning the result.

Prepends elem to array, returning the result.

Prepends elem to array, returning the result.

Prepends elem to array, returning the result.

Prepends elem to array, returning the result.

Prepends elem to array, returning the result.

Prepends elem to array, returning the result.

Prepends elem to array, returning the result.

Prepends elem to array, returning the result.

Prepends elem to array, returning the result.

Prepends elem to array, returning the result.

Prepends elem to array, returning the result.

Prepends elem to array, returning the result.

Prepends elem to array, returning the result.

Prepends elem to array, returning the result.

Prepends elem to array, returning the result.

Prepends elem to array, returning the result.

Prepends elem to array, returning the result.

Prepends elem to array, returning the result.

Remove from array all elements equal to elem.

Remove from array all elements equal to elem.

Remove from array all elements equal to elem.

Remove from array all elements equal to elem.

Remove from array all elements equal to elem.

Remove from array all elements equal to elem.

Remove from array all elements equal to elem.

Remove from array all elements equal to elem.

Remove from array all elements equal to elem.

Remove from array all elements equal to elem.

Remove from array all elements equal to elem.

Remove from array all elements equal to elem.

Remove from array all elements equal to elem.

Remove from array all elements equal to elem.

Remove from array all elements equal to elem.

Remove from array all elements equal to elem.

Remove from array all elements equal to elem.

Remove from array all elements equal to elem.

Remove from array all elements equal to elem.

Remove from array all elements equal to elem.

Remove from array all elements equal to elem.

Remove from array all elements equal to elem.

Replace all occurrences of toreplace in array with replacewith.

Replace all occurrences of toreplace in array with replacewith.

Replace all occurrences of toreplace in array with replacewith.

Replace all occurrences of toreplace in array with replacewith.

Replace all occurrences of toreplace in array with replacewith.

Replace all occurrences of toreplace in array with replacewith.

Replace all occurrences of toreplace in array with replacewith.

Replace all occurrences of toreplace in array with replacewith.

Replace all occurrences of toreplace in array with replacewith.

Replace all occurrences of toreplace in array with replacewith.

Replace all occurrences of toreplace in array with replacewith.

Replace all occurrences of toreplace in array with replacewith.

Replace all occurrences of toreplace in array with replacewith.

Replace all occurrences of toreplace in array with replacewith.

Replace all occurrences of toreplace in array with replacewith.

Replace all occurrences of toreplace in array with replacewith.

Replace all occurrences of toreplace in array with replacewith.

Replace all occurrences of toreplace in array with replacewith.

Replace all occurrences of toreplace in array with replacewith.

Replace all occurrences of toreplace in array with replacewith.

Replace all occurrences of toreplace in array with replacewith.

Replace all occurrences of toreplace in array with replacewith.

Join an array into a string with a delimiter.

Join an array into a string with a delimiter, replacing NULLs with a null string.

Calculates the maximum value of input on the provided array_dimension. However, because CockroachDB doesn’t yet support multi-dimensional arrays, the only supported array_dimension is 1.

Calculates the number of elements contained in input

Merge an array of roachpb.StatementStatistics into a single JSONB object

Merge an array of StmtStatsMetadata into a single JSONB object

Merge an array of roachpb.TransactionStatistics into a single JSONB object

Split a string into components on a delimiter.

Split a string into components on a delimiter with a specified string to consider NULL.

Matches case insensetively unescaped with pattern using escape as an escape token.

Test for subnet inclusion or equality, using only the network parts of the addresses. The host part of the addresses is ignored.

Test for subnet inclusion or equality, using only the network parts of the addresses. The host part of the addresses is ignored.

Checks if two IP addresses are of the same IP family.

Matches unescaped with pattern using escape as an escape token.

Checks whether unescaped not matches case insensetively with pattern using escape as an escape token.

Checks whether unescaped not matches with pattern using escape as an escape token.

Checks whether unescaped not matches with pattern using escape as an escape token.

Returns the element with the greatest value.

Returns the element with the lowest value.

Returns the number of nonnull arguments.

Returns the number of null arguments.

Computes a binary hash of the given data. type is the algorithm to use (md5, sha1, sha224, sha256, sha384, or sha512).

Computes a binary hash of the given data. type is the algorithm to use (md5, sha1, sha224, sha256, sha384, or sha512).

Calculates hashed MAC for data with key key. type is the same as in digest().

Calculates hashed MAC for data with key key. type is the same as in digest().

Returns a TimestampTZ representation of a CockroachDB HLC in decimal form.

Note that a TimestampTZ has less precision than a CockroachDB HLC. It is intended as a convenience function to display HLCs in a print-friendly form. Use the decimal value if you rely on the HLC for accuracy.

Calculates the interval between begin and end, normalized into years, months and days.

Note this may not be an accurate time span since years and months are normalized from days, and years and months are out of context. To avoid normalizing days into months and years, use the timestamptz subtraction operator.

Calculates the interval between val and the current time, normalized into years, months and days.

Note this may not be an accurate time span since years and months are normalized from days, and years and months are out of context. To avoid normalizing days into months and years, use now() - timestamptz.

Returns the current system time on one of the cluster nodes.

Returns the current system time on one of the cluster nodes.

Returns the date of the current transaction.

The value is based on a timestamp picked when the transaction starts and which stays constant throughout the transaction. This timestamp has no relationship with the commit order of concurrent transactions.

Returns the time of the current transaction.

The value is based on a timestamp picked when the transaction starts and which stays constant throughout the transaction. This timestamp has no relationship with the commit order of concurrent transactions.

Returns the time of the current transaction.

The value is based on a timestamp picked when the transaction starts and which stays constant throughout the transaction. This timestamp has no relationship with the commit order of concurrent transactions.

Returns the time of the current transaction.

The value is based on a timestamp picked when the transaction starts and which stays constant throughout the transaction. This timestamp has no relationship with the commit order of concurrent transactions.

This function is the preferred overload and will be evaluated by default.

Returns the time of the current transaction.

The value is based on a timestamp picked when the transaction starts and which stays constant throughout the transaction. This timestamp has no relationship with the commit order of concurrent transactions.

Returns the time of the current transaction.

The value is based on a timestamp picked when the transaction starts and which stays constant throughout the transaction. This timestamp has no relationship with the commit order of concurrent transactions.

Returns the time of the current transaction.

The value is based on a timestamp picked when the transaction starts and which stays constant throughout the transaction. This timestamp has no relationship with the commit order of concurrent transactions.

This function is the preferred overload and will be evaluated by default.

Extracts element from input.

Compatible elements: millennium, century, decade, year, isoyear, quarter, month, week, dayofweek, isodow, dayofyear, julian, hour, minute, second, millisecond, microsecond, epoch

Extracts element from input.

Compatible elements: millennium, century, decade, year, month, day, hour, minute, second, millisecond, microsecond, epoch

Extracts element from input.

Compatible elements: hour, minute, second, millisecond, microsecond, epoch

Extracts element from input.

Compatible elements: millennium, century, decade, year, isoyear, quarter, month, week, dayofweek, isodow, dayofyear, julian, hour, minute, second, millisecond, microsecond, epoch

Extracts element from input.

Compatible elements: millennium, century, decade, year, isoyear, quarter, month, week, dayofweek, isodow, dayofyear, julian, hour, minute, second, millisecond, microsecond, epoch, timezone, timezone_hour, timezone_minute

Extracts element from input.

Compatible elements: hour, minute, second, millisecond, microsecond, epoch, timezone, timezone_hour, timezone_minute

Truncates input to precision element. Sets all fields that are less significant than element to zero (or one, for day and month)

Compatible elements: millennium, century, decade, year, quarter, month, week, day, hour, minute, second, millisecond, microsecond.

Truncates input to precision element. Sets all fields that are less significant than element to zero (or one, for day and month)

Compatible elements: millennium, century, decade, year, quarter, month, week, day, hour, minute, second, millisecond, microsecond.

Truncates input to precision element. Sets all fields that are less significant than element to zero.

Compatible elements: hour, minute, second, millisecond, microsecond.

Truncates input to precision element. Sets all fields that are less significant than element to zero (or one, for day and month)

Compatible elements: millennium, century, decade, year, quarter, month, week, day, hour, minute, second, millisecond, microsecond.

Truncates input to precision element. Sets all fields that are less significant than element to zero (or one, for day and month)

Compatible elements: millennium, century, decade, year, quarter, month, week, day, hour, minute, second, millisecond, microsecond.

Same as follower_read_timestamp. This name is deprecated.

From input, extracts and formats the time as identified in extract_format using standard strftime notation (though not all formatting is supported).

From input, extracts and formats the time as identified in extract_format using standard strftime notation (though not all formatting is supported).

From input, extracts and formats the time as identified in extract_format using standard strftime notation (though not all formatting is supported).

Returns input as a timestamptz using format (which uses standard strptime formatting).

Extracts element from input.

Compatible elements: millennium, century, decade, year, isoyear, quarter, month, week, dayofweek, isodow, dayofyear, julian, hour, minute, second, millisecond, microsecond, epoch

Extracts element from input.

Compatible elements: millennium, century, decade, year, month, day, hour, minute, second, millisecond, microsecond, epoch

Extracts element from input.

Compatible elements: hour, minute, second, millisecond, microsecond, epoch

Extracts element from input.

Compatible elements: millennium, century, decade, year, isoyear, quarter, month, week, dayofweek, isodow, dayofyear, julian, hour, minute, second, millisecond, microsecond, epoch

Extracts element from input.

Compatible elements: millennium, century, decade, year, isoyear, quarter, month, week, dayofweek, isodow, dayofyear, julian, hour, minute, second, millisecond, microsecond, epoch, timezone, timezone_hour, timezone_minute

Extracts element from input.

Compatible elements: hour, minute, second, millisecond, microsecond, epoch, timezone, timezone_hour, timezone_minute

Extracts element from input. Compatible elements: hour, minute, second, millisecond, microsecond. This is deprecated in favor of extract which supports duration.

Returns a timestamp which is very likely to be safe to perform against a follower replica.

This function is intended to be used with an AS OF SYSTEM TIME clause to perform historical reads against a time which is recent but sufficiently old for reads to be performed against the closest replica as opposed to the currently leaseholder for a given range.

Note that this function requires an enterprise license on a CCL distribution to return a result that is less likely the closest replica. It is otherwise hardcoded as -4.8s from the statement time, which may not result in reading from the nearest replica.

Returns the time of the current transaction.

The value is based on a timestamp picked when the transaction starts and which stays constant throughout the transaction. This timestamp has no relationship with the commit order of concurrent transactions.

Returns the time of the current transaction.

The value is based on a timestamp picked when the transaction starts and which stays constant throughout the transaction. This timestamp has no relationship with the commit order of concurrent transactions.

This function is the preferred overload and will be evaluated by default.

Returns the time of the current transaction.

The value is based on a timestamp picked when the transaction starts and which stays constant throughout the transaction. This timestamp has no relationship with the commit order of concurrent transactions.

Returns the time of the current transaction.

The value is based on a timestamp picked when the transaction starts and which stays constant throughout the transaction. This timestamp has no relationship with the commit order of concurrent transactions.

Returns the time of the current transaction.

The value is based on a timestamp picked when the transaction starts and which stays constant throughout the transaction. This timestamp has no relationship with the commit order of concurrent transactions.

This function is the preferred overload and will be evaluated by default.

Returns the time of the current transaction.

The value is based on a timestamp picked when the transaction starts and which stays constant throughout the transaction. This timestamp has no relationship with the commit order of concurrent transactions.

Returns the time of the current transaction.

The value is based on a timestamp picked when the transaction starts and which stays constant throughout the transaction. This timestamp has no relationship with the commit order of concurrent transactions.

Returns the time of the current transaction.

The value is based on a timestamp picked when the transaction starts and which stays constant throughout the transaction. This timestamp has no relationship with the commit order of concurrent transactions.

Returns the time of the current transaction.

The value is based on a timestamp picked when the transaction starts and which stays constant throughout the transaction. This timestamp has no relationship with the commit order of concurrent transactions.

This function is the preferred overload and will be evaluated by default.

Returns the start time of the current statement.

Returns the start time of the current statement.

Returns the current system time on one of the cluster nodes as a string.

Treat given time without time zone as located in the specified time zone.

Treat given time stamp without time zone as located in the specified time zone.

Convert given time stamp with time zone to the new time zone, with no time zone designation.

Convert given time stamp with time zone to the new time zone, with no time zone designation.

Convert given time with time zone to the new time zone.

Convert an date to a string assuming the ISO, MDY DateStyle.

Convert an interval to a string assuming the Postgres IntervalStyle.

Convert an timestamp to a string assuming the ISO, MDY DateStyle.

Returns the time of the current transaction.

The value is based on a timestamp picked when the transaction starts and which stays constant throughout the transaction. This timestamp has no relationship with the commit order of concurrent transactions.

Returns the time of the current transaction.

The value is based on a timestamp picked when the transaction starts and which stays constant throughout the transaction. This timestamp has no relationship with the commit order of concurrent transactions.

Returns the time of the current transaction.

The value is based on a timestamp picked when the transaction starts and which stays constant throughout the transaction. This timestamp has no relationship with the commit order of concurrent transactions.

This function is the preferred overload and will be evaluated by default.

When used in the AS OF SYSTEM TIME clause of an single-statement, read-only transaction, CockroachDB chooses the newest timestamp within the staleness bound that allows execution of the reads at the nearest available replica without blocking.

Note this function requires an enterprise license on a CCL distribution.

When used in the AS OF SYSTEM TIME clause of an single-statement, read-only transaction, CockroachDB chooses the newest timestamp within the staleness bound that allows execution of the reads at the nearest available replica without blocking.

If nearest_only is set to true, reads that cannot be served using the nearest available replica will error.

Note this function requires an enterprise license on a CCL distribution.

When used in the AS OF SYSTEM TIME clause of an single-statement, read-only transaction, CockroachDB chooses the newest timestamp before the min_timestamp that allows execution of the reads at the nearest available replica without blocking.

Note this function requires an enterprise license on a CCL distribution.

When used in the AS OF SYSTEM TIME clause of an single-statement, read-only transaction, CockroachDB chooses the newest timestamp before the min_timestamp that allows execution of the reads at the nearest available replica without blocking.

If nearest_only is set to true, reads that cannot be served using the nearest available replica will error.

Note this function requires an enterprise license on a CCL distribution.

Returns the first value of the input enum type.

Returns the last value of the input enum type.

Returns all values of the input enum in an ordered array between the two arguments (inclusive).

Returns all values of the input enum in an ordered array.

Calculates the absolute value of val.

Calculates the absolute value of val.

Calculates the absolute value of val.

Calculates the inverse cosine of val.

Calculates the inverse cosine of val with the result in degrees

Calculates the inverse hyperbolic cosine of val.

Calculates the inverse sine of val.

Calculates the inverse sine of val with the result in degrees.

Calculates the inverse hyperbolic sine of val.

Calculates the inverse tangent of val.

Calculates the inverse tangent of x/y.

Calculates the inverse tangent of x/y with the result in degrees

Calculates the inverse tangent of val with the result in degrees.

Calculates the inverse hyperbolic tangent of val.

Calculates the cube root (∛) of val.

Calculates the cube root (∛) of val.

Calculates the smallest integer not smaller than val.

Calculates the smallest integer not smaller than val.

Calculates the smallest integer not smaller than val.

Calculates the smallest integer not smaller than val.

Calculates the smallest integer not smaller than val.

Calculates the smallest integer not smaller than val.

Calculates the cosine of val.

Calculates the cosine of val where val is in degrees.

Calculates the hyperbolic cosine of val.

Calculates the cotangent of val.

Calculates the cotangent of val where val is in degrees.

Converts val as a radian value to a degree value.

Calculates the integer quotient of x/y.

Calculates the integer quotient of x/y.

Calculates the integer quotient of x/y.

Calculates e ^ val.

Calculates e ^ val.

Calculates the largest integer not greater than val.

Calculates the largest integer not greater than val.

Calculates the largest integer not greater than val.

Returns true if val is NaN, false otherwise.

Returns true if val is NaN, false otherwise.

Calculates the natural log of val.

Calculates the natural log of val.

Calculates the base b log of val.

Calculates the base b log of val.

Calculates the base 10 log of val.

Calculates the base 10 log of val.

Calculates x%y.

Calculates x%y.

Calculates x%y.

Returns the value for pi (3.141592653589793).

Calculates x^y.

Calculates x^y.

Calculates x^y.

Calculates x^y.

Calculates x^y.

Calculates x^y.

Converts val as a degree value to a radians value.

Returns a random floating-point number between 0 (inclusive) and 1 (exclusive). Note that the value contains at most 53 bits of randomness.

Keeps decimal_accuracy number of figures to the right of the zero position in input using half away from zero rounding. If decimal_accuracy is not in the range -2^31…(2^31-1), the results are undefined.

Keeps decimal_accuracy number of figures to the right of the zero position in input using half to even (banker’s) rounding.

Rounds val to the nearest integer, half away from zero: round(+/-2.4) = +/-2, round(+/-2.5) = +/-3.

Rounds val to the nearest integer using half to even (banker’s) rounding.

Determines the sign of val: 1 for positive; 0 for 0 values; -1 for negative.

Determines the sign of val: 1 for positive; 0 for 0 values; -1 for negative.

Determines the sign of val: 1 for positive; 0 for 0 values; -1 for negative.

Calculates the sine of val.

Calculates the sine of val where val is in degrees.

Calculates the hyperbolic sine of val.

Calculates the square root of val.

Calculates the square root of val.

Calculates the tangent of val.

Calculates the tangent of val where val is in degrees.

Calculates the hyperbolic tangent of val.

Truncates the decimal values of val.

Truncates the decimal values of val.

Returns a UUID.

Generates a random ULID and returns it as a value of UUID type.

Generates a random UUID and returns it as a value of UUID type.

Returns a unique ID used by CockroachDB to generate unique row IDs if a Primary Key isn’t defined for the table. The value is a combination of the insert timestamp and the ID of the node executing the statement, which guarantees this combination is globally unique. However, there can be gaps and the order is not completely guaranteed.

Returns a unique ID. The value is a combination of the insert timestamp and the ID of the node executing the statement, which guarantees this combination is globally unique. The way it is generated there is no ordering

Generates a random UUID and returns it as a value of UUID type.

Returns a UUID.

Converts the combined IP address and prefix length to an abbreviated display format as text.For INET types, this will omit the prefix length if it’s not the default (32 or IPv4, 128 for IPv6)

For example, abbrev('192.168.1.2/24') returns '192.168.1.2/24'

Gets the broadcast address for the network address represented by the value.

For example, broadcast('192.168.1.2/24') returns '192.168.1.255/24'

Extracts the IP family of the value; 4 for IPv4, 6 for IPv6.

For example, family('::1') returns 6

Extracts the address part of the combined address/prefixlen value as text.

For example, host('192.168.1.2/16') returns '192.168.1.2'

Creates an IP host mask corresponding to the prefix length in the value.

For example, hostmask('192.168.1.2/16') returns '0.0.255.255'

Retrieves the prefix length stored in the value.

For example, masklen('192.168.1.2/16') returns 16

Creates an IP network mask corresponding to the prefix length in the value.

For example, netmask('192.168.1.2/16') returns '255.255.0.0'

Sets the prefix length of val to prefixlen.

For example, set_masklen('192.168.1.2', 16) returns '192.168.1.2/16'.

Converts the IP address and prefix length to text.

Calculates the CRC-32 hash using the Castagnoli polynomial.

Calculates the CRC-32 hash using the Castagnoli polynomial.

Calculates the CRC-32 hash using the IEEE polynomial.

Calculates the CRC-32 hash using the IEEE polynomial.

Calculates the 32-bit FNV-1 hash value of a set of values.

Calculates the 32-bit FNV-1 hash value of a set of values.

Calculates the 32-bit FNV-1a hash value of a set of values.

Calculates the 32-bit FNV-1a hash value of a set of values.

Calculates the 64-bit FNV-1 hash value of a set of values.

Calculates the 64-bit FNV-1 hash value of a set of values.

Calculates the 64-bit FNV-1a hash value of a set of values.

Calculates the 64-bit FNV-1a hash value of a set of values.

Calculates the Levenshtein distance between two strings. Maximum input length is 255 characters.

Calculates the Levenshtein distance between two strings. The cost parameters specify how much to charge for each edit operation. Maximum input length is 255 characters.

return the bucket number to which operand would be assigned in a histogram having count equal-width buckets spanning the range b1 to b2.

return the bucket number to which operand would be assigned in a histogram having count equal-width buckets spanning the range b1 to b2.

return the bucket number to which operand would be assigned given an array listing the lower bounds of the buckets; returns 0 for an input less than the first lower bound; the thresholds array must be sorted, smallest first, or unexpected results will be obtained

Returns the array as JSON or JSONB.

Returns the array as JSON or JSONB.

Convert JSONB data to protocol message bytes

Converts protocol message to its JSONB representation.

Converts protocol message to its JSONB representation.

Converts protocol message to its JSONB representation.

Read the content of the file at the supplied external storage URI

Write the content passed to a file at the supplied external storage URI

Returns the number of elements in the outermost JSON or JSONB array.

Builds a possibly-heterogeneously-typed JSON or JSONB array out of a variadic argument list.

Builds a JSON object out of a variadic argument list.

Returns the JSON value pointed to by the variadic arguments.

Returns the JSON value as text pointed to by the variadic arguments.

This form of json_object takes keys and values pairwise from two separate arrays. In all other respects it is identical to the one-argument form.

Builds a JSON or JSONB object out of a text array. The array must have exactly one dimension with an even number of members, in which case they are taken as alternating key/value pairs.

Remove the specified path from the JSON object.

Returns the JSON value pointed to by the variadic arguments.

Returns the JSON value pointed to by the variadic arguments. If create_missing is false, new keys will not be inserted to objects and values will not be prepended or appended to arrays.

Returns from_json with all object fields that have null values omitted. Other null values are untouched.

Returns the type of the outermost JSON value as a text string.

Returns whether the given string is a valid JSON or not

Returns the number of elements in the outermost JSON or JSONB array.

Builds a possibly-heterogeneously-typed JSON or JSONB array out of a variadic argument list.

Builds a JSON object out of a variadic argument list.

Returns whether any of the strings in the text array exist as top-level keys or array elements

Returns the JSON value pointed to by the variadic arguments.

Returns the JSON value as text pointed to by the variadic arguments.

Returns the JSON value pointed to by the variadic arguments. new_val will be inserted before path target.

Returns the JSON value pointed to by the variadic arguments. If insert_after is true (default is false), new_val will be inserted after path target.

This form of json_object takes keys and values pairwise from two separate arrays. In all other respects it is identical to the one-argument form.

Builds a JSON or JSONB object out of a text array. The array must have exactly one dimension with an even number of members, in which case they are taken as alternating key/value pairs.

Returns the given JSON value as a STRING indented and with newlines.

Returns the JSON value pointed to by the variadic arguments.

Returns the JSON value pointed to by the variadic arguments. If create_missing is false, new keys will not be inserted to objects and values will not be prepended or appended to arrays.

Returns from_json with all object fields that have null values omitted. Other null values are untouched.

Returns the type of the outermost JSON value as a text string.

Returns the row as a JSON object.

Returns the value as JSON or JSONB.

Returns the value as JSON or JSONB.

Takes in a CONFIGURE ZONE SQL statement and returns a modified SQL statement omitting multi-region related zone configuration fields. If the CONFIGURE ZONE statement can be inferred by the database’s or table’s zone configuration this will return NULL.

Resets the zone configuration for a multi-region database to match its original state. No-ops if the given database ID is not multi-region enabled.

Resets the zone configuration for a multi-region table to match its original state. No-ops if the given table ID is not a multi-region table.

Validates all multi-region zone configurations are correctly setup for the current database, including all tables, indexes and partitions underneath. Returns an error if validation fails. This builtin uses un-leased versions of the each descriptor, requiring extra round trips.

Returns the given region if the region has been added to the current database. Otherwise, this will return the primary region of the current database. This will error if the current database is not a multi-region database.

Returns the region of the connection’s current node as defined by the locality flag on node startup. Returns an error if no region is set.

Returns the region of the connection’s current node as defined by the locality flag on node startup. Returns an error if no region is set.

Split string using a POSIX regular expression as the delimiter.

Split string using a POSIX regular expression as the delimiter with flags.

CockroachDB supports the following flags:

Returns the latest value obtained with nextval for this sequence in this session.

Returns the latest value obtained with nextval for this sequence in this session.

Return value most recently obtained with nextval in this session.

Advances the given sequence and returns its new value.

Advances the given sequence and returns its new value.

Set the given sequence’s current value. The next call to nextval will return value + Increment

Set the given sequence’s current value. If is_called is false, the next call to nextval will return value; otherwise value + Increment.

Set the given sequence’s current value. The next call to nextval will return value + Increment

Set the given sequence’s current value. If is_called is false, the next call to nextval will return value; otherwise value + Increment.

Produces a virtual table containing aclitem stuff (returns no rows as this feature is unsupported in CockroachDB)

For internal CRDB testing only. The function calls a callback identified by name registered with the server by the test.

Produces a virtual table containing a single row with no values.

This function is used only by CockroachDB’s developers for testing purposes.

Produces a virtual table containing the integer values from start to end, inclusive.

Produces a virtual table containing the integer values from start to end, inclusive, by increment of step.

Produces a virtual table containing the timestamp values from start to end, inclusive, by increment of step.

Produces a virtual table containing the timestampTZ values from start to end, inclusive, by increment of step.

Returns a series comprising the given array’s subscripts.

Returns a series comprising the given array’s subscripts.

Returns a series comprising the given array’s subscripts.

When reverse is true, the series is returned in reverse order.

Returns the input array as a set of rows with an index

Expands a JSON array to a set of JSON values.

Expands a JSON array to a set of text values.

Expands the outermost JSON or JSONB object into a set of key/value pairs.

Expands the outermost JSON or JSONB object into a set of key/value pairs. The returned values will be of type text.

Returns sorted set of keys in the outermost JSON object.

Expands the object in from_json to a row whose columns match the record type defined by base.

Expands the outermost array of objects in from_json to a set of rows whose columns match the record type defined by base

Expands a JSON array to a set of JSON values.

Expands a JSON array to a set of text values.

Expands the outermost JSON or JSONB object into a set of key/value pairs.

Expands the outermost JSON or JSONB object into a set of key/value pairs. The returned values will be of type text.

Returns sorted set of keys in the outermost JSON object.

Expands the object in from_json to a row whose columns match the record type defined by base.

Expands the outermost array of objects in from_json to a set of rows whose columns match the record type defined by base

Produces a virtual table containing the keywords known to the SQL parser.

Split string using a POSIX regular expression as the delimiter.

Split string using a POSIX regular expression as the delimiter with flags.

CockroachDB supports the following flags:

Returns the input arrays as a set of rows

Returns the input array as a set of rows

Returns true if no points of geometry_b lie in the exterior of geometry_a, and there is at least one point in the interior of geometry_b that lies in the interior of geometry_a.

This function utilizes the GEOS module.

This function variant does not utilize any spatial index.

Returns true if geometry_b intersects the interior of geometry_a but not the boundary or exterior of geometry_a.

This function utilizes the GEOS module.

This function variant does not utilize any spatial index.

Returns true if no point in geography_a is outside geography_b.

The calculations performed are have a precision of 1cm.

This function utilizes the S2 library for spherical calculations.

This function variant does not utilize any spatial index.

Returns true if no point in geometry_a is outside geometry_b.

This function utilizes the GEOS module.

This function variant does not utilize any spatial index.

Returns true if no point in geography_b is outside geography_a.

This function utilizes the S2 library for spherical calculations.

This function variant does not utilize any spatial index.

Returns true if no point in geometry_b is outside geometry_a.

This function utilizes the GEOS module.

This function variant does not utilize any spatial index.

Returns true if geometry_a has some - but not all - interior points in common with geometry_b.

This function utilizes the GEOS module.

This function variant does not utilize any spatial index.

Returns true if every pair of points comprising geometry_a and geometry_b are within distance units, inclusive. In other words, the ST_MaxDistance between geometry_a and geometry_b is less than or equal to distance units.

This function variant does not utilize any spatial index.

Returns true if every pair of points comprising geometry_a and geometry_b are within distance units, exclusive. In other words, the ST_MaxDistance between geometry_a and geometry_b is less than distance units.

This function variant does not utilize any spatial index.

Returns true if any of geography_a is within distance meters of geography_b, inclusive. Uses a spheroid to perform the operation."\n\nWhen operating on a spheroid, this function will use the sphere to calculate the closest two points. The spheroid distance between these two points is calculated using GeographicLib. This follows observed PostGIS behavior.

The calculations performed are have a precision of 1cm.

This function utilizes the GeographicLib library for spheroid calculations.

This function variant does not utilize any spatial index.

Returns true if any of geography_a is within distance meters of geography_b, inclusive."\n\nWhen operating on a spheroid, this function will use the sphere to calculate the closest two points. The spheroid distance between these two points is calculated using GeographicLib. This follows observed PostGIS behavior.

The calculations performed are have a precision of 1cm.

This function utilizes the S2 library for spherical calculations.

This function utilizes the GeographicLib library for spheroid calculations.

This function variant does not utilize any spatial index.

Returns true if any of geometry_a is within distance units of geometry_b, inclusive.

This function variant does not utilize any spatial index.

Returns true if any of geography_a is within distance meters of geography_b, exclusive. Uses a spheroid to perform the operation."\n\nWhen operating on a spheroid, this function will use the sphere to calculate the closest two points. The spheroid distance between these two points is calculated using GeographicLib. This follows observed PostGIS behavior.

The calculations performed are have a precision of 1cm.

This function utilizes the GeographicLib library for spheroid calculations.

This function variant does not utilize any spatial index.

Returns true if any of geography_a is within distance meters of geography_b, exclusive."\n\nWhen operating on a spheroid, this function will use the sphere to calculate the closest two points. The spheroid distance between these two points is calculated using GeographicLib. This follows observed PostGIS behavior.

The calculations performed are have a precision of 1cm.

This function utilizes the S2 library for spherical calculations.

This function utilizes the GeographicLib library for spheroid calculations.

This function variant does not utilize any spatial index.

Returns true if any of geometry_a is within distance units of geometry_b, exclusive.

This function variant does not utilize any spatial index.

Returns true if geometry_a is spatially equal to geometry_b, i.e. ST_Within(geometry_a, geometry_b) = ST_Within(geometry_b, geometry_a) = true.

This function utilizes the GEOS module.

This function variant does not utilize any spatial index.

Returns true if geography_a shares any portion of space with geography_b.

The calculations performed are have a precision of 1cm.

This function utilizes the S2 library for spherical calculations.

This function variant does not utilize any spatial index.

Returns true if geometry_a shares any portion of space with geometry_b.

The calculations performed are have a precision of 1cm.

This function utilizes the GEOS module.

This function variant does not utilize any spatial index.

Returns true if geometry_a intersects but does not completely contain geometry_b, or vice versa. “Does not completely” implies ST_Within(geometry_a, geometry_b) = ST_Within(geometry_b, geometry_a) = false.

This function utilizes the GEOS module.

This function variant does not utilize any spatial index.

Returns true if the only points in common between geometry_a and geometry_b are on the boundary. Note points do not touch other points.

This function utilizes the GEOS module.

This function variant does not utilize any spatial index.

Returns true if geometry_a is completely inside geometry_b.

This function utilizes the GEOS module.

This function variant does not utilize any spatial index.

Adds a new geometry column to an existing table and returns metadata about the column created.

Adds a new geometry column to an existing table and returns metadata about the column created.

Adds a new geometry column to an existing table and returns metadata about the column created.

Adds a new geometry column to an existing table and returns metadata about the column created.

Adds a new geometry column to an existing table and returns metadata about the column created.

Adds a new geometry column to an existing table and returns metadata about the column created.

Returns the type of geometry as a string.

This function utilizes the GEOS module.

Returns the Geometry from an EWKB representation.

Returns the Geometry from an EWKT representation.

Compatibility placeholder function with PostGIS. This does not perform any operation on the Geometry.

Compatibility placeholder function with PostGIS. This does not perform any operation on the Geometry.

Compatibility placeholder function with PostGIS. Returns a fixed string based on PostGIS 3.0.1, with minor edits.

Compatibility placeholder function with PostGIS. Returns a fixed string based on PostGIS 3.0.1, with minor edits.

Compatibility placeholder function with PostGIS. Returns a fixed string based on PostGIS 3.0.1, with minor edits.

Returns a box2d encapsulating the given Geometry.

Returns whether a given Geometry has a bounding box. False for points and empty geometries; always true otherwise.

Compatibility placeholder function with PostGIS. Returns a fixed string based on PostGIS 3.0.1, with minor edits.

Compatibility placeholder function with PostGIS. Returns a fixed string based on PostGIS 3.0.1, with minor edits.

Compatibility placeholder function with PostGIS. Returns a fixed string based on PostGIS 3.0.1, with minor edits.

Compatibility placeholder function with PostGIS. Returns a fixed string based on PostGIS 3.0.1, with minor edits.

Compatibility placeholder function with PostGIS. Returns a fixed string based on PostGIS 3.0.1, with minor edits.

Compatibility placeholder function with PostGIS. Returns a fixed string based on PostGIS 3.0.1, with minor edits.

Compatibility placeholder function with PostGIS. Returns a fixed string based on PostGIS 3.0.1, with minor edits.

Compatibility placeholder function with PostGIS. Returns a fixed string based on PostGIS 3.0.1, with minor edits.

Compatibility placeholder function with PostGIS. Returns a fixed string based on PostGIS 3.0.1, with minor edits.

Compatibility placeholder function with PostGIS. Returns a fixed string based on PostGIS 3.0.1, with minor edits.

Returns a copy of a LineString or MultiLineString with measure coordinates linearly interpolated between the specified start and end values. Any existing M coordinates will be overwritten.

Adds a Point to the end of a LineString.

Adds a Point to a LineString at the given 0-based index (-1 to append).

Applies a 3D affine transformation to the given geometry.

The matrix transformation will be applied as follows for each coordinate: / a b c x_off \ / x
| d e f y_off | | y | | g h i z_off | | z | \ 0 0 0 1 / \ 0 /

Applies a 2D affine transformation to the given geometry.

The matrix transformation will be applied as follows for each coordinate: / a b x_off \ / x
| d e y_off | | y | \ 0 0 1 / \ 0 /

Returns the clockwise angle between two LINESTRING geometries, treating them as vectors between their start- and endpoints. Returns NULL if any vectors have 0 length.

Returns the clockwise angle between the vectors formed by point2,point1 and point2,point3. The arguments must be POINT geometries. Returns NULL if any vectors have 0 length.

Returns the clockwise angle between the vectors formed by point1,point2 and point3,point4. The arguments must be POINT geometries. Returns NULL if any vectors have 0 length.

Returns the area of the given geography in meters^2. Uses a spheroid to perform the operation.

This function utilizes the GeographicLib library for spheroid calculations.

Returns the area of the given geography in meters^2.

This function utilizes the S2 library for spherical calculations.

This function utilizes the GeographicLib library for spheroid calculations.

Returns the area of the given geometry.

This function utilizes the GEOS module.

Returns the area of the given geometry.

This function utilizes the GEOS module.

This variant will cast all geometry_str arguments into Geometry types.

Returns the area of the given geometry.

This function utilizes the GEOS module.

Returns the WKB representation of a given Geography.

Returns the WKB representation of a given Geography. This variant has a second argument denoting the encoding - xdr for big endian and ndr for little endian.

Returns the WKB representation of a given Geometry.

Returns the WKB representation of a given Geometry. This variant has a second argument denoting the encoding - xdr for big endian and ndr for little endian.

Returns the geometry as an Encoded Polyline. This format is used by Google Maps with precision=5 and by Open Source Routing Machine with precision=5 and 6. Preserves 5 decimal places.

Returns the geometry as an Encoded Polyline. This format is used by Google Maps with precision=5 and by Open Source Routing Machine with precision=5 and 6. Precision specifies how many decimal places will be preserved in Encoded Polyline. Value should be the same on encoding and decoding, or coordinates will be incorrect.

Returns the EWKB representation of a given Geography.

Returns the EWKB representation of a given Geometry.

Returns the EWKT representation of a given Geography. A default of 15 decimal digits is used.

Returns the EWKT representation of a given Geography. The max_decimal_digits parameter controls the maximum decimal digits to print after the .. Use -1 to print as many digits as required to rebuild the same number.

Returns the EWKT representation of a given Geometry. A maximum of 15 decimal digits is used.

Returns the WKT representation of a given Geometry. The max_decimal_digits parameter controls the maximum decimal digits to print after the .. Use -1 to print as many digits as required to rebuild the same number.

Returns the EWKT representation of a given Geometry. A maximum of 15 decimal digits is used.

This variant will cast all geometry_str arguments into Geometry types.

Returns the WKT representation of a given Geometry. The max_decimal_digits parameter controls the maximum decimal digits to print after the .. Use -1 to print as many digits as required to rebuild the same number.

This variant will cast all geometry_str arguments into Geometry types.

Returns the GeoJSON representation of a given Geography. Coordinates have a maximum of 9 decimal digits.

Returns the GeoJSON representation of a given Geography with max_decimal_digits output for each coordinate value.

Returns the GeoJSON representation of a given Geography with max_decimal_digits output for each coordinate value.

Options is a flag that can be bitmasked. The options are:

• 0: no option (default for Geography)
• 1: GeoJSON BBOX
• 2: GeoJSON Short CRS (e.g EPSG:4326)
• 4: GeoJSON Long CRS (e.g urn:ogc:def:crs:EPSG::4326)
• 8: GeoJSON Short CRS if not EPSG:4326

Returns the GeoJSON representation of a given Geometry. Coordinates have a maximum of 9 decimal digits.

Returns the GeoJSON representation of a given Geometry with max_decimal_digits output for each coordinate value.

Returns the GeoJSON representation of a given Geometry with max_decimal_digits output for each coordinate value.

Options is a flag that can be bitmasked. The options are:

• 0: no option
• 1: GeoJSON BBOX
• 2: GeoJSON Short CRS (e.g EPSG:4326)
• 4: GeoJSON Long CRS (e.g urn:ogc:def:crs:EPSG::4326)
• 8: GeoJSON Short CRS if not EPSG:4326 (default for Geometry)

Returns the GeoJSON representation of a given Geometry. Coordinates have a maximum of 9 decimal digits.

This variant will cast all geometry_str arguments into Geometry types.

Returns the GeoJSON representation of a given Geometry with max_decimal_digits output for each coordinate value.

This variant will cast all geometry_str arguments into Geometry types.

Returns the GeoJSON representation of a given Geometry with max_decimal_digits output for each coordinate value.

Options is a flag that can be bitmasked. The options are:

• 0: no option
• 1: GeoJSON BBOX
• 2: GeoJSON Short CRS (e.g EPSG:4326)
• 4: GeoJSON Long CRS (e.g urn:ogc:def:crs:EPSG::4326)
• 8: GeoJSON Short CRS if not EPSG:4326 (default for Geometry)

This variant will cast all geometry_str arguments into Geometry types.

Returns the GeoJSON representation of a given Geometry. Coordinates have a maximum of 9 decimal digits.

Returns the GeoJSON representation of a given Geometry, using geo_column as the geometry for the given Feature. Coordinates have a maximum of 9 decimal digits.

Returns the GeoJSON representation of a given Geometry, using geo_column as the geometry for the given Feature. max_decimal_digits will be output for each coordinate value.

Returns the GeoJSON representation of a given Geometry, using geo_column as the geometry for the given Feature. max_decimal_digits will be output for each coordinate value. Output will be pretty printed in JSON if pretty is true.

Returns the EWKB representation in hex of a given Geography.

Returns the EWKB representation in hex of a given Geography. This variant has a second argument denoting the encoding - xdr for big endian and ndr for little endian.

Returns the EWKB representation in hex of a given Geometry.

Returns the EWKB representation in hex of a given Geometry. This variant has a second argument denoting the encoding - xdr for big endian and ndr for little endian.

Returns the WKB representation in hex of a given Geography.

Returns the WKB representation in hex of a given Geometry.

Returns the KML representation of a given Geography.

Returns the KML representation of a given Geometry.

Returns the KML representation of a given Geometry.

This variant will cast all geometry_str arguments into Geometry types.

Returns the WKT representation of a given Geography. A default of 15 decimal digits is used.

Returns the WKT representation of a given Geography. The max_decimal_digits parameter controls the maximum decimal digits to print after the .. Use -1 to print as many digits as required to rebuild the same number.

Returns the WKT representation of a given Geometry. A maximum of 15 decimal digits is used.

Returns the WKT representation of a given Geometry. The max_decimal_digits parameter controls the maximum decimal digits to print after the .. Use -1 to print as many digits as required to rebuild the same number.

Returns the WKT representation of a given Geometry. A maximum of 15 decimal digits is used.

This variant will cast all geometry_str arguments into Geometry types.

Returns the WKT representation of a given Geometry. The max_decimal_digits parameter controls the maximum decimal digits to print after the .. Use -1 to print as many digits as required to rebuild the same number.

This variant will cast all geometry_str arguments into Geometry types.

Returns the TWKB representation of a given geometry.

Returns the TWKB representation of a given geometry.

Returns the TWKB representation of a given geometry.

Returns the azimuth in radians of the segment defined by the given point geographies, or NULL if the two points are coincident. It is solved using the Inverse geodesic problem.

The azimuth is angle is referenced from north, and is positive clockwise: North = 0; East = π/2; South = π; West = 3π/2.

This function utilizes the GeographicLib library for spheroid calculations.

Returns the azimuth in radians of the segment defined by the given point geometries, or NULL if the two points are coincident.

The azimuth is angle is referenced from north, and is positive clockwise: North = 0; East = π/2; South = π; West = 3π/2.

Returns the closure of the combinatorial boundary of this Geometry.

This function utilizes the GEOS module.

Return a Box2D from a GeoHash string with max precision.

Return a Box2D from a GeoHash string with supplied precision.

Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.

This function utilizes the GEOS module.

This operation is done by transforming the object into a Geometry. This occurs by translating the Geography objects into Geometry objects before applying an LAEA, UTM or Web Mercator based projection based on the bounding boxes of the given Geography objects. When the result is calculated, the result is transformed back into a Geography with SRID 4326.

Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.

This variant takes in a space separate parameter string, which will augment the buffer styles. Valid parameters are:

• quad_segs=<int>, default 8
• endcap=<round|flat|butt|square>, default round
• join=<round|mitre|miter|bevel>, default round
• side=<both|left|right>, default both
• mitre_limit=<float>, default 5.0

This function utilizes the GEOS module.

This operation is done by transforming the object into a Geometry. This occurs by translating the Geography objects into Geometry objects before applying an LAEA, UTM or Web Mercator based projection based on the bounding boxes of the given Geography objects. When the result is calculated, the result is transformed back into a Geography with SRID 4326.

Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.

This variant approximates the circle into quad_seg segments per line (the default is 8).

This function utilizes the GEOS module.

This operation is done by transforming the object into a Geometry. This occurs by translating the Geography objects into Geometry objects before applying an LAEA, UTM or Web Mercator based projection based on the bounding boxes of the given Geography objects. When the result is calculated, the result is transformed back into a Geography with SRID 4326.

Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.

This function utilizes the GEOS module.

Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.

This function utilizes the GEOS module.

Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.

This variant takes in a space separate parameter string, which will augment the buffer styles. Valid parameters are:

• quad_segs=<int>, default 8
• endcap=<round|flat|butt|square>, default round
• join=<round|mitre|miter|bevel>, default round
• side=<both|left|right>, default both
• mitre_limit=<float>, default 5.0

This function utilizes the GEOS module.

Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.

This variant approximates the circle into quad_seg segments per line (the default is 8).

This function utilizes the GEOS module.

Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.

This function utilizes the GEOS module.

Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.

This function utilizes the GEOS module.

This variant will cast all geometry_str arguments into Geometry types.

Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.

This function utilizes the GEOS module.

This variant will cast all geometry_str arguments into Geometry types.

Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.

This variant takes in a space separate parameter string, which will augment the buffer styles. Valid parameters are:

• quad_segs=<int>, default 8
• endcap=<round|flat|butt|square>, default round
• join=<round|mitre|miter|bevel>, default round
• side=<both|left|right>, default both
• mitre_limit=<float>, default 5.0

This function utilizes the GEOS module.

This variant will cast all geometry_str arguments into Geometry types.

Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.

This variant approximates the circle into quad_seg segments per line (the default is 8).

This function utilizes the GEOS module.

This variant will cast all geometry_str arguments into Geometry types.

Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.

This function utilizes the GEOS module.

This variant will cast all geometry_str arguments into Geometry types.

Returns the centroid of given geography. Uses a spheroid to perform the operation.

This function utilizes the GeographicLib library for spheroid calculations.

Returns the centroid of given geography.

This function utilizes the S2 library for spherical calculations.

This function utilizes the GeographicLib library for spheroid calculations.

Returns the centroid of the given geometry.

This function utilizes the GEOS module.

Returns the centroid of the given geometry.

This function utilizes the GEOS module.

This variant will cast all geometry_str arguments into Geometry types.

Clips the geometry to conform to the bounding box specified by box2d.

Returns the 2-dimensional point on geometry_a that is closest to geometry_b. This is the first point of the shortest line.

Given a collection, returns a multitype consisting only of elements of the specified type. If there are no elements of the given type, an EMPTY geometry is returned. Types are specified as 1=POINT, 2=LINESTRING, 3=POLYGON - other types are not supported.

Returns the “simplest” representation of a collection’s contents. Collections of a single type will be returned as an appopriate multitype, or a singleton if it only contains a single geometry.

Combines the current bounding box with the bounding box of the Geometry.

Returns true if no points of geometry_b lie in the exterior of geometry_a, and there is at least one point in the interior of geometry_b that lies in the interior of geometry_a.

This function utilizes the GEOS module.

This function variant will attempt to utilize any available spatial index.

Returns true if geometry_b intersects the interior of geometry_a but not the boundary or exterior of geometry_a.

This function utilizes the GEOS module.

This function variant will attempt to utilize any available spatial index.

Returns a geometry that represents the Convex Hull of the given geometry.

This function utilizes the GEOS module.

Returns the number of coordinate dimensions of a given Geometry.

Returns true if no point in geography_a is outside geography_b.

The calculations performed are have a precision of 1cm.

This function utilizes the S2 library for spherical calculations.

This function variant will attempt to utilize any available spatial index.

Returns true if no point in geometry_a is outside geometry_b.

This function utilizes the GEOS module.

This function variant will attempt to utilize any available spatial index.

Returns true if no point in geometry_a is outside geometry_b.

This function utilizes the GEOS module.

This function variant will attempt to utilize any available spatial index.

This variant will cast all geometry_str arguments into Geometry types.

Returns true if no point in geography_b is outside geography_a.

This function utilizes the S2 library for spherical calculations.

This function variant will attempt to utilize any available spatial index.

Returns true if no point in geometry_b is outside geometry_a.

This function utilizes the GEOS module.

This function variant will attempt to utilize any available spatial index.

Returns true if no point in geometry_b is outside geometry_a.

This function utilizes the GEOS module.

This function variant will attempt to utilize any available spatial index.

This variant will cast all geometry_str arguments into Geometry types.

Returns true if geometry_a has some - but not all - interior points in common with geometry_b.

This function utilizes the GEOS module.

This function variant will attempt to utilize any available spatial index.

Returns true if every pair of points comprising geometry_a and geometry_b are within distance units, inclusive. In other words, the ST_MaxDistance between geometry_a and geometry_b is less than or equal to distance units.

This function variant will attempt to utilize any available spatial index.

Returns true if every pair of points comprising geometry_a and geometry_b are within distance units, exclusive. In other words, the ST_MaxDistance between geometry_a and geometry_b is less than distance units.

This function variant will attempt to utilize any available spatial index.

Returns the difference of two Geometries.

This function utilizes the GEOS module.

Returns the number of topological dimensions of a given Geometry.

Returns true if geometry_a does not overlap, touch or is within geometry_b.

This function utilizes the GEOS module.

Returns the distance in meters between geography_a and geography_b. Uses a spheroid to perform the operation."\n\nWhen operating on a spheroid, this function will use the sphere to calculate the closest two points. The spheroid distance between these two points is calculated using GeographicLib. This follows observed PostGIS behavior.

This function utilizes the GeographicLib library for spheroid calculations.

Returns the distance in meters between geography_a and geography_b."\n\nWhen operating on a spheroid, this function will use the sphere to calculate the closest two points. The spheroid distance between these two points is calculated using GeographicLib. This follows observed PostGIS behavior.

This function utilizes the S2 library for spherical calculations.

This function utilizes the GeographicLib library for spheroid calculations.

Returns the distance between the given geometries.

Returns the distance between the given geometries.

This variant will cast all geometry_str arguments into Geometry types.

Returns the distance in meters between geometry_a and geometry_b assuming the coordinates represent lng/lat points on a sphere.

This function utilizes the S2 library for spherical calculations.

Returns the distance in meters between geometry_a and geometry_b assuming the coordinates represent lng/lat points on a spheroid."\n\nWhen operating on a spheroid, this function will use the sphere to calculate the closest two points. The spheroid distance between these two points is calculated using GeographicLib. This follows observed PostGIS behavior.

This function utilizes the S2 library for spherical calculations.

This function utilizes the GeographicLib library for spheroid calculations.

Returns true if any of geography_a is within distance meters of geography_b, inclusive. Uses a spheroid to perform the operation."\n\nWhen operating on a spheroid, this function will use the sphere to calculate the closest two points. The spheroid distance between these two points is calculated using GeographicLib. This follows observed PostGIS behavior.

The calculations performed are have a precision of 1cm.

This function utilizes the GeographicLib library for spheroid calculations.

This function variant will attempt to utilize any available spatial index.

Returns true if any of geography_a is within distance meters of geography_b, inclusive."\n\nWhen operating on a spheroid, this function will use the sphere to calculate the closest two points. The spheroid distance between these two points is calculated using GeographicLib. This follows observed PostGIS behavior.

The calculations performed are have a precision of 1cm.

This function utilizes the S2 library for spherical calculations.

This function utilizes the GeographicLib library for spheroid calculations.

This function variant will attempt to utilize any available spatial index.

Returns true if any of geometry_a is within distance units of geometry_b, inclusive.

This function variant will attempt to utilize any available spatial index.

Returns true if any of geometry_a is within distance units of geometry_b, inclusive.

This function variant will attempt to utilize any available spatial index.

This variant will cast all geometry_str arguments into Geometry types.

Returns true if any of geography_a is within distance meters of geography_b, exclusive. Uses a spheroid to perform the operation."\n\nWhen operating on a spheroid, this function will use the sphere to calculate the closest two points. The spheroid distance between these two points is calculated using GeographicLib. This follows observed PostGIS behavior.

The calculations performed are have a precision of 1cm.

This function utilizes the GeographicLib library for spheroid calculations.

This function variant will attempt to utilize any available spatial index.

Returns true if any of geography_a is within distance meters of geography_b, exclusive."\n\nWhen operating on a spheroid, this function will use the sphere to calculate the closest two points. The spheroid distance between these two points is calculated using GeographicLib. This follows observed PostGIS behavior.

The calculations performed are have a precision of 1cm.

This function utilizes the S2 library for spherical calculations.

This function utilizes the GeographicLib library for spheroid calculations.

This function variant will attempt to utilize any available spatial index.

Returns true if any of geometry_a is within distance units of geometry_b, exclusive.

This function variant will attempt to utilize any available spatial index.

Returns true if any of geometry_a is within distance units of geometry_b, exclusive.

This function variant will attempt to utilize any available spatial index.

This variant will cast all geometry_str arguments into Geometry types.

Returns the last point of a geometry which has shape LineString. Returns NULL if the geometry is not a LineString.

Returns a bounding geometry for the given box.

Returns a bounding envelope for the given geometry.

For geometries which have a POINT or LINESTRING bounding box (i.e. is a single point or a horizontal or vertical line), a POINT or LINESTRING is returned. Otherwise, the returned POLYGON will be ordered Bottom Left, Top Left, Top Right, Bottom Right, Bottom Left.

Returns true if geometry_a is spatially equal to geometry_b, i.e. ST_Within(geometry_a, geometry_b) = ST_Within(geometry_b, geometry_a) = true.

This function utilizes the GEOS module.

This function variant will attempt to utilize any available spatial index.

Returns the estimated extent of the geometries in the column of the given table. This currently always returns NULL.

Returns the estimated extent of the geometries in the column of the given table. This currently always returns NULL.

The parent_only boolean is always ignored.

Returns the estimated extent of the geometries in the column of the given table. This currently always returns NULL.

Extends the box2d by delta units across all dimensions.

Extends the box2d by delta_x units in the x dimension and delta_y units in the y dimension.

Extends the bounding box represented by the geometry by delta units across all dimensions, returning a Polygon representing the new bounding box.

Extends the bounding box represented by the geometry by delta_x units in the x dimension and delta_y units in the y dimension, returning a Polygon representing the new bounding box.

Returns the exterior ring of a Polygon as a LineString. Returns NULL if the shape is not a Polygon.

Returns a new geometry with the X and Y axes flipped.

Returns a Geometry that is forced into XY layout with any Z or M dimensions discarded.

Returns a Geometry that is forced into XYZ layout. If a Z coordinate doesn’t exist, it will be set to 0. If a M coordinate is present, it will be discarded.

Returns a Geometry that is forced into XYZ layout. If a Z coordinate doesn’t exist, it will be set to the specified default Z value. If a M coordinate is present, it will be discarded.

Returns a Geometry that is forced into XYM layout. If a M coordinate doesn’t exist, it will be set to 0. If a Z coordinate is present, it will be discarded.

Returns a Geometry that is forced into XYM layout. If a M coordinate doesn’t exist, it will be set to the specified default M value. If a Z coordinate is present, it will be discarded.

Returns a Geometry that is forced into XYZ layout. If a Z coordinate doesn’t exist, it will be set to 0. If a M coordinate is present, it will be discarded.

Returns a Geometry that is forced into XYZ layout. If a Z coordinate doesn’t exist, it will be set to the specified default Z value. If a M coordinate is present, it will be discarded.

Returns a Geometry that is forced into XYZM layout. If a Z coordinate doesn’t exist, it will be set to 0. If a M coordinate doesn’t exist, it will be set to 0.

Returns a Geometry that is forced into XYZ layout. If a Z coordinate doesn’t exist, it will be set to the specified default Z value. If a M coordinate doesn’t exist, it will be set to 0.

Returns a Geometry that is forced into XYZ layout. If a Z coordinate doesn’t exist, it will be set to the specified Z value. If a M coordinate doesn’t exist, it will be set to the specified M value.

Converts the geometry into a GeometryCollection.

Returns a Geometry where all Polygon objects have exterior rings in the counter-clockwise orientation and interior rings in the clockwise orientation. Non-Polygon objects are unchanged.

Returns a Geometry where all Polygon objects have exterior rings in the clockwise orientation and interior rings in the counter-clockwise orientation. Non-Polygon objects are unchanged.

Returns the Frechet distance between the given geometries.

This function utilizes the GEOS module.

Returns the Frechet distance between the given geometries, with the given segment densification (range 0.0-1.0, -1 to disable).

Smaller densify_frac gives a more accurate Fréchet distance. However, the computation time and memory usage increases with the square of the number of subsegments.

This function utilizes the GEOS module.

Generates pseudo-random points until the requested number are found within the input area. Uses system time as a seed. The requested number of points must be not larger than 65336.

Generates pseudo-random points until the requested number are found within the input area. The requested number of points must be not larger than 65336.

Returns the Geography from an EWKB representation.

Returns the Geography from an EWKT representation.

Returns the Geography from an GeoJSON representation.

Returns the Geography from an GeoJSON representation.

Returns the Geography from a WKT or EWKT representation with an SRID. If the SRID is present in both the EWKT and the argument, the argument value is used.

Returns the Geography from a WKT or EWKT representation.

Returns the Geography from a WKB (or EWKB) representation with the given SRID set.

Returns the Geography from a WKB (or EWKB) representation.

Returns the Geography from a WKT or EWKT representation with an SRID. If the SRID is present in both the EWKT and the argument, the argument value is used.

Returns the Geography from a WKT or EWKT representation.

Returns a GeoHash representation of the geeographywith full precision if a point is provided, or with variable precision based on the size of the feature.

Returns a GeoHash representation of the geography with the supplied precision.

Returns a GeoHash representation of the geometry with full precision if a point is provided, or with variable precision based on the size of the feature. This will error any coordinates are outside the bounds of longitude/latitude.

Returns a GeoHash representation of the geometry with the supplied precision. This will error any coordinates are outside the bounds of longitude/latitude.

Returns the Geometry from a WKT or EWKT representation with an SRID. If the shape underneath is not GeometryCollection, NULL is returned. If the SRID is present in both the EWKT and the argument, the argument value is used.

Returns the Geometry from a WKT or EWKT representation. If the shape underneath is not GeometryCollection, NULL is returned.

Returns the Geometry from a WKB (or EWKB) representation. If the shape underneath is not GeometryCollection, NULL is returned.

Returns the Geometry from a WKB (or EWKB) representation with an SRID. If the shape underneath is not GeometryCollection, NULL is returned.

Returns the Geometry from a WKT or EWKT representation with an SRID. If the SRID is present in both the EWKT and the argument, the argument value is used.

Returns the Geometry from a WKT or EWKT representation.

Returns the n-th Geometry (1-indexed). Returns NULL if out of bounds.

Returns the type of geometry as a string prefixed with ST_.

This function utilizes the GEOS module.

Returns the Geometry from an EWKB representation.

Returns the Geometry from an EWKT representation.

Return a POLYGON Geometry from a GeoHash string with max precision.

Return a POLYGON Geometry from a GeoHash string with supplied precision.

Returns the Geometry from an GeoJSON representation.

Returns the Geometry from an GeoJSON representation.

Returns the Geometry from a WKT or EWKT representation with an SRID. If the SRID is present in both the EWKT and the argument, the argument value is used.

Returns the Geometry from a WKT or EWKT representation.

Returns the Geometry from a WKB (or EWKB) representation with the given SRID set.

Returns the Geometry from a WKB (or EWKB) representation.

Returns whether there is a CIRCULARSTRING in the geometry.

Returns the Hausdorff distance between the given geometries.

This function utilizes the GEOS module.

Returns the Hausdorff distance between the given geometries, with the given segment densification (range 0.0-1.0).

This function utilizes the GEOS module.

Returns the n-th (1-indexed) interior ring of a Polygon as a LineString. Returns NULL if the shape is not a Polygon, or the ring does not exist.

Returns the point intersections of the given geographies.

This operation is done by transforming the object into a Geometry. This occurs by translating the Geography objects into Geometry objects before applying an LAEA, UTM or Web Mercator based projection based on the bounding boxes of the given Geography objects. When the result is calculated, the result is transformed back into a Geography with SRID 4326.

This function utilizes the GEOS module.

Returns the point intersections of the given geometries.

This function utilizes the GEOS module.

Returns the point intersections of the given geometries.

This function utilizes the GEOS module.

This variant will cast all geometry_str arguments into Geometry types.