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