Functions

List of non-standard CQL2 functions supported by this API.

UPPER
  • Converts a string to uppercase.
  • Arguments:
    value: string - Input text.
  • Returns: string
LOWER
  • Converts a string to lowercase.
  • Arguments:
    value: string - Input text.
  • Returns: string
POSITION
  • Returns the row position in nested filters.
  • Arguments: None
  • Returns: integer
NOW
  • Returns the current timestamp.
  • Arguments: None
  • Returns: datetime
DIAMETER2D
  • Returns the 2D diameter of a geometry.
  • Arguments:
    geometry: geometry - Input geometry.
  • Returns: number
DIAMETER3D
  • Returns the 3D diameter of a geometry.
  • Arguments:
    geometry: geometry - Input geometry.
  • Returns: number
ALIKE
  • Checks if one of the array values matches the LIKE pattern.
  • Arguments:
    values: string - Array value expression.
    pattern: string - LIKE pattern.
  • Returns: boolean
inResultSet
  • Tests whether the value of a property, or the feature id, is contained in a named result set. Result sets are defined by other queries of the same query expression; this function can therefore only be used within a query expression, not in a standalone CQL2 filter.
  • Arguments:
    value: string - Property to test: a feature reference, a value property holding feature ids, or the feature id.
    resultSet: string - Name of the result set.
  • Returns: boolean
inResultSetByKey
  • Tests whether the composite key of a feature is contained in a named result set. The key has one member per key part, the part names are those declared by the query that defines the result set, and the value of each member is the property of this feature type that holds that part. Result sets are defined by other queries of the same query expression; this function can therefore only be used within a query expression, not in a standalone CQL2 filter, and it has no CQL2-Text encoding.
  • Arguments:
    key: string - Key of this feature type, one member per key part.
    resultSet: string - Name of the result set.
  • Returns: boolean