2021年09月18日くいなちゃん


プログラミング言語Kuin」の実行環境がexe用のAPIリファレンスページです。
sqlライブラリは現在、動作環境(-eオプション)が「exe」のときのみ使えます。 他の環境向けに使用するとコンパイルエラーになります。

 sql@Sql

データベースを操作するクラスです。

 sql@Sql.apply



プリペアドステートメントを実行するメソッドです。

func apply(): bool

戻り値成功したらtrue、失敗したらfalse
発生条件ビルド例外コード
データベースが終了状態になっているdbgのみ0xE917000A

 sql@Sql.errMsg



エラーメッセージを取得するメソッドです。

func errMsg(): []char

戻り値エラーメッセージ
発生条件ビルド例外コード
データベースが終了状態になっているdbgのみ0xE917000A

 sql@Sql.exec



データベースの操作を実行するメソッドです。

func exec(cmd: []char): bool

cmd実行するクエリ
戻り値成功したらtrue、失敗したらfalse
発生条件ビルド例外コード
データベースが終了状態になっているdbgのみ0xE917000A

 sql@Sql.fin



データベースの操作を終了するメソッドです。

fin()

既に終了しているとき、このメソッドは何もしません。
データベースはsql@Sqlクラスのインスタンスが解放されるときに自動で終了します。 このメソッドは、終了するタイミングを明示的に制御したいときにお使いください。

 sql@Sql.getBlob



実行結果をバイナリで取得するメソッドです。

func getBlob(col: int): []bit8

col取得する列(最初の列を0とする)
戻り値バイナリの値。データベースの値がNULLの場合にはnullが返る
データベースの値の型が取得しようとした型と異なる場合、自動的に型が変換されて返ります。
発生条件ビルド例外コード
データベースが終了状態になっているdbgのみ0xE917000A

 sql@Sql.getFloat



実行結果をfloatで取得するメソッドです。

func getFloat(col: int): float

col取得する列(最初の列を0とする)
戻り値floatの値
データベースの値の型が取得しようとした型と異なる場合、自動的に型が変換されて返ります。
発生条件ビルド例外コード
データベースが終了状態になっているdbgのみ0xE917000A

 sql@Sql.getInt



実行結果をintで取得するメソッドです。

func getInt(col: int): int

col取得する列(最初の列を0とする)
戻り値intの値
データベースの値の型が取得しようとした型と異なる場合、自動的に型が変換されて返ります。
発生条件ビルド例外コード
データベースが終了状態になっているdbgのみ0xE917000A

 sql@Sql.getStr



実行結果を文字列で取得するメソッドです。

func getStr(col: int): []char

col取得する列(最初の列を0とする)
戻り値文字列の値。データベースの値がNULLの場合にはnullが返る
データベースの値の型が取得しようとした型と異なる場合、自動的に型が変換されて返ります。
発生条件ビルド例外コード
データベースが終了状態になっているdbgのみ0xE917000A

 sql@Sql.next



次の行へ進むメソッドです。

func next()

SQLのselectで複数行を取得した場合には、このメソッドを使って1行ずつ処理します。
発生条件ビルド例外コード
データベースが終了状態になっているdbgのみ0xE917000A

 sql@Sql.prepare



プリペアドステートメントの準備を行うメソッドです。

func prepare(cmd: []char): bool

cmd実行するクエリ。 バインドする箇所に「?」と書く
戻り値成功したらtrue、失敗したらfalse
「WHERE id=? AND name=?」のように書くと、「?」の部分に外部から値を安全にバインドすることができます。
プリペアドステートメントはバインドが終わったら、applyメソッドで実行できます。
発生条件ビルド例外コード
データベースが終了状態になっているdbgのみ0xE917000A

 sql@Sql.setBlob



プリペアドステートメントにバイナリ値をバインドするメソッドです。

func setBlob(idx: int, value: []bit8): bool

idxバインドするインデックス(最初の要素を0とする)
valueバインドする値
戻り値成功したらtrue、失敗したらfalse
発生条件ビルド例外コード
データベースが終了状態になっているdbgのみ0xE917000A

 sql@Sql.setFloat



プリペアドステートメントにfloat値をバインドするメソッドです。

func setFloat(idx: int, value: float): bool

idxバインドするインデックス(最初の要素を0とする)
valueバインドする値
戻り値成功したらtrue、失敗したらfalse
発生条件ビルド例外コード
データベースが終了状態になっているdbgのみ0xE917000A

 sql@Sql.setInt



プリペアドステートメントにint値をバインドするメソッドです。

func setInt(idx: int, value: int): bool

idxバインドするインデックス(最初の要素を0とする)
valueバインドする値
戻り値成功したらtrue、失敗したらfalse
発生条件ビルド例外コード
データベースが終了状態になっているdbgのみ0xE917000A

 sql@Sql.setStr



プリペアドステートメントに文字列をバインドするメソッドです。

func setStr(idx: int, value: []char): bool

idxバインドするインデックス(最初の要素を0とする)
valueバインドする値
戻り値成功したらtrue、失敗したらfalse
発生条件ビルド例外コード
データベースが終了状態になっているdbgのみ0xE917000A

 sql@Sql.term



取得できる行が無くなったかどうかを取得するメソッドです。

func term(): bool

戻り値取得できる行が残っていればfalse、無くなればtrue
SQLのselectで複数行を取得した場合には、このメソッドを使って取得できる行が残っているかを判定します。
発生条件ビルド例外コード
データベースが終了状態になっているdbgのみ0xE917000A

 sql@makeSql

データベースの操作を開始する関数です。

func makeSql(path: []char): sql@Sql

pathデータベースを保存するファイル名
戻り値データベースを操作するクラスのインスタンス
既にpathにファイルが存在すれば、開いてデータベースを読み込みます。 なければ新規データベースを作成します。
1631936762jaf