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.

Instance Method Summary collapse

Instance Method Details

#call(bind_vars = OPTS, &block) ⇒ Object

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


117
118
119
# File 'lib/sequel/dataset/prepared_statements.rb', line 117

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

#columnsObject

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


130
131
132
# File 'lib/sequel/dataset/prepared_statements.rb', line 130

def columns
  orig_dataset.columns
end

#delayed_evaluation_sql_append(sql, delay) ⇒ Object

Disallow use of delayed evaluations in prepared statements.

Raises:


135
136
137
138
# File 'lib/sequel/dataset/prepared_statements.rb', line 135

def delayed_evaluation_sql_append(sql, delay)
  raise Error, "delayed evaluations cannot be used in prepared statements" if @opts[:no_delayed_evaluations]
  super
end

#inspectObject

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


176
177
178
# File 'lib/sequel/dataset/prepared_statements.rb', line 176

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.


165
166
167
168
169
170
171
# File 'lib/sequel/dataset/prepared_statements.rb', line 165

def literal_symbol_append(sql, v)
  if @opts[:bind_vars] && /\A\$(.*)\z/ =~ v
    literal_append(sql, prepared_arg($1.to_sym))
  else
    super
  end
end

#log_sqlObject

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


89
90
91
# File 'lib/sequel/dataset/prepared_statements.rb', line 89

def log_sql
  @opts[:log_sql]
end

#orig_datasetObject

The dataset that created this prepared statement.


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

def orig_dataset
  @opts[:orig_dataset]
end

#prepareObject

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

Raises:


123
124
125
126
# File 'lib/sequel/dataset/prepared_statements.rb', line 123

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

#prepared_argsObject

The array/hash of bound variable placeholder names.


100
101
102
# File 'lib/sequel/dataset/prepared_statements.rb', line 100

def prepared_args
  @opts[:prepared_args]
end

#prepared_modify_valuesObject

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


111
112
113
# File 'lib/sequel/dataset/prepared_statements.rb', line 111

def prepared_modify_values
  @opts[:prepared_modify_values]
end

#prepared_sqlObject

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


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

def prepared_sql
  case prepared_type
  when :select, :all, :each
    # Most common scenario, so listed first.
    select_sql
  when :first, :single_value
    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_typeObject

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


95
96
97
# File 'lib/sequel/dataset/prepared_statements.rb', line 95

def prepared_type
  @opts[:prepared_type]
end