-
Notifications
You must be signed in to change notification settings - Fork 9
/
Firebird.pm
1593 lines (1042 loc) · 42.8 KB
/
Firebird.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#
# Copyright (c) 2011 Marius Popa <[email protected]>
# Copyright (c) 2011 Damyan Ivanov <[email protected]>
# Copyright (c) 1999-2008 Edwin Pratomo
#
# You may distribute under the terms of either the GNU General Public
# License or the Artistic License, as specified in the Perl README file
require 5.008001;
package DBD::Firebird;
use strict;
use warnings;
use Carp;
use vars qw($VERSION @ISA @EXPORT @EXPORT_OK $AUTOLOAD);
use DBI 1.41 ();
require Exporter;
require DynaLoader;
@ISA = qw(Exporter DynaLoader);
$VERSION = '1.38';
bootstrap DBD::Firebird $VERSION;
use vars qw($VERSION $err $errstr $drh);
$err = 0;
$errstr = "";
$drh = undef;
sub CLONE
{
$drh = undef;
}
sub driver
{
return $drh if $drh;
my($class, $attr) = @_;
$class .= "::dr";
$drh = DBI::_new_drh($class, {'Name' => 'Firebird',
'Version' => $VERSION,
'Err' => \$DBD::Firebird::err,
'Errstr' => \$DBD::Firebird::errstr,
'Attribution' => 'DBD::Firebird by Edwin Pratomo and Daniel Ritz'});
$drh;
}
# taken from JWIED's DBD::mysql, with slight modification
sub _OdbcParse($$$)
{
my($class, $dsn, $hash, $args) = @_;
my($var, $val);
if (!defined($dsn))
{ return; }
while (length($dsn))
{
if ($dsn =~ /([^;]*)[;]\r?\n?(.*)/s)
{
$val = $1;
$dsn = $2;
}
else
{
$val = $dsn;
$dsn = '';
}
if ($val =~ /([^=]*)=(.*)/)
{
$var = $1;
$val = $2;
if ($var eq 'hostname')
{ $hash->{'host'} = $val; }
elsif ($var eq 'db' || $var eq 'dbname')
{ $hash->{'database'} = $val; }
else
{ $hash->{$var} = $val; }
}
else
{
foreach $var (@$args)
{
if (!defined($hash->{$var}))
{
$hash->{$var} = $val;
last;
}
}
}
}
$hash->{host} = "$hash->{host}/$hash->{port}" if ($hash->{host} && $hash->{port});
$hash->{database} = "$hash->{host}:$hash->{database}" if $hash->{host};
}
sub create_database {
my ( $self, $params ) = ( shift, shift );
$self and $params and ref($params) and ref($params) eq 'HASH' and not @_
or croak 'Usage: '
. __PACKAGE__
. '->create_database( { params...} )';
exists $params->{db_path} and defined( $params->{db_path} )
or croak "Required parameter 'db_path' not supplied";
for( qw(db_path user password character_set) ) {
next unless exists $params->{$_};
$params->{$_} =~ s/'/''/g if defined($params->{$_});
}
DBD::Firebird::db::_create_database($params);
}
sub gfix {
my ( $self, $params ) = ( shift, shift );
$self and $params and ref($params) and ref($params) eq 'HASH' and not @_
or croak 'Usage: '
. __PACKAGE__
. '->gfix( { params...} )';
DBD::Firebird::db::_gfix($params);
}
package DBD::Firebird::dr;
sub connect
{
my($drh, $dsn, $dbuser, $dbpasswd, $attr) = @_;
$dbuser ||= $ENV{ISC_USER}; #"SYSDBA";
$dbpasswd ||= $ENV{ISC_PASSWORD}; #"masterkey";
my ($this, $private_attr_hash);
$private_attr_hash = {
'Name' => $dsn,
'user' => $dbuser,
'password' => $dbpasswd
};
DBD::Firebird->_OdbcParse($dsn, $private_attr_hash,
['database', 'host', 'port', 'ib_role', 'ib_dbkey_scope',
'ib_charset', 'ib_dialect', 'ib_cache', 'ib_lc_time',
'ib_db_triggers']);
$private_attr_hash->{database} ||= $ENV{ISC_DATABASE}; #"employee.fdb"
my ($dbh_name) = ($dsn =~ /(db=[^;]+)/);
$dbh_name ||= "db=$private_attr_hash->{database}";
my $dbh = DBI::_new_dbh($drh,
{ Name => $dbh_name },
$private_attr_hash);
DBD::Firebird::db::_login($dbh, $dsn, $dbuser, $dbpasswd, $attr)
or return undef;
$dbh;
}
package DBD::Firebird::db;
use strict;
use Carp;
sub do
{
my($dbh, $statement, $attr, @params) = @_;
my $rows;
if (@params)
{
my $sth = $dbh->prepare($statement, $attr) or return undef;
defined($sth->execute(@params)) or return undef;
$rows = $sth->rows;
}
else
{
$rows = DBD::Firebird::db::_do($dbh, $statement, $attr);
return undef unless defined($rows);
}
($rows == 0) ? "0E0" : $rows;
}
sub prepare
{
my ($dbh, $statement, $attribs) = @_;
my $sth = DBI::_new_sth($dbh, {'Statement' => $statement });
DBD::Firebird::st::_prepare($sth, $statement, $attribs)
or return undef;
$sth;
}
sub primary_key_info
{
my ($dbh, undef, undef, $tbl) = @_;
my $sth = $dbh->prepare(<<'__eosql');
SELECT CAST(NULL AS CHAR(1)) AS TABLE_CAT,
CAST(NULL AS CHAR(1)) AS TABLE_SCHEM,
rc.rdb$relation_name AS TABLE_NAME,
ix.rdb$field_name AS COLUMN_NAME,
ix.rdb$field_position + 1 AS KEY_SEQ,
rc.rdb$index_name AS PK_NAME
FROM rdb$relation_constraints rc
INNER JOIN
rdb$index_segments ix
ON rc.rdb$index_name = ix.rdb$index_name
WHERE rc.rdb$relation_name = ?
AND
rc.rdb$constraint_type = 'PRIMARY KEY'
ORDER BY 1, 2, 3, 5
__eosql
if ($sth) {
$sth->{ChopBlanks} = 1;
return unless $sth->execute($tbl);
}
$sth;
}
sub table_info
{
my ($self, $cat, $schem, $name, $type, $attr) = @_;
require DBD::Firebird::TableInfo;
my $ti = ($self->{private_table_info}
||=
DBD::Firebird::TableInfo->factory($self));
no warnings 'uninitialized';
if ($cat eq '%' and $schem eq '' and $name eq '') {
return $ti->list_catalogs($self);
} elsif ($cat eq '' and $schem eq '%' and $name eq '') {
return $ti->list_schema($self);
} elsif ($cat eq '' and $schem eq '' and $name eq '' and $type eq '%') {
return $ti->list_types($self);
} else {
my %seen;
$type = '' if $type eq '%';
# normalize $type specifiers: upcase, strip quote and uniqify
my @types = grep { length and not $seen{$_}++ }
map { s/'//g; s/^\s+//; s/\s+$//; uc }
split(',' => $type);
return $ti->list_tables($self, $name, @types);
}
}
sub ping
{
my($dbh) = @_;
local $SIG{__WARN__} = sub { } if $dbh->{PrintError};
local $dbh->{RaiseError} = 0 if $dbh->{RaiseError};
my $ret = DBD::Firebird::db::_ping($dbh);
return $ret;
}
# The get_info function was automatically generated by
# DBI::DBD::Metadata::write_getinfo_pm v1.05.
sub get_info {
my($dbh, $info_type) = @_;
require DBD::Firebird::GetInfo;
my $v = $DBD::Firebird::GetInfo::info{int($info_type)};
$v = $v->($dbh) if ref $v eq 'CODE';
return $v;
}
# The type_info_all function was automatically generated by
# DBI::DBD::Metadata::write_typeinfo_pm v1.05.
sub type_info_all
{
my ($dbh) = @_;
require DBD::Firebird::TypeInfo;
return [ @$DBD::Firebird::TypeInfo::type_info_all ];
}
1;
package DBD::Firebird::st;
# taken from DBI.pm, with this only change:
# - remove the call to bind_param without value when $attr is set
# * it fails when the column can't contain NULLs
# * it is not necessary anyway, as we allocate param placeholder
# structures according to Firebird's ananysis of the SQL, not
# according to the datatype the supplied in $attr
sub bind_param_array {
my $sth = shift;
my ($p_id, $value_array, $attr) = @_;
return $sth->set_err($DBI::stderr, "Value for parameter $p_id must be a scalar or an arrayref, not a ".ref($value_array))
if defined $value_array and ref $value_array and ref $value_array ne 'ARRAY';
return $sth->set_err($DBI::stderr, "Can't use named placeholder '$p_id' for non-driver supported bind_param_array")
unless DBI::looks_like_number($p_id); # because we rely on execute(@ary) here
return $sth->set_err($DBI::stderr, "Placeholder '$p_id' is out of range")
if $p_id <= 0; # can't easily/reliably test for too big
# get/create arrayref to hold params
my $hash_of_arrays = $sth->{ParamArrays} ||= { };
$$hash_of_arrays{$p_id} = $value_array;
1;
}
1;
__END__
=head1 NAME
DBD::Firebird - DBI driver for Firebird RDBMS server
=head1 SYNOPSIS
use DBI;
$dbh = DBI->connect("dbi:Firebird:db=$dbname", $user, $password);
# See the DBI module documentation for full details
=head1 DESCRIPTION
DBD::Firebird is a Perl module which works with the DBI module to provide
access to Firebird databases.
=head1 MODULE DOCUMENTATION
This documentation describes driver specific behavior and restrictions.
It is not supposed to be used as the only reference for the user. In any
case consult the DBI documentation first !
=head1 THE DBI CLASS
=head2 DBI Class Methods
=over 4
=item B<connect>
To connect to a database with a minimum of parameters, use the
following syntax:
$dbh = DBI->connect("dbi:Firebird:dbname=$dbname", $user, $password);
If omitted, C<$user> defaults to the ISC_USER environment variable
(or, failing that, the DBI-standard DBI_USER environment variable).
Similarly, C<$password> defaults to ISC_PASSWORD (or DBI_PASS). If
C<$dbname> is blank, that is, I<"dbi:Firebird:dbname=">, the
environment variable ISC_DATABASE is substituted.
The DSN may take several optional parameters, which may be split
over multiple lines. Here is an example of connect statement which
uses all possible parameters:
$dsn =<< "DSN";
dbi:Firebird:dbname=$dbname;
host=$host;
port=$port;
ib_dialect=$dialect;
ib_role=$role;
ib_charset=$charset;
ib_cache=$cache;
ib_db_triggers=0;
timeout=$timeout
DSN
$dbh = DBI->connect($dsn, $username, $password);
The C<$dsn> is prefixed by 'dbi:Firebird:', and consists of key-value
parameters separated by B<semicolons>. New line may be added after the
semicolon. The following is the list of valid parameters and their
respective meanings:
parameter meaning optional?
-----------------------------------------------------------------
database path to the database required
dbname path to the database
db path to the database
hostname hostname / IP address optional
host hostname / IP address
port port number optional
timeout connect timeout in seconds optional
ib_dialect the SQL dialect to be used optional
ib_role the role of the user optional
ib_charset character set to be used optional
ib_cache number of database cache buffers optional
ib_dbkey_scope change default duration of RDB$DB_KEY optional
ib_db_triggers enable/disable database-level triggers optional
defaults to 1 (enabled)
B<database> could be used interchangebly with B<dbname> and B<db>.
To connect to a remote host, use the B<host> parameter.
Here is an example of DSN to connect to a remote Windows host:
$dsn = "dbi:Firebird:db=C:/temp/test.gdb;host=example.com;ib_dialect=3";
Database file alias can be used too in connection string. In the following
example, "billing" is defined in aliases.conf:
$dsn = 'dbi:Firebird:hostname=192.168.88.5;db=billing;ib_dialect=3';
Firebird as of version 1.0 listens on port specified within the services
file. To connect to port other than the default 3050, add the port number at
the end of host name, separated by a slash. Example:
$dsn = 'dbi:Firebird:db=/data/test.gdb;host=localhost/3060';
Firebird 1.0 introduces B<SQL dialect> to provide backward compatibility with
databases created by older versions of Firebird (pre 1.0). In short, SQL
dialect controls how Firebird interprets:
- double quotes
- the DATE datatype
- decimal and numeric datatypes
- new 1.0 reserved keywords
Valid values for B<ib_dialect> are 1 and 3 .The driver's default value is
3 (Currently it is possible to create databases in Dialect 1 and 3 only,
however it is recommended that you use Dialect 3 exclusively, since Dialect 1
will eventually be deprecated. Dialect 2 cannot be used to create a database
since it only serves to convert Dialect 1 to Dialect 3).
http://www.firebirdsql.org/file/documentation/reference_manuals/user_manuals/html/isql-dialects.html
B<ib_role> specifies the role of the connecting user. B<SQL role> is
implemented by Firebird to make database administration easier when dealing
with lots of users. A detailed reading can be found at:
http://www.ibphoenix.com/resources/documents/general/doc_59
If B<ib_cache> is not specified, the default database's cache size value will
be used. The Firebird Operation Guide discusses in full length the importance
of this parameter to gain the best performance.
=item B<available_drivers>
@driver_names = DBI->available_drivers;
Implemented by DBI, no driver-specific impact.
=item B<data_sources>
This method is not yet implemented.
=item B<trace>
DBI->trace($trace_level, $trace_file)
Implemented by DBI, no driver-specific impact.
=back
=head2 DBI Dynamic Attributes
See Common Methods.
=head1 METHODS COMMON TO ALL DBI HANDLES
=over 4
=item B<err>
$rv = $h->err;
Supported by the driver as proposed by DBI.
=item B<errstr>
$str = $h->errstr;
Supported by the driver as proposed by DBI.
=item B<state>
This method is not yet implemented.
=item B<trace>
$h->trace($trace_level, $trace_filename);
Implemented by DBI, no driver-specific impact.
=item B<trace_msg>
$h->trace_msg($message_text);
Implemented by DBI, no driver-specific impact.
=item B<func>
See B<Transactions> section for information about invoking
C<ib_set_tx_param()> from func() method.
=back
=head1 ATTRIBUTES COMMON TO ALL DBI HANDLES
=over 4
=item B<Warn> (boolean, inherited)
Implemented by DBI, no driver-specific impact.
=item B<Active> (boolean, read-only)
Supported by the driver as proposed by DBI. A database
handle is active while it is connected and statement
handle is active until it is finished.
=item B<Kids> (integer, read-only)
Implemented by DBI, no driver-specific impact.
=item B<ActiveKids> (integer, read-only)
Implemented by DBI, no driver-specific impact.
=item B<CachedKids> (hash ref)
Implemented by DBI, no driver-specific impact.
=item B<CompatMode> (boolean, inherited)
Not used by this driver.
=item B<InactiveDestroy> (boolean)
Implemented by DBI, no driver-specific impact.
=item B<PrintError> (boolean, inherited)
Implemented by DBI, no driver-specific impact.
=item B<RaiseError> (boolean, inherited)
Implemented by DBI, no driver-specific impact.
=item B<ChopBlanks> (boolean, inherited)
Supported by the driver as proposed by DBI.
=item B<LongReadLen> (integer, inherited)
Supported by the driver as proposed by DBI.The default value is 80 bytes.
=item B<LongTruncOk> (boolean, inherited)
Supported by the driver as proposed by DBI.
=item B<Taint> (boolean, inherited)
Implemented by DBI, no driver-specific impact.
=back
=head1 DATABASE HANDLE OBJECTS
=head2 Database Handle Methods
=over 4
=item B<selectrow_array>
@row_ary = $dbh->selectrow_array($statement, \%attr, @bind_values);
Implemented by DBI, no driver-specific impact.
=item B<selectall_arrayref>
$ary_ref = $dbh->selectall_arrayref($statement, \%attr, @bind_values);
Implemented by DBI, no driver-specific impact.
=item B<selectcol_arrayref>
$ary_ref = $dbh->selectcol_arrayref($statement, \%attr, @bind_values);
Implemented by DBI, no driver-specific impact.
=item B<prepare>
$sth = $dbh->prepare($statement, \%attr);
Supported by the driver as proposed by DBI.
When AutoCommit is On, this method implicitly starts a new transaction,
which will be automatically committed after the following execute() or the
last fetch(), depending on the statement type. For select statements,
commit automatically takes place after the last fetch(), or by explicitly
calling finish() method if there are any rows remaining. For non-select
statements, execute() will implicitly commits the transaction.
=item B<prepare_cached>
$sth = $dbh->prepare_cached($statement, \%attr);
Implemented by DBI, no driver-specific impact.
=item B<do>
$rv = $dbh->do($statement, \%attr, @bind_values);
Supported by the driver as proposed by DBI.
This should be used for non-select statements, where the driver doesn't take
the conservative prepare - execute steps, thereby speeding up the execution
time. But if this method is used with bind values, the speed advantage
diminishes as this method calls prepare() for binding the placeholders.
Instead of calling this method repeatedly with bind values, it would be
better to call prepare() once, and execute() many times.
See the notes for the execute method elsewhere in this document. Unlike the
execute method, currently this method doesn't return the number of affected
rows.
=item B<commit>
$rc = $dbh->commit;
Supported by the driver as proposed by DBI. See also the
notes about B<Transactions> elsewhere in this document.
=item B<rollback>
$rc = $dbh->rollback;
Supported by the driver as proposed by DBI. See also the
notes about B<Transactions> elsewhere in this document.
=item B<disconnect>
$rc = $dbh->disconnect;
Supported by the driver as proposed by DBI.
=item B<ping>
$rc = $dbh->ping;
This driver supports the ping-method, which can be used to check the
validity of a database-handle. This is especially required by
C<Apache::DBI>.
=item B<primary_key_info>
$sth = $dbh->primary_key_info('', '', $table_name);
@pks = $dbh->primary_key('', '', $table_name);
Supported by the driver as proposed by DBI. Note that catalog and schema
are ignored.
=item B<table_info>
$sth = $dbh->table_info;
All Firebird versions support the basic DBI-specified columns
(TABLE_NAME, TABLE_TYPE, etc.) as well as C<IB_TABLE_OWNER>. Peculiar
versions may return additional fields, prefixed by C<IB_>.
Table searching may not work as expected on older Interbase/Firebird engines
which do not natively offer a TRIM() function. Some engines store TABLE_NAME
in a blank-padded CHAR field, and a search for table name is performed via a
SQL C<LIKE> predicate, which is sensitive to blanks. That is:
$dbh->table_info('', '', 'FOO'); # May not find table "FOO", depending on
# FB version
$dbh->table_info('', '', 'FOO%'); # Will always find "FOO", but also tables
# "FOOD", "FOOT", etc.
Future versions of DBD::Firebird may attempt to work around this irritating
limitation, at the expense of efficiency.
Note that Firebird implementations do not presently support the DBI
concepts of 'catalog' and 'schema', so these parameters are effectively
ignored.
=item B<tables>
@names = $dbh->tables;
Returns a list of tables, excluding any 'SYSTEM TABLE' types.
=item B<type_info_all>
$type_info_all = $dbh->type_info_all;
Supported by the driver as proposed by DBI.
For further details concerning the Firebird specific data-types
please read the Firebird Data Definition Guide
http://www.firebirdsql.org/en/reference-manuals/
=item B<type_info>
@type_info = $dbh->type_info($data_type);
Implemented by DBI, no driver-specific impact.
=item B<quote>
$sql = $dbh->quote($value, $data_type);
Implemented by DBI, no driver-specific impact.
=back
=head2 Database Handle Attributes
=over 4
=item B<AutoCommit> (boolean)
Supported by the driver as proposed by DBI. According to the
classification of DBI, Firebird is a database, in which a
transaction must be explicitly started. Without starting a
transaction, every change to the database becomes immediately
permanent. The default of AutoCommit is on, which corresponds
to the DBI's default. When setting AutoCommit to off, a transaction
will be started and every commit or rollback
will automatically start a new transaction. For details see the
notes about B<Transactions> elsewhere in this document.
=item B<Driver> (handle)
Implemented by DBI, no driver-specific impact.
=item B<Name> (string, read-only)
Not yet implemented.
=item B<RowCacheSize> (integer)
Implemented by DBI, not used by the driver.
=item B<ib_softcommit> (driver-specific, boolean)
Set this attribute to TRUE to use Firebird's soft commit feature (default
to FALSE). Soft commit retains the internal transaction handle when
committing a transaction, while the default commit behavior always closes
and invalidates the transaction handle.
Since the transaction handle is still open, there is no need to start a new
transaction upon every commit, so applications can gain performance
improvement. Using soft commit is also desirable when dealing with nested
statement handles under AutoCommit on.
Switching the attribute's value from TRUE to FALSE will force hard commit thus
closing the current transaction.
=item B<ib_enable_utf8> (driver-specific, boolean)
Setting this attribute to TRUE will cause any Perl Unicode strings supplied as
statement parameters to be downgraded to octet sequences before passing them
to Firebird.
Also, any character data retrieved from the database (CHAR, VARCHAR, BLOB
sub_type TEXT) will be upgraded to Perl Unicode strings.
B<Caveat>: Currently this is supported only if the B<ib_charset> DSN parameter
is C<UTF8>. In the future, encoding and decoding to/from arbitrary character
set may be implemented.
Example:
$dbh = DBI->connect( 'dbi:Firebird:db=database.fdb;ib_charset=UTF8',
{ ib_enable_utf8 => 1 } );
=back
=head1 STATEMENT HANDLE OBJECTS
=head2 Statement Handle Methods
=over 4
=item B<bind_param>
Supported by the driver as proposed by DBI.
The SQL data type passed as the third argument is ignored.
=item B<bind_param_array>
Supported by the driver as proposed by DBI.
The attributes, supplied in the optional third parameter are ignored.
=item B<bind_param_inout>
Not supported by this driver.
=item B<execute>
$rv = $sth->execute(@bind_values);
Supported by the driver as proposed by DBI.
=item B<fetchrow_arrayref>
$ary_ref = $sth->fetchrow_arrayref;
Supported by the driver as proposed by DBI.
=item B<fetchrow_array>
@ary = $sth->fetchrow_array;
Supported by the driver as proposed by DBI.
=item B<fetchrow_hashref>
$hash_ref = $sth->fetchrow_hashref;
Supported by the driver as proposed by DBI.
=item B<fetchall_arrayref>
$tbl_ary_ref = $sth->fetchall_arrayref;
Implemented by DBI, no driver-specific impact.
=item B<finish>
$rc = $sth->finish;
Supported by the driver as proposed by DBI.
=item B<rows>
$rv = $sth->rows;
Supported by the driver as proposed by DBI.
It returns the number of B<fetched> rows for select statements, otherwise
it returns -1 (unknown number of affected rows).
=item B<bind_col>
$rc = $sth->bind_col($column_number, \$var_to_bind, \%attr);
Supported by the driver as proposed by DBI.
=item B<bind_columns>
$rc = $sth->bind_columns(\%attr, @list_of_refs_to_vars_to_bind);
Supported by the driver as proposed by DBI.
=item B<dump_results>
$rows = $sth->dump_results($maxlen, $lsep, $fsep, $fh);
Implemented by DBI, no driver-specific impact.
=back
=head2 Statement Handle Attributes
=over 4
=item B<NUM_OF_FIELDS> (integer, read-only)
Implemented by DBI, no driver-specific impact.
=item B<NUM_OF_PARAMS> (integer, read-only)
Implemented by DBI, no driver-specific impact.
=item B<NAME> (array-ref, read-only)
Supported by the driver as proposed by DBI.
=item B<NAME_lc> (array-ref, read-only)
Implemented by DBI, no driver-specific impact.
=item B<NAME_uc> (array-ref, read-only)
Implemented by DBI, no driver-specific impact.
=item B<TYPE> (array-ref, read-only)
Supported by the driver as proposed by DBI, with
the restriction, that the types are Firebird
specific data-types which do not correspond to
international standards.
=item B<PRECISION> (array-ref, read-only)
Supported by the driver as proposed by DBI.
=item B<SCALE> (array-ref, read-only)
Supported by the driver as proposed by DBI.
=item B<NULLABLE> (array-ref, read-only)
Supported by the driver as proposed by DBI.
=item B<CursorName> (string, read-only)
Supported by the driver as proposed by DBI.
=item B<Statement> (string, read-only)
Supported by the driver as proposed by DBI.
=item B<RowCache> (integer, read-only)
Not supported by the driver.
=item B<ParamValues> (hashref, read-only)
Supported by the driver as proposed by DBI.
=back
=head1 TRANSACTION SUPPORT
The transaction behavior is controlled with the attribute AutoCommit.
For a complete definition of AutoCommit please refer to the DBI documentation.
According to the DBI specification the default for AutoCommit is TRUE.
In this mode, any change to the database becomes valid immediately. Any
commit() or rollback() will be rejected.
If AutoCommit is switched-off, immediately a transaction will be started.
A rollback() will rollback and close the active transaction, then implicitly
start a new transaction. A disconnect will issue a rollback.
Firebird provides fine control over transaction behavior, where users can
specify the access mode, the isolation level, the lock resolution, and the
table reservation (for a specified table). For this purpose,
C<ib_set_tx_param()> database handle method is available.
Upon a successful C<connect()>, these default parameter values will be used
for every SQL operation:
Access mode: read_write
Isolation level: snapshot
Lock resolution: wait
Any of the above value can be changed using C<ib_set_tx_param()>.
=over 4
=item B<ib_set_tx_param>
$dbh->func(
-access_mode => 'read_write',
-isolation_level => 'read_committed',
-lock_resolution => 'wait',
'ib_set_tx_param'
);
Valid value for C<-access_mode> is C<read_write>, or C<read_only>.
Valid value for C<-lock_resolution> is C<wait>, or C<no_wait>.
In Firebird 2.0, a timeout value for wait is introduced. This can be
specified using hash ref as lock_resolution value:
$dbh->func(
-lock_resolution => { wait => 5 }, # wait for 5 seconds
'ib_set_tx_param'
);
C<-isolation_level> may be: C<read_committed>, C<snapshot>,
C<snapshot_table_stability>.
If C<read_committed> is to be used with C<record_version> or
C<no_record_version>, then they should be inside an anonymous array:
$dbh->func(
-isolation_level => ['read_committed', 'record_version'],
'ib_set_tx_param'
);
Table reservation is supported since C<DBD::Firebird 0.30>. Names of the
tables to reserve as well as their reservation params/values are specified
inside a hashref, which is then passed as the value of C<-reserving>.
The following example reserves C<foo_table> with C<read> lock and C<bar_table>
with C<read> lock and C<protected> access:
$dbh->func(
-access_mode => 'read_write',
-isolation_level => 'read_committed',
-lock_resolution => 'wait',
-reserving =>
{