pro.foundev.cassandra.commons.migrations.MigrationRunner Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cassandra-commons-migrations Show documentation

Versioned Cassandra Schema Migrations For Sane Development

The newest version!

/*
 * Copyright 2015 Ryan Svihla
 *
 * 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 pro.foundev.cassandra.commons.migrations;

import java.io.FileNotFoundException;
import java.nio.file.Path;

/**
 * Runs migrations.
 */
public interface MigrationRunner {
    /**
     * Executes all CQL scripts found inside of the specified path. TODO: document file finding rules
     *
     * @param scriptDirectory Contains cql scripts with the following naming convention:
     *                        [version]_[version].cql version is typically a timestamp and will be applied in
     *                        ascending order.
     * @throws FileNotFoundException occurs when unable to find the scriptDirectory.
     */
    void runScriptDirectory(Path scriptDirectory) throws FileNotFoundException;

    /**
     * drops and recreates keyspace. Today it does a simplestrategy of RF 1 on recreate. Not useful for production
     */
    void resetKeyspace();
}