org.jdbi.v3.sqlobject.customizer.OutParameter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jdbi3-sqlobject Show documentation
Show all versions of jdbi3-sqlobject Show documentation
SqlObject is a declarative, annotation-driven API
for database access. It complements the core API.
Jdbi 3 is designed to provide convenient tabular data access in
Java(tm) and other JVM based languages.
It uses the Java collections framework for query results,
provides a convenient means of externalizing SQL statements, and
named parameter support for any database that supports JDBC.
/*
* 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.
*/
package org.jdbi.v3.sqlobject.customizer;
import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.jdbi.v3.sqlobject.customizer.internal.OutParameterFactory;
/**
* Declare a named out parameter on an {@code @SqlCall} annotated method.
* Note that you *must* include the parameter name in the SQL text to
* ensure that the binding is activated, this is a limitation that
* may be fixed at a future date.
*
* Example usage, using PostgreSQL call syntax:
*
* handle.execute("CREATE FUNCTION set100(OUT outparam INT) AS $$ BEGIN outparam := 100; END; $$ LANGUAGE plpgsql");
*
* @SqlCall("{call myStoredProc(:outparam)}")
* @OutParameter(name="outparam", sqlType = Types.INTEGER)
* OutParameters callStoredProc();
*
*/
@SqlStatementCustomizingAnnotation(OutParameterFactory.class)
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(OutParameterList.class)
public @interface OutParameter {
String name();
int sqlType();
}