com.datastax.oss.driver.api.querybuilder.schema

Interface CreateFunctionStart

public interface CreateFunctionStart

Method Summary

Modifier and Type	Method and Description
CreateFunctionWithNullOption	calledOnNull() Adds CALLED ON NULL to the create function specification.
CreateFunctionStart	ifNotExists() Adds IF NOT EXISTS to the create function specification.
CreateFunctionStart	orReplace() Adds OR REPLACE to the create function specification.
CreateFunctionWithNullOption	returnsNullOnNull() Adds RETURNS NULL ON NULL to the create function specification.
CreateFunctionStart	withParameter(CqlIdentifier paramName, DataType paramType) Adds a parameter definition in the CREATE FUNCTION statement.
default CreateFunctionStart	withParameter(String paramName, DataType paramType) Shortcut for withParameter(CqlIdentifier.asCql(paramName), dataType).

Method Detail

ifNotExists

@NonNull
CreateFunctionStart ifNotExists()

Adds IF NOT EXISTS to the create function specification. This indicates that the function should not be created if it already exists.

orReplace

@NonNull
CreateFunctionStart orReplace()

Adds OR REPLACE to the create function specification. This indicates that the function should replace an existing function with the same name if it exists.

withParameter

@NonNull
CreateFunctionStart withParameter(@NonNull
                                           CqlIdentifier paramName,
                                           @NonNull
                                           DataType paramType)

Adds a parameter definition in the CREATE FUNCTION statement.

Parameter keys are added in the order of their declaration.

To create the data type, use the constants and static methods in DataTypes, or SchemaBuilder.udt(CqlIdentifier, boolean).

withParameter

@NonNull
default CreateFunctionStart withParameter(@NonNull
                                                   String paramName,
                                                   @NonNull
                                                   DataType paramType)

Shortcut for withParameter(CqlIdentifier.asCql(paramName), dataType).

returnsNullOnNull

@NonNull
CreateFunctionWithNullOption returnsNullOnNull()

Adds RETURNS NULL ON NULL to the create function specification. This indicates that the body of the function should be skipped when null input is provided.

calledOnNull

@NonNull
CreateFunctionWithNullOption calledOnNull()

Adds CALLED ON NULL to the create function specification. This indicates that the body of the function not be skipped when null input is provided.