Slight POD correction
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Storage / DBI / SQLite.pm
CommitLineData
843f8ecd 1package DBIx::Class::Storage::DBI::SQLite;
2
3use strict;
4use warnings;
2ad62d97 5
6use base qw/DBIx::Class::Storage::DBI/;
7use mro 'c3';
8
b5ce6748 9use SQL::Abstract 'is_plain_value';
ddcc02d1 10use DBIx::Class::_Util qw(modver_gt_or_eq sigwarn_silencer dbic_internal_try);
632d1e0f 11use DBIx::Class::Carp;
8d1fb3e2 12use Try::Tiny;
632d1e0f 13use namespace::clean;
14
d5dedbd6 15__PACKAGE__->sql_maker_class('DBIx::Class::SQLMaker::SQLite');
6a247f33 16__PACKAGE__->sql_limit_dialect ('LimitOffset');
2b8cc2f2 17__PACKAGE__->sql_quote_char ('"');
6f7a118e 18__PACKAGE__->datetime_parser_type ('DateTime::Format::SQLite');
09cedb88 19
2fa97c7d 20=head1 NAME
21
22DBIx::Class::Storage::DBI::SQLite - Automatic primary key class for SQLite
23
24=head1 SYNOPSIS
25
26 # In your table classes
27 use base 'DBIx::Class::Core';
28 __PACKAGE__->set_primary_key('id');
29
30=head1 DESCRIPTION
31
32This class implements autoincrements for SQLite.
33
75a1d824 34=head2 Known Issues
35
36=over
37
38=item RT79576
39
40 NOTE - This section applies to you only if ALL of these are true:
41
42 * You are or were using DBD::SQLite with a version lesser than 1.38_01
43
44 * You are or were using DBIx::Class versions between 0.08191 and 0.08209
45 (inclusive) or between 0.08240-TRIAL and 0.08242-TRIAL (also inclusive)
46
47 * You use objects with overloaded stringification and are feeding them
48 to DBIC CRUD methods directly
49
50An unfortunate chain of events led to DBIx::Class silently hitting the problem
51described in L<RT#79576|https://rt.cpan.org/Public/Bug/Display.html?id=79576>.
52
53In order to trigger the bug condition one needs to supply B<more than one>
4a0eed52 54bind value that is an object with overloaded stringification (numification
75a1d824 55is not relevant, only stringification is). When this is the case the internal
56DBIx::Class call to C<< $sth->bind_param >> would be executed in a way that
57triggers the above-mentioned DBD::SQLite bug. As a result all the logs and
58tracers will contain the expected values, however SQLite will receive B<all>
59these bind positions being set to the value of the B<last> supplied
60stringifiable object.
61
62Even if you upgrade DBIx::Class (which works around the bug starting from
63version 0.08210) you may still have corrupted/incorrect data in your database.
cff17b97 64DBIx::Class warned about this condition for several years, hoping to give
65anyone affected sufficient notice of the potential issues. The warning was
f0c2d11f 66removed in 2015/v0.082820.
75a1d824 67
68=back
69
2fa97c7d 70=head1 METHODS
71
72=cut
73
357eb92c 74sub backup {
75
76 require File::Spec;
77 require File::Copy;
78 require POSIX;
79
8795fefb 80 my ($self, $dir) = @_;
81 $dir ||= './';
c9d2e0a2 82
83 ## Where is the db file?
12c9beea 84 my $dsn = $self->_dbi_connect_info()->[0];
c9d2e0a2 85
86 my $dbname = $1 if($dsn =~ /dbname=([^;]+)/);
87 if(!$dbname)
88 {
89 $dbname = $1 if($dsn =~ /^dbi:SQLite:(.+)$/i);
90 }
357eb92c 91 $self->throw_exception("Cannot determine name of SQLite db file")
c9d2e0a2 92 if(!$dbname || !-f $dbname);
93
94# print "Found database: $dbname\n";
79923569 95# my $dbfile = file($dbname);
8795fefb 96 my ($vol, $dbdir, $file) = File::Spec->splitpath($dbname);
79923569 97# my $file = $dbfile->basename();
357eb92c 98 $file = POSIX::strftime("%Y-%m-%d-%H_%M_%S", localtime()) . $file;
c9d2e0a2 99 $file = "B$file" while(-f $file);
8795fefb 100
101 mkdir($dir) unless -f $dir;
102 my $backupfile = File::Spec->catfile($dir, $file);
103
357eb92c 104 my $res = File::Copy::copy($dbname, $backupfile);
c9d2e0a2 105 $self->throw_exception("Backup failed! ($!)") if(!$res);
106
8795fefb 107 return $backupfile;
c9d2e0a2 108}
109
86a51471 110sub _exec_svp_begin {
111 my ($self, $name) = @_;
112
113 $self->_dbh->do("SAVEPOINT $name");
114}
115
116sub _exec_svp_release {
117 my ($self, $name) = @_;
118
119 $self->_dbh->do("RELEASE SAVEPOINT $name");
120}
121
122sub _exec_svp_rollback {
123 my ($self, $name) = @_;
124
398215b1 125 $self->_dbh->do("ROLLBACK TO SAVEPOINT $name");
86a51471 126
66c817df 127 # resync state for older DBD::SQLite (RT#67843)
128 # https://github.com/DBD-SQLite/DBD-SQLite/commit/9b3cdbf
129 if (
130 ! modver_gt_or_eq('DBD::SQLite', '1.33')
131 and
132 $self->_dbh->FETCH('AutoCommit')
133 ) {
134 $self->_dbh->STORE('AutoCommit', 0);
135 $self->_dbh->STORE('BegunWork', 1);
136 }
86a51471 137}
138
8d1fb3e2 139sub _ping {
140 my $self = shift;
2aeb3c7f 141
142 # Be extremely careful what we do here. SQLite is notoriously bad at
143 # synchronizing its internal transaction state with {AutoCommit}
144 # https://metacpan.org/source/ADAMK/DBD-SQLite-1.37/lib/DBD/SQLite.pm#L921
145 # There is a function http://www.sqlite.org/c3ref/get_autocommit.html
146 # but DBD::SQLite does not expose it (nor does it seem to properly use it)
147
148 # Therefore only execute a "ping" when we have no other choice *AND*
149 # scrutinize the thrown exceptions to make sure we are where we think we are
150 my $dbh = $self->_dbh or return undef;
151 return undef unless $dbh->FETCH('Active');
152 return undef unless $dbh->ping;
153
ab0b0a09 154 my $ping_fail;
155
156 # older DBD::SQLite does not properly synchronize commit state between
157 # the libsqlite and the $dbh
158 unless (defined $DBD::SQLite::__DBIC_TXN_SYNC_SANE__) {
b1dbf716 159 $DBD::SQLite::__DBIC_TXN_SYNC_SANE__ = modver_gt_or_eq('DBD::SQLite', '1.38_02');
ab0b0a09 160 }
2aeb3c7f 161
ab0b0a09 162 # fallback to travesty
163 unless ($DBD::SQLite::__DBIC_TXN_SYNC_SANE__) {
164 # since we do not have access to sqlite3_get_autocommit(), do a trick
165 # to attempt to *safely* determine what state are we *actually* in.
ddcc02d1 166
167 my $really_not_in_txn;
168
169 # not assigning RV directly to env above, because this causes a bizarre
170 # leak of the catch{} cref on older perls... wtf
171 dbic_internal_try {
ab0b0a09 172
173 # older versions of DBD::SQLite do not properly detect multiline BEGIN/COMMIT
174 # statements to adjust their {AutoCommit} state. Hence use such a statement
175 # pair here as well, in order to escape from poking {AutoCommit} needlessly
176 # https://rt.cpan.org/Public/Bug/Display.html?id=80087
ddcc02d1 177 #
178 # will fail instantly if already in a txn
179 $dbh->do("-- multiline\nBEGIN");
180 $dbh->do("-- multiline\nCOMMIT");
181
182 $really_not_in_txn = 1;
183 }
184 catch {
185 $really_not_in_txn = ( $_[0] =~ qr/transaction within a transaction/
186 ? 0
187 : undef
188 );
2aeb3c7f 189 };
2aeb3c7f 190
ab0b0a09 191 # if we were unable to determine this - we may very well be dead
192 if (not defined $really_not_in_txn) {
193 $ping_fail = 1;
194 }
195 # check the AC sync-state
196 elsif ($really_not_in_txn xor $dbh->{AutoCommit}) {
197 carp_unique (sprintf
198 'Internal transaction state of handle %s (apparently %s a transaction) does not seem to '
199 . 'match its AutoCommit attribute setting of %s - this is an indication of a '
200 . 'potentially serious bug in your transaction handling logic',
201 $dbh,
202 $really_not_in_txn ? 'NOT in' : 'in',
203 $dbh->{AutoCommit} ? 'TRUE' : 'FALSE',
204 );
205
206 # it is too dangerous to execute anything else in this state
207 # assume everything works (safer - worst case scenario next statement throws)
208 return 1;
209 }
2aeb3c7f 210 }
211
ab0b0a09 212 # do the actual test and return on no failure
ddcc02d1 213 ( $ping_fail ||= ! dbic_internal_try { $dbh->do('SELECT * FROM sqlite_master LIMIT 1'); 1 } )
ab0b0a09 214 or return 1; # the actual RV of _ping()
215
216 # ping failed (or so it seems) - need to do some cleanup
217 # it is possible to have a proper "connection", and have "ping" return
218 # false anyway (e.g. corrupted file). In such cases DBD::SQLite still
219 # keeps the actual file handle open. We don't really want this to happen,
220 # so force-close the handle via DBI itself
221 #
ddcc02d1 222 dbic_internal_try { $dbh->disconnect }; # if it fails - it fails
ab0b0a09 223 undef; # the actual RV of _ping()
8d1fb3e2 224}
225
2361982d 226sub deployment_statements {
96736321 227 my $self = shift;
2361982d 228 my ($schema, $type, $version, $dir, $sqltargs, @rest) = @_;
229
230 $sqltargs ||= {};
231
96736321 232 if (
233 ! exists $sqltargs->{producer_args}{sqlite_version}
234 and
235 my $dver = $self->_server_info->{normalized_dbms_version}
236 ) {
237 $sqltargs->{producer_args}{sqlite_version} = $dver;
6d766626 238 }
2361982d 239
240 $self->next::method($schema, $type, $version, $dir, $sqltargs, @rest);
241}
242
0e773352 243sub bind_attribute_by_data_type {
04ab4eb1 244
245 # According to http://www.sqlite.org/datatype3.html#storageclasses
246 # all numeric types are dynamically allocated up to 8 bytes per
247 # individual value
248 # Thus it should be safe and non-wasteful to bind everything as
249 # SQL_BIGINT and have SQLite deal with storage/comparisons however
250 # it deems correct
251 $_[1] =~ /^ (?: int(?:[1248]|eger)? | (?:tiny|small|medium|big)int ) $/ix
252 ? DBI::SQL_BIGINT()
0e773352 253 : undef
254 ;
255}
256
04ab4eb1 257# FIXME - what the flying fuck... work around RT#76395
258# DBD::SQLite warns on binding >32 bit values with 32 bit IVs
259sub _dbh_execute {
1363f0f5 260 if (
00882d2c 261 (
262 DBIx::Class::_ENV_::IV_SIZE < 8
263 or
264 DBIx::Class::_ENV_::OS_NAME eq 'MSWin32'
265 )
1363f0f5 266 and
267 ! defined $DBD::SQLite::__DBIC_CHECK_dbd_mishandles_bound_BIGINT
268 ) {
269 $DBD::SQLite::__DBIC_CHECK_dbd_mishandles_bound_BIGINT = (
270 modver_gt_or_eq('DBD::SQLite', '1.37')
271 ) ? 1 : 0;
04ab4eb1 272 }
273
1363f0f5 274 local $SIG{__WARN__} = sigwarn_silencer( qr/
275 \Qdatatype mismatch: bind\E \s (?:
276 param \s+ \( \d+ \) \s+ [-+]? \d+ (?: \. 0*)? \Q as integer\E
277 |
278 \d+ \s type \s @{[ DBI::SQL_BIGINT() ]} \s as \s [-+]? \d+ (?: \. 0*)?
279 )
00882d2c 280 /x ) if (
281 (
282 DBIx::Class::_ENV_::IV_SIZE < 8
283 or
284 DBIx::Class::_ENV_::OS_NAME eq 'MSWin32'
285 )
286 and
287 $DBD::SQLite::__DBIC_CHECK_dbd_mishandles_bound_BIGINT
288 );
1363f0f5 289
04ab4eb1 290 shift->next::method(@_);
291}
292
632d1e0f 293# DBD::SQLite (at least up to version 1.31 has a bug where it will
4a0eed52 294# non-fatally numify a string value bound as an integer, resulting
632d1e0f 295# in insertions of '0' into supposed-to-be-numeric fields
296# Since this can result in severe data inconsistency, remove the
4a0eed52 297# bind attr if such a situation is detected
632d1e0f 298#
299# FIXME - when a DBD::SQLite version is released that eventually fixes
4a0eed52 300# this situation (somehow) - no-op this override once a proper DBD
632d1e0f 301# version is detected
302sub _dbi_attrs_for_bind {
303 my ($self, $ident, $bind) = @_;
75a1d824 304
632d1e0f 305 my $bindattrs = $self->next::method($ident, $bind);
306
04ab4eb1 307 if (! defined $DBD::SQLite::__DBIC_CHECK_dbd_can_bind_bigint_values) {
215102b9 308 $DBD::SQLite::__DBIC_CHECK_dbd_can_bind_bigint_values
309 = modver_gt_or_eq('DBD::SQLite', '1.37') ? 1 : 0;
04ab4eb1 310 }
311
49f7b6c7 312 for my $i (0.. $#$bindattrs) {
632d1e0f 313 if (
49f7b6c7 314 defined $bindattrs->[$i]
632d1e0f 315 and
49f7b6c7 316 defined $bind->[$i][1]
632d1e0f 317 and
d830d9f4 318 grep { $bindattrs->[$i] eq $_ } (
319 DBI::SQL_INTEGER(), DBI::SQL_TINYINT(), DBI::SQL_SMALLINT(), DBI::SQL_BIGINT()
320 )
632d1e0f 321 ) {
04ab4eb1 322 if ( $bind->[$i][1] !~ /^ [\+\-]? [0-9]+ (?: \. 0* )? $/x ) {
323 carp_unique( sprintf (
324 "Non-integer value supplied for column '%s' despite the integer datatype",
325 $bind->[$i][0]{dbic_colname} || "# $i"
326 ) );
327 undef $bindattrs->[$i];
328 }
329 elsif (
330 ! $DBD::SQLite::__DBIC_CHECK_dbd_can_bind_bigint_values
215102b9 331 ) {
04ab4eb1 332 # unsigned 32 bit ints have a range of −2,147,483,648 to 2,147,483,647
333 # alternatively expressed as the hexadecimal numbers below
334 # the comparison math will come out right regardless of ivsize, since
335 # we are operating within 31 bits
336 # P.S. 31 because one bit is lost for the sign
215102b9 337 if ($bind->[$i][1] > 0x7fff_ffff or $bind->[$i][1] < -0x8000_0000) {
338 carp_unique( sprintf (
339 "An integer value occupying more than 32 bits was supplied for column '%s' "
340 . 'which your version of DBD::SQLite (%s) can not bind properly so DBIC '
341 . 'will treat it as a string instead, consider upgrading to at least '
342 . 'DBD::SQLite version 1.37',
343 $bind->[$i][0]{dbic_colname} || "# $i",
344 DBD::SQLite->VERSION,
345 ) );
346 undef $bindattrs->[$i];
347 }
348 else {
349 $bindattrs->[$i] = DBI::SQL_INTEGER()
350 }
04ab4eb1 351 }
632d1e0f 352 }
353 }
354
355 return $bindattrs;
356}
357
732e4282 358=head2 connect_call_use_foreign_keys
359
360Used as:
361
362 on_connect_call => 'use_foreign_keys'
363
8384a713 364In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to turn on foreign key
365(including cascading) support for recent versions of SQLite and L<DBD::SQLite>.
732e4282 366
367Executes:
368
8273e845 369 PRAGMA foreign_keys = ON
732e4282 370
371See L<http://www.sqlite.org/foreignkeys.html> for more information.
372
373=cut
374
375sub connect_call_use_foreign_keys {
376 my $self = shift;
377
378 $self->_do_query(
379 'PRAGMA foreign_keys = ON'
380 );
381}
382
a2bd3796 383=head1 FURTHER QUESTIONS?
843f8ecd 384
a2bd3796 385Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
843f8ecd 386
a2bd3796 387=head1 COPYRIGHT AND LICENSE
843f8ecd 388
a2bd3796 389This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
390by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
391redistribute it and/or modify it under the same terms as the
392L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
843f8ecd 393
394=cut
a2bd3796 395
3961;