forked from jeremyevans/sequel
-
Notifications
You must be signed in to change notification settings - Fork 0
/
postgres.rb
1351 lines (1205 loc) · 54.9 KB
/
postgres.rb
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
Sequel.require 'adapters/utils/pg_types'
module Sequel
# Top level module for holding all PostgreSQL-related modules and classes
# for Sequel. There are a few module level accessors that are added via
# metaprogramming. These are:
# * client_min_messages (only available when using the native adapter) -
# Change the minimum level of messages that PostgreSQL will send to the
# the client. The PostgreSQL default is NOTICE, the Sequel default is
# WARNING. Set to nil to not change the server default.
# * force_standard_strings - Set to false to not force the use of
# standard strings
# * use_iso_date_format (only available when using the native adapter) -
# Set to false to not change the date format to
# ISO. This disables one of Sequel's optimizations.
#
# Changes in these settings only affect future connections. To make
# sure that they are applied, they should generally be called right
# after the Database object is instantiated and before a connection
# is actually made. For example, to use whatever the server defaults are:
#
# DB = Sequel.postgres(...)
# Sequel::Postgres.client_min_messages = nil
# Sequel::Postgres.force_standard_strings = false
# Sequel::Postgres.use_iso_date_format = false
# # A connection to the server is not made until here
# DB[:t].all
#
# The reason they can't be done earlier is that the Sequel::Postgres
# module is not loaded until a Database object which uses PostgreSQL
# is created.
module Postgres
# Array of exceptions that need to be converted. JDBC
# uses NativeExceptions, the native adapter uses PGError.
CONVERTED_EXCEPTIONS = []
@client_min_messages = :warning
@force_standard_strings = true
class << self
# By default, Sequel sets the minimum level of log messages sent to the client
# to WARNING, where PostgreSQL uses a default of NOTICE. This is to avoid a lot
# of mostly useless messages when running migrations, such as a couple of lines
# for every serial primary key field.
attr_accessor :client_min_messages
# By default, Sequel forces the use of standard strings, so that
# '\\' is interpreted as \\ and not \. While PostgreSQL <9.1 defaults
# to interpreting plain strings, newer versions use standard strings by
# default. Sequel assumes that SQL standard strings will be used. Setting
# this to false means Sequel will use the database's default.
attr_accessor :force_standard_strings
end
class CreateTableGenerator < Sequel::Schema::Generator
# Add an exclusion constraint when creating the table. Elements should be
# an array of 2 element arrays, with the first element being the column or
# expression the exclusion constraint is applied to, and the second element
# being the operator to use for the column/expression to check for exclusion.
#
# Example:
#
# exclude([[:col1, '&&'], [:col2, '=']])
# # EXCLUDE USING gist (col1 WITH &&, col2 WITH =)
#
# Options supported:
#
# :name :: Name the constraint with the given name (useful if you may
# need to drop the constraint later)
# :using :: Override the index_method for the exclusion constraint (defaults to gist).
# :where :: Create a partial exclusion constraint, which only affects
# a subset of table rows, value should be a filter expression.
def exclude(elements, opts={})
constraints << {:type => :exclude, :elements => elements}.merge(opts)
end
end
class AlterTableGenerator < Sequel::Schema::AlterTableGenerator
# Adds an exclusion constraint to an existing table, see
# CreateTableGenerator#exclude.
def add_exclusion_constraint(elements, opts={})
@operations << {:op => :add_constraint, :type => :exclude, :elements => elements}.merge(opts)
end
# Validate the constraint with the given name, which should have
# been added previously with NOT VALID.
def validate_constraint(name)
@operations << {:op => :validate_constraint, :name => name}
end
end
# Methods shared by Database instances that connect to PostgreSQL.
module DatabaseMethods
EXCLUDE_SCHEMAS = /pg_*|information_schema/i
PREPARED_ARG_PLACEHOLDER = LiteralString.new('$').freeze
RE_CURRVAL_ERROR = /currval of sequence "(.*)" is not yet defined in this session|relation "(.*)" does not exist/.freeze
SYSTEM_TABLE_REGEXP = /^pg|sql/.freeze
FOREIGN_KEY_LIST_ON_DELETE_MAP = {'a'.freeze=>:no_action, 'r'.freeze=>:restrict, 'c'.freeze=>:cascade, 'n'.freeze=>:set_null, 'd'.freeze=>:set_default}.freeze
POSTGRES_DEFAULT_RE = /\A(?:B?('.*')::[^']+|\((-?\d+(?:\.\d+)?)\))\z/
UNLOGGED = 'UNLOGGED '.freeze
# SQL fragment for custom sequences (ones not created by serial primary key),
# Returning the schema and literal form of the sequence name, by parsing
# the column defaults table.
SELECT_CUSTOM_SEQUENCE_SQL = (<<-end_sql
SELECT name.nspname AS "schema",
CASE
WHEN split_part(def.adsrc, '''', 2) ~ '.' THEN
substr(split_part(def.adsrc, '''', 2),
strpos(split_part(def.adsrc, '''', 2), '.')+1)
ELSE split_part(def.adsrc, '''', 2)
END AS "sequence"
FROM pg_class t
JOIN pg_namespace name ON (t.relnamespace = name.oid)
JOIN pg_attribute attr ON (t.oid = attrelid)
JOIN pg_attrdef def ON (adrelid = attrelid AND adnum = attnum)
JOIN pg_constraint cons ON (conrelid = adrelid AND adnum = conkey[1])
WHERE cons.contype = 'p'
AND def.adsrc ~* 'nextval'
end_sql
).strip.gsub(/\s+/, ' ').freeze
# SQL fragment for determining primary key column for the given table. Only
# returns the first primary key if the table has a composite primary key.
SELECT_PK_SQL = (<<-end_sql
SELECT pg_attribute.attname AS pk
FROM pg_class, pg_attribute, pg_index, pg_namespace
WHERE pg_class.oid = pg_attribute.attrelid
AND pg_class.relnamespace = pg_namespace.oid
AND pg_class.oid = pg_index.indrelid
AND pg_index.indkey[0] = pg_attribute.attnum
AND pg_index.indisprimary = 't'
end_sql
).strip.gsub(/\s+/, ' ').freeze
# SQL fragment for getting sequence associated with table's
# primary key, assuming it was a serial primary key column.
SELECT_SERIAL_SEQUENCE_SQL = (<<-end_sql
SELECT name.nspname AS "schema", seq.relname AS "sequence"
FROM pg_class seq, pg_attribute attr, pg_depend dep,
pg_namespace name, pg_constraint cons, pg_class t
WHERE seq.oid = dep.objid
AND seq.relnamespace = name.oid
AND seq.relkind = 'S'
AND attr.attrelid = dep.refobjid
AND attr.attnum = dep.refobjsubid
AND attr.attrelid = cons.conrelid
AND attr.attnum = cons.conkey[1]
AND attr.attrelid = t.oid
AND cons.contype = 'p'
end_sql
).strip.gsub(/\s+/, ' ').freeze
# The Sequel extensions that require reseting of the conversion procs.
RESET_PROCS_EXTENSIONS = [:pg_array, :pg_hstore, :pg_inet, :pg_interval, :pg_json, :pg_range].freeze
# A hash of conversion procs, keyed by type integer (oid) and
# having callable values for the conversion proc for that type.
attr_reader :conversion_procs
# Commit an existing prepared transaction with the given transaction
# identifier string.
def commit_prepared_transaction(transaction_id)
run("COMMIT PREPARED #{literal(transaction_id)}")
end
# Creates the function in the database. Arguments:
# * name : name of the function to create
# * definition : string definition of the function, or object file for a dynamically loaded C function.
# * opts : options hash:
# * :args : function arguments, can be either a symbol or string specifying a type or an array of 1-3 elements:
# * element 1 : argument data type
# * element 2 : argument name
# * element 3 : argument mode (e.g. in, out, inout)
# * :behavior : Should be IMMUTABLE, STABLE, or VOLATILE. PostgreSQL assumes VOLATILE by default.
# * :cost : The estimated cost of the function, used by the query planner.
# * :language : The language the function uses. SQL is the default.
# * :link_symbol : For a dynamically loaded see function, the function's link symbol if different from the definition argument.
# * :returns : The data type returned by the function. If you are using OUT or INOUT argument modes, this is ignored.
# Otherwise, if this is not specified, void is used by default to specify the function is not supposed to return a value.
# * :rows : The estimated number of rows the function will return. Only use if the function returns SETOF something.
# * :security_definer : Makes the privileges of the function the same as the privileges of the user who defined the function instead of
# the privileges of the user who runs the function. There are security implications when doing this, see the PostgreSQL documentation.
# * :set : Configuration variables to set while the function is being run, can be a hash or an array of two pairs. search_path is
# often used here if :security_definer is used.
# * :strict : Makes the function return NULL when any argument is NULL.
def create_function(name, definition, opts={})
self << create_function_sql(name, definition, opts)
end
# Create the procedural language in the database. Arguments:
# * name : Name of the procedural language (e.g. plpgsql)
# * opts : options hash:
# * :handler : The name of a previously registered function used as a call handler for this language.
# * :replace: Replace the installed language if it already exists (on PostgreSQL 9.0+).
# * :trusted : Marks the language being created as trusted, allowing unprivileged users to create functions using this language.
# * :validator : The name of previously registered function used as a validator of functions defined in this language.
def create_language(name, opts={})
self << create_language_sql(name, opts)
end
# Create a schema in the database. Arguments:
# * name : Name of the schema (e.g. admin)
def create_schema(name)
self << create_schema_sql(name)
end
# Create a trigger in the database. Arguments:
# * table : the table on which this trigger operates
# * name : the name of this trigger
# * function : the function to call for this trigger, which should return type trigger.
# * opts : options hash:
# * :after : Calls the trigger after execution instead of before.
# * :args : An argument or array of arguments to pass to the function.
# * :each_row : Calls the trigger for each row instead of for each statement.
# * :events : Can be :insert, :update, :delete, or an array of any of those. Calls the trigger whenever that type of statement is used. By default,
# the trigger is called for insert, update, or delete.
def create_trigger(table, name, function, opts={})
self << create_trigger_sql(table, name, function, opts)
end
# PostgreSQL uses the :postgres database type.
def database_type
:postgres
end
# Use PostgreSQL's DO syntax to execute an anonymous code block. The code should
# be the literal code string to use in the underlying procedural language. Options:
#
# :language :: The procedural language the code is written in. The PostgreSQL
# default is plpgsql. Can be specified as a string or a symbol.
def do(code, opts={})
language = opts[:language]
run "DO #{"LANGUAGE #{literal(language.to_s)} " if language}#{literal(code)}"
end
# Drops the function from the database. Arguments:
# * name : name of the function to drop
# * opts : options hash:
# * :args : The arguments for the function. See create_function_sql.
# * :cascade : Drop other objects depending on this function.
# * :if_exists : Don't raise an error if the function doesn't exist.
def drop_function(name, opts={})
self << drop_function_sql(name, opts)
end
# Drops a procedural language from the database. Arguments:
# * name : name of the procedural language to drop
# * opts : options hash:
# * :cascade : Drop other objects depending on this function.
# * :if_exists : Don't raise an error if the function doesn't exist.
def drop_language(name, opts={})
self << drop_language_sql(name, opts)
end
# Drops a schema from the database. Arguments:
# * name : name of the schema to drop
# * opts : options hash:
# * :cascade : Drop all objects in this schema.
# * :if_exists : Don't raise an error if the schema doesn't exist.
def drop_schema(name, opts={})
self << drop_schema_sql(name, opts)
end
# Drops a trigger from the database. Arguments:
# * table : table from which to drop the trigger
# * name : name of the trigger to drop
# * opts : options hash:
# * :cascade : Drop other objects depending on this function.
# * :if_exists : Don't raise an error if the function doesn't exist.
def drop_trigger(table, name, opts={})
self << drop_trigger_sql(table, name, opts)
end
# If any of the extensions that require reseting the conversion procs
# is loaded, reset them. This is done here so that if you load
# multiple pg_* extensions in the same call, the conversion procs are
# only reset once instead of once for every extension.
def extension(*exts)
super
unless (RESET_PROCS_EXTENSIONS & exts).empty?
reset_conversion_procs
end
end
# Return full foreign key information using the pg system tables, including
# :name, :on_delete, :on_update, and :deferrable entries in the hashes.
def foreign_key_list(table, opts={})
m = output_identifier_meth
im = input_identifier_meth
schema, table = schema_and_table(table)
range = 0...32
base_ds = metadata_dataset.
where(:cl__relkind=>'r', :co__contype=>'f', :cl__relname=>im.call(table)).
from(:pg_constraint___co).
join(:pg_class___cl, :oid=>:conrelid)
# We split the parsing into two separate queries, which are merged manually later.
# This is because PostgreSQL stores both the referencing and referenced columns in
# arrays, and I don't know a simple way to not create a cross product, as PostgreSQL
# doesn't appear to have a function that takes an array and element and gives you
# the index of that element in the array.
ds = base_ds.
join(:pg_attribute___att, :attrelid=>:oid, :attnum=>SQL::Function.new(:ANY, :co__conkey)).
order(:co__conname, SQL::CaseExpression.new(range.map{|x| [SQL::Subscript.new(:co__conkey, [x]), x]}, 32, :att__attnum)).
select(:co__conname___name, :att__attname___column, :co__confupdtype___on_update, :co__confdeltype___on_delete,
SQL::BooleanExpression.new(:AND, :co__condeferrable, :co__condeferred).as(:deferrable))
ref_ds = base_ds.
join(:pg_class___cl2, :oid=>:co__confrelid).
join(:pg_attribute___att2, :attrelid=>:oid, :attnum=>SQL::Function.new(:ANY, :co__confkey)).
order(:co__conname, SQL::CaseExpression.new(range.map{|x| [SQL::Subscript.new(:co__conkey, [x]), x]}, 32, :att2__attnum)).
select(:co__conname___name, :cl2__relname___table, :att2__attname___refcolumn)
# If a schema is given, we only search in that schema, and the returned :table
# entry is schema qualified as well.
if schema
ds = ds.join(:pg_namespace___nsp, :oid=>:cl__relnamespace).
where(:nsp__nspname=>im.call(schema))
ref_ds = ref_ds.join(:pg_namespace___nsp2, :oid=>:cl2__relnamespace).
select_more(:nsp2__nspname___schema)
end
h = {}
fklod_map = FOREIGN_KEY_LIST_ON_DELETE_MAP
ds.each do |row|
if r = h[row[:name]]
r[:columns] << m.call(row[:column])
else
h[row[:name]] = {:name=>m.call(row[:name]), :columns=>[m.call(row[:column])], :on_update=>fklod_map[row[:on_update]], :on_delete=>fklod_map[row[:on_delete]], :deferrable=>row[:deferrable]}
end
end
ref_ds.each do |row|
r = h[row[:name]]
r[:table] ||= schema ? SQL::QualifiedIdentifier.new(m.call(row[:schema]), m.call(row[:table])) : m.call(row[:table])
r[:key] ||= []
r[:key] << m.call(row[:refcolumn])
end
h.values
end
# Use the pg_* system tables to determine indexes on a table
def indexes(table, opts={})
m = output_identifier_meth
im = input_identifier_meth
schema, table = schema_and_table(table)
range = 0...32
attnums = server_version >= 80100 ? SQL::Function.new(:ANY, :ind__indkey) : range.map{|x| SQL::Subscript.new(:ind__indkey, [x])}
ds = metadata_dataset.
from(:pg_class___tab).
join(:pg_index___ind, :indrelid=>:oid, im.call(table)=>:relname).
join(:pg_class___indc, :oid=>:indexrelid).
join(:pg_attribute___att, :attrelid=>:tab__oid, :attnum=>attnums).
left_join(:pg_constraint___con, :conname=>:indc__relname).
filter(:indc__relkind=>'i', :ind__indisprimary=>false, :indexprs=>nil, :indpred=>nil, :indisvalid=>true).
order(:indc__relname, SQL::CaseExpression.new(range.map{|x| [SQL::Subscript.new(:ind__indkey, [x]), x]}, 32, :att__attnum)).
select(:indc__relname___name, :ind__indisunique___unique, :att__attname___column, :con__condeferrable___deferrable)
ds.join!(:pg_namespace___nsp, :oid=>:tab__relnamespace, :nspname=>schema.to_s) if schema
ds.filter!(:indisready=>true, :indcheckxmin=>false) if server_version >= 80300
indexes = {}
ds.each do |r|
i = indexes[m.call(r[:name])] ||= {:columns=>[], :unique=>r[:unique], :deferrable=>r[:deferrable]}
i[:columns] << m.call(r[:column])
end
indexes
end
# Dataset containing all current database locks
def locks
dataset.from(:pg_class).join(:pg_locks, :relation=>:relfilenode).select(:pg_class__relname, Sequel::SQL::ColumnAll.new(:pg_locks))
end
# Notifies the given channel. See the PostgreSQL NOTIFY documentation. Options:
#
# :payload :: The payload string to use for the NOTIFY statement. Only supported
# in PostgreSQL 9.0+.
# :server :: The server to which to send the NOTIFY statement, if the sharding support
# is being used.
def notify(channel, opts={})
execute_ddl("NOTIFY #{dataset.send(:table_ref, channel)}#{", #{literal(opts[:payload].to_s)}" if opts[:payload]}", opts)
end
# Return primary key for the given table.
def primary_key(table, opts={})
quoted_table = quote_schema_table(table)
Sequel.synchronize{return @primary_keys[quoted_table] if @primary_keys.has_key?(quoted_table)}
schema, table = schema_and_table(table)
sql = "#{SELECT_PK_SQL} AND pg_class.relname = #{literal(table)}"
sql << " AND pg_namespace.nspname = #{literal(schema)}" if schema
value = fetch(sql).single_value
Sequel.synchronize{@primary_keys[quoted_table] = value}
end
# Return the sequence providing the default for the primary key for the given table.
def primary_key_sequence(table, opts={})
quoted_table = quote_schema_table(table)
Sequel.synchronize{return @primary_key_sequences[quoted_table] if @primary_key_sequences.has_key?(quoted_table)}
schema, table = schema_and_table(table)
table = literal(table)
sql = "#{SELECT_SERIAL_SEQUENCE_SQL} AND t.relname = #{table}"
sql << " AND name.nspname = #{literal(schema)}" if schema
if pks = fetch(sql).single_record
value = literal(SQL::QualifiedIdentifier.new(pks[:schema], pks[:sequence]))
Sequel.synchronize{@primary_key_sequences[quoted_table] = value}
else
sql = "#{SELECT_CUSTOM_SEQUENCE_SQL} AND t.relname = #{table}"
sql << " AND name.nspname = #{literal(schema)}" if schema
if pks = fetch(sql).single_record
value = literal(SQL::QualifiedIdentifier.new(pks[:schema], LiteralString.new(pks[:sequence])))
Sequel.synchronize{@primary_key_sequences[quoted_table] = value}
end
end
end
# Reset the database's conversion procs, requires a server query if there
# any named types.
def reset_conversion_procs
@conversion_procs = get_conversion_procs
end
# Reset the primary key sequence for the given table, basing it on the
# maximum current value of the table's primary key.
def reset_primary_key_sequence(table)
return unless seq = primary_key_sequence(table)
pk = SQL::Identifier.new(primary_key(table))
db = self
seq_ds = db.from(LiteralString.new(seq))
s, t = schema_and_table(table)
table = Sequel.qualify(s, t) if s
get{setval(seq, db[table].select{coalesce(max(pk)+seq_ds.select{:increment_by}, seq_ds.select(:min_value))}, false)}
end
# Rollback an existing prepared transaction with the given transaction
# identifier string.
def rollback_prepared_transaction(transaction_id)
run("ROLLBACK PREPARED #{literal(transaction_id)}")
end
# PostgreSQL uses SERIAL psuedo-type instead of AUTOINCREMENT for
# managing incrementing primary keys.
def serial_primary_key_options
{:primary_key => true, :serial => true, :type=>Integer}
end
# The version of the PostgreSQL server, used for determining capability.
def server_version(server=nil)
return @server_version if @server_version
@server_version = synchronize(server) do |conn|
(conn.server_version rescue nil) if conn.respond_to?(:server_version)
end
unless @server_version
@server_version = if m = /PostgreSQL (\d+)\.(\d+)(?:(?:rc\d+)|\.(\d+))?/.match(fetch('SELECT version()').single_value)
(m[1].to_i * 10000) + (m[2].to_i * 100) + m[3].to_i
else
0
end
end
warn 'Sequel no longer supports PostgreSQL <8.2, some things may not work' if @server_version < 80200
@server_version
end
# PostgreSQL supports CREATE TABLE IF NOT EXISTS on 9.1+
def supports_create_table_if_not_exists?
server_version >= 90100
end
# PostgreSQL 9.0+ supports some types of deferrable constraints beyond foreign key constraints.
def supports_deferrable_constraints?
server_version >= 90000
end
# PostgreSQL supports deferrable foreign key constraints.
def supports_deferrable_foreign_key_constraints?
true
end
# PostgreSQL supports DROP TABLE IF EXISTS
def supports_drop_table_if_exists?
true
end
# PostgreSQL supports prepared transactions (two-phase commit) if
# max_prepared_transactions is greater than 0.
def supports_prepared_transactions?
return @supports_prepared_transactions if defined?(@supports_prepared_transactions)
@supports_prepared_transactions = self['SHOW max_prepared_transactions'].get.to_i > 0
end
# PostgreSQL supports savepoints
def supports_savepoints?
true
end
# PostgreSQL supports transaction isolation levels
def supports_transaction_isolation_levels?
true
end
# PostgreSQL supports transaction DDL statements.
def supports_transactional_ddl?
true
end
# Array of symbols specifying table names in the current database.
# The dataset used is yielded to the block if one is provided,
# otherwise, an array of symbols of table names is returned.
#
# Options:
# * :schema - The schema to search (default_schema by default)
# * :server - The server to use
def tables(opts={}, &block)
pg_class_relname('r', opts, &block)
end
# Check whether the given type name string/symbol (e.g. :hstore) is supported by
# the database.
def type_supported?(type)
@supported_types ||= {}
@supported_types.fetch(type){@supported_types[type] = (from(:pg_type).filter(:typtype=>'b', :typname=>type.to_s).count > 0)}
end
# Array of symbols specifying view names in the current database.
#
# Options:
# * :schema - The schema to search (default_schema by default)
# * :server - The server to use
def views(opts={})
pg_class_relname('v', opts)
end
private
# Use a PostgreSQL-specific alter table generator
def alter_table_generator_class
Postgres::AlterTableGenerator
end
# Handle :using option for set_column_type op, and the :validate_constraint op.
def alter_table_op_sql(table, op)
case op[:op]
when :set_column_type
s = super
if using = op[:using]
using = Sequel::LiteralString.new(using) if using.is_a?(String)
s << ' USING '
s << literal(using)
end
s
when :validate_constraint
"VALIDATE CONSTRAINT #{quote_identifier(op[:name])}"
else
super
end
end
# If the :synchronous option is given and non-nil, set synchronous_commit
# appropriately. Valid values for the :synchronous option are true,
# :on, false, :off, :local, and :remote_write.
def begin_new_transaction(conn, opts)
super
if opts.has_key?(:synchronous)
case sync = opts[:synchronous]
when true
sync = :on
when false
sync = :off
when nil
return
end
log_connection_execute(conn, "SET LOCAL synchronous_commit = #{sync}")
end
end
# Handle PostgreSQL specific default format.
def column_schema_normalize_default(default, type)
if m = POSTGRES_DEFAULT_RE.match(default)
default = m[1] || m[2]
end
super(default, type)
end
# If the :prepare option is given and we aren't in a savepoint,
# prepare the transaction for a two-phase commit.
def commit_transaction(conn, opts={})
if (s = opts[:prepare]) && _trans(conn)[:savepoint_level] <= 1
log_connection_execute(conn, "PREPARE TRANSACTION #{literal(s)}")
else
super
end
end
# PostgreSQL can't combine rename_column operations, and it can combine
# the custom validate_constraint operation.
def combinable_alter_table_op?(op)
(super || op[:op] == :validate_constraint) && op[:op] != :rename_column
end
# The SQL queries to execute when starting a new connection.
def connection_configuration_sqls
sqls = []
sqls << "SET standard_conforming_strings = ON" if Postgres.force_standard_strings
if cmm = Postgres.client_min_messages
sqls << "SET client_min_messages = '#{cmm.to_s.upcase}'"
end
sqls
end
# Handle exclusion constraints.
def constraint_definition_sql(constraint)
case constraint[:type]
when :exclude
elements = constraint[:elements].map{|c, op| "#{literal(c)} WITH #{op}"}.join(', ')
"#{"CONSTRAINT #{quote_identifier(constraint[:name])} " if constraint[:name]}EXCLUDE USING #{constraint[:using]||'gist'} (#{elements})#{" WHERE #{filter_expr(constraint[:where])}" if constraint[:where]}"
when :foreign_key
sql = super
if constraint[:not_valid]
sql << " NOT VALID"
end
sql
else
super
end
end
# SQL for doing fast table insert from stdin.
def copy_into_sql(table, opts)
sql = "COPY #{literal(table)}"
if cols = opts[:columns]
sql << literal(Array(cols))
end
sql << " FROM STDIN"
if opts[:options] || opts[:format]
sql << " ("
sql << "FORMAT #{opts[:format]}" if opts[:format]
sql << "#{', ' if opts[:format]}#{opts[:options]}" if opts[:options]
sql << ')'
end
sql
end
# SQL for doing fast table output to stdout.
def copy_table_sql(table, opts)
if table.is_a?(String)
return table
else
if opts[:options] || opts[:format]
options = " ("
options << "FORMAT #{opts[:format]}" if opts[:format]
options << "#{', ' if opts[:format]}#{opts[:options]}" if opts[:options]
options << ')'
end
table = if table.is_a?(::Sequel::Dataset)
"(#{table.sql})"
else
literal(table)
end
return "COPY #{table} TO STDOUT#{options}"
end
end
# SQL statement to create database function.
def create_function_sql(name, definition, opts={})
args = opts[:args]
if !opts[:args].is_a?(Array) || !opts[:args].any?{|a| Array(a).length == 3 and %w'OUT INOUT'.include?(a[2].to_s)}
returns = opts[:returns] || 'void'
end
language = opts[:language] || 'SQL'
<<-END
CREATE#{' OR REPLACE' if opts[:replace]} FUNCTION #{name}#{sql_function_args(args)}
#{"RETURNS #{returns}" if returns}
LANGUAGE #{language}
#{opts[:behavior].to_s.upcase if opts[:behavior]}
#{'STRICT' if opts[:strict]}
#{'SECURITY DEFINER' if opts[:security_definer]}
#{"COST #{opts[:cost]}" if opts[:cost]}
#{"ROWS #{opts[:rows]}" if opts[:rows]}
#{opts[:set].map{|k,v| " SET #{k} = #{v}"}.join("\n") if opts[:set]}
AS #{literal(definition.to_s)}#{", #{literal(opts[:link_symbol].to_s)}" if opts[:link_symbol]}
END
end
# SQL for creating a procedural language.
def create_language_sql(name, opts={})
"CREATE#{' OR REPLACE' if opts[:replace] && server_version >= 90000}#{' TRUSTED' if opts[:trusted]} LANGUAGE #{name}#{" HANDLER #{opts[:handler]}" if opts[:handler]}#{" VALIDATOR #{opts[:validator]}" if opts[:validator]}"
end
# SQL for creating a schema.
def create_schema_sql(name)
"CREATE SCHEMA #{quote_identifier(name)}"
end
# DDL statement for creating a table with the given name, columns, and options
def create_table_prefix_sql(name, options)
temp_or_unlogged_sql = if options[:temp]
raise(Error, "can't provide both :temp and :unlogged to create_table") if options[:unlogged]
temporary_table_sql
elsif options[:unlogged]
UNLOGGED
end
"CREATE #{temp_or_unlogged_sql}TABLE#{' IF NOT EXISTS' if options[:if_not_exists]} #{options[:temp] ? quote_identifier(name) : quote_schema_table(name)}"
end
# Use a PostgreSQL-specific create table generator
def create_table_generator_class
Postgres::CreateTableGenerator
end
# SQL for creating a database trigger.
def create_trigger_sql(table, name, function, opts={})
events = opts[:events] ? Array(opts[:events]) : [:insert, :update, :delete]
whence = opts[:after] ? 'AFTER' : 'BEFORE'
"CREATE TRIGGER #{name} #{whence} #{events.map{|e| e.to_s.upcase}.join(' OR ')} ON #{quote_schema_table(table)}#{' FOR EACH ROW' if opts[:each_row]} EXECUTE PROCEDURE #{function}(#{Array(opts[:args]).map{|a| literal(a)}.join(', ')})"
end
# The errors that the main adapters can raise, depends on the adapter being used
def database_error_classes
CONVERTED_EXCEPTIONS
end
# SQL for dropping a function from the database.
def drop_function_sql(name, opts={})
"DROP FUNCTION#{' IF EXISTS' if opts[:if_exists]} #{name}#{sql_function_args(opts[:args])}#{' CASCADE' if opts[:cascade]}"
end
# Support :if_exists, :cascade, and :concurrently options.
def drop_index_sql(table, op)
"DROP INDEX#{' CONCURRENTLY' if op[:concurrently]}#{' IF EXISTS' if op[:if_exists]} #{quote_identifier(op[:name] || default_index_name(table, op[:columns]))}#{' CASCADE' if op[:cascade]}"
end
# SQL for dropping a procedural language from the database.
def drop_language_sql(name, opts={})
"DROP LANGUAGE#{' IF EXISTS' if opts[:if_exists]} #{name}#{' CASCADE' if opts[:cascade]}"
end
# SQL for dropping a schema from the database.
def drop_schema_sql(name, opts={})
"DROP SCHEMA#{' IF EXISTS' if opts[:if_exists]} #{quote_identifier(name)}#{' CASCADE' if opts[:cascade]}"
end
# SQL for dropping a trigger from the database.
def drop_trigger_sql(table, name, opts={})
"DROP TRIGGER#{' IF EXISTS' if opts[:if_exists]} #{name} ON #{quote_schema_table(table)}#{' CASCADE' if opts[:cascade]}"
end
# If opts includes a :schema option, or a default schema is used, restrict the dataset to
# that schema. Otherwise, just exclude the default PostgreSQL schemas except for public.
def filter_schema(ds, opts)
if schema = opts[:schema] || default_schema
ds.filter(:pg_namespace__nspname=>schema.to_s)
else
ds.exclude(:pg_namespace__nspname=>EXCLUDE_SCHEMAS)
end
end
# Return a hash with oid keys and callable values, used for converting types.
def get_conversion_procs
procs = PG_TYPES.dup
procs[1184] = procs[1114] = method(:to_application_timestamp)
unless (pgnt = PG_NAMED_TYPES).empty?
from(:pg_type).where(:typtype=>'b', :typname=>pgnt.keys.map{|t| t.to_s}).select_map([:oid, :typname]).each do |oid, name|
procs[oid.to_i] ||= pgnt[name.untaint.to_sym]
end
end
procs
end
# PostgreSQL folds unquoted identifiers to lowercase, so it shouldn't need to upcase identifiers on input.
def identifier_input_method_default
nil
end
# PostgreSQL folds unquoted identifiers to lowercase, so it shouldn't need to upcase identifiers on output.
def identifier_output_method_default
nil
end
# PostgreSQL specific index SQL.
def index_definition_sql(table_name, index)
cols = index[:columns]
index_name = index[:name] || default_index_name(table_name, cols)
expr = if o = index[:opclass]
"(#{Array(cols).map{|c| "#{literal(c)} #{o}"}.join(', ')})"
else
literal(Array(cols))
end
unique = "UNIQUE " if index[:unique]
index_type = index[:type]
filter = index[:where] || index[:filter]
filter = " WHERE #{filter_expr(filter)}" if filter
case index_type
when :full_text
expr = "(to_tsvector(#{literal(index[:language] || 'simple')}::regconfig, #{literal(dataset.send(:full_text_string_join, cols))}))"
index_type = :gin
when :spatial
index_type = :gist
end
"CREATE #{unique}INDEX#{' CONCURRENTLY' if index[:concurrently]} #{quote_identifier(index_name)} ON #{quote_schema_table(table_name)} #{"USING #{index_type} " if index_type}#{expr}#{filter}"
end
# Setup datastructures shared by all postgres adapters.
def initialize_postgres_adapter
@primary_keys = {}
@primary_key_sequences = {}
@conversion_procs = PG_TYPES.dup
reset_conversion_procs
end
# Backbone of the tables and views support.
def pg_class_relname(type, opts)
ds = metadata_dataset.from(:pg_class).filter(:relkind=>type).select(:relname).exclude(SQL::StringExpression.like(:relname, SYSTEM_TABLE_REGEXP)).server(opts[:server]).join(:pg_namespace, :oid=>:relnamespace)
ds = filter_schema(ds, opts)
m = output_identifier_meth
block_given? ? yield(ds) : ds.map{|r| m.call(r[:relname])}
end
# Use a dollar sign instead of question mark for the argument
# placeholder.
def prepared_arg_placeholder
PREPARED_ARG_PLACEHOLDER
end
# Remove the cached entries for primary keys and sequences when a table is
# changed.
def remove_cached_schema(table)
tab = quote_schema_table(table)
Sequel.synchronize do
@primary_keys.delete(tab)
@primary_key_sequences.delete(tab)
end
super
end
# SQL DDL statement for renaming a table. PostgreSQL doesn't allow you to change a table's schema in
# a rename table operation, so speciying a new schema in new_name will not have an effect.
def rename_table_sql(name, new_name)
"ALTER TABLE #{quote_schema_table(name)} RENAME TO #{quote_identifier(schema_and_table(new_name).last)}"
end
# PostgreSQL's autoincrementing primary keys are of type integer or bigint
# using a nextval function call as a default.
def schema_autoincrementing_primary_key?(schema)
super && schema[:default] =~ /\Anextval/io
end
# Recognize PostgreSQL interval type.
def schema_column_type(db_type)
case db_type
when /\Ainterval\z/io
:interval
else
super
end
end
# The dataset used for parsing table schemas, using the pg_* system catalogs.
def schema_parse_table(table_name, opts)
m = output_identifier_meth(opts[:dataset])
m2 = input_identifier_meth(opts[:dataset])
ds = metadata_dataset.select(:pg_attribute__attname___name,
SQL::Cast.new(:pg_attribute__atttypid, :integer).as(:oid),
SQL::Function.new(:format_type, :pg_type__oid, :pg_attribute__atttypmod).as(:db_type),
SQL::Function.new(:pg_get_expr, :pg_attrdef__adbin, :pg_class__oid).as(:default),
SQL::BooleanExpression.new(:NOT, :pg_attribute__attnotnull).as(:allow_null),
SQL::Function.new(:COALESCE, SQL::BooleanExpression.from_value_pairs(:pg_attribute__attnum => SQL::Function.new(:ANY, :pg_index__indkey)), false).as(:primary_key),
:pg_namespace__nspname).
from(:pg_class).
join(:pg_attribute, :attrelid=>:oid).
join(:pg_type, :oid=>:atttypid).
join(:pg_namespace, :oid=>:pg_class__relnamespace).
left_outer_join(:pg_attrdef, :adrelid=>:pg_class__oid, :adnum=>:pg_attribute__attnum).
left_outer_join(:pg_index, :indrelid=>:pg_class__oid, :indisprimary=>true).
filter(:pg_attribute__attisdropped=>false).
filter{|o| o.pg_attribute__attnum > 0}.
filter(:pg_class__relname=>m2.call(table_name)).
order(:pg_attribute__attnum)
ds = filter_schema(ds, opts)
current_schema = nil
ds.map do |row|
sch = row.delete(:nspname)
if current_schema
if sch != current_schema
raise Error, "columns from tables in two separate schema were returned (please specify a schema): #{current_schema.inspect}, #{sch.inspect}"
end
else
current_schema = sch
end
row[:default] = nil if blank_object?(row[:default])
row[:type] = schema_column_type(row[:db_type])
[m.call(row.delete(:name)), row]
end
end
# Set the transaction isolation level on the given connection
def set_transaction_isolation(conn, opts)
level = opts.fetch(:isolation, transaction_isolation_level)
read_only = opts[:read_only]
deferrable = opts[:deferrable]
if level || !read_only.nil? || !deferrable.nil?
sql = "SET TRANSACTION"
sql << " ISOLATION LEVEL #{Sequel::Database::TRANSACTION_ISOLATION_LEVELS[level]}" if level
sql << " READ #{read_only ? 'ONLY' : 'WRITE'}" unless read_only.nil?
sql << " #{'NOT ' unless deferrable}DEFERRABLE" unless deferrable.nil?
log_connection_execute(conn, sql)
end
end
# Turns an array of argument specifiers into an SQL fragment used for function arguments. See create_function_sql.
def sql_function_args(args)
"(#{Array(args).map{|a| Array(a).reverse.join(' ')}.join(', ')})"
end
# PostgreSQL can combine multiple alter table ops into a single query.
def supports_combining_alter_table_ops?
true
end
# Handle bigserial type if :serial option is present
def type_literal_generic_bignum(column)
column[:serial] ? :bigserial : super
end
# PostgreSQL uses the bytea data type for blobs
def type_literal_generic_file(column)
:bytea
end
# Handle serial type if :serial option is present
def type_literal_generic_integer(column)
column[:serial] ? :serial : super
end
# PostgreSQL prefers the text datatype. If a fixed size is requested,
# the char type is used. If the text type is specifically
# disallowed or there is a size specified, use the varchar type.
# Otherwise use the type type.
def type_literal_generic_string(column)
if column[:fixed]
"char(#{column[:size]||255})"
elsif column[:text] == false or column[:size]
"varchar(#{column[:size]||255})"
else
:text
end
end
end
# Instance methods for datasets that connect to a PostgreSQL database.
module DatasetMethods
ACCESS_SHARE = 'ACCESS SHARE'.freeze
ACCESS_EXCLUSIVE = 'ACCESS EXCLUSIVE'.freeze
BOOL_FALSE = 'false'.freeze
BOOL_TRUE = 'true'.freeze
COMMA_SEPARATOR = ', '.freeze
DELETE_CLAUSE_METHODS = Dataset.clause_methods(:delete, %w'delete from using where returning')
DELETE_CLAUSE_METHODS_91 = Dataset.clause_methods(:delete, %w'with delete from using where returning')
EXCLUSIVE = 'EXCLUSIVE'.freeze
EXPLAIN = 'EXPLAIN '.freeze
EXPLAIN_ANALYZE = 'EXPLAIN ANALYZE '.freeze
FOR_SHARE = ' FOR SHARE'.freeze
INSERT_CLAUSE_METHODS = Dataset.clause_methods(:insert, %w'insert into columns values returning')
INSERT_CLAUSE_METHODS_91 = Dataset.clause_methods(:insert, %w'with insert into columns values returning')
LOCK = 'LOCK TABLE %s IN %s MODE'.freeze
NULL = LiteralString.new('NULL').freeze
PG_TIMESTAMP_FORMAT = "TIMESTAMP '%Y-%m-%d %H:%M:%S".freeze
QUERY_PLAN = 'QUERY PLAN'.to_sym
ROW_EXCLUSIVE = 'ROW EXCLUSIVE'.freeze
ROW_SHARE = 'ROW SHARE'.freeze
SELECT_CLAUSE_METHODS = Dataset.clause_methods(:select, %w'select distinct columns from join where group having compounds order limit lock')
SELECT_CLAUSE_METHODS_84 = Dataset.clause_methods(:select, %w'with select distinct columns from join where group having window compounds order limit lock')
SHARE = 'SHARE'.freeze
SHARE_ROW_EXCLUSIVE = 'SHARE ROW EXCLUSIVE'.freeze
SHARE_UPDATE_EXCLUSIVE = 'SHARE UPDATE EXCLUSIVE'.freeze
SQL_WITH_RECURSIVE = "WITH RECURSIVE ".freeze
UPDATE_CLAUSE_METHODS = Dataset.clause_methods(:update, %w'update table set from where returning')
UPDATE_CLAUSE_METHODS_91 = Dataset.clause_methods(:update, %w'with update table set from where returning')
SPACE = Dataset::SPACE
FROM = Dataset::FROM
APOS = Dataset::APOS
APOS_RE = Dataset::APOS_RE
DOUBLE_APOS = Dataset::DOUBLE_APOS
PAREN_OPEN = Dataset::PAREN_OPEN
PAREN_CLOSE = Dataset::PAREN_CLOSE
COMMA = Dataset::COMMA
AS = Dataset::AS
XOR_OP = ' # '.freeze
CRLF = "\r\n".freeze
BLOB_RE = /[\000-\037\047\134\177-\377]/n.freeze
WINDOW = " WINDOW ".freeze
EMPTY_STRING = ''.freeze
# Shared methods for prepared statements when used with PostgreSQL databases.
module PreparedStatementMethods
# Override insert action to use RETURNING if the server supports it.
def run
if @prepared_type == :insert