Module: ActiveRecord::FullTextSearch::PostgreSQLAdapter

Defined in:
lib/active_record/full_text_search/7.2/postgresql_adapter.rb

Constant Summary collapse

VOLATILITIES =
{
  "i" => :immutable,
  "s" => :stable,
  "v" => :volatile
}.freeze

Instance Method Summary collapse

Instance Method Details

#functionsObject



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
# File 'lib/active_record/full_text_search/7.2/postgresql_adapter.rb', line 15

def functions
  # List of functions in the current schema with their argument types, return type, language,  immutability, and body.
  # List only functions that don't depend on extensions.
  # Functions are ordered by dependency depth (via pg_depend) so that dependencies come first.
  res = exec_query(<<-SQL.strip_heredoc, "SCHEMA")
    WITH RECURSIVE
      func_deps AS (
        SELECT p.oid AS func_oid, dep_p.oid AS dep_func_oid
        FROM pg_catalog.pg_proc p
        JOIN pg_catalog.pg_namespace n ON n.oid = p.pronamespace
        JOIN pg_catalog.pg_depend fd ON fd.objid = p.oid AND fd.deptype = 'n'
        JOIN pg_catalog.pg_proc dep_p ON dep_p.oid = fd.refobjid
        JOIN pg_catalog.pg_namespace dep_n ON dep_n.oid = dep_p.pronamespace
        WHERE n.nspname = ANY (current_schemas(false))
          AND dep_n.nspname = ANY (current_schemas(false))
          AND p.oid != dep_p.oid
      ),
      levels(oid, level) AS (
        SELECT p.oid, 0
        FROM pg_catalog.pg_proc p
        JOIN pg_catalog.pg_namespace n ON n.oid = p.pronamespace
        WHERE n.nspname = ANY (current_schemas(false))
          AND p.oid NOT IN (SELECT func_oid FROM func_deps)
        UNION ALL
        SELECT fd.func_oid, l.level + 1
        FROM func_deps fd
        JOIN levels l ON l.oid = fd.dep_func_oid
      ),
      max_levels AS (
        SELECT oid, MAX(level) AS level FROM levels GROUP BY oid
      )
    SELECT proname, pg_catalog.pg_get_function_arguments(p.oid) AS argtypes, pg_catalog.pg_get_function_result(p.oid) AS rettype, lanname, provolatile, prosrc
    FROM pg_catalog.pg_proc p
    JOIN pg_catalog.pg_namespace n ON n.oid = p.pronamespace
    JOIN pg_catalog.pg_language l ON l.oid = p.prolang
    LEFT JOIN pg_catalog.pg_depend d ON d.objid = p.oid AND d.deptype = 'e'
    LEFT JOIN pg_catalog.pg_extension e ON e.oid = d.refobjid
    JOIN max_levels ml ON ml.oid = p.oid
    WHERE n.nspname = ANY (current_schemas(false))
      AND e.extname IS NULL
    ORDER BY ml.level, proname;
  SQL

  res.rows.each_with_object({}) do |(name, args, ret, lang, vol, src), memo|
    memo[name] = {arguments: args, returns: ret, language: lang, volatility: VOLATILITIES[vol], source: src}
  end
end

#text_search_configurationsObject



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
# File 'lib/active_record/full_text_search/7.2/postgresql_adapter.rb', line 150

def text_search_configurations
  res = exec_query(<<-SQL.strip_heredoc, "SCHEMA")
    SELECT cfg.oid, cfgname, cfgparser, prsname
    FROM pg_catalog.pg_ts_config AS cfg
    LEFT JOIN pg_catalog.pg_ts_parser ON cfgparser = pg_ts_parser.oid
    LEFT JOIN pg_catalog.pg_depend AS d ON d.objid = cfgparser AND d.deptype = 'e'
    LEFT JOIN pg_catalog.pg_extension AS e ON e.oid = d.refobjid
    WHERE cfgnamespace = (SELECT oid FROM pg_catalog.pg_namespace WHERE nspname = ANY (current_schemas(false)))
      AND e.extname IS NULL;
  SQL

  res.rows.each_with_object({}) do |(oid, name, parser_oid, parser_name), memo|
    maps = exec_query(<<-SQL.strip_heredoc, "SCHEMA")
      SELECT t.alias AS "token", dictname AS "dict"
      FROM pg_catalog.pg_ts_config_map
      JOIN (SELECT * FROM ts_token_type(#{parser_oid})) AS t ON maptokentype = t.tokid
      JOIN pg_catalog.pg_ts_dict ON mapdict = pg_ts_dict.oid
      WHERE mapcfg = #{oid}
      ORDER BY mapseqno;
    SQL
    maps = maps.rows.each_with_object({}) { |(token, dict), memo|
      memo[token] ||= []
      memo[token] << dict
    }
    maps = maps.each_with_object({}) { |(k, v), memo|
      memo[v] ||= []
      memo[v] << k
    }
    memo[name] = {parser: parser_name, maps: maps}
  end
end

#text_search_dictionariesObject



135
136
137
138
139
140
141
142
143
144
145
146
147
148
# File 'lib/active_record/full_text_search/7.2/postgresql_adapter.rb', line 135

def text_search_dictionaries
  res = exec_query(<<-SQL.strip_heredoc, "SCHEMA")
    SELECT dictname, tns.nspname || '.' || tmplname, dictinitoption
    FROM pg_catalog.pg_ts_dict
    LEFT JOIN pg_catalog.pg_ts_template AS t ON dicttemplate = t.oid
    LEFT JOIN pg_catalog.pg_namespace AS tns ON t.tmplnamespace = tns.oid
    LEFT JOIN pg_catalog.pg_depend AS d ON d.objid = dicttemplate AND d.deptype = 'e'
    LEFT JOIN pg_catalog.pg_extension AS e ON e.oid = d.refobjid
    WHERE dictnamespace = (SELECT oid FROM pg_catalog.pg_namespace WHERE nspname = ANY (current_schemas(false)))
      AND e.extname IS NULL;
  SQL

  res.rows.each_with_object({}) { |(name, template, init), memo| memo[name] = options_to_hash(init).reverse_merge(template: template) }.sort_by { |k, _| k.to_s }.sort_by { |_, v| v[:dictionary].nil? ? 0 : 1 }
end

#text_search_parsersObject



106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'lib/active_record/full_text_search/7.2/postgresql_adapter.rb', line 106

def text_search_parsers
  res = exec_query(<<-SQL.strip_heredoc, "SCHEMA")
    SELECT prsname, prsstart::VARCHAR, prstoken::VARCHAR, prsend::VARCHAR, prsheadline::VARCHAR, prslextype::VARCHAR
    FROM pg_catalog.pg_ts_parser
    LEFT JOIN pg_catalog.pg_depend AS d ON d.objid = pg_ts_parser.oid AND d.deptype = 'e'
    LEFT JOIN pg_catalog.pg_extension AS e ON e.oid = d.refobjid
    WHERE prsnamespace = (SELECT oid FROM pg_catalog.pg_namespace WHERE nspname = ANY (current_schemas(false)))
      AND e.extname IS NULL;
  SQL

  res.rows.each_with_object({}) do |(name, start, token, finish, headline, lextype), memo|
    memo[name] = {start: start, token: token, finish: finish, headline: headline, lextype: lextype}
  end
end

#text_search_templatesObject



121
122
123
124
125
126
127
128
129
130
131
132
133
# File 'lib/active_record/full_text_search/7.2/postgresql_adapter.rb', line 121

def text_search_templates
  res = exec_query(<<-SQL.strip_heredoc, "SCHEMA")
    SELECT tmplname, tmplinit::VARCHAR, tmpllexize::VARCHAR
    FROM pg_catalog.pg_ts_template
    LEFT JOIN pg_catalog.pg_depend AS d ON d.objid = pg_ts_template.oid AND d.deptype = 'e'
    LEFT JOIN pg_catalog.pg_extension AS e ON e.oid = d.refobjid
    WHERE tmplnamespace = (SELECT oid FROM pg_catalog.pg_namespace WHERE nspname = ANY (current_schemas(false)))
      AND tmplnamespace NOT IN (SELECT extnamespace FROM pg_extension)
      AND e.extname IS NULL;
  SQL

  res.rows.each_with_object({}) { |(name, init, lexize), memo| memo[name] = {init: init, lexize: lexize} }
end

#triggersObject



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
# File 'lib/active_record/full_text_search/7.2/postgresql_adapter.rb', line 65

def triggers
  # List of triggers in the current schema with name, table name, function, timing, op, for each, condition, deferrable, initially_deferred.
  res = exec_query(<<-SQL.strip_heredoc, "SCHEMA")
    SELECT tgname, c.relname, proname,
      COALESCE(
        CASE WHEN (tgtype::int::bit(7) & b'0000010')::int = 0 THEN NULL ELSE 'before' END,
        CASE WHEN (tgtype::int::bit(7) & b'0000010')::int = 0 THEN 'after' ELSE NULL END,
        CASE WHEN (tgtype::int::bit(7) & b'1000000')::int = 0 THEN NULL ELSE 'instead_of' END,
        ''
      ) as tg_timing,
      (CASE WHEN (tgtype::int::bit(7) & b'0000100')::int = 0 THEN '' ELSE ' insert' END)
      || (CASE WHEN (tgtype::int::bit(7) & b'0001000')::int = 0 THEN '' ELSE ' delete' END)
      || (CASE WHEN (tgtype::int::bit(7) & b'0010000')::int = 0 THEN '' ELSE ' update' END)
      -- || (CASE WHEN (tgtype::int::bit(7) & b'0100000')::int = 0 THEN '' ELSE ' truncate' END)
      AS tg_ops,
      CASE WHEN (tgtype::int::bit(7) & b'0000001')::int = 0 THEN 'statement' ELSE 'row' END as tg_foreach,
      pg_get_triggerdef(t.oid, true) AS tg_definition,
      tgdeferrable,
      tginitdeferred
    FROM pg_catalog.pg_trigger t
    JOIN pg_catalog.pg_class c ON c.oid = tgrelid
    JOIN pg_catalog.pg_proc f ON f.oid = t.tgfoid
    JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
    LEFT JOIN pg_catalog.pg_depend d ON d.objid = t.oid AND d.deptype = 'e'
    LEFT JOIN pg_catalog.pg_extension e ON e.oid = d.refobjid
    WHERE n.nspname = ANY (current_schemas(false))
      AND tgisinternal = FALSE
      AND e.extname IS NULL
    ORDER BY c.relname, tgname;
  SQL

  res.rows.each_with_object({}) do |(name, table, function, timing, ops, for_each, definition, deferrable, initially_deferred), memo|
    attributes = {table: table, function: function, for_each: for_each.to_sym}
    condition = extract_trigger_condition(definition)
    attributes[:when] = condition if condition.present?
    attributes[timing.to_sym] = ops.strip.split(/\s+/).map(&:to_sym)
    attributes[:deferrable] = initially_deferred ? :initially_deferred : true if deferrable
    memo[name] = attributes
  end
end