com.github.helenusdriver.driver.CreateTable Maven / Gradle / Ivy
Show all versions of api Show documentation
/*
* Copyright (C) 2015-2015 The Helenus Driver Project Authors.
*
* 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.github.helenusdriver.driver;
/**
* The CreateTable interface provides support for the
* CREATE TABLE statement for a POJO.
*
* @copyright 2015-2015 The Helenus Driver Project Authors
*
* @author The Helenus Driver Project Authors
* @version 1 - Jan 15, 2015 - paouelle - Creation
*
* @param The type of POJO associated with this statement.
*
* @since 1.0
*/
public interface CreateTable
extends Statement, SequenceableStatement {
/**
* {@inheritDoc}
*
* Note: This might not actually be a valid query string if there are
* more than one tables defined in the POJO that needs to be created. It will
* then be a representation of the query strings for each table creation
* similar to a "BATCH" statement.
*
* @author paouelle
*
* @see com.github.helenusdriver.driver.GenericStatement#getQueryString()
*/
@Override
public String getQueryString();
/**
* Sets the 'IF NOT EXISTS' option for this CREATE TABLE statement.
*
* A create with that option will not succeed unless the table does not exist
* at the time the creation is executing. The existence check and creations
* are done transactionally in the sense that if multiple clients attempt to
* create a given table with this option, then at most one may succeed.
*
* Please keep in mind that using this option has a non negligible performance
* impact and should be avoided when possible.
*
* @author paouelle
*
* @return this CREATE TABLE statement.
*/
public CreateTable ifNotExists();
/**
* Adds a WITH option to this statement.
*
* This is a shorter/more readable version for {@code with().and(option)}.
*
* @author paouelle
*
* @param option the option to add
* @return the WITH options of this statement to which more options can be
* added
* @throws NullPointerException if option is null
*/
public Options with(TableWith option);
/**
* Returns a WITH option for this statement.
*
* @author paouelle
*
* @return the WITH options of this statement to which more options can be
* added
*/
public Options with();
/**
* Adds a WHERE clause to this statement used to specify suffixes when required.
*
* This is a shorter/more readable version for {@code where().and(clauses)}.
*
* @author paouelle
*
* @param clause the clause to add
* @return the where clause of this query to which more clause can be added.
* @throws IllegalArgumentException if the clause doesn't reference a
* suffix key defined in the POJO
*/
public Where where(Clause clause);
/**
* Returns a WHERE in-construct for this statement without adding clause.
*
* @author paouelle
*
* @return the where clause of this query to which more clause can be added.
*/
public Where where();
/**
* The Options class defines an in-statement construct for
* CREATE TABLE options.
*
* @copyright 2015-2015 The Helenus Driver Project Authors
*
* @author The Helenus Driver Project Authors
* @version 1 - Jan 15, 2015 - paouelle - Creation
*
* @param The type of POJO associated with this statement.
*
* @since 1.0
*/
public interface Options
extends Statement, SequenceableStatement {
/**
* Adds a WITH option to this statement.
*
* @author paouelle
*
* @param option the option to add
* @return this WITH options
* @throws NullPointerException if option is null
*/
public Options and(TableWith option);
/**
* Adds a WHERE clause to this statement used to specify suffixes when required.
*
* This is a shorter/more readable version for {@code where().and(clauses)}.
*
* @author paouelle
*
* @param clause the clause to add
* @return the where clause of this query to which more clause can be added.
* @throws IllegalArgumentException if the clause doesn't reference a
* suffix key defined in the POJO
*/
public Where where(Clause clause);
/**
* Returns a WHERE in-construct for this statement without adding clause.
*
* @author paouelle
*
* @return the where clause of this query to which more clause can be added.
*/
public Where where();
}
/**
* The Where interface defines a WHERE clause for the CREATE
* TABLE statement which can be used to specify suffix keys used for the
* keyspace name.
*
* @copyright 2015-2015 The Helenus Driver Project Authors
*
* @author The Helenus Driver Project Authors
* @version 1 - Jan 15, 2015 - paouelle - Creation
*
* @param The type of POJO associated with the statement.
*
* @since 1.0
*/
public interface Where
extends Statement, SequenceableStatement {
/**
* Adds the provided clause to this WHERE clause.
*
* @author paouelle
*
* @param clause the clause to add.
* @return this WHERE clause.
* @throws NullPointerException if clause is null
* @throws IllegalArgumentException if the clause doesn't reference a
* suffix key defined in the POJO
*/
public Where and(Clause clause);
}
}