名前¶

BerkeleyDB::Lite - 簡潔になったBerkeleyDBへのインターフェース

概要¶

  use BerkeleyDB::Lite;

## 例1¶

  ## Create a Hashed database
  my $db = new BerkeleyDB::Lite::Hash
                home => 'zoo',
                filename => 'residents' ;

  $db->{Samson} = new Primate ;
  $db->{Cornelius} = new Primate ;
  $db->{Kaa} = new Reptile ;

## 例2¶

  ## Create a Btree database allowing duplicates and scalar values
  my $types = scalars BerkeleyDB::Lite::Btree
                home => 'zoo',
                filename => 'types',
                &duplicatekeys ;

  $types->{primate} = 'Samson' ;
  $types->{primate} = 'Cornelius' ;
  $types->{reptile} = 'Kaa' ;

  printf "%s\n", join ' ', $types->recordset{primate} ;
  ## prints: Samson Cornelius

  $types->delete( primate => 'Samson' ) ;
  printf "%s\n", join ' ', $types->recordset{primate} ;
  ## prints: Cornelius

## 例3¶

  ## Create a database of visitors
  ## Use a table with arbitrary keys
  ## Track visitors by date/timestamp

  $tickets = new BerkeleyDB::Lite::Btree
                home => 'zoo',
                filename => 'tickets',
                &incrementkeys ;

  ## Lexical Alternative
  # $tickets = lexical BerkeleyDB::Lite::Btree
  #             home => 'zoo',
  #             filename => 'tickets' ;

  $bytime = scalars BerkeleyDB::Lite::Btree
                home => 'zoo',
                filename => 'ticketsbytime',
                &duplicatekeys ;

  ## Process a new visitor in real time
  sub newvisitor {
        my $serial = $tickets->nextrecord() ;
        my $date = getdate() ;  ## not part of BerkeleyDB::Lite
        my $time = gettime() ;  ## not part of BerkeleyDB::Lite

        $tickets->{$serial} = { @_ } ;
        $bytime->{ "$date $time" } = $serial ;
        return $serial ;
        }

  ## Get a list of visitors on a certain date
  sub showvisitorsbydate {
        my $date = shift ;
        return $bytime->matchingvalues( $date ) ;
        }

説明¶

BerkeleyDB::LiteはPaul MarquessのBerkeleyDBにおける簡潔になったコンストラクタ、データへのtieされたアクセス、および複数レコードの集合を返す為のメソッドを提供します。

例1¶

BerkeleyDB::Liteは引数homeと言うキーに関連付けられたパッケージ変数のハッシュを参照する BerkeleyDB環境変数を調整します。基本的なBerkeleyDB::Liteのコンストラクタの引数は BerkeleyDBの環境変数およびデータベースを定義します。コンストラクタが呼び出される時、以前にオープンされた環境変数が有効であれば使い回されます。一方、新しい新しい環境変数が生成され、以後のコンストラクタの要求のために有効となります。

BerkeleyDB::Liteの本バージョンでは全ての環境変数オブジェクトは１点集中するデータストアとして生成されます。トランザクション可能なストレージは現在統合されていません。

デフォルトでは、BerkeleyDB::LiteはStorableモジュールを用いるデータベースとなるマーシャルオブジェクトとして設計されています。

例1ではこれらの両方の特徴を意味する単純なアプリケーションを示しています。コンストラクタは環境変数およびデータベースを識別するための最小の引数によって呼び出されています。

これら数行のコードでアプリケーションをサポートするための persistentなオブジェクトを追加するのに十分です。

例2¶

Berkeleyでもっとも良く見られる特等の一つが重複キーのサポートです。この特徴はマーシャリングすることなしに、要素がアクセスできて、追加可能で、削除できるような persistentな配列を用いる用いることで可能にします。

例2ではレコードアクセスの自動シリアライズを無効にした scalarsコンストラクタを用いています。一方で、どうやって保存したかに関わらず、newコンストラクタが用いられた場合、スカラーはスカラーのリファレンスとして返るでしょう。

&duplicatekeysはショートカットとしての定数のペアを返すサブルーチンです。これらの定数はBerkeleyDBモジュールの中で定義されています。

recordsetメソッドはデータベースから保存されたリストを返します。このメソッドはBerkeleyDB::Lite::Btreeおよび BerkeleyDB::Lite::Hash両クラスで有効となっています。

deleteメソッドはリストから要素を削除するために使われます。 BerkeleyDB::Liteにtieインターフェースが付属して以来、 delete関数は通常保存されたオブジェクトを削除するために用いることが出来ます。deleteメソッドはデータベース上で重複キーを伴う曖昧な結果を避けるために使用されるべきです。

BerkeleyDBは削除操作の状態を返します。この形式では次のイディオムを用いることでリスト全体を削除することができます:

  while ( ! delete $types->{primate} ) {}

重複キーの設定をされたBerkeleyDBデータベースでは重複したkey/valueペアも許容されます。ほとんど大部分のデータセットでは、key/valueペアは重複してはなりません。この問題は完全には解決されていません。最近ではその事前策として取得したリストをハッシュ構造にインポートします:

  %unique = map { $_ => 1 } $types->recordset('primate') ;
  keys %unique ;

しかしながら、要素を削除するときに注意すべきです。重複キーを削除するためにはほぼ常に上記に似通ったイディオムを用いてdeleteメソッドが実行されます:

  while ( ! $types->delete( primate => 'samson' ) ) {}

ソースにおけるもう一つの問題はdeleteメソッドをオブジェクトを含むデータベース上で用いた際に発生します。この場合では、 2つ目の引数は保存された値と正しくマッチしないオブジェクトを参照しているかも知れません。次のコードではこの難しさを示します:

  my $cats = new BerkeleyDB::Lite::Btree(
                home => 'zoo',
                filename => 'cats',
                &duplicatekeys,
                ) ;

  my $Felix = new BigCat dinner => 'antelope' ;
  $cats->{lion} = $Felix ;
  $Felix->{dinner} = 'gazelle' ;
  $cats->delete( lion => $Felix ) ;             ## fails

この問題はマーシャリング操作による結果と整数、小数、さもなくば文字列として解釈された数値が異なると言う場合でも起きます。したがって、オブジェクトの値は全くの文脈の結果として変更されるかもしれないかもしれない可能性を孕んでいるのです:

  $weight = '300 lbs.' ;
  $weight =~ s/\D//g ;
  my $Felix = new BigCat( weight => $weight ) ; ## member as string
  $cats->{lion} = $Felix ;
  $cats->delete( lion => $Felix )               ## operation fails
                if $Felix->{weight} > 200 ;     ## member as integer

例3¶

例3では開発者の助けとなるおなじみのリレーショナルデータベースの追加の特徴を2,3紹介します。これらの形式はBtreeデータベースの能力にアドバンテージをもたらしますが、BerkeleyDB::Lite::Hashオブジェクトでは有効ではありません。

BerkeleyDB::Lite::Btreeのnextrecordメソッドは新しいユニークなキーを返します。nextrecordをそれぞれ呼び出すことで競合状態を回避するために新しい空白レコードを作りだ際、新たなキーを返します。このメソッドでは最終レコードに1を追加することでキーを作成します。最高値のキーを含む最終レコードを確保するためには、 &incrementkeys引数をBerkeleyDB::Lite::Btreeコンストラクタに対して用いて下さい。&incrementkeys関数は数値のBtreeソートを強制するCODE定数を返すショートカットです。

&incrementkeys引数を用いてデータベースを構築することによる重大な損害もあります。そのことによって、データベースはdb_dumpおよび db_verifyのようなSleepyCatユーティリティと互換性を失うことになるのです。その代わりnextrecordはBerkeleyDB::Lite::Btree::Lexicalサブクラスからメソッドとして呼び出すことが可能です。このサブクラスは同様に機能しますが、その数値のキーは0をパディングされた文字列としてソートされたものです。しかしながら、Lexicalサブクラスにおける制約により、データベースにおけるキーは10,000,000,000以下の数値でなければなりません。

BerkeleyDB::Lite::Btreeクラスへのlexicalコンストラクタは BerkeleyDB::Lite::Btree::Lexicalサブクラスのnewコンストラクタと同意です。

BerkeleyDB::LiteではBerkeleyにおけるもう一つの良い特徴を実装しています: 文字列の部分マッチング。メソッドmatchingkeys、matchingvalues、および searchsetでは全て共通の部分文字列で始まるキーのレコードの集合を返します。

例えば、もしキーが次のフォーマットで定義されたら: "2002 Jul 14 15:30"、以下のデータを返すことが可能です:

  ## All records for the year
  @annually = $bytime->matchingkeys('2002 ') ;

  ## All records for the month
  @monthly = $bytime->matchingvalues('2002 Jul ') ;

  ## All records for the day
  %daily = $bytime->searchset('2002 Jul 14 ') ;

matchingkeysではマッチしたレコードのキーの配列を返します。 matchingvaluesではマッチしたレコードの値の配列を返します。意外な混乱としてmatchingvaluesというメソッドにおける結果- 返されるレコードはマッチしているキーを保有していますが、実際に返って来るのはレコードの値です。

searchsetでは示されたような連想配列に変換可能な key/valueペアとしてマッチしたレコードを返します。しかしながら、連想配列を使うことはデータベースが重複キーを含んでいた場合無意味となります。以下のコードではこの手の探索における結果を取得するための効果的なテクニックです:

    foreach ( $bytime->matchingkeys( '2002 Jul 14', &uniquekeys ) ) {
        $daily{ $_ } = [ $bytime->recordset( $_ ) ] ;
        }

&uniqukeysではデータベースからの重複結果をフィルターするために matchingkeysメソッドに対する引数として第一に使用される定数を返します。この引数が&searchsetメソッドに渡された時、key/valueペアにおける値はレコードカウントを示します。&uniquekeysでは matchingvaluesメソッドと共に用いることができません。

エクスポート¶

&duplicatekeys &incrementkeys &uniquepairs &uniquekeys

作者¶

Jim Schueler, <jschueler@tqis.com>

翻訳者¶

三浦真磁 <snj@users.sourceforge.jp>

参考文献¶

Storable BerkeleyDB http://www.sleepycat.com