APIリファレンス
GDPostgresPool
PostgreSQL接続を必要に応じて上限まで作り、複数の処理で再利用します。空き接続の待機と、接続状況の確認ができます。
メソッド
open(host: String = "127.0.0.1", port: int = 5432, opts: Dictionary = { }, size: int = 0) -> Variant, Errquery(sql: String, args: Array = []) -> Dictionary, Errquery_row(sql: String, args: Array = [], max_bytes: int = 0) -> Dictionary, Errquery_rows(sql: String, args: Array = []) -> GDDatabaseRows, Errquery_values(sql: String, args: Array = []) -> Dictionary, Errquery_flat(sql: String, args: Array = []) -> Dictionary, Errquery_many(sql: String, rows: Array) -> Array, Errfetch_many(sql: String, rows: Array) -> Array, Errfetch_values_many(sql: String, rows: Array) -> Array, Errfetch_flat_many(sql: String, rows: Array) -> Array, Errexec_many(sql: String, rows: Array) -> int, Erropen_async(host: String = "127.0.0.1", port: int = 5432, opts: Dictionary = { }, size: int = 0) -> await Variant, Errquery_async(sql: String, args: Array = []) -> await Dictionary, Errquery_row_async(sql: String, args: Array = [], max_bytes: int = 0) -> await Dictionary, Errquery_rows_async(sql: String, args: Array = []) -> await GDDatabaseRows, Errquery_values_async(sql: String, args: Array = []) -> await Dictionary, Errquery_flat_async(sql: String, args: Array = []) -> await Dictionary, Errquery_many_async(sql: String, rows: Array) -> await Array, Errfetch_many_async(sql: String, rows: Array) -> await Array, Errfetch_values_many_async(sql: String, rows: Array) -> await Array, Errfetch_flat_many_async(sql: String, rows: Array) -> await Array, Errexec_many_async(sql: String, rows: Array) -> await int, Errclose() -> voidsize() -> intin_flight() -> intstats() -> Dictionary
open
open(host: String = "127.0.0.1", port: int = 5432, opts: Dictionary = { }, size: int = 0) -> Variant, Err英語原文Configure the pool and create connections lazily on first use.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
host | String | "127.0.0.1" | 接続または待ち受けに使うホスト名・IPアドレス。 |
port | int | 5432 | ネットワークのポート番号。待ち受け時の0はOSがポートを選びます。 |
opts | Dictionary | { } | 処理の設定を名前と値で指定する辞書。省略した項目には、この関数の既定値が使われます。 |
size | int | 0 | プールに用意する物理接続の数。 |
戻り値
Variant, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
query
query(sql: String, args: Array = []) -> Dictionary, Err英語原文Send through an available connection; scripts use await pool.query(...).
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
args | Array | [] | 関数へ渡す引数、またはSQL文中のプレースホルダーに渡す値を、順番に並べた配列。 |
戻り値
Dictionary, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
query_row
query_row(sql: String, args: Array = [], max_bytes: int = 0) -> Dictionary, Err英語原文Return only the first row through an available connection.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
args | Array | [] | 関数へ渡す引数、またはSQL文中のプレースホルダーに渡す値を、順番に並べた配列。 |
max_bytes | int | 0 | クエリごとの制限を指定するときの、結果の最大バイト数。 |
戻り値
Dictionary, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
query_rows
query_rows(sql: String, args: Array = []) -> GDDatabaseRows, Err英語原文Return rows sequentially while retaining the borrowed connection until Rows closes.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
args | Array | [] | 関数へ渡す引数、またはSQL文中のプレースホルダーに渡す値を、順番に並べた配列。 |
戻り値
GDDatabaseRows, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
query_values
query_values(sql: String, args: Array = []) -> Dictionary, Err英語原文Return rows as column-ordered arrays.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
args | Array | [] | 関数へ渡す引数、またはSQL文中のプレースホルダーに渡す値を、順番に並べた配列。 |
戻り値
Dictionary, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
query_flat
query_flat(sql: String, args: Array = []) -> Dictionary, Err英語原文Return all row values in one array.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
args | Array | [] | 関数へ渡す引数、またはSQL文中のプレースホルダーに渡す値を、順番に並べた配列。 |
戻り値
Dictionary, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
query_many
query_many(sql: String, rows: Array) -> Array, Err英語原文Batch one statement through one connection with one wait and completion signal.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
rows | Array | 省略不可 | 入力順の行。データベースの一括実行では各行が1組のパラメーターです。 |
戻り値
Array, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
fetch_many
fetch_many(sql: String, rows: Array) -> Array, Err英語原文Batch one statement and flatten all rows from its queries.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
rows | Array | 省略不可 | 入力順の行。データベースの一括実行では各行が1組のパラメーターです。 |
戻り値
Array, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
fetch_values_many
fetch_values_many(sql: String, rows: Array) -> Array, Err英語原文Flatten column-ordered row arrays.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
rows | Array | 省略不可 | 入力順の行。データベースの一括実行では各行が1組のパラメーターです。 |
戻り値
Array, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
fetch_flat_many
fetch_flat_many(sql: String, rows: Array) -> Array, Err英語原文Return all row values in one array.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
rows | Array | 省略不可 | 入力順の行。データベースの一括実行では各行が1組のパラメーターです。 |
戻り値
Array, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
exec_many
exec_many(sql: String, rows: Array) -> int, Err英語原文Batch updates through one connection and return only the completion count.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
rows | Array | 省略不可 | 入力順の行。データベースの一括実行では各行が1組のパラメーターです。 |
戻り値
int, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
open_async
open_async(host: String = "127.0.0.1", port: int = 5432, opts: Dictionary = { }, size: int = 0) -> await Variant, Err英語原文Configure the pool and create connections lazily on first use.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
host | String | "127.0.0.1" | 接続または待ち受けに使うホスト名・IPアドレス。 |
port | int | 5432 | ネットワークのポート番号。待ち受け時の0はOSがポートを選びます。 |
opts | Dictionary | { } | 処理の設定を名前と値で指定する辞書。省略した項目には、この関数の既定値が使われます。 |
size | int | 0 | プールに用意する物理接続の数。 |
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
query_async
query_async(sql: String, args: Array = []) -> await Dictionary, Err英語原文Send through an available connection; scripts use await pool.query(...).
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
args | Array | [] | 関数へ渡す引数、またはSQL文中のプレースホルダーに渡す値を、順番に並べた配列。 |
戻り値
await Dictionary, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
query_row_async
query_row_async(sql: String, args: Array = [], max_bytes: int = 0) -> await Dictionary, Err英語原文Return only the first row through an available connection.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
args | Array | [] | 関数へ渡す引数、またはSQL文中のプレースホルダーに渡す値を、順番に並べた配列。 |
max_bytes | int | 0 | クエリごとの制限を指定するときの、結果の最大バイト数。 |
戻り値
await Dictionary, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
query_rows_async
query_rows_async(sql: String, args: Array = []) -> await GDDatabaseRows, Err英語原文Return rows sequentially while retaining the borrowed connection until Rows closes.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
args | Array | [] | 関数へ渡す引数、またはSQL文中のプレースホルダーに渡す値を、順番に並べた配列。 |
戻り値
await GDDatabaseRows, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
query_values_async
query_values_async(sql: String, args: Array = []) -> await Dictionary, Err英語原文Return rows as column-ordered arrays.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
args | Array | [] | 関数へ渡す引数、またはSQL文中のプレースホルダーに渡す値を、順番に並べた配列。 |
戻り値
await Dictionary, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
query_flat_async
query_flat_async(sql: String, args: Array = []) -> await Dictionary, Err英語原文Return all row values in one array.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
args | Array | [] | 関数へ渡す引数、またはSQL文中のプレースホルダーに渡す値を、順番に並べた配列。 |
戻り値
await Dictionary, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
query_many_async
query_many_async(sql: String, rows: Array) -> await Array, Err英語原文Batch one statement through one connection with one wait and completion signal.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
rows | Array | 省略不可 | 入力順の行。データベースの一括実行では各行が1組のパラメーターです。 |
戻り値
await Array, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
fetch_many_async
fetch_many_async(sql: String, rows: Array) -> await Array, Err英語原文Batch one statement and flatten all rows from its queries.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
rows | Array | 省略不可 | 入力順の行。データベースの一括実行では各行が1組のパラメーターです。 |
戻り値
await Array, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
fetch_values_many_async
fetch_values_many_async(sql: String, rows: Array) -> await Array, Err英語原文Flatten column-ordered row arrays.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
rows | Array | 省略不可 | 入力順の行。データベースの一括実行では各行が1組のパラメーターです。 |
戻り値
await Array, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
fetch_flat_many_async
fetch_flat_many_async(sql: String, rows: Array) -> await Array, Err英語原文Return all row values in one array.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
rows | Array | 省略不可 | 入力順の行。データベースの一括実行では各行が1組のパラメーターです。 |
戻り値
await Array, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
exec_many_async
exec_many_async(sql: String, rows: Array) -> await int, Err英語原文Batch updates through one connection and return only the completion count.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sql | String | 省略不可 | 実行するSQL文。外部から受け取った値はSQL文につなげず、別の配列で渡します。 |
rows | Array | 省略不可 | 入力順の行。データベースの一括実行では各行が1組のパラメーターです。 |
戻り値
await int, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
close
close() -> void英語原文Close and release retained resources.
引数
引数はありません。
戻り値
void
値を返しません。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
size
size() -> int英語原文Return the number of physical connections currently owned by this pool.
引数
引数はありません。
戻り値
int
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
in_flight
in_flight() -> int英語原文Return the number of active queries.
引数
引数はありません。
戻り値
int
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
stats
stats() -> Dictionary英語原文Return connection-pool state and cumulative wait statistics.
引数
引数はありません。
戻り値
Dictionary
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。