1 package DBIx::Class::Storage::DBI::SQLite;
6 use base qw/DBIx::Class::Storage::DBI/;
9 use DBIx::Class::_Util qw(modver_gt_or_eq sigwarn_silencer is_plain_value);
10 use DBIx::Class::Carp;
14 __PACKAGE__->sql_maker_class('DBIx::Class::SQLMaker::SQLite');
15 __PACKAGE__->sql_limit_dialect ('LimitOffset');
16 __PACKAGE__->sql_quote_char ('"');
17 __PACKAGE__->datetime_parser_type ('DateTime::Format::SQLite');
21 DBIx::Class::Storage::DBI::SQLite - Automatic primary key class for SQLite
25 # In your table classes
26 use base 'DBIx::Class::Core';
27 __PACKAGE__->set_primary_key('id');
31 This class implements autoincrements for SQLite.
39 NOTE - This section applies to you only if ALL of these are true:
41 * You are or were using DBD::SQLite with a version lesser than 1.38_01
43 * You are or were using DBIx::Class versions between 0.08191 and 0.08209
44 (inclusive) or between 0.08240-TRIAL and 0.08242-TRIAL (also inclusive)
46 * You use objects with overloaded stringification and are feeding them
47 to DBIC CRUD methods directly
49 An unfortunate chain of events led to DBIx::Class silently hitting the problem
50 described in L<RT#79576|https://rt.cpan.org/Public/Bug/Display.html?id=79576>.
52 In order to trigger the bug condition one needs to supply B<more than one>
53 bind value that is an object with overloaded stringification (numification
54 is not relevant, only stringification is). When this is the case the internal
55 DBIx::Class call to C<< $sth->bind_param >> would be executed in a way that
56 triggers the above-mentioned DBD::SQLite bug. As a result all the logs and
57 tracers will contain the expected values, however SQLite will receive B<all>
58 these bind positions being set to the value of the B<last> supplied
61 Even if you upgrade DBIx::Class (which works around the bug starting from
62 version 0.08210) you may still have corrupted/incorrect data in your database.
63 DBIx::Class will currently detect when this condition (more than one
64 stringifiable object in one CRUD call) is encountered and will issue a warning
65 pointing to this section. This warning will be removed 2 years from now,
66 around April 2015, You can disable it after you've audited your data by
67 setting the C<DBIC_RT79576_NOWARN> environment variable. Note - the warning
68 is emitted only once per callsite per process and only when the condition in
69 question is encountered. Thus it is very unlikely that your logsystem will be
70 flooded as a result of this.
84 my ($self, $dir) = @_;
87 ## Where is the db file?
88 my $dsn = $self->_dbi_connect_info()->[0];
90 my $dbname = $1 if($dsn =~ /dbname=([^;]+)/);
93 $dbname = $1 if($dsn =~ /^dbi:SQLite:(.+)$/i);
95 $self->throw_exception("Cannot determine name of SQLite db file")
96 if(!$dbname || !-f $dbname);
98 # print "Found database: $dbname\n";
99 # my $dbfile = file($dbname);
100 my ($vol, $dbdir, $file) = File::Spec->splitpath($dbname);
101 # my $file = $dbfile->basename();
102 $file = POSIX::strftime("%Y-%m-%d-%H_%M_%S", localtime()) . $file;
103 $file = "B$file" while(-f $file);
105 mkdir($dir) unless -f $dir;
106 my $backupfile = File::Spec->catfile($dir, $file);
108 my $res = File::Copy::copy($dbname, $backupfile);
109 $self->throw_exception("Backup failed! ($!)") if(!$res);
114 sub _exec_svp_begin {
115 my ($self, $name) = @_;
117 $self->_dbh->do("SAVEPOINT $name");
120 sub _exec_svp_release {
121 my ($self, $name) = @_;
123 $self->_dbh->do("RELEASE SAVEPOINT $name");
126 sub _exec_svp_rollback {
127 my ($self, $name) = @_;
129 $self->_dbh->do("ROLLBACK TO SAVEPOINT $name");
132 # older SQLite has issues here too - both of these are in fact
133 # completely benign warnings (or at least so say the tests)
134 sub _exec_txn_rollback {
135 local $SIG{__WARN__} = sigwarn_silencer( qr/rollback ineffective/ )
136 unless $DBD::SQLite::__DBIC_TXN_SYNC_SANE__;
138 shift->next::method(@_);
141 sub _exec_txn_commit {
142 local $SIG{__WARN__} = sigwarn_silencer( qr/commit ineffective/ )
143 unless $DBD::SQLite::__DBIC_TXN_SYNC_SANE__;
145 shift->next::method(@_);
151 # Be extremely careful what we do here. SQLite is notoriously bad at
152 # synchronizing its internal transaction state with {AutoCommit}
153 # https://metacpan.org/source/ADAMK/DBD-SQLite-1.37/lib/DBD/SQLite.pm#L921
154 # There is a function http://www.sqlite.org/c3ref/get_autocommit.html
155 # but DBD::SQLite does not expose it (nor does it seem to properly use it)
157 # Therefore only execute a "ping" when we have no other choice *AND*
158 # scrutinize the thrown exceptions to make sure we are where we think we are
159 my $dbh = $self->_dbh or return undef;
160 return undef unless $dbh->FETCH('Active');
161 return undef unless $dbh->ping;
165 # older DBD::SQLite does not properly synchronize commit state between
166 # the libsqlite and the $dbh
167 unless (defined $DBD::SQLite::__DBIC_TXN_SYNC_SANE__) {
168 $DBD::SQLite::__DBIC_TXN_SYNC_SANE__ = modver_gt_or_eq('DBD::SQLite', '1.38_02');
171 # fallback to travesty
172 unless ($DBD::SQLite::__DBIC_TXN_SYNC_SANE__) {
173 # since we do not have access to sqlite3_get_autocommit(), do a trick
174 # to attempt to *safely* determine what state are we *actually* in.
176 # also using T::T here leads to bizarre leaks - will figure it out later
177 my $really_not_in_txn = do {
180 # older versions of DBD::SQLite do not properly detect multiline BEGIN/COMMIT
181 # statements to adjust their {AutoCommit} state. Hence use such a statement
182 # pair here as well, in order to escape from poking {AutoCommit} needlessly
183 # https://rt.cpan.org/Public/Bug/Display.html?id=80087
185 # will fail instantly if already in a txn
186 $dbh->do("-- multiline\nBEGIN");
187 $dbh->do("-- multiline\nCOMMIT");
190 ($@ =~ /transaction within a transaction/)
197 # if we were unable to determine this - we may very well be dead
198 if (not defined $really_not_in_txn) {
201 # check the AC sync-state
202 elsif ($really_not_in_txn xor $dbh->{AutoCommit}) {
204 'Internal transaction state of handle %s (apparently %s a transaction) does not seem to '
205 . 'match its AutoCommit attribute setting of %s - this is an indication of a '
206 . 'potentially serious bug in your transaction handling logic',
208 $really_not_in_txn ? 'NOT in' : 'in',
209 $dbh->{AutoCommit} ? 'TRUE' : 'FALSE',
212 # it is too dangerous to execute anything else in this state
213 # assume everything works (safer - worst case scenario next statement throws)
218 # do the actual test and return on no failure
219 ( $ping_fail ||= ! try { $dbh->do('SELECT * FROM sqlite_master LIMIT 1'); 1 } )
220 or return 1; # the actual RV of _ping()
222 # ping failed (or so it seems) - need to do some cleanup
223 # it is possible to have a proper "connection", and have "ping" return
224 # false anyway (e.g. corrupted file). In such cases DBD::SQLite still
225 # keeps the actual file handle open. We don't really want this to happen,
226 # so force-close the handle via DBI itself
228 local $@; # so that we do not clobber the real error as set above
229 eval { $dbh->disconnect }; # if it fails - it fails
230 undef; # the actual RV of _ping()
233 sub deployment_statements {
235 my ($schema, $type, $version, $dir, $sqltargs, @rest) = @_;
240 ! exists $sqltargs->{producer_args}{sqlite_version}
242 my $dver = $self->_server_info->{normalized_dbms_version}
244 $sqltargs->{producer_args}{sqlite_version} = $dver;
247 $sqltargs->{quote_identifiers}
248 = !!$self->sql_maker->_quote_chars
249 if ! exists $sqltargs->{quote_identifiers};
251 $self->next::method($schema, $type, $version, $dir, $sqltargs, @rest);
254 sub bind_attribute_by_data_type {
256 # According to http://www.sqlite.org/datatype3.html#storageclasses
257 # all numeric types are dynamically allocated up to 8 bytes per
259 # Thus it should be safe and non-wasteful to bind everything as
260 # SQL_BIGINT and have SQLite deal with storage/comparisons however
262 $_[1] =~ /^ (?: int(?:[1248]|eger)? | (?:tiny|small|medium|big)int ) $/ix
268 # FIXME - what the flying fuck... work around RT#76395
269 # DBD::SQLite warns on binding >32 bit values with 32 bit IVs
273 DBIx::Class::_ENV_::IV_SIZE < 8
275 DBIx::Class::_ENV_::OS_NAME eq 'MSWin32'
278 ! defined $DBD::SQLite::__DBIC_CHECK_dbd_mishandles_bound_BIGINT
280 $DBD::SQLite::__DBIC_CHECK_dbd_mishandles_bound_BIGINT = (
281 modver_gt_or_eq('DBD::SQLite', '1.37')
285 local $SIG{__WARN__} = sigwarn_silencer( qr/
286 \Qdatatype mismatch: bind\E \s (?:
287 param \s+ \( \d+ \) \s+ [-+]? \d+ (?: \. 0*)? \Q as integer\E
289 \d+ \s type \s @{[ DBI::SQL_BIGINT() ]} \s as \s [-+]? \d+ (?: \. 0*)?
293 DBIx::Class::_ENV_::IV_SIZE < 8
295 DBIx::Class::_ENV_::OS_NAME eq 'MSWin32'
298 $DBD::SQLite::__DBIC_CHECK_dbd_mishandles_bound_BIGINT
301 shift->next::method(@_);
304 # DBD::SQLite (at least up to version 1.31 has a bug where it will
305 # non-fatally numify a string value bound as an integer, resulting
306 # in insertions of '0' into supposed-to-be-numeric fields
307 # Since this can result in severe data inconsistency, remove the
308 # bind attr if such a situation is detected
310 # FIXME - when a DBD::SQLite version is released that eventually fixes
311 # this situation (somehow) - no-op this override once a proper DBD
312 # version is detected
313 sub _dbi_attrs_for_bind {
314 my ($self, $ident, $bind) = @_;
316 my $bindattrs = $self->next::method($ident, $bind);
318 if (! defined $DBD::SQLite::__DBIC_CHECK_dbd_can_bind_bigint_values) {
319 $DBD::SQLite::__DBIC_CHECK_dbd_can_bind_bigint_values
320 = modver_gt_or_eq('DBD::SQLite', '1.37') ? 1 : 0;
323 # an attempt to detect former effects of RT#79576, bug itself present between
324 # 0.08191 and 0.08209 inclusive (fixed in 0.08210 and higher)
325 my $stringifiable = 0;
327 for my $i (0.. $#$bindattrs) {
329 $stringifiable++ if ( length ref $bind->[$i][1] and is_plain_value($bind->[$i][1]) );
332 defined $bindattrs->[$i]
334 defined $bind->[$i][1]
336 grep { $bindattrs->[$i] eq $_ } (
337 DBI::SQL_INTEGER(), DBI::SQL_TINYINT(), DBI::SQL_SMALLINT(), DBI::SQL_BIGINT()
340 if ( $bind->[$i][1] !~ /^ [\+\-]? [0-9]+ (?: \. 0* )? $/x ) {
341 carp_unique( sprintf (
342 "Non-integer value supplied for column '%s' despite the integer datatype",
343 $bind->[$i][0]{dbic_colname} || "# $i"
345 undef $bindattrs->[$i];
348 ! $DBD::SQLite::__DBIC_CHECK_dbd_can_bind_bigint_values
350 # unsigned 32 bit ints have a range of −2,147,483,648 to 2,147,483,647
351 # alternatively expressed as the hexadecimal numbers below
352 # the comparison math will come out right regardless of ivsize, since
353 # we are operating within 31 bits
354 # P.S. 31 because one bit is lost for the sign
355 if ($bind->[$i][1] > 0x7fff_ffff or $bind->[$i][1] < -0x8000_0000) {
356 carp_unique( sprintf (
357 "An integer value occupying more than 32 bits was supplied for column '%s' "
358 . 'which your version of DBD::SQLite (%s) can not bind properly so DBIC '
359 . 'will treat it as a string instead, consider upgrading to at least '
360 . 'DBD::SQLite version 1.37',
361 $bind->[$i][0]{dbic_colname} || "# $i",
362 DBD::SQLite->VERSION,
364 undef $bindattrs->[$i];
367 $bindattrs->[$i] = DBI::SQL_INTEGER()
374 'POSSIBLE *PAST* DATA CORRUPTION detected - see '
375 . 'DBIx::Class::Storage::DBI::SQLite/RT79576 or '
376 . 'http://v.gd/DBIC_SQLite_RT79576 for further details or set '
377 . '$ENV{DBIC_RT79576_NOWARN} to disable this warning. Trigger '
378 . 'condition encountered'
379 ) if (!$ENV{DBIC_RT79576_NOWARN} and $stringifiable > 1);
384 =head2 connect_call_use_foreign_keys
388 on_connect_call => 'use_foreign_keys'
390 In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to turn on foreign key
391 (including cascading) support for recent versions of SQLite and L<DBD::SQLite>.
395 PRAGMA foreign_keys = ON
397 See L<http://www.sqlite.org/foreignkeys.html> for more information.
401 sub connect_call_use_foreign_keys {
405 'PRAGMA foreign_keys = ON'
411 =head1 AUTHOR AND CONTRIBUTORS
413 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
417 You may distribute this code under the same terms as Perl itself.