Module: ActiveRecord::ConnectionAdapters::PostgreSQL::DatabaseStatements
- Included in:
- ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
- Defined in:
- lib/active_record/connection_adapters/postgresql/database_statements.rb
Defined Under Namespace
Classes: ExplainPrettyPrinter
Constant Summary collapse
- MONEY_COLUMN_TYPE_OID =
The internal PostgreSQL identifier of the money data type.
790
- BYTEA_COLUMN_TYPE_OID =
The internal PostgreSQL identifier of the BYTEA data type.
17
Instance Method Summary collapse
-
#begin_db_transaction ⇒ Object
Begins a transaction.
- #begin_isolated_db_transaction(isolation) ⇒ Object
-
#commit_db_transaction ⇒ Object
Commits a transaction.
- #create ⇒ Object
- #exec_delete(sql, name = 'SQL', binds = []) ⇒ Object (also: #exec_update)
- #exec_insert(sql, name, binds, pk = nil, sequence_name = nil) ⇒ Object
- #exec_query(sql, name = 'SQL', binds = []) ⇒ Object
-
#exec_rollback_db_transaction ⇒ Object
Aborts a transaction.
-
#execute(sql, name = nil) ⇒ Object
Executes an SQL statement, returning a PGresult object on success or raising a PGError exception otherwise.
- #explain(arel, binds = []) ⇒ Object
-
#insert_sql(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil) ⇒ Object
Executes an INSERT query and returns the new record’s ID.
-
#query(sql, name = nil) ⇒ Object
Queries the database and returns the results in an Array-like object.
-
#result_as_array(res) ⇒ Object
create a 2D array representing the result set.
-
#select_rows(sql, name = nil, binds = []) ⇒ Object
Executes a SELECT query and returns an array of rows.
- #select_value(arel, name = nil, binds = []) ⇒ Object
- #select_values(arel, name = nil) ⇒ Object
- #sql_for_insert(sql, pk, id_value, sequence_name, binds) ⇒ Object
-
#update_sql(sql, name = nil) ⇒ Object
Executes an UPDATE query and returns the number of affected tuples.
Instance Method Details
#begin_db_transaction ⇒ Object
Begins a transaction.
211 212 213 |
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 211 def begin_db_transaction execute "BEGIN" end |
#begin_isolated_db_transaction(isolation) ⇒ Object
215 216 217 218 |
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 215 def begin_isolated_db_transaction(isolation) begin_db_transaction execute "SET TRANSACTION ISOLATION LEVEL #{transaction_isolation_levels.fetch(isolation)}" end |
#commit_db_transaction ⇒ Object
Commits a transaction.
221 222 223 |
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 221 def commit_db_transaction execute "COMMIT" end |
#create ⇒ Object
93 94 95 |
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 93 def create super.insert end |
#exec_delete(sql, name = 'SQL', binds = []) ⇒ Object Also known as: exec_update
172 173 174 |
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 172 def exec_delete(sql, name = 'SQL', binds = []) execute_and_clear(sql, name, binds) {|result| result.cmd_tuples } end |
#exec_insert(sql, name, binds, pk = nil, sequence_name = nil) ⇒ Object
191 192 193 194 195 196 197 198 199 200 201 202 203 |
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 191 def exec_insert(sql, name, binds, pk = nil, sequence_name = nil) val = exec_query(sql, name, binds) 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 |
#exec_query(sql, name = 'SQL', binds = []) ⇒ Object
159 160 161 162 163 164 165 166 167 168 169 170 |
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 159 def exec_query(sql, name = 'SQL', binds = []) execute_and_clear(sql, name, binds) do |result| types = {} fields = result.fields fields.each_with_index do |fname, i| ftype = result.ftype i fmod = result.fmod i types[fname] = get_oid_type(ftype, fmod, fname) end ActiveRecord::Result.new(fields, result.values, types) end end |
#exec_rollback_db_transaction ⇒ Object
Aborts a transaction.
226 227 228 |
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 226 def exec_rollback_db_transaction execute "ROLLBACK" end |
#execute(sql, name = nil) ⇒ Object
Executes an SQL statement, returning a PGresult object on success or raising a PGError exception otherwise.
153 154 155 156 157 |
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 153 def execute(sql, name = nil) log(sql, name) do @connection.async_exec(sql) end end |
#explain(arel, binds = []) ⇒ Object
5 6 7 8 |
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 5 def explain(arel, binds = []) sql = "EXPLAIN #{to_sql(arel, binds)}" ExplainPrettyPrinter.new.pp(exec_query(sql, 'EXPLAIN', binds)) end |
#insert_sql(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil) ⇒ Object
Executes an INSERT query and returns the new record’s ID
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 76 def insert_sql(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil) unless pk # Extract the table from the insert sql. Yuck. table_ref = extract_table_ref_from_insert_sql(sql) pk = primary_key(table_ref) if table_ref end if pk && use_insert_returning? select_value("#{sql} RETURNING #{quote_column_name(pk)}") elsif pk super last_insert_id_value(sequence_name || default_sequence_name(table_ref, pk)) else super end end |
#query(sql, name = nil) ⇒ Object
Queries the database and returns the results in an Array-like object
145 146 147 148 149 |
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 145 def query(sql, name = nil) #:nodoc: log(sql, name) do result_as_array @connection.async_exec(sql) end end |
#result_as_array(res) ⇒ Object
create a 2D array representing the result set
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 103 def result_as_array(res) #:nodoc: # check if we have any binary column and if they need escaping ftypes = Array.new(res.nfields) do |i| [i, res.ftype(i)] end rows = res.values return rows unless ftypes.any? { |_, x| x == BYTEA_COLUMN_TYPE_OID || x == MONEY_COLUMN_TYPE_OID } typehash = ftypes.group_by { |_, type| type } binaries = typehash[BYTEA_COLUMN_TYPE_OID] || [] monies = typehash[MONEY_COLUMN_TYPE_OID] || [] rows.each do |row| # unescape string passed BYTEA field (OID == 17) binaries.each do |index, _| row[index] = unescape_bytea(row[index]) end # If this is a money type column and there are any currency symbols, # then strip them off. Indeed it would be prettier to do this in # PostgreSQLColumn.string_to_decimal but would break form input # fields that call value_before_type_cast. monies.each do |index, _| data = row[index] # Because money output is formatted according to the locale, there are two # cases to consider (note the decimal separators): # (1) $12,345,678.12 # (2) $12.345.678,12 case data when /^-?\D+[\d,]+\.\d{2}$/ # (1) data.gsub!(/[^-\d.]/, '') when /^-?\D+[\d.]+,\d{2}$/ # (2) data.gsub!(/[^-\d,]/, '').sub!(/,/, '.') end end end end |
#select_rows(sql, name = nil, binds = []) ⇒ Object
Executes a SELECT query and returns an array of rows. Each row is an array of field values.
69 70 71 72 73 |
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 69 def select_rows(sql, name = nil, binds = []) execute_and_clear(sql, name, binds) do |result| result.values end end |
#select_value(arel, name = nil, binds = []) ⇒ Object
47 48 49 50 51 52 53 |
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 47 def select_value(arel, name = nil, binds = []) arel, binds = binds_from_relation arel, binds sql = to_sql(arel, binds) execute_and_clear(sql, name, binds) do |result| result.getvalue(0, 0) if result.ntuples > 0 && result.nfields > 0 end end |
#select_values(arel, name = nil) ⇒ Object
55 56 57 58 59 60 61 62 63 64 65 |
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 55 def select_values(arel, name = nil) arel, binds = binds_from_relation arel, [] sql = to_sql(arel, binds) execute_and_clear(sql, name, binds) do |result| if result.nfields > 0 result.column_values(0) else [] end end end |
#sql_for_insert(sql, pk, id_value, sequence_name, binds) ⇒ Object
177 178 179 180 181 182 183 184 185 186 187 188 189 |
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 177 def sql_for_insert(sql, pk, id_value, sequence_name, binds) unless pk # Extract the table from the insert sql. Yuck. table_ref = extract_table_ref_from_insert_sql(sql) pk = primary_key(table_ref) if table_ref end if pk && use_insert_returning? sql = "#{sql} RETURNING #{quote_column_name(pk)}" end [sql, binds] end |
#update_sql(sql, name = nil) ⇒ Object
Executes an UPDATE query and returns the number of affected tuples.
206 207 208 |
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 206 def update_sql(sql, name = nil) super.cmd_tuples end |