Class FunctionMetadata

Describes a CQL function.

Inheritance
object
FunctionMetadata
Inherited Members
Namespace: Cassandra
Assembly: Cassandra.dll
Syntax
public class FunctionMetadata

Constructors

FunctionMetadata()

Creates a new instance of Function metadata.

Declaration
public FunctionMetadata()

FunctionMetadata(string, string, string[], string[], ColumnDesc[], string, bool, string, ColumnDesc)

Creates a new instance of Function metadata.

Declaration
public FunctionMetadata(string name, string keyspaceName, string[] signature, string[] argumentNames, ColumnDesc[] argumentTypes, string body, bool calledOnNullInput, string language, ColumnDesc returnType)
Parameters
Type Name Description
string name
string keyspaceName
string[] signature
string[] argumentNames
ColumnDesc[] argumentTypes
string body
bool calledOnNullInput
string language
ColumnDesc returnType

Properties

ArgumentNames

List of the function argument names.

Declaration
public string[] ArgumentNames { get; }
Property Value
Type Description
string[]

ArgumentTypes

List of the function argument types.

Declaration
public ColumnDesc[] ArgumentTypes { get; }
Property Value
Type Description
ColumnDesc[]

Body

Body of the function.

Declaration
public string Body { get; }
Property Value
Type Description
string

CalledOnNullInput

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

Declaration
public bool CalledOnNullInput { get; }
Property Value
Type Description
bool

Deterministic

Indicates whether or not this function is deterministic. This means that given a particular input, the function will always produce the same output.

Declaration
public bool Deterministic { get; }
Property Value
Type Description
bool

KeyspaceName

Name of the keyspace where the CQL function is declared.

Declaration
public string KeyspaceName { get; }
Property Value
Type Description
string

Language

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

Declaration
public string Language { get; }
Property Value
Type Description
string

Monotonic

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.

Declaration
public bool Monotonic { get; }
Property Value
Type Description
bool
Remarks

Monotonicity is required to use the function in a GROUP BY clause.

MonotonicOn

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 collection.

Declaration
public ICollection<string> MonotonicOn { get; }
Property Value
Type Description
ICollection<string>

Name

Name of the CQL function.

Declaration
public string Name { get; }
Property Value
Type Description
string

ReturnType

Type of the return value.

Declaration
public ColumnDesc ReturnType { get; }
Property Value
Type Description
ColumnDesc

Signature

Signature of the function.

Declaration
public string[] Signature { get; }
Property Value
Type Description
string[]