com.github.risedragon.mysql.MysqlClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-mysqlclient Show documentation
A very simple/efficient Mysql Client Framework
The newest version!
package com.github.risedragon.mysql;

import java.sql.SQLException;
import java.util.List;

/**
 * Spring-mysqlclient core interface, which provides CRUD its bulk form @Table class.
 * 
 * 
 * MysqlClient there are two important realization:
 * 
MysqlClientPlatformTransactionImpl with the Spring container-managed transaction to perform JDBC operation
 * 
MysqlConnectTransactionImpl manage its own affairs Connection transaction
 * 
 * 
 * @author hezhaowu
 * @since 0.9.1
 */
public interface MysqlClient {

	/**
	 * The initialization method mysqlclient
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	void init() throws Exception;

	/**
	 * Executive Connection callbacks.
	 * 
	 * @param callback
	 *            the callback object to invoke
	 * @return
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 T callback(ConnectionCallback callback) throws SQLException;

	/**
	 * Insert an object using INSERT INTO ... Syntax
	 * 
	 * @param tableObject
	 *            any object whose class marked @Table annotation.
	 * @return number of affected records
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 int insert(T tableObject) throws SQLException;

	/**
	 * Insert an object using INSERT IGNORE INTO ... Syntax
	 * 
	 * @param tableObject
	 *            any object whose class marked @Table annotation.
	 * @return number of affected records
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 int insertIgnore(T tableObject) throws SQLException;

	/**
	 * Insert an object using INSERT INTO ... Syntax, and return the generated key value.
	 * 
	 * @param tableObject
	 *            any object whose class marked @Table annotation.
	 * @return the generated key value
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 R insert(T tableObject, Class generatedKeyType) throws SQLException;

	/**
	 * Insert an object using INSERT IGNORE INTO ... Syntax, and return the generated key value.
	 * 
	 * @param tableObject
	 *            any object whose class marked @Table annotation.
	 * @return the generated key value
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 R insertIgnore(T tableObject, Class generatedKeyType) throws SQLException;

	/**
	 * Update an object using UPDATE ... SET Syntax
	 * 
	 * @param tableObject
	 *            any object whose class marked @Table annotation.
	 * @return number of affected records
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 int update(T tableObject) throws SQLException;

	/**
	 * Update an object using REPLACE INTO ... Syntax
	 * 
	 * @param tableObject
	 *            any object whose class marked @Table annotation.
	 * @return number of affected records
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 int replace(T tableObject) throws SQLException;

	/**
	 * Update an object using REPLACE INTO ... Syntax, and return the generated key value.
	 * 
	 * @param tableObject
	 *            any object whose class marked @Table annotation.
	 * @return the generated key value
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 R replace(T tableObject, Class generatedKeyType) throws SQLException;

	/**
	 * Insert or Update an object using INSERT INTO ... ON DUPLICATE KEY UPDATE column=IFNULL(?,column) Syntax,
	 * 
	 * @param tableObject
	 *            any object whose class marked @Table annotation.
	 * @return number of affected records
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 int merge(T tableObject) throws SQLException;

	/**
	 * Insert or Update an object using INSERT INTO ... ON DUPLICATE KEY UPDATE column=IFNULL(?,column) Syntax, and return the generated key value.
	 * 
	 * @param tableObject
	 *            any object whose class marked @Table annotation.
	 * @return the generated key value
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 R merge(T tableObject, Class generatedKeyType) throws SQLException;

	/**
	 * Delete an object using DELETE FROM ... Syntax
	 * 
	 * @param tableObject
	 *            any object whose class marked @Table annotation.
	 * @return number of affected records
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 int delete(T tableObject) throws SQLException;

	/**
	 * Delete an object by keys using DELETE FROM ... Syntax, with the same order of declaration.
	 * 
	 * @param tableType
	 *            the class marked @Table annotation
	 * @param keys
	 *            the primary key values
	 * @return number of affected records
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 int deleteByKey(Class tableType, Object... keys) throws SQLException;

	/**
	 * Select an object using SELECT ... FROM Syntax, and returns a completely new object.
	 * 
	 * @param tableObject
	 *            any object whose class marked @Table annotation.
	 * @return the record object if there is, otherwise return null
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 T select(T tableObject) throws SQLException;

	/**
	 * Select an object using SELECT ... FROM Syntax, it will reuse the parameter object but not create a new one;
	 * 
	 * @param tableObject
	 *            any object whose class marked @Table annotation.
	 * @return the record object if there is, otherwise return null
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 T select2(T tableObject) throws SQLException;

	/**
	 * Select an object by keys using SELECT ... FROM Syntax, with the same order of declaration.
	 * 
	 * @param tableType,
	 *            any class marked @Table annotation.
	 * @param keys,
	 *            primary keys of the table
	 * @return the record object if there is, otherwise return null
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 T selectByKey(Class tableType, Object... keys) throws SQLException;

	/**
	 * Select all object using SELECT ... FROM Syntax
	 * 
	 * @param tableType
	 *            any class marked @Table annotation.
	 * @return the record list of a table
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 List selectAll(Class tableType) throws SQLException;

	/**
	 * Select a range object set between [start,start+count) using SELECT ... FROM...LIMIT offset,count Syntax
	 * 
	 * @param tableType
	 *            any class marked @Table annotation.
	 * @param offset
	 * @param count
	 * @return the record list of a table
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 List selectRange(Class tableType, int offset, int count) throws SQLException;

	/**
	 * Select the first object using SELECT ... FROM...LIMIT 0,1 Syntax
	 * 
	 * @param tableType
	 *            any class marked @Table annotation.
	 * @return the record list of a table
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 T selectFirst(Class tableType) throws SQLException;

	/**
	 * 
	 * @param tableType
	 *            any class marked @Table annotation.
	 * @param page
	 *            contain information for paging, such as offset, count, orderBy, orderDesc
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 void selectPage(Class tableType, Page page) throws SQLException;

	/**
	 * The batch operation form of insert method.
	 * 
	 * @param tableObject
	 *            any object whose class marked @Table annotation.
	 * @return number of affected records
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 int[] batchInsert(T[] tableObject) throws SQLException;

	/**
	 * The batch operation form of insertIgnore method.
	 * 
	 * @param tableObject
	 *            any object whose class marked @Table annotation.
	 * @return number of affected records
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 int[] batchInsertIgnore(T[] tableObject) throws SQLException;

	/**
	 * The batch operation form of insert method.
	 * 
	 * @param tableObject
	 *            any object whose class marked @Table annotation.
	 * @param generatedKeyType
	 *            the type of generated key value
	 * @return the generated key values
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 R[] batchInsert(T[] tableObject, Class generatedKeyType) throws SQLException;

	/**
	 * The batch operation form of insertIgnore method.
	 * 
	 * @param tableObject
	 *            any object whose class marked @Table annotation.
	 * @param generatedKeyType
	 *            the type of generated key value
	 * @return the generated key values
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 R[] batchInsertIgnore(T[] tableObject, Class generatedKeyType) throws SQLException;

	/**
	 * The batch operation form of update method.
	 * 
	 * @param tableObject
	 *            any object whose class marked @Table annotation.
	 * @return number of affected records
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 int[] batchUpdate(T[] tableObject) throws SQLException;

	/**
	 * The batch operation form of replace method.
	 * 
	 * @param tableObject
	 *            any object whose class marked @Table annotation.
	 * @return number of affected records
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 int[] batchReplace(T[] tableObject) throws SQLException;

	/**
	 * The batch operation form of replace method.
	 * 
	 * @param tableObject
	 *            any object whose class marked @Table annotation.
	 * @param generatedKeyType
	 *            the type of generated key value
	 * @return a list of generated key value
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 R[] batchReplace(T[] tableObject, Class generatedKeyType) throws SQLException;

	/**
	 * The batch operation form of merge method.
	 * 
	 * @param tableObject
	 *            any object whose class marked @Table annotation.
	 * @return number of affected records
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 int[] batchMerge(T[] tableObject) throws SQLException;

	/**
	 * The batch operation form of merge method.
	 * 
	 * @param tableObject
	 *            any object whose class marked @Table annotation.
	 * @param generatedKeyType
	 *            the type of generated key value
	 * @return a list of generated key value
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 R[] batchMerge(T[] tableObject, Class generatedKeyType) throws SQLException;

	/**
	 * The batch operation form of delete method.
	 * 
	 * @param tableObjects
	 *            any object whose class marked @Table annotation.
	 * @return number of affected records
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 int[] batchDelete(T[] tableObjects) throws SQLException;

	/**
	 * The batch operation form of deleteByKey method.
	 * 
	 * @param tableType
	 *            any object whose class marked @Table annotation.
	 * @param keys
	 *            the primary key values
	 * @return number of affected records
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 int[] batchDeleteByKey(Class tableType, Object[][] keys) throws SQLException;

	/**
	 * Execute the query represented by queryId and return all the records.
	 * 
	 * @param queryId
	 *            the query id
	 * @param elemType
	 *            the element type of result. it would be Object[] if null. It could not be array, enum, interface
	 * @param params
	 *            the parameters for query, it could be scalar value in JavaType, Map, List, or POJO
	 * @return all the records
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 List query(String queryId, Class elemType, Object params) throws SQLException;

	/**
	 * 
	 * Execute the query represented by queryId and return the records between [offset, offset+count)
	 * 
	 * @param queryId
	 *            the query id
	 * @param elemType
	 *            the element type of result. it would be Object[] if null. It could not be array, enum, interface
	 * @param offset
	 * @param count
	 * @param params
	 *            the parameters for query, it could be scalar value in JavaType, Map, List, or POJO
	 * @return the records between [offset, offset+count)
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 List queryRange(String queryId, Class elemType, int offset, int count, Object params) throws SQLException;

	/**
	 * Execute the query represented by queryId and return the first record of result
	 * 
	 * @param queryId
	 *            the query id
	 * @param elemType
	 *            the element type of result. it would be Object[] if null. It could not be array, enum, interface
	 * @param params
	 *            the parameters for query, it could be scalar value in JavaType, Map, List, or POJO
	 * @return the first record of result
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 T queryFirst(String queryId, Class elemType, Object params) throws SQLException;

	/**
	 * Execute the query represented by queryId and return the page result
	 * 
	 * @param queryId
	 *            the query id
	 * @param elemType
	 *            the element type of result. it would be Object[] if null. It could not be array, enum, interface
	 * @param page
	 *            contain information for paging.
	 * @param params
	 *            the parameters for query, it could be scalar value in JavaType, Map, List, or POJO
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 void queryPage(String queryId, Class elemType, Page page, Object params) throws SQLException;

	/**
	 * Execute the update statement represented by queryId and return the number of affected records
	 * 
	 * @param updateId
	 *            the statement id
	 * @param params
	 *            the parameters for query, it could be scalar value in JavaType, Map, List, or POJO
	 * @return number of affected records
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	int execute(String updateId, Object params) throws SQLException;

	/**
	 * Execute the update statement represented by queryId and return the generated key value
	 * 
	 * @param updateId
	 *            the statement id
	 * @param params
	 *            the parameters for query, it could be scalar value in JavaType, Map, List, or POJO
	 * @param generatedKeyType
	 *            the type of generated key value
	 * @return the generated key value
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 R execute(String updateId, Object params, Class generatedKeyType) throws SQLException;

	/**
	 * The batch operation form of execute method.
	 * 
	 * @param updateId
	 *            the statement id
	 * @param params
	 *            the parameters for query, it could be scalar value in JavaType, Map, List, or POJO
	 * @return number of affected records
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 */
	 int[] batchExecute(String updateId, T[] params) throws SQLException;

	/**
	 * The batch operation form of execute method.
	 * 
	 * @param updateId
	 *            the statement id
	 * @param params
	 *            the parameters for query, it could be scalar value in JavaType, Map, List, or POJO
	 * @param generatedKeyType
	 *            the type of generated key value
	 * @return the generated key value
	 * @throws SQLException
	 *             if there are any database access error or statement execution failed
	 * 
	 * @author hezhaowu
	 * @since 0.9.1
	 */
	 R[] batchExecute(String updateId, T[] params, Class generatedKeyType) throws SQLException;

}