Ruby 1.9.2 リファレンスマニュアル > ライブラリ一覧 > pstoreライブラリ > PStoreクラス

class PStore

クラスの継承リスト: PStore < Object < Kernel < BasicObject

Abstract

Rubyのオブジェクトを外部ファイルに格納するためのクラスです。 内部で Marshal を使っています。

使い方

データベースにアクセスするためには、 transaction のブロック内である必要があります。 インターフェースは Hash に似ています。 

require 'pstore'
db = PStore.new("/tmp/foo")
db.transaction do
  p db.roots       # => []
  ary = db["root"] = [1,2,3,4]
  ary[0] = [1,1.5]
end

db.transaction do
  p db["root"]     # => [[1, 1.5], 2, 3, 4]
end

特異メソッド

new(file) -> PStore

ファイル名 file に対してデータベースを読み書きする。

file のあるディレクトリは書き込み可能である必要がある。 データベースを更新するときにバックアップファイルが作成されるため。

[PARAM] file:
データベースファイル名。

データベースの更新が成功すると、バックアップファイルは削除される。バックアップファイル名は ファイル名に ".tmp" および ".new" を付けたもの。

インスタンスメソッド

self[name] -> object

ルートnameに対応する値を得る。

[PARAM] name:
探索するルート。
[EXCEPTION] PStore::Error:
トランザクション外でこのメソッドが呼び出された場合に発生します。

[SEE_ALSO] Hash#[]

self[name] = value

ルート name に対応する値 value をセットする。

[PARAM] name:
ルート。
[UNKNOWN_META_INFO] @aram:
value 格納する値。
[EXCEPTION] PStore::Error:
トランザクション外でこのメソッドが呼び出された場合に発生します。

[SEE_ALSO] Hash#[]=

abort -> ()

データベースの読み書きを終了する。

transaction ブロックから抜けますが、データベースの変更は反映されません。

[EXCEPTION] PStore::Error:
トランザクション外でこのメソッドが呼び出された場合に発生します。

例: 

require 'pstore'
db = PStore.new("/tmp/foo")
db.transaction do
  p db.roots       # => []
  ary = db["root"] = [1,2,3,4]
  db.abort
  ary[0] = [1,1.5] # => ここは実行されない。
end

db.transaction do |pstore|
  pstore["root"]       # => nil
end
commit -> ()

データベースの読み書きを終了します。

transaction ブロックから抜け、データベースの変更が反映されます。

[EXCEPTION] PStore::Error:
トランザクション外でこのメソッドが呼び出された場合に発生します。

例: 

require 'pstore'
db = PStore.new("/tmp/foo")
db.transaction do
  p db.roots       # => []
  ary = db["root"] = [1,2,3,4]
  db.commit
  ary[0] = [1,1.5] # => ここは実行されない。
end

db.transaction do |pstore|
  pstore["root"]       # => [[1, 2, 3, 4]
end
delete(name) -> object

ルートnameに対応する値を削除します。

[PARAM] name:
探索するルート。
[RETURN]
削除した値を返します。
[EXCEPTION] PStore::Error:
トランザクション外でこのメソッドが呼び出された場合に発生します。

例: 

require 'pstore'
db = PStore.new("/tmp/foo")
db.transaction do
  p db.roots       # => []
  ary = db["root"] = [1,2,3,4]
  ary[0] = [1,1.5]
end

db.transaction do |pstore|
  pstore.delete("root")       # => [[1, 1.5], 2, 3, 4]
  pstore.delete("root")       # => nil
end

[SEE_ALSO] Hash#delete

fetch(name, default = PStore::Error) -> object

ルートnameに対応する値を得る。

該当するルートが登録されていない時には、 引数 default が与えられていればその値を返し、 与えられていなければ例外 PStore::Error が発生します。

[PARAM] name:
探索するルート。
[PARAM] default:
name に対応するルートが登録されていない場合に返す値を指定する。
[EXCEPTION] PStore::Error:
name に対応するルートが登録されていないかつ、 default が与えられていない場合に発生します。 また、トランザクション外でこのメソッドが呼び出された場合に発生します。

例: 

require 'pstore'
db = PStore.new("/tmp/foo")
db.transaction do
  p db.roots       # => []
  ary = db["root"] = [1,2,3,4]
  ary[0] = [1,1.5]
end

db.transaction(true) do |pstore|
  pstore.fetch("root")        # => [[1, 1.5], 2, 3, 4]
  pstore.fetch("root", 'aaa') # => [[1, 1.5], 2, 3, 4]
  pstore.fetch("not_root")    # => 例外発生
end

[SEE_ALSO] Hash#fetch, PStore#[]

path -> String

データベースのファイル名を得ます。

root?(name) -> bool

ルート name がデータベースに格納されている場合に真を返します。

[PARAM] name:
探索するルート。
[EXCEPTION] PStore::Error:
トランザクション外でこのメソッドが呼び出された場合に発生します。

[SEE_ALSO] Hash#key?

roots -> Array

ルートの集合を配列で返します。

[EXCEPTION] PStore::Error:
トランザクション外でこのメソッドが呼び出された場合に発生します。

[SEE_ALSO] Hash#keys

transaction(read_only = false) {|pstore| ... } -> ()

トランザクションに入ります。 このブロックの中でのみデータベースの読み書きができます。

読み込み専用のトランザクションが使用可能です。

[PARAM] read_only:
真を指定すると、読み込み専用のトランザクションになります。
[EXCEPTION] PStore::Error:
read_only を真にしたときに、データベースを変更しようした場合に発生します。

例: 

require 'pstore'
db = PStore.new("/tmp/foo")
db.transaction do
  p db.roots       # => []
  ary = db["root"] = [1,2,3,4]
  ary[0] = [1,1.5]
end

db.transaction(true) do |pstore|
  pstore["root"] = 'aaa' # => ここで例外発生
end

privateメソッド

in_transaction -> ()

トランザクションの中でなければ例外を発生させます。

Methods

Classes