Module: Torque::PostgreSQL::Adapter::DatabaseStatements

Included in:
Torque::PostgreSQL::Adapter
Defined in:
lib/torque/postgresql/adapter/database_statements.rb

Constant Summary collapse

EXTENDED_DATABASE_TYPES = 
%i(enum enum_set interval)

Instance Method Summary collapse

Instance Method Details

#column_definitions(table_name) ⇒ Object

Get the list of columns, and their definition, but only from the actual table, does not include columns that comes from inherited table



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/torque/postgresql/adapter/database_statements.rb', line 143

def column_definitions(table_name) # :nodoc:
  # Only affects inheritance
  local_condition = 'AND a.attislocal IS TRUE' if @_dump_mode

  query(<<-SQL, 'SCHEMA')
      SELECT a.attname, format_type(a.atttypid, a.atttypmod),
             pg_get_expr(d.adbin, d.adrelid), a.attnotnull, a.atttypid, a.atttypmod,
     (SELECT c.collname FROM pg_collation c, pg_type t
       WHERE c.oid = a.attcollation AND t.oid = a.atttypid AND a.attcollation <> t.typcollation),
             col_description(a.attrelid, a.attnum) AS comment
        FROM pg_attribute a
   LEFT JOIN pg_attrdef d ON a.attrelid = d.adrelid AND a.attnum = d.adnum
       WHERE a.attrelid = '#{quote_table_name(table_name)}'::regclass
         AND a.attnum > 0
         AND a.attisdropped IS FALSE
         #{local_condition}
       ORDER BY a.attnum
  SQL
end

#configure_connection ⇒ Object

Configure the interval format



32
33
34
35
 
# File 'lib/torque/postgresql/adapter/database_statements.rb', line 32

def configure_connection
  super
  execute("SET SESSION IntervalStyle TO 'iso_8601'", 'SCHEMA')
end

#create_enum(name) ⇒ Object

Since enums create new types, type map needs to be rebooted to include the new ones, both normal and array one



39
40
41
42
43
44
 
# File 'lib/torque/postgresql/adapter/database_statements.rb', line 39

def create_enum(name, *)
  super

  oid = query_value("SELECT #{quote(name)}::regtype::oid", "SCHEMA").to_i
  load_additional_types([oid])
end

#dump_mode! ⇒ Object

Switch between dump mode or not



11
12
13
 
# File 'lib/torque/postgresql/adapter/database_statements.rb', line 11

def dump_mode!
  @_dump_mode = !!!@_dump_mode
end

#extended_types ⇒ Object

Get the list of extended types



21
22
23
 
# File 'lib/torque/postgresql/adapter/database_statements.rb', line 21

def extended_types
  EXTENDED_DATABASE_TYPES
end

#inherited_tables ⇒ Object

Get the list of inherited tables associated with their parent tables



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/torque/postgresql/adapter/database_statements.rb', line 125

def inherited_tables
  tables = query(<<-SQL, 'SCHEMA')
    SELECT child.relname             AS table_name,
           array_agg(parent.relname) AS inheritances
    FROM pg_inherits
    JOIN pg_class parent ON pg_inherits.inhparent = parent.oid
    JOIN pg_class child  ON pg_inherits.inhrelid  = child.oid
    GROUP BY child.relname, pg_inherits.inhrelid
    ORDER BY pg_inherits.inhrelid
  SQL

  tables.map do |(table, refs)|
    [table, PG::TextDecoder::Array.new.decode(refs)]
  end.to_h
end

#initialize_type_map(m = type_map) ⇒ Object

Change some of the types being mapped



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/torque/postgresql/adapter/database_statements.rb', line 47

def initialize_type_map(m = type_map)
  super
  m.register_type 'box',      OID::Box.new
  m.register_type 'circle',   OID::Circle.new
  m.register_type 'interval', OID::Interval.new
  m.register_type 'line',     OID::Line.new
  m.register_type 'segment',  OID::Segment.new

  m.alias_type 'regclass', 'varchar'
end

#load_additional_types(oids = nil) ⇒ Object

:nodoc:



59
60
61
62
 
# File 'lib/torque/postgresql/adapter/database_statements.rb', line 59

def load_additional_types(oids = nil)
  super
  torque_load_additional_types(oids)
end

#torque_load_additional_types(oids = nil) ⇒ Object

Add the composite types to be loaded too.



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
 
# File 'lib/torque/postgresql/adapter/database_statements.rb', line 65

def torque_load_additional_types(oids = nil)
  filter = ("AND     a.typelem::integer IN (%s)" % oids.join(', ')) if oids

  query = <<-SQL
    SELECT      a.typelem AS oid, t.typname, t.typelem,
                t.typdelim, t.typbasetype, t.typtype,
                t.typarray
    FROM        pg_type t
    INNER JOIN  pg_type a ON (a.oid = t.typarray)
    LEFT JOIN   pg_catalog.pg_namespace n ON n.oid = t.typnamespace
    WHERE       n.nspname NOT IN ('pg_catalog', 'information_schema')
    AND     t.typtype IN ( 'e' )
    #{filter}
    AND     NOT EXISTS(
              SELECT 1 FROM pg_catalog.pg_type el
                WHERE el.oid = t.typelem AND el.typarray = t.oid
              )
    AND     (t.typrelid = 0 OR (
              SELECT c.relkind = 'c' FROM pg_catalog.pg_class c
                WHERE c.oid = t.typrelid
              ))
  SQL

  execute_and_clear(query, 'SCHEMA', []) do |records|
    records.each { |row| OID::Enum.create(row, type_map) }
  end
end

#type_exists?(name) ⇒ Boolean Also known as: data_type_exists?

Returns true if type exists.

Returns:

  • (Boolean) 


26
27
28
 
# File 'lib/torque/postgresql/adapter/database_statements.rb', line 26

def type_exists?(name)
  user_defined_types.key? name.to_s
end

#user_defined_types(*categories) ⇒ Object

Gets a list of user defined types. You can even choose the category filter



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
 
# File 'lib/torque/postgresql/adapter/database_statements.rb', line 95

def user_defined_types(*categories)
  category_condition = categories.present? \
    ? "AND t.typtype IN ('#{categories.join("', '")}')" \
    : "AND t.typtype NOT IN ('b', 'd')"

  select_all(<<-SQL, 'SCHEMA').rows.to_h
    SELECT t.typname AS name,
           CASE t.typtype
             WHEN 'e' THEN 'enum'
             END     AS type
    FROM pg_type t
           LEFT JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace
    WHERE n.nspname NOT IN ('pg_catalog', 'information_schema')
      #{category_condition}
      AND NOT EXISTS(
        SELECT 1
        FROM pg_catalog.pg_type el
        WHERE el.oid = t.typelem
          AND el.typarray = t.oid
      )
      AND (t.typrelid = 0 OR (
      SELECT c.relkind = 'c'
      FROM pg_catalog.pg_class c
      WHERE c.oid = t.typrelid
    ))
    ORDER BY t.typtype DESC
  SQL
end

#valid_type?(type) ⇒ Boolean

Check if a given type is valid.

Returns:

  • (Boolean) 


16
17
18
 
# File 'lib/torque/postgresql/adapter/database_statements.rb', line 16

def valid_type?(type)
  super || extended_types.include?(type)
end