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