All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.jooq.impl.AbstractRoutine Maven / Gradle / Ivy

There is a newer version: 3.19.11
Show 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.impl;

import static java.lang.Boolean.TRUE;
import static org.jooq.Clause.FIELD;
import static org.jooq.Clause.FIELD_FUNCTION;
import static org.jooq.SQLDialect.FIREBIRD;
// ...
import static org.jooq.SQLDialect.POSTGRES;
// ...
import static org.jooq.impl.DSL.field;
import static org.jooq.impl.DSL.function;
import static org.jooq.impl.DSL.name;
import static org.jooq.impl.DSL.table;
import static org.jooq.impl.DSL.using;
import static org.jooq.impl.DSL.val;
import static org.jooq.impl.Tools.consumeExceptions;
import static org.jooq.impl.Tools.settings;

import java.sql.CallableStatement;
import java.sql.Connection;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.jooq.AggregateFunction;
// ...
import org.jooq.AttachableInternal;
import org.jooq.BindContext;
import org.jooq.Binding;
import org.jooq.Clause;
import org.jooq.Configuration;
import org.jooq.Context;
import org.jooq.Converter;
import org.jooq.DSLContext;
import org.jooq.DataType;
import org.jooq.ExecuteContext;
import org.jooq.ExecuteListener;
import org.jooq.Field;
import org.jooq.Package;
import org.jooq.Parameter;
import org.jooq.Record;
import org.jooq.RenderContext;
import org.jooq.Result;
import org.jooq.Results;
import org.jooq.Routine;
import org.jooq.SQLDialect;
import org.jooq.Schema;
import org.jooq.UDTField;
import org.jooq.UDTRecord;
import org.jooq.exception.ControlFlowSignal;
import org.jooq.exception.MappingException;
import org.jooq.tools.Convert;

/**
 * A common base class for stored procedures
 * 

* This type is for JOOQ INTERNAL USE only. Do not reference directly * * @author Lukas Eder */ public abstract class AbstractRoutine extends AbstractQueryPart implements Routine, AttachableInternal { /** * Generated UID */ private static final long serialVersionUID = 6330037113167106443L; private static final Clause[] CLAUSES = { FIELD, FIELD_FUNCTION }; // ------------------------------------------------------------------------ // Meta-data attributes (the same for every call) // ------------------------------------------------------------------------ private final Schema schema; private final Package pkg; private final String name; private final List> allParameters; private final List> inParameters; private final List> outParameters; private final DataType type; private Parameter returnParameter; private ResultsImpl results; private boolean overloaded; private boolean hasUnnamedParameters; // ------------------------------------------------------------------------ // Call-data attributes (call-specific) // ------------------------------------------------------------------------ private final Map, Field> inValues; private final Set> inValuesDefaulted; private final Set> inValuesNonDefaulted; private transient Field function; private Configuration configuration; private final Map, Object> outValues; private final Map, Integer> resultIndexes; // ------------------------------------------------------------------------ // Constructors // ------------------------------------------------------------------------ protected AbstractRoutine(String name, Schema schema) { this(name, schema, null, null, null, null); } protected AbstractRoutine(String name, Schema schema, Package pkg) { this(name, schema, pkg, null, null, null); } protected AbstractRoutine(String name, Schema schema, DataType type) { this(name, schema, null, type, null, null); } protected AbstractRoutine(String name, Schema schema, DataType type, Converter converter) { this(name, schema, null, type, converter, null); } protected AbstractRoutine(String name, Schema schema, DataType type, Binding binding) { this(name, schema, null, type, null, binding); } protected AbstractRoutine(String name, Schema schema, DataType type, Converter converter, Binding binding) { this(name, schema, null, type, converter, binding); } protected AbstractRoutine(String name, Schema schema, Package pkg, DataType type) { this(name, schema, pkg, type, null, null); } protected AbstractRoutine(String name, Schema schema, Package pkg, DataType type, Converter converter) { this(name, schema, pkg, type, converter, null); } protected AbstractRoutine(String name, Schema schema, Package pkg, DataType type, Binding binding) { this(name, schema, pkg, type, null, binding); } @SuppressWarnings({ "unchecked", "rawtypes" }) protected AbstractRoutine(String name, Schema schema, Package pkg, DataType type, Converter converter, Binding binding) { this.resultIndexes = new HashMap, Integer>(); this.schema = schema; this.pkg = pkg; this.name = name; this.allParameters = new ArrayList>(); this.inParameters = new ArrayList>(); this.outParameters = new ArrayList>(); this.results = new ResultsImpl(null); this.inValues = new HashMap, Field>(); this.inValuesDefaulted = new HashSet>(); this.inValuesNonDefaulted = new HashSet>(); this.outValues = new HashMap, Object>(); this.type = converter == null && binding == null ? (DataType) type : type.asConvertedDataType(DefaultBinding.newBinding((Converter) converter, type, binding)); } // ------------------------------------------------------------------------ // Initialise a routine call // ------------------------------------------------------------------------ protected final void setNumber(Parameter parameter, Number value) { setValue(parameter, Convert.convert(value, parameter.getType())); } protected final void setNumber(Parameter parameter, Field value) { setField(parameter, value); } @Override public final void setValue(Parameter parameter, Z value) { set(parameter, value); } @Override public final void set(Parameter parameter, Z value) { setField(parameter, val(value, parameter.getDataType())); } /* * #326 - Avoid overloading setValue() */ protected final void setField(Parameter parameter, Field value) { // Be sure null is correctly represented as a null field if (value == null) { setField(parameter, val(null, parameter.getDataType())); } // [#1183] [#3533] Add the field to the in-values and mark them as non-defaulted else { inValues.put(parameter, value); inValuesDefaulted.remove(parameter); inValuesNonDefaulted.add(parameter); } } // ------------------------------------------------------------------------ // Call the routine // ------------------------------------------------------------------------ @Override public final void attach(Configuration c) { configuration = c; } @Override public final void detach() { attach(null); } @Override public final Configuration configuration() { return configuration; } @Override public final int execute(Configuration c) { // Ensure that all depending Attachables are attached Configuration previous = configuration(); try { attach(c); return execute(); } finally { attach(previous); } } @Override public final int execute() { SQLDialect family = configuration.family(); results.clear(); outValues.clear(); // [#4254] In PostgreSQL, there are only functions, no procedures. Some // functions cannot be called using a CallableStatement, e.g. those with // DEFAULT parameters if (family == POSTGRES) { return executeSelectFromPOSTGRES(); } // Procedures (no return value) are always executed as CallableStatement else if (type == null) { return executeCallableStatement(); } else { switch (family) { // [#852] Some RDBMS don't allow for using JDBC procedure escape // syntax for functions. Select functions from DUAL instead case HSQLDB: // [#692] HSQLDB cannot SELECT f() FROM [...] when f() // returns a cursor. Instead, SELECT * FROM table(f()) works if (SQLDataType.RESULT.equals(type.getSQLDataType())) { return executeSelectFromHSQLDB(); } // Fall through else { } case H2: return executeSelect(); // [#773] If JDBC escape syntax is available for functions, use // it to prevent transactional issues when functions issue // DML statements default: return executeCallableStatement(); } } } private final int executeSelectFromHSQLDB() { DSLContext create = create(configuration); Result result = create.selectFrom(table(asField())).fetch(); outValues.put(returnParameter, result); return 0; } private final int executeSelectFromPOSTGRES() { DSLContext create = create(configuration); List> fields = new ArrayList>(); if (returnParameter != null) fields.add(DSL.field(DSL.name(getName()), returnParameter.getDataType())); for (Parameter p : outParameters) fields.add(DSL.field(DSL.name(p.getName()), p.getDataType())); Result result = create.select(fields).from("{0}", asField()).fetch(); int i = 0; if (returnParameter != null) outValues.put(returnParameter, returnParameter.getDataType().convert(result.getValue(0, i++))); for (Parameter p : outParameters) outValues.put(p, p.getDataType().convert(result.getValue(0, i++))); return 0; } private final int executeSelect() { final Field field = asField(); outValues.put(returnParameter, create(configuration).select(field).fetchOne(field)); return 0; } private final int executeCallableStatement() { ExecuteContext ctx = new DefaultExecuteContext(configuration, this); ExecuteListener listener = new ExecuteListeners(ctx); try { Connection connection = ctx.connection(); listener.renderStart(ctx); // [#1520] TODO: Should the number of bind values be checked, here? ctx.sql(create(configuration).render(this)); listener.renderEnd(ctx); listener.prepareStart(ctx); ctx.statement(connection.prepareCall(ctx.sql())); // [#1856] TODO: Add Statement flags like timeout here listener.prepareEnd(ctx); listener.bindStart(ctx); using(configuration).bindContext(ctx.statement()).visit(this); registerOutParameters(ctx); listener.bindEnd(ctx); execute0(ctx, listener); // [#2925] Jaybird currently doesn't like fetching OUT parameters and consuming ResultSets // http://tracker.firebirdsql.org/browse/JDBC-350 if (ctx.family() != FIREBIRD) Tools.consumeResultSets(ctx, listener, results, null); listener.outStart(ctx); fetchOutParameters(ctx); listener.outEnd(ctx); return 0; } // [#3427] ControlFlowSignals must not be passed on to ExecuteListners catch (ControlFlowSignal e) { throw e; } catch (RuntimeException e) { ctx.exception(e); listener.exception(ctx); throw ctx.exception(); } catch (SQLException e) { ctx.sqlException(e); listener.exception(ctx); throw ctx.exception(); } finally { Tools.safeClose(listener, ctx); } } private final void execute0(ExecuteContext ctx, ExecuteListener listener) throws SQLException { try { listener.executeStart(ctx); if (ctx.statement().execute()) ctx.resultSet(ctx.statement().getResultSet()); listener.executeEnd(ctx); } // [#3011] [#3054] Consume additional exceptions if there are any catch (SQLException e) { consumeExceptions(ctx.configuration(), ctx.statement(), e); throw e; } } @Override public final Clause[] clauses(Context ctx) { return CLAUSES; } @Override public void accept(Context ctx) { if (ctx instanceof RenderContext) toSQL0((RenderContext) ctx); else bind0((BindContext) ctx); } final void bind0(BindContext context) { for (Parameter parameter : getParameters()) { // [#1183] [#3533] Skip defaulted parameters if (getInParameters().contains(parameter) && inValuesDefaulted.contains(parameter)) continue; bind1(context, parameter, getInValues().get(parameter) != null, resultParameter(parameter)); } } private final void bind1(BindContext context, Parameter parameter, boolean bindAsIn, boolean bindAsOut) { int index = context.peekIndex(); if (bindAsOut) resultIndexes.put(parameter, index); if (bindAsIn) { context.visit(getInValues().get(parameter)); // [#391] This happens when null literals are used as IN/OUT // parameters. They're not bound as in value, but they need to // be registered as OUT parameter if (index == context.peekIndex() && bindAsOut) context.nextIndex(); } // Skip one index for OUT parameters else { context.nextIndex(); } } final void toSQL0(RenderContext context) { toSQLDeclare(context); toSQLBegin(context); if (getReturnParameter() != null) toSQLAssign(context); toSQLCall(context); context.sql('('); String separator = ""; List> parameters = getParameters(); for (int i = 0; i < parameters.size(); i++) { Parameter parameter = parameters.get(i); // The return value has already been written if (parameter.equals(getReturnParameter())) continue; // OUT and IN OUT parameters are always written as a '?' bind variable if (getOutParameters().contains(parameter)) { context.sql(separator); toSQLOutParam(context, parameter, i); } // [#1183] [#3533] Omit defaulted parameters else if (inValuesDefaulted.contains(parameter)) { continue; } // IN parameters are rendered normally else { context.sql(separator); toSQLInParam(context, parameter, i, getInValues().get(parameter)); } separator = ", "; } context.sql(')'); toSQLEnd(context); } private final void toSQLEnd(RenderContext context) { { context.sql(" }"); } } private final void toSQLDeclare(RenderContext context) { } private final void toSQLBegin(RenderContext context) { { context.sql("{ "); } } private final void toSQLAssign(RenderContext context) { { context.sql("? = "); } } private final void toSQLCall(RenderContext context) { { context.sql("call "); } toSQLQualifiedName(context); } private final void toSQLOutParam(RenderContext context, Parameter parameter, int index) { context.sql('?'); } private final void toSQLInParam(RenderContext context, Parameter parameter, int index, Field value) { context.visit(value); } private final void toSQLQualifiedName(RenderContext context) { Schema mappedSchema = Tools.getMappedSchema(context.configuration(), getSchema()); if (context.qualify()) { if (mappedSchema != null) { context.visit(mappedSchema); context.sql('.'); } if (getPackage() != null) { context.visit(DSL.name(getPackage().getName())); context.sql('.'); } } context.literal(getName()); } private final void fetchOutParameters(ExecuteContext ctx) throws SQLException { for (Parameter parameter : getParameters()) if (resultParameter(parameter)) fetchOutParameter(ctx, parameter); } private final void fetchOutParameter(ExecuteContext ctx, Parameter parameter) throws SQLException { DefaultBindingGetStatementContext out = new DefaultBindingGetStatementContext( ctx.configuration(), ctx.data(), (CallableStatement) ctx.statement(), resultIndexes.get(parameter) ); parameter.getBinding().get(out); outValues.put(parameter, out.value()); } private final void registerOutParameters(ExecuteContext ctx) throws SQLException { Configuration c = ctx.configuration(); Map data = ctx.data(); CallableStatement statement = (CallableStatement) ctx.statement(); // Register all out / inout parameters according to their position // Note that some RDBMS do not support binding by name very well for (Parameter parameter : getParameters()) if (resultParameter(parameter)) registerOutParameter(c, data, statement, parameter); } private final void registerOutParameter(Configuration c, Map data, CallableStatement statement, Parameter parameter) throws SQLException { parameter.getBinding().register(new DefaultBindingRegisterContext(c, data, statement, resultIndexes.get(parameter))); } // ------------------------------------------------------------------------ // Fetch routine results // ------------------------------------------------------------------------ @Override public final T getReturnValue() { if (returnParameter != null) return getValue(returnParameter); return null; } @Override public final Results getResults() { return results; } @Override public final Z getValue(Parameter parameter) { return get(parameter); } @Override @SuppressWarnings("unchecked") public final Z get(Parameter parameter) { return (Z) outValues.get(parameter); } protected final Map, Field> getInValues() { return inValues; } // ------------------------------------------------------------------------ // Access to routine configuration objects // ------------------------------------------------------------------------ @Override public final List> getOutParameters() { return Collections.unmodifiableList(outParameters); } @Override public final List> getInParameters() { return Collections.unmodifiableList(inParameters); } @Override public final List> getParameters() { return Collections.unmodifiableList(allParameters); } @Override public final Schema getSchema() { return schema; } @Override public final Package getPackage() { return pkg; } @Override public final String getName() { return name; } @Override public final Parameter getReturnParameter() { return returnParameter; } protected final void setOverloaded(boolean overloaded) { this.overloaded = overloaded; } protected final boolean isOverloaded() { return overloaded; } private final boolean hasUnnamedParameters() { return hasUnnamedParameters; } private final void addParameter(Parameter parameter) { allParameters.add(parameter); hasUnnamedParameters |= parameter.isUnnamed(); } private final boolean resultParameter(Parameter parameter) { return parameter.equals(getReturnParameter()) || getOutParameters().contains(parameter); } protected final void addInParameter(Parameter parameter) { addParameter(parameter); inParameters.add(parameter); // IN parameters are initialised with null by default inValues.put(parameter, val(null, parameter.getDataType())); // [#1183] [#3533] defaulted parameters are marked as such if (parameter.isDefaulted()) inValuesDefaulted.add(parameter); else inValuesNonDefaulted.add(parameter); } protected final void addInOutParameter(Parameter parameter) { addInParameter(parameter); outParameters.add(parameter); } protected final void addOutParameter(Parameter parameter) { addParameter(parameter); outParameters.add(parameter); } protected final void setReturnParameter(Parameter parameter) { addParameter(parameter); returnParameter = parameter; } public final Field asField() { if (function == null) { function = new RoutineField(); } return function; } public final Field asField(String alias) { return asField().as(alias); } public final AggregateFunction asAggregateFunction() { Field[] array = new Field[getInParameters().size()]; int i = 0; for (Parameter p : getInParameters()) { array[i] = getInValues().get(p); i++; } // [#2393] Fully qualify custom aggregate functions. // TODO: Merge this code into RoutineField! List names = new ArrayList(); if (schema != null) { names.add(schema.getName()); } if (pkg != null) { names.add(pkg.getName()); } names.add(name); return (AggregateFunction) function(DSL.name(names.toArray(new String[0])), type, array); } /** * Subclasses may call this method to create {@link UDTField} objects that * are linked to this table. * * @param name The name of the field (case-sensitive!) * @param type The data type of the field * * @deprecated - Please, re-generate your routine code. */ @Deprecated protected static final Parameter createParameter(String name, DataType type) { return createParameter(name, type, false, null, null); } /** * Subclasses may call this method to create {@link UDTField} objects that * are linked to this table. * * @param name The name of the field (case-sensitive!) * @param type The data type of the field * @param isDefaulted Whether the parameter is defaulted (see * {@link Parameter#isDefaulted()} * * @deprecated - Please, re-generate your routine code. */ @Deprecated protected static final Parameter createParameter(String name, DataType type, boolean isDefaulted) { return createParameter(name, type, isDefaulted, null, null); } /** * Subclasses may call this method to create {@link UDTField} objects that * are linked to this table. * * @param name The name of the field (case-sensitive!) * @param type The data type of the field * @param isDefaulted Whether the parameter is defaulted (see * {@link Parameter#isDefaulted()} * * @deprecated - Please, re-generate your routine code. */ @Deprecated protected static final Parameter createParameter(String name, DataType type, boolean isDefaulted, Converter converter) { return createParameter(name, type, isDefaulted, converter, null); } /** * Subclasses may call this method to create {@link UDTField} objects that * are linked to this table. * * @param name The name of the field (case-sensitive!) * @param type The data type of the field * @param isDefaulted Whether the parameter is defaulted (see * {@link Parameter#isDefaulted()} * * @deprecated - Please, re-generate your routine code. */ @Deprecated protected static final Parameter createParameter(String name, DataType type, boolean isDefaulted, Binding binding) { return createParameter(name, type, isDefaulted, null, binding); } /** * Subclasses may call this method to create {@link UDTField} objects that * are linked to this table. * * @param name The name of the field (case-sensitive!) * @param type The data type of the field * @param isDefaulted Whether the parameter is defaulted (see * {@link Parameter#isDefaulted()} * * @deprecated - Please, re-generate your routine code. */ @Deprecated protected static final Parameter createParameter(String name, DataType type, boolean isDefaulted, Converter converter, Binding binding) { return createParameter(name, type, isDefaulted, false, converter, binding); } /** * Subclasses may call this method to create {@link UDTField} objects that * are linked to this table. * * @param name The name of the field (case-sensitive!) * @param type The data type of the field * @param isDefaulted Whether the parameter is defaulted (see * {@link Parameter#isDefaulted()} * @param isUnnamed Whether the parameter is unnamed (see * {@link Parameter#isUnnamed()}. */ protected static final Parameter createParameter(String name, DataType type, boolean isDefaulted, boolean isUnnamed) { return createParameter(name, type, isDefaulted, isUnnamed, null, null); } /** * Subclasses may call this method to create {@link UDTField} objects that * are linked to this table. * * @param name The name of the field (case-sensitive!) * @param type The data type of the field * @param isDefaulted Whether the parameter is defaulted (see * {@link Parameter#isDefaulted()} * @param isUnnamed Whether the parameter is unnamed (see * {@link Parameter#isUnnamed()}. */ protected static final Parameter createParameter(String name, DataType type, boolean isDefaulted, boolean isUnnamed, Converter converter) { return createParameter(name, type, isDefaulted, isUnnamed, converter, null); } /** * Subclasses may call this method to create {@link UDTField} objects that * are linked to this table. * * @param name The name of the field (case-sensitive!) * @param type The data type of the field * @param isDefaulted Whether the parameter is defaulted (see * {@link Parameter#isDefaulted()} * @param isUnnamed Whether the parameter is unnamed (see * {@link Parameter#isUnnamed()}. */ protected static final Parameter createParameter(String name, DataType type, boolean isDefaulted, boolean isUnnamed, Binding binding) { return createParameter(name, type, isDefaulted, isUnnamed, null, binding); } /** * Subclasses may call this method to create {@link UDTField} objects that * are linked to this table. * * @param name The name of the field (case-sensitive!) * @param type The data type of the field * @param isDefaulted Whether the parameter is defaulted (see * {@link Parameter#isDefaulted()} * @param isUnnamed Whether the parameter is unnamed (see * {@link Parameter#isUnnamed()}. */ @SuppressWarnings("unchecked") protected static final Parameter createParameter(String name, DataType type, boolean isDefaulted, boolean isUnnamed, Converter converter, Binding binding) { final Binding actualBinding = DefaultBinding.newBinding(converter, type, binding); final DataType actualType = converter == null && binding == null ? (DataType) type : type.asConvertedDataType(actualBinding); return new ParameterImpl(name, actualType, actualBinding, isDefaulted, isUnnamed); } /** * The {@link Field} representation of this {@link Routine} */ private class RoutineField extends AbstractField { /** * Generated UID */ private static final long serialVersionUID = -5730297947647252624L; @SuppressWarnings("unchecked") RoutineField() { super(AbstractRoutine.this.getName(), AbstractRoutine.this.type == null // [#4254] PostgreSQL may have stored functions that don't // declare an explicit return type. Those function's return // type is in fact a RECORD type, consisting of OUT paramterers ? (DataType) SQLDataType.RESULT : AbstractRoutine.this.type); } @Override public void accept(Context ctx) { RenderContext local = create(ctx).renderContext(); toSQLQualifiedName(local); List> fields = new ArrayList>(); for (Parameter parameter : getInParameters()) { // [#1183] [#3533] Skip defaulted parameters if (inValuesDefaulted.contains(parameter)) continue; // Disambiguate overloaded function signatures if (ctx.family() == POSTGRES) { // [#4920] In case there are any unnamed parameters, we mustn't if (hasUnnamedParameters()) { if (isOverloaded()) fields.add(getInValues().get(parameter).cast(parameter.getType())); else fields.add(getInValues().get(parameter)); } else { if (isOverloaded()) fields.add(field("{0} := {1}", name(parameter.getName()), getInValues().get(parameter).cast(parameter.getType()))); else fields.add(field("{0} := {1}", name(parameter.getName()), getInValues().get(parameter))); } } else fields.add(getInValues().get(parameter)); } Field result = function(local.render(), getDataType(), fields.toArray(new Field[0])); // [#3592] Decrease SQL -> PL/SQL context switches with Oracle Scalar Subquery Caching if (TRUE.equals(settings(ctx.configuration()).isRenderScalarSubqueriesForStoredFunctions())) { result = DSL.select(result).asField(); } ctx.visit(result); } } // ------------------------------------------------------------------------ // XXX: Object API // ------------------------------------------------------------------------ @Override public int hashCode() { // [#1938] This is a much more efficient hashCode() implementation // compared to that of standard QueryParts return name.hashCode(); } }