Ruby 2.3.0 リファレンスマニュアル > ライブラリ一覧 > pstoreライブラリ > PStoreクラス
クラスの継承リスト: PStore < Object < Kernel < BasicObject
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, thread_safe = false) -> PStore
[permalink][rdoc]ファイル名 file に対してデータベースを読み書きします。
データベースを更新するときにバックアップファイルが作成されるため、 file のあるディレクトリは書き込み可能である必要があります。 データベースの更新が成功すると、バックアップファイルは削除されます。バックアップファイル名は ファイル名に ".tmp" および ".new" を付けたものです。
self[name] -> object
[permalink][rdoc]ルートnameに対応する値を得ます。
[SEE_ALSO] Hash#[]
self[name] = value
[permalink][rdoc]ルート name に対応する値 value をセットします。
[SEE_ALSO] Hash#[]=
abort -> ()
[permalink][rdoc]データベースの読み書きを終了します。
transaction ブロックから抜けますが、データベースの変更は反映されません。
例:
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 -> ()
[permalink][rdoc]データベースの読み書きを終了します。
transaction ブロックから抜け、データベースの変更が反映されます。
例:
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
[permalink][rdoc]ルートnameに対応する値を削除します。
例:
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
[permalink][rdoc]ルートnameに対応する値を得ます。
該当するルートが登録されていない時には、 引数 default が与えられていればその値を返し、 与えられていなければ例外 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(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
[permalink][rdoc]データベースのファイル名を得ます。
root?(name) -> bool
[permalink][rdoc]ルート name がデータベースに格納されている場合に真を返します。
[SEE_ALSO] Hash#key?
roots -> Array
[permalink][rdoc]ルートの集合を配列で返します。
[SEE_ALSO] Hash#keys
transaction(read_only = false) {|pstore| ... } -> object
[permalink][rdoc]トランザクションに入ります。 このブロックの中でのみデータベースの読み書きができます。
読み込み専用のトランザクションが使用可能です。
例:
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
ultra_safe -> bool
[permalink][rdoc]真であれば、パフォーマンスと引き換えにファイル更新の衝突を避けることができます。 デフォルトは偽です。
このフラグの効果があるのは一部のプラットフォームだけです。 (e.g. all POSIX platforms: Linux, Mac OS X, FreeBSD, etc)
ultra_safe=(flag)
[permalink][rdoc]真をセットすると、パフォーマンスと引き換えにファイル更新の衝突を避けることができます。
このフラグの効果があるのは一部のプラットフォームだけです。 (e.g. all POSIX platforms: Linux, Mac OS X, FreeBSD, etc)
in_transaction -> ()
[permalink][rdoc]トランザクションの中でなければ例外を発生させます。
EMPTY_MARSHAL_CHECKSUM -> String
[permalink][rdoc]内部で利用する定数です。
EMPTY_MARSHAL_DATA -> String
[permalink][rdoc]内部で利用する定数です。
EMPTY_STRING -> String
[permalink][rdoc]内部で利用する定数です。
RDWR_ACCESS -> Integer
[permalink][rdoc]内部で利用する定数です。
RD_ACCESS -> Integer
[permalink][rdoc]内部で利用する定数です。
WR_ACCESS -> Integer
[permalink][rdoc]内部で利用する定数です。