CData Python Connector for Azure Cosmos DB

Build 24.0.9060

Predicate Functions

ABS(numeric_expr)

Returns the absolute (positive) value of the specified numeric expression.

  • numeric_expr: A numeric expression.

ACOS(numeric_expr)

Returns the angle, in radians, whose cosine is the specified numeric expression; also called arccosine.

  • numeric_expr: A numeric expression.

ASIN(numeric_expr)

Returns the angle, in radians, whose sine is the specified numeric expression. This is also called arcsine.

  • numeric_expr: A numeric expression.

ATAN(numeric_expr)

Returns the angle, in radians, whose tangent is the specified numeric expression. This is also called arctangent.

  • numeric_expr: A numeric expression.

CEILING(numeric_expr)

Returns the smallest integer value greater than, or equal to, the specified numeric expression.

  • numeric_expr: A numeric expression.

COS(numeric_expr)

Returns the trigonometric cosine of the specified angle, in radians, in the specified expression.

  • numeric_expr: A numeric expression.

COT(numeric_expr)

Returns the trigonometric cotangent of the specified angle, in radians, in the specified numeric expression.

  • numeric_expr: A numeric expression.

DEGREES(numeric_expr)

Returns the corresponding angle in degrees for an angle specified in radians.

  • numeric_expr: A numeric expression.

FLOOR(numeric_expr)

Returns the largest integer less than or equal to the specified numeric expression.

  • numeric_expr: A numeric expression.

EXP(numeric_expr)

Returns the exponential value of the specified numeric expression.

  • numeric_expr: A numeric expression.

LOG10(numeric_expr)

Returns the base-10 logarithm of the specified numeric expression.

  • numeric_expr: A numeric expression.

RADIANS(numeric_expr)

Returns radians when a numeric expression, in degrees, is entered.

  • numeric_expr: A numeric expression.

RAND()

Returns a randomly generated numeric value from [0,1).

ROUND(numeric_expr)

Returns a numeric value, rounded to the closest integer value.

  • numeric_expr: A numeric expression.

SIGN(numeric_expr)

Returns the positive (+1), zero (0), or negative (-1) sign of the specified numeric expression.

  • numeric_expr: A numeric expression.

SIN(numeric_expr)

Returns the trigonometric sine of the specified angle, in radians, in the specified expression.

  • numeric_expr: A numeric expression.

SQRT(numeric_expr)

Returns the square root of the specified numeric value.

  • numeric_expr: A numeric expression.

SQUARE(numeric_expr)

Returns the square of the specified numeric value.

  • numeric_expr: A numeric expression.

TAN(numeric_expr)

Returns the tangent of the specified angle, in radians, in the specified expression.

  • numeric_expr: A numeric expression.

TRUNC(numeric_expr)

Returns a numeric value, truncated to the closest integer value.

  • numeric_expr: A numeric expression.

ATN2(y_expr, x_expr)

Returns the principal value of the arc tangent of y/x, expressed in radians.

  • y_expr: The y numeric expression.
  • x_expr: The x numeric expression.

LOG(numeric_expr [, base])

Returns the natural logarithm of the specified numeric expression.

  • numeric_expr: A numeric expression.
  • base: Optional numeric argument that sets the base for the logarithm.

PI()

Returns the constant value of PI.

POWER(numeric_expr, power_expr)

Returns the value of the specified expression to the specified power.

  • numeric_expr: A numeric expression.
  • power_expr: Is the power to which to raise numeric_expr.

IS_ARRAY(expr)

Returns a Boolean value indicating if the type of the specified expression is an array.

  • expr: Any valid expression.

IS_BOOL(expr)

Returns a Boolean value indicating if the type of the specified expression is a Boolean.

  • expr: Any valid expression.

IS_DEFINED(expr)

Returns a Boolean indicating if the property has been assigned a value.

  • expr: Any valid expression.

IS_NULL(expr)

Returns a Boolean value indicating if the type of the specified expression is null.

  • expr: Any valid expression.

IS_NUMBER(expr)

Returns a Boolean value indicating if the type of the specified expression is a number.

  • expr: Any valid expression.

IS_OBJECT(expr)

Returns a Boolean value indicating if the type of the specified expression is a JSON object.

  • expr: Any valid expression.

IS_PRIMITIVE(expr)

Returns a Boolean value indicating if the type of the specified expression is a primitive (string, Boolean, numeric, or null).

  • expr: Any valid expression.

IS_STRING(expr)

Returns a Boolean value indicating if the type of the specified expression is a string.

  • expr: Any valid expression.

CONCAT(str1, str2 [, str3] [, ...])

Returns a string that is the result of concatenating two or more string values.

  • str1: The first string to concatenate.
  • str2: The second string to concatenate.
  • str3: The third string to concatenate.

CONTAINS(str1, str2)

Returns a Boolean indicating whether the first string expression contains the second.

  • str1: The string to search in.
  • str2: The string to search for.

ENDSWITH(str1, str2)

Returns a Boolean indicating whether the first string expression ends with the second.

  • str1: The string to search in.
  • str2: The string to search for.

INDEX_OF(str1, str2)

Returns the starting position of the first occurrence of the second string expression within the first specified string expression, or -1 if the string is not found.

  • str1: The string to search in.
  • str2: The string to search for.

LEFT(str, num_expr)

Returns the left part of a string with the specified number of characters.

  • str: A valid string expression.
  • num_expr: The number of characters to return.

LENGTH(str)

Returns the number of characters of the specified string expression.

  • str: Any valid string expression.

LOWER(str)

Returns a string expression after converting uppercase character data to lowercase.

  • str: Any valid string expression.

LTRIM(str)

Returns a string expression after it removes leading blanks.

  • str: Any valid string expression.

REPLACE(original_value, from_value, to_value)

Replaces all occurrences of a specified string value with another string value.

  • original_value: The string to search in.
  • from_value: The string to search for.
  • to_value: The string to replace instances of from_value.

REPLICATE(str, repeat_num)

Repeats a string value a specified number of times.

  • str: The string expression to repeat.
  • repeat_num: The number of times to repeat the str expression.

REVERSE(str)

Returns the reverse order of a string value.

  • str: Any valid string expression.

RIGHT(str, num_expr)

Returns the right part of a string with the specified number of characters.

  • str: Any valid string expression.
  • num_expr: The starting index.

RTRIM(str)

Returns a string expression after it removes trailing blanks.

  • str: Any valid string expression.

STARTSWITH(str1, str2)

Returns a Boolean indicating whether the first string expression starts with the second.

  • str1: The string to search in.
  • str2: The string to search for.

SUBSTRING(str, start_index, length)

Returns part of a string expression starting at the specified character zero-based position and continues to the specified length, or to the end of the string.

  • str: Any valid string expression.
  • start_index: The starting index.
  • length: The length of the string to return.

TOSTRING(expr)

Returns a string representation of scalar expression.

  • expr: Any valid expression.

TRIM(str)

Returns a string expression after it removes leading and trailing blanks.

  • str: Any valid string expression.

UPPER(str)

Returns a string expression after converting lowercase character data to uppercase.

  • str: Any valid string expression.

ARRAY_CONCAT(array_exp1, array_exp2 [, array_exp3])

Returns an array that is the result of concatenating two or more array values.

  • array_exp1: Any valid array expression.
  • array_exp2: Any valid array expression.
  • array_exp3: Any valid array expression.

ARRAY_CONTAINS(array_exp, expr [, bool_expr])

Returns a Boolean indicating whether the array contains the specified value. You can check for a partial or full match of an object by using a boolean expression within the command.

  • array_exp1: Any array expression.
  • expr: The expression to search for.
  • bool_expr: If it's set to 'true'and if the specified search value is an object, the command checks for a partial match (the search object is a subset of one of the objects). If it's set to 'false', the command checks for a full match of all objects within the array. The default value if not specified is false.

ARRAY_LENGTH(array_exp)

Returns the number of elements of the specified array expression.

  • array_exp: Any valid array expression.

ARRAY_SLICE(array_exp, start_index, max_size)

Returns part of an array expression.

  • array_exp: Any valid array expression.
  • start_index: Zero-based numeric index at which to begin the array. Negative values may be used to specify the starting index relative to the last element of the array i.e. -1 references the last element in the array.
  • max_size: Maximum number of elements in the resulting array.

ST_DISTANCE(spatial_expr1, spatial_expr2)

Returns the distance between the two GeoJSON Point, Polygon, or LineString expressions.

  • spatial_expr1: Is any valid GeoJSON Point, Polygon, or LineString object expression.
  • spatial_expr2: Is any valid GeoJSON Point, Polygon, or LineString object expression.

ST_WITHIN(spatial_expr1, spatial_expr2)

Returns a Boolean expression indicating whether the GeoJSON object (Point, Polygon, or LineString) specified in the first argument is within the GeoJSON (Point, Polygon, or LineString) in the second argument.

  • spatial_expr1: Is any valid GeoJSON Point, Polygon, or LineString object expression.
  • spatial_expr2: Is any valid GeoJSON Point, Polygon, or LineString object expression.

ST_INTERSECTS(1, 2)

Returns a Boolean expression indicating whether the GeoJSON object (Point, Polygon, or LineString) specified in the first argument intersects the GeoJSON (Point, Polygon, or LineString) in the second argument.

  • spatial_expr1: Is any valid GeoJSON Point, Polygon, or LineString object expression.
  • spatial_expr2: Is any valid GeoJSON Point, Polygon, or LineString object expression.

ST_ISVALID(spatial_expr)

Returns a Boolean value indicating whether the specified GeoJSON Point, Polygon, or LineString expression is valid.

  • spatial_expr: Is any valid GeoJSON Point, Polygon, or LineString object expression.

ST_ISVALIDDETAILED(spatial_expr)

Returns a JSON value containing a Boolean value if the specified GeoJSON Point, Polygon, or LineString expression is valid, and if invalid, additionally the reason as a string value.

  • spatial_expr: Is any valid GeoJSON Point, Polygon, or LineString object expression.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060