[#4245] Added missing type

This commit is contained in:
Lukas Eder 2020-02-07 16:57:42 +01:00
parent 175937f41a
commit 9ecb8a8caa

View File

@ -0,0 +1,166 @@
/*
* 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.POSTGRES;
import java.util.Collection;
import org.jooq.impl.DSL;
/**
* This type is used for the {@link Delete}'s DSL API.
* <p>
* Example: <code><pre>
* DSLContext create = DSL.using(configuration);
*
* create.delete(table)
* .where(field1.greaterThan(100))
* .execute();
* </pre></code>
* <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 DeleteUsingStep<R extends Record> extends DeleteWhereStep<R> {
/**
* Add a <code>USING</code> clause to the query.
*/
@Support({ POSTGRES })
DeleteWhereStep<R> using(TableLike<?> table);
/**
* Add a <code>USING</code> clause to the query.
*/
@Support({ POSTGRES })
DeleteWhereStep<R> using(TableLike<?>... tables);
/**
* Add a <code>USING</code> clause to the query.
*/
@Support({ POSTGRES })
DeleteWhereStep<R> using(Collection<? extends TableLike<?>> tables);
/**
* Add a <code>USING</code> clause to the query.
* <p>
* <b>NOTE</b>: When inserting plain SQL into jOOQ objects, you must
* guarantee syntax integrity. You may also create the possibility of
* malicious SQL injection. Be sure to properly use bind variables and/or
* escape literals when concatenated into SQL clauses!
*
* @see DSL#table(SQL)
* @see SQL
*/
@Support({ POSTGRES })
@PlainSQL
DeleteWhereStep<R> using(SQL sql);
/**
* Add a <code>USING</code> clause to the query.
* <p>
* <b>NOTE</b>: When inserting plain SQL into jOOQ objects, you must
* guarantee syntax integrity. You may also create the possibility of
* malicious SQL injection. Be sure to properly use bind variables and/or
* escape literals when concatenated into SQL clauses!
*
* @see DSL#table(String)
* @see SQL
*/
@Support({ POSTGRES })
@PlainSQL
DeleteWhereStep<R> using(String sql);
/**
* Add a <code>USING</code> clause to the query.
* <p>
* <b>NOTE</b>: When inserting plain SQL into jOOQ objects, you must
* guarantee syntax integrity. You may also create the possibility of
* malicious SQL injection. Be sure to properly use bind variables and/or
* escape literals when concatenated into SQL clauses!
*
* @see DSL#table(String, Object...)
* @see DSL#sql(String, Object...)
* @see SQL
*/
@Support({ POSTGRES })
@PlainSQL
DeleteWhereStep<R> using(String sql, Object... bindings);
/**
* Add a <code>USING</code> clause to the query.
* <p>
* <b>NOTE</b>: When inserting plain SQL into jOOQ objects, you must
* guarantee syntax integrity. You may also create the possibility of
* malicious SQL injection. Be sure to properly use bind variables and/or
* escape literals when concatenated into SQL clauses!
*
* @see DSL#table(String, QueryPart...)
* @see DSL#sql(String, QueryPart...)
* @see SQL
*/
@Support({ POSTGRES })
@PlainSQL
DeleteWhereStep<R> using(String sql, QueryPart... parts);
/**
* Add a <code>USING</code> clause to the query.
*
* @see DSL#table(Name)
*/
@Support({ POSTGRES })
DeleteWhereStep<R> using(Name name);
}