diff --git a/jOOQ/src/main/java/org/jooq/DeleteUsingStep.java b/jOOQ/src/main/java/org/jooq/DeleteUsingStep.java new file mode 100644 index 0000000000..85e6b1b387 --- /dev/null +++ b/jOOQ/src/main/java/org/jooq/DeleteUsingStep.java @@ -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. + *

+ * 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: + *

+ * + * @author Lukas Eder + */ +public interface DeleteUsingStep extends DeleteWhereStep { + + /** + * Add a USING clause to the query. + */ + @Support({ POSTGRES }) + DeleteWhereStep using(TableLike table); + + /** + * Add a USING clause to the query. + */ + @Support({ POSTGRES }) + DeleteWhereStep using(TableLike... tables); + + /** + * Add a USING clause to the query. + */ + @Support({ POSTGRES }) + DeleteWhereStep using(Collection> tables); + + /** + * Add a USING clause to the query. + *

+ * NOTE: 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 using(SQL sql); + + /** + * Add a USING clause to the query. + *

+ * NOTE: 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 using(String sql); + + /** + * Add a USING clause to the query. + *

+ * NOTE: 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 using(String sql, Object... bindings); + + /** + * Add a USING clause to the query. + *

+ * NOTE: 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 using(String sql, QueryPart... parts); + + /** + * Add a USING clause to the query. + * + * @see DSL#table(Name) + */ + @Support({ POSTGRES }) + DeleteWhereStep using(Name name); +}