gdドキュメント0.8.0

APIリファレンス

GDDatabaseRows

結果を1行ずつ読み取るオブジェクトです。next()で次の行に進み、scan()またはvalues()でその行の値を取得します。読み取り後はerr()でエラーを確認し、close()で閉じます。

メソッド

next

next() -> bool
英語原文

Advance one row; return false on EOF or failure.

引数

引数はありません。

戻り値

bool

この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

next_async

next_async() -> await bool
英語原文

Advance one row; return false on EOF or failure.

引数

引数はありません。

戻り値

await bool

完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

scan

scan() -> Dictionary, Err
英語原文

Copy the current row into a column-name dictionary.

引数

引数はありません。

戻り値

Dictionary, Err

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

values

values() -> Array, Err
英語原文

Return current-row values in column order.

引数

引数はありません。

戻り値

Array, Err

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

columns

columns() -> PackedStringArray
英語原文

Return result column names.

引数

引数はありません。

戻り値

PackedStringArray

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

err

err() -> Err
英語原文

Return the reason Next returned false, or null for EOF.

引数

引数はありません。

戻り値

Err

エラー

Errオブジェクトを直接返します。処理結果とErrの2つを返す形式ではありません。エラーが見つからない場合などはnullを返します。詳しい条件は、この関数の説明を参照してください。

command_tag

command_tag() -> String
英語原文

Return the backend completion tag.

引数

引数はありません。

戻り値

String

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

close

close() -> void
英語原文

Close Rows without reading the remainder.

引数

引数はありません。

戻り値

void

値を返しません。

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

cancel

cancel() -> void
英語原文

Close Rows while preserving context cancellation as an Err.

引数

引数はありません。

戻り値

void

値を返しません。

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

is_closed

is_closed() -> bool
英語原文

Check whether Rows reached EOF, failure, or explicit closure.

引数

引数はありません。

戻り値

bool

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。