1 package DBIx::Class::Storage::DBI::InterBase;
5 use base qw/DBIx::Class::Storage::DBI/;
7 use List::Util 'first';
13 DBIx::Class::Storage::DBI::InterBase - Driver for the Firebird RDBMS
17 This class implements autoincrements for Firebird using C<RETURNING> as well as
18 L<auto_nextval|DBIx::Class::ResultSource/auto_nextval> and provides
19 L<DBIx::Class::InflateColumn::DateTime> support.
21 You need to use either the
22 L<disable_sth_caching|DBIx::Class::Storage::DBI/disable_sth_caching> option or
23 L</connect_call_use_softcommit> (see L</CAVEATS>) for your code to function
24 correctly with this driver. Otherwise you will likely get bizarre error messages
25 such as C<no statement executing>. The alternative is to use the
26 L<ODBC|DBIx::Class::Storage::DBI::ODBC::Firebird> driver, which is more suitable
27 for long running processes such as under L<Catalyst>.
29 To turn on L<DBIx::Class::InflateColumn::DateTime> support, see
30 L</connect_call_datetime_setup>.
35 __PACKAGE__->_use_insert_returning (1);
36 __PACKAGE__->sql_limit_dialect ('FirstSkip');
39 my ($self, $nextval, $sequence) = @_;
41 $self->throw_exception("Can only fetch 'nextval' for a sequence")
42 if $nextval !~ /^nextval$/i;
44 $self->throw_exception('No sequence to fetch') unless $sequence;
46 my ($val) = $self->_get_dbh->selectrow_array(sprintf
47 'SELECT GEN_ID(%s, 1) FROM rdb$database',
48 $self->sql_maker->_quote($sequence)
54 sub _dbh_get_autoinc_seq {
55 my ($self, $dbh, $source, $col) = @_;
57 my $table_name = $source->from;
58 $table_name = $$table_name if ref $table_name;
59 $table_name = $self->sql_maker->quote_char ? $table_name : uc($table_name);
61 local $dbh->{LongReadLen} = 100000;
62 local $dbh->{LongTruncOk} = 1;
64 my $sth = $dbh->prepare(<<'EOF');
65 SELECT t.rdb$trigger_source
67 WHERE t.rdb$relation_name = ?
68 AND t.rdb$system_flag = 0 -- user defined
69 AND t.rdb$trigger_type = 1 -- BEFORE INSERT
71 $sth->execute($table_name);
73 while (my ($trigger) = $sth->fetchrow_array) {
75 /^"([^"]+)/ ? $1 : uc($1)
76 } $trigger =~ /new\.("?\w+"?)/ig;
78 my ($quoted, $generator) = $trigger =~
79 /(?:gen_id\s* \( \s* |next \s* value \s* for \s*)(")?(\w+)/ix;
82 $generator = uc $generator unless $quoted;
86 $self->sql_maker->quote_char ? ($_ eq $col) : (uc($_) eq uc($col))
95 my ($self, $name) = @_;
97 $self->_get_dbh->do("SAVEPOINT $name");
101 my ($self, $name) = @_;
103 $self->_get_dbh->do("RELEASE SAVEPOINT $name");
107 my ($self, $name) = @_;
109 $self->_get_dbh->do("ROLLBACK TO SAVEPOINT $name")
115 my $dbh = $self->_dbh or return 0;
117 local $dbh->{RaiseError} = 1;
118 local $dbh->{PrintError} = 0;
121 $dbh->do('select 1 from rdb$database');
128 # We want dialect 3 for new features and quoting to work, DBD::InterBase uses
129 # dialect 1 (interbase compat) by default.
132 $self->_set_sql_dialect(3);
135 sub _set_sql_dialect {
137 my $val = shift || 3;
139 my $dsn = $self->_dbi_connect_info->[0];
141 return if ref($dsn) eq 'CODE';
143 if ($dsn !~ /ib_dialect=/) {
144 $self->_dbi_connect_info->[0] = "$dsn;ib_dialect=$val";
145 my $connected = defined $self->_dbh;
147 $self->ensure_connected if $connected;
151 sub _get_server_version {
154 return $self->next::method(@_) if ref $self ne __PACKAGE__;
156 local $SIG{__WARN__} = sub {}; # silence warning due to bug in DBD::InterBase
158 return $self->next::method(@_);
161 =head2 connect_call_use_softcommit
165 on_connect_call => 'use_softcommit'
167 In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to set the
168 L<DBD::InterBase> C<ib_softcommit> option.
170 You need either this option or C<< disable_sth_caching => 1 >> for
171 L<DBIx::Class> code to function correctly (otherwise you may get C<no statement
172 executing> errors.) Or use the L<ODBC|DBIx::Class::Storage::DBI::ODBC::Firebird>
175 The downside of using this option is that your process will B<NOT> see UPDATEs,
176 INSERTs and DELETEs from other processes for already open statements.
180 sub connect_call_use_softcommit {
183 $self->_dbh->{ib_softcommit} = 1;
186 =head2 connect_call_datetime_setup
190 on_connect_call => 'datetime_setup'
192 In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to set the date and
193 timestamp formats using:
195 $dbh->{ib_time_all} = 'ISO';
197 See L<DBD::InterBase> for more details.
199 The C<TIMESTAMP> data type supports up to 4 digits after the decimal point for
200 second precision. The full precision is used.
202 The C<DATE> data type stores the date portion only, and it B<MUST> be declared
207 in your Result class.
209 Timestamp columns can be declared with either C<datetime> or C<timestamp>.
211 You will need the L<DateTime::Format::Strptime> module for inflation to work.
213 For L<DBIx::Class::Storage::DBI::ODBC::Firebird>, this is a noop and sub-second
214 precision is not currently available.
218 sub connect_call_datetime_setup {
221 $self->_get_dbh->{ib_time_all} = 'ISO';
224 sub datetime_parser_type {
225 'DBIx::Class::Storage::DBI::InterBase::DateTime::Format'
228 package # hide from PAUSE
229 DBIx::Class::Storage::DBI::InterBase::DateTime::Format;
231 my $timestamp_format = '%Y-%m-%d %H:%M:%S.%4N'; # %F %T
232 my $date_format = '%Y-%m-%d';
234 my ($timestamp_parser, $date_parser);
238 require DateTime::Format::Strptime;
239 $timestamp_parser ||= DateTime::Format::Strptime->new(
240 pattern => $timestamp_format,
243 return $timestamp_parser->parse_datetime(shift);
246 sub format_datetime {
248 require DateTime::Format::Strptime;
249 $timestamp_parser ||= DateTime::Format::Strptime->new(
250 pattern => $timestamp_format,
253 return $timestamp_parser->format_datetime(shift);
258 require DateTime::Format::Strptime;
259 $date_parser ||= DateTime::Format::Strptime->new(
260 pattern => $date_format,
263 return $date_parser->parse_datetime(shift);
268 require DateTime::Format::Strptime;
269 $date_parser ||= DateTime::Format::Strptime->new(
270 pattern => $date_format,
273 return $date_parser->format_datetime(shift);
284 with L</connect_call_use_softcommit>, you will not be able to see changes made
285 to data in other processes. If this is an issue, use
286 L<disable_sth_caching|DBIx::Class::Storage::DBI/disable_sth_caching> as a
287 workaround for the C<no statement executing> errors, this of course adversely
290 Alternately, use the L<ODBC|DBIx::Class::Storage::DBI::ODBC::Firebird> driver.
294 C<last_insert_id> support by default only works for Firebird versions 2 or
295 greater, L<auto_nextval|DBIx::Class::ResultSource/auto_nextval> however should
296 work with earlier versions.
300 Sub-second precision for TIMESTAMPs is not currently available when using the
301 L<ODBC|DBIx::Class::Storage::DBI::ODBC::Firebird> driver.
307 See L<DBIx::Class/AUTHOR> and L<DBIx::Class/CONTRIBUTORS>.
311 You may distribute this code under the same terms as Perl itself.