Module: Sequel::MySQL::DatabaseMethods

Constant Summary

CAST_TYPES =
{String=>:CHAR, Integer=>:SIGNED, Time=>:DATETIME, DateTime=>:DATETIME, Numeric=>:DECIMAL, BigDecimal=>:DECIMAL, File=>:BINARY}.freeze
COLUMN_DEFINITION_ORDER =
[:collate, :null, :default, :unique, :primary_key, :auto_increment, :references].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#default_charsetObject

Set the default charset used for CREATE TABLE. You can pass the :charset option to create_table to override this setting.



26
27
28
# File 'lib/sequel/adapters/shared/mysql.rb', line 26

def default_charset
  @default_charset
end

#default_collateObject

Set the default collation used for CREATE TABLE. You can pass the :collate option to create_table to override this setting.



30
31
32
# File 'lib/sequel/adapters/shared/mysql.rb', line 30

def default_collate
  @default_collate
end

#default_engineObject

Set the default engine used for CREATE TABLE. You can pass the :engine option to create_table to override this setting.



34
35
36
# File 'lib/sequel/adapters/shared/mysql.rb', line 34

def default_engine
  @default_engine
end

Instance Method Details

#cast_type_literal(type) ⇒ Object

MySQL's cast rules are restrictive in that you can't just cast to any possible database type.



38
39
40
# File 'lib/sequel/adapters/shared/mysql.rb', line 38

def cast_type_literal(type)
  CAST_TYPES[type] || super
end

#commit_prepared_transaction(transaction_id, opts = OPTS) ⇒ Object



42
43
44
# File 'lib/sequel/adapters/shared/mysql.rb', line 42

def commit_prepared_transaction(transaction_id, opts=OPTS)
  run("XA COMMIT #{literal(transaction_id)}", opts)
end

#database_typeObject



46
47
48
# File 'lib/sequel/adapters/shared/mysql.rb', line 46

def database_type
  :mysql
end

#foreign_key_list(table, opts = OPTS) ⇒ Object

Use the Information Schema's KEY_COLUMN_USAGE table to get basic information on foreign key columns, but include the constraint name.



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# File 'lib/sequel/adapters/shared/mysql.rb', line 53

def foreign_key_list(table, opts=OPTS)
  m = output_identifier_meth
  im = input_identifier_meth
  ds = .
    from(Sequel[:INFORMATION_SCHEMA][:KEY_COLUMN_USAGE]).
    where(:TABLE_NAME=>im.call(table), :TABLE_SCHEMA=>Sequel.function(:DATABASE)).
    exclude(:CONSTRAINT_NAME=>'PRIMARY').
    exclude(:REFERENCED_TABLE_NAME=>nil).
    select(Sequel[:CONSTRAINT_NAME].as(:name), Sequel[:COLUMN_NAME].as(:column), Sequel[:REFERENCED_TABLE_NAME].as(:table), Sequel[:REFERENCED_COLUMN_NAME].as(:key))
  
  h = {}
  ds.each do |row|
    if r = h[row[:name]]
      r[:columns] << m.call(row[:column])
      r[:key] << m.call(row[:key])
    else
      h[row[:name]] = {:name=>m.call(row[:name]), :columns=>[m.call(row[:column])], :table=>m.call(row[:table]), :key=>[m.call(row[:key])]}
    end
  end
  h.values
end

#freezeObject



75
76
77
78
79
# File 'lib/sequel/adapters/shared/mysql.rb', line 75

def freeze
  server_version
  supports_timestamp_usecs?
  super
end

#global_index_namespace?Boolean

MySQL namespaces indexes per table.

Returns:

  • (Boolean)


82
83
84
# File 'lib/sequel/adapters/shared/mysql.rb', line 82

def global_index_namespace?
  false
end

#indexes(table, opts = OPTS) ⇒ Object

Use SHOW INDEX FROM to get the index information for the table.

By default partial indexes are not included, you can use the option :partial to override this.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
# File 'lib/sequel/adapters/shared/mysql.rb', line 91

def indexes(table, opts=OPTS)
  indexes = {}
  remove_indexes = []
  m = output_identifier_meth
  schema, table = schema_and_table(table)

  table = Sequel::SQL::Identifier.new(table)
  sql = "SHOW INDEX FROM #{literal(table)}"
  if schema
    schema = Sequel::SQL::Identifier.new(schema)
    sql += " FROM #{literal(schema)}"
  end

  .with_sql(sql).each do |r|
    name = r[:Key_name]
    next if name == 'PRIMARY'
    name = m.call(name)
    remove_indexes << name if r[:Sub_part] && ! opts[:partial]
    i = indexes[name] ||= {:columns=>[], :unique=>r[:Non_unique] != 1}
    i[:columns] << m.call(r[:Column_name])
  end
  indexes.reject{|k,v| remove_indexes.include?(k)}
end

#rollback_prepared_transaction(transaction_id, opts = OPTS) ⇒ Object



115
116
117
# File 'lib/sequel/adapters/shared/mysql.rb', line 115

def rollback_prepared_transaction(transaction_id, opts=OPTS)
  run("XA ROLLBACK #{literal(transaction_id)}", opts)
end

#server_versionObject

Get version of MySQL server, used for determined capabilities.



120
121
122
123
124
125
# File 'lib/sequel/adapters/shared/mysql.rb', line 120

def server_version
  @server_version ||= begin
    m = /(\d+)\.(\d+)\.(\d+)/.match(get(SQL::Function.new(:version)))
    (m[1].to_i * 10000) + (m[2].to_i * 100) + m[3].to_i
  end
end

#supports_create_table_if_not_exists?Boolean

MySQL supports CREATE TABLE IF NOT EXISTS syntax.

Returns:

  • (Boolean)


128
129
130
# File 'lib/sequel/adapters/shared/mysql.rb', line 128

def supports_create_table_if_not_exists?
  true
end

#supports_prepared_transactions?Boolean

MySQL 5+ supports prepared transactions (two-phase commit) using XA

Returns:

  • (Boolean)


133
134
135
# File 'lib/sequel/adapters/shared/mysql.rb', line 133

def supports_prepared_transactions?
  server_version >= 50000
end

#supports_savepoints?Boolean

MySQL 5+ supports savepoints

Returns:

  • (Boolean)


138
139
140
# File 'lib/sequel/adapters/shared/mysql.rb', line 138

def supports_savepoints?
  server_version >= 50000
end

#supports_savepoints_in_prepared_transactions?Boolean

MySQL doesn't support savepoints inside prepared transactions in from 5.5.12 to 5.5.23, see bugs.mysql.com/bug.php?id=64374

Returns:

  • (Boolean)


144
145
146
# File 'lib/sequel/adapters/shared/mysql.rb', line 144

def supports_savepoints_in_prepared_transactions?
  super && (server_version <= 50512 || server_version >= 50523)
end

#supports_timestamp_usecs?Boolean

Support fractional timestamps on MySQL 5.6.5+ if the :fractional_seconds Database option is used. Technically, MySQL 5.6.4+ supports them, but automatic initialization of datetime values wasn't supported to 5.6.5+, and this is related to that.

Returns:

  • (Boolean)


152
153
154
155
# File 'lib/sequel/adapters/shared/mysql.rb', line 152

def supports_timestamp_usecs?
  return @supports_timestamp_usecs if defined?(@supports_timestamp_usecs)
  @supports_timestamp_usecs = server_version >= 50605 && typecast_value_boolean(opts[:fractional_seconds])
end

#supports_transaction_isolation_levels?Boolean

MySQL supports transaction isolation levels

Returns:

  • (Boolean)


158
159
160
# File 'lib/sequel/adapters/shared/mysql.rb', line 158

def supports_transaction_isolation_levels?
  true
end

#tables(opts = OPTS) ⇒ Object

Return an array of symbols specifying table names in the current database.

Options:

:server

Set the server to use



166
167
168
# File 'lib/sequel/adapters/shared/mysql.rb', line 166

def tables(opts=OPTS)
  full_tables('BASE TABLE', opts)
end

#views(opts = OPTS) ⇒ Object

Return an array of symbols specifying view names in the current database.

Options:

:server

Set the server to use



174
175
176
# File 'lib/sequel/adapters/shared/mysql.rb', line 174

def views(opts=OPTS)
  full_tables('VIEW', opts)
end