module ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaStatements
def add_column(table_name, column_name, type, **options) # :nodoc:
def add_column(table_name, column_name, type, **options) # :nodoc: clear_cache! super change_column_comment(table_name, column_name, options[:comment]) if options.key?(:comment) end
def add_column_for_alter(table_name, column_name, type, **options)
def add_column_for_alter(table_name, column_name, type, **options) return super unless options.key?(:comment) [super, Proc.new { change_column_comment(table_name, column_name, options[:comment]) }] end
def add_index(table_name, column_name, **options) # :nodoc:
def add_index(table_name, column_name, **options) # :nodoc: index, algorithm, if_not_exists = add_index_options(table_name, column_name, **options) create_index = CreateIndexDefinition.new(index, algorithm, if_not_exists) result = execute schema_creation.accept(create_index) execute "COMMENT ON INDEX #{quote_column_name(index.name)} IS #{quote(index.comment)}" if index.comment result end
def add_index_opclass(quoted_columns, **options)
def add_index_opclass(quoted_columns, **options) opclasses = options_for_index_columns(options[:opclass]) quoted_columns.each do |name, column| column << " #{opclasses[name]}" if opclasses[name].present? end end
def add_options_for_index_columns(quoted_columns, **options)
def add_options_for_index_columns(quoted_columns, **options) quoted_columns = add_index_opclass(quoted_columns, **options) super end
def change_column(table_name, column_name, type, **options) # :nodoc:
def change_column(table_name, column_name, type, **options) # :nodoc: clear_cache! sqls, procs = Array(change_column_for_alter(table_name, column_name, type, **options)).partition { |v| v.is_a?(String) } execute "ALTER TABLE #{quote_table_name(table_name)} #{sqls.join(", ")}" procs.each(&:call) end
def change_column_comment(table_name, column_name, comment_or_changes) # :nodoc:
Adds comment for given table column or drops it if +comment+ is a +nil+
def change_column_comment(table_name, column_name, comment_or_changes) # :nodoc: clear_cache! comment = extract_new_comment_value(comment_or_changes) execute "COMMENT ON COLUMN #{quote_table_name(table_name)}.#{quote_column_name(column_name)} IS #{quote(comment)}" end
def change_column_default(table_name, column_name, default_or_changes) # :nodoc:
Changes the default value of a table column.
def change_column_default(table_name, column_name, default_or_changes) # :nodoc: execute "ALTER TABLE #{quote_table_name(table_name)} #{change_column_default_for_alter(table_name, column_name, default_or_changes)}" end
def change_column_default_for_alter(table_name, column_name, default_or_changes)
def change_column_default_for_alter(table_name, column_name, default_or_changes) column = column_for(table_name, column_name) return unless column default = extract_new_default_value(default_or_changes) alter_column_query = "ALTER COLUMN #{quote_column_name(column_name)} %s" if default.nil? # <tt>DEFAULT NULL</tt> results in the same behavior as <tt>DROP DEFAULT</tt>. However, PostgreSQL will # cast the default to the columns type, which leaves us with a default like "default NULL::character varying". alter_column_query % "DROP DEFAULT" else alter_column_query % "SET DEFAULT #{quote_default_expression(default, column)}" end end
def change_column_for_alter(table_name, column_name, type, **options)
def change_column_for_alter(table_name, column_name, type, **options) td = create_table_definition(table_name) cd = td.new_column_definition(column_name, type, **options) sqls = [schema_creation.accept(ChangeColumnDefinition.new(cd, column_name))] sqls << Proc.new { change_column_comment(table_name, column_name, options[:comment]) } if options.key?(:comment) sqls end
def change_column_null(table_name, column_name, null, default = nil) # :nodoc:
def change_column_null(table_name, column_name, null, default = nil) # :nodoc: clear_cache! unless null || default.nil? column = column_for(table_name, column_name) execute "UPDATE #{quote_table_name(table_name)} SET #{quote_column_name(column_name)}=#{quote_default_expression(default, column)} WHERE #{quote_column_name(column_name)} IS NULL" if column end execute "ALTER TABLE #{quote_table_name(table_name)} #{change_column_null_for_alter(table_name, column_name, null, default)}" end
def change_column_null_for_alter(table_name, column_name, null, default = nil)
def change_column_null_for_alter(table_name, column_name, null, default = nil) "ALTER COLUMN #{quote_column_name(column_name)} #{null ? 'DROP' : 'SET'} NOT NULL" end
def change_table_comment(table_name, comment_or_changes) # :nodoc:
Adds comment for given table or drops it if +comment+ is a +nil+
def change_table_comment(table_name, comment_or_changes) # :nodoc: clear_cache! comment = extract_new_comment_value(comment_or_changes) execute "COMMENT ON TABLE #{quote_table_name(table_name)} IS #{quote(comment)}" end
def check_constraints(table_name) # :nodoc:
def check_constraints(table_name) # :nodoc: scope = quoted_scope(table_name) check_info = exec_query(<<-SQL, "SCHEMA") SELECT conname, pg_get_constraintdef(c.oid, true) AS constraintdef, c.convalidated AS valid FROM pg_constraint c JOIN pg_class t ON c.conrelid = t.oid JOIN pg_namespace n ON n.oid = c.connamespace WHERE c.contype = 'c' AND t.relname = #{scope[:name]} AND n.nspname = #{scope[:schema]} SQL check_info.map do |row| options = { name: row["conname"], validate: row["valid"] } expression = row["constraintdef"][/CHECK \((.+)\)/m, 1] CheckConstraintDefinition.new(table_name, expression, options) end end
def client_min_messages
def client_min_messages query_value("SHOW client_min_messages", "SCHEMA") end
def client_min_messages=(level)
def client_min_messages=(level) execute("SET client_min_messages TO '#{level}'", "SCHEMA") end
def collation
def collation query_value("SELECT datcollate FROM pg_database WHERE datname = current_database()", "SCHEMA") end
def columns_for_distinct(columns, orders) # :nodoc:
requires that the ORDER BY include the distinct column.
PostgreSQL requires the ORDER BY columns in the select list for distinct queries, and
def columns_for_distinct(columns, orders) # :nodoc: order_columns = orders.compact_blank.map { |s| # Convert Arel node to string s = visitor.compile(s) unless s.is_a?(String) # Remove any ASC/DESC modifiers s.gsub(/\s+(?:ASC|DESC)\b/i, "") .gsub(/\s+NULLS\s+(?:FIRST|LAST)\b/i, "") }.compact_blank.map.with_index { |column, i| "#{column} AS alias_#{i}" } (order_columns << super).join(", ") end
def create_alter_table(name)
def create_alter_table(name) PostgreSQL::AlterTable.new create_table_definition(name) end
def create_database(name, options = {})
create_database config[:database], config
Example:
:charset while PostgreSQL uses :encoding).
:tablespace, and :connection_limit (note that MySQL uses
:encoding (defaults to utf8), :collation, :ctype,
Create a new PostgreSQL database. Options include :owner, :template,
def create_database(name, options = {}) options = { encoding: "utf8" }.merge!(options.symbolize_keys) option_string = options.each_with_object(+"") do |(key, value), memo| memo << case key when :owner " OWNER = \"#{value}\"" when :template " TEMPLATE = \"#{value}\"" when :encoding " ENCODING = '#{value}'" when :collation " LC_COLLATE = '#{value}'" when :ctype " LC_CTYPE = '#{value}'" when :tablespace " TABLESPACE = \"#{value}\"" when :connection_limit " CONNECTION LIMIT = #{value}" else "" end end execute "CREATE DATABASE #{quote_table_name(name)}#{option_string}" end
def create_schema(schema_name)
def create_schema(schema_name) execute "CREATE SCHEMA #{quote_schema_name(schema_name)}" end
def create_schema_dumper(options) # :nodoc:
def create_schema_dumper(options) # :nodoc: PostgreSQL::SchemaDumper.create(self, options) end
def create_table_definition(name, **options)
def create_table_definition(name, **options) PostgreSQL::TableDefinition.new(self, name, **options) end
def ctype
def ctype query_value("SELECT datctype FROM pg_database WHERE datname = current_database()", "SCHEMA") end
def current_database
def current_database query_value("SELECT current_database()", "SCHEMA") end
def current_schema
def current_schema query_value("SELECT current_schema", "SCHEMA") end
def data_source_sql(name = nil, type: nil)
def data_source_sql(name = nil, type: nil) scope = quoted_scope(name, type: type) scope[:type] ||= "'r','v','m','p','f'" # (r)elation/table, (v)iew, (m)aterialized view, (p)artitioned table, (f)oreign table sql = +"SELECT c.relname FROM pg_class c LEFT JOIN pg_namespace n ON n.oid = c.relnamespace" sql << " WHERE n.nspname = #{scope[:schema]}" sql << " AND c.relname = #{scope[:name]}" if scope[:name] sql << " AND c.relkind IN (#{scope[:type]})" sql end
def default_sequence_name(table_name, pk = "id") # :nodoc:
Returns the sequence name for a table's primary key or some other specified key.
def default_sequence_name(table_name, pk = "id") # :nodoc: result = serial_sequence(table_name, pk) return nil unless result Utils.extract_schema_qualified_name(result).to_s rescue ActiveRecord::StatementInvalid PostgreSQL::Name.new(nil, "#{table_name}_#{pk}_seq").to_s end
def drop_database(name) # :nodoc:
drop_database 'matt_development'
Example:
Drops a PostgreSQL database.
def drop_database(name) # :nodoc: execute "DROP DATABASE IF EXISTS #{quote_table_name(name)}" end
def drop_schema(schema_name, **options)
def drop_schema(schema_name, **options) execute "DROP SCHEMA#{' IF EXISTS' if options[:if_exists]} #{quote_schema_name(schema_name)} CASCADE" end
def drop_table(table_name, **options) # :nodoc:
def drop_table(table_name, **options) # :nodoc: schema_cache.clear_data_source_cache!(table_name.to_s) execute "DROP TABLE#{' IF EXISTS' if options[:if_exists]} #{quote_table_name(table_name)}#{' CASCADE' if options[:force] == :cascade}" end
def encoding
def encoding query_value("SELECT pg_encoding_to_char(encoding) FROM pg_database WHERE datname = current_database()", "SCHEMA") end
def extract_foreign_key_action(specifier)
def extract_foreign_key_action(specifier) case specifier when "c"; :cascade when "n"; :nullify when "r"; :restrict end end
def extract_foreign_key_deferrable(deferrable, deferred)
def extract_foreign_key_deferrable(deferrable, deferred) deferrable && (deferred ? :deferred : true) end
def extract_schema_qualified_name(string)
def extract_schema_qualified_name(string) name = Utils.extract_schema_qualified_name(string.to_s) [name.schema, name.identifier] end
def fetch_type_metadata(column_name, sql_type, oid, fmod)
def fetch_type_metadata(column_name, sql_type, oid, fmod) cast_type = get_oid_type(oid, fmod, column_name, sql_type) simple_type = SqlTypeMetadata.new( sql_type: sql_type, type: cast_type.type, limit: cast_type.limit, precision: cast_type.precision, scale: cast_type.scale, ) PostgreSQL::TypeMetadata.new(simple_type, oid: oid, fmod: fmod) end
def foreign_keys(table_name)
def foreign_keys(table_name) scope = quoted_scope(table_name) fk_info = exec_query(<<~SQL, "SCHEMA") SELECT t2.oid::regclass::text AS to_table, a1.attname AS column, a2.attname AS primary_key, c.conname AS name, c.confupdtype AS on_update, c.confdeltype AS on_delete, c.convalidated AS valid, c.condeferrable AS deferrable, c.condeferred AS deferred FROM pg_constraint c JOIN pg_class t1 ON c.conrelid = t1.oid JOIN pg_class t2 ON c.confrelid = t2.oid JOIN pg_attribute a1 ON a1.attnum = c.conkey[1] AND a1.attrelid = t1.oid JOIN pg_attribute a2 ON a2.attnum = c.confkey[1] AND a2.attrelid = t2.oid JOIN pg_namespace t3 ON c.connamespace = t3.oid WHERE c.contype = 'f' AND t1.relname = #{scope[:name]} AND t3.nspname = #{scope[:schema]} ORDER BY c.conname SQL fk_info.map do |row| options = { column: Utils.unquote_identifier(row["column"]), name: row["name"], primary_key: row["primary_key"] } options[:on_delete] = extract_foreign_key_action(row["on_delete"]) options[:on_update] = extract_foreign_key_action(row["on_update"]) options[:deferrable] = extract_foreign_key_deferrable(row["deferrable"], row["deferred"]) options[:validate] = row["valid"] to_table = Utils.unquote_identifier(row["to_table"]) ForeignKeyDefinition.new(table_name, to_table, options) end end
def foreign_table_exists?(table_name)
def foreign_table_exists?(table_name) query_values(data_source_sql(table_name, type: "FOREIGN TABLE"), "SCHEMA").any? if table_name.present? end
def foreign_tables
def foreign_tables query_values(data_source_sql(type: "FOREIGN TABLE"), "SCHEMA") end
def index_name_exists?(table_name, index_name)
def index_name_exists?(table_name, index_name) table = quoted_scope(table_name) index = quoted_scope(index_name) query_value(<<~SQL, "SCHEMA").to_i > 0 SELECT COUNT(*) FROM pg_class t INNER JOIN pg_index d ON t.oid = d.indrelid INNER JOIN pg_class i ON d.indexrelid = i.oid LEFT JOIN pg_namespace n ON n.oid = i.relnamespace WHERE i.relkind IN ('i', 'I') AND i.relname = #{index[:name]} AND t.relname = #{table[:name]} AND n.nspname = #{index[:schema]} SQL end
def indexes(table_name) # :nodoc:
Returns an array of indexes for the given table.
def indexes(table_name) # :nodoc: scope = quoted_scope(table_name) result = query(<<~SQL, "SCHEMA") SELECT distinct i.relname, d.indisunique, d.indkey, pg_get_indexdef(d.indexrelid), t.oid, pg_catalog.obj_description(i.oid, 'pg_class') AS comment FROM pg_class t INNER JOIN pg_index d ON t.oid = d.indrelid INNER JOIN pg_class i ON d.indexrelid = i.oid LEFT JOIN pg_namespace n ON n.oid = i.relnamespace WHERE i.relkind IN ('i', 'I') AND d.indisprimary = 'f' AND t.relname = #{scope[:name]} AND n.nspname = #{scope[:schema]} ORDER BY i.relname SQL result.map do |row| index_name = row[0] unique = row[1] indkey = row[2].split(" ").map(&:to_i) inddef = row[3] oid = row[4] comment = row[5] using, expressions, where = inddef.scan(/ USING (\w+?) \((.+?)\)(?: WHERE (.+))?\z/m).flatten orders = {} opclasses = {} if indkey.include?(0) columns = expressions else columns = Hash[query(<<~SQL, "SCHEMA")].values_at(*indkey).compact SELECT a.attnum, a.attname FROM pg_attribute a WHERE a.attrelid = #{oid} AND a.attnum IN (#{indkey.join(",")}) SQL # add info on sort order (only desc order is explicitly specified, asc is the default) # and non-default opclasses expressions.scan(/(?<column>\w+)"?\s?(?<opclass>\w+_ops)?\s?(?<desc>DESC)?\s?(?<nulls>NULLS (?:FIRST|LAST))?/).each do |column, opclass, desc, nulls| opclasses[column] = opclass.to_sym if opclass if nulls orders[column] = [desc, nulls].compact.join(" ") else orders[column] = :desc if desc end end end IndexDefinition.new( table_name, index_name, unique, columns, orders: orders, opclasses: opclasses, where: where, using: using.to_sym, comment: comment.presence ) end end
def new_column_from_field(table_name, field)
def new_column_from_field(table_name, field) column_name, type, default, notnull, oid, fmod, collation, comment, attgenerated = field type_metadata = fetch_type_metadata(column_name, type, oid.to_i, fmod.to_i) default_value = extract_value_from_default(default) if attgenerated.present? default_function = default else default_function = extract_default_function(default_value, default) end if match = default_function&.match(/\Anextval\('"?(?<sequence_name>.+_(?<suffix>seq\d*))"?'::regclass\)\z/) serial = sequence_name_from_parts(table_name, column_name, match[:suffix]) == match[:sequence_name] end PostgreSQL::Column.new( column_name, default_value, type_metadata, !notnull, default_function, collation: collation, comment: comment.presence, serial: serial, generated: attgenerated ) end
def pk_and_sequence_for(table) # :nodoc:
Returns a table's primary key and belonging sequence.
def pk_and_sequence_for(table) # :nodoc: # First try looking for a sequence with a dependency on the # given table's primary key. result = query(<<~SQL, "SCHEMA")[0] SELECT attr.attname, nsp.nspname, seq.relname FROM pg_class seq, pg_attribute attr, pg_depend dep, pg_constraint cons, pg_namespace nsp WHERE seq.oid = dep.objid 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 seq.relnamespace = nsp.oid AND cons.contype = 'p' AND dep.classid = 'pg_class'::regclass AND dep.refobjid = #{quote(quote_table_name(table))}::regclass SQL if result.nil? || result.empty? result = query(<<~SQL, "SCHEMA")[0] SELECT attr.attname, nsp.nspname, CASE WHEN pg_get_expr(def.adbin, def.adrelid) !~* 'nextval' THEN NULL WHEN split_part(pg_get_expr(def.adbin, def.adrelid), '''', 2) ~ '.' THEN substr(split_part(pg_get_expr(def.adbin, def.adrelid), '''', 2), strpos(split_part(pg_get_expr(def.adbin, def.adrelid), '''', 2), '.')+1) ELSE split_part(pg_get_expr(def.adbin, def.adrelid), '''', 2) END FROM pg_class t 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]) JOIN pg_namespace nsp ON (t.relnamespace = nsp.oid) WHERE t.oid = #{quote(quote_table_name(table))}::regclass AND cons.contype = 'p' AND pg_get_expr(def.adbin, def.adrelid) ~* 'nextval|uuid_generate' SQL end pk = result.shift if result.last [pk, PostgreSQL::Name.new(*result)] else [pk, nil] end rescue nil end
def primary_keys(table_name) # :nodoc:
def primary_keys(table_name) # :nodoc: query_values(<<~SQL, "SCHEMA") SELECT a.attname FROM ( SELECT indrelid, indkey, generate_subscripts(indkey, 1) idx FROM pg_index WHERE indrelid = #{quote(quote_table_name(table_name))}::regclass AND indisprimary ) i JOIN pg_attribute a ON a.attrelid = i.indrelid AND a.attnum = i.indkey[i.idx] ORDER BY i.idx SQL end
def quoted_scope(name = nil, type: nil)
def quoted_scope(name = nil, type: nil) schema, name = extract_schema_qualified_name(name) type = \ case type when "BASE TABLE" "'r','p'" when "VIEW" "'v','m'" when "FOREIGN TABLE" "'f'" end scope = {} scope[:schema] = schema ? quote(schema) : "ANY (current_schemas(false))" scope[:name] = quote(name) if name scope[:type] = type if type scope end
def recreate_database(name, options = {}) # :nodoc:
and creates it again using the provided +options+.
Drops the database specified on the +name+ attribute
def recreate_database(name, options = {}) # :nodoc: drop_database(name) create_database(name, options) end
def remove_index(table_name, column_name = nil, **options) # :nodoc:
def remove_index(table_name, column_name = nil, **options) # :nodoc: table = Utils.extract_schema_qualified_name(table_name.to_s) if options.key?(:name) provided_index = Utils.extract_schema_qualified_name(options[:name].to_s) options[:name] = provided_index.identifier table = PostgreSQL::Name.new(provided_index.schema, table.identifier) unless table.schema.present? if provided_index.schema.present? && table.schema != provided_index.schema raise ArgumentError.new("Index schema '#{provided_index.schema}' does not match table schema '#{table.schema}'") end end return if options[:if_exists] && !index_exists?(table_name, column_name, **options) index_to_remove = PostgreSQL::Name.new(table.schema, index_name_for_remove(table.to_s, column_name, options)) execute "DROP INDEX #{index_algorithm(options[:algorithm])} #{quote_table_name(index_to_remove)}" end
def rename_column(table_name, column_name, new_column_name) # :nodoc:
Renames a column in a table.
def rename_column(table_name, column_name, new_column_name) # :nodoc: clear_cache! execute("ALTER TABLE #{quote_table_name(table_name)} #{rename_column_sql(table_name, column_name, new_column_name)}") rename_column_indexes(table_name, column_name, new_column_name) end
def rename_index(table_name, old_name, new_name)
Renames an index of a table. Raises error if length of new
def rename_index(table_name, old_name, new_name) validate_index_length!(table_name, new_name) execute "ALTER INDEX #{quote_column_name(old_name)} RENAME TO #{quote_table_name(new_name)}" end
def rename_table(table_name, new_name)
Example:
matches the Active Record default.
Also renames a table's primary key sequence if the sequence name exists and
Renames a table.
def rename_table(table_name, new_name) clear_cache! schema_cache.clear_data_source_cache!(table_name.to_s) schema_cache.clear_data_source_cache!(new_name.to_s) execute "ALTER TABLE #{quote_table_name(table_name)} RENAME TO #{quote_table_name(new_name)}" pk, seq = pk_and_sequence_for(new_name) if pk idx = "#{table_name}_pkey" new_idx = "#{new_name}_pkey" execute "ALTER INDEX #{quote_table_name(idx)} RENAME TO #{quote_table_name(new_idx)}" if seq && seq.identifier == "#{table_name}_#{pk}_seq" new_seq = "#{new_name}_#{pk}_seq" execute "ALTER TABLE #{seq.quoted} RENAME TO #{quote_table_name(new_seq)}" end end rename_table_indexes(table_name, new_name) end
def reset_pk_sequence!(table, pk = nil, sequence = nil) # :nodoc:
Resets the sequence of a table's primary key to the maximum value.
def reset_pk_sequence!(table, pk = nil, sequence = nil) # :nodoc: unless pk && sequence default_pk, default_sequence = pk_and_sequence_for(table) pk ||= default_pk sequence ||= default_sequence end if @logger && pk && !sequence @logger.warn "#{table} has primary key #{pk} with no default sequence." end if pk && sequence quoted_sequence = quote_table_name(sequence) max_pk = query_value("SELECT MAX(#{quote_column_name pk}) FROM #{quote_table_name(table)}", "SCHEMA") if max_pk.nil? if database_version >= 100000 minvalue = query_value("SELECT seqmin FROM pg_sequence WHERE seqrelid = #{quote(quoted_sequence)}::regclass", "SCHEMA") else minvalue = query_value("SELECT min_value FROM #{quoted_sequence}", "SCHEMA") end end query_value("SELECT setval(#{quote(quoted_sequence)}, #{max_pk ? max_pk : minvalue}, #{max_pk ? true : false})", "SCHEMA") end end
def schema_creation
def schema_creation PostgreSQL::SchemaCreation.new(self) end
def schema_exists?(name)
def schema_exists?(name) query_value("SELECT COUNT(*) FROM pg_namespace WHERE nspname = #{quote(name)}", "SCHEMA").to_i > 0 end
def schema_names
def schema_names query_values(<<~SQL, "SCHEMA") SELECT nspname FROM pg_namespace WHERE nspname !~ '^pg_.*' AND nspname NOT IN ('information_schema') ORDER by nspname; SQL end
def schema_search_path
def schema_search_path @schema_search_path ||= query_value("SHOW search_path", "SCHEMA") end
def schema_search_path=(schema_csv)
See: https://www.postgresql.org/docs/current/static/ddl-schemas.html
Names beginning with $ have to be quoted (e.g. $user => '$user').
Sets the schema search path to a string of comma-separated schema names.
def schema_search_path=(schema_csv) if schema_csv execute("SET search_path TO #{schema_csv}", "SCHEMA") @schema_search_path = schema_csv end end
def sequence_name_from_parts(table_name, column_name, suffix)
def sequence_name_from_parts(table_name, column_name, suffix) over_length = [table_name, column_name, suffix].sum(&:length) + 2 - max_identifier_length if over_length > 0 column_name_length = [(max_identifier_length - suffix.length - 2) / 2, column_name.length].min over_length -= column_name.length - column_name_length column_name = column_name[0, column_name_length - [over_length, 0].min] end if over_length > 0 table_name = table_name[0, table_name.length - over_length] end "#{table_name}_#{column_name}_#{suffix}" end
def serial_sequence(table, column)
def serial_sequence(table, column) query_value("SELECT pg_get_serial_sequence(#{quote(table)}, #{quote(column)})", "SCHEMA") end
def set_pk_sequence!(table, value) # :nodoc:
Sets the sequence of a table's primary key to the specified value.
def set_pk_sequence!(table, value) # :nodoc: pk, sequence = pk_and_sequence_for(table) if pk if sequence quoted_sequence = quote_table_name(sequence) query_value("SELECT setval(#{quote(quoted_sequence)}, #{value})", "SCHEMA") else @logger.warn "#{table} has primary key #{pk} with no default sequence." if @logger end end end
def table_comment(table_name) # :nodoc:
Returns a comment stored in database for given table
def table_comment(table_name) # :nodoc: scope = quoted_scope(table_name, type: "BASE TABLE") if scope[:name] query_value(<<~SQL, "SCHEMA") SELECT pg_catalog.obj_description(c.oid, 'pg_class') FROM pg_catalog.pg_class c LEFT JOIN pg_namespace n ON n.oid = c.relnamespace WHERE c.relname = #{scope[:name]} AND c.relkind IN (#{scope[:type]}) AND n.nspname = #{scope[:schema]} SQL end end
def table_options(table_name) # :nodoc:
def table_options(table_name) # :nodoc: if comment = table_comment(table_name) { comment: comment } end end
def type_to_sql(type, limit: nil, precision: nil, scale: nil, array: nil, enum_type: nil, **) # :nodoc:
Maps logical Rails types to PostgreSQL-specific data types.
def type_to_sql(type, limit: nil, precision: nil, scale: nil, array: nil, enum_type: nil, **) # :nodoc: sql = \ case type.to_s when "binary" # PostgreSQL doesn't support limits on binary (bytea) columns. # The hard limit is 1GB, because of a 32-bit size field, and TOAST. case limit when nil, 0..0x3fffffff; super(type) else raise ArgumentError, "No binary type has byte size #{limit}. The limit on binary can be at most 1GB - 1byte." end when "text" # PostgreSQL doesn't support limits on text columns. # The hard limit is 1GB, according to section 8.3 in the manual. case limit when nil, 0..0x3fffffff; super(type) else raise ArgumentError, "No text type has byte size #{limit}. The limit on text can be at most 1GB - 1byte." end when "integer" case limit when 1, 2; "smallint" when nil, 3, 4; "integer" when 5..8; "bigint" else raise ArgumentError, "No integer type has byte size #{limit}. Use a numeric with scale 0 instead." end when "enum" raise ArgumentError, "enum_type is required for enums" if enum_type.nil? enum_type else super end sql = "#{sql}[]" if array && type != :primary_key sql end
def update_table_definition(table_name, base) # :nodoc:
def update_table_definition(table_name, base) # :nodoc: PostgreSQL::Table.new(table_name, base) end
def validate_check_constraint(table_name, **options)
validate_check_constraint :products, name: "price_check"
Validates the given check constraint.
def validate_check_constraint(table_name, **options) chk_name_to_validate = check_constraint_for!(table_name, **options).name validate_constraint table_name, chk_name_to_validate end
def validate_constraint(table_name, constraint_name)
Validates the constraint named +constraint_name+ on +accounts+.
Validates the given constraint.
def validate_constraint(table_name, constraint_name) at = create_alter_table table_name at.validate_constraint constraint_name execute schema_creation.accept(at) end
def validate_foreign_key(from_table, to_table = nil, **options)
validate_foreign_key :accounts, name: :special_fk_name
Validates the foreign key named +special_fk_name+ on the +accounts+ table.
validate_foreign_key :accounts, column: :owner_id
Validates the foreign key on +accounts.owner_id+.
validate_foreign_key :accounts, :branches
Validates the foreign key on +accounts.branch_id+.
Validates the given foreign key.
def validate_foreign_key(from_table, to_table = nil, **options) fk_name_to_validate = foreign_key_for!(from_table, to_table: to_table, **options).name validate_constraint from_table, fk_name_to_validate end