Transaction (TeamKunPluginManager 3.0.0-pre9 API)

java.lang.Object
- net.kunmc.lab.kpm.db.Transaction

All Implemented Interfaces:

AutoCloseable
```
public class Transaction
extends Object
implements AutoCloseable
```
DBのトランザクションを簡単に行うためのクラスです。

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Transaction.QueryResult<T>` クエリの実行結果を表すクラスです。
`static interface`	`Transaction.TransactionRun` トランザクションを実行する汎用関数です。

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`abortManually()` 手動でトランザクションをロールバックし終了します。
`Transaction`	`beforeCommit(Transaction.TransactionRun beforeCommit)` コミット前に実行する処理を登録します。
`void`	`close()`
`static Transaction`	`create(@NotNull Connection connection, @Nullable String sql)` トランザクションを開始します。
`static Transaction`	`create(@NotNull com.zaxxer.hikari.HikariDataSource dataSource)` トランザクションを開始します。
`static Transaction`	`create(@NotNull com.zaxxer.hikari.HikariDataSource dataSource, @Nullable String sql)` トランザクションを開始します。
`static Transaction`	`create(@NotNull Transaction transaction, @Nullable String sql)` トランザクションを開始します。
`static com.zaxxer.hikari.HikariDataSource`	`createDataSource(@NotNull Path databasePath)` SQLIte データソースを作成します。
`void`	`doTransaction(Transaction.TransactionRun transactionRun)` トランザクションを実行し、コミットします。
`<T> Transaction.QueryResult<T>`	`executeQuery()` クエリ系SQL文を実行します。
`int`	`executeUpdate()` 更新系SQL文を実行します。
`int`	`executeUpdate(boolean autoFinish)` 更新系SQL文を実行します。
`void`	`finishManually()` 手動でトランザクションをコミットし終了します。
`boolean`	`isExists()` DBにレコードが存在するかどうかを確認します。
`boolean`	`isExists(boolean closeConnection)` DBにレコードが存在するかどうかを確認します。
`Transaction`	`renew(@Nullable String newQuery)` トランザクションを再生成します。
`Transaction`	`set(int index, boolean value)` SQL文に真偽値をセットします。
`Transaction`	`set(int index, byte value)` SQL文にバイナリ値をセットします。
`Transaction`	`set(int index, byte[] value)` SQL文にバイト配列をセットします。
`Transaction`	`set(int index, double value)` SQL文に64ビット浮動小数点数値をセットします。
`Transaction`	`set(int index, float value)` SQL文に32ビット浮動小数点数値をセットします。
`Transaction`	`set(int index, int value)` SQL文に32ビット整数値をセットします。
`Transaction`	`set(int index, long value)` SQL文に64ビット整数値をセットします。
`Transaction`	`set(int index, short value)` SQL文に16ビット整数値をセットします。
`Transaction`	`set(int index, @Nullable String value)` SQL文に文字列値をセットします。
`Transaction`	`setNull(int index, int type)` SQL文にNULL値をセットします。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static Transaction create(@NotNull
                                 @NotNull com.zaxxer.hikari.HikariDataSource dataSource,
                                 @Nullable
                                 @Nullable String sql)
```
    トランザクションを開始します。
    
    Parameters:
    
    dataSource - データソース
    
    sql - SQL文
    
    Returns:
    
    トランザクション
  - create
```
public static Transaction create(@NotNull
                                 @NotNull Connection connection,
                                 @Nullable
                                 @Nullable String sql)
```
    トランザクションを開始します。
    
    Parameters:
    
    connection - コネクション
    
    sql - SQL文
    
    Returns:
    
    トランザクション
  - create
```
public static Transaction create(@NotNull
                                 @NotNull Transaction transaction,
                                 @Nullable
                                 @Nullable String sql)
```
    トランザクションを開始します。
    
    Parameters:
    
    transaction - 既存のトランザクション
    
    sql - SQL文
    
    Returns:
    
    トランザクション
  - create
```
public static Transaction create(@NotNull
                                 @NotNull com.zaxxer.hikari.HikariDataSource dataSource)
```
    トランザクションを開始します。
    
    Parameters:
    
    dataSource - データソース
    
    Returns:
    
    トランザクション
  - createDataSource
```
public static com.zaxxer.hikari.HikariDataSource createDataSource(@NotNull
                                                                  @NotNull Path databasePath)
```
    SQLIte データソースを作成します。
    
    Parameters:
    
    databasePath - データベースのパス
    
    Returns:
    
    データソース
  - renew
```
public Transaction renew(@Nullable
                         @Nullable String newQuery)
```
    トランザクションを再生成します。
    
    Parameters:
    
    newQuery - 新しいSQL文
    
    Returns:
    
    トランザクション
  - beforeCommit
```
public Transaction beforeCommit(Transaction.TransactionRun beforeCommit)
```
    コミット前に実行する処理を登録します。
    
    Parameters:
    
    beforeCommit - コミット前に実行する処理
    
    Returns:
    
    トランザクション
  - set
```
public Transaction set(int index,
                       @Nullable
                       @Nullable String value)
```
    SQL文に文字列値をセットします。
    
    Parameters:
    
    index - インデックス
    
    value - 値
    
    Returns:
    
    トランザクション
  - set
```
public Transaction set(int index,
                       int value)
```
    SQL文に32ビット整数値をセットします。
    
    Parameters:
    
    index - インデックス
    
    value - 値
    
    Returns:
    
    トランザクション
  - set
```
public Transaction set(int index,
                       boolean value)
```
    SQL文に真偽値をセットします。
    
    Parameters:
    
    index - インデックス
    
    value - 値
    
    Returns:
    
    トランザクション
  - set
```
public Transaction set(int index,
                       long value)
```
    SQL文に64ビット整数値をセットします。
    
    Parameters:
    
    index - インデックス
    
    value - 値
    
    Returns:
    
    トランザクション
  - set
```
public Transaction set(int index,
                       double value)
```
    SQL文に64ビット浮動小数点数値をセットします。
    
    Parameters:
    
    index - インデックス
    
    value - 値
    
    Returns:
    
    トランザクション
  - set
```
public Transaction set(int index,
                       float value)
```
    SQL文に32ビット浮動小数点数値をセットします。
    
    Parameters:
    
    index - インデックス
    
    value - 値
    
    Returns:
    
    トランザクション
  - set
```
public Transaction set(int index,
                       byte value)
```
    SQL文にバイナリ値をセットします。
    
    Parameters:
    
    index - インデックス
    
    value - 値
    
    Returns:
    
    トランザクション
  - set
```
public Transaction set(int index,
                       short value)
```
    SQL文に16ビット整数値をセットします。
    
    Parameters:
    
    index - インデックス
    
    value - 値
    
    Returns:
    
    トランザクション
  - set
```
public Transaction set(int index,
                       byte[] value)
```
    SQL文にバイト配列をセットします。
    
    Parameters:
    
    index - インデックス
    
    value - 値
    
    Returns:
    
    トランザクション
  - setNull
```
public Transaction setNull(int index,
                           int type)
```
    SQL文にNULL値をセットします。
    
    Parameters:
    
    index - インデックス
    
    type - 型
    
    Returns:
    
    トランザクション
  - executeUpdate
```
public int executeUpdate(boolean autoFinish)
```
    更新系SQL文を実行します。
    
    Parameters:
    
    autoFinish - 自動終了するかどうか
    
    Returns:
    
    更新件数
  - executeUpdate
```
public int executeUpdate()
```
    更新系SQL文を実行します。
    
    Returns:
    
    更新件数
  - executeQuery
```
public <T> Transaction.QueryResult<T> executeQuery()
```
    クエリ系SQL文を実行します。
    
    Type Parameters:
    
    T - 戻り値の型
  - doTransaction
```
public void doTransaction(Transaction.TransactionRun transactionRun)
```
    トランザクションを実行し、コミットします。
    
    Parameters:
    
    transactionRun - トランザクションを処理する関数
  - finishManually
```
public void finishManually()
```
    手動でトランザクションをコミットし終了します。
  - abortManually
```
public void abortManually()
```
    手動でトランザクションをロールバックし終了します。
  - isExists
```
public boolean isExists(boolean closeConnection)
```
    DBにレコードが存在するかどうかを確認します。
    
    Parameters:
    
    closeConnection - 終了時にコネクションを閉じるかどうか
    
    Returns:
    
    存在するかどうか
  - isExists
```
public boolean isExists()
```
    DBにレコードが存在するかどうかを確認します。
    
    Returns:
    
    存在するかどうか
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable

Class Transaction

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

create

create

create

createDataSource

renew

beforeCommit

set

set

set

set

set

set

set

set

set

setNull

executeUpdate

executeUpdate

executeQuery

doTransaction

finishManually

abortManually

isExists

isExists

close