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