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