[ViewVC] Diff of: cvs/BDB/README

Comparing BDB/README (file contents):
Revision 1.4 by root, Fri Dec 7 13:39:04 2007 UTC vs.
Revision 1.8 by root, Sun Mar 30 08:01:59 2008 UTC

      db_put $db, undef, "key", "data", 0, sub {
         db_del $db, undef, "key";
      };
      db_sync $db;
+     # when you also use Coro, management is easy:
+     use Coro::BDB;
      # automatic result processing with AnyEvent:
      our $FH; open $FH, "<&=" . BDB::poll_fileno;
      our $WATCHER = AnyEvent->io (fh => $FH, poll => 'r', cb => \&BDB::poll_cb);
      # automatic result processing with EV:
         Request has reached the end of its lifetime and holds no resources
         anymore (except possibly for the Perl object, but its connection to
         the actual aio request is severed and calling its methods will
         either do nothing or result in a runtime error).
+  WIN32 FILENAMES/DATABASE NAME MESS
+    Perl on Win32 supports only ASCII filenames (the reason is that it
+    abuses an internal flag to store wether a filename is Unicode or ANSI,
+    but that flag is used for somethign else in the perl core, so there is
+    no way to detect wether a filename is ANSI or Unicode-encoded). The BDB
+    module tries to work around this issue by assuming that the filename is
+    an ANSI filename and BDB was built for unicode support.
   BERKELEYDB FUNCTIONS
     All of these are functions. The create functions simply return a new
-    object and never block. All the remaining functions all take an optional
+    object and never block. All the remaining functions take an optional
-    callback as last argument. If it is missing, then the fucntion will be
+    callback as last argument. If it is missing, then the function will be
-    executed synchronously.
+    executed synchronously. In both cases, $! will reflect the return value
+    of the function.
     BDB functions that cannot block (mostly functions that manipulate
     settings) are method calls on the relevant objects, so the rule of thumb
-    is: if its a method, its not blocking, if its a function, it takes a
+    is: if it's a method, it's not blocking, if it's a function, it takes a
     callback as last argument.
     In the following, $int signifies an integer return value, "octetstring"
     is a "binary string" (i.e. a perl string with no character indices
     >255), "U32" is an unsigned 32 bit integer, "int" is some integer, "NV"
        db_open (DB *db, DB_TXN_ornull *txnid, octetstring file, octetstring database, int type, U32 flags, int mode, SV *callback = &PL_sv_undef)
           flags: AUTO_COMMIT CREATE EXCL MULTIVERSION NOMMAP RDONLY READ_UNCOMMITTED THREAD TRUNCATE
        db_close (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef)
           flags: DB_NOSYNC
+       db_upgrade (DB *db, octetstring file, U32 flags = 0, SV *callback = &PL_sv_undef)
        db_compact (DB *db, DB_TXN_ornull *txn = 0, SV *start = 0, SV *stop = 0, SV *unused1 = 0, U32 flags = DB_FREE_SPACE, SV *unused2 = 0, SV *callback = &PL_sv_undef)
           flags: FREELIST_ONLY FREE_SPACE
        db_sync (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef)
        db_key_range (DB *db, DB_TXN_ornull *txn, SV *key, SV *key_range, U32 flags = 0, SV *callback = &PL_sv_undef)
        db_put (DB *db, DB_TXN_ornull *txn, SV *key, SV *data, U32 flags = 0, SV *callback = &PL_sv_undef)
        DESTROY (DBC_ornull *dbc)
                CODE:
                if (dbc)
                  dbc->c_close (dbc);
+       $int = $cursor->set_priority ($priority = PRIORITY_*)
    Example:
        my $c = $db->cursor;
        for (;;) {
           db_c_get $c, my $key, my $data, BDB::NEXT;
           flags: SEQ_DEC SEQ_INC SEQ_WRAP
        $int = $seq->set_range (db_seq_t min, db_seq_t max)
    Example:
        my $seq = $db->sequence;
-       db_sequence_open $seq, undef, "seq", BDB::CREATE;
+   db_sequence_open $seq, undef, "seq", BDB::CREATE;
        db_sequence_get $seq, undef, 1, my $value;
   SUPPORT FUNCTIONS
    EVENT PROCESSING AND EVENT LOOP INTEGRATION
+    $msg = BDB::strerror [$errno]
+        Returns the string corresponding to the given errno value. If no
+        argument is given, use $!.
+        Note that the BDB module also patches the $! variable directly, so
+        you should be able to get a bdb error string by simply stringifying
+        $!.
     $fileno = BDB::poll_fileno
         Return the *request result pipe file descriptor*. This filehandle
         must be polled for reading by some mechanism outside this module
         (e.g. Event or select, see below or the SYNOPSIS). If the pipe
         becomes readable you have to call "poll_cb" to check the results.
     In short: the parent will, after a short pause, continue as if fork had
     not been called, while the child will act as if BDB has not been used
     yet.
+    Win32 note: there is no fork on win32, and perls emulation of it is too
+    broken to be supported, so do not use BDB in a windows pseudo-fork,
+    better yet, switch to a more capable platform.
   MEMORY USAGE
     Per-request usage:
     Each aio request uses - depending on your architecture - around 100-200
     bytes of memory. In addition, stat requests need a stat buffer (possibly

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing BDB/README (file contents): Revision 1.4 by root, Fri Dec 7 13:39:04 2007 UTC vs. Revision 1.8 by root, Sun Mar 30 08:01:59 2008 UTC

Diff Legend

Comparing BDB/README (file contents):
Revision 1.4 by root, Fri Dec 7 13:39:04 2007 UTC vs.
Revision 1.8 by root, Sun Mar 30 08:01:59 2008 UTC