Database (GNU Emacs Lisp Reference Manual)

33.29 データベース

SQLiteデータベースへのアクセスにたいする組み込みサポートとともにEmacsをコンパイルできます。このセクションではLispプログラムからSQLiteデータベースへアクセスするために利用できる機能について説明します。

Function: sqlite-available-p ¶: この関数はビルトインSQLiteサポートが利用可能なら非nilをリターンする。

SQLiteサポートが利用可能なら、以下の関数を利用できます。

Function: sqlite-open &optional file ¶

この関数はfileをSQLiteのデータベースファイルとしてオープンする。fileが存在しなければ、新たなデータベースを作成して指定されたファイルに格納する。fileが省略またはnilなら、かわりにインメモリーのデータベースを作成する。

リターン値はデータベースオブジェクト(database object)。これは以下に挙げるほとんどの関数の引数として利用できる。

Function: sqlitep object ¶: この述語関数はobjectがSQLiteデータベースオブジェクトなら非nilをリターンする。sqlite-openがリターンしたデータベースオブジェクトは、この述語を満足する。

Function: sqlite-close db ¶: データベースdbを閉じる。通常はこの関数を明示的に呼び出す必要はない(Emacsのシャットダウンやデータベースオブジェクトがガーベージコレクトされればデータベースは自動的に閉じられる)。

Function: sqlite-execute db statement &optional values ¶

SQLの命令文statementを実行時する。たとえば:

(sqlite-execute db "insert into foo values ('bar', 2)")

オプション引数valuesを与える場合には、それは命令を実行する際に値としてバインドされるリストかベクターのいずれかであること。

(sqlite-execute db "insert into foo values (?, ?)" '("bar" 2))

これは前の例とまったく同じ効果をもつが、より効率的かつ安全である(文字列の解析や挿入を何も行わないので)。

sqlite-executeは通常は影響を受ける行数をリターンする。たとえば‘insert’文は通常だと‘1’をリターンするが、‘update’文は0、あるいはそれより大きい値をリターンするかもしれない。ただし‘insert into … returning …’やその類いのSQL文を使った際には、かわりに‘returning …’によって指定された値がリターンされる。

SQLiteでの文字列は、デフォルトではutf-8として格納されて、テキストの列をselectした場合にはその文字セット(charset)を使って文字列をデコードする。blobの列をselectした場合には、何もデコードせずにrawデータをリターンする(データベースに格納されているバイトを含んだユニバイトをリターンする)。バイナリーデータをblob列にinsertする場合には、デフォルトではsqlite-executeはすべての文字列をutf-8と解釈するため注意を要する。

したがってたとえばgifと呼ばれるユニバイト文字列としてGIFデータをもっている場合には、sqlite-executeにそれが判るように特別にマークする必要がある:

(put-text-property 0 1 'coding-system 'binary gif)
(sqlite-execute db "insert into foo values (?, ?)" (list gif 2))

Function: sqlite-execute-batch db statements ¶: SQLのstatementsを実行する。statementsは0 個以上のSQL文を含んだ文字列であること。Lispプログラムが一度に複数のDDL文(Data Definition Language: データ定義言語)を実行する必要がある場合に、このコマンドが役に立つかもしれない。

Function: sqlite-select db query &optional values return-type ¶

dbからデータをselectしてそれをリターンする。たとえば:

(sqlite-select db "select * from foo where key = 2")
  ⇒ (("bar" 2))

sqlite-executeの場合と同様に、selectの実行前にバインドする値としてリストまたはベクターをオプションとして渡すことができる:

(sqlite-select db "select * from foo where key = ?" [2])
  ⇒ (("bar" 2))

これは前の例で用いた手法に比べて、通常はより効果的かつ安全である。

この関数はデフォルトではマッチした行のリストをリターンする(行は列の値のリスト)。return-typeがfullの場合には、リターン値の1つ目の要素として列の名前(文字列のリスト)をリターンする。

return-typeがsetなら、この関数はかわりにステートメントオブジェクト(statement object)をリターンする。このオブジェクトはsqlite-next、sqlite-columns、sqlite-more-pといった関数を用いて調べることができる。結果セットが小さければ単に直接データをリターンするほうが便利な場合が多いが、結果セットが大きい場合(あるいはそのセットのデータすべてを使いたい場合)には、割り当てられるメモリーが大幅に小さくメモリー効率に優れたsetメソッドを使用すること。

Function: sqlite-next statement ¶

この関数は結果セットstatement(通常はsqlite-selectがリターンしたオブジェクト)の次の行をリターンする。

(sqlite-next stmt)
    ⇒ ("bar" 2)

Function: sqlite-columns statement ¶

この関数は結果セットstatement (通常はsqlite-selectがリターンしたオブジェクト)の列名をリターンする。

(sqlite-columns stmt)
    ⇒ ("name" "issue")

Function: sqlite-more-p statement ¶: 結果セットstatement(通常はsqlite-selectがリターンしたオブジェクト)からfetchできるデータがまだあるかどうかを調べる述語である。

Function: sqlite-finalize statement ¶: これ以上statementを使わない場合には、この関数を呼び出すことによってstatementが使用していたリソースが解放される。この関数の呼び出しは通常は必要ない(statementオブジェクトがガーベージコレクトされれば、Emacsがそのオブジェクトのリソースを自動的に解放する)。

Function: sqlite-transaction db ¶: dbでトランザクションを開始する。トランザクションにおいてはsqlite-commitによってそのトランザクションがコミットされるまでは、そのデータベースの他の読み取り手は結果にアクセスできない。

Function: sqlite-commit db ¶: dbのトランザクションを終了して、データベースのファイルにデータを書き込む。

Function: sqlite-rollback db ¶: dbのトランザクションを終了して、そのトランザクションによって行われたすべての変更を破棄する。

Macro: with-sqlite-transaction db body… ¶: progn (順序を参照)と同様だが、トランザクションを保持した状態でbodyを実行して、bodyが正常に終了した場合には最後にそのトランザクションをコミットする。bodyがエラーをシグナルするかトランザクションのコミットに失敗すると、bodyで行われたdbでの変更はロールバックされる。このマクロは正常終了してコミットが成功するとbodyの値をリターンする。

Function: sqlite-pragma db pragma ¶

dbにおいてpragmaを実行する。pragmaとは特定のテーブルではなく、通常はデータベース全体に効果を及ぼすコマンドのこと。たとえば不要になったデータのガーベージコレクトをSQLiteに自動的に行わせるには、以下のようにすればよい:

(sqlite-pragma db "auto_vacuum = FULL")

この関数はpragmaが成功すれば非nil、失敗するとnilをリターンする。pragmaの多くは空の新規データベースでのみ発行できる。

Function: sqlite-load-extension db module ¶: 名前つきエクステンション(拡張)であるmoduleをデータベースdbにロードする。エクステンションは通常は共有ライブラリーであり、GNUおよびUnixのシステムではファイル名の拡張子として.soがつけられている。

Function: sqlite-version ¶: 使用中のSQLiteライブラリーのバージョンを表す文字列をリターンする。

SQLiteファイルの内容を一覧したければ、sqlite-mode-open-fileコマンドを使うことができます。これはSQLiteデータベースの調査(と変更)が可能なsqlite-modeのバッファーをポップアップします。