# frozen_string_literal: true ArJdbc.load_java_part :PostgreSQL require 'ipaddr' require 'active_record/connection_adapters/abstract_adapter' require 'active_record/connection_adapters/postgresql/column' require 'active_record/connection_adapters/postgresql/explain_pretty_printer' require 'active_record/connection_adapters/postgresql/quoting' require 'active_record/connection_adapters/postgresql/referential_integrity' require 'active_record/connection_adapters/postgresql/schema_creation' require 'active_record/connection_adapters/postgresql/schema_definitions' require 'active_record/connection_adapters/postgresql/schema_dumper' require 'active_record/connection_adapters/postgresql/schema_statements' require 'active_record/connection_adapters/postgresql/type_metadata' require 'active_record/connection_adapters/postgresql/utils' require 'arjdbc/abstract/core' require 'arjdbc/abstract/connection_management' require 'arjdbc/abstract/database_statements' require 'arjdbc/abstract/statement_cache' require 'arjdbc/abstract/transaction_support' require 'arjdbc/postgresql/base/array_decoder' require 'arjdbc/postgresql/base/array_encoder' require 'arjdbc/postgresql/name' module ArJdbc # Strives to provide Rails built-in PostgreSQL adapter (API) compatibility. module PostgreSQL require 'arjdbc/postgresql/column' require 'arel/visitors/postgresql_jdbc' # @private IndexDefinition = ::ActiveRecord::ConnectionAdapters::IndexDefinition # @private Type = ::ActiveRecord::Type # @see ActiveRecord::ConnectionAdapters::JdbcAdapter#jdbc_connection_class def self.jdbc_connection_class ::ActiveRecord::ConnectionAdapters::PostgreSQLJdbcConnection end # @see ActiveRecord::ConnectionAdapters::JdbcAdapter#jdbc_column_class def jdbc_column_class; ::ActiveRecord::ConnectionAdapters::PostgreSQLColumn end ADAPTER_NAME = 'PostgreSQL' def adapter_name ADAPTER_NAME end def get_database_version # :nodoc: begin version = @connection.database_product if match = version.match(/([\d\.]*\d).*?/) version = match[1].split('.').map(&:to_i) # PostgreSQL version representation does not have more than 4 digits # From version 10 onwards, PG has changed its versioning policy to # limit it to only 2 digits. i.e. in 10.x, 10 being the major # version and x representing the patch release # Refer to: # https://www.postgresql.org/support/versioning/ # https://www.postgresql.org/docs/10/static/libpq-status.html -> PQserverVersion() # for more info if version.size >= 3 (version[0] * 100 + version[1]) * 100 + version[2] elsif version.size == 2 if version[0] >= 10 version[0] * 100 * 100 + version[1] else (version[0] * 100 + version[1]) * 100 end elsif version.size == 1 version[0] * 100 * 100 else 0 end else 0 end end end def check_version # :nodoc: if database_version < 90300 raise "Your version of PostgreSQL (#{database_version}) is too old. Active Record supports PostgreSQL >= 9.3." end end def redshift? # SELECT version() : # PostgreSQL 8.0.2 on i686-pc-linux-gnu, compiled by GCC gcc (GCC) 3.4.2 20041017 (Red Hat 3.4.2-6.fc3), Redshift 1.0.647 if ( redshift = config[:redshift] ).nil? redshift = !! (@connection.database_product || '').index('Redshift') end redshift end private :redshift? def set_client_encoding(encoding) ActiveRecord::Base.logger.warn "client_encoding is set by the driver and should not be altered, ('#{encoding}' ignored)" ActiveRecord::Base.logger.debug "Set the 'allowEncodingChanges' driver property (e.g. using config[:properties]) if you need to override the client encoding when doing a copy." end # Configures the encoding, verbosity, schema search path, and time zone of the connection. # This is called on `connection.connect` and should not be called manually. def configure_connection #if encoding = config[:encoding] # The client_encoding setting is set by the driver and should not be altered. # If the driver detects a change it will abort the connection. # see http://jdbc.postgresql.org/documentation/91/connect.html # self.set_client_encoding(encoding) #end self.client_min_messages = config[:min_messages] || 'warning' self.schema_search_path = config[:schema_search_path] || config[:schema_order] # Use standard-conforming strings if available so we don't have to do the E'...' dance. set_standard_conforming_strings # If using Active Record's time zone support configure the connection to return # TIMESTAMP WITH ZONE types in UTC. # (SET TIME ZONE does not use an equals sign like other SET variables) if ActiveRecord::Base.default_timezone == :utc execute("SET time zone 'UTC'", 'SCHEMA') elsif tz = local_tz execute("SET time zone '#{tz}'", 'SCHEMA') end unless redshift? # SET statements from :variables config hash # http://www.postgresql.org/docs/8.3/static/sql-set.html (config[:variables] || {}).map do |k, v| if v == ':default' || v == :default # Sets the value to the global or compile default execute("SET SESSION #{k} TO DEFAULT", 'SCHEMA') elsif ! v.nil? execute("SET SESSION #{k} TO #{quote(v)}", 'SCHEMA') end end end # @private ActiveRecordError = ::ActiveRecord::ActiveRecordError NATIVE_DATABASE_TYPES = { primary_key: 'bigserial primary key', bigint: { name: 'bigint' }, binary: { name: 'bytea' }, bit: { name: 'bit' }, bit_varying: { name: 'bit varying' }, boolean: { name: 'boolean' }, box: { name: 'box' }, char: { name: 'char' }, cidr: { name: 'cidr' }, circle: { name: 'circle' }, citext: { name: 'citext' }, date: { name: 'date' }, daterange: { name: 'daterange' }, datetime: { name: 'timestamp' }, decimal: { name: 'decimal' }, # :limit => 1000 float: { name: 'float' }, hstore: { name: 'hstore' }, inet: { name: 'inet' }, int4range: { name: 'int4range' }, int8range: { name: 'int8range' }, integer: { name: 'integer' }, interval: { name: 'interval' }, json: { name: 'json' }, jsonb: { name: 'jsonb' }, line: { name: 'line' }, lseg: { name: 'lseg' }, ltree: { name: 'ltree' }, macaddr: { name: 'macaddr' }, money: { name: 'money' }, numeric: { name: 'numeric' }, numrange: { name: 'numrange' }, oid: { name: 'oid' }, path: { name: 'path' }, point: { name: 'point' }, polygon: { name: 'polygon' }, string: { name: 'character varying' }, text: { name: 'text' }, time: { name: 'time' }, timestamp: { name: 'timestamp' }, tsrange: { name: 'tsrange' }, tstzrange: { name: 'tstzrange' }, tsvector: { name: 'tsvector' }, uuid: { name: 'uuid' }, xml: { name: 'xml' } } def native_database_types NATIVE_DATABASE_TYPES end def valid_type?(type) !native_database_types[type].nil? end def set_standard_conforming_strings execute("SET standard_conforming_strings = on", "SCHEMA") end def supports_bulk_alter? true end def supports_index_sort_order? true end def supports_partial_index? true end def supports_expression_index? true end def supports_transaction_isolation? true end def supports_foreign_keys? true end def supports_validate_constraints? true end def supports_views? true end def supports_datetime_with_precision? true end def supports_json? database_version >= 90200 end def supports_comments? true end def supports_savepoints? true end def supports_insert_returning? true end def supports_insert_on_conflict? database_version >= 90500 end alias supports_insert_on_duplicate_skip? supports_insert_on_conflict? alias supports_insert_on_duplicate_update? supports_insert_on_conflict? alias supports_insert_conflict_target? supports_insert_on_conflict? def index_algorithms { concurrently: 'CONCURRENTLY' } end def supports_ddl_transactions? true end def supports_advisory_locks? true end def supports_explain? true end def supports_extensions? database_version >= 90200 end def supports_ranges? database_version >= 90200 end def supports_materialized_views? database_version >= 90300 end def supports_foreign_tables? # we don't really support this yet, its a reminder :) database_version >= 90300 end def supports_pgcrypto_uuid? database_version >= 90400 end 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 def supports_common_table_expressions? true end def supports_lazy_transactions? true end # From AR 5.1 postgres_adapter.rb def default_index_type?(index) # :nodoc: index.using == :btree || super end def get_advisory_lock(lock_id) # :nodoc: unless lock_id.is_a?(Integer) && lock_id.bit_length <= 63 raise(ArgumentError, "PostgreSQL requires advisory lock ids to be a signed 64 bit integer") end query_value("SELECT pg_try_advisory_lock(#{lock_id})") end def release_advisory_lock(lock_id) # :nodoc: unless lock_id.is_a?(Integer) && lock_id.bit_length <= 63 raise(ArgumentError, "PostgreSQL requires advisory lock ids to be a signed 64 bit integer") end query_value("SELECT pg_advisory_unlock(#{lock_id})") end def enable_extension(name) exec_query("CREATE EXTENSION IF NOT EXISTS \"#{name}\"").tap { reload_type_map } end def disable_extension(name) exec_query("DROP EXTENSION IF EXISTS \"#{name}\" CASCADE").tap { reload_type_map } end def extension_available?(name) query_value("SELECT true FROM pg_available_extensions WHERE name = #{quote(name)}", "SCHEMA") end def extension_enabled?(name) query_value("SELECT installed_version IS NOT NULL FROM pg_available_extensions WHERE name = #{quote(name)}", "SCHEMA") end def extensions exec_query("SELECT extname FROM pg_extension", "SCHEMA").cast_values end # Returns the configured supported identifier length supported by PostgreSQL def max_identifier_length @max_identifier_length ||= query_value("SHOW max_identifier_length", "SCHEMA").to_i end # Set the authorized user for this session def session_auth=(user) clear_cache! execute("SET SESSION AUTHORIZATION #{user}") end def use_insert_returning? @use_insert_returning end def exec_insert(sql, name = nil, binds = [], pk = nil, sequence_name = nil) val = super if !use_insert_returning? && pk unless sequence_name table_ref = extract_table_ref_from_insert_sql(sql) sequence_name = default_sequence_name(table_ref, pk) return val unless sequence_name end last_insert_id_result(sequence_name) else val end end def execute_batch(statements, name = nil) if statements.is_a? Array execute(combine_multi_statements(statements), name) else execute(statements, name) end end def explain(arel, binds = []) sql, binds = to_sql_and_binds(arel, binds) ActiveRecord::ConnectionAdapters::PostgreSQL::ExplainPrettyPrinter.new.pp(exec_query("EXPLAIN #{sql}", 'EXPLAIN', binds)) end # from ActiveRecord::ConnectionAdapters::PostgreSQL::DatabaseStatements READ_QUERY = ActiveRecord::ConnectionAdapters::AbstractAdapter.build_read_query_regexp( :begin, :commit, :explain, :select, :set, :show, :release, :savepoint, :rollback, :with ) # :nodoc: private_constant :READ_QUERY def write_query?(sql) # :nodoc: !READ_QUERY.match?(sql) end # We need to make sure to deallocate all the prepared statements # since apparently calling close on the statement object # doesn't always free the server resources and calling # 'DISCARD ALL' fails if we are inside a transaction def clear_cache! super # Make sure all query plans are *really* gone @connection.execute 'DEALLOCATE ALL' if active? end def reset! clear_cache! reset_transaction @connection.rollback # Have to deal with rollbacks differently than the AR adapter @connection.execute 'DISCARD ALL' @connection.configure_connection end def default_sequence_name(table_name, pk = "id") #:nodoc: serial_sequence(table_name, pk) rescue ActiveRecord::StatementInvalid %Q("#{table_name}_#{pk}_seq") end def last_insert_id_result(sequence_name) exec_query("SELECT currval('#{sequence_name}')", 'SQL') end def build_insert_sql(insert) # :nodoc: sql = +"INSERT #{insert.into} #{insert.values_list}" if insert.skip_duplicates? sql << " ON CONFLICT #{insert.conflict_target} DO NOTHING" elsif insert.update_duplicates? sql << " ON CONFLICT #{insert.conflict_target} DO UPDATE SET " sql << insert.updatable_columns.map { |column| "#{column}=excluded.#{column}" }.join(",") end sql << " RETURNING #{insert.returning}" if insert.returning sql end def build_truncate_statements(*table_names) ["TRUNCATE TABLE #{table_names.flatten.map(&method(:quote_table_name)).join(", ")}"] end def truncate(table_name, name = nil) ActiveRecord::Base.clear_query_caches_for_current_thread if @query_cache_enabled execute("TRUNCATE TABLE #{quote_table_name(table_name)}", name) end def all_schemas select('SELECT nspname FROM pg_namespace').map { |row| row["nspname"] } end # Returns the current client message level. def client_min_messages return nil if redshift? # not supported on Redshift # Need to use #execute so we don't try to access the type map before it is initialized execute('SHOW client_min_messages', 'SCHEMA').values.first.first end # Set the client message level. def client_min_messages=(level) # Not supported on Redshift redshift? ? nil : super end # ORDER BY clause for the passed order option. # # PostgreSQL does not allow arbitrary ordering when using DISTINCT ON, # so we work around this by wrapping the SQL as a sub-select and ordering # in that query. def add_order_by_for_association_limiting!(sql, options) return sql if options[:order].blank? order = options[:order].split(',').collect { |s| s.strip }.reject(&:blank?) order.map! { |s| 'DESC' if s =~ /\bdesc$/i } order = order.zip((0...order.size).to_a).map { |s,i| "id_list.alias_#{i} #{s}" }.join(', ') sql.replace "SELECT * FROM (#{sql}) AS id_list ORDER BY #{order}" end # @note #quote_string implemented as native def escape_bytea(string) return unless string "\\x#{string.unpack("H*")[0]}" end # @override def quote_table_name(name) schema, name_part = extract_pg_identifier_from_name(name.to_s) unless name_part quote_column_name(schema) else table_name, name_part = extract_pg_identifier_from_name(name_part) "#{quote_column_name(schema)}.#{quote_column_name(table_name)}" end end # @note #quote_column_name implemented as native alias_method :quote_schema_name, :quote_column_name # Need to clear the cache even though the AR adapter doesn't for some reason def remove_column(table_name, column_name, type = nil, **options) super clear_cache! end # @private def column_for(table_name, column_name) column_name = column_name.to_s for column in columns(table_name) return column if column.name == column_name end nil end # @private def column_name_for_operation(operation, node) case operation when 'maximum' then 'max' when 'minimum' then 'min' when 'average' then 'avg' else operation.downcase end end private # Returns the list of a table's column names, data types, and default values. # # If the table name is not prefixed with a schema, the database will # take the first match from the schema search path. # # Query implementation notes: # - format_type includes the column size constraint, e.g. varchar(50) # - ::regclass is a function that gives the id for a table name def column_definitions(table_name) select_rows(<<~SQL, 'SCHEMA') SELECT a.attname, format_type(a.atttypid, a.atttypmod), pg_get_expr(d.adbin, d.adrelid), a.attnotnull, a.atttypid, a.atttypmod, c.collname, col_description(a.attrelid, a.attnum) AS comment FROM pg_attribute a LEFT JOIN pg_attrdef d ON a.attrelid = d.adrelid AND a.attnum = d.adnum LEFT JOIN pg_type t ON a.atttypid = t.oid LEFT JOIN pg_collation c ON a.attcollation = c.oid AND a.attcollation <> t.typcollation WHERE a.attrelid = #{quote(quote_table_name(table_name))}::regclass AND a.attnum > 0 AND NOT a.attisdropped ORDER BY a.attnum SQL end def extract_table_ref_from_insert_sql(sql) sql[/into\s("[A-Za-z0-9_."\[\]\s]+"|[A-Za-z0-9_."\[\]]+)\s*/im] $1.strip if $1 end def arel_visitor Arel::Visitors::PostgreSQL.new(self) end # Pulled from ActiveRecord's Postgres adapter and modified to use execute def can_perform_case_insensitive_comparison_for?(column) @case_insensitive_cache ||= {} @case_insensitive_cache[column.sql_type] ||= begin sql = <<~SQL SELECT exists( SELECT * FROM pg_proc WHERE proname = 'lower' AND proargtypes = ARRAY[#{quote column.sql_type}::regtype]::oidvector ) OR exists( SELECT * FROM pg_proc INNER JOIN pg_cast ON ARRAY[casttarget]::oidvector = proargtypes WHERE proname = 'lower' AND castsource = #{quote column.sql_type}::regtype ) SQL select_value(sql, 'SCHEMA') end end def translate_exception(exception, message:, sql:, binds:) return super unless exception.is_a?(ActiveRecord::JDBCError) # TODO: Can we base these on an error code of some kind? case exception.message when /duplicate key value violates unique constraint/ ::ActiveRecord::RecordNotUnique.new(message, sql: sql, binds: binds) when /violates not-null constraint/ ::ActiveRecord::NotNullViolation.new(message, sql: sql, binds: binds) when /violates foreign key constraint/ ::ActiveRecord::InvalidForeignKey.new(message, sql: sql, binds: binds) when /value too long/ ::ActiveRecord::ValueTooLong.new(message, sql: sql, binds: binds) when /out of range/ ::ActiveRecord::RangeError.new(message, sql: sql, binds: binds) when /could not serialize/ ::ActiveRecord::SerializationFailure.new(message, sql: sql, binds: binds) when /deadlock detected/ ::ActiveRecord::Deadlocked.new(message, sql: sql, binds: binds) when /lock timeout/ ::ActiveRecord::LockWaitTimeout.new(message, sql: sql, binds: binds) when /canceling statement/ # This needs to come after lock timeout because the lock timeout message also contains "canceling statement" ::ActiveRecord::QueryCanceled.new(message, sql: sql, binds: binds) else super end end # @private `Utils.extract_schema_and_table` from AR def extract_schema_and_table(name) result = name.scan(/[^".\s]+|"[^"]*"/)[0, 2] result.each { |m| m.gsub!(/(^"|"$)/, '') } result.unshift(nil) if result.size == 1 # schema == nil result # [schema, table] end def extract_pg_identifier_from_name(name) match_data = name[0, 1] == '"' ? name.match(/\"([^\"]+)\"/) : name.match(/([^\.]+)/) if match_data rest = name[match_data[0].length..-1] rest = rest[1..-1] if rest[0, 1] == "." [match_data[1], (rest.length > 0 ? rest : nil)] end end def local_tz @local_tz ||= execute('SHOW TIME ZONE', 'SCHEMA').first["TimeZone"] end def bind_params_length 32767 end end end require 'arjdbc/util/quoted_cache' module ActiveRecord::ConnectionAdapters # NOTE: seems needed on 4.x due loading of '.../postgresql/oid' which # assumes: class PostgreSQLAdapter < AbstractAdapter remove_const(:PostgreSQLAdapter) if const_defined?(:PostgreSQLAdapter) class PostgreSQLAdapter < AbstractAdapter class_attribute :create_unlogged_tables, default: false # Try to use as much of the built in postgres logic as possible # maybe someday we can extend the actual adapter include ActiveRecord::ConnectionAdapters::PostgreSQL::ReferentialIntegrity include ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaStatements include ActiveRecord::ConnectionAdapters::PostgreSQL::Quoting include Jdbc::ConnectionPoolCallbacks include ArJdbc::Abstract::Core include ArJdbc::Abstract::ConnectionManagement include ArJdbc::Abstract::DatabaseStatements include ArJdbc::Abstract::StatementCache include ArJdbc::Abstract::TransactionSupport include ArJdbc::PostgreSQL require 'arjdbc/postgresql/oid_types' include ::ArJdbc::PostgreSQL::OIDTypes include ::ArJdbc::PostgreSQL::ColumnHelpers include ::ArJdbc::Util::QuotedCache # AR expects OID to be available on the adapter OID = ActiveRecord::ConnectionAdapters::PostgreSQL::OID def initialize(connection, logger = nil, connection_parameters = nil, config = {}) # @local_tz is initialized as nil to avoid warnings when connect tries to use it @local_tz = nil @max_identifier_length = nil super(connection, logger, config) # configure_connection happens in super @type_map = Type::HashLookupTypeMap.new initialize_type_map @use_insert_returning = @config.key?(:insert_returning) ? self.class.type_cast_config_to_boolean(@config[:insert_returning]) : true end def self.database_exists?(config) conn = ActiveRecord::Base.postgresql_connection(config) conn && conn.really_valid? rescue ActiveRecord::NoDatabaseError false ensure conn.disconnect! if conn end require 'active_record/connection_adapters/postgresql/schema_definitions' ColumnMethods = ActiveRecord::ConnectionAdapters::PostgreSQL::ColumnMethods TableDefinition = ActiveRecord::ConnectionAdapters::PostgreSQL::TableDefinition Table = ActiveRecord::ConnectionAdapters::PostgreSQL::Table public :sql_for_insert alias :postgresql_version :database_version def jdbc_connection_class(spec) ::ArJdbc::PostgreSQL.jdbc_connection_class end private # Prepared statements aren't schema aware so we need to make sure we # store different PreparedStatement objects for different schemas def sql_key(sql) "#{schema_search_path}-#{sql}" end end end