Class: Sequel::Postgres::PGRow::HashRow

Inherits:
Hash show all
Includes:
SQL::AliasMethods
Defined in:
lib/sequel/extensions/pg_row.rb

Overview

Class for row-valued/composite types that are treated as hashes. Types registered via Database#register_row_type will use this class by default.

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from SQL::AliasMethods

#as

Methods inherited from Hash

#&, #case, #hstore, #pg_json, #sql_expr, #sql_negate, #sql_or, #|, #~

Class Attribute Details

.columns ⇒ Object

The columns associated with this class.



135
136
137
 
# File 'lib/sequel/extensions/pg_row.rb', line 135

def columns
  @columns
end

.db_type ⇒ Object

The database type for this class. May be nil if this class done not have a specific database type.



139
140
141
 
# File 'lib/sequel/extensions/pg_row.rb', line 139

def db_type
  @db_type
end

Instance Attribute Details

#columns ⇒ Object

Return the instance’s columns, or the class’s columns if the instance has not overridden it.



168
169
170
 
# File 'lib/sequel/extensions/pg_row.rb', line 168

def columns
  @columns || self.class.columns
end

#db_type ⇒ Object

Return the instance’s database type, or the class’s columns if the instance has not overridden it.



174
175
176
 
# File 'lib/sequel/extensions/pg_row.rb', line 174

def db_type
  @db_type || self.class.db_type
end

Class Method Details

.subclass(db_type, columns) ⇒ Object

Create a new subclass of this class with the given database type and columns.



148
149
150
151
152
153
 
# File 'lib/sequel/extensions/pg_row.rb', line 148

def self.subclass(db_type, columns)
  sc = Class.new(self) do
    @db_type = db_type
    @columns = columns
  end
end

Instance Method Details

#check_columns! ⇒ Object

Check that the HashRow has valid columns. This should be used before all attempts to literalize the object, since literalization depends on the columns to get the column order.



181
182
183
184
185
 
# File 'lib/sequel/extensions/pg_row.rb', line 181

def check_columns!
  if columns.nil? || columns.empty?
    raise Error, 'cannot literalize HashRow without columns'
  end
end

#sql_literal_append(ds, sql) ⇒ Object

Append SQL fragment related to this object to the sql.



188
189
190
191
192
193
194
195
196
 
# File 'lib/sequel/extensions/pg_row.rb', line 188

def sql_literal_append(ds, sql)
  check_columns!
  sql << ROW
  ds.literal_append(sql, values_at(*columns))
  if db_type
    sql << CAST
    ds.quote_schema_table_append(sql, db_type)
  end
end