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

class DBM

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

Abstract

特異メソッド

open(dbname, mode = 0666, flags = nil) -> DBM

open(dbname, mode = 0666, flags = nil) {|db| ... } -> ()

dbname で指定したデータベースをモードを mode に設定してオープンします。

mode の省略値は 0666 です。mode として nil を指定すると データベースが存在しない時には新たなデータベースを作らず nil を返します。

[PARAM] dbname:

データベース名

[PARAM] mode:

データベースのオープンモード

[PARAM] flags:

以下のいずれかを指定します。

DBM::READER

データベースの読み込みのみを行う

DBM::WRITER

データベースの新規作成はせず読み書きする

DBM::WRCREAT

データベースが存在しなければ新規作成して読み書きする

DBM::NEWDB

データベースを常に新規作成して既存のデータは破棄する

インスタンスメソッド

self[key] -> String

key をキーとする値を返します。

[PARAM] key:

キー。

self[key] = value

key をキーとして、value を格納します。 value として nil を指定すると、key に対する要素を削除します。

[PARAM] key:

キー。

[PARAM] value:

値。

clear -> self

DBM ファイルを空にします。

close -> nil

DBM ファイルをクローズします。以後の操作は例外を発生させます。

closed? -> bool

DBM ファイルが既に閉じられているか調べます。

既に閉じられていれば true を返します。そうでなければ false を返します。

delete(key) -> String

key をキーとする要素を削除します。

[RETURN]

削除した要素の値を返します。

[EXCEPTION] DBMError:

要素の削除に失敗した場合に発生します。

reject! { |key, value| ... } -> self

delete_if { |key, value| ... } -> self

ブロックを評価した値が真であれば該当する要素を削除します。

このメソッドは self を破壊的に変更します。

each {|key, value| ... } -> self

each_pair {|key, value| ... } -> self

各要素に対するイテレータ。

each_key {|key| ... } -> self

全ての key に対して繰り返すイテレータ。

each_value {|value| ... } -> self

全ての value に対して繰り返すイテレータ。

empty?() -> bool

データベースが空の時、真を返します。

fetch(key, ifnone = nil) -> String

データベースからキーを探して対応する要素の値を返します。

[PARAM] key:

キー。

[PARAM] ifnone:

キーが見つからなかった場合に返す値。

[EXCEPTION] IndexError:

ifnone を指定していないとき、キーが見つからなかった場合に発生します。

require 'dbm'

db1 = DBM.open('aaa.db', 0666, DBM::NEWDB)
db1[:a] = 'aaa'
db1[:b] = 'bbbbbb'
p db1.fetch('a')                     #=> 'aaa'
p db1.fetch('z', 'zzz')              #=> 'zzz'
p db1.fetch('z'){|key| [:key, key] } #=> [:key, 'z']
p db1.fetch('z')                     #=> IndexError 発生

[SEE_ALSO] Hash#fetch

has_key?(key) -> bool

key?(key) -> bool

include?(key) -> bool

member?(key) -> bool

key がデータベース中に存在する時、真を返します。

[PARAM] key:

キー。

has_value?(value) -> bool

value?(value) -> bool

value を値とする組がデータベース中に存在する時、真を返します。

[PARAM] value:

検索したい値。

index(value) -> String | nil

value を持つ要素のキーを返します。

見つからなかった場合は nil を返します。

[PARAM] value:

検索したい値。

invert -> Hash

値からキーへのハッシュを返します。

require 'dbm'

db1 = DBM.open('aaa.db', 0666, DBM::NEWDB)
db1[:a] = 'aaa'
db1[:b] = 'bbbbbb'
p db1.invert  #=> {"bbbbbb" => "b", "aaa" => "a"}

keys -> [String]

データベース中に存在するキー全てを含む配列を返します。

length -> Integer

size -> Integer

データベース中の要素の数を返します。

現在の実装では要素数を数えるためにデータベースを全部検索します。

reject { |key, value| ... } -> Hash

ブロックを評価した値が真であれば該当する要素を削除します。

self.to_hash.reject{|key, value| ... }

と同じです。

[SEE_ALSO] Hash#reject

replace(other) -> self

self の内容を other の内容で置き換えます。

[PARAM] other:

each_pair メソッドを持つオブジェクトでなければなりません。

require 'dbm'

db1 = DBM.open('aaa.db', 0666, DBM::NEWDB)
db1[:a] = 'aaa'
db1[:b] = 'bbbbbb'
db2 = DBM.open('bbb.db', 0666, DBM::NEWDB)
db2[:bb] = 'bbb'
db2[:cc] = 'ccc'

p db1.keys #=> ['b', 'a']

db1.replace(db2)

p db1.keys #=> ['bb', 'cc']
p db2.keys #=> ['bb', 'cc']

hash = {'x' => 'xxx', 'y' => 'yyy' }
p db1               #=> #<DBM:0xb7c7eb08>
p db1.replace(hash) #=> #<DBM:0xb7c7eb08>

select {|key, value| ... } -> [Array]

ブロックを評価して真になった要素のみを配列に格納して返します。

require 'dbm'

db1 = DBM.open('aaa.db', 0666, DBM::NEWDB)
db1[:a] = 'aaa'
db1[:b] = 'bbbbbb'

p db1.select {|key, value| key == 'a' } #=> [["a", "aaa"]]

shift -> String

データベース中の要素を一つ取り出し、データベースから削除します。

store(key, value) -> String

key に対して value を格納します。

[PARAM] key:

キー。

[PARAM] value:

値。

[SEE_ALSO] DBM#[]=

require 'dbm'

db1 = DBM.open('aaa.db', 0666, DBM::NEWDB)
p db1.store('c', 'ccc') #=> "ccc"

to_a -> [Array]

キーと値のペアを配列に変換して返します。

require 'dbm'

db1 = DBM.open('aaa.db', 0666, DBM::NEWDB)
db1[:a] = 'aaa'
db1[:b] = 'bbbbbb'

p db1.to_a #=> [["b", "bbbbbb"], ["a", "aaa"]]

to_hash -> Hash

self をハッシュに変換して返します。

require 'dbm'

db1 = DBM.open('aaa.db', 0666, DBM::NEWDB)
db1[:a] = 'aaa'
db1[:b] = 'bbbbbb'
p db1.to_hash #=> {"a"=>"aaa", "b"=>"bbbbbb"}

update(other) {|key, value| ... } -> self

self と other の内容をマージします。

重複するキーに対応する値はother の内容で上書きされます。

[PARAM] other:

each_pair メソッドを持つオブジェクトでなければなりません。

require 'dbm'

db1 = DBM.open('aaa.db', 0666, DBM::NEWDB)
db1[:a] = 'aaa'
db1[:b] = 'bbbbbb'
db2 = DBM.open('bbb.db', 0666, DBM::NEWDB)
db2[:bb] = 'bbb'
db2[:cc] = 'ccc'

db1.update(db2)
p db1.keys #=> ["bb", "cc", "b", "a"]

values -> [String]

データベース中に存在する値全てを含む配列を返します。

values_at(*keys) -> [String]

keys に対応する値を配列に格納して返します。

[PARAM] keys:

キー。複数指定可能です。

require 'dbm'

db1 = DBM.open('aaa.db', 0666, DBM::NEWDB)
db1[:a] = 'aaa'
db1[:b] = 'bbbbbb'

p db1.values_at('a', 'b') #=> ["aaa", "bbbbbb"]

定数

NEWDB

書き込みモードで、すでにファイルが存在したら削除して作り直します．

[SEE_ALSO] DBM.open

READER

読み込みモードでオープンします．

[SEE_ALSO] DBM.open

VERSION

libdbm のバージョンを表す文字列です。

DB_VERSION_STRING という定数が C 言語レベルで定義されていない場合は "unknown" になります。

WRCREAT

書き込みモードで、すでにファイルが存在しなかったら作ります．

[SEE_ALSO] DBM.open

WRITER

書き込みモードでオープンします．

[SEE_ALSO] DBM.open