Class: SchemaFunction

metadata~SchemaFunction()

Describes a CQL function.

Constructor

new SchemaFunction()

Creates a new SchemaFunction.

Source:

Members

argumentNames :Array.<String>

List of the function argument names.

Type:
  • Array.<String>
Source:

argumentTypes :Array.<{code, info}>

List of the function argument types.

Type:
  • Array.<{code, info}>
Source:

body :String

Body of the function.

Type:
  • String
Source:

calledOnNullInput :Boolean

Determines if the function is called when the input is null.

Type:
  • Boolean
Source:

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
Source:

keyspaceName

Name of the keyspace where the cql function is declared.

Source:

language :String

Name of the programming language, for example: java, javascript, ...

Type:
  • String
Source:

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
Source:

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:
  • Array.<String>
Source:

name :String

Name of the cql function.

Type:
  • String
Source:

returnType :Object

Type of the return value.

Type:
  • Object
Source:

signature :Array.<String>

Signature of the function.

Type:
  • Array.<String>
Source: