Commit | Line | Data |
88a8d0fa |
1 | package DBIx::Class::Storage::DBI::InterBase; |
2 | |
88a8d0fa |
3 | use strict; |
4 | use warnings; |
bab40dee |
5 | use base qw/DBIx::Class::Storage::DBI/; |
88a8d0fa |
6 | use mro 'c3'; |
88a8d0fa |
7 | use List::Util(); |
8 | |
90489c23 |
9 | =head1 NAME |
10 | |
11 | DBIx::Class::Storage::DBI::InterBase - Driver for the Firebird RDBMS |
12 | |
13 | =head1 DESCRIPTION |
14 | |
95570280 |
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. |
90489c23 |
18 | |
dd2109ee |
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 |
47ec67c3 |
22 | correctly with this driver. Otherwise you will likely get bizarre error messages |
d1fc96c7 |
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>. |
90489c23 |
26 | |
c5827074 |
27 | To turn on L<DBIx::Class::InflateColumn::DateTime> support, see |
28 | L</connect_call_datetime_setup>. |
32323fc2 |
29 | |
90489c23 |
30 | =cut |
31 | |
227d8366 |
32 | sub _supports_insert_returning { 1 } |
bab40dee |
33 | |
e1958268 |
34 | sub _sequence_fetch { |
35 | my ($self, $nextval, $sequence) = @_; |
36 | |
37 | if ($nextval ne 'nextval') { |
38 | $self->throw_exception("Can only fetch 'nextval' for a sequence"); |
39 | } |
40 | |
41 | $self->throw_exception('No sequence to fetch') unless $sequence; |
42 | |
43 | my ($val) = $self->_get_dbh->selectrow_array( |
44 | 'SELECT GEN_ID(' . $self->sql_maker->_quote($sequence) . |
45 | ', 1) FROM rdb$database'); |
46 | |
47 | return $val; |
48 | } |
49 | |
50 | sub _dbh_get_autoinc_seq { |
51 | my ($self, $dbh, $source, $col) = @_; |
52 | |
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); |
56 | |
57 | local $dbh->{LongReadLen} = 100000; |
58 | local $dbh->{LongTruncOk} = 1; |
59 | |
60 | my $sth = $dbh->prepare(<<'EOF'); |
61 | SELECT t.rdb$trigger_source |
62 | FROM rdb$triggers t |
63 | WHERE t.rdb$relation_name = ? |
64 | AND t.rdb$system_flag = 0 -- user defined |
65 | AND t.rdb$trigger_type = 1 -- BEFORE INSERT |
66 | EOF |
67 | $sth->execute($table_name); |
68 | |
69 | while (my ($trigger) = $sth->fetchrow_array) { |
70 | my @trig_cols = map { |
71 | /^"([^"]+)/ ? $1 : uc($1) |
72 | } $trigger =~ /new\.("?\w+"?)/ig; |
73 | |
74 | my ($quoted, $generator) = $trigger =~ |
75 | /(?:gen_id\s* \( \s* |next \s* value \s* for \s*)(")?(\w+)/ix; |
76 | |
77 | if ($generator) { |
78 | $generator = uc $generator unless $quoted; |
79 | |
80 | return $generator |
81 | if List::Util::first { |
82 | $self->sql_maker->quote_char ? ($_ eq $col) : (uc($_) eq uc($col)) |
83 | } @trig_cols; |
84 | } |
85 | } |
86 | |
87 | return undef; |
88 | } |
89 | |
145b2a3d |
90 | # this sub stolen from DB2 |
88a8d0fa |
91 | |
145b2a3d |
92 | sub _sql_maker_opts { |
93 | my ( $self, $opts ) = @_; |
94 | |
95 | if ( $opts ) { |
96 | $self->{_sql_maker_opts} = { %$opts }; |
97 | } |
98 | |
99 | return { limit_dialect => 'FirstSkip', %{$self->{_sql_maker_opts}||{}} }; |
100 | } |
101 | |
32323fc2 |
102 | sub _svp_begin { |
103 | my ($self, $name) = @_; |
104 | |
105 | $self->_get_dbh->do("SAVEPOINT $name"); |
106 | } |
107 | |
108 | sub _svp_release { |
109 | my ($self, $name) = @_; |
110 | |
111 | $self->_get_dbh->do("RELEASE SAVEPOINT $name"); |
112 | } |
113 | |
114 | sub _svp_rollback { |
115 | my ($self, $name) = @_; |
116 | |
117 | $self->_get_dbh->do("ROLLBACK TO SAVEPOINT $name") |
118 | } |
119 | |
120 | sub _ping { |
121 | my $self = shift; |
122 | |
123 | my $dbh = $self->_dbh or return 0; |
124 | |
125 | local $dbh->{RaiseError} = 1; |
ecdf1ac8 |
126 | local $dbh->{PrintError} = 0; |
32323fc2 |
127 | |
128 | eval { |
129 | $dbh->do('select 1 from rdb$database'); |
130 | }; |
131 | |
132 | return $@ ? 0 : 1; |
133 | } |
134 | |
9633951d |
135 | # We want dialect 3 for new features and quoting to work, DBD::InterBase uses |
136 | # dialect 1 (interbase compat) by default. |
137 | sub _init { |
138 | my $self = shift; |
139 | $self->_set_sql_dialect(3); |
140 | } |
141 | |
142 | sub _set_sql_dialect { |
143 | my $self = shift; |
144 | my $val = shift || 3; |
145 | |
146 | my $dsn = $self->_dbi_connect_info->[0]; |
147 | |
148 | return if ref($dsn) eq 'CODE'; |
149 | |
150 | if ($dsn !~ /ib_dialect=/) { |
151 | $self->_dbi_connect_info->[0] = "$dsn;ib_dialect=$val"; |
152 | my $connected = defined $self->_dbh; |
153 | $self->disconnect; |
154 | $self->ensure_connected if $connected; |
155 | } |
156 | } |
157 | |
6d766626 |
158 | sub _get_server_version { |
8f0a1e07 |
159 | my $self = shift; |
160 | |
b22700c4 |
161 | return $self->next::method(@_) if ref $self ne __PACKAGE__; |
162 | |
8f0a1e07 |
163 | local $SIG{__WARN__} = sub {}; # silence warning due to bug in DBD::InterBase |
164 | |
165 | return $self->next::method(@_); |
166 | } |
167 | |
dd2109ee |
168 | =head2 connect_call_use_softcommit |
169 | |
170 | Used as: |
171 | |
172 | on_connect_call => 'use_softcommit' |
173 | |
174 | In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to set the |
175 | L<DBD::InterBase> C<ib_softcommit> option. |
176 | |
177 | You need either this option or C<< disable_sth_caching => 1 >> for |
47ec67c3 |
178 | L<DBIx::Class> code to function correctly (otherwise you may get C<no statement |
d1fc96c7 |
179 | executing> errors.) Or use the L<ODBC|DBIx::Class::Storage::DBI::ODBC::Firebird> |
180 | driver. |
dd2109ee |
181 | |
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. |
184 | |
185 | =cut |
186 | |
187 | sub connect_call_use_softcommit { |
a499b173 |
188 | my $self = shift; |
189 | |
190 | $self->_dbh->{ib_softcommit} = 1; |
a499b173 |
191 | } |
192 | |
32323fc2 |
193 | =head2 connect_call_datetime_setup |
9cd0b325 |
194 | |
32323fc2 |
195 | Used as: |
9cd0b325 |
196 | |
32323fc2 |
197 | on_connect_call => 'datetime_setup' |
198 | |
f0f8ac86 |
199 | In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to set the date and |
200 | timestamp formats using: |
32323fc2 |
201 | |
202 | $dbh->{ib_time_all} = 'ISO'; |
203 | |
204 | See L<DBD::InterBase> for more details. |
205 | |
206 | The C<TIMESTAMP> data type supports up to 4 digits after the decimal point for |
207 | second precision. The full precision is used. |
208 | |
c5827074 |
209 | The C<DATE> data type stores the date portion only, and it B<MUST> be declared |
210 | with: |
211 | |
212 | data_type => 'date' |
213 | |
214 | in your Result class. |
215 | |
216 | Timestamp columns can be declared with either C<datetime> or C<timestamp>. |
217 | |
32323fc2 |
218 | You will need the L<DateTime::Format::Strptime> module for inflation to work. |
219 | |
220 | For L<DBIx::Class::Storage::DBI::ODBC::Firebird>, this is a noop and sub-second |
221 | precision is not currently available. |
222 | |
223 | =cut |
224 | |
225 | sub connect_call_datetime_setup { |
226 | my $self = shift; |
227 | |
228 | $self->_get_dbh->{ib_time_all} = 'ISO'; |
9cd0b325 |
229 | } |
230 | |
c5827074 |
231 | sub datetime_parser_type { |
232 | 'DBIx::Class::Storage::DBI::InterBase::DateTime::Format' |
233 | } |
32323fc2 |
234 | |
c5827074 |
235 | package # hide from PAUSE |
236 | DBIx::Class::Storage::DBI::InterBase::DateTime::Format; |
32323fc2 |
237 | |
c5827074 |
238 | my $timestamp_format = '%Y-%m-%d %H:%M:%S.%4N'; # %F %T |
239 | my $date_format = '%Y-%m-%d'; |
240 | |
241 | my ($timestamp_parser, $date_parser); |
242 | |
243 | sub parse_datetime { |
244 | shift; |
245 | require DateTime::Format::Strptime; |
246 | $timestamp_parser ||= DateTime::Format::Strptime->new( |
247 | pattern => $timestamp_format, |
248 | on_error => 'croak', |
249 | ); |
250 | return $timestamp_parser->parse_datetime(shift); |
251 | } |
252 | |
253 | sub format_datetime { |
254 | shift; |
255 | require DateTime::Format::Strptime; |
256 | $timestamp_parser ||= DateTime::Format::Strptime->new( |
257 | pattern => $timestamp_format, |
258 | on_error => 'croak', |
259 | ); |
260 | return $timestamp_parser->format_datetime(shift); |
261 | } |
262 | |
263 | sub parse_date { |
264 | shift; |
265 | require DateTime::Format::Strptime; |
266 | $date_parser ||= DateTime::Format::Strptime->new( |
267 | pattern => $date_format, |
268 | on_error => 'croak', |
269 | ); |
270 | return $date_parser->parse_datetime(shift); |
271 | } |
272 | |
273 | sub format_date { |
274 | shift; |
275 | require DateTime::Format::Strptime; |
276 | $date_parser ||= DateTime::Format::Strptime->new( |
277 | pattern => $date_format, |
32323fc2 |
278 | on_error => 'croak', |
279 | ); |
c5827074 |
280 | return $date_parser->format_datetime(shift); |
9cd0b325 |
281 | } |
282 | |
145b2a3d |
283 | 1; |
90489c23 |
284 | |
285 | =head1 CAVEATS |
286 | |
287 | =over 4 |
288 | |
289 | =item * |
290 | |
dd2109ee |
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 |
47ec67c3 |
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 |
295 | affects performance. |
dd2109ee |
296 | |
d1fc96c7 |
297 | Alternately, use the L<ODBC|DBIx::Class::Storage::DBI::ODBC::Firebird> driver. |
298 | |
dd2109ee |
299 | =item * |
300 | |
e1958268 |
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. |
90489c23 |
304 | |
47ec67c3 |
305 | =item * |
306 | |
d1fc96c7 |
307 | Sub-second precision for TIMESTAMPs is not currently available when using the |
308 | L<ODBC|DBIx::Class::Storage::DBI::ODBC::Firebird> driver. |
47ec67c3 |
309 | |
90489c23 |
310 | =back |
311 | |
312 | =head1 AUTHOR |
313 | |
314 | See L<DBIx::Class/AUTHOR> and L<DBIx::Class/CONTRIBUTORS>. |
315 | |
316 | =head1 LICENSE |
317 | |
318 | You may distribute this code under the same terms as Perl itself. |
319 | |
320 | =cut |