migratedb.v1.core.api.MigrationInfoService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of migratedb-core Show documentation
The newest version!
/*
 * Copyright (C) Red Gate Software Ltd 2010-2021
 * Copyright 2022-2024 The MigrateDB contributors
 *
 * 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 migratedb.v1.core.api;

/**
 * Info about all migrations, including applied, current and pending with details and status.
 */
public interface MigrationInfoService extends InfoOutputProvider {
    /**
     * @return The full set of info about applied, current and future migrations. An empty array if none.
     */
    MigrationInfo[] all();

    /**
     * @return Information about the current applied migration or {@code null} if no migrations have been applied yet.
     */
    MigrationInfo current();

    /**
     * @return The next pending migration or {@code null} if no migration is pending. This will be the first outdated
     * repeatable migration if no pending versioned migration exists.
     */
    MigrationInfo next();

    /**
     * @return All pending migrations, available locally, but not yet applied to the DB, ordered by version. An empty
     * array if none.
     */
    MigrationInfo[] pending();

    /**
     * @return All applied migrations. An empty array if none.
     */
    MigrationInfo[] applied();

    /**
     * @return All resolved migrations. An empty array if none.
     */
    MigrationInfo[] resolved();

    /**
     * @return The failed migrations. An empty array if none.
     */
    MigrationInfo[] failed();

    /**
     * @return The future migrations. An empty array if none.
     */
    MigrationInfo[] future();

    /**
     * @return The out of order migrations. An empty array if none.
     */
    MigrationInfo[] outOfOrder();

    /**
     * @return All outdated repeatable migrations. An empty array if none.
     */
    MigrationInfo[] outdated();
}