Was this page helpful?
SchemaFunction¶
metadata~SchemaFunction()
Describes a CQL function.
Constructor¶
Members¶
argumentNames :Array:.<String:>
List of the function argument names.
Type:
argumentTypes :Array:.<{code:, info:}>
List of the function argument types.
Type:
body :String
Body of the function.
Type:
- String
calledOnNullInput :Boolean
Determines if the function is called when the input is null.
Type:
- Boolean
deterministic :Boolean
Indicates whether or not this function is deterministic. This means that given a particular input, the function will always produce the same output.
Type:
- Boolean
keyspaceName
Name of the keyspace where the cql function is declared.
language :String
Name of the programming language, for example: java, javascript, ...
Type:
- String
monotonic :Boolean
Indicates whether or not this function is monotonic on all of its arguments. This means that it is either entirely non-increasing or non-decreasing. Even if the function is not monotonic on all of its arguments, it's possible to specify that it is monotonic on one of its arguments, meaning that partial applications of the function over that argument will be monotonic.
Monotonicity is required to use the function in a GROUP BY clause.
Type:
- Boolean
monotonicOn :Array:.<String:>
The argument names that the function is monotonic on.
If monotonic is true, this will return all argument names. Otherwise, this will return either one argument or an empty array.
Type:
name :String
Name of the cql function.
Type:
- String
returnType :Object
Type of the return value.
Type:
- Object
signature :Array:.<String:>
Signature of the function.