Prepare for 1.0020
[dbsrgits/DBM-Deep.git] / Changes
1 Revision history for DBM::Deep (ordered by revision number).
2
3 1.0020 Feb 16 22:00:00 2010 EST
4     (This version is compatible with 1.0016)
5         - Fixed t/43_transaction_maximum.t so that it doesn't error out on systems
6       which cannot fork > 255 children at one time.
7     - Improved code coverage
8         - Added t/96_virtual_functions.t which helps describe what actually
9           needs to be overridden in a new plugin.
10     
11
12 1.0019_003 Feb 16 22:00:00 2010 EST
13     (This is the third developer release for 1.0020.)
14     (This version is compatible with 1.0016)
15         - Fixed problem where "./Build test" wouldn't actually -do- anything.
16         - (No-one apparently tried to install this till Steven Lembark. Thanks!)
17     - Fixed speed regression with keys in the File backend.
18         - Introduced in 1.0019_002 to fix #50541
19         - Thanks, SPROUT!
20     - (RT #53575) Recursion failure in STORE (Thanks, SPROUT)
21     - Merged the rest of the fixes from 1.0015 and 1.0016
22         - Thanks to our new co-maintainer, SPROUT! :)
23     - Had to turn off singleton support in the File backend because the caching
24       was causing havoc with transactions. Turning on fatal warnings does give
25       apparently important information.
26     - Oh - forgot to mention that fatal warnings are now on in all files.
27
28 1.0019_002 Jan 05 22:30:00 2010 EST
29     (This is the second developer release for 1.0020.)
30     (This version is compatible with 1.0014)
31         - Fixed bug where attempting to store a value tied to something other than
32       DBM::Deep would leave the file flocked.
33         - Added support for DBD::SQLite
34         - Build.PL has been extended to support sqlite vs. mysql
35         - Storage::DBI now detects between the two DBDs
36     - (RT #51888) Applied POD patch (Thanks, FWIE!)
37     - (RT #44981) Added VERSION to ::Array, ::Engine, and ::Hash
38     - Removed extraneous slashes from POD links (Thanks ilmari!)
39     - (RT #50541) Fixed bug in clear() for hashes in the File backend.
40         - This has caused a regression in speed for clear() when clearing
41           large hashes using running with the File backend. ->clear() (on my
42           machine) now takes ( N / 40 ) ** (1.66) seconds. So, clearing 4000
43           keys (as is the test in t/03_bighash.t) would take ~2070 seconds.
44     - (RT #40782) Fixed bug when handling a key of '0' (Thanks Sterling!)
45     - (RT #48031) Fixed bug with localized $, (Thanks, SPROUT!)
46
47 1.0019_001 Dec 31 22:00:00 2009 EST
48     (This is the first developer release for 1.0020.)
49     (This version is compatible with 1.0014)
50         - DBM::Deep has been refactored to allow for multiple engines. There are two
51       engines built so far:
52         - File (the original engine)
53         - DBI (an engine based on DBI)
54     - The DBI engine has only been tested on MySQL and isn't transactional.
55         - InnoDB sucks horribly. When run in a sufficient isolation mode, it
56           creates deadlocks. 
57     - A custom Build.PL has been written to allow for running tests under
58       CPAN.pm against the various engines.
59         - This also allows running the long tests under CPAN.pm
60     - This has meant a ton of refactoring. Hopefullly, this refactoring will
61       allow finding some of the niggly bugs more easily. Those tests have not
62       been enabled yet. That's the next developer release.
63     - Hopefully, this multi-engine support will allow deprecation of the file
64       format in the future.
65
66 1.0016 Feb 05 22:10:00 2010 PST
67     - (This version is compatible with 1.0015)
68     - New caveat in the docs explaining stale references (RT#42129)
69     - All included modules now have the same version in META.yml, so
70       the CPAN shell will no longer try to downgrade.
71     - Fixed bug in clear() for hashes (RT#50541)
72
73 1.0015 Jan 25 22:05:00 2010 PST
74     - (This version is compatible with 1.0014)
75     - Fix deep recursion errors (RT#53575)
76     - Avoid leaving temp files lying around (RT#32462)
77     - (RT #48031) Fixed bug with localized $, (Thanks, SPROUT!)
78
79 1.0014 Jun 13 23:15:00 2008 EST
80     - (This version is compatible with 1.0013)
81     - Fix for RT#36781 (t/44 has an unrequired dependency)
82     - lock() has been aliased to lock_exclusive(). There is now
83       a lock_shared() method. The :flock constants are no longer
84       imported into the DBM::Deep namespace.
85       **** THIS IS AN API CHANGE ****
86
87 1.0013 Jun 13 23:15:00 2008 EST
88     - (This version is compatible with 1.0012)
89     - Fix for RT#30144 (Optimization failure on Win32)
90     - Fixed a bug in reindex_entry (Thanks, Wulfram Humann!)
91
92 1.0012 Jun 09 15:00:00 2008 EST
93     - (This version is compatible with 1.0011)
94     - Fix for RT#30085 (Remove dependency on XS module)
95         - Thank you very much tachyon-II@Perlmonks!!
96         - This also resolves RT#35424 (DBM::Deep breaks XML::Twig).
97     - Updated the POD with fixes that were made, but still on the TODO list.
98     - Bypass for RT#36419 (t/44_upgrade_db.t fails on *BSD)
99         - We're just going to skip that for now. It's a number-of-processes-open
100         issue. Best is to do a port to another module to do the heavy lifting.
101
102 1.0011 May 27 15:00:00 2008 EST
103     - (This version is compatible with 1.0010)
104     - A test has the wrong plan.
105
106 1.0010 May 27 12:00:00 2008 EST
107     - (This version is compatible with 1.0009)
108     - Fix for RT#35140 (invalid POD links)
109     - Fix for RT#34819 (Cannot assign the same value back to the same location)
110     - Fix for RT#29957 (Cannot assign the same value back to the same location)
111     - Fix for RT#33863 (Cannot shift an arrayref from an array)
112     - When something is deleted from a DB, the value is export()ed, allowing it
113       to be saved.
114       - This exporting is only done if the refcount == 0 after the deletion.
115
116 1.0009 Mar 19 12:00:00 2008 EDT
117     - (This version is compatible with 1.0008)
118     - Internal refactorings to prepare for some optimizations.
119         - _fh() has been removed. It was marked as private, so don't complain.
120     - Skip a test that was spuriously failing on Win32 (Thanks, Alias!)
121
122 1.0008 Mar 09 20:00:00 2008 EDT
123     - (This version is compatible with 1.0007)
124     - Fixed a number of Win32 issues (Reported by Steven Samelson - thank you!)
125         - Much thanks to Nigel Sandever and David Golden for their help
126           debugging the issues, particularly with DBM::Deep's usage of
127           File::Temp (which removes a number of warnings).
128         - Autovivification now works on Win32. It turns out that when a
129           process takes a shared flock on a file, it's not allowed to write to
130           it under Win32, unlike *nix. This is probably a good catch.
131             - Note: The fix is a hack. All locks are now exclusive until a
132               better fix is found.
133
134 1.0007 Jan 10 00:00:00 2008 EDT
135     - (This version is compatible with 1.0006)
136     - Applied a patch+failing test submitted by sprout@cpan.org. Thanks!
137       - Turns out that the case of 17 keys with the same first character in the
138         MD5 hash wasn't being tested for. This was a crashbug.
139     - A fix has been made to upgrade_db.pl (RT# 30067)
140       - The version determinations were in the wrong order or evaluation. This
141         meant that upgrade_db.pl wouldn't work as expected (or at all).
142     - Added a minimum Pod::Usage requirement (RT# 29976)
143       - It's an optional item in Build.PL
144       - utils/upgrade_db.pl now checks for that version, as does the test.
145
146 1.0006 Oct 01 23:15:00 2007 EDT
147     - (This version is compatible with 1.0005)
148     - Removed Clone and replaced it with a hand-written datastructure walker.
149       - This greatly reduces the footprint of a large import
150       - This bypasses a failure of Clone under Perl 5.9.5
151       - Moved t/37_delete_edge_cases.t to t_attic because it wasn't really used
152     - import() has a stricter API now. This is a potentially incompatible API
153       change. Only HASH and ARRAY refs are now allowed and they must match the type
154       of the object being imported into.
155
156 1.0005 Oct 01 11:15:00 2007 EDT
157     - (This version is compatible with 1.0004)
158     - Added proper singleton support. This means that the following now works:
159         $db->{foo} = [ 1 .. 3];
160         my $x = $db->{foo};
161         my $y = $db->{foo};
162         is( $x, $y ); # Now passes
163       - This means that Data::Dumper now properly reports when $db->{foo} = $db->{bar}
164
165 1.0004 Sep 28 12:15:00 2007 EDT
166     - (This version is compatible with 1.0003)
167     - Fixed the Changes file (wrong version was displayed for 1.0003)
168     - Added filter sugar methods to be more API-compatible with other DBMs
169       - This was added to support a patch provided to IO::All so it can
170         use DBM::Deep as a DBM provider.
171     - Implemented _dump_file in order to display the file structure. As a
172       result, the following bugs were fixed:
173       - Arrays and hashes now clean up after themselves better.
174       - Bucketlists now clean up after themselves better.
175       - Reindexing properly clears the old bucketlist before freeing it.
176
177 1.0003 Sep 24 14:00:00 2007 EDT
178     - THIS VERSION IS INCOMPATIBLE WITH FILES FROM ALL OTHER PRIOR VERSIONS.
179     - Further fixes for unshift/shift/splice and references (RT# 29583)
180     - To fix that, I had to put support for real references in.
181       - the 16 and 22 tests are now re-enabled.
182       - Yes, this means that real references work. See t/45_references.t
183
184 1.0002 Sep 20 22:00:00 2007 EDT
185     - (This version is compatible with 1.0001)
186     - Expanded _throw_error() so that it provides better information.
187       (Thanks brian d foy!)
188     - Fixed how shift, unshift, and splice work when there are references
189       being moved. It now no longer dies.
190     - Added diag in t/17_import.t to note that the failing tests on blead
191       are due to Clone being broken, not DBM::Deep. The tests will still
192       fail because I don't want users to install something that's broken
193       and deal with those bug reports.
194
195 1.0001 Mar 12 16:15:00 2007 EDT
196     - (This version is compatible with 1.0000)
197     - Added a missing dependency on IO::Scalar (RT #25387)
198     - Fixed how t/44_upgrade_db.t and utils/upgrade_db.pl worked
199       - utils/upgrade_db.pl now uses #!perl, not #!/usr/bin/perl
200       - t/44_upgrade_db.t now explicitly calls $^X
201         (Thanks merlyn!)
202
203 1.0000 Feb 26 22:30:00 2007 EST
204     - THIS VERSION IS INCOMPATIBLE WITH FILES FROM ALL OTHER PRIOR VERSIONS.
205       - To aid in this form of upgrades, DBM::Deep now checks the file format
206         version to make sure that it knows how to read it.
207       - db_upgrade.pl was added to utils/. This will -NOT- install onto
208         your system. This is deliberate.
209       - db_upgrade.pl will not handle developer release file formats. This
210         is due to the fact that all developer releases in preparation for a
211         given release share the same file version, even though the file
212         format may change. This is deliberate.
213     - Importing no longer takes place within a transaction
214     - The following parameters were added:
215       - data_sector_size - this determines the default size of a data sector.
216     - Correctly handle opening readonly files
217
218 0.99_04 Jan 24 22:30:00 2007 EST
219     - Added the missing lib/DBM/Deep.pod file to the MANIFEST
220     - Fixed a poorly-designed test that was failing depending on what Clone::Any
221       was using.
222     - All "use 5.6.0;" lines are now "use 5.006_000;" to avoid warnings about
223       unsupported vstrings in 5.9.x
224
225 0.99_03 Jan 23 22:30:00 2007 EST
226     - THIS VERSION IS INCOMPATIBLE WITH FILES FROM ALL OTHER PRIOR VERSIONS.
227       - The fileformat changed completely. I will be writing a converter, but
228         it's not there right now. Do NOT expect that this module will
229         correctly detect older versions and handle them sanely. Sanity will be
230         there for 1.00, but we're not there yet, are we?
231     - Converted to use FileHandle::Fmode to handle filehandle status checks
232     - Fixed bug with deleting already-deleted items on Win32 (reported by Nigel Sandever)
233     - The guts of how transactions work has been rewritten to better handle
234       some edgecases. This required a complete rewrite of the engine.
235     - Freespace management is now in place. It's not perfect, but it's there.
236     - The rewrite of the engine required a rewrite of how first_key/next_key
237       was implemented. This should result in significant speed improvements.
238     - Self-reference has been removed. This means you cannot do:
239           $db->{foo} = { x => 'y' };
240           $db->{bar} = $db->{foo};
241       I hope to be able to return this functionality by 1.00, but I cannot
242       promise anything. To do this properly, it requires refcounting in order
243       to correctly handle deletions and transactions. Once you move away from
244       a simple tree, everything becomes really hard.
245
246 0.99_02 Apr 28 05:00:00 2006 Pacific
247     - Added missing file to the MANIFEST
248
249 0.99_01 Apr 27 18:00:00 2006 Pacific
250     - Added explicit dependency on Perl 5.6.0
251       - Digest::MD5 requires 5.6.0
252       - Sub::Uplevel (dep of Test::Exception) requires 5.6.0
253     - Removed error()/clear_error()
254       - All error-handling is done with die()
255     - Broke out DBM::Deep's code into DBM::Deep::Engine
256     - Tied variables can no longer be assigned to a DBM::Deep object.
257       - This includes cross-file assignments.
258     - Autovivification now works
259       - This is a consequence of the fact that all assignments are tied.
260     - set_pack() and set_digest() have been removed.
261       - Instead, you will now pass the appropriate values into new()
262       - A pack_size parameter has been added to make 64-bit files easier
263     - Transactions now work
264
265 0.983 Apr 10 20:00:00 2006 Pacific
266     - Added patch inspired by Jeff Janes (Thanks!)
267       - Autovivification now works correctly
268       - The following now works correctly
269         my %hash = ( a => 1 );
270         $db->{hash} = \%hash;
271         $hash{b} = 2;
272         cmp_ok( $db->{hash}{b}, '==', 2 );
273     - (RT#18530) - DBM::Deep now plays nicely with -l
274
275 0.982 Mar 08 11:00:00 2006 Pacific
276     - Fixed smoketests that were failing on Win32
277     - Added restriction for Perl 5.6.0 or higher.
278       - Digest::MD5 and Sub::Uplevel (dep of Test::Exception) require 5.6+
279
280 0.981 Mar 06 11:00:00 2006 Pacific
281     - (RT#17947) - Fixed test that was failing on older Perls
282
283 0.98  Feb 28 11:00:00 2006 Pacific
284     - Added in patch by David Cantrell to allow use of DATA filehandle
285     - Fixed bug where attempting to export() a structure that used autobless would die
286     - Fixed arraytest slowness by localizing $SIG{__DIE__} to prevent Test::Builder's
287       $SIG{__DIE__} from being called. (q.v. http://perldoc.perl.org/functions/eval.html)
288     - More methods have been made private:
289         - root() is now _root()
290         - base_offset() is now _base_offset()
291         - fh() is now _fh()
292         - type() is now _type()
293         - precalc_sizes() is now _precalc_sizes()
294
295 0.97  Feb 24 10:00:00 2006 Pacific
296     - Reorganization of distribution to a more standard layout
297     - Migration to Module::Build with EU::MM backwards compatibility
298     - Migration of all tests to use Test::More and Test::Exception
299     - Added Devel::Cover report to DBM::Deep POD
300       - Test coverage improved to 89.6% (and climbing)
301     - The following methods have been renamed to reflect their private nature:
302         - init() is now _init()
303         - open() is now _open()
304         - close() is now _close()
305         - load_tag() is now _load_tag()
306         - index_lookup() is now _index_lookup()
307         - add_bucket() is now _add_bucket()
308         - get_bucket_value() is now _get_bucket_value()
309         - delete_bucket() is now _delete_bucket()
310         - bucket_exists() is now _bucket_exists()
311         - find_bucket_list() is now _find_bucket_list()
312         - traverse_index() is now _traverse_index()
313         - get_next_key() is now _get_next_key()
314         - copy_node() is now _copy_node()
315         - throw_error() is now _throw_error()
316     - The various tied classes have been broken out. This means that testing
317         "ref( $obj ) eq 'DBM::Deep'" will now fail. The correct test is
318         "eval { $obj->isa( 'DBM::Deep' ) }".
319     - The various methods like push and delete now have the same return values as
320       the standard builtins.
321     - TIEARRAY and TIEHASH now check their parameters more thoroughly
322     - Negative indices for arrays works as expected, including throwing the appropriate
323       errors.
324     - RT #16877 is fixed (DBM::Deep broken with Perl 5.9.3+).
325     - RT #14893 is fixed (tie() and new() use different parameter lists).
326     - A bug with optimize and threading is fixed.
327     - autobless has received some attention, resulting in a number of bugs fixed.
328     - Removed mode option as it just caused confusion.
329     - Removed volatile option as it is pretty useless (use locking instead)
330     - Locking now implicitly enables autoflush
331
332 0.96  Oct 14 09:55:00 2005 Pacific
333     - Fixed build (OS X hidden files killed it)
334     - You can now pass in an optional filehandle to the constructor
335
336 0.95  Oct 12 13:58:00 2005 Pacific
337     - Added optional autobless flag to preserve and restore blessed hashes
338     - Fixed bug where 0 could not be fetched using get_next_key
339     - Fixed bug where tie() constructor didn't accept a hash ref for args
340     - optimize() now preserves user/group/permissions
341     - Errors are now FATAL (meaning it calls die()), unless you set debug flag
342
343 0.94  Apr 13 19:00:26 2004 Pacific
344     - Fixed bug reported by John Cardenas (corruption at key level when
345          replace of less data was done on bucket)
346
347 0.93  Feb 15 19:53:17 2004 Pacific
348     - Fixed optmize() on Win32 where orig file couldn't be overwritten unless
349          filehandle was closed first.  This change introduces a potential race
350          condition when using locking and optmize() on Win32, but it can be 
351          fixed in the future using a soft copy instead of Perl's rename().
352
353 0.92  Feb 12 19:10:22 2004 Pacific
354     - Fixed bug where passing a reference to a different DBM::Deep object
355          would still result in an internal reference.
356     - Added export() method for recursively extracting hashes/arrays into
357          standard in-memory Perl structures.
358     - Added import() method for recursively importing existing Perl hash/
359          array structures
360     - Fixed bug where optimize() wouldn't work if base level of DB was
361          an array instead of a hash.
362
363 0.91  Feb 12 02:30:22 2004 Pacific
364     - Fixed bug with splice() when length of removed section was 0
365     - Updated POD re: circular refs and optimize()
366     - Had to jump version numbers to 0.91 because in previous releases
367          I used only a single digit after the decimal which was confusing
368          the CPAN indexer.
369
370 0.10  Feb 11 08:58:35 2004 Pacific
371     - Fixed bug where default file mode was CLEARING files (Thanks Rich!)
372     - Added experimental support for circular references
373     - Fixed bugs in shift(), unshift() and splice() where nested objects
374         in array would be recursively re-stored as basic hashes/arrays
375     - Fixed typos in POD docs
376
377 0.9   Feb 10 03:25:48 2004 Pacific
378     - Added Filters for storing/fetching keys/values
379     - Added hook for supplying own hashing algorithm
380     - FIxed some typos in POD docs, added new sections
381
382 0.8   Feb 8 02:38:22 2004 Pacific
383     - Renamed to DBM::Deep for CPAN
384     - Added optimize() method for rekindling unused space
385     - Now returning hybrid tie()/OO object from new()
386     - Basic error handling introduced
387     - Added debug mode for printing errors to STDERR
388     - Added TYPE_HASH and TYPE_ARRAY constants for "type" param
389     - Added clone() method for safe copying of objects
390     - Wrote POD documentation
391     - Added set_pack() function for manipulating LONG_SIZE / LONG_PACK
392     - Added aliases for most tied functions for public use
393     - Now setting binmode() on FileHandle for Win32
394     - Added 45 unit tests
395
396 0.7   Jan 4 11:31:50 2003 UTC
397     - Renamed to DeepDB
398     - Changed file signature to DPDB (not compatible with older versions)
399     - Converted array length to packed long instead of sprintf()ed string
400
401 0.6   Dec 31 15:12:03 2002 UTC
402     - Some misc optimizations for speed
403
404 0.5   Oct 18 08:55:29 2002 UTC
405     - support for force_return_next parameter in traverse_index() method for 
406       ultra-fast combined key search/removal
407
408 0.4   Oct 15 20:07:47 2002 UTC
409     - now making sure filehandle is open for all DB calls
410
411 0.3   Oct 3 19:04:13 2002 UTC
412     - fixed bug that could cause corrupted data when using locking
413
414 0.2   Aug 6 16:37:32 2002 UTC
415     - Removed base index caching, as it can cause problems when two processes 
416       are populating the db at the same time (even with locking)
417
418 0.1   Jun 3 08:06:26 2002 UTC
419     - initial release