com.github.drinkjava2.jdbpro.NormalJdbcTool Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jdialects Show documentation

jDialects is a pagination and DDL tool support ~80 databases, run on JDK8 or above

There is a newer version: 5.0.13.jre8

/**
 * Copyright (C) 2016 Yong Zhu.
 *
 * 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 com.github.drinkjava2.jdbpro;

/**
 * Interface of Normal JDBC methods, this interface is used for other projects
 * like jDialects to eliminate jar dependency, other projects need copy this
 * interface into there source code folder but always use name
 * "com.github.drinkjava2.jdbpro.NormalJdbcTool"
 * 
 * @author Yong Zhu
 * @since 1.7.0.1
 */

public interface NormalJdbcTool {// NOSONAR

	/**
	 * Query for an Object, only return the first row and first column's value
	 * if more than one column or more than 1 rows returned, a null object may
	 * return if no result found
	 * 
	 * @param sql
	 * @param params
	 * @return An Object or null, Object type determined by SQL content
	 */
	public  T nQueryForObject(String sql, Object... params);

	/**
	 * Executes the given INSERT, UPDATE, or DELETE SQL statement.
	 * 
	 * @param sql
	 *            the SQL
	 * @param params
	 *            the parameters if have
	 * @return The number of rows updated.
	 */
	public int nUpdate(String sql, Object... params);

	/**
	 * Execute an statement, including a stored procedure call, which does not
	 * return any result sets. Any parameters which are instances of
	 * org.apache.commons.dbutils.OutParameter will be registered as OUT
	 * parameters. Transaction mode is determined by connectionManager property.
	 * 
	 * Use this method when invoking a stored procedure with OUT parameters that
	 * does not return any result sets. If you are not invoking a stored
	 * procedure, or the stored procedure has no OUT parameters, consider using
	 * {@link #Update(java.lang.String...) }. If the stored procedure returns
	 * result sets, use
	 * {@link #iExecute(org.apache.commons.dbutils.ResultSetHandler, java.lang.String...) }.
	 * 
	 * @param sql
	 *            the SQL
	 * @return The number of rows updated.
	 */
	public int nExecute(String sql, Object... params);
}