Module: Sequel::MySQL::DatasetMethods

Includes:
Dataset::Replace, UnmodifiedIdentifiers::DatasetMethods
Included in:
DataObjects::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
APOS = 
"'".freeze
APOS_RE = 
/'/.freeze
DOUBLE_APOS = 
"''".freeze
SPACE = 
' '.freeze
PAREN_CLOSE = 
')'.freeze
PAREN_OPEN = 
'('.freeze
NOT_SPACE = 
'NOT '.freeze
FROM = 
' FROM '.freeze
COMMA = 
', '.freeze
LIMIT = 
" LIMIT ".freeze
GROUP_BY = 
" GROUP BY ".freeze
ESCAPE = 
" ESCAPE ".freeze
BACKSLASH = 
"\\".freeze
REGEXP = 
'REGEXP'.freeze
LIKE = 
'LIKE'.freeze
BINARY = 
'BINARY '.freeze
CONCAT = 
"CONCAT".freeze
CAST_BITCOMP_OPEN = 
"CAST(~".freeze
CAST_BITCOMP_CLOSE = 
" AS SIGNED INTEGER)".freeze
STRAIGHT_JOIN = 
'STRAIGHT_JOIN'.freeze
NATURAL_LEFT_JOIN = 
'NATURAL LEFT JOIN'.freeze
BACKTICK = 
'`'.freeze
BACKTICK_RE = 
/`/.freeze
DOUBLE_BACKTICK = 
'``'.freeze
EMPTY_COLUMNS = 
" ()".freeze
EMPTY_VALUES = 
" VALUES ()".freeze
IGNORE = 
" IGNORE".freeze
ON_DUPLICATE_KEY_UPDATE = 
" ON DUPLICATE KEY UPDATE ".freeze
EQ_VALUES = 
'=VALUES('.freeze
EQ = 
'='.freeze
WITH_ROLLUP = 
' WITH ROLLUP'.freeze
EXPLAIN = 
'EXPLAIN '.freeze
EXPLAIN_EXTENDED = 
'EXPLAIN EXTENDED '.freeze
BACKSLASH_RE = 
/\\/.freeze
QUAD_BACKSLASH = 
"\\\\\\\\".freeze
BLOB_START = 
"0x".freeze
EMPTY_BLOB = 
"''".freeze
HSTAR = 
"H*".freeze
CURRENT_TIMESTAMP_56 = 
'CURRENT_TIMESTAMP(6)'.freeze
ONLY_OFFSET = 
",18446744073709551615".freeze
NON_SQL_OPTIONS = 
(Dataset::NON_SQL_OPTIONS + [:insert_ignore, :update_ignore, :on_duplicate_key_update]).freeze
MATCH_AGAINST = 
["MATCH ".freeze, " AGAINST (".freeze, ")".freeze].freeze
MATCH_AGAINST_BOOLEAN = 
["MATCH ".freeze, " AGAINST (".freeze, " IN BOOLEAN MODE)".freeze].freeze

Constants included from Dataset::Replace

Dataset::Replace::INSERT, Dataset::Replace::REPLACE

Instance Method Summary collapse

Methods included from Dataset::Replace

#multi_replace, #replace, #replace_sql, #supports_replace?

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



798
799
800
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 798

def calc_found_rows
  clone(:calc_found_rows => true)
end

#complex_expression_sql_append(sql, op, args) ⇒ Object

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



738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 738

def complex_expression_sql_append(sql, op, args)
  case op
  when :IN, :"NOT IN"
    ds = args[1]
    if ds.is_a?(Sequel::Dataset) && ds.opts[:limit]
      super(sql, op, [args[0], ds.from_self])
    else
      super
    end
  when :~, :'!~', :'~*', :'!~*', :LIKE, :'NOT LIKE', :ILIKE, :'NOT ILIKE'
    sql << '('
    literal_append(sql, args[0])
    sql << ' '
    sql << 'NOT ' if [:'NOT LIKE', :'NOT ILIKE', :'!~', :'!~*'].include?(op)
    sql << ([:~, :'!~', :'~*', :'!~*'].include?(op) ? 'REGEXP' : 'LIKE')
    sql << ' '
    sql << 'BINARY ' if [:~, :'!~', :LIKE, :'NOT LIKE'].include?(op)
    literal_append(sql, args[1])
    if [:LIKE, :'NOT LIKE', :ILIKE, :'NOT ILIKE'].include?(op)
      sql << " ESCAPE "
      literal_append(sql, "\\")
    end
    sql << ')'
  when :'||'
    if args.length > 1
      sql << "CONCAT"
      array_sql_append(sql, args)
    else
      literal_append(sql, args[0])
    end
  when :'B~'
    sql << "CAST(~"
    literal_append(sql, args[0])
    sql << " AS SIGNED INTEGER)"
  else
    super
  end
end

#constant_sql_append(sql, constant) ⇒ Object

MySQL’s CURRENT_TIMESTAMP does not use fractional seconds, even if the database itself supports fractional seconds. If MySQL 5.6.4+ is being used, use a value that will return fractional seconds.



781
782
783
784
785
786
787
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 781

def constant_sql_append(sql, constant)
  if constant == :CURRENT_TIMESTAMP && supports_timestamp_usecs?
    sql << 'CURRENT_TIMESTAMP(6)'
  else
    super
  end
end

#delete_from(*tables) ⇒ Object

Sets up the select methods to delete from if deleting from a joined dataset:

DB[:a].join(:b, :a_id=>:id).delete
# DELETE a FROM a INNER JOIN b ON (b.a_id = a.id)

DB[:a].join(:b, :a_id=>:id).delete_from(:a, :b).delete
# DELETE a, b FROM a INNER JOIN b ON (b.a_id = a.id)



810
811
812
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 810

def delete_from(*tables)
  clone(:delete_from=>tables)
end

#distinct(*args) ⇒ Object

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



790
791
792
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 790

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

#explain(opts = OPTS) ⇒ Object

Return the results of an EXPLAIN query as a string. Options:

:extended

Use EXPLAIN EXPTENDED instead of EXPLAIN if true.



816
817
818
819
820
821
822
823
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 816

def explain(opts=OPTS)
  # Load the PrettyTable class, needed for explain output
  Sequel.extension(:_pretty_table) unless defined?(Sequel::PrettyTable)

  ds = db.send(:metadata_dataset).with_sql((opts[:extended] ? 'EXPLAIN EXTENDED ' : 'EXPLAIN ') + select_sql).naked
  rows = ds.all
  Sequel::PrettyTable.string(rows, ds.columns)
end

#for_share ⇒ Object

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



826
827
828
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 826

def for_share
  lock_style(:share)
end

#full_text_search(cols, terms, opts = OPTS) ⇒ Object

Adds full text filter



831
832
833
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 831

def full_text_search(cols, terms, opts = OPTS)
  where(full_text_sql(cols, terms, opts))
end

#full_text_sql(cols, terms, opts = OPTS) ⇒ Object

MySQL specific full text search syntax.



836
837
838
839
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 836

def full_text_sql(cols, terms, opts = OPTS)
  terms = terms.join(' ') if terms.is_a?(Array)
  SQL::PlaceholderLiteralString.new((opts[:boolean] ? MATCH_AGAINST_BOOLEAN : MATCH_AGAINST), [Array(cols), terms])
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)



874
875
876
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 874

def insert_ignore
  clone(:insert_ignore=>true)
end

#join_table(type, table, expr = nil, opts = OPTS, &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:



843
844
845
846
847
848
849
850
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 843

def join_table(type, table, expr=nil, opts=OPTS, &block)
  if (type == :cross) && !expr.nil?
     Sequel::Deprecation.deprecate(":cross join type with conditions being converted to INNER JOIN on MySQL", "Use :inner join type instead")
    type = :inner
  end
  raise(Sequel::Error, "MySQL doesn't support FULL OUTER JOIN or NATURAL FULL JOIN") if type == :full_outer || type == :natural_full
  super(type, table, expr, opts, &block)
end

#join_type_sql(join_type) ⇒ Object

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



854
855
856
857
858
859
860
861
862
863
864
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 854

def join_type_sql(join_type)
  case join_type
  when :straight
    'STRAIGHT_JOIN'
  when :natural_inner
     Sequel::Deprecation.deprecate(":natural_inner join type being converted to NATURAL LEFT JOIN on MySQL", "Use :natural_left join type for NATURAL LEFT JOIN, or :natural join type for NATURAL JOIN")
    'NATURAL LEFT JOIN'
  else
    super
  end
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. If you pass a hash you can customize the values (for example, to increment a numeric field).

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)

dataset.on_duplicate_key_update(
  :value => Sequel.lit('value + VALUES(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=value + VALUES(value)



907
908
909
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 907

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

#quoted_identifier_append(sql, c) ⇒ Object

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



912
913
914
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 912

def quoted_identifier_append(sql, c)
  sql << '`' << c.to_s.gsub('`', '``') << '`'
end

#supports_derived_column_lists? ⇒ Boolean

MySQL does not support derived column lists

Returns:

  • (Boolean) 


917
918
919
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 917

def supports_derived_column_lists?
  false
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) 


923
924
925
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 923

def supports_distinct_on?
  true
end

#supports_group_rollup? ⇒ Boolean

MySQL supports GROUP BY WITH ROLLUP (but not CUBE)

Returns:

  • (Boolean) 


928
929
930
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 928

def supports_group_rollup?
  true
end

#supports_intersect_except? ⇒ Boolean

MySQL does not support INTERSECT or EXCEPT

Returns:

  • (Boolean) 


933
934
935
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 933

def supports_intersect_except?
  false
end

#supports_limits_in_correlated_subqueries? ⇒ Boolean

MySQL does not support limits in correlated subqueries (or any subqueries that use IN).

Returns:

  • (Boolean) 


938
939
940
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 938

def supports_limits_in_correlated_subqueries?
  false
end

#supports_modifying_joins? ⇒ Boolean

MySQL supports modifying joined datasets

Returns:

  • (Boolean) 


943
944
945
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 943

def supports_modifying_joins?
  true
end

#supports_ordered_distinct_on? ⇒ Boolean

MySQL’s DISTINCT ON emulation using GROUP BY does not respect the queries ORDER BY clause.

Returns:

  • (Boolean) 


949
950
951
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 949

def supports_ordered_distinct_on?
  false
end

#supports_regexp? ⇒ Boolean

MySQL supports pattern matching via regular expressions

Returns:

  • (Boolean) 


954
955
956
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 954

def supports_regexp?
  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) 


961
962
963
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 961

def supports_timestamp_usecs?
  db.supports_timestamp_usecs?
end

#update_ignore ⇒ Object

Sets up the update methods to use UPDATE IGNORE. Useful if you have a unique key and want to just skip updating rows that violate the unique key restriction.

dataset.update_ignore.update({:name => 'a', :value => 1})
# UPDATE IGNORE tablename SET name = 'a', value = 1



971
972
973
 
# File 'lib/sequel/adapters/shared/mysql.rb', line 971

def update_ignore
  clone(:update_ignore=>true)
end