Module: PGSpecHelper::Columns

Included in:
PGSpecHelper
Defined in:
lib/pg_spec_helper/columns.rb

Defined Under Namespace

Classes: ColumnDoesNotExistError

Instance Method Summary collapse

Instance Method Details

#create_column(schema_name, table_name, column_name, type, null = true, default = nil) ⇒ Object

create a column for the provided table



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/pg_spec_helper/columns.rb', line 9

def create_column schema_name, table_name, column_name, type, null = true, default = nil
  # required extension for citext
  if type.to_sym == :citext
    connection.exec("      -- temporarily set the client_min_messages to WARNING to\n      -- suppress the NOTICE messages about extension already existing\n      SET client_min_messages TO WARNING;\n      CREATE EXTENSION IF NOT EXISTS \"citext\";\n      SET client_min_messages TO NOTICE;\n    SQL\n  end\n\n  # note the `type` is safe from sql_injection due to the validation above\n  connection.exec(<<~SQL)\n    ALTER TABLE \#{connection.quote_ident schema_name.to_s}.\#{connection.quote_ident table_name.to_s}\n      ADD COLUMN \#{connection.quote_ident column_name.to_s} \#{type}\n        \#{null ? \"\" : \"NOT NULL\"}\n        \#{default ? \"DEFAULT \#{default}\" : \"\"}\n  SQL\nend\n")

#get_column_names(schema_name, table_name) ⇒ Object

return an array of column names for the provided table



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/pg_spec_helper/columns.rb', line 31

def get_column_names schema_name, table_name
  rows = connection.exec_params("    SELECT column_name\n    FROM information_schema.columns\n    WHERE table_schema = $1\n      AND table_name = $2\n    ORDER BY ordinal_position;\n  SQL\n  rows.map { |row| row[\"column_name\"].to_sym }\nend\n", [schema_name.to_s, table_name.to_s])

#is_column_nullable(schema_name, table_name, column_name) ⇒ Object

return an array of column names for the provided table

Raises:



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/pg_spec_helper/columns.rb', line 43

def is_column_nullable schema_name, table_name, column_name
  rows = connection.exec_params("    SELECT is_nullable\n    FROM information_schema.columns\n    WHERE table_schema = $1\n      AND table_name = $2\n      AND column_name = $3;\n  SQL\n  raise ColumnDoesNotExistError if rows.first.nil?\n  rows.first[\"is_nullable\"] == \"YES\"\nend\n", [schema_name.to_s, table_name.to_s, column_name.to_s])