APIリファレンス
GDDatabaseTx
トランザクションが終わるまで専用の接続を使うデータベースクライアントです。
メソッド
query(sql: String, args: Array = []) -> Dictionary, Errquery_async(sql: String, args: Array = []) -> await Dictionary, Errquery_row(sql: String, args: Array = []) -> Dictionary, Errquery_row_async(sql: String, args: Array = []) -> await Dictionary, Errquery_rows(sql: String, args: Array = []) -> GDDatabaseRows, Errquery_rows_async(sql: String, args: Array = []) -> await GDDatabaseRows, Erris_active() -> bool
query
query(sql: String, args: Array = []) -> Dictionary, Err英語原文Return the completion signal without waiting, for composition.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
args | Array | [] | 関数へ渡す引数、またはSQL文中のプレースホルダーに渡す値を、順番に並べた配列。 |
戻り値
Dictionary, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
query_async
query_async(sql: String, args: Array = []) -> await Dictionary, Err英語原文Return the completion signal without waiting, for composition.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
args | Array | [] | 関数へ渡す引数、またはSQL文中のプレースホルダーに渡す値を、順番に並べた配列。 |
戻り値
await Dictionary, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
query_row
query_row(sql: String, args: Array = []) -> Dictionary, Err英語原文Return query_row's completion signal without waiting, for composition.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
args | Array | [] | 関数へ渡す引数、またはSQL文中のプレースホルダーに渡す値を、順番に並べた配列。 |
戻り値
Dictionary, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
query_row_async
query_row_async(sql: String, args: Array = []) -> await Dictionary, Err英語原文Return query_row's completion signal without waiting, for composition.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
args | Array | [] | 関数へ渡す引数、またはSQL文中のプレースホルダーに渡す値を、順番に並べた配列。 |
戻り値
await Dictionary, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
query_rows
query_rows(sql: String, args: Array = []) -> GDDatabaseRows, Err英語原文Return query_rows' completion signal without waiting, for composition.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
args | Array | [] | 関数へ渡す引数、またはSQL文中のプレースホルダーに渡す値を、順番に並べた配列。 |
戻り値
GDDatabaseRows, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
query_rows_async
query_rows_async(sql: String, args: Array = []) -> await GDDatabaseRows, Err英語原文Return query_rows' completion signal without waiting, for composition.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
args | Array | [] | 関数へ渡す引数、またはSQL文中のプレースホルダーに渡す値を、順番に並べた配列。 |
戻り値
await GDDatabaseRows, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
is_active
is_active() -> bool英語原文Check whether the transaction remains usable.
引数
引数はありません。
戻り値
bool
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。