Class: ActiveRecord::ConnectionAdapters::PostgreSQLAdapter

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 105

class_attribute :create_unlogged_tables, default: false

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 123

class_attribute :datetime_type, default: :timestamp

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 123

class_attribute :datetime_type, default: :timestamp

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 132

class_attribute :decode_dates, default: false

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 132

class_attribute :decode_dates, default: false

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 57

def new_client(conn_params)
  PG.connect(**conn_params)
rescue ::PG::Error => error
  if conn_params && conn_params[:dbname] == "postgres"
    raise ActiveRecord::ConnectionNotEstablished, error.message
  elsif conn_params && conn_params[:dbname] && error.message.include?(conn_params[:dbname])
    raise ActiveRecord::NoDatabaseError.db_error(conn_params[:dbname])
  elsif conn_params && conn_params[:user] && error.message.include?(conn_params[:user])
    raise ActiveRecord::DatabaseConnectionError.username_error(conn_params[:user])
  elsif conn_params && conn_params[:host] && error.message.include?(conn_params[:host])
    raise ActiveRecord::DatabaseConnectionError.hostname_error(conn_params[:host])
  else
    raise ActiveRecord::ConnectionNotEstablished, error.message
  end
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 343

def connected?
  !(@raw_connection.nil? || @raw_connection.finished?)
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 105

class_attribute :create_unlogged_tables, default: false

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 105

class_attribute :create_unlogged_tables, default: false

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 123

class_attribute :datetime_type, default: :timestamp

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 123

class_attribute :datetime_type, default: :timestamp

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 132

class_attribute :decode_dates, default: false

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 132

class_attribute :decode_dates, default: false

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 624

def session_auth=(user)
  clear_cache!
  internal_execute("SET SESSION AUTHORIZATION #{user}", nil, materialize_transactions: true)
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 419

def supports_advisory_locks?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 188

def supports_bulk_alter?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 220

def supports_check_constraints?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 252

def supports_comments?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 450

def supports_common_table_expressions?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 244

def supports_datetime_with_precision?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 415

def supports_ddl_transactions?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 236

def supports_deferrable_constraints?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 224

def supports_exclusion_constraints?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 423

def supports_explain?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 208

def supports_expression_index?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 427

def supports_extensions?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 216

def supports_foreign_keys?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 435

def supports_foreign_tables?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 204

def supports_index_include?
  database_version >= 11_00_00 # >= 11.0
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 192

def supports_index_sort_order?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 273

alias supports_insert_conflict_target? supports_insert_on_conflict?

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 268

def supports_insert_on_conflict?
  database_version >= 9_05_00 # >= 9.5
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 271

alias supports_insert_on_duplicate_skip? supports_insert_on_conflict?

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 272

alias supports_insert_on_duplicate_update? supports_insert_on_conflict?

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 264

def supports_insert_returning?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 248

def supports_json?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 454

def supports_lazy_transactions?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 431

def supports_materialized_views?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 283

def supports_nulls_not_distinct?
  database_version >= 15_00_00 # >= 15.0
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 443

def supports_optimizer_hints?
  unless defined?(@has_pg_hint_plan)
    @has_pg_hint_plan = extension_available?("pg_hint_plan")
  end
  @has_pg_hint_plan
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 200

def supports_partial_index?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 196

def supports_partitioned_indexes?
  database_version >= 11_00_00 # >= 11.0
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 439

def supports_pgcrypto_uuid?
  database_version >= 9_04_00 # >= 9.4
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 260

def supports_restart_db_transaction?
  database_version >= 12_00_00 # >= 12.0
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 256

def supports_savepoints?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 212

def supports_transaction_isolation?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 228

def supports_unique_constraints?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 232

def supports_validate_constraints?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 240

def supports_views?
  true
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 275

def supports_virtual_columns?
  database_version >= 12_00_00 # >= 12.0
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 629

def use_insert_returning?
  @use_insert_returning
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 540

def create_enum(name, values, **options)
  sql_values = values.map { |s| quote(s) }.join(", ")
  scope = quoted_scope(name)
  query = <<~SQL
    DO $$
    BEGIN
        IF NOT EXISTS (
          SELECT 1
          FROM pg_type t
          JOIN pg_namespace n ON t.typnamespace = n.oid
          WHERE t.typname = #{scope[:name]}
            AND n.nspname = #{scope[:schema]}
        ) THEN
            CREATE TYPE #{quote_table_name(name)} AS ENUM (#{sql_values});
        END IF;
    END
    $$;
  SQL
  internal_exec_query(query).tap { reload_type_map }
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 485

def disable_extension(name, force: false)
  _schema, name = name.to_s.split(".").values_at(-2, -1)
  internal_exec_query("DROP EXTENSION IF EXISTS \"#{name}\"#{' CASCADE' if force == :cascade}").tap {
    reload_type_map
  }
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 385

def disconnect!
  @lock.synchronize do
    super
    @raw_connection&.close rescue nil
    @raw_connection = nil
  end
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 570

def drop_enum(name, values = nil, **options)
  query = <<~SQL
    DROP TYPE#{' IF EXISTS' if options[:if_exists]} #{quote_table_name(name)};
  SQL
  internal_exec_query(query).tap { reload_type_map }
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 472

def enable_extension(name, **)
  schema, name = name.to_s.split(".").values_at(-2, -1)
  sql = +"CREATE EXTENSION IF NOT EXISTS \"#{name}\""
  sql << " SCHEMA #{schema}" if schema

  internal_exec_query(sql).tap { reload_type_map }
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 517

def enum_types
  query = <<~SQL
    SELECT
      type.typname AS name,
      type.OID AS oid,
      n.nspname AS schema,
      string_agg(enum.enumlabel, ',' ORDER BY enum.enumsortorder) AS value
    FROM pg_enum AS enum
    JOIN pg_type AS type ON (type.oid = enum.enumtypid)
    JOIN pg_namespace n ON type.typnamespace = n.oid
    WHERE n.nspname = ANY (current_schemas(false))
    GROUP BY type.OID, n.nspname, type.typname;
  SQL

  internal_exec_query(query, "SCHEMA", allow_retry: true, materialize_transactions: false).cast_values.each_with_object({}) do |row, memo|
    name, schema = row[0], row[2]
    schema = nil if schema == current_schema
    full_name = [schema, name].compact.join(".")
    memo[full_name] = row.last
  end.to_a
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 492

def extension_available?(name)
  query_value("SELECT true FROM pg_available_extensions WHERE name = #{quote(name)}", "SCHEMA")
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 496

def extension_enabled?(name)
  query_value("SELECT installed_version IS NOT NULL FROM pg_available_extensions WHERE name = #{quote(name)}", "SCHEMA")
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 500

def extensions
  query = <<~SQL
    SELECT
      pg_extension.extname,
      n.nspname AS schema
    FROM pg_extension
    JOIN pg_namespace n ON pg_extension.extnamespace = n.oid
  SQL

  internal_exec_query(query, "SCHEMA", allow_retry: true, materialize_transactions: false).cast_values.map do |row|
    name, schema = row[0], row[1]
    schema = nil if schema == current_schema
    [schema, name].compact.join(".")
  end
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 291

def index_algorithms
  { concurrently: "CONCURRENTLY" }
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 619

def max_identifier_length
  @max_identifier_length ||= query_value("SHOW max_identifier_length", "SCHEMA").to_i
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 639

alias :postgresql_version :database_version

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 578

def rename_enum(name, new_name = nil, **options)
  new_name ||= options.fetch(:to) do
    raise ArgumentError, "rename_enum requires two from/to name positional arguments."
  end

  exec_query("ALTER TYPE #{quote_table_name(name)} RENAME TO #{quote_table_name(new_name)}").tap { reload_type_map }
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 605

def rename_enum_value(type_name, **options)
  unless database_version >= 10_00_00 # >= 10.0
    raise ArgumentError, "Renaming enum values is only supported in PostgreSQL 10 or later"
  end

  from = options.fetch(:from) { raise ArgumentError, ":from is required" }
  to = options.fetch(:to) { raise ArgumentError, ":to is required" }

  execute("ALTER TYPE #{quote_table_name(type_name)} RENAME VALUE #{quote(from)} TO #{quote(to)}").tap {
    reload_type_map
  }
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 370

def reset!
  @lock.synchronize do
    return connect! unless @raw_connection

    unless @raw_connection.transaction_status == ::PG::PQTRANS_IDLE
      @raw_connection.query "ROLLBACK"
    end
    @raw_connection.query "DISCARD ALL"

    super
  end
end

# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 411

def set_standard_conforming_strings
  internal_execute("SET standard_conforming_strings = on", "SCHEMA")
end