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