org.jooq.BatchBindStep Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jooq Show documentation
The newest version!
/*
 * 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
 *
 *  https://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
 * Apache-2.0 license and offer limited warranties, support, maintenance, and
 * commercial database integrations.
 *
 * For more information, please visit: https://www.jooq.org/legal/licensing
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */
package org.jooq;

import org.jooq.impl.DSL;

import org.jetbrains.annotations.*;


import java.sql.Statement;
import java.util.Map;

/**
 * This type is used for the {@link Batch}'s DSL API.
 * 
 * Use it to add bind values to a single operation in the batch statement.
 *
 * @author Lukas Eder
 * @see Batch
 * @see Statement#executeBatch()
 */
public interface BatchBindStep extends Batch {

    /**
     * Set indexed bind values onto the batch statement.
     * 

     * The argument array of bindValues will be set onto the
     * indexed bind values of the batch statement:
     * 

     * :1 -> bindValues[0]
     * :2 -> bindValues[1]
     * ...
     * :N -> bindValues[N - 1]
     * 
     * 
     * "Unmatched" bind values will be left unmodified:
     * 

     * :N+1 -> unmodified
     * :N+2 -> unmodified
     * 
     * Bind index order The 1-based parameter index describes a
     * parameter in rendering order, not in input order. For example,
     * if a query contains a {@link DSL#log(Field, Field)} call, where the first
     * argument is the value and the second argument is the
     * base, this may produce different dialect specific
     * renderings:
     * 
     * Db2: ln(value) / ln(base)
     * Oracle: log(base, value)
     * SQL Server: log(value, base)
     * 
     * 
     * Some bind values may even be repeated by a dialect specific emulation,
     * leading to duplication and index-shifting.
     * 

     * As such, it is usually better to supply bind values directly with the
     * input of an expression, e.g.:
     * 

     * Directly with the {@link DSL} method, such as
     * {@link DSL#log(Field, Field)}, for example.
     * With the plain SQL template constructor, e.g.
     * {@link DSL#field(String, Object...)}
     * With the parser method, e.g.
     * {@link Parser#parseField(String, Object...)}
     * 
     */
    @NotNull @CheckReturnValue
    @Support
    BatchBindStep bind(Object... bindValues);

    /**
     * Set several indexed bind values onto the batch statement.
     * 
     * This is the same as calling {@link #bind(Object...)} several times.
     */
    @NotNull @CheckReturnValue
    @Support
    BatchBindStep bind(Object[]... bindValues);

    /**
     * Set named bind values onto the batch statement.
     * 

     * The argument map of namedBindValues will be set onto the
     * named bind values of the batch statement:
     * 

     * :name1 -> bindValues.get("name1")
     * :name2 -> bindValues.get("name2")
     * ...
     * :nameN -> bindValues.get("nameN")
     * 
     * 
     * "Unmatched" bind values will be left unmodified:
     * 

     * :nameN+1 -> unmodified
     * :nameN+2 -> unmodified
     * 
     */
    @NotNull @CheckReturnValue
    @Support
    BatchBindStep bind(Map namedBindValues);

    /**
     * Set several named bind values onto the batch statement.
     * 
     * This is the same as calling {@link #bind(Map...)} several times.
     */
    @NotNull @CheckReturnValue
    @Support
    BatchBindStep bind(Map... namedBindValues);
}