Class/Module Index [+]

Quicksearch

Sequel::MySQL::DatasetMethods

Dataset methods shared by datasets that use MySQL databases.

Public Instance Methods

complex_expression_sql(op, args) click to toggle source

MySQL specific syntax for LIKE/REGEXP searches, as well as string concatenation.

# File lib/sequel/adapters/shared/mysql.rb, line 233
def complex_expression_sql(op, args)
  case op
  when :~, :'!~', :'~*', :'!~*', :LIKE, :'NOT LIKE', :ILIKE, :'NOT ILIKE'
    "(#{literal(args.at(0))} #{'NOT ' if [:'NOT LIKE', :'NOT ILIKE', :'!~', :'!~*'].include?(op)}#{[:~, :'!~', :'~*', :'!~*'].include?(op) ? 'REGEXP' : 'LIKE'} #{'BINARY ' if [:~, :'!~', :LIKE, :'NOT LIKE'].include?(op)}#{literal(args.at(1))})"
  when :'||'
    if args.length > 1
      "CONCAT(#{args.collect{|a| literal(a)}.join(', ')})"
    else
      literal(args.at(0))
    end
  else
    super(op, args)
  end
end
distinct(*args) click to toggle source

Use GROUP BY instead of DISTINCT ON if arguments are provided.

# File lib/sequel/adapters/shared/mysql.rb, line 249
def distinct(*args)
  args.empty? ? super : group(*args)
end
for_share() click to toggle source

Return a cloned dataset which will use LOCK IN SHARE MODE to lock returned rows.

# File lib/sequel/adapters/shared/mysql.rb, line 254
def for_share
  lock_style(:share)
end
full_text_search(cols, terms, opts = {}) click to toggle source

Adds full text filter

# File lib/sequel/adapters/shared/mysql.rb, line 259
def full_text_search(cols, terms, opts = {})
  filter(full_text_sql(cols, terms, opts))
end
full_text_sql(cols, term, opts = {}) click to toggle source

MySQL specific full text search syntax.

# File lib/sequel/adapters/shared/mysql.rb, line 264
def full_text_sql(cols, term, opts = {})
  "MATCH #{literal(Array(cols))} AGAINST (#{literal(Array(term).join(' '))}#{" IN BOOLEAN MODE" if opts[:boolean]})"
end
having(*cond, &block) click to toggle source

MySQL allows HAVING clause on ungrouped datasets.

# File lib/sequel/adapters/shared/mysql.rb, line 269
def having(*cond, &block)
  _filter(:having, *cond, &block)
end
insert_ignore() click to toggle source

Sets up the insert methods to use INSERT IGNORE. Useful if you have a unique key and want to just skip inserting rows that violate the unique key restriction.

dataset.insert_ignore.multi_insert(
 [{:name => 'a', :value => 1}, {:name => 'b', :value => 2}]
)
# INSERT IGNORE INTO tablename (name, value) VALUES (a, 1), (b, 2)
# File lib/sequel/adapters/shared/mysql.rb, line 299
def insert_ignore
  clone(:insert_ignore=>true)
end
join_table(type, table, expr=nil, table_alias={}) click to toggle source

Transforms an CROSS JOIN to an INNER JOIN if the expr is not nil. Raises an error on use of :full_outer type, since MySQL doesn’t support it.

# File lib/sequel/adapters/shared/mysql.rb, line 275
def join_table(type, table, expr=nil, table_alias={})
  type = :inner if (type == :cross) && !expr.nil?
  raise(Sequel::Error, "MySQL doesn't support FULL OUTER JOIN") if type == :full_outer
  super(type, table, expr, table_alias)
end
join_type_sql(join_type) click to toggle source

Transforms :natural_inner to NATURAL LEFT JOIN and straight to STRAIGHT_JOIN.

# File lib/sequel/adapters/shared/mysql.rb, line 283
def join_type_sql(join_type)
  case join_type
  when :straight then 'STRAIGHT_JOIN'
  when :natural_inner then 'NATURAL LEFT JOIN'
  else super
  end
end
multi_insert_sql(columns, values) click to toggle source

MySQL specific syntax for inserting multiple values at once.

# File lib/sequel/adapters/shared/mysql.rb, line 327
def multi_insert_sql(columns, values)
  [insert_sql(columns, LiteralString.new('VALUES ' + values.map {|r| literal(Array(r))}.join(COMMA_SEPARATOR)))]
end
on_duplicate_key_update(*args) click to toggle source

Sets up the insert methods to use ON DUPLICATE KEY UPDATE If you pass no arguments, ALL fields will be updated with the new values. If you pass the fields you want then ONLY those field will be updated.

Useful if you have a unique key and want to update inserting rows that violate the unique key restriction.

dataset.on_duplicate_key_update.multi_insert(
 [{:name => 'a', :value => 1}, {:name => 'b', :value => 2}]
)
# INSERT INTO tablename (name, value) VALUES (a, 1), (b, 2)
# ON DUPLICATE KEY UPDATE name=VALUES(name), value=VALUES(value)

dataset.on_duplicate_key_update(:value).multi_insert(
  [{:name => 'a', :value => 1}, {:name => 'b', :value => 2}]
)
# INSERT INTO tablename (name, value) VALUES (a, 1), (b, 2)
# ON DUPLICATE KEY UPDATE value=VALUES(value)
# File lib/sequel/adapters/shared/mysql.rb, line 322
def on_duplicate_key_update(*args)
  clone(:on_duplicate_key_update => args)
end
provides_accurate_rows_matched?() click to toggle source

MySQL uses the number of rows actually modified in the update, instead of the number of matched by the filter.

# File lib/sequel/adapters/shared/mysql.rb, line 333
def provides_accurate_rows_matched?
  false
end
quoted_identifier(c) click to toggle source

MySQL uses the nonstandard ` (backtick) for quoting identifiers.

# File lib/sequel/adapters/shared/mysql.rb, line 338
def quoted_identifier(c)
  "`#{c}`"
end
replace_sql(*values) click to toggle source

MySQL specific syntax for REPLACE (aka UPSERT, or update if exists, insert if it doesn't).

# File lib/sequel/adapters/shared/mysql.rb, line 344
def replace_sql(*values)
  clone(:replace=>true).insert_sql(*values)
end
supports_distinct_on?() click to toggle source

MySQL can emulate DISTINCT ON with its non-standard GROUP BY implementation, though the rows returned cannot be made deterministic through ordering.

# File lib/sequel/adapters/shared/mysql.rb, line 350
def supports_distinct_on?
  true
end
supports_intersect_except?() click to toggle source

MySQL does not support INTERSECT or EXCEPT

# File lib/sequel/adapters/shared/mysql.rb, line 355
def supports_intersect_except?
  false
end
supports_modifying_joins?() click to toggle source

MySQL supports modifying joined datasets

# File lib/sequel/adapters/shared/mysql.rb, line 360
def supports_modifying_joins?
  true
end
supports_timestamp_usecs?() click to toggle source

MySQL does support fractional timestamps in literal timestamps, but it ignores them. Also, using them seems to cause problems on 1.9. Since they are ignored anyway, not using them is probably best.

# File lib/sequel/adapters/shared/mysql.rb, line 367
def supports_timestamp_usecs?
  false
end

Protected Instance Methods

_insert_sql() click to toggle source

If this is an replace instead of an insert, use replace instead

# File lib/sequel/adapters/shared/mysql.rb, line 374
def _insert_sql
  @opts[:replace] ? clause_sql(:replace) : super
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.