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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<title>Class: SQLite3::Database</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
<script language="JavaScript" type="text/javascript">
// <![CDATA[
function toggleSource( id )
{
var elem
var link
if( document.getElementById )
{
elem = document.getElementById( id )
link = document.getElementById( "l_" + id )
}
else if ( document.all )
{
elem = eval( "document.all." + id )
link = eval( "document.all.l_" + id )
}
else
return false;
if( elem.style.display == "block" )
{
elem.style.display = "none"
link.innerHTML = "show source"
}
else
{
elem.style.display = "block"
link.innerHTML = "hide source"
}
}
function openCode( url )
{
window.open( url, "SOURCE_CODE", "width=400,height=400,scrollbars=yes" )
}
// ]]>
</script>
</head>
<body>
<table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'><tr>
<td class="file-title"><span class="file-title-prefix">Class</span><br />SQLite3::Database</td>
<td align="right">
<table cellspacing=0 cellpadding=2>
<tr valign="top">
<td>In:</td>
<td>
<a href="../../files/lib/sqlite3/database_rb.html">lib/sqlite3/database.rb</a>
</td>
</tr>
<tr>
<td>Parent:</td>
<td>
Object
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- banner header -->
<div id="bodyContent">
<div id="content">
<div class="description"><p>
The <a href="Database.html">Database</a> class encapsulates a single
connection to a <a href="../SQLite3.html">SQLite3</a> database. Its usage
is very straightforward:
</p>
<pre>
require 'sqlite3'
db = SQLite3::Database.new( "data.db" )
db.execute( "select * from table" ) do |row|
p row
end
db.close
</pre>
<p>
It wraps the lower-level methods provides by the selected driver, and
includes the <a href="Pragmas.html">Pragmas</a> module for access to
various pragma convenience methods.
</p>
<p>
The <a href="Database.html">Database</a> class provides type translation
services as well, by which the <a href="../SQLite3.html">SQLite3</a> data
types (which are all represented as strings) may be converted into their
corresponding types (as defined in the schemas for their tables). This
translation only occurs when querying data from the
database—insertions and updates are all still typeless.
</p>
<p>
Furthermore, the <a href="Database.html">Database</a> class has been
designed to work well with the ArrayFields module from Ara Howard. If you
require the ArrayFields module before performing a <a
href="Database.html#M000108">query</a>, and if you have not enabled results
as hashes, then the results will all be indexible by field name.
</p>
</div>
<div class="sectiontitle">Methods</div>
<ul>
<li><a href="#M000103">authorizer</a></li>
<li><a href="#M000115">busy_handler</a></li>
<li><a href="#M000116">busy_timeout</a></li>
<li><a href="#M000112">changes</a></li>
<li><a href="#M000100">close</a></li>
<li><a href="#M000101">closed?</a></li>
<li><a href="#M000121">commit</a></li>
<li><a href="#M000096">complete?</a></li>
<li><a href="#M000118">create_aggregate</a></li>
<li><a href="#M000119">create_aggregate_handler</a></li>
<li><a href="#M000117">create_function</a></li>
<li><a href="#M000098">errcode</a></li>
<li><a href="#M000097">errmsg</a></li>
<li><a href="#M000105">execute</a></li>
<li><a href="#M000106">execute2</a></li>
<li><a href="#M000107">execute_batch</a></li>
<li><a href="#M000109">get_first_row</a></li>
<li><a href="#M000110">get_first_value</a></li>
<li><a href="#M000114">interrupt</a></li>
<li><a href="#M000111">last_insert_row_id</a></li>
<li><a href="#M000095">new</a></li>
<li><a href="#M000104">prepare</a></li>
<li><a href="#M000108">query</a></li>
<li><a href="#M000094">quote</a></li>
<li><a href="#M000122">rollback</a></li>
<li><a href="#M000113">total_changes</a></li>
<li><a href="#M000102">trace</a></li>
<li><a href="#M000120">transaction</a></li>
<li><a href="#M000123">transaction_active?</a></li>
<li><a href="#M000099">translator</a></li>
</ul>
<div class="sectiontitle">Included Modules</div>
<ul>
<li><a href="Pragmas.html">Pragmas</a></li>
</ul>
<div class="sectiontitle">Classes and Modules</div>
Class <a href="Database/FunctionProxy.html" class="link">SQLite3::Database::FunctionProxy</a><br />
<div class="sectiontitle">Attributes</div>
<table border='0' cellpadding='5'>
<tr valign='top'>
<td class='attr-rw'>
[R]
</td>
<td class='attr-name'>driver</td>
<td class='attr-desc'>
A reference to the underlying <a href="../SQLite3.html">SQLite3</a> driver
used by this database.
</td>
</tr>
<tr valign='top'>
<td class='attr-rw'>
[R]
</td>
<td class='attr-name'>handle</td>
<td class='attr-desc'>
The low-level opaque database handle that this object wraps.
</td>
</tr>
<tr valign='top'>
<td class='attr-rw'>
[RW]
</td>
<td class='attr-name'>results_as_hash</td>
<td class='attr-desc'>
A boolean that indicates whether rows in result sets should be returned as
hashes or not. By default, rows are returned as arrays.
</td>
</tr>
<tr valign='top'>
<td class='attr-rw'>
[RW]
</td>
<td class='attr-name'>type_translation</td>
<td class='attr-desc'>
A boolean indicating whether or not type translation is enabled for this
database.
</td>
</tr>
</table>
<div class="sectiontitle">Public Class methods</div>
<div class="method">
<div class="title">
<a name="M000095"></a><b>new</b>( file_name, options={} )
</div>
<div class="description">
<p>
Create a <a href="Database.html#M000095">new</a> <a
href="Database.html">Database</a> object that opens the given file. If
utf16 is <tt>true</tt>, the filename is interpreted as a UTF-16 encoded
string.
</p>
<p>
By default, the <a href="Database.html#M000095">new</a> database will
return result rows as arrays (results_as_hash) and has type translation
disabled (type_translation=).
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000095_source')" id="l_M000095_source">show source</a> ]</p>
<div id="M000095_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 72</span>
72: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>( <span class="ruby-identifier">file_name</span>, <span class="ruby-identifier">options</span>={} )
73: <span class="ruby-identifier">utf16</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">:utf16</span>, <span class="ruby-keyword kw">false</span>)
74: <span class="ruby-identifier">load_driver</span>( <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:driver</span>] )
75:
76: <span class="ruby-ivar">@statement_factory</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:statement_factory</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">Statement</span>
77:
78: <span class="ruby-identifier">result</span>, <span class="ruby-ivar">@handle</span> = <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">open</span>( <span class="ruby-identifier">file_name</span>, <span class="ruby-identifier">utf16</span> )
79: <span class="ruby-constant">Error</span>.<span class="ruby-identifier">check</span>( <span class="ruby-identifier">result</span>, <span class="ruby-keyword kw">self</span>, <span class="ruby-value str">"could not open database"</span> )
80:
81: <span class="ruby-ivar">@closed</span> = <span class="ruby-keyword kw">false</span>
82: <span class="ruby-ivar">@results_as_hash</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">:results_as_hash</span>,<span class="ruby-keyword kw">false</span>)
83: <span class="ruby-ivar">@type_translation</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">:type_translation</span>,<span class="ruby-keyword kw">false</span>)
84: <span class="ruby-ivar">@translator</span> = <span class="ruby-keyword kw">nil</span>
85: <span class="ruby-ivar">@transaction_active</span> = <span class="ruby-keyword kw">false</span>
86: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000094"></a><b>quote</b>( string )
</div>
<div class="description">
<p>
Quotes the given string, making it safe to use in an SQL statement. It
replaces all instances of the single-<a
href="Database.html#M000094">quote</a> character with two single-<a
href="Database.html#M000094">quote</a> characters. The modified string is
returned.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000094_source')" id="l_M000094_source">show source</a> ]</p>
<div id="M000094_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 47</span>
47: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">quote</span>( <span class="ruby-identifier">string</span> )
48: <span class="ruby-identifier">string</span>.<span class="ruby-identifier">gsub</span>( <span class="ruby-regexp re">/'/</span>, <span class="ruby-value str">"''"</span> )
49: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="sectiontitle">Public Instance methods</div>
<div class="method">
<div class="title">
<a name="M000103"></a><b>authorizer</b>( data=nil, &block )
</div>
<div class="description">
<p>
Installs (or removes) a block that will be invoked for every access to the
database. If the block returns 0 (or <tt>nil</tt>), the statement is
allowed to proceed. Returning 1 causes an authorization error to occur, and
returning 2 causes the access to be silently denied.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000103_source')" id="l_M000103_source">show source</a> ]</p>
<div id="M000103_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 143</span>
143: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">authorizer</span>( <span class="ruby-identifier">data</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span> )
144: <span class="ruby-identifier">result</span> = <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">set_authorizer</span>( <span class="ruby-ivar">@handle</span>, <span class="ruby-identifier">data</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span> )
145: <span class="ruby-constant">Error</span>.<span class="ruby-identifier">check</span>( <span class="ruby-identifier">result</span>, <span class="ruby-keyword kw">self</span> )
146: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000115"></a><b>busy_handler</b>( data=nil ) {|data, retries| ...}
</div>
<div class="description">
<p>
Register a busy handler with this database instance. When a requested
resource is busy, this handler will be invoked. If the handler returns
<tt>false</tt>, the operation will be aborted; otherwise, the resource will
be requested again.
</p>
<p>
The handler will be invoked with the name of the resource that was busy,
and the number of times it has been retried.
</p>
<p>
See also the mutually exclusive <a
href="Database.html#M000116">busy_timeout</a>.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000115_source')" id="l_M000115_source">show source</a> ]</p>
<div id="M000115_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 309</span>
309: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">busy_handler</span>( <span class="ruby-identifier">data</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span> ) <span class="ruby-comment cmt"># :yields: data, retries</span>
310: <span class="ruby-identifier">result</span> = <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">busy_handler</span>( <span class="ruby-ivar">@handle</span>, <span class="ruby-identifier">data</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span> )
311: <span class="ruby-constant">Error</span>.<span class="ruby-identifier">check</span>( <span class="ruby-identifier">result</span>, <span class="ruby-keyword kw">self</span> )
312: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000116"></a><b>busy_timeout</b>( ms )
</div>
<div class="description">
<p>
Indicates that if a request for a resource terminates because that resource
is busy, SQLite should sleep and retry for up to the indicated number of
milliseconds. By default, SQLite does not retry busy resources. To restore
the default behavior, send 0 as the <tt>ms</tt> parameter.
</p>
<p>
See also the mutually exclusive <a
href="Database.html#M000115">busy_handler</a>.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000116_source')" id="l_M000116_source">show source</a> ]</p>
<div id="M000116_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 321</span>
321: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">busy_timeout</span>( <span class="ruby-identifier">ms</span> )
322: <span class="ruby-identifier">result</span> = <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">busy_timeout</span>( <span class="ruby-ivar">@handle</span>, <span class="ruby-identifier">ms</span> )
323: <span class="ruby-constant">Error</span>.<span class="ruby-identifier">check</span>( <span class="ruby-identifier">result</span>, <span class="ruby-keyword kw">self</span> )
324: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000112"></a><b>changes</b>()
</div>
<div class="description">
<p>
Returns the number of <a href="Database.html#M000112">changes</a> made to
this database instance by the last operation performed. Note that a
"delete from table" without a where clause will not affect this
value.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000112_source')" id="l_M000112_source">show source</a> ]</p>
<div id="M000112_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 285</span>
285: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">changes</span>
286: <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">changes</span>( <span class="ruby-ivar">@handle</span> )
287: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000100"></a><b>close</b>()
</div>
<div class="description">
<p>
Closes this database.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000100_source')" id="l_M000100_source">show source</a> ]</p>
<div id="M000100_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 118</span>
118: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">close</span>
119: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@closed</span>
120: <span class="ruby-identifier">result</span> = <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">close</span>( <span class="ruby-ivar">@handle</span> )
121: <span class="ruby-constant">Error</span>.<span class="ruby-identifier">check</span>( <span class="ruby-identifier">result</span>, <span class="ruby-keyword kw">self</span> )
122: <span class="ruby-keyword kw">end</span>
123: <span class="ruby-ivar">@closed</span> = <span class="ruby-keyword kw">true</span>
124: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000101"></a><b>closed?</b>()
</div>
<div class="description">
<p>
Returns <tt>true</tt> if this database instance has been closed (see <a
href="Database.html#M000100">close</a>).
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000101_source')" id="l_M000101_source">show source</a> ]</p>
<div id="M000101_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 127</span>
127: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">closed?</span>
128: <span class="ruby-ivar">@closed</span>
129: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000121"></a><b>commit</b>()
</div>
<div class="description">
<p>
Commits the current <a href="Database.html#M000120">transaction</a>. If
there is no current <a href="Database.html#M000120">transaction</a>, this
will cause an error to be raised. This returns <tt>true</tt>, in order to
allow it to be used in idioms like <tt>abort? and <a
href="Database.html#M000122">rollback</a> or <a
href="Database.html#M000121">commit</a></tt>.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000121_source')" id="l_M000121_source">show source</a> ]</p>
<div id="M000121_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 580</span>
580: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">commit</span>
581: <span class="ruby-identifier">execute</span> <span class="ruby-value str">"commit transaction"</span>
582: <span class="ruby-ivar">@transaction_active</span> = <span class="ruby-keyword kw">false</span>
583: <span class="ruby-keyword kw">true</span>
584: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000096"></a><b>complete?</b>( string, utf16=false )
</div>
<div class="description">
<p>
Return <tt>true</tt> if the string is a valid (ie, parsable) SQL statement,
and <tt>false</tt> otherwise. If +utf16+ is <tt>true</tt>, then the string
is a UTF-16 character string.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000096_source')" id="l_M000096_source">show source</a> ]</p>
<div id="M000096_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 91</span>
91: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">complete?</span>( <span class="ruby-identifier">string</span>, <span class="ruby-identifier">utf16</span>=<span class="ruby-keyword kw">false</span> )
92: <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">complete?</span>( <span class="ruby-identifier">string</span>, <span class="ruby-identifier">utf16</span> )
93: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000118"></a><b>create_aggregate</b>( name, arity, step=nil, finalize=nil, text_rep=Constants::TextRep::ANY, &block )
</div>
<div class="description">
<p>
Creates a <a href="Database.html#M000095">new</a> aggregate function for
use in SQL statements. Aggregate functions are functions that apply over
every row in the result set, instead of over just a single row. (A very
common aggregate function is the "count" function, for
determining the number of rows that match a <a
href="Database.html#M000108">query</a>.)
</p>
<p>
The <a href="Database.html#M000095">new</a> function will be added as
<tt>name</tt>, with the given <tt>arity</tt>. (For variable arity
functions, use -1 for the arity.)
</p>
<p>
The <tt>step</tt> parameter must be a proc object that accepts as its first
parameter a <a href="Database/FunctionProxy.html">FunctionProxy</a>
instance (representing the function invocation), with any subsequent
parameters (up to the function‘s arity). The <tt>step</tt> callback
will be invoked once for each row of the result set.
</p>
<p>
The <tt>finalize</tt> parameter must be a <tt>proc</tt> object that accepts
only a single parameter, the <a
href="Database/FunctionProxy.html">FunctionProxy</a> instance representing
the current function invocation. It should invoke <a
href="Database/FunctionProxy.html#M000126">FunctionProxy#set_result</a> to
store the result of the function.
</p>
<p>
Example:
</p>
<pre>
db.create_aggregate( "lengths", 1 ) do
step do |func, value|
func[ :total ] ||= 0
func[ :total ] += ( value ? value.length : 0 )
end
finalize do |func|
func.set_result( func[ :total ] || 0 )
end
end
puts db.get_first_value( "select lengths(name) from table" )
</pre>
<p>
See also <a href="Database.html#M000119">create_aggregate_handler</a> for a
more object-oriented approach to aggregate functions.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000118_source')" id="l_M000118_source">show source</a> ]</p>
<div id="M000118_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 405</span>
405: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_aggregate</span>( <span class="ruby-identifier">name</span>, <span class="ruby-identifier">arity</span>, <span class="ruby-identifier">step</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">finalize</span>=<span class="ruby-keyword kw">nil</span>,
406: <span class="ruby-identifier">text_rep</span>=<span class="ruby-constant">Constants</span><span class="ruby-operator">::</span><span class="ruby-constant">TextRep</span><span class="ruby-operator">::</span><span class="ruby-constant">ANY</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span> )
407: <span class="ruby-comment cmt"># begin</span>
408: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block</span>
409: <span class="ruby-identifier">proxy</span> = <span class="ruby-constant">AggregateDefinitionProxy</span>.<span class="ruby-identifier">new</span>
410: <span class="ruby-identifier">proxy</span>.<span class="ruby-identifier">instance_eval</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
411: <span class="ruby-identifier">step</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">proxy</span>.<span class="ruby-identifier">step_callback</span>
412: <span class="ruby-identifier">finalize</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">proxy</span>.<span class="ruby-identifier">finalize_callback</span>
413: <span class="ruby-keyword kw">end</span>
414:
415: <span class="ruby-identifier">step_callback</span> = <span class="ruby-identifier">proc</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">func</span>,<span class="ruby-operator">*</span><span class="ruby-identifier">args</span><span class="ruby-operator">|</span>
416: <span class="ruby-identifier">ctx</span> = <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">aggregate_context</span>( <span class="ruby-identifier">func</span> )
417: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">ctx</span>[<span class="ruby-identifier">:__error</span>]
418: <span class="ruby-keyword kw">begin</span>
419: <span class="ruby-identifier">step</span>.<span class="ruby-identifier">call</span>( <span class="ruby-constant">FunctionProxy</span>.<span class="ruby-identifier">new</span>( <span class="ruby-ivar">@driver</span>, <span class="ruby-identifier">func</span>, <span class="ruby-identifier">ctx</span> ),
420: <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>.<span class="ruby-identifier">map</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-constant">Value</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>,<span class="ruby-identifier">v</span>)} )
421: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
422: <span class="ruby-identifier">ctx</span>[<span class="ruby-identifier">:__error</span>] = <span class="ruby-identifier">e</span>
423: <span class="ruby-keyword kw">end</span>
424: <span class="ruby-keyword kw">end</span>
425: <span class="ruby-keyword kw">end</span>
426:
427: <span class="ruby-identifier">finalize_callback</span> = <span class="ruby-identifier">proc</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">func</span><span class="ruby-operator">|</span>
428: <span class="ruby-identifier">ctx</span> = <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">aggregate_context</span>( <span class="ruby-identifier">func</span> )
429: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">ctx</span>[<span class="ruby-identifier">:__error</span>]
430: <span class="ruby-keyword kw">begin</span>
431: <span class="ruby-identifier">finalize</span>.<span class="ruby-identifier">call</span>( <span class="ruby-constant">FunctionProxy</span>.<span class="ruby-identifier">new</span>( <span class="ruby-ivar">@driver</span>, <span class="ruby-identifier">func</span>, <span class="ruby-identifier">ctx</span> ) )
432: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
433: <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">result_error</span>( <span class="ruby-identifier">func</span>,
434: <span class="ruby-node">"#{e.message} (#{e.class})"</span>, <span class="ruby-value">-1</span> )
435: <span class="ruby-keyword kw">end</span>
436: <span class="ruby-keyword kw">else</span>
437: <span class="ruby-identifier">e</span> = <span class="ruby-identifier">ctx</span>[<span class="ruby-identifier">:__error</span>]
438: <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">result_error</span>( <span class="ruby-identifier">func</span>,
439: <span class="ruby-node">"#{e.message} (#{e.class})"</span>, <span class="ruby-value">-1</span> )
440: <span class="ruby-keyword kw">end</span>
441: <span class="ruby-keyword kw">end</span>
442:
443: <span class="ruby-identifier">result</span> = <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">create_function</span>( <span class="ruby-ivar">@handle</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">arity</span>, <span class="ruby-identifier">text_rep</span>, <span class="ruby-keyword kw">nil</span>,
444: <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">step_callback</span>, <span class="ruby-identifier">finalize_callback</span> )
445: <span class="ruby-constant">Error</span>.<span class="ruby-identifier">check</span>( <span class="ruby-identifier">result</span>, <span class="ruby-keyword kw">self</span> )
446:
447: <span class="ruby-keyword kw">self</span>
448: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000119"></a><b>create_aggregate_handler</b>( handler )
</div>
<div class="description">
<p>
This is another approach to creating an aggregate function (see <a
href="Database.html#M000118">create_aggregate</a>). Instead of explicitly
specifying the name, callbacks, arity, and type, you specify a factory
object (the "handler") that knows how to obtain all of that
information. The handler should respond to the following messages:
</p>
<table>
<tr><td valign="top"><tt>arity</tt>:</td><td>corresponds to the <tt>arity</tt> parameter of <a
href="Database.html#M000118">create_aggregate</a>. This message is
optional, and if the handler does not respond to it, the function will have
an arity of -1.
</td></tr>
<tr><td valign="top"><tt>name</tt>:</td><td>this is the name of the function. The handler <em>must</em> implement this
message.
</td></tr>
<tr><td valign="top"><tt><a href="Database.html#M000095">new</a></tt>:</td><td>this must be implemented by the handler. It should return a <a
href="Database.html#M000095">new</a> instance of the object that will
handle a specific invocation of the function.
</td></tr>
</table>
<p>
The handler instance (the object returned by the <tt><a
href="Database.html#M000095">new</a></tt> message, described above), must
respond to the following messages:
</p>
<table>
<tr><td valign="top"><tt>step</tt>:</td><td>this is the method that will be called for each step of the aggregate
function‘s evaluation. It should implement the same signature as the
<tt>step</tt> callback for <a
href="Database.html#M000118">create_aggregate</a>.
</td></tr>
<tr><td valign="top"><tt>finalize</tt>:</td><td>this is the method that will be called to finalize the aggregate
function‘s evaluation. It should implement the same signature as the
<tt>finalize</tt> callback for <a
href="Database.html#M000118">create_aggregate</a>.
</td></tr>
</table>
<p>
Example:
</p>
<pre>
class LengthsAggregateHandler
def self.arity; 1; end
def initialize
@total = 0
end
def step( ctx, name )
@total += ( name ? name.length : 0 )
end
def finalize( ctx )
ctx.set_result( @total )
end
end
db.create_aggregate_handler( LengthsAggregateHandler )
puts db.get_first_value( "select lengths(name) from A" )
</pre>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000119_source')" id="l_M000119_source">show source</a> ]</p>
<div id="M000119_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 496</span>
496: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_aggregate_handler</span>( <span class="ruby-identifier">handler</span> )
497: <span class="ruby-identifier">arity</span> = <span class="ruby-value">-1</span>
498: <span class="ruby-identifier">text_rep</span> = <span class="ruby-constant">Constants</span><span class="ruby-operator">::</span><span class="ruby-constant">TextRep</span><span class="ruby-operator">::</span><span class="ruby-constant">ANY</span>
499:
500: <span class="ruby-identifier">arity</span> = <span class="ruby-identifier">handler</span>.<span class="ruby-identifier">arity</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">handler</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">:arity</span>)
501: <span class="ruby-identifier">text_rep</span> = <span class="ruby-identifier">handler</span>.<span class="ruby-identifier">text_rep</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">handler</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">:text_rep</span>)
502: <span class="ruby-identifier">name</span> = <span class="ruby-identifier">handler</span>.<span class="ruby-identifier">name</span>
503:
504: <span class="ruby-identifier">step</span> = <span class="ruby-identifier">proc</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">func</span>,<span class="ruby-operator">*</span><span class="ruby-identifier">args</span><span class="ruby-operator">|</span>
505: <span class="ruby-identifier">ctx</span> = <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">aggregate_context</span>( <span class="ruby-identifier">func</span> )
506: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">ctx</span>[ <span class="ruby-identifier">:__error</span> ]
507: <span class="ruby-identifier">ctx</span>[ <span class="ruby-identifier">:handler</span> ] <span class="ruby-operator">||=</span> <span class="ruby-identifier">handler</span>.<span class="ruby-identifier">new</span>
508: <span class="ruby-keyword kw">begin</span>
509: <span class="ruby-identifier">ctx</span>[ <span class="ruby-identifier">:handler</span> ].<span class="ruby-identifier">step</span>( <span class="ruby-constant">FunctionProxy</span>.<span class="ruby-identifier">new</span>( <span class="ruby-ivar">@driver</span>, <span class="ruby-identifier">func</span>, <span class="ruby-identifier">ctx</span> ),
510: <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>.<span class="ruby-identifier">map</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-constant">Value</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>,<span class="ruby-identifier">v</span>)} )
511: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span>, <span class="ruby-constant">StandardError</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
512: <span class="ruby-identifier">ctx</span>[ <span class="ruby-identifier">:__error</span> ] = <span class="ruby-identifier">e</span>
513: <span class="ruby-keyword kw">end</span>
514: <span class="ruby-keyword kw">end</span>
515: <span class="ruby-keyword kw">end</span>
516:
517: <span class="ruby-identifier">finalize</span> = <span class="ruby-identifier">proc</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">func</span><span class="ruby-operator">|</span>
518: <span class="ruby-identifier">ctx</span> = <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">aggregate_context</span>( <span class="ruby-identifier">func</span> )
519: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">ctx</span>[ <span class="ruby-identifier">:__error</span> ]
520: <span class="ruby-identifier">ctx</span>[ <span class="ruby-identifier">:handler</span> ] <span class="ruby-operator">||=</span> <span class="ruby-identifier">handler</span>.<span class="ruby-identifier">new</span>
521: <span class="ruby-keyword kw">begin</span>
522: <span class="ruby-identifier">ctx</span>[ <span class="ruby-identifier">:handler</span> ].<span class="ruby-identifier">finalize</span>( <span class="ruby-constant">FunctionProxy</span>.<span class="ruby-identifier">new</span>( <span class="ruby-ivar">@driver</span>, <span class="ruby-identifier">func</span>, <span class="ruby-identifier">ctx</span> ) )
523: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
524: <span class="ruby-identifier">ctx</span>[ <span class="ruby-identifier">:__error</span> ] = <span class="ruby-identifier">e</span>
525: <span class="ruby-keyword kw">end</span>
526: <span class="ruby-keyword kw">end</span>
527:
528: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">ctx</span>[ <span class="ruby-identifier">:__error</span> ]
529: <span class="ruby-identifier">e</span> = <span class="ruby-identifier">ctx</span>[ <span class="ruby-identifier">:__error</span> ]
530: <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">sqlite3_result_error</span>( <span class="ruby-identifier">func</span>, <span class="ruby-node">"#{e.message} (#{e.class})"</span>, <span class="ruby-value">-1</span> )
531: <span class="ruby-keyword kw">end</span>
532: <span class="ruby-keyword kw">end</span>
533:
534: <span class="ruby-identifier">result</span> = <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">create_function</span>( <span class="ruby-ivar">@handle</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">arity</span>, <span class="ruby-identifier">text_rep</span>, <span class="ruby-keyword kw">nil</span>,
535: <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">step</span>, <span class="ruby-identifier">finalize</span> )
536: <span class="ruby-constant">Error</span>.<span class="ruby-identifier">check</span>( <span class="ruby-identifier">result</span>, <span class="ruby-keyword kw">self</span> )
537:
538: <span class="ruby-keyword kw">self</span>
539: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000117"></a><b>create_function</b>( name, arity, text_rep=Constants::TextRep::ANY ) {|func, *args| ...}
</div>
<div class="description">
<p>
Creates a <a href="Database.html#M000095">new</a> function for use in SQL
statements. It will be added as <tt>name</tt>, with the given
<tt>arity</tt>. (For variable arity functions, use -1 for the arity.)
</p>
<p>
The block should accept at least one parameter—the <a
href="Database/FunctionProxy.html">FunctionProxy</a> instance that wraps
this function invocation—and any other arguments it needs (up to its
arity).
</p>
<p>
The block does not return a value directly. Instead, it will invoke the <a
href="Database/FunctionProxy.html#M000126">FunctionProxy#set_result</a>
method on the <tt>func</tt> parameter and indicate the return value that
way.
</p>
<p>
Example:
</p>
<pre>
db.create_function( "maim", 1 ) do |func, value|
if value.nil?
func.result = nil
else
func.result = value.split(//).sort.join
end
end
puts db.get_first_value( "select maim(name) from table" )
</pre>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000117_source')" id="l_M000117_source">show source</a> ]</p>
<div id="M000117_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 349</span>
349: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_function</span>( <span class="ruby-identifier">name</span>, <span class="ruby-identifier">arity</span>, <span class="ruby-identifier">text_rep</span>=<span class="ruby-constant">Constants</span><span class="ruby-operator">::</span><span class="ruby-constant">TextRep</span><span class="ruby-operator">::</span><span class="ruby-constant">ANY</span>,
350: <span class="ruby-operator">&</span><span class="ruby-identifier">block</span> ) <span class="ruby-comment cmt"># :yields: func, *args</span>
351: <span class="ruby-comment cmt"># begin</span>
352: <span class="ruby-identifier">callback</span> = <span class="ruby-identifier">proc</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">func</span>,<span class="ruby-operator">*</span><span class="ruby-identifier">args</span><span class="ruby-operator">|</span>
353: <span class="ruby-keyword kw">begin</span>
354: <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>( <span class="ruby-constant">FunctionProxy</span>.<span class="ruby-identifier">new</span>( <span class="ruby-ivar">@driver</span>, <span class="ruby-identifier">func</span> ),
355: <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>.<span class="ruby-identifier">map</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-constant">Value</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>,<span class="ruby-identifier">v</span>)} )
356: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">StandardError</span>, <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
357: <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">result_error</span>( <span class="ruby-identifier">func</span>,
358: <span class="ruby-node">"#{e.message} (#{e.class})"</span>, <span class="ruby-value">-1</span> )
359: <span class="ruby-keyword kw">end</span>
360: <span class="ruby-keyword kw">end</span>
361:
362: <span class="ruby-identifier">result</span> = <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">create_function</span>( <span class="ruby-ivar">@handle</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">arity</span>, <span class="ruby-identifier">text_rep</span>, <span class="ruby-keyword kw">nil</span>,
363: <span class="ruby-identifier">callback</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-keyword kw">nil</span> )
364: <span class="ruby-constant">Error</span>.<span class="ruby-identifier">check</span>( <span class="ruby-identifier">result</span>, <span class="ruby-keyword kw">self</span> )
365:
366: <span class="ruby-keyword kw">self</span>
367: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000098"></a><b>errcode</b>()
</div>
<div class="description">
<p>
Return an integer representing the last error to have occurred with this
database.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000098_source')" id="l_M000098_source">show source</a> ]</p>
<div id="M000098_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 103</span>
103: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">errcode</span>
104: <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">errcode</span>( <span class="ruby-ivar">@handle</span> )
105: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000097"></a><b>errmsg</b>( utf16=false )
</div>
<div class="description">
<p>
Return a string describing the last error to have occurred with this
database.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000097_source')" id="l_M000097_source">show source</a> ]</p>
<div id="M000097_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 97</span>
97: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">errmsg</span>( <span class="ruby-identifier">utf16</span>=<span class="ruby-keyword kw">false</span> )
98: <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">errmsg</span>( <span class="ruby-ivar">@handle</span>, <span class="ruby-identifier">utf16</span> )
99: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000105"></a><b>execute</b>( sql, *bind_vars ) {|row| ...}
</div>
<div class="description">
<p>
Executes the given SQL statement. If additional parameters are given, they
are treated as bind variables, and are bound to the placeholders in the <a
href="Database.html#M000108">query</a>.
</p>
<p>
Note that if any of the values passed to this are hashes, then the
key/value pairs are each bound separately, with the key being used as the
name of the placeholder to bind the value to.
</p>
<p>
The block is optional. If given, it will be invoked for each row returned
by the <a href="Database.html#M000108">query</a>. Otherwise, any results
are accumulated into an array and returned wholesale.
</p>
<p>
See also <a href="Database.html#M000106">execute2</a>, <a
href="Database.html#M000108">query</a>, and <a
href="Database.html#M000107">execute_batch</a> for additional ways of
executing statements.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000105_source')" id="l_M000105_source">show source</a> ]</p>
<div id="M000105_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 180</span>
180: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">execute</span>( <span class="ruby-identifier">sql</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">bind_vars</span> )
181: <span class="ruby-identifier">prepare</span>( <span class="ruby-identifier">sql</span> ) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">stmt</span><span class="ruby-operator">|</span>
182: <span class="ruby-identifier">result</span> = <span class="ruby-identifier">stmt</span>.<span class="ruby-identifier">execute</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">bind_vars</span> )
183: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
184: <span class="ruby-identifier">result</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">row</span><span class="ruby-operator">|</span> <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">row</span> }
185: <span class="ruby-keyword kw">else</span>
186: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">inject</span>( [] ) { <span class="ruby-operator">|</span><span class="ruby-identifier">arr</span>,<span class="ruby-identifier">row</span><span class="ruby-operator">|</span> <span class="ruby-identifier">arr</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">row</span>; <span class="ruby-identifier">arr</span> }
187: <span class="ruby-keyword kw">end</span>
188: <span class="ruby-keyword kw">end</span>
189: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000106"></a><b>execute2</b>( sql, *bind_vars ) {|result.columns| ...}
</div>
<div class="description">
<p>
Executes the given SQL statement, exactly as with <a
href="Database.html#M000105">execute</a>. However, the first row returned
(either via the block, or in the returned array) is always the names of the
columns. Subsequent rows correspond to the data from the result set.
</p>
<p>
Thus, even if the <a href="Database.html#M000108">query</a> itself returns
no rows, this method will always return at least one row—the names of
the columns.
</p>
<p>
See also <a href="Database.html#M000105">execute</a>, <a
href="Database.html#M000108">query</a>, and <a
href="Database.html#M000107">execute_batch</a> for additional ways of
executing statements.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000106_source')" id="l_M000106_source">show source</a> ]</p>
<div id="M000106_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 201</span>
201: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">execute2</span>( <span class="ruby-identifier">sql</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">bind_vars</span> )
202: <span class="ruby-identifier">prepare</span>( <span class="ruby-identifier">sql</span> ) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">stmt</span><span class="ruby-operator">|</span>
203: <span class="ruby-identifier">result</span> = <span class="ruby-identifier">stmt</span>.<span class="ruby-identifier">execute</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">bind_vars</span> )
204: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
205: <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">columns</span>
206: <span class="ruby-identifier">result</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">row</span><span class="ruby-operator">|</span> <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">row</span> }
207: <span class="ruby-keyword kw">else</span>
208: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">inject</span>( [ <span class="ruby-identifier">result</span>.<span class="ruby-identifier">columns</span> ] ) { <span class="ruby-operator">|</span><span class="ruby-identifier">arr</span>,<span class="ruby-identifier">row</span><span class="ruby-operator">|</span>
209: <span class="ruby-identifier">arr</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">row</span>; <span class="ruby-identifier">arr</span> }
210: <span class="ruby-keyword kw">end</span>
211: <span class="ruby-keyword kw">end</span>
212: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000107"></a><b>execute_batch</b>( sql, *bind_vars )
</div>
<div class="description">
<p>
Executes all SQL statements in the given string. By contrast, the other
means of executing queries will only <a
href="Database.html#M000105">execute</a> the first statement in the string,
ignoring all subsequent statements. This will <a
href="Database.html#M000105">execute</a> each one in turn. The same bind
parameters, if given, will be applied to each statement.
</p>
<p>
This always returns <tt>nil</tt>, making it unsuitable for queries that
return rows.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000107_source')" id="l_M000107_source">show source</a> ]</p>
<div id="M000107_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 222</span>
222: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">execute_batch</span>( <span class="ruby-identifier">sql</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">bind_vars</span> )
223: <span class="ruby-identifier">sql</span> = <span class="ruby-identifier">sql</span>.<span class="ruby-identifier">strip</span>
224: <span class="ruby-keyword kw">until</span> <span class="ruby-identifier">sql</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-keyword kw">do</span>
225: <span class="ruby-identifier">prepare</span>( <span class="ruby-identifier">sql</span> ) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">stmt</span><span class="ruby-operator">|</span>
226: <span class="ruby-identifier">stmt</span>.<span class="ruby-identifier">execute</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">bind_vars</span> )
227: <span class="ruby-identifier">sql</span> = <span class="ruby-identifier">stmt</span>.<span class="ruby-identifier">remainder</span>.<span class="ruby-identifier">strip</span>
228: <span class="ruby-keyword kw">end</span>
229: <span class="ruby-keyword kw">end</span>
230: <span class="ruby-keyword kw">nil</span>
231: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000109"></a><b>get_first_row</b>( sql, *bind_vars )
</div>
<div class="description">
<p>
A convenience method for obtaining the first row of a result set, and
discarding all others. It is otherwise identical to <a
href="Database.html#M000105">execute</a>.
</p>
<p>
See also <a href="Database.html#M000110">get_first_value</a>.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000109_source')" id="l_M000109_source">show source</a> ]</p>
<div id="M000109_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 261</span>
261: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_first_row</span>( <span class="ruby-identifier">sql</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">bind_vars</span> )
262: <span class="ruby-identifier">execute</span>( <span class="ruby-identifier">sql</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">bind_vars</span> ) { <span class="ruby-operator">|</span><span class="ruby-identifier">row</span><span class="ruby-operator">|</span> <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">row</span> }
263: <span class="ruby-keyword kw">nil</span>
264: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000110"></a><b>get_first_value</b>( sql, *bind_vars )
</div>
<div class="description">
<p>
A convenience method for obtaining the first value of the first row of a
result set, and discarding all other values and rows. It is otherwise
identical to <a href="Database.html#M000105">execute</a>.
</p>
<p>
See also <a href="Database.html#M000109">get_first_row</a>.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000110_source')" id="l_M000110_source">show source</a> ]</p>
<div id="M000110_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 271</span>
271: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_first_value</span>( <span class="ruby-identifier">sql</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">bind_vars</span> )
272: <span class="ruby-identifier">execute</span>( <span class="ruby-identifier">sql</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">bind_vars</span> ) { <span class="ruby-operator">|</span><span class="ruby-identifier">row</span><span class="ruby-operator">|</span> <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">row</span>[<span class="ruby-value">0</span>] }
273: <span class="ruby-keyword kw">nil</span>
274: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000114"></a><b>interrupt</b>()
</div>
<div class="description">
<p>
Interrupts the currently executing operation, causing it to abort.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000114_source')" id="l_M000114_source">show source</a> ]</p>
<div id="M000114_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 296</span>
296: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">interrupt</span>
297: <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">interrupt</span>( <span class="ruby-ivar">@handle</span> )
298: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000111"></a><b>last_insert_row_id</b>()
</div>
<div class="description">
<p>
Obtains the unique row ID of the last row to be inserted by this <a
href="Database.html">Database</a> instance.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000111_source')" id="l_M000111_source">show source</a> ]</p>
<div id="M000111_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 278</span>
278: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">last_insert_row_id</span>
279: <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">last_insert_rowid</span>( <span class="ruby-ivar">@handle</span> )
280: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000104"></a><b>prepare</b>( sql ) {|stmt| ...}
</div>
<div class="description">
<p>
Returns a <a href="Statement.html">Statement</a> object representing the
given SQL. This does not <a href="Database.html#M000105">execute</a> the
statement; it merely prepares the statement for execution.
</p>
<p>
The <a href="Statement.html">Statement</a> can then be executed using <a
href="Statement.html#M000079">Statement#execute</a>.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000104_source')" id="l_M000104_source">show source</a> ]</p>
<div id="M000104_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 153</span>
153: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">prepare</span>( <span class="ruby-identifier">sql</span> )
154: <span class="ruby-identifier">stmt</span> = <span class="ruby-ivar">@statement_factory</span>.<span class="ruby-identifier">new</span>( <span class="ruby-keyword kw">self</span>, <span class="ruby-identifier">sql</span> )
155: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
156: <span class="ruby-keyword kw">begin</span>
157: <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">stmt</span>
158: <span class="ruby-keyword kw">ensure</span>
159: <span class="ruby-identifier">stmt</span>.<span class="ruby-identifier">close</span>
160: <span class="ruby-keyword kw">end</span>
161: <span class="ruby-keyword kw">else</span>
162: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">stmt</span>
163: <span class="ruby-keyword kw">end</span>
164: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000108"></a><b>query</b>( sql, *bind_vars ) {|result| ...}
</div>
<div class="description">
<p>
This is a convenience method for creating a statement, binding paramters to
it, and calling <a href="Database.html#M000105">execute</a>:
</p>
<pre>
result = db.query( "select * from foo where a=?", 5 )
# is the same as
result = db.prepare( "select * from foo where a=?" ).execute( 5 )
</pre>
<p>
You must be sure to call <tt><a href="Database.html#M000100">close</a></tt>
on the <a href="ResultSet.html">ResultSet</a> instance that is returned, or
you could have problems with locks on the table. If called with a block,
<tt><a href="Database.html#M000100">close</a></tt> will be invoked
implicitly when the block terminates.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000108_source')" id="l_M000108_source">show source</a> ]</p>
<div id="M000108_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 244</span>
244: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">query</span>( <span class="ruby-identifier">sql</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">bind_vars</span> )
245: <span class="ruby-identifier">result</span> = <span class="ruby-identifier">prepare</span>( <span class="ruby-identifier">sql</span> ).<span class="ruby-identifier">execute</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">bind_vars</span> )
246: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
247: <span class="ruby-keyword kw">begin</span>
248: <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">result</span>
249: <span class="ruby-keyword kw">ensure</span>
250: <span class="ruby-identifier">result</span>.<span class="ruby-identifier">close</span>
251: <span class="ruby-keyword kw">end</span>
252: <span class="ruby-keyword kw">else</span>
253: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">result</span>
254: <span class="ruby-keyword kw">end</span>
255: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000122"></a><b>rollback</b>()
</div>
<div class="description">
<p>
Rolls the current <a href="Database.html#M000120">transaction</a> back. If
there is no current <a href="Database.html#M000120">transaction</a>, this
will cause an error to be raised. This returns <tt>true</tt>, in order to
allow it to be used in idioms like <tt>abort? and <a
href="Database.html#M000122">rollback</a> or <a
href="Database.html#M000121">commit</a></tt>.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000122_source')" id="l_M000122_source">show source</a> ]</p>
<div id="M000122_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 590</span>
590: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rollback</span>
591: <span class="ruby-identifier">execute</span> <span class="ruby-value str">"rollback transaction"</span>
592: <span class="ruby-ivar">@transaction_active</span> = <span class="ruby-keyword kw">false</span>
593: <span class="ruby-keyword kw">true</span>
594: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000113"></a><b>total_changes</b>()
</div>
<div class="description">
<p>
Returns the total number of <a href="Database.html#M000112">changes</a>
made to this database instance since it was opened.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000113_source')" id="l_M000113_source">show source</a> ]</p>
<div id="M000113_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 291</span>
291: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">total_changes</span>
292: <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">total_changes</span>( <span class="ruby-ivar">@handle</span> )
293: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000102"></a><b>trace</b>( data=nil, &block )
</div>
<div class="description">
<p>
Installs (or removes) a block that will be invoked for every SQL statement
executed. The block receives a two parameters: the <tt>data</tt> argument,
and the SQL statement executed. If the block is <tt>nil</tt>, any existing
tracer will be uninstalled.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000102_source')" id="l_M000102_source">show source</a> ]</p>
<div id="M000102_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 135</span>
135: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">trace</span>( <span class="ruby-identifier">data</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span> )
136: <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">trace</span>( <span class="ruby-ivar">@handle</span>, <span class="ruby-identifier">data</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span> )
137: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000120"></a><b>transaction</b>( mode = :deferred ) {|self| ...}
</div>
<div class="description">
<p>
Begins a <a href="Database.html#M000095">new</a> <a
href="Database.html#M000120">transaction</a>. Note that nested transactions
are not allowed by SQLite, so attempting to nest a <a
href="Database.html#M000120">transaction</a> will result in a runtime
exception.
</p>
<p>
The <tt>mode</tt> parameter may be either <tt>:deferred</tt> (the default),
<tt>:immediate</tt>, or <tt>:exclusive</tt>.
</p>
<p>
If a block is given, the database instance is yielded to it, and the <a
href="Database.html#M000120">transaction</a> is committed when the block
terminates. If the block raises an exception, a <a
href="Database.html#M000122">rollback</a> will be performed instead. Note
that if a block is given, <a href="Database.html#M000121">commit</a> and <a
href="Database.html#M000122">rollback</a> should never be called explicitly
or you‘ll get an error when the block terminates.
</p>
<p>
If a block is not given, it is the caller‘s responsibility to end the
<a href="Database.html#M000120">transaction</a> explicitly, either by
calling <a href="Database.html#M000121">commit</a>, or by calling <a
href="Database.html#M000122">rollback</a>.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000120_source')" id="l_M000120_source">show source</a> ]</p>
<div id="M000120_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 557</span>
557: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">transaction</span>( <span class="ruby-identifier">mode</span> = <span class="ruby-identifier">:deferred</span> )
558: <span class="ruby-identifier">execute</span> <span class="ruby-node">"begin #{mode.to_s} transaction"</span>
559: <span class="ruby-ivar">@transaction_active</span> = <span class="ruby-keyword kw">true</span>
560:
561: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
562: <span class="ruby-identifier">abort</span> = <span class="ruby-keyword kw">false</span>
563: <span class="ruby-keyword kw">begin</span>
564: <span class="ruby-keyword kw">yield</span> <span class="ruby-keyword kw">self</span>
565: <span class="ruby-keyword kw">rescue</span> <span class="ruby-operator">::</span><span class="ruby-constant">Object</span>
566: <span class="ruby-identifier">abort</span> = <span class="ruby-keyword kw">true</span>
567: <span class="ruby-identifier">raise</span>
568: <span class="ruby-keyword kw">ensure</span>
569: <span class="ruby-identifier">abort</span> <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">rollback</span> <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">commit</span>
570: <span class="ruby-keyword kw">end</span>
571: <span class="ruby-keyword kw">end</span>
572:
573: <span class="ruby-keyword kw">true</span>
574: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000123"></a><b>transaction_active?</b>()
</div>
<div class="description">
<p>
Returns <tt>true</tt> if there is a <a
href="Database.html#M000120">transaction</a> active, and <tt>false</tt>
otherwise.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000123_source')" id="l_M000123_source">show source</a> ]</p>
<div id="M000123_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 597</span>
597: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">transaction_active?</span>
598: <span class="ruby-ivar">@transaction_active</span>
599: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000099"></a><b>translator</b>()
</div>
<div class="description">
<p>
Return the type <a href="Database.html#M000099">translator</a> employed by
this database instance. Each database instance has its own type <a
href="Database.html#M000099">translator</a>; this allows for different type
handlers to be installed in each instance without affecting other
instances. Furthermore, the translators are instantiated lazily, so that if
a database does not use type translation, it will not be burdened by the
overhead of a useless type <a href="Database.html#M000099">translator</a>.
(See the <a href="Translator.html">Translator</a> class.)
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000099_source')" id="l_M000099_source">show source</a> ]</p>
<div id="M000099_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/sqlite3/database.rb, line 113</span>
113: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">translator</span>
114: <span class="ruby-ivar">@translator</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Translator</span>.<span class="ruby-identifier">new</span>
115: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
</body>
</html>
|
