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