/*
 * 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 org.jetbrains.annotations.*;


// ...
// ...
// ...
// ...
// ...
import static org.jooq.SQLDialect.DERBY;
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;
// ...
// ...

The step in the ALTER INDEX where the table can be specified for the index.

Referencing XYZ*Step types directly from client code

It is usually not recommended to reference any XYZ*Step types directly from client code, or assign them to local variables. When writing dynamic SQL, creating a statement's components dynamically, and passing them to the DSL API statically is usually a better choice. See the manual's section about dynamic SQL for details: https://www.jooq.org/doc/latest/manual/sql-building/dynamic-sql.

Drawbacks of referencing the XYZ*Step types directly:

  • They're operating on mutable implementations (as of jOOQ 3.x)
  • They're less composable and not easy to get right when dynamic SQL gets complex
  • They're less readable
  • They might have binary incompatible changes between minor releases
Author:Lukas Eder
/** * The step in the <code>ALTER INDEX</code> where the table can be specified for * the index. * <p> * <h3>Referencing <code>XYZ*Step</code> types directly from client code</h3> * <p> * It is usually not recommended to reference any <code>XYZ*Step</code> types * directly from client code, or assign them to local variables. When writing * dynamic SQL, creating a statement's components dynamically, and passing them * to the DSL API statically is usually a better choice. See the manual's * section about dynamic SQL for details: <a href= * "https://www.jooq.org/doc/latest/manual/sql-building/dynamic-sql">https://www.jooq.org/doc/latest/manual/sql-building/dynamic-sql</a>. * <p> * Drawbacks of referencing the <code>XYZ*Step</code> types directly: * <ul> * <li>They're operating on mutable implementations (as of jOOQ 3.x)</li> * <li>They're less composable and not easy to get right when dynamic SQL gets * complex</li> * <li>They're less readable</li> * <li>They might have binary incompatible changes between minor releases</li> * </ul> * * @author Lukas Eder */
public interface AlterIndexOnStep extends AlterIndexStep {
Specify the table expression on which to alter an index.

SQLDialect.MYSQL, SQLDialect.MARIADB, and SQLDialect.SQLSERVER use table-scoped index names, not schema-scoped names. This means that in these databases, the ON clause is mandatory in order to unambiguously identify an index. In all other databases, the ON clause will simply be ignored for compatibility reasons.

/** * Specify the table expression on which to alter an index. * <p> * {@link SQLDialect#MYSQL}, {@link SQLDialect#MARIADB}, and * {@link SQLDialect#SQLSERVER} use table-scoped index names, not * schema-scoped names. This means that in these databases, the * <code>ON</code> clause is mandatory in order to unambiguously identify an * index. In all other databases, the <code>ON</code> clause will simply be * ignored for compatibility reasons. */
@NotNull @Support({ DERBY, H2, HSQLDB, MARIADB, MYSQL, POSTGRES }) AlterIndexStep on(Table<?> table);
Specify the table expression on which to alter an index.

SQLDialect.MYSQL, SQLDialect.MARIADB, and SQLDialect.SQLSERVER use table-scoped index names, not schema-scoped names. This means that in these databases, the ON clause is mandatory in order to unambiguously identify an index. In all other databases, the ON clause will simply be ignored for compatibility reasons.

/** * Specify the table expression on which to alter an index. * <p> * {@link SQLDialect#MYSQL}, {@link SQLDialect#MARIADB}, and * {@link SQLDialect#SQLSERVER} use table-scoped index names, not * schema-scoped names. This means that in these databases, the * <code>ON</code> clause is mandatory in order to unambiguously identify an * index. In all other databases, the <code>ON</code> clause will simply be * ignored for compatibility reasons. */
@NotNull @Support({ DERBY, H2, HSQLDB, MARIADB, MYSQL, POSTGRES }) AlterIndexStep on(String tableName);
Specify the table expression on which to alter an index.

SQLDialect.MYSQL, SQLDialect.MARIADB, and SQLDialect.SQLSERVER use table-scoped index names, not schema-scoped names. This means that in these databases, the ON clause is mandatory in order to unambiguously identify an index. In all other databases, the ON clause will simply be ignored for compatibility reasons.

/** * Specify the table expression on which to alter an index. * <p> * {@link SQLDialect#MYSQL}, {@link SQLDialect#MARIADB}, and * {@link SQLDialect#SQLSERVER} use table-scoped index names, not * schema-scoped names. This means that in these databases, the * <code>ON</code> clause is mandatory in order to unambiguously identify an * index. In all other databases, the <code>ON</code> clause will simply be * ignored for compatibility reasons. */
@NotNull @Support({ DERBY, H2, HSQLDB, MARIADB, MYSQL, POSTGRES }) AlterIndexStep on(Name tableName); }