1 package DBIx::Class::Storage::DBI::InterBase;
5 use base qw/DBIx::Class::Storage::DBI::InsertReturning/;
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>.
33 my ($self, $nextval, $sequence) = @_;
35 if ($nextval ne 'nextval') {
36 $self->throw_exception("Can only fetch 'nextval' for a sequence");
39 $self->throw_exception('No sequence to fetch') unless $sequence;
41 my ($val) = $self->_get_dbh->selectrow_array(
42 'SELECT GEN_ID(' . $self->sql_maker->_quote($sequence) .
43 ', 1) FROM rdb$database');
48 sub _dbh_get_autoinc_seq {
49 my ($self, $dbh, $source, $col) = @_;
51 my $table_name = $source->from;
52 $table_name = $$table_name if ref $table_name;
53 $table_name = $self->sql_maker->quote_char ? $table_name : uc($table_name);
55 local $dbh->{LongReadLen} = 100000;
56 local $dbh->{LongTruncOk} = 1;
58 my $sth = $dbh->prepare(<<'EOF');
59 SELECT t.rdb$trigger_source
61 WHERE t.rdb$relation_name = ?
62 AND t.rdb$system_flag = 0 -- user defined
63 AND t.rdb$trigger_type = 1 -- BEFORE INSERT
65 $sth->execute($table_name);
67 while (my ($trigger) = $sth->fetchrow_array) {
69 /^"([^"]+)/ ? $1 : uc($1)
70 } $trigger =~ /new\.("?\w+"?)/ig;
72 my ($quoted, $generator) = $trigger =~
73 /(?:gen_id\s* \( \s* |next \s* value \s* for \s*)(")?(\w+)/ix;
76 $generator = uc $generator unless $quoted;
79 if List::Util::first {
80 $self->sql_maker->quote_char ? ($_ eq $col) : (uc($_) eq uc($col))
88 # this sub stolen from DB2
91 my ( $self, $opts ) = @_;
94 $self->{_sql_maker_opts} = { %$opts };
97 return { limit_dialect => 'FirstSkip', %{$self->{_sql_maker_opts}||{}} };
101 my ($self, $name) = @_;
103 $self->_get_dbh->do("SAVEPOINT $name");
107 my ($self, $name) = @_;
109 $self->_get_dbh->do("RELEASE SAVEPOINT $name");
113 my ($self, $name) = @_;
115 $self->_get_dbh->do("ROLLBACK TO SAVEPOINT $name")
121 my $dbh = $self->_dbh or return 0;
123 local $dbh->{RaiseError} = 1;
124 local $dbh->{PrintError} = 0;
127 $dbh->do('select 1 from rdb$database');
133 # We want dialect 3 for new features and quoting to work, DBD::InterBase uses
134 # dialect 1 (interbase compat) by default.
137 $self->_set_sql_dialect(3);
140 sub _set_sql_dialect {
142 my $val = shift || 3;
144 my $dsn = $self->_dbi_connect_info->[0];
146 return if ref($dsn) eq 'CODE';
148 if ($dsn !~ /ib_dialect=/) {
149 $self->_dbi_connect_info->[0] = "$dsn;ib_dialect=$val";
150 my $connected = defined $self->_dbh;
152 $self->ensure_connected if $connected;
156 =head2 connect_call_use_softcommit
160 on_connect_call => 'use_softcommit'
162 In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to set the
163 L<DBD::InterBase> C<ib_softcommit> option.
165 You need either this option or C<< disable_sth_caching => 1 >> for
166 L<DBIx::Class> code to function correctly (otherwise you may get C<no statement
167 executing> errors.) Or use the L<ODBC|DBIx::Class::Storage::DBI::ODBC::Firebird>
170 The downside of using this option is that your process will B<NOT> see UPDATEs,
171 INSERTs and DELETEs from other processes for already open statements.
175 sub connect_call_use_softcommit {
178 $self->_dbh->{ib_softcommit} = 1;
181 =head2 connect_call_datetime_setup
185 on_connect_call => 'datetime_setup'
187 In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to set the date and
188 timestamp formats using:
190 $dbh->{ib_time_all} = 'ISO';
192 See L<DBD::InterBase> for more details.
194 The C<TIMESTAMP> data type supports up to 4 digits after the decimal point for
195 second precision. The full precision is used.
197 The C<DATE> data type stores the date portion only, and it B<MUST> be declared
202 in your Result class.
204 Timestamp columns can be declared with either C<datetime> or C<timestamp>.
206 You will need the L<DateTime::Format::Strptime> module for inflation to work.
208 For L<DBIx::Class::Storage::DBI::ODBC::Firebird>, this is a noop and sub-second
209 precision is not currently available.
213 sub connect_call_datetime_setup {
216 $self->_get_dbh->{ib_time_all} = 'ISO';
219 sub datetime_parser_type {
220 'DBIx::Class::Storage::DBI::InterBase::DateTime::Format'
223 package # hide from PAUSE
224 DBIx::Class::Storage::DBI::InterBase::DateTime::Format;
226 my $timestamp_format = '%Y-%m-%d %H:%M:%S.%4N'; # %F %T
227 my $date_format = '%Y-%m-%d';
229 my ($timestamp_parser, $date_parser);
233 require DateTime::Format::Strptime;
234 $timestamp_parser ||= DateTime::Format::Strptime->new(
235 pattern => $timestamp_format,
238 return $timestamp_parser->parse_datetime(shift);
241 sub format_datetime {
243 require DateTime::Format::Strptime;
244 $timestamp_parser ||= DateTime::Format::Strptime->new(
245 pattern => $timestamp_format,
248 return $timestamp_parser->format_datetime(shift);
253 require DateTime::Format::Strptime;
254 $date_parser ||= DateTime::Format::Strptime->new(
255 pattern => $date_format,
258 return $date_parser->parse_datetime(shift);
263 require DateTime::Format::Strptime;
264 $date_parser ||= DateTime::Format::Strptime->new(
265 pattern => $date_format,
268 return $date_parser->format_datetime(shift);
279 with L</connect_call_use_softcommit>, you will not be able to see changes made
280 to data in other processes. If this is an issue, use
281 L<disable_sth_caching|DBIx::Class::Storage::DBI/disable_sth_caching> as a
282 workaround for the C<no statement executing> errors, this of course adversely
285 Alternately, use the L<ODBC|DBIx::Class::Storage::DBI::ODBC::Firebird> driver.
289 C<last_insert_id> support by default only works for Firebird versions 2 or
290 greater, L<auto_nextval|DBIx::Class::ResultSource/auto_nextval> however should
291 work with earlier versions.
295 Sub-second precision for TIMESTAMPs is not currently available when using the
296 L<ODBC|DBIx::Class::Storage::DBI::ODBC::Firebird> driver.
302 See L<DBIx::Class/AUTHOR> and L<DBIx::Class/CONTRIBUTORS>.
306 You may distribute this code under the same terms as Perl itself.