インターフェース API#
https://github.com/TryGhost/node-sqlite3/wiki/API
注意:callback
を使用しなくても、API は同期呼び出しにはなりません。
new sqlite3.Database(filename [, mode] [, callback])
#
新しい Database オブジェクトを返し、その Database オブジェクトを自動的に開きます。
filename
:有効な値はファイル名です。
-
mode
(オプション):sqlite3.OPEN_READONLY
、sqlite3.OPEN_READWRITE
、sqlite3.OPEN_CREATE
、sqlite3.OPEN_FULLMUTEX
、sqlite3.OPEN_URI
、sqlite3.OPEN_SHAREDCACHE
、sqlite3.OPEN_PRIVATECACHE
のいずれかを選択できます。初期値はOPEN_READWRITE | OPEN_CREATE | OPEN_FULLMUTEX
です。 -
callback
(オプション):このコールバック(関数)が提供された場合、データベースが正常に開かれたかどうかに関係なく、このコールバックが呼び出されます。最初の引数はエラーオブジェクトです。このオブジェクトがnull
の場合、データベースのオープンに成功しています。コールバックが提供されず、データベースのオープン時にエラーが発生した場合、このデータベースオブジェクト上でerror
イベントが発生し、そのエラーオブジェクトが唯一のパラメータとして渡されます。データベースが正常にオープンされた場合、コールバックが提供されていない場合でも、パラメータのないopen
イベントが発生します。
sqlite3.verbose()
#
実行モードを冗長モード(verbose)に設定して、長いスタックトレースを生成します。リセットする方法はありません。詳細については、デバッグの wiki ページを参照してください。
データベース Database#
close([callback])
#
データベースを閉じます。
callback
(オプション):callback
が提供された場合、この関数はデータベースが正常に閉じられたかどうかに関係なく呼び出されます。最初の引数はエラーオブジェクトです。このオブジェクトがnull
の場合、データベースのクローズに成功しています。コールバックが提供されず、データベースのクローズ時にエラーが発生した場合、このデータベースオブジェクト上でerror
イベントが発生します。データベースが正常にクローズされた場合、パラメータのないclose
イベントが発生します。
configure(option, value)
#
データベースに設定オプションを設定します。有効なオプションは次のとおりです:
トレースとプロファイリング
- trace:値としてコールバック関数を提供します。SQL ステートメントの実行時に呼び出され、ステートメントテキストを表示します。
- profile:値としてコールバック関数を提供します。SQL ステートメントの実行時に呼び出されます。
- busyTimeout:値として整数を提供します。ビジータイムアウトを設定します。
run(sql [, param, ...] [, callback])
#
指定されたパラメータで SQL 文を実行し、その後にコールバックを呼び出します。結果は返されません。この関数は、データベースオブジェクトが呼び出されたときに関数チェーンを行うために使用されます。
sql
:実行する SQL 文。SQL クエリが無効であり、かつコールバックが提供された場合、