Class FunctionMetadata

Describes a CQL function.

Inheritance

System.Object

FunctionMetadata

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Dse

Assembly: Dse.dll

Syntax

public class FunctionMetadata

Constructors

FunctionMetadata()

Creates a new instance of Function metadata.

Declaration

public FunctionMetadata()

FunctionMetadata(String, String, String[], String[], ColumnDesc[], String, Boolean, 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
System.String	name
System.String	keyspaceName
System.String[]	signature
System.String[]	argumentNames
ColumnDesc[]	argumentTypes
System.String	body
System.Boolean	calledOnNullInput
System.String	language
ColumnDesc	returnType

Properties

ArgumentNames

List of the function argument names.

Declaration

public string[] ArgumentNames { get; }

Property Value

Type	Description
System.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
System.String

CalledOnNullInput

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

Declaration

public bool CalledOnNullInput { get; }

Property Value

Type	Description
System.Boolean

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
System.Boolean

KeyspaceName

Name of the keyspace where the CQL function is declared.

Declaration

public string KeyspaceName { get; }

Property Value

Type	Description
System.String

Language

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

Declaration

public string Language { get; }

Property Value

Type	Description
System.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
System.Boolean

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
System.Collections.Generic.ICollection<System.String>

Name

Name of the CQL function.

Declaration

public string Name { get; }

Property Value

Type	Description
System.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
System.String[]