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