forked from globegit/postgresql-plruby
-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathplruby.html
More file actions
1454 lines (1418 loc) · 66.3 KB
/
plruby.html
File metadata and controls
1454 lines (1418 loc) · 66.3 KB
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
<?xml version="1.0" ?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Untitled</title>
</head>
<body>
<h1><a name="label-0" id="label-0">PL/Ruby</a></h1><!-- RDLabel: "PL/Ruby" -->
<ul>
<li><a href="#label-2">Defining function in PL Ruby</a></li>
<li><a href="#label-5">Function returning SET (SFRM Materialize)</a></li>
<li><a href="#label-6">Function returning SET (ExprMultiResult)</a></li>
<li><a href="#label-7">Trigger procedures in PL Ruby</a></li>
<li><a href="#label-19">plruby_singleton_methods</a></li>
<li><a href="#label-20">Conversion</a></li>
<li><a href="#label-21">Class and modules</a>
<ul>
<li><a href="#label-26">module PL</a> : general module</li>
<li><a href="#label-45">class PL::Plan</a> : class for prepared plans</li>
<li><a href="#label-58">class PL::Cursor</a> : class for cursors</li>
<li><a href="#label-66">class PL::Transaction</a> : class for transactions (8.0)</li>
<li><a href="#label-69">class BitString</a></li>
<li><a href="#label-117">class Tinterval</a></li>
<li><a href="#label-91">class NetAddr</a></li>
<li><a href="#label-111">class MacAddr</a></li>
<li><a href="#label-125">class Box</a></li>
<li><a href="#label-230">class Circle</a></li>
<li><a href="#label-157">class Path</a></li>
<li><a href="#label-173">class Point</a></li>
<li><a href="#label-211">class Polygon</a></li>
<li><a href="#label-196">class Segment</a></li>
</ul></li>
</ul>
<p>PL/Ruby is a loadable procedural language for the Postgres database
system that enable the Ruby language to create functions and trigger
procedures</p>
<p>Functions and triggers are singleton methods of the module PLtemp.</p>
<h1><a name="label-1" id="label-1">WARNING</a></h1><!-- RDLabel: "WARNING" -->
<p><em>if PL/Ruby was compiled with <kbd>--disable-conversion</kbd>,
all arguments (to the function or the triggers) are passed as string
values, except for NULL values represented by <kbd>Qnil</kbd>.</em>
<em>In this case you must explicitely call a conversion function (like to_i)
if you want to use an argument as an integer</em></p>
<h2><a name="label-2" id="label-2">Defining function in PL Ruby</a></h2><!-- RDLabel: "Defining function in PL Ruby" -->
<p>To create a function in the PL/Ruby language use the syntax</p>
<pre>CREATE FUNCTION funcname(arguments_type) RETURNS type AS '
# PL/Ruby function body
' LANGUAGE 'plruby';</pre>
<p>when calling the function in a query, the arguments are given <em>as
string values</em> in the array <kbd>args</kbd>. To create a little max
function returning the higher of two int4 values write :</p>
<pre>CREATE FUNCTION ruby_max(int4, int4) RETURNS int4 AS '
if args[0].to_i > args[1].to_i
return args[0]
else
return args[1]
end
' LANGUAGE 'plruby';</pre>
<p>Tuple arguments are given as hash. Here is an example that defines
the overpaid_2 function (as found in the older Postgres documentation)
in PL/Ruby.</p>
<pre>CREATE FUNCTION overpaid_2 (EMP) RETURNS bool AS '
args[0]["salary"].to_f > 200000 ||
(args[0]["salary"].to_f > 100000 && args[0]["age"].to_i < 30)
' LANGUAGE 'plruby';</pre>
<h3><a name="label-3" id="label-3">Warning : with PostgreSQL >= 7.4 "array" are given as a ruby Array</a></h3><!-- RDLabel: "Warning : with PostgreSQL >= 7.4 "array" are given as a ruby Array" -->
<p>For example to define a function (int4[], int4) and return int4[],
in version < 7.4 you write</p>
<pre>CREATE FUNCTION ruby_int4_accum(_int4, int4) RETURNS _int4 AS '
if /\\{(\\d+),(\\d+)\\}/ =~ args[0]
a, b = $1, $2
newsum = a.to_i + args[1].to_i
newcnt = b.to_i + 1
else
raise "unexpected value #{args[0]}"
end
"{#{newsum},#{newcnt}}"
' LANGUAGE 'plruby';</pre>
<p>This must now (>= 7.4) be written</p>
<pre>CREATE FUNCTION ruby_int4_accum(_int4, int4) RETURNS _int4 AS '
a = args[0]
[a[0].to_i + args[1].to_i, a[1].to_i + 1]
' LANGUAGE 'plruby';</pre>
<h3><a name="label-4" id="label-4">Release PostgreSQL 8.0</a></h3><!-- RDLabel: "Release PostgreSQL 8.0" -->
<p>With this version, plruby can have named arguments and the previous functions
can be written</p>
<pre>CREATE FUNCTION ruby_max(a int4, b int4) RETURNS int4 AS '
if a > b
a
else
b
end
' LANGUAGE 'plruby';
CREATE FUNCTION overpaid_2 (emp EMP) RETURNS bool AS '
emp["salary"] > 200000 ||
(emp["salary"] > 100000 && emp["age"] < 30)
' LANGUAGE 'plruby';</pre>
<p>With this version, you can also use transaction. For example</p>
<pre>plruby_test=# create table tu (a int, b int);
CREATE TABLE
plruby_test=# create or replace function tt(abort bool) returns bool as '
plruby_test'# transaction do |txn|
plruby_test'# PL.exec("insert into tu values (1, 2)")
plruby_test'# transaction do |txn1|
plruby_test'# PL.exec("insert into tu values (3, 4)")
plruby_test'# txn1.abort
plruby_test'# end
plruby_test'# PL.exec("insert into tu values (5, 6)")
plruby_test'# txn.abort if abort
plruby_test'# end
plruby_test'# abort
plruby_test'# ' language 'plruby';
CREATE FUNCTION
plruby_test=#
plruby_test=# select tt(true);
tt
----
t
(1 row)
plruby_test=# select * from tu;
a | b
---+---
(0 rows)
plruby_test=# select tt(false);
tt
----
f
(1 row)
plruby_test=# select * from tu;
a | b
---+---
1 | 2
5 | 6
(2 rows)
plruby_test=# </pre>
<h2><a name="label-5" id="label-5">Function returning SET (SFRM Materialize)</a></h2><!-- RDLabel: "Function returning SET (SFRM Materialize)" -->
<p>The return type must be declared as SETOF</p>
<p>The function must call <kbd>yield</kbd> to return rows or return a String which
must be a valid SELECT statement</p>
<p>For example to concatenate 2 rows create the function</p>
<pre>plruby_test=# CREATE FUNCTION tu(varchar) RETURNS setof record
plruby_test-# AS '
plruby_test'# size = PL.column_name(args[0]).size
plruby_test'# res = nil
plruby_test'# PL::Plan.new("select * from #{args[0]}",
plruby_test'# "block" => 50).each do |row|
plruby_test'# if res.nil?
plruby_test'# res = row.values
plruby_test'# else
plruby_test'# res.concat row.values
plruby_test'# yield res
plruby_test'# res = nil
plruby_test'# end
plruby_test'# end
plruby_test'# if res
plruby_test'# res.concat Array.new(size)
plruby_test'# yield res
plruby_test'# end
plruby_test'# ' language 'plruby';
CREATE FUNCTION
plruby_test=#
plruby_test=# select * from tt;
a | b
---+----
1 | 2
3 | 4
5 | 6
7 | 8
9 | 10
(5 rows)
plruby_test=# select * from tu('tt') as tbl(a int, b int, c int, d int);
a | b | c | d
---+----+---+---
1 | 2 | 3 | 4
5 | 6 | 7 | 8
9 | 10 | |
(3 rows)
plruby_test=# </pre>
<h2><a name="label-6" id="label-6">Function returning SET (ExprMultiResult)</a></h2><!-- RDLabel: "Function returning SET (ExprMultiResult)" -->
<p>The return type must be declared as SETOF</p>
<p>The function is called until it returns nil</p>
<p>The method PL#context and PL#context= give the possibility to store information
between the call</p>
<p>For example</p>
<pre>plruby_test=# create or replace function vv(int) returns setof int as '
plruby_test'# i = PL.context || 0
plruby_test'# if i >= args[0].to_i
plruby_test'# nil
plruby_test'# else
plruby_test'# PL.context = i + 1
plruby_test'# end
plruby_test'# ' language plruby;
CREATE FUNCTION
plruby_test=#
plruby_test=# select * from uu;
b
---
2
(1 row)
plruby_test=#
plruby_test=# select *,vv(3) from uu;
b | vv
---+----
2 | 1
2 | 2
2 | 3
(3 rows)
plruby_test=# </pre>
<h2><a name="label-7" id="label-7">Trigger procedures in PL Ruby</a></h2><!-- RDLabel: "Trigger procedures in PL Ruby" -->
<p>Trigger procedures are defined in Postgres as functions without
arguments and a return type of trigger. In PL/Ruby the procedure is
called with 4 arguments :</p>
<dl>
<dt><a name="label-8" id="label-8">new (hash, tainted)</a></dt><!-- RDLabel: "new (hash, tainted)" -->
<dd>
an hash containing the values of the new table row on INSERT/UPDATE
actions, or empty on DELETE.
</dd>
<dt><a name="label-9" id="label-9">old (hash, tainted)</a></dt><!-- RDLabel: "old (hash, tainted)" -->
<dd>
an hash containing the values of the old table row on UPDATE/DELETE
actions, or empty on INSERT
</dd>
<dt><a name="label-10" id="label-10">args (array, tainted, frozen)</a></dt><!-- RDLabel: "args (array, tainted, frozen)" -->
<dd>
An array of the arguments to the procedure as given in the CREATE
TRIGGER statement
</dd>
<dt><a name="label-11" id="label-11">tg (hash, tainted, frozen)</a></dt><!-- RDLabel: "tg (hash, tainted, frozen)" -->
<dd>
The following keys are defined
<dl>
<dt><a name="label-12" id="label-12">name</a></dt><!-- RDLabel: "name" -->
<dd>
The name of the trigger from the CREATE TRIGGER statement.
</dd>
<dt><a name="label-13" id="label-13">relname</a></dt><!-- RDLabel: "relname" -->
<dd>
The name of the relation who has fired the trigger
</dd>
<dt><a name="label-14" id="label-14">relid</a></dt><!-- RDLabel: "relid" -->
<dd>
The object ID of the table that caused the trigger procedure to be invoked.
</dd>
<dt><a name="label-15" id="label-15">relatts</a></dt><!-- RDLabel: "relatts" -->
<dd>
An array containing the name of the tables field.
</dd>
<dt><a name="label-16" id="label-16">when</a></dt><!-- RDLabel: "when" -->
<dd>
The constant <kbd>PL::BEFORE</kbd>, <kbd>PL::AFTER</kbd> or
<kbd>PL::UNKNOWN</kbd> depending on the event of the trigger call.
</dd>
<dt><a name="label-17" id="label-17">level</a></dt><!-- RDLabel: "level" -->
<dd>
The constant <kbd>PL::ROW</kbd> or <kbd>PL::STATEMENT</kbd>
depending on the event of the trigger call.
</dd>
<dt><a name="label-18" id="label-18">op</a></dt><!-- RDLabel: "op" -->
<dd>
The constant <kbd>PL::INSERT</kbd>, <kbd>PL::UPDATE</kbd> or
<kbd>PL::DELETE</kbd> depending on the event of the trigger call.
</dd>
</dl>
</dd>
</dl>
<p>The return value from a trigger procedure is one of the constant
<kbd>PL::OK</kbd> or <kbd>PL::SKIP</kbd>, or an hash. If the
return value is <kbd>PL::OK</kbd>, the normal operation
(INSERT/UPDATE/DELETE) that fired this trigger will take
place. Obviously, <kbd>PL::SKIP</kbd> tells the trigger manager to
silently suppress the operation. The hash tells
PL/Ruby to return a modified row to the trigger manager that will be
inserted instead of the one given in <kbd>new</kbd> (INSERT/UPDATE
only). Needless to say that all this is only meaningful when the
trigger is BEFORE and FOR EACH ROW.</p>
<p>Here's a little example trigger procedure that forces an integer
value in a table to keep track of the # of updates that are performed
on the row. For new row's inserted, the value is initialized to 0 and
then incremented on every update operation :</p>
<pre>CREATE FUNCTION trigfunc_modcount() RETURNS TRIGGER AS '
case tg["op"]
when PL::INSERT
new[args[0]] = 0
when PL::UPDATE
new[args[0]] = old[args[0]].to_i + 1
else
return PL::OK
end
new
' LANGUAGE 'plruby';
CREATE TABLE mytab (num int4, modcnt int4, descr text);
CREATE TRIGGER trig_mytab_modcount BEFORE INSERT OR UPDATE ON mytab
FOR EACH ROW EXECUTE PROCEDURE trigfunc_modcount('modcnt');</pre>
<p>A more complex example (extract from test_setup.sql in the distribution)
which use the global variable <kbd>$Plans</kbd> to store a prepared
plan</p>
<pre>create function trig_pkey2_after() returns trigger as '
if ! $Plans.key?("plan_dta2_upd")
$Plans["plan_dta2_upd"] =
PL::Plan.new("update T_dta2
set ref1 = $3, ref2 = $4
where ref1 = $1 and ref2 = $2",
["int4", "varchar", "int4", "varchar" ]).save
$Plans["plan_dta2_del"] =
PL::Plan.new("delete from T_dta2
where ref1 = $1 and ref2 = $2",
["int4", "varchar"]).save
end
old_ref_follow = false
old_ref_delete = false
case tg["op"]
when PL::UPDATE
new["key2"] = new["key2"].upcase
old_ref_follow = (new["key1"] != old["key1"]) ||
(new["key2"] != old["key2"])
when PL::DELETE
old_ref_delete = true
end
if old_ref_follow
n = $Plans["plan_dta2_upd"].exec([old["key1"], old["key2"], new["key1"],
new["key2"]])
warn "updated #{n} entries in T_dta2 for new key in T_pkey2" if n != 0
end
if old_ref_delete
n = $Plans["plan_dta2_del"].exec([old["key1"], old["key2"]])
warn "deleted #{n} entries from T_dta2" if n != 0
end
PL::OK
' language 'plruby';
create trigger pkey2_after after update or delete on T_pkey2
for each row execute procedure
trig_pkey2_after();</pre>
<h2><a name="label-19" id="label-19">plruby_singleton_methods</a></h2><!-- RDLabel: "plruby_singleton_methods" -->
<p>Sometime it can be usefull to define methods (in pure Ruby) which can be
called from a PL/Ruby function or a PL/Ruby trigger.</p>
<p>In this case, you have 2 possibilities</p>
<ul>
<li>the "stupid" way <code>:-) :-) :-)</code></li>
</ul>
<p>just close the current definition of the function (or trigger) with a
<code>end</code> and define your singleton method without the final <code>end</code></p>
<p>Here a small and useless example</p>
<pre>plruby_test=# CREATE FUNCTION tutu() RETURNS int4 AS '
plruby_test'# toto(1, 3) + toto(4, 4)
plruby_test'# end
plruby_test'#
plruby_test'# def PLtemp.toto(a, b)
plruby_test'# a + b
plruby_test'# ' LANGUAGE 'plruby';
CREATE
plruby_test=# select tutu();
tutu
----
12
(1 row)
plruby_test=#</pre>
<ul>
<li>create a table plruby_singleton_methods with the columns (name, args, body)</li>
</ul>
<p>At load time, PL/Ruby look if it exist a table plruby_singleton_methods and if
found try, for each row, to define singleton methods with the template :</p>
<pre>def PLtemp.#{name} (#{args})
#{body}
end</pre>
<p>The previous example can be written (you have a more complete example in
test/plp/test_setup.sql)</p>
<pre>plruby_test=# SELECT * FROM plruby_singleton_methods;
name|args|body
----+----+-----
toto|a, b|a + b
(1 row)
plruby_test=# CREATE FUNCTION tutu() RETURNS int4 AS '
plruby_test'# toto(1, 3) + toto(4, 4)
plruby_test'# ' LANGUAGE 'plruby';
CREATE
plruby_test=# select tutu();
tutu
----
12
(1 row)
plruby_test=#</pre>
<ul>
<li><p>Another example, if PLRuby was compiled with --enable-conversion and it
exist a column with the name '***' then it can create a singleton method
from a PLRuby function</p>
<pre>plruby_test=# select * from plruby_singleton_methods;
name | args | body
------+------+------
*** | |
(1 row)
plruby_test=# create function add_value(int, int) returns int as '
plruby_test'# args[0] + args[1]
plruby_test'# ' language 'plruby';
CREATE FUNCTION
plruby_test=#
plruby_test=# select add_value(10, 2);
add_value
-----------
12
(1 row)
plruby_test=#
plruby_test=# create function add_one(int) returns int as '
plruby_test'# add_value(args[0], 1)
plruby_test'# ' language 'plruby';
CREATE FUNCTION
plruby_test=#
plruby_test=# select add_one(11);
add_one
---------
12
(1 row)
plruby_test=# </pre></li>
</ul>
<h2><a name="label-20" id="label-20">Conversion</a></h2><!-- RDLabel: "Conversion" -->
<p>If the conversions was not disabled (--disable-conversion), the following
conversions are made</p>
<pre>PostgreSQL Ruby
---------- ----
OID Fixnum
INT2OID Fixnum
INT4OID Fixnum
INT8OID Fixnum (or Bignum)
FLOAT4OID Float
FLOAT8OID Float
CASHOID Float
NUMERICOID Float
BOOLOID true, false
ABSTIMEOID Time
RELTIMEOID Time
TIMEOID Time
TIMETZOID Time
TIMESTAMPOID Time
TIMESTAMPTZOID Time
DATEOID Time
INTERVALOID Time
TINTERVALOID Tinterval (new Ruby class)
BITOID BitString (new Ruby class)
VARBITOID BitString (new Ruby class)
INETOID NetAddr (new Ruby class)
CIDROID NetAddr (new Ruby class)
MACADDROID MacAddr (new Ruby class)
POINTOID Point (new Ruby class)
LSEGOID Segment (new Ruby class)
BOXOID Box (new Ruby class)
PATHOID Path (new Ruby class)
POLYGONOID Polygon (new Ruby class)
CIRCLEOID Circle (new Ruby class)</pre>
<p>all others OID are converted to a String object</p>
<h2><a name="label-21" id="label-21">Class and modules</a></h2><!-- RDLabel: "Class and modules" -->
<h3><a name="label-22" id="label-22">Global</a></h3><!-- RDLabel: "Global" -->
<dl>
<dt><a name="label-23" id="label-23"><code>transaction {|<var>txn</var>| }</code></a></dt><!-- RDLabel: "transaction" -->
<dd>
create a new transaction, yield an object <kbd>PL::Transaction</kbd></dd>
<dt><a name="label-24" id="label-24"><code>warn [<var>level</var>], <var>message</var></code></a></dt><!-- RDLabel: "warn [level], message" -->
<dd>
<p>Ruby interface to PostgreSQL elog()</p>
<p>Possible value for <kbd>level</kbd> are <kbd>NOTICE</kbd>, <kbd>DEBUG</kbd> and <kbd>NOIND</kbd></p>
<p>Use <kbd>raise()</kbd> if you want to simulate <kbd>elog(ERROR, "...")</kbd></p></dd>
<dt><a name="label-25" id="label-25"><code>$Plans (<var>hash</var>, <var>tainted</var>)</code></a></dt><!-- RDLabel: "$Plans" -->
<dd>
can be used to store prepared plans.</dd>
</dl>
<h3><a name="label-26" id="label-26">module PL</a></h3><!-- RDLabel: "module PL" -->
<pre>general module</pre>
<dl>
<dt><a name="label-27" id="label-27"><code>args_type</code></a></dt><!-- RDLabel: "args_type" -->
<dd>
Return the type of the arguments given to the function</dd>
<dt><a name="label-28" id="label-28"><code>column_name(<var>table</var>)</code></a></dt><!-- RDLabel: "column_name" -->
<dd>
Return the name of the columns for the table</dd>
<dt><a name="label-29" id="label-29"><code>column_type(<var>table</var>)</code></a></dt><!-- RDLabel: "column_type" -->
<dd>
return the type of the columns for the table</dd>
<dt><a name="label-30" id="label-30"><code>context</code></a></dt><!-- RDLabel: "context" -->
<dd>
Return the context (or nil) associated with a SETOF function
(ExprMultiResult)</dd>
<dt><a name="label-31" id="label-31"><code>context=</code></a></dt><!-- RDLabel: "context=" -->
<dd>
Set the context for a SETOF function (ExprMultiResult)</dd>
<dt><a name="label-32" id="label-32"><code>quote(<var>string</var>)</code></a></dt><!-- RDLabel: "quote" -->
<dd>
Duplicates all occurences of single quote and backslash
characters. It should be used when variables are used in the query
string given to spi_exec or spi_prepare (not for the value list on
execp).</dd>
<dt><a name="label-33" id="label-33"><code>result_name</code></a></dt><!-- RDLabel: "result_name" -->
<dd>
Return the name of the columns for a function returning a SETOF</dd>
<dt><a name="label-34" id="label-34"><code>result_type</code></a></dt><!-- RDLabel: "result_type" -->
<dd>
Return the type of the columns for a function returning a SETOF
or the type of the return value</dd>
<dt><a name="label-35" id="label-35"><code>result_size</code></a></dt><!-- RDLabel: "result_size" -->
<dd>
Return the number of columns for a function returning a SETOF</dd>
<dt><a name="label-36" id="label-36"><code>result_description</code></a></dt><!-- RDLabel: "result_description" -->
<dd>
Return the table description given to a function returning a SETOF</dd>
<dt><a name="label-37" id="label-37"><code>exec(<var>string</var> [, <var>count</var> [, <var>type</var>]])</code></a></dt><!-- RDLabel: "exec" -->
<dt><a name="label-38" id="label-38"><code>spi_exec(<var>string</var> [, <var>count</var> [, <var>type</var>]])</code></a></dt><!-- RDLabel: "spi_exec" -->
<dd>
Call parser/planner/optimizer/executor for query. The optional
<kbd>count</kbd> value tells spi_exec the maximum number of rows to be
processed by the query.
<dl>
<dt><a name="label-39" id="label-39">SELECT</a></dt><!-- RDLabel: "SELECT" -->
<dd>
<p>If the query is a SELECT statement, an array is return (if count is
not specified or with a value > 1). Each element of this array is an
hash where the key is the column name.</p>
<p>If type is specified it can take the value</p>
<ul>
<li>"array" return for each column an array with the element
["name", "value", "type", "len", "typeid"]</li>
<li>"hash" return for each column an hash with the keys
{"name", "value", "type", "len", "typeid"}</li>
<li>"value" return all values</li>
</ul>
<p>For example this procedure display all rows in the table pg_table.</p>
<pre>CREATE FUNCTION pg_table_dis() RETURNS int4 AS '
res = PLruby.exec("select * from pg_class")
res.each do |x|
warn "======================"
x.each do |y, z|
warn "name = #{y} -- value = #{z}"
end
warn "======================"
end
return res.size
' LANGUAGE 'plruby';</pre>
<p>A block can be specified, in this case a call to yield() will be
made.</p>
<p>If count is specified with the value 1, only the first row (or
FALSE if it fail) is returned as a hash. Here a little example :</p>
<pre>CREATE FUNCTION pg_table_dis() RETURNS int4 AS '
PL.exec("select * from pg_class", 1) { |y, z|
warn "name = #{y} -- value = #{z}"
}
return 1
' LANGUAGE 'plruby';</pre>
<p>Another example with count = 1</p>
<pre>create table T_pkey1 (
skey1 int4,
skey2 varchar(20),
stxt varchar(40)
);
create function toto() returns bool as '
warn("=======")
PL.exec("select * from T_pkey1", 1, "hash") do |a|
warn(a.inspect)
end
warn("=======")
PL.exec("select * from T_pkey1", 1, "array") do |a|
warn(a.inspect)
end
warn("=======")
PL.exec("select * from T_pkey1", 1) do |a|
warn(a.inspect)
end
warn("=======")
return true
' language 'plruby';
plruby_test=# select toto();
NOTICE: =======
NOTICE: {"name"=>"skey1", "typeid"=>23, "type"=>"int4", "value"=>"12", "len"=>4}
NOTICE: {"name"=>"skey2", "typeid"=>1043, "type"=>"varchar", "value"=>"a", "len"=>20}
NOTICE: {"name"=>"stxt", "typeid"=>1043, "type"=>"varchar", "value"=>"b", "len"=>40}
NOTICE: =======
NOTICE: ["skey1", "12", "int4", 4, 23]
NOTICE: ["skey2", "a", "varchar", 20, 1043]
NOTICE: ["stxt", "b", "varchar", 40, 1043]
NOTICE: =======
NOTICE: ["skey1", "12"]
NOTICE: ["skey2", "a"]
NOTICE: ["stxt", "b"]
NOTICE: =======
toto
------
t
(1 row)
plruby_test=# </pre>
</dd>
<dt><a name="label-40" id="label-40">SELECT INTO, INSERT, UPDATE, DELETE</a></dt><!-- RDLabel: "SELECT INTO, INSERT, UPDATE, DELETE" -->
<dd>
return the number of rows insered, updated, deleted, ...
</dd>
<dt><a name="label-41" id="label-41">UTILITY</a></dt><!-- RDLabel: "UTILITY" -->
<dd>
return TRUE
</dd>
</dl></dd>
<dt><a name="label-42" id="label-42"><code>prepare(<var>string</var>[, <var>types</var>])</code></a></dt><!-- RDLabel: "prepare" -->
<dt><a name="label-43" id="label-43"><code>spi_prepare(<var>string</var>[, <var>types</var>])</code></a></dt><!-- RDLabel: "spi_prepare" -->
<dt><a name="label-44" id="label-44"><code>prepare(<var>string</var>, "<var>types</var>" => <var>types</var>, "<var>count</var>" => <var>count</var>, "<var>output</var>" => <var>type</var>, "<var>tmp</var>" => <var>true</var>)</code></a></dt><!-- RDLabel: "prepare" -->
<dd>
<p>Deprecated : See <kbd>PL::Plan::new</kbd> and <kbd>PL::Plan#save</kbd></p>
<p>Prepares AND SAVES a query plan for later execution. It is a bit
different from the C level SPI_prepare in that the plan is
automatically copied to the toplevel memory context.</p>
<p>If the query references arguments, the type names must be given as a
Ruby array of strings. The return value from prepare is a
<kbd>PL::Plan</kbd> object to be used in subsequent calls to
<kbd>PL::Plan#exec</kbd>.</p>
<p>If the hash given has the keys <kbd>count</kbd>, <kbd>output</kbd> these values
will be given to the subsequent calls to <kbd>each</kbd></p></dd>
</dl>
<h3><a name="label-45" id="label-45">class PL::Plan</a></h3><!-- RDLabel: "class PL::Plan" -->
<pre>class for prepared plan</pre>
<dl>
<dt><a name="label-46" id="label-46"><code>initialize(<var>string</var>, "<var>types</var>" => <var>types</var>, "<var>count</var>" => <var>count</var>, "<var>output</var>" => <var>type</var>, "<var>save</var>" => <var>false</var>)</code></a></dt><!-- RDLabel: "initialize" -->
<dd>
<p>Prepares a query plan for later execution.</p>
<p>If the query references arguments, the type names must be given as a
Ruby array of strings.</p>
<p>If the hash given has the keys <kbd>output</kbd>, <kbd>count</kbd> these values
will be given to the subsequent calls to <kbd>each</kbd></p>
<p>If <kbd>"save"</kbd> as a true value, the plan will be saved </p></dd>
<dt><a name="label-47" id="label-47"><code>exec(<var>values</var>, [<var>count</var> [, <var>type</var>]])</code></a></dt><!-- RDLabel: "exec" -->
<dt><a name="label-48" id="label-48"><code>execp(<var>values</var>, [<var>count</var> [, <var>type</var>]])</code></a></dt><!-- RDLabel: "execp" -->
<dt><a name="label-49" id="label-49"><code>exec("<var>values</var>" => <var>values</var>, "<var>count</var>" => <var>count</var>, "<var>output</var>" => <var>type</var>)</code></a></dt><!-- RDLabel: "exec" -->
<dt><a name="label-50" id="label-50"><code>execp("<var>values</var>" => <var>values</var>, "<var>count</var>" => <var>count</var>, "<var>output</var>" => <var>type</var>)</code></a></dt><!-- RDLabel: "execp" -->
<dd>
<p>Execute a prepared plan from <kbd>PL::PLan::new</kbd> with variable
substitution. The optional <kbd>count</kbd> value tells
<kbd>PL::Plan#exec</kbd> the maximum number of rows to be processed by the
query.</p>
<p>If there was a typelist given to <kbd>PL::Plan::new</kbd>, an array
of <kbd>values</kbd> of exactly the same length must be given to
<kbd>PL::Plan#exec</kbd> as first argument. If the type list on
<kbd>PL::Plan::new</kbd> was empty, this argument must be omitted.</p>
<p>If the query is a SELECT statement, the same as described for
<kbd>PL#exec</kbd> happens for the loop-body and the variables for
the fields selected.</p>
<p>If type is specified it can take the values</p>
<ul>
<li>"array" return an array with the element ["name", "value", "type", "len", "typeid"]</li>
<li>"hash" return an hash with the keys {"name", "value", "type", "len", "typeid"}</li>
<li>"value" return an array with all values</li>
</ul>
<p>Here's an example for a PL/Ruby function using a prepared plan : </p>
<pre>CREATE FUNCTION t1_count(int4, int4) RETURNS int4 AS '
if ! $Plans.key?("plan")
# prepare the saved plan on the first call
$Plans["plan"] = PL::Plan.new("SELECT count(*) AS cnt FROM t1
WHERE num >= $1 AND num <= $2",
["int4", "int4"]).save
end
n = $Plans["plan"].exec([args[0], args[1]], 1)
n["cnt"]
' LANGUAGE 'plruby';</pre></dd>
<dt><a name="label-51" id="label-51"><code>cursor(<var>name</var> = <var>nil</var>, "<var>values</var>" => <var>values</var>, "<var>output</var>" => <var>type</var>)</code></a></dt><!-- RDLabel: "cursor" -->
<dd>
<p>Create a new object PL::Cursor</p>
<p>If output is specified it can take the values</p>
<ul>
<li>"array" return an array with the element ["name", "value", "type", "len", "typeid"]</li>
<li>"hash" return an hash with the keys {"name", "value", "type", "len", "typeid"}</li>
<li>"value" return an array with all values</li>
</ul>
<p>If there was a typelist given to <kbd>PL::Plan::new</kbd>, an array
of <kbd>values</kbd> of exactly the same length must be given to
<kbd>PL::Plan#cursor</kbd></p></dd>
<dt><a name="label-52" id="label-52"><code>each(<var>values</var>, [<var>count</var> [, <var>type</var> ]]) { ... }</code></a></dt><!-- RDLabel: "each" -->
<dt><a name="label-53" id="label-53"><code>fetch(<var>values</var>, [<var>count</var> [, <var>type</var> ]]) { ... }</code></a></dt><!-- RDLabel: "fetch" -->
<dt><a name="label-54" id="label-54"><code>each("<var>values</var>" => <var>values</var>, "<var>count</var>" => <var>count</var>, "<var>output</var>" => <var>type</var>) { ... }</code></a></dt><!-- RDLabel: "each" -->
<dt><a name="label-55" id="label-55"><code>fetch("<var>values</var>" => <var>values</var>, "<var>count</var>" => <var>count</var>, "<var>output</var>" => <var>type</var>) { ... }</code></a></dt><!-- RDLabel: "fetch" -->
<dd>
<p>Same then #exec but a call to SPI_cursor_open(), SPI_cursor_fetch() is made.</p>
<p>Can be used only with a block and a SELECT statement</p>
<pre>create function toto() returns bool as '
plan = PL::Plan.new("select * from T_pkey1")
warn "=====> ALL"
plan.each do |x|
warn(x.inspect)
end
warn "=====> FIRST 2"
plan.each("count" => 2) do |x|
warn(x.inspect)
end
return true
' language 'plruby';
plruby_test=# select * from T_pkey1;
skey1 | skey2 | stxt
-------+-------+------
12 | a | b
24 | c | d
36 | e | f
(3 rows)
plruby_test=#
plruby_test=# select toto();
NOTICE: =====> ALL
NOTICE: {"skey1"=>"12", "skey2"=>"a", "stxt"=>"b"}
NOTICE: {"skey1"=>"24", "skey2"=>"c", "stxt"=>"d"}
NOTICE: {"skey1"=>"36", "skey2"=>"e", "stxt"=>"f"}
NOTICE: =====> FIRST 2
NOTICE: {"skey1"=>"12", "skey2"=>"a", "stxt"=>"b"}
NOTICE: {"skey1"=>"24", "skey2"=>"c", "stxt"=>"d"}
toto
------
t
(1 row)
plruby_test=# </pre></dd>
<dt><a name="label-56" id="label-56"><code>release</code></a></dt><!-- RDLabel: "release" -->
<dd>
Release a query plan</dd>
<dt><a name="label-57" id="label-57"><code>save</code></a></dt><!-- RDLabel: "save" -->
<dd>
Save a query plan for later execution. The plan is copied to the
toplevel memory context.</dd>
</dl>
<h3><a name="label-58" id="label-58">class PL::Cursor</a></h3><!-- RDLabel: "class PL::Cursor" -->
<pre>A cursor is created with the method PL::Plan#cursor</pre>
<dl>
<dt><a name="label-59" id="label-59"><code>close</code></a></dt><!-- RDLabel: "close" -->
<dd>
Closes a cursor</dd>
<dt><a name="label-60" id="label-60"><code>each {|<var>row</var>| ... }</code></a></dt><!-- RDLabel: "each" -->
<dd>
Iterate over all rows (forward)</dd>
<dt><a name="label-61" id="label-61"><code>fetch(<var>count</var> = <var>1</var>)</code></a></dt><!-- RDLabel: "fetch" -->
<dt><a name="label-62" id="label-62"><code>row(<var>count</var> = <var>1</var>)</code></a></dt><!-- RDLabel: "row" -->
<dd>
<p>Fetches some rows from a cursor</p>
<p>if count > 0 fetch forward else backward</p></dd>
<dt><a name="label-63" id="label-63"><code>move(<var>count</var>)</code></a></dt><!-- RDLabel: "move" -->
<dd>
Move a cursor : if count > 0 move forward else backward</dd>
<dt><a name="label-64" id="label-64"><code>reverse_each {|<var>row</var>| ... }</code></a></dt><!-- RDLabel: "reverse_each" -->
<dd>
Iterate over all rows (backward)</dd>
<dt><a name="label-65" id="label-65"><code>rewind</code></a></dt><!-- RDLabel: "rewind" -->
<dd>
Positions the cursor at the beginning of the table</dd>
</dl>
<h3><a name="label-66" id="label-66">class PL::Transaction</a></h3><!-- RDLabel: "class PL::Transaction" -->
<p>a transaction is created with the global function <kbd>transaction()</kbd>. Only
available with PostgreSQL >= 8.0</p>
<dl>
<dt><a name="label-67" id="label-67"><code>abort</code></a></dt><!-- RDLabel: "abort" -->
<dd>
Abort the transaction</dd>
<dt><a name="label-68" id="label-68"><code>commit</code></a></dt><!-- RDLabel: "commit" -->
<dd>
Commit the transaction</dd>
</dl>
<h3><a name="label-69" id="label-69">class BitString</a></h3><!-- RDLabel: "class BitString" -->
<p>The class BitString implement the PostgreSQL type <var>bit</var>
and <var>bit varying</var></p>
<p>The modules Comparable and Enumerable are included</p>
<dl>
<dt><a name="label-70" id="label-70"><code>from_string(<var>string</var>, <var>length</var> = <var>strlen</var>(<var>string</var>))</code></a></dt><!-- RDLabel: "from_string" -->
<dd>
Convert a <var>String</var> to a <var>BitString</var></dd>
<dt><a name="label-71" id="label-71"><code><=>(<var>other</var>)</code></a></dt><!-- RDLabel: "<=>" -->
<dd>
<p>comparison function for 2 <var>BitString</var> objects</p>
<p>All bits are considered and additional zero bits may make one string
smaller/larger than the other, even if their zero-padded values would
be the same.</p></dd>
<dt><a name="label-72" id="label-72"><code>+(<var>other</var>)</code></a></dt><!-- RDLabel: "+" -->
<dd>
Concatenate <var>self</var> and <var>other</var></dd>
<dt><a name="label-73" id="label-73"><code>&(<var>other</var>)</code></a></dt><!-- RDLabel: "&" -->
<dd>
AND operator</dd>
<dt><a name="label-74" id="label-74"><code>|(<var>other</var>)</code></a></dt><!-- RDLabel: "|" -->
<dd>
OR operator</dd>
<dt><a name="label-75" id="label-75"><code>^(<var>other</var>)</code></a></dt><!-- RDLabel: "^" -->
<dd>
XOR operator</dd>
<dt><a name="label-76" id="label-76"><code>~</code></a></dt><!-- RDLabel: "~" -->
<dd>
NOT operator</dd>
<dt><a name="label-77" id="label-77"><code><<(<var>lshft</var>)</code></a></dt><!-- RDLabel: "<<" -->
<dd>
LEFT SHIFT operator</dd>
<dt><a name="label-78" id="label-78"><code>>>(<var>rshft</var>)</code></a></dt><!-- RDLabel: ">>" -->
<dd>
RIGHT SHIFT operator</dd>
<dt><a name="label-79" id="label-79"><code>[*<var>args</var>]</code></a></dt><!-- RDLabel: "[]" -->
<dd>
<p>Element reference with the same syntax that for a <var>String</var> object</p>
<p>Return a <var>BitString</var> or a <var>Fixnum</var> 0, 1</p>
<pre>bitstring[fixnum]
bitstring[fixnum, fixnum]
bitstring[range]
bitstring[regexp]
bitstring[regexp, fixnum]
bitstring[string]
bitstring[other_bitstring]</pre></dd>
<dt><a name="label-80" id="label-80"><code>[*<var>args</var>] = <var>val</var></code></a></dt><!-- RDLabel: "[]=" -->
<dd>
<p>Element assignment with the same syntax that for a <var>String</var> object</p>
<pre>bitstring[fixnum] = fixnum
bitstring[fixnum] = string_or_bitstring
bitstring[fixnum, fixnum] = string_or_bitstring
bitstring[range] = string_or_bitstring
bitstring[regexp] = string_or_bitstring
bitstring[regexp, fixnum] = string_or_bitstring
bitstring[other_str] = string_or_bitstring</pre></dd>
<dt><a name="label-81" id="label-81"><code>concat(<var>other</var>)</code></a></dt><!-- RDLabel: "concat" -->
<dd>
append <var>other</var> to <var>self</var></dd>
<dt><a name="label-82" id="label-82"><code>each</code></a></dt><!-- RDLabel: "each" -->
<dd>
iterate other each bit</dd>
<dt><a name="label-83" id="label-83"><code>include?(<var>other</var>)</code></a></dt><!-- RDLabel: "include?" -->
<dd>
return <var>true</var> if <var>other</var> is included in <var>self</var></dd>
<dt><a name="label-84" id="label-84"><code>index(<var>other</var>)</code></a></dt><!-- RDLabel: "index" -->
<dd>
<p>return the position of <var>other</var> in <var>self</var></p>
<p>return <var>nil</var> if <var>other</var> is not included in <var>self</var></p></dd>
<dt><a name="label-85" id="label-85"><code>initialize(<var>init</var>, <var>nbits</var> = -<var>1</var>)</code></a></dt><!-- RDLabel: "initialize" -->
<dd>
<p>create a new <var>BitString</var> object with <var>nbits</var> bits</p>
<p><var>init</var> can be a <var>Fixnum</var> or a <var>String</var></p>
<p>For a <var>String</var> the first character can be 'x', 'X' for and
hexadecimal representation, or 'b', 'B' for a binary representation.
The default is a binary representation</p></dd>
<dt><a name="label-86" id="label-86"><code>length</code></a></dt><!-- RDLabel: "length" -->
<dd>
return the length of <var>self</var> in bits</dd>
<dt><a name="label-87" id="label-87"><code>octet_length</code></a></dt><!-- RDLabel: "octet_length" -->
<dd>
return the length of <var>self</var> in octets</dd>
<dt><a name="label-88" id="label-88"><code>push(<var>other</var>)</code></a></dt><!-- RDLabel: "push" -->
<dd>
append <var>other</var> to <var>self</var></dd>
<dt><a name="label-89" id="label-89"><code>to_i</code></a></dt><!-- RDLabel: "to_i" -->
<dd>
convert <var>self</var> to a <var>Fixnum</var></dd>
<dt><a name="label-90" id="label-90"><code>to_s</code></a></dt><!-- RDLabel: "to_s" -->
<dd>
convert <var>self</var> to a <var>String</var></dd>
</dl>
<h3><a name="label-91" id="label-91">class NetAddr</a></h3><!-- RDLabel: "class NetAddr" -->
<p>The class NetAddr implement the PostgreSQL type <var>inet</var>
and <var>cidr</var></p>
<p>The module Comparable is included</p>
<dl>
<dt><a name="label-92" id="label-92"><code>from_string(<var>string</var>, <var>cidr</var> = <var>false</var>)</code></a></dt><!-- RDLabel: "from_string" -->
<dd>
Convert a <var>String</var> to a <var>NetAddr</var></dd>
<dt><a name="label-93" id="label-93"><code><=>(<var>other</var>)</code></a></dt><!-- RDLabel: "<=>" -->
<dd>
<p>comparison function for 2 <var>NetAddr</var> objects</p>
<p>comparison is first on the common bits of the network part, then on
the length of the network part, and then on the whole unmasked address.</p></dd>
<dt><a name="label-94" id="label-94"><code>abbrev</code></a></dt><!-- RDLabel: "abbrev" -->
<dd>
return the abbreviated display format as a <var>String</var> object</dd>
<dt><a name="label-95" id="label-95"><code>broadcast</code></a></dt><!-- RDLabel: "broadcast" -->
<dd>
return the broadcast address from the network</dd>
<dt><a name="label-96" id="label-96"><code>contain?(<var>other</var>)</code></a></dt><!-- RDLabel: "contain?" -->
<dd>
return true if <var>other</var> is included in <var>self</var></dd>
<dt><a name="label-97" id="label-97"><code>contain_or_equal?(<var>other</var>)</code></a></dt><!-- RDLabel: "contain_or_equal?" -->
<dd>
return true if <var>other</var> is included in <var>self</var>, or equal</dd>
<dt><a name="label-98" id="label-98"><code>contained?(<var>other</var>)</code></a></dt><!-- RDLabel: "contained?" -->
<dd>
return true if <var>self</var> is included in <var>other</var></dd>
<dt><a name="label-99" id="label-99"><code>contained_or_equal?(<var>other</var>)</code></a></dt><!-- RDLabel: "contained_or_equal?" -->
<dd>
return true if <var>self</var> is included in <var>other</var>, or equal</dd>
<dt><a name="label-100" id="label-100"><code>family</code></a></dt><!-- RDLabel: "family" -->
<dd>
return the String "AF_INET" or "AF_INET6"</dd>
<dt><a name="label-101" id="label-101"><code>first</code></a></dt><!-- RDLabel: "first" -->
<dd>
return the first address in the network</dd>
<dt><a name="label-102" id="label-102"><code>host</code></a></dt><!-- RDLabel: "host" -->
<dd>
extract the IP address and return it as a <var>String</var> </dd>
<dt><a name="label-103" id="label-103"><code>hostmask</code></a></dt><!-- RDLabel: "hostmask" -->
<dd>
return the host mask for network</dd>
<dt><a name="label-104" id="label-104"><code>initialize(<var>string</var>, <var>cidr</var> = <var>false</var>)</code></a></dt><!-- RDLabel: "initialize" -->
<dd>
create a <var>NetAddr</var> from a <var>String</var></dd>
<dt><a name="label-105" id="label-105"><code>last</code></a></dt><!-- RDLabel: "last" -->
<dd>
return the last address in the network</dd>
<dt><a name="label-106" id="label-106"><code>masklen</code></a></dt><!-- RDLabel: "masklen" -->
<dd>
return the length of the netmask</dd>
<dt><a name="label-107" id="label-107"><code>netmask</code></a></dt><!-- RDLabel: "netmask" -->
<dd>
return the netmask for the network</dd>
<dt><a name="label-108" id="label-108"><code>network</code></a></dt><!-- RDLabel: "network" -->
<dd>
return the network part of the address</dd>
<dt><a name="label-109" id="label-109"><code>set_masklen(<var>len</var>)</code></a></dt><!-- RDLabel: "set_masklen" -->
<dd>
return a new <var>NetAddr</var> with netmask length <var>len</var></dd>
<dt><a name="label-110" id="label-110"><code>to_s</code></a></dt><!-- RDLabel: "to_s" -->
<dd>
return the string representation of the address</dd>
</dl>
<h3><a name="label-111" id="label-111">class MacAddr</a></h3><!-- RDLabel: "class MacAddr" -->
<p>The MacAddr implement the PostgreSQL type <var>macaddr</var></p>
<p>The module Comparable is included</p>
<dl>
<dt><a name="label-112" id="label-112"><code>from_string(<var>string</var>, <var>cidr</var> = <var>false</var>)</code></a></dt><!-- RDLabel: "from_string" -->
<dd>
Convert a <var>String</var> to a <var>MacAddr</var></dd>
<dt><a name="label-113" id="label-113"><code><=>(<var>other</var>)</code></a></dt><!-- RDLabel: "<=>" -->
<dd>
comparison function for 2 <var>MacAddr</var> objects</dd>
<dt><a name="label-114" id="label-114"><code>initialize(<var>string</var>)</code></a></dt><!-- RDLabel: "initialize" -->
<dd>
create a <var>MacAddr</var> from a <var>String</var></dd>
<dt><a name="label-115" id="label-115"><code>to_s</code></a></dt><!-- RDLabel: "to_s" -->
<dd>
return the string representation of the MAC address</dd>
<dt><a name="label-116" id="label-116"><code>truncate</code></a></dt><!-- RDLabel: "truncate" -->
<dd>
return a new object with the last 3 bytes set to zero</dd>
</dl>
<h3><a name="label-117" id="label-117">class Tinterval</a></h3><!-- RDLabel: "class Tinterval" -->
<p>The Tinterval implement the PostgreSQL type <var>tinterval</var></p>
<dl>
<dt><a name="label-118" id="label-118"><code>from_string(<var>string</var>)</code></a></dt><!-- RDLabel: "from_string" -->
<dd>
Convert a <var>String</var> (PostgreSQL representation)
to a <var>Tinterval</var></dd>
<dt><a name="label-119" id="label-119"><code>high</code></a></dt><!-- RDLabel: "high" -->
<dd>
return a <var>Time</var> which is the high value of the interval</dd>
<dt><a name="label-120" id="label-120"><code>high=(<var>time</var>)</code></a></dt><!-- RDLabel: "high=" -->
<dd>
set the high value for the interval</dd>
<dt><a name="label-121" id="label-121"><code>initialize(<var>low</var>, <var>high</var>)</code></a></dt><!-- RDLabel: "initialize" -->
<dd>
create a <var>Tinterval</var> with the 2 <var>Time</var> objects
<var>low</var> and <var>high</var></dd>
<dt><a name="label-122" id="label-122"><code>low</code></a></dt><!-- RDLabel: "low" -->
<dd>
return a <var>Time</var> which is the low value of the interval</dd>
<dt><a name="label-123" id="label-123"><code>low=(<var>time</var>)</code></a></dt><!-- RDLabel: "low=" -->
<dd>
set the low value for the interval</dd>
<dt><a name="label-124" id="label-124"><code>to_s</code></a></dt><!-- RDLabel: "to_s" -->
<dd>
return the string representation of the object</dd>
</dl>
<h3><a name="label-125" id="label-125">class Box</a></h3><!-- RDLabel: "class Box" -->
<p>The Box implement the PostgreSQL type <var>box</var></p>
<p>The module Comparable is included</p>
<dl>
<dt><a name="label-126" id="label-126"><code>from_string(<var>string</var>)</code></a></dt><!-- RDLabel: "from_string" -->
<dd>
Convert a <var>String</var> (PostgreSQL representation)
to a <var>Box</var> object</dd>
<dt><a name="label-127" id="label-127"><code>+(<var>point</var>)</code></a></dt><!-- RDLabel: "+" -->
<dd>
translate (right, up) <var>self</var></dd>
<dt><a name="label-128" id="label-128"><code>-(<var>point</var>)</code></a></dt><!-- RDLabel: "-" -->