1 package DBIx::Class::Storage::DBI::SQLite;
6 use base qw/DBIx::Class::Storage::DBI/;
13 __PACKAGE__->sql_maker_class('DBIx::Class::SQLMaker::SQLite');
14 __PACKAGE__->sql_limit_dialect ('LimitOffset');
15 __PACKAGE__->sql_quote_char ('"');
16 __PACKAGE__->datetime_parser_type ('DateTime::Format::SQLite');
20 DBIx::Class::Storage::DBI::SQLite - Automatic primary key class for SQLite
24 # In your table classes
25 use base 'DBIx::Class::Core';
26 __PACKAGE__->set_primary_key('id');
30 This class implements autoincrements for SQLite.
42 my ($self, $dir) = @_;
45 ## Where is the db file?
46 my $dsn = $self->_dbi_connect_info()->[0];
48 my $dbname = $1 if($dsn =~ /dbname=([^;]+)/);
51 $dbname = $1 if($dsn =~ /^dbi:SQLite:(.+)$/i);
53 $self->throw_exception("Cannot determine name of SQLite db file")
54 if(!$dbname || !-f $dbname);
56 # print "Found database: $dbname\n";
57 # my $dbfile = file($dbname);
58 my ($vol, $dbdir, $file) = File::Spec->splitpath($dbname);
59 # my $file = $dbfile->basename();
60 $file = POSIX::strftime("%Y-%m-%d-%H_%M_%S", localtime()) . $file;
61 $file = "B$file" while(-f $file);
63 mkdir($dir) unless -f $dir;
64 my $backupfile = File::Spec->catfile($dir, $file);
66 my $res = File::Copy::copy($dbname, $backupfile);
67 $self->throw_exception("Backup failed! ($!)") if(!$res);
73 my ($self, $name) = @_;
75 $self->_dbh->do("SAVEPOINT $name");
78 sub _exec_svp_release {
79 my ($self, $name) = @_;
81 $self->_dbh->do("RELEASE SAVEPOINT $name");
84 sub _exec_svp_rollback {
85 my ($self, $name) = @_;
87 # For some reason this statement changes the value of $dbh->{AutoCommit}, so
88 # we localize it here to preserve the original value.
89 local $self->_dbh->{AutoCommit} = $self->_dbh->{AutoCommit};
91 $self->_dbh->do("ROLLBACK TRANSACTION TO SAVEPOINT $name");
97 # Be extremely careful what we do here. SQLite is notoriously bad at
98 # synchronizing its internal transaction state with {AutoCommit}
99 # https://metacpan.org/source/ADAMK/DBD-SQLite-1.37/lib/DBD/SQLite.pm#L921
100 # There is a function http://www.sqlite.org/c3ref/get_autocommit.html
101 # but DBD::SQLite does not expose it (nor does it seem to properly use it)
103 # Therefore only execute a "ping" when we have no other choice *AND*
104 # scrutinize the thrown exceptions to make sure we are where we think we are
105 my $dbh = $self->_dbh or return undef;
106 return undef unless $dbh->FETCH('Active');
107 return undef unless $dbh->ping;
109 # since we do not have access to sqlite3_get_autocommit(), do a trick
110 # to attempt to *safely* determine what state are we *actually* in.
112 # also using T::T here leads to bizarre leaks - will figure it out later
113 my $really_not_in_txn = do {
116 # older versions of DBD::SQLite do not properly detect multiline BEGIN/COMMIT
117 # statements to adjust their {AutoCommit} state. Hence use such a statement
118 # pair here as well, in order to escape from poking {AutoCommit} needlessly
119 # https://rt.cpan.org/Public/Bug/Display.html?id=80087
121 # will fail instantly if already in a txn
122 $dbh->do("-- multiline\nBEGIN");
123 $dbh->do("-- multiline\nCOMMIT");
126 ($@ =~ /transaction within a transaction/)
135 # if we were unable to determine this - we may very well be dead
136 if (not defined $really_not_in_txn) {
139 # check the AC sync-state
140 elsif ($really_not_in_txn xor $dbh->{AutoCommit}) {
142 'Internal transaction state of handle %s (apparently %s a transaction) does not seem to '
143 . 'match its AutoCommit attribute setting of %s - this is an indication of a '
144 . 'potentially serious bug in your transaction handling logic',
146 $really_not_in_txn ? 'NOT in' : 'in',
147 $dbh->{AutoCommit} ? 'TRUE' : 'FALSE',
150 # it is too dangerous to execute anything else in this state
151 # assume everything works (safer - worst case scenario next statement throws)
156 $ping_fail = ! try { $dbh->do('SELECT * FROM sqlite_master LIMIT 1'); 1 };
160 # it is possible to have a proper "connection", and have "ping" return
161 # false anyway (e.g. corrupted file). In such cases DBD::SQLite still
162 # keeps the actual file handle open. We don't really want this to happen,
163 # so force-close the handle via DBI itself
165 local $@; # so that we do not clober the real error as set above
166 eval { $dbh->disconnect }; # if it fails - it fails
167 return undef # the actual RV of _ping()
174 sub deployment_statements {
176 my ($schema, $type, $version, $dir, $sqltargs, @rest) = @_;
181 ! exists $sqltargs->{producer_args}{sqlite_version}
183 my $dver = $self->_server_info->{normalized_dbms_version}
185 $sqltargs->{producer_args}{sqlite_version} = $dver;
188 $self->next::method($schema, $type, $version, $dir, $sqltargs, @rest);
191 sub bind_attribute_by_data_type {
192 $_[1] =~ /^ (?: int(?:eger)? | (?:tiny|small|medium)int ) $/ix
198 # DBD::SQLite (at least up to version 1.31 has a bug where it will
199 # non-fatally nummify a string value bound as an integer, resulting
200 # in insertions of '0' into supposed-to-be-numeric fields
201 # Since this can result in severe data inconsistency, remove the
202 # bind attr if such a sitation is detected
204 # FIXME - when a DBD::SQLite version is released that eventually fixes
205 # this sutiation (somehow) - no-op this override once a proper DBD
206 # version is detected
207 sub _dbi_attrs_for_bind {
208 my ($self, $ident, $bind) = @_;
209 my $bindattrs = $self->next::method($ident, $bind);
211 for (0.. $#$bindattrs) {
213 defined $bindattrs->[$_]
215 defined $bind->[$_][1]
217 $bindattrs->[$_] eq DBI::SQL_INTEGER()
219 $bind->[$_][1] !~ /^ [\+\-]? [0-9]+ (?: \. 0* )? $/x
221 carp_unique( sprintf (
222 "Non-integer value supplied for column '%s' despite the integer datatype",
223 $bind->[$_][0]{dbic_colname} || "# $_"
225 undef $bindattrs->[$_];
232 =head2 connect_call_use_foreign_keys
236 on_connect_call => 'use_foreign_keys'
238 In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to turn on foreign key
239 (including cascading) support for recent versions of SQLite and L<DBD::SQLite>.
243 PRAGMA foreign_keys = ON
245 See L<http://www.sqlite.org/foreignkeys.html> for more information.
249 sub connect_call_use_foreign_keys {
253 'PRAGMA foreign_keys = ON'
259 =head1 AUTHOR AND CONTRIBUTORS
261 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
265 You may distribute this code under the same terms as Perl itself.