Class: PG::Doc::Engine

Inherits:

Sinatra::Base

• Object
• Sinatra::Base
• PG::Doc::Engine

Defined in:

lib/pg/doc/engine.rb

Instance Method Summary

• #parse_function_argument(arg) ⇒ Object
• #setup(connection, opts) ⇒ Object

  Initializes the internal state for this instance.

Instance Method Details

#parse_function_argument(arg) ⇒ Object

# File 'lib/pg/doc/engine.rb', line 259

def parse_function_argument arg

  # Determine the argument's mode
  arg = arg.strip
  argmode = case arg
  when /^VARIADIC\b/, /^OUT\b/, /^INOUT\b/, /^IN\b/
    _parts = arg.split(" ")
    _mode = _parts.shift
    arg = _parts.join(" ")
    _mode
  else
    "IN"
  end

  # Determine it's name and type
  if arg.count(" ") > 0
    name, *type = arg.split " "
    type = type.join " "
  else
    name = nil
    type = arg
  end

  {"name" => name, "type" => type, "mode" => argmode}

end

#setup(connection, opts) ⇒ Object

Initializes the internal state for this instance

# File 'lib/pg/doc/engine.rb', line 42

def setup connection, opts

  @conn = PG.connect connection
  @path_to_markdowns = opts.fetch(:path_to_markdowns, nil)
  @schema_filter = opts.fetch(:schema_filter, nil) || ->(field) {
    "      \#{field} NOT ILIKE 'pg_%'\n      AND \#{field} != 'information_schema'\n    SQL\n  }\n\n  @cache = {schemas: {}}\n\n  # Load schemas\n  _recordset = @conn.exec <<~SQL\n    SELECT\n      schema_name\n    FROM\n      information_schema.schemata\n    WHERE\n      \#{@schema_filter.call :schema_name}\n    ORDER BY\n      1\n  SQL\n  _recordset.each_with_object(@cache){ |row, h|\n    h[:schemas][row[\"schema_name\"]] = {\n      tables: {},\n      views: {},\n      functions: {},\n      triggers: {}\n    }\n  }\n\n  # Load tables\n  _recordset = @conn.exec <<~SQL\n    SELECT\n      table_schema,\n      table_name,\n      obj_description((table_schema || '.' || table_name)::regclass::oid, 'pg_class') as comment\n    FROM\n      information_schema.tables\n    WHERE\n      \#{@schema_filter.call :table_schema}\n      AND table_type = 'BASE TABLE'\n    ORDER BY\n      1, 2\n  SQL\n  _recordset.each_with_object(@cache){ |row, h|\n    h[:schemas][row[\"table_schema\"]][:tables][row[\"table_name\"]] = {\n      columns: [],\n      foreign_keys: {},\n      indexes: {},\n      comment: row[\"comment\"]\n    }\n  }\n\n  # Load views\n  _recordset = @conn.exec <<~SQL\n    SELECT\n      table_schema,\n      table_name,\n      view_definition,\n      obj_description((table_schema || '.' || table_name)::regclass::oid, 'pg_class') as comment\n    FROM\n      information_schema.views\n    WHERE\n      \#{@schema_filter.call :table_schema}\n    ORDER BY\n      1, 2\n  SQL\n  _recordset.each_with_object(@cache){ |row, h|\n    h[:schemas][row[\"table_schema\"]][:views][row[\"table_name\"]] = {\n      view_definition: row[\"view_definition\"],\n      columns: [],\n      comment: row[\"comment\"]\n    }\n  }\n\n  # Load columns\n  _recordset = @conn.exec <<~SQL\n    SELECT\n      c.table_schema,\n      c.table_name,\n      c.column_name,\n      c.ordinal_position,\n      c.data_type,\n      c.is_nullable,\n      c.column_default,\n      col_description((c.table_schema || '.' || c.table_name)::regclass::oid, c.ordinal_position) as comment,\n      t.table_type\n    FROM\n      information_schema.columns c\n      JOIN information_schema.tables t USING (table_catalog, table_schema, table_name)\n    WHERE\n      \#{@schema_filter.call :table_schema}\n      AND table_type = 'BASE TABLE'\n    ORDER BY\n      1, 2, 4\n  SQL\n  _recordset.each_with_object(@cache){ |row, h|\n    type = row.delete(\"table_type\") == \"VIEW\" ? :views : :tables\n    schema = row.delete \"table_schema\"\n    name = row.delete \"table_name\"\n    h[:schemas][schema][type][name][:columns] << row\n  }\n\n  # Load functions (note: this currently does not support overloaded functions)\n  _recordset = @conn.exec <<~SQL\n    SELECT\n      routine_schema,\n      routine_name,\n      routine_definition,\n      external_language,\n      pg_get_function_identity_arguments((routine_schema || '.' || routine_name)::regproc) as arguments,\n      pg_get_functiondef((routine_schema || '.' || routine_name)::regproc) as function_definition,\n      pg_get_function_result((routine_schema || '.' || routine_name)::regproc) as function_result,\n      obj_description((routine_schema || '.' || routine_name)::regproc::oid, 'pg_proc') as comment\n    FROM\n      information_schema.routines\n    WHERE\n      \#{@schema_filter.call :routine_schema}\n      AND external_name IS NULL\n    ORDER BY\n      1, 2\n  SQL\n  _recordset.each_with_object(@cache){ |row, h|\n    dest = row[\"function_result\"] == \"trigger\" ? :triggers : :functions\n    h[:schemas][row[\"routine_schema\"]][dest][row[\"routine_name\"]] = {\n      external_language: row[\"external_language\"],\n      comment: row[\"comment\"],\n      arguments: row[\"arguments\"].split(\",\").map{ |arg| parse_function_argument arg },\n      function_definition: row[\"function_definition\"],\n      function_result: row[\"function_result\"]\n    }\n  }\n\n  # Load foreign keys\n  _recordset = @conn.exec <<~SQL\n    SELECT\n      tc.table_schema,\n      tc.table_name,\n      tc.constraint_name,\n      tc.constraint_type,\n      kcu.column_name,\n      tc.is_deferrable,\n      tc.initially_deferred,\n      rc.match_option AS match_type,\n\n      rc.update_rule AS on_update,\n      rc.delete_rule AS on_delete,\n      ccu.table_schema AS references_schema,\n      ccu.table_name AS references_table,\n      ccu.column_name AS references_field\n\n    FROM\n      information_schema.table_constraints tc\n\n    LEFT JOIN information_schema.key_column_usage kcu\n      ON tc.constraint_catalog = kcu.constraint_catalog\n      AND tc.constraint_schema = kcu.constraint_schema\n      AND tc.constraint_name = kcu.constraint_name\n\n    LEFT JOIN information_schema.referential_constraints rc\n      ON tc.constraint_catalog = rc.constraint_catalog\n      AND tc.constraint_schema = rc.constraint_schema\n      AND tc.constraint_name = rc.constraint_name\n\n    LEFT JOIN information_schema.constraint_column_usage ccu\n      ON rc.unique_constraint_catalog = ccu.constraint_catalog\n      AND rc.unique_constraint_schema = ccu.constraint_schema\n      AND rc.unique_constraint_name = ccu.constraint_name\n\n    WHERE\n      tc.constraint_type = 'FOREIGN KEY'\n    ORDER BY\n      1, 2\n  SQL\n  _recordset.each_with_object(@cache){ |row, h|\n    h[:schemas][row[\"table_schema\"]][:tables][row[\"table_name\"]][:foreign_keys][row[\"column_name\"]] = row\n  }\n\n  # Load indexes\n  _recordset = @conn.exec <<~SQL\n    SELECT\n      ns.nspname AS table_schema,\n      t.relname AS table_name,\n      U.usename AS user_name,\n      i.relname AS index_name,\n      idx.indisunique AS is_unique,\n      idx.indisprimary AS is_primary,\n      am.amname AS index_type,\n      idx.indkey,\n      ARRAY(\n        SELECT pg_get_indexdef(idx.indexrelid, k + 1, TRUE)\n        FROM generate_subscripts(idx.indkey, 1) AS k\n        ORDER BY k\n      ) AS index_keys,\n      (idx.indexprs IS NOT NULL) OR (idx.indkey::int[] @> array[0]) AS is_functional,\n      idx.indpred IS NOT NULL AS is_partial\n    FROM\n      pg_index AS idx\n      JOIN pg_class AS i ON i.oid = idx.indexrelid\n      JOIN pg_class AS t ON t.oid = idx.indrelid\n      JOIN pg_am AS am ON i.relam = am.oid\n      JOIN pg_namespace AS ns ON i.relnamespace = ns.oid\n      JOIN pg_user AS U ON i.relowner = U.usesysid\n    WHERE\n      \#{@schema_filter.call :\"ns.nspname\"}\n    ORDER BY\n      1, 2, idx.indisprimary DESC, i.relname\n  SQL\n  _recordset.each_with_object(@cache){ |row, h|\n    h[:schemas][row[\"table_schema\"]][:tables][row[\"table_name\"]][:indexes][row[\"index_name\"]] = row\n  }\n\nend\n"