com.datastax.oss.driver.api.core.metadata.schema

Interface FunctionMetadata

All Superinterfaces:

Describable

All Known Subinterfaces:

DseFunctionMetadata

public interface FunctionMetadata
extends Describable

A CQL function in the schema metadata.

Method Summary

Modifier and Type	Method and Description
default String	describe(boolean pretty) Returns a single CQL statement that creates the element.
default String	describeWithChildren(boolean pretty) Returns a CQL script that creates the element and all of its children.
String	getBody()
CqlIdentifier	getKeyspace()
String	getLanguage()
List<CqlIdentifier>	getParameterNames() The names of the parameters.
DataType	getReturnType()
FunctionSignature	getSignature()
boolean	isCalledOnNullInput()

Method Detail

getKeyspace

@NonNull
CqlIdentifier getKeyspace()

getSignature

@NonNull
FunctionSignature getSignature()

getParameterNames

@NonNull
List<CqlIdentifier> getParameterNames()

The names of the parameters. This is in the same order as getSignature().getParameterTypes()

getBody

@NonNull
String getBody()

isCalledOnNullInput

boolean isCalledOnNullInput()

getLanguage

@NonNull
String getLanguage()

getReturnType

@NonNull
DataType getReturnType()

describe

@NonNull
default String describe(boolean pretty)

Description copied from interface: Describable

Returns a single CQL statement that creates the element.

Specified by:

describe in interface Describable

Parameters:

pretty - if true, make the output more human-readable (line breaks, indents, and pretty identifiers). If false, return the statement on a single line with minimal formatting.

describeWithChildren

@NonNull
default String describeWithChildren(boolean pretty)

Description copied from interface: Describable

Returns a CQL script that creates the element and all of its children. For example: a schema with its tables, materialized views, types, etc. A table with its indices.

Specified by:

describeWithChildren in interface Describable

Parameters:

pretty - if true, make the output more human-readable (line breaks, indents, and pretty identifiers). If false, return each statement on a single line with minimal formatting.