Class: Baza::Driver::Mysql::Table

Inherits:
Table
  • Object
show all
Defined in:
lib/baza/driver/mysql/table.rb

Instance Attribute Summary collapse

Attributes inherited from Table

#db

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Table

#<=>, #create_columns, #insert, #inspect, #row, #rows, #rows_count, #to_param, #to_s, #truncate, #upsert_duplicate_key

Methods included from Baza::DatabaseModelFunctionality

#model_name, #to_model

Constructor Details

#initialize(args) ⇒ Table

Returns a new instance of Table.



4
5
6
7
8
9
10
11
 
# File 'lib/baza/driver/mysql/table.rb', line 4

def initialize(args)
  @db = args.fetch(:db)
  @data = args.fetch(:data)
  @list = Wref::Map.new
  @indexes_list = Wref::Map.new
  @name = @data.fetch(:TABLE_NAME)
  @tables = args.fetch(:tables)
end

Instance Attribute Details

#list ⇒ Object (readonly)

Returns the value of attribute list.



2
3
4
 
# File 'lib/baza/driver/mysql/table.rb', line 2

def list
  @list
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



2
3
4
 
# File 'lib/baza/driver/mysql/table.rb', line 2

def name
  @name
end

Class Method Details

.create_indexes(index_arr, args = {}) ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/baza/driver/mysql/table.rb', line 192

def self.create_indexes(index_arr, args = {})
  db = args[:db]

  if args[:return_sql]
    sql = ""
    first = true
  end

  index_arr.each do |index_data|
    sql = "" unless args[:return_sql]

    sql << "CREATE" if args[:create] || !args.key?(:create)

    if index_data.is_a?(String) || index_data.is_a?(Symbol)
      index_data = {name: index_data, columns: [index_data]}
    end

    raise "No name was given: '#{index_data}'." if !index_data.key?(:name) || index_data[:name].to_s.strip.empty?
    raise "No columns was given on index: '#{index_data.fetch(:name)}'." if !index_data[:columns] || index_data[:columns].empty?

    if args[:return_sql]
      if first
        first = false
      else
        sql << ", "
      end
    end

    sql << " UNIQUE" if index_data[:unique]
    sql << " INDEX #{db.sep_index}#{db.escape_index(index_data.fetch(:name))}#{db.sep_index}"

    if args[:on_table] || !args.key?(:on_table)
      sql << " ON #{db.sep_table}#{db.escape_table(args.fetch(:table_name))}#{db.sep_table}"
    end

    sql << " ("

    first = true
    index_data[:columns].each do |col_name|
      sql << ", " unless first
      first = false if first

      sql << "#{db.sep_col}#{db.escape_column(col_name)}#{db.sep_col}"
    end

    sql << ")"

    db.query(sql) unless args[:return_sql]
  end

  sql if args[:return_sql]
end

Instance Method Details

#__object_unique_id__ ⇒ Object

Used to validate in Wref::Map.



25
26
27
 
# File 'lib/baza/driver/mysql/table.rb', line 25

def __object_unique_id__
  name
end

#clone(newname, args = {}) ⇒ Object 



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/baza/driver/mysql/table.rb', line 283

def clone(newname, args = {})
  raise "Invalid name." if newname.to_s.strip.empty?

  sql = "CREATE TABLE #{@db.sep_table}#{@db.escape_table(newname)}#{@db.sep_table} ("
  first = true
  pkey_found = false
  pkeys = []

  columns do |col|
    sql << ", " unless first
    first = false if first

    col_data = col.data
    pkey_found = true if !pkey_found && col_data[:primarykey] && args[:force_single_pkey]

    if args[:no_pkey] || (pkey_found && col_data[:primarykey] && args[:force_single_pkey])
      col_data[:primarykey] = false
    end

    if col_data[:primarykey]
      pkeys << col_data[:name]
      col_data.delete(:primarykey)
    end

    col_data[:storage] = args[:all_cols_storage] if args[:all_cols_storage]

    sql << @db.columns.data_sql(col_data)
  end

  unless pkeys.empty?
    sql << ", PRIMARY KEY ("

    first = true
    pkeys.each do |pkey|
      sql << ", " unless first
      first = false if first
      sql << "#{@db.sep_col}#{@db.escape_column(pkey)}#{@db.sep_col}"
    end

    sql << ")"
  end

  sql << ")"
  sql << " TABLESPACE #{args[:tablespace]}" if args[:tablespace]
  sql << " ENGINE=#{args[:engine]}" if args[:engine]
  sql << ";"

  # Create table.
  @db.query(sql)


  # Insert data of previous data in a single query.
  @db.query("INSERT INTO #{@db.sep_table}#{@db.escape_table(newname)}#{@db.sep_table} SELECT * FROM #{@db.sep_table}#{@db.escape_table(name)}#{@db.sep_table}")


  # Create indexes.
  new_table = @db.tables[newname]
  indexes_list = []
  indexes do |index|
    indexes_list << index.data unless index.primary?
  end

  new_table.create_indexes(indexes_list)


  # Return new table.
  new_table
end

#column(name) ⇒ Object

Raises:



52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/baza/driver/mysql/table.rb', line 52

def column(name)
  name = name.to_s

  col = @list.get(name)
  return col if col

  columns(name: name) do |col_i|
    return col_i if col_i.name == name
  end

  raise Baza::Errors::ColumnNotFound, "Column not found: '#{name}'"
end

#columns(args = nil) ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/baza/driver/mysql/table.rb', line 65

def columns(args = nil)
  @db.columns
  ret = []
  sql = "SHOW FULL COLUMNS FROM `#{@db.escape_table(name)}`"
  sql << " WHERE `Field` = '#{@db.esc(args.fetch(:name))}'" if args && args.key?(:name)

  @db.q(sql) do |d_cols|
    column_name = d_cols.fetch(:Field)
    obj = @list.get(name)

    unless obj
      obj = Baza::Driver::Mysql::Column.new(
        table_name: name,
        db: @db,
        data: d_cols
      )
      @list[column_name] = obj
    end

    if block_given?
      yield obj
    else
      ret << obj
    end
  end

  if block_given?
    return nil
  else
    return ret
  end
end

#create_indexes(index_arr, args = {}) ⇒ Object 



188
189
190
 
# File 'lib/baza/driver/mysql/table.rb', line 188

def create_indexes(index_arr, args = {})
  Baza::Driver::Mysql::Table.create_indexes(index_arr, args.merge(table_name: name, db: @db))
end

#data ⇒ Object 



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/baza/driver/mysql/table.rb', line 265

def data
  ret = {
    name: name,
    columns: [],
    indexes: []
  }

  columns do |column|
    ret[:columns] << column.data
  end

  indexes do |index|
    ret[:indexes] << index.data unless index.name == "PRIMARY"
  end

  ret
end

#database_name ⇒ Object 



20
21
22
 
# File 'lib/baza/driver/mysql/table.rb', line 20

def database_name
  @data.fetch(:TABLE_SCHEMA)
end

#drop ⇒ Object 



29
30
31
32
33
34
35
36
37
38
 
# File 'lib/baza/driver/mysql/table.rb', line 29

def drop
  raise "Cant drop native table: '#{name}'" if native?

  @db.with_database(database_name) do
    @db.query("DROP TABLE `#{@db.escape_table(name)}`")
  end

  @tables.__send__(:remove_from_list, self)
  nil
end

#engine ⇒ Object

Returns the current engine of the table.



353
354
355
 
# File 'lib/baza/driver/mysql/table.rb', line 353

def engine
  @data.fetch(:ENGINE)
end

#engine=(newengine) ⇒ Object

Changes the engine for a table.



358
359
360
361
362
 
# File 'lib/baza/driver/mysql/table.rb', line 358

def engine=(newengine)
  raise "Invalid engine: '#{newengine}'." unless newengine.to_s =~ /^[A-z]+$/
  @db.query("ALTER TABLE `#{@db.escape_table(name)}` ENGINE = #{newengine}") if engine.to_s != newengine.to_s
  @data[:ENGINE] = newengine
end

#foreign_key(name) ⇒ Object

Raises:



135
136
137
138
139
140
141
 
# File 'lib/baza/driver/mysql/table.rb', line 135

def foreign_key(name)
  foreign_keys(name: name) do |foreign_key|
    return foreign_key
  end

  raise Baza::Errors::ForeignKeyNotFound, "Foreign key not found: #{name}"
end

#foreign_keys(args = {}) ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/baza/driver/mysql/table.rb', line 98

def foreign_keys(args = {})
  sql = "
    SELECT
      TABLE_NAME,
      COLUMN_NAME,
      CONSTRAINT_NAME,
      REFERENCED_TABLE_NAME,
      REFERENCED_COLUMN_NAME

    FROM
      INFORMATION_SCHEMA.KEY_COLUMN_USAGE

    WHERE
      REFERENCED_TABLE_SCHEMA = '#{@db.escape_database(@db.current_database_name)}' AND
      TABLE_NAME = '#{@db.escape_table(name)}'
  "

  sql << " AND CONSTRAINT_NAME = '#{@db.escape(args.fetch(:name))}'" if args[:name]

  result = [] unless block_given?

  @db.query(sql) do |data|
    foreign_key = Baza::Driver::Mysql::ForeignKey.new(
      db: @db,
      data: data
    )

    if block_given?
      yield foreign_key
    else
      result << foreign_key
    end
  end

  result
end

#index(name) ⇒ Object

Raises:



175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/baza/driver/mysql/table.rb', line 175

def index(name)
  name = name.to_s

  index = @indexes_list.get(name)
  return index if index

  indexes(name: name) do |index_i|
    return index_i if index_i.name == name
  end

  raise Baza::Errors::IndexNotFound, "Index not found: #{name}."
end

#indexes(args = nil, &blk) ⇒ Object 



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/baza/driver/mysql/table.rb', line 143

def indexes(args = nil, &blk)
  ret = {}

  sql = "SHOW INDEX FROM `#{@db.escape_table(name)}`"
  sql << " WHERE `Key_name` = '#{@db.esc(args.fetch(:name))}'" if args && args.key?(:name)

  @db.query(sql) do |d_indexes|
    next if d_indexes[:Key_name] == "PRIMARY"

    index_name = d_indexes.fetch(:Key_name)
    obj = @indexes_list.get(index_name)

    unless obj
      obj = Baza::Driver::Mysql::Index.new(
        table_name: name,
        db: @db,
        data: d_indexes
      )
      @indexes_list[index_name] = obj
    end

    obj.columns << d_indexes.fetch(:Column_name) unless obj.columns.include?(d_indexes.fetch(:Column_name))
    ret[obj.name] = obj unless ret.key?(obj.name)
  end

  if blk
    ret.values.each(&blk)
  else
    return ret.values
  end
end

#native? ⇒ Boolean

Returns true if the table is safe to drop.

Returns:

  • (Boolean) 


41
42
43
44
45
 
# File 'lib/baza/driver/mysql/table.rb', line 41

def native?
  data = @db.q("SELECT DATABASE() AS db").fetch
  return true if data.fetch(:db) == "mysql"
  false
end

#optimize ⇒ Object 



47
48
49
50
 
# File 'lib/baza/driver/mysql/table.rb', line 47

def optimize
  @db.query("OPTIMIZE TABLE `#{@db.escape_table(name)}`")
  self
end

#reload ⇒ Object

Raises:



13
14
15
16
17
18
 
# File 'lib/baza/driver/mysql/table.rb', line 13

def reload
  data = @db.single([:information_schema, :tables], "TABLE_SCHEMA" => database_name, "TABLE_NAME" => name)
  raise Baza::Errors::TableNotFound unless data
  @data = data
  self
end

#rename(newname) ⇒ Object 



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/baza/driver/mysql/table.rb', line 245

def rename(newname)
  newname = newname.to_s
  oldname = name

  @tables.__send__(:remove_from_list, self)
  @db.query("ALTER TABLE `#{@db.escape_table(oldname)}` RENAME TO `#{@db.escape_table(newname)}`")

  @data[:name] = newname
  @name = newname
  @tables.__send__(:add_to_list, self)

  @list.each do |_name, column|
    column.args[:table_name] = newname
  end

  @indexes_list.each do |_name, index|
    index.table_name = newname
  end
end