buckelieg.fn.db.Script Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of db-fn Show documentation
Functional style programming with plain JDBC
There is a newer version: 0.3.10
/*
 * Copyright 2016- Anatoly Kutyakov
 *
 * 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 buckelieg.fn.db;

import javax.annotation.Nonnull;
import javax.annotation.ParametersAreNonnullByDefault;
import java.io.PrintStream;
import java.sql.SQLException;
import java.util.Objects;
import java.util.Optional;
import java.util.function.Consumer;
import java.util.function.Supplier;

/**
 * An abstraction for SQL scripts.
 * Script is treated as a series of separate SQL statements which are executed sequentially.
 * Result is an execution time (in milliseconds) taken the script to complete.
 */
@SuppressWarnings("unchecked")
@ParametersAreNonnullByDefault
public interface Script extends Query {

    /**
     * {@inheritDoc}
     */
    @Nonnull
    @Override
    Script timeout(int timeout);

    /**
     * {@inheritDoc}
     */
    @Nonnull
    @Override
    default Script poolable(boolean poolable) {
        throw new UnsupportedOperationException("Not applicable");
    }

    /**
     * {@inheritDoc}
     */
    @Nonnull
    @Override
    Script escaped(boolean escapeProcessing);

    /**
     * Set escape processing for this query.
     *
     * @param supplier escaped processing value supplier
     * @return script query abstraction
     * @throws NullPointerException if supplier is null
     * @see #escaped(boolean)
     */
    @Nonnull
    default Script escaped(Supplier supplier) {
        return escaped(Optional.ofNullable(Objects.requireNonNull(supplier, "Value supplier must be provided").get()).orElse(true));
    }

    /**
     * Prints this query string (as SQL) to provided logger.
     *
     * @param printer query string consumer
     * @return script query abstraction
     */
    @Nonnull
    Script print(Consumer printer);

    /**
     * Prints this query string (as SQL) to standard output.
     *
     * @return script query abstraction
     * @see System#out
     * @see PrintStream#println
     */
    @Nonnull
    default Script print() {
        return print(System.out::println);
    }

    /**
     * Sets flag whether to skip errors during script execution.
     * If flag is set to false then script execution is halt on the first error occurred.
     *
     * @param skipErrors false if to stop on the first error, true - otherwise
     * @return script query abstraction
     */
    @Nonnull
    Script skipErrors(boolean skipErrors);

    /**
     * Set escape processing for this query.
     *
     * @param supplier escaped processing value supplier
     * @return script query abstraction
     * @throws NullPointerException if supplier is null
     * @see #skipErrors(boolean)
     */
    @Nonnull
    default Script skipErrors(Supplier supplier) {
        return skipErrors(Optional.ofNullable(Objects.requireNonNull(supplier, "Value supplier must be provided").get()).orElse(false));
    }

    /**
     * Sets flag whether to stkip on warnings or not.
     * Default is true
     *
     * @param skipWarnings true if to skip warning, false - otherwise.
     * @return script query abstraction
     */
    @Nonnull
    Script skipWarnings(boolean skipWarnings);


    /**
     * Sets flag whether to skip warnings or not.
     *
     * @param supplier escaped processing value supplier
     * @return script query abstraction
     * @throws NullPointerException if supplier is null
     * @see #skipWarnings(boolean)
     */
    @Nonnull
    default Script skipWarnings(Supplier supplier) {
        return skipWarnings(Optional.ofNullable(Objects.requireNonNull(supplier, "Value supplier must be provided").get()).orElse(false));
    }

    /**
     * Registers error or warning handler.
     * The default handler is noop handler. I.e. if skipErrors or skipWarnings flag is set to false
     * but no errorHandler is provided the default handler (which does nothing) is used.
     *
     * @param handler error/warning handler.
     * @return script query abstraction
     * @throws NullPointerException if handler is null
     * @see #skipErrors(boolean)
     * @see #skipWarnings(boolean)
     */
    @Nonnull
    Script errorHandler(Consumer handler);

}