com.datastax.dse.driver.api.querybuilder.schema.CreateDseAggregateStart Maven / Gradle / Ivy
/*
* Copyright DataStax, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.datastax.dse.driver.api.querybuilder.schema;
import com.datastax.oss.driver.api.core.CqlIdentifier;
import com.datastax.oss.driver.api.core.type.DataType;
import com.datastax.oss.driver.api.core.type.DataTypes;
import com.datastax.oss.driver.api.querybuilder.SchemaBuilder;
import edu.umd.cs.findbugs.annotations.NonNull;
public interface CreateDseAggregateStart {
/**
* Adds IF NOT EXISTS to the create aggregate specification. This indicates that the aggregate
* should not be created if it already exists.
*/
@NonNull
CreateDseAggregateStart ifNotExists();
/**
* Adds OR REPLACE to the create aggregate specification. This indicates that the aggregate should
* replace an existing aggregate with the same name if it exists.
*/
@NonNull
CreateDseAggregateStart orReplace();
/**
* Adds a parameter definition in the CREATE AGGREGATE statement.
*
* Parameter keys are added in the order of their declaration.
*
*
To create the data type, use the constants and static methods in {@link DataTypes}, or
* {@link SchemaBuilder#udt(CqlIdentifier, boolean)}.
*/
@NonNull
CreateDseAggregateStart withParameter(@NonNull DataType paramType);
/** Adds SFUNC to the create aggregate specification. This is the state function for each row. */
@NonNull
CreateDseAggregateStateFunc withSFunc(@NonNull CqlIdentifier sfuncName);
/** Shortcut for {@link #withSFunc(CqlIdentifier) withSFunc(CqlIdentifier.fromCql(sfuncName))}. */
@NonNull
default CreateDseAggregateStateFunc withSFunc(@NonNull String sfuncName) {
return withSFunc(CqlIdentifier.fromCql(sfuncName));
}
}