org.jooq.DeleteOrderByStep Maven / Gradle / Ivy
/*
* 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
* Apache-2.0 license 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 java.util.Collection;
/**
* This type is used for the {@link Delete}'s DSL API.
*
* Example:
* DSLContext create = DSL.using(configuration);
*
* create.delete(table)
* .where(field1.greaterThan(100))
* .execute();
*
*
*
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
*/
public interface DeleteOrderByStep extends DeleteLimitStep {
/**
* Add an ORDER BY clause to the query.
*/
@NotNull @CheckReturnValue
@Support
DeleteLimitStep orderBy(OrderField... fields);
/**
* Add an ORDER BY clause to the query.
*/
@NotNull @CheckReturnValue
@Support
DeleteLimitStep orderBy(Collection> fields);
/**
* Add an ORDER BY clause to the query.
*
* Indexes start at 1 in SQL!
*
* Note, you can use orderBy(DSL.val(1).desc()) or
* orderBy(DSL.literal(1).desc()) to apply descending
* ordering
*/
@NotNull @CheckReturnValue
@Support
DeleteLimitStep orderBy(int... fieldIndexes);
}