Module: Sequel::Dataset::PreparedStatementMethods

Defined in:
lib/sequel/dataset/prepared_statements.rb

Overview

Backbone of the prepared statement support. Grafts bind variable support into datasets by hijacking #literal and using placeholders. By default, emulates prepared statements and bind variables by taking the hash of bind variables and directly substituting them into the query, which works on all databases, as it is no different from using the dataset without bind variables.

Constant Summary collapse

PLACEHOLDER_RE = 
/\A\$(.*)\z/

Instance Method Summary collapse

Instance Method Details

#call(bind_vars = {}, &block) ⇒ Object

Sets the prepared_args to the given hash and runs the prepared statement.



126
127
128
 
# File 'lib/sequel/dataset/prepared_statements.rb', line 126

def call(bind_vars={}, &block)
  bind(bind_vars).run(&block)
end

#columns ⇒ Object

Send the columns to the original dataset, as calling it on the prepared statement can cause problems.



139
140
141
 
# File 'lib/sequel/dataset/prepared_statements.rb', line 139

def columns
  orig_dataset.columns
end

#inspect ⇒ Object

Programmer friendly string showing this is a prepared statement, with the prepared SQL it represents (which in general won’t have substituted variables).



184
185
186
 
# File 'lib/sequel/dataset/prepared_statements.rb', line 184

def inspect
  "<#{visible_class_name}/PreparedStatement #{prepared_sql.inspect}>"
end

#literal_symbol_append(sql, v) ⇒ Object

Changes the values of symbols if they start with $ and prepared_args is present. If so, they are considered placeholders, and they are substituted using prepared_arg.



168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/sequel/dataset/prepared_statements.rb', line 168

def literal_symbol_append(sql, v)
  if @opts[:bind_vars] and match = PLACEHOLDER_RE.match(v.to_s)
    s = match[1].to_sym
    if prepared_arg?(s)
      literal_append(sql, prepared_arg(s))
    else
      sql << v.to_s
    end
  else
    super
  end
end

#log_sql ⇒ Object

Whether to log the full SQL query. By default, just the prepared statement name is generally logged on adapters that support native prepared statements.



98
99
100
 
# File 'lib/sequel/dataset/prepared_statements.rb', line 98

def log_sql
  @opts[:log_sql]
end

#orig_dataset ⇒ Object

The dataset that created this prepared statement.



114
115
116
 
# File 'lib/sequel/dataset/prepared_statements.rb', line 114

def orig_dataset
  @opts[:orig_dataset]
end

#prepare ⇒ Object

Raise an error if attempting to call prepare on an already prepared statement.

Raises:



132
133
134
135
 
# File 'lib/sequel/dataset/prepared_statements.rb', line 132

def prepare(*)
  raise Error, "cannot prepare an already prepared statement" unless allow_preparing_prepared_statements?
  super
end

#prepared_args ⇒ Object

The array/hash of bound variable placeholder names.



109
110
111
 
# File 'lib/sequel/dataset/prepared_statements.rb', line 109

def prepared_args
  @opts[:prepared_args]
end

#prepared_modify_values ⇒ Object

The argument to supply to insert and update, which may use placeholders specified by prepared_args



120
121
122
 
# File 'lib/sequel/dataset/prepared_statements.rb', line 120

def prepared_modify_values
  @opts[:prepared_modify_values]
end

#prepared_sql ⇒ Object

Returns the SQL for the prepared statement, depending on the type of the statement and the prepared_modify_values.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/sequel/dataset/prepared_statements.rb', line 145

def prepared_sql
  case prepared_type
  when :select, :all, :each
    # Most common scenario, so listed first.
    select_sql
  when :first
    clone(:limit=>1).select_sql
  when :insert_select
    insert_select_sql(*prepared_modify_values)
  when :insert, :insert_pk
    insert_sql(*prepared_modify_values)
  when :update
    update_sql(*prepared_modify_values)
  when :delete
    delete_sql
  else
    select_sql
  end
end

#prepared_type ⇒ Object

The type of prepared statement, should be one of :select, :first, :insert, :update, or :delete



104
105
106
 
# File 'lib/sequel/dataset/prepared_statements.rb', line 104

def prepared_type
  @opts[:prepared_type]
end