Module: Sequel::MySQL::DatasetMethods

Included in:
DataObjects::MySQL::Dataset, JDBC::MySQL::Dataset, Dataset, Sequel::Mysql2::Dataset, Swift::MySQL::Dataset
Defined in:
lib/sequel/adapters/shared/mysql.rb

Overview

Dataset methods shared by datasets that use MySQL databases.

Constant Summary collapse

BOOL_TRUE = 
'1'.freeze
BOOL_FALSE = 
'0'.freeze
COMMA_SEPARATOR = 
', '.freeze
FOR_SHARE = 
' LOCK IN SHARE MODE'.freeze
SQL_CALC_FOUND_ROWS = 
' SQL_CALC_FOUND_ROWS'.freeze
DELETE_CLAUSE_METHODS = 
Dataset.clause_methods(:delete, %w'from where order limit')
INSERT_CLAUSE_METHODS = 
Dataset.clause_methods(:insert, %w'ignore into columns values on_duplicate_key_update')
SELECT_CLAUSE_METHODS = 
Dataset.clause_methods(:select, %w'distinct calc_found_rows columns from join where group having compounds order limit lock')
UPDATE_CLAUSE_METHODS = 
Dataset.clause_methods(:update, %w'table set where order limit')

Instance Method Summary collapse

Instance Method Details

#calc_found_rows ⇒ Object

Sets up the select methods to use SQL_CALC_FOUND_ROWS option.

dataset.calc_found_rows.limit(10)
# SELECT SQL_CALC_FOUND_ROWS * FROM table LIMIT 10



339
340
341
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 339

def calc_found_rows
  clone(:calc_found_rows => true)
end

#complex_expression_sql(op, args) ⇒ Object

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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 313

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
  when :'B~'
    "CAST(~#{literal(args.at(0))} AS SIGNED INTEGER)"
  else
    super(op, args)
  end
end

#distinct(*args) ⇒ Object

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



331
332
333
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 331

def distinct(*args)
  args.empty? ? super : group(*args)
end

#for_share ⇒ Object

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



344
345
346
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 344

def for_share
  lock_style(:share)
end

#full_text_search(cols, terms, opts = {}) ⇒ Object

Adds full text filter



349
350
351
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 349

def full_text_search(cols, terms, opts = {})
  filter(full_text_sql(cols, terms, opts))
end

#full_text_sql(cols, term, opts = {}) ⇒ Object

MySQL specific full text search syntax.



354
355
356
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 354

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) ⇒ Object

MySQL allows HAVING clause on ungrouped datasets.



359
360
361
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 359

def having(*cond, &block)
  _filter(:having, *cond, &block)
end

#insert_ignore ⇒ Object

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)



389
390
391
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 389

def insert_ignore
  clone(:insert_ignore=>true)
end

#join_table(type, table, expr = nil, table_alias = {}, &block) ⇒ Object

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.

Raises:



365
366
367
368
369
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 365

def join_table(type, table, expr=nil, table_alias={}, &block)
  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, &block)
end

#join_type_sql(join_type) ⇒ Object

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



373
374
375
376
377
378
379
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 373

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) ⇒ Object

MySQL specific syntax for inserting multiple values at once.



417
418
419
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 417

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) ⇒ Object

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)



412
413
414
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 412

def on_duplicate_key_update(*args)
  clone(:on_duplicate_key_update => args)
end

#provides_accurate_rows_matched? ⇒ Boolean

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

Returns:

  • (Boolean) 


423
424
425
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 423

def provides_accurate_rows_matched?
  false
end

#quoted_identifier(c) ⇒ Object

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



428
429
430
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 428

def quoted_identifier(c)
  "`#{c}`"
end

#replace_sql(*values) ⇒ Object

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



434
435
436
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 434

def replace_sql(*values)
  clone(:replace=>true).insert_sql(*values)
end

#supports_distinct_on? ⇒ Boolean

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

Returns:

  • (Boolean) 


440
441
442
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 440

def supports_distinct_on?
  true
end

#supports_intersect_except? ⇒ Boolean

MySQL does not support INTERSECT or EXCEPT

Returns:

  • (Boolean) 


445
446
447
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 445

def supports_intersect_except?
  false
end

#supports_modifying_joins? ⇒ Boolean

MySQL supports modifying joined datasets

Returns:

  • (Boolean) 


450
451
452
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 450

def supports_modifying_joins?
  true
end

#supports_timestamp_usecs? ⇒ Boolean

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.

Returns:

  • (Boolean) 


457
458
459
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 457

def supports_timestamp_usecs?
  false
end