org.jooq.AlterTableStep Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hello-world-plugin Show documentation
Kill Bill Hello World plugin
The newest version!
/*
 * Copyright (c) 2009-2016, Data Geekery GmbH (http://www.datageekery.com)
 * All rights reserved.
 *
 * 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.
 *
 * Other licenses:
 * -----------------------------------------------------------------------------
 * Commercial licenses for this work are available. These replace the above
 * ASL 2.0 and offer limited warranties, support, maintenance, and commercial
 * database integrations.
 *
 * For more information, please visit: http://www.jooq.org/licenses
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */
package org.jooq;

// ...
// ...
import static org.jooq.SQLDialect.CUBRID;
// ...
import static org.jooq.SQLDialect.DERBY;
import static org.jooq.SQLDialect.FIREBIRD;
import static org.jooq.SQLDialect.H2;
// ...
import static org.jooq.SQLDialect.HSQLDB;
// ...
// ...
import static org.jooq.SQLDialect.MARIADB;
import static org.jooq.SQLDialect.MYSQL;
// ...
import static org.jooq.SQLDialect.POSTGRES;
// ...
// ...
// ...
// ...

import org.jooq.impl.DSL;


/**
 * The step in the ALTER TABLE statement where the action can be
 * decided.
 *
 * @author Lukas Eder
 */
public interface AlterTableStep {

    /**
     * Add a RENAME TO clause to the ALTER TABLE
     * statement.
     */
    @Support
    AlterTableFinalStep renameTo(Table newName);

    /**
     * Add a RENAME TO clause to the ALTER TABLE
     * statement.
     */
    @Support
    AlterTableFinalStep renameTo(Name newName);

    /**
     * Add a RENAME TO clause to the ALTER TABLE
     * statement.
     */
    @Support
    AlterTableFinalStep renameTo(String newName);

    /**
     * Add a RENAME COLUMN clause to the ALTER TABLE
     * statement.
     */
    @Support
    AlterTableRenameColumnToStep renameColumn(Field oldName);

    /**
     * Add a RENAME COLUMN clause to the ALTER TABLE
     * statement.
     */
    @Support
    AlterTableRenameColumnToStep renameColumn(Name oldName);

    /**
     * Add a RENAME COLUMN clause to the ALTER TABLE
     * statement.
     */
    @Support
    AlterTableRenameColumnToStep renameColumn(String oldName);

    /**
     * Add a RENAME CONSTRAINT clause to the ALTER TABLE
     * statement.
     */
    @Support
    AlterTableRenameConstraintToStep renameConstraint(Constraint oldName);

    /**
     * Add a RENAME CONSTRAINT clause to the ALTER TABLE
     * statement.
     */
    @Support
    AlterTableRenameConstraintToStep renameConstraint(Name oldName);

    /**
     * Add a RENAME CONSTRAINT clause to the ALTER TABLE
     * statement.
     */
    @Support
    AlterTableRenameConstraintToStep renameConstraint(String oldName);

    /**
     * Add an ALTER COLUMN clause to the ALTER TABLE
     * statement.
     * 
     * This is an alias for {@link #alterColumn(Field)}.
     */
    @Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES })
     AlterTableAlterStep alter(Field field);

    /**
     * Add an ALTER COLUMN clause to the ALTER TABLE
     * statement.
     * 

     * This is an alias for {@link #alterColumn(Name)}
     */
    @Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES })
    AlterTableAlterStep