org.jooq.CreateIndexWhereStep Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jooq Show documentation
There is a newer version: 3.19.9
/*
 * 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.
 *
 * Other licenses:
 * -----------------------------------------------------------------------------
 * Commercial licenses for this work are available. These replace the above
 * ASL 2.0 and offer limited warranties, support, maintenance, and commercial
 * database integrations.
 *
 * For more information, please visit: http://www.jooq.org/licenses
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */
package org.jooq;

import static org.jooq.SQLDialect.POSTGRES;
// ...

import java.util.Collection;

import org.jooq.impl.DSL;

/**
 * A {@link Query} that can create indexes.
 *
 * @author Lukas Eder
 */
public interface CreateIndexWhereStep extends CreateIndexFinalStep {

    /**
     * Add a WHERE clause to create a partial index, connecting
     * them with each other with {@link Operator#AND}.
     */
    @Support({ POSTGRES })
    CreateIndexFinalStep where(Condition... conditions);

    /**
     * Add a WHERE clause to create a partial index, connecting
     * them with each other with {@link Operator#AND}.
     */
    @Support({ POSTGRES })
    CreateIndexFinalStep where(Collection conditions);

    /**
     * Add a WHERE clause to create a partial index.
     */
    @Support({ POSTGRES })
    CreateIndexFinalStep where(Field field);

    /**
     * Add a WHERE clause to create a partial index.
     * 
     * NOTE: When inserting plain SQL into jOOQ objects, you must
     * guarantee syntax integrity. You may also create the possibility of
     * malicious SQL injection. Be sure to properly use bind variables and/or
     * escape literals when concatenated into SQL clauses!
     *
     * @see DSL#condition(SQL)
     * @see SQL
     */
    @Support({ POSTGRES })
    @PlainSQL
    CreateIndexFinalStep where(SQL sql);

    /**
     * Add a WHERE clause to create a partial index.
     * 

     * NOTE: When inserting plain SQL into jOOQ objects, you must
     * guarantee syntax integrity. You may also create the possibility of
     * malicious SQL injection. Be sure to properly use bind variables and/or
     * escape literals when concatenated into SQL clauses!
     *
     * @see DSL#condition(String)
     * @see SQL
     */
    @Support({ POSTGRES })
    @PlainSQL
    CreateIndexFinalStep where(String sql);

    /**
     * Add a WHERE clause to create a partial index.
     * 

     * NOTE: When inserting plain SQL into jOOQ objects, you must
     * guarantee syntax integrity. You may also create the possibility of
     * malicious SQL injection. Be sure to properly use bind variables and/or
     * escape literals when concatenated into SQL clauses!
     *
     * @see DSL#condition(String, Object...)
     * @see DSL#sql(String, Object...)
     * @see SQL
     */
    @Support({ POSTGRES })
    @PlainSQL
    CreateIndexFinalStep where(String sql, Object... bindings);

    /**
     * Add a WHERE clause to create a partial index.
     * 
     * NOTE: When inserting plain SQL into jOOQ objects, you must
     * guarantee syntax integrity. You may also create the possibility of
     * malicious SQL injection. Be sure to properly use bind variables and/or
     * escape literals when concatenated into SQL clauses!
     *
     * @see DSL#condition(String, QueryPart...)
     * @see DSL#sql(String, QueryPart...)
     * @see SQL
     */
    @Support({ POSTGRES })
    @PlainSQL
    CreateIndexFinalStep where(String sql, QueryPart... parts);
}