/*
 * 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 java.util.Collection;
import java.util.List;

import org.jooq.conf.Settings;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.ApiStatus.Experimental;

/**
 * A version ID attached to a {@link Meta} description of a database.
 * <p>
 * Unlike a {@link Commit}, which describes a <em>change</em> between two
 * versions of a database, this type just describes the version itself, not how
 * to get to the version.
 * <p>
 * While it is possible to describe a path between versions using a migration
 * (e.g. composed of {@link Queries}), the versions themselves do not expose
 * this information.
 * <p>
 * This is EXPERIMENTAL functionality and subject to change in future jOOQ
 * versions.
 *
 * @author Lukas Eder
 */
@Experimental
public interface Version extends Node<Version> {

    /**
     * The version's {@link Meta} representation of the database.
     */
    @NotNull
    Meta meta();

    /**
     * Produce a migration to a new version.
     * <p>
     * In jOOQ's commercial distributions, this method allows for migrating
     * between versions in any direction, regardless of which version was
     * "first" in a version graph, or if the two versions are on different
     * branches. The resulting queries are potentially destructive in such a
     * case. Such destructive queries ("UNDO" migrations) are prevented by
     * default, and can be turned on using
     * {@link Settings#isMigrationAllowsUndo()}.
     * <p>
     * In jOOQ's Open Source Edition, this method only allows for migrating
     * "forward".
     */
    @NotNull
    Queries migrateTo(Version version);

    /**
     * Commit a new {@link Meta} representation to the version graph.
     * <p>
     * This calculates a migration path using {@link Meta#migrateTo(Meta)}.
     */
    @NotNull
    Version commit(String id, Meta meta);

    /**
     * Commit a new {@link Meta} representation to the version graph.
     *
     * @see #commit(String, Meta)
     */
    @NotNull
    Version commit(String id, String... meta);

    /**
     * Commit a new {@link Meta} representation to the version graph.
     *
     * @see #commit(String, Meta)
     */
    @NotNull
    Version commit(String id, Source... meta);

    /**
     * Merge versions.
     */
    @NotNull
    Version merge(String id, Version with);

    /**
     * Apply a migration to produce a new version.
     */
    @NotNull
    Version apply(String id, Queries migration);

    /**
     * Apply a migration to produce a new version.
     *
     * @see #apply(String, Queries)
     */
    @NotNull
    Version apply(String id, Query... migration);

    /**
     * Apply a migration to produce a new version.
     *
     * @see #apply(String, Queries)
     */
    @NotNull
    Version apply(String id, Collection<? extends Query> migration);

    /**
     * Apply a migration to produce a new version.
     *
     * @see #apply(String, Queries)
     */
    @NotNull
    Version apply(String id, String migration);
}
