1 package DBIx::Class::Storage::DBI::InterBase;
5 use base qw/DBIx::Class::Storage::DBI/;
11 DBIx::Class::Storage::DBI::InterBase - Driver for the Firebird RDBMS
15 This class implements autoincrements for Firebird using C<RETURNING> as well as
16 L<auto_nextval|DBIx::Class::ResultSource/auto_nextval> sets the limit dialect to
17 C<FIRST X SKIP X> and provides L<DBIx::Class::InflateColumn::DateTime> support.
19 You need to use either the
20 L<disable_sth_caching|DBIx::Class::Storage::DBI/disable_sth_caching> option or
21 L</connect_call_use_softcommit> (see L</CAVEATS>) for your code to function
22 correctly with this driver. Otherwise you will likely get bizarre error messages
23 such as C<no statement executing>. The alternative is to use the
24 L<ODBC|DBIx::Class::Storage::DBI::ODBC::Firebird> driver, which is more suitable
25 for long running processes such as under L<Catalyst>.
27 To turn on L<DBIx::Class::InflateColumn::DateTime> support, see
28 L</connect_call_datetime_setup>.
32 sub _supports_insert_returning { 1 }
35 my ($self, $nextval, $sequence) = @_;
37 if ($nextval ne 'nextval') {
38 $self->throw_exception("Can only fetch 'nextval' for a sequence");
41 $self->throw_exception('No sequence to fetch') unless $sequence;
43 my ($val) = $self->_get_dbh->selectrow_array(
44 'SELECT GEN_ID(' . $self->sql_maker->_quote($sequence) .
45 ', 1) FROM rdb$database');
50 sub _dbh_get_autoinc_seq {
51 my ($self, $dbh, $source, $col) = @_;
53 my $table_name = $source->from;
54 $table_name = $$table_name if ref $table_name;
55 $table_name = $self->sql_maker->quote_char ? $table_name : uc($table_name);
57 local $dbh->{LongReadLen} = 100000;
58 local $dbh->{LongTruncOk} = 1;
60 my $sth = $dbh->prepare(<<'EOF');
61 SELECT t.rdb$trigger_source
63 WHERE t.rdb$relation_name = ?
64 AND t.rdb$system_flag = 0 -- user defined
65 AND t.rdb$trigger_type = 1 -- BEFORE INSERT
67 $sth->execute($table_name);
69 while (my ($trigger) = $sth->fetchrow_array) {
71 /^"([^"]+)/ ? $1 : uc($1)
72 } $trigger =~ /new\.("?\w+"?)/ig;
74 my ($quoted, $generator) = $trigger =~
75 /(?:gen_id\s* \( \s* |next \s* value \s* for \s*)(")?(\w+)/ix;
78 $generator = uc $generator unless $quoted;
81 if List::Util::first {
82 $self->sql_maker->quote_char ? ($_ eq $col) : (uc($_) eq uc($col))
90 # this sub stolen from DB2
93 my ( $self, $opts ) = @_;
96 $self->{_sql_maker_opts} = { %$opts };
99 return { limit_dialect => 'FirstSkip', %{$self->{_sql_maker_opts}||{}} };
103 my ($self, $name) = @_;
105 $self->_get_dbh->do("SAVEPOINT $name");
109 my ($self, $name) = @_;
111 $self->_get_dbh->do("RELEASE SAVEPOINT $name");
115 my ($self, $name) = @_;
117 $self->_get_dbh->do("ROLLBACK TO SAVEPOINT $name")
123 my $dbh = $self->_dbh or return 0;
125 local $dbh->{RaiseError} = 1;
126 local $dbh->{PrintError} = 0;
129 $dbh->do('select 1 from rdb$database');
135 # We want dialect 3 for new features and quoting to work, DBD::InterBase uses
136 # dialect 1 (interbase compat) by default.
139 $self->_set_sql_dialect(3);
142 sub _set_sql_dialect {
144 my $val = shift || 3;
146 my $dsn = $self->_dbi_connect_info->[0];
148 return if ref($dsn) eq 'CODE';
150 if ($dsn !~ /ib_dialect=/) {
151 $self->_dbi_connect_info->[0] = "$dsn;ib_dialect=$val";
152 my $connected = defined $self->_dbh;
154 $self->ensure_connected if $connected;
158 sub _get_server_version {
161 return $self->next::method(@_) if ref $self ne __PACKAGE__;
163 local $SIG{__WARN__} = sub {}; # silence warning due to bug in DBD::InterBase
165 return $self->next::method(@_);
168 =head2 connect_call_use_softcommit
172 on_connect_call => 'use_softcommit'
174 In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to set the
175 L<DBD::InterBase> C<ib_softcommit> option.
177 You need either this option or C<< disable_sth_caching => 1 >> for
178 L<DBIx::Class> code to function correctly (otherwise you may get C<no statement
179 executing> errors.) Or use the L<ODBC|DBIx::Class::Storage::DBI::ODBC::Firebird>
182 The downside of using this option is that your process will B<NOT> see UPDATEs,
183 INSERTs and DELETEs from other processes for already open statements.
187 sub connect_call_use_softcommit {
190 $self->_dbh->{ib_softcommit} = 1;
193 =head2 connect_call_datetime_setup
197 on_connect_call => 'datetime_setup'
199 In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to set the date and
200 timestamp formats using:
202 $dbh->{ib_time_all} = 'ISO';
204 See L<DBD::InterBase> for more details.
206 The C<TIMESTAMP> data type supports up to 4 digits after the decimal point for
207 second precision. The full precision is used.
209 The C<DATE> data type stores the date portion only, and it B<MUST> be declared
214 in your Result class.
216 Timestamp columns can be declared with either C<datetime> or C<timestamp>.
218 You will need the L<DateTime::Format::Strptime> module for inflation to work.
220 For L<DBIx::Class::Storage::DBI::ODBC::Firebird>, this is a noop and sub-second
221 precision is not currently available.
225 sub connect_call_datetime_setup {
228 $self->_get_dbh->{ib_time_all} = 'ISO';
231 sub datetime_parser_type {
232 'DBIx::Class::Storage::DBI::InterBase::DateTime::Format'
235 package # hide from PAUSE
236 DBIx::Class::Storage::DBI::InterBase::DateTime::Format;
238 my $timestamp_format = '%Y-%m-%d %H:%M:%S.%4N'; # %F %T
239 my $date_format = '%Y-%m-%d';
241 my ($timestamp_parser, $date_parser);
245 require DateTime::Format::Strptime;
246 $timestamp_parser ||= DateTime::Format::Strptime->new(
247 pattern => $timestamp_format,
250 return $timestamp_parser->parse_datetime(shift);
253 sub format_datetime {
255 require DateTime::Format::Strptime;
256 $timestamp_parser ||= DateTime::Format::Strptime->new(
257 pattern => $timestamp_format,
260 return $timestamp_parser->format_datetime(shift);
265 require DateTime::Format::Strptime;
266 $date_parser ||= DateTime::Format::Strptime->new(
267 pattern => $date_format,
270 return $date_parser->parse_datetime(shift);
275 require DateTime::Format::Strptime;
276 $date_parser ||= DateTime::Format::Strptime->new(
277 pattern => $date_format,
280 return $date_parser->format_datetime(shift);
291 with L</connect_call_use_softcommit>, you will not be able to see changes made
292 to data in other processes. If this is an issue, use
293 L<disable_sth_caching|DBIx::Class::Storage::DBI/disable_sth_caching> as a
294 workaround for the C<no statement executing> errors, this of course adversely
297 Alternately, use the L<ODBC|DBIx::Class::Storage::DBI::ODBC::Firebird> driver.
301 C<last_insert_id> support by default only works for Firebird versions 2 or
302 greater, L<auto_nextval|DBIx::Class::ResultSource/auto_nextval> however should
303 work with earlier versions.
307 Sub-second precision for TIMESTAMPs is not currently available when using the
308 L<ODBC|DBIx::Class::Storage::DBI::ODBC::Firebird> driver.
314 See L<DBIx::Class/AUTHOR> and L<DBIx::Class/CONTRIBUTORS>.
318 You may distribute this code under the same terms as Perl itself.