Class: Mysql

Inherits:
Object
  • Object
show all
Defined in:
lib/og/vendor/mysql.rb,
lib/og/adapter/mysql/override.rb

Overview

– Customize the standard MySQL driver objects to make more compatible with Og. ++

Defined Under Namespace

Classes: Error, Field, Net, Random, Result

Constant Summary collapse

VERSION = 
"4.0-ruby-0.2.5"
MAX_PACKET_LENGTH = 
256*256*256-1
MAX_ALLOWED_PACKET = 
1024*1024*1024
MYSQL_UNIX_ADDR = 
"/tmp/mysql.sock"
MYSQL_PORT = 
3306
PROTOCOL_VERSION = 
10
COM_SLEEP =

Command

0
COM_QUIT = 
1
COM_INIT_DB = 
2
COM_QUERY = 
3
COM_FIELD_LIST = 
4
COM_CREATE_DB = 
5
COM_DROP_DB = 
6
COM_REFRESH = 
7
COM_SHUTDOWN = 
8
COM_STATISTICS = 
9
COM_PROCESS_INFO = 
10
COM_CONNECT = 
11
COM_PROCESS_KILL = 
12
COM_DEBUG = 
13
COM_PING = 
14
COM_TIME = 
15
COM_DELAYED_INSERT = 
16
COM_CHANGE_USER = 
17
COM_BINLOG_DUMP = 
18
COM_TABLE_DUMP = 
19
COM_CONNECT_OUT = 
20
COM_REGISTER_SLAVE = 
21
CLIENT_LONG_PASSWORD =

Client flag

1
CLIENT_FOUND_ROWS = 
1 << 1
CLIENT_LONG_FLAG = 
1 << 2
CLIENT_CONNECT_WITH_DB = 
1 << 3
CLIENT_NO_SCHEMA = 
1 << 4
CLIENT_COMPRESS = 
1 << 5
CLIENT_ODBC = 
1 << 6
CLIENT_LOCAL_FILES = 
1 << 7
CLIENT_IGNORE_SPACE = 
1 << 8
CLIENT_PROTOCOL_41 = 
1 << 9
CLIENT_INTERACTIVE = 
1 << 10
CLIENT_SSL = 
1 << 11
CLIENT_IGNORE_SIGPIPE = 
1 << 12
CLIENT_TRANSACTIONS = 
1 << 13
CLIENT_RESERVED = 
1 << 14
CLIENT_SECURE_CONNECTION = 
1 << 15
CLIENT_CAPABILITIES = 
CLIENT_LONG_PASSWORD|CLIENT_LONG_FLAG|CLIENT_TRANSACTIONS
PROTO_AUTH41 = 
CLIENT_PROTOCOL_41 | CLIENT_SECURE_CONNECTION
OPT_CONNECT_TIMEOUT =

Connection Option

0
OPT_COMPRESS = 
1
OPT_NAMED_PIPE = 
2
INIT_COMMAND = 
3
READ_DEFAULT_FILE = 
4
READ_DEFAULT_GROUP = 
5
SET_CHARSET_DIR = 
6
SET_CHARSET_NAME = 
7
OPT_LOCAL_INFILE = 
8
SERVER_STATUS_IN_TRANS =

Server Status

1
SERVER_STATUS_AUTOCOMMIT = 
2
REFRESH_GRANT =

Refresh parameter

1
REFRESH_LOG = 
2
REFRESH_TABLES = 
4
REFRESH_HOSTS = 
8
REFRESH_STATUS = 
16
REFRESH_THREADS = 
32
REFRESH_SLAVE = 
64
REFRESH_MASTER = 
128

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ Mysql

Returns a new instance of Mysql.



90
91
92
93
94
95
96
97
98
 
# File 'lib/og/vendor/mysql.rb', line 90

def initialize(*args)
  @client_flag = 0
  @max_allowed_packet = MAX_ALLOWED_PACKET
  @query_with_result = true
  @status = :STATUS_READY
  if args[0] != :INIT then
    real_connect(*args)
  end
end

Instance Attribute Details

#affected_rows ⇒ Object (readonly)

Returns the value of attribute affected_rows.



342
343
344
 
# File 'lib/og/vendor/mysql.rb', line 342

def affected_rows
  @affected_rows
end

#field_count ⇒ Object (readonly)

Returns the value of attribute field_count.



342
343
344
 
# File 'lib/og/vendor/mysql.rb', line 342

def field_count
  @field_count
end

#info ⇒ Object (readonly)

Returns the value of attribute info.



342
343
344
 
# File 'lib/og/vendor/mysql.rb', line 342

def info
  @info
end

#insert_id ⇒ Object (readonly)

Returns the value of attribute insert_id.



342
343
344
 
# File 'lib/og/vendor/mysql.rb', line 342

def insert_id
  @insert_id
end

#query_with_result ⇒ Object

Returns the value of attribute query_with_result.



343
344
345
 
# File 'lib/og/vendor/mysql.rb', line 343

def query_with_result
  @query_with_result
end

#status ⇒ Object

Returns the value of attribute status.



343
344
345
 
# File 'lib/og/vendor/mysql.rb', line 343

def status
  @status
end

#thread_id ⇒ Object (readonly)

Returns the value of attribute thread_id.



342
343
344
 
# File 'lib/og/vendor/mysql.rb', line 342

def thread_id
  @thread_id
end

Class Method Details

.debug(str) ⇒ Object 



1184
1185
1186
 
# File 'lib/og/vendor/mysql.rb', line 1184

def debug(str)
  raise "not implemented"
end

.escape_string(str) ⇒ Object Also known as: quote 



1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
 
# File 'lib/og/vendor/mysql.rb', line 1166

def escape_string(str)
  str.gsub(/([\0\n\r\032\'\"\\])/) do
    case $1
    when "\0" then "\\0"
    when "\n" then "\\n"
    when "\r" then "\\r"
    when "\032" then "\\Z"
    else "\\"+$1
    end
  end
end

.finalizer(net) ⇒ Object 



1159
1160
1161
1162
1163
1164
 
# File 'lib/og/vendor/mysql.rb', line 1159

def finalizer(net)
  proc {
    net.clear
    net.write Mysql::COM_QUIT.chr
  }
end

.get_client_info ⇒ Object Also known as: client_info 



1179
1180
1181
 
# File 'lib/og/vendor/mysql.rb', line 1179

def get_client_info()
  Mysql::VERSION
end

.init ⇒ Object 



1150
1151
1152
 
# File 'lib/og/vendor/mysql.rb', line 1150

def init()
  Mysql::new :INIT
end

.real_connect(*args) ⇒ Object Also known as: connect 



1154
1155
1156
 
# File 'lib/og/vendor/mysql.rb', line 1154

def real_connect(*args)
  Mysql::new(*args)
end

Instance Method Details

#change_user(user = "", passwd = "", db = "") ⇒ Object 



205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/og/vendor/mysql.rb', line 205

def change_user(user="", passwd="", db="")
  if @pre_411
    data = user+"\0"+scramble(passwd, @scramble_buff, @protocol_version==9)+"\0"+db
  else
    data = user+"\0"+scramble41(passwd, @scramble_buff)+db
  end
  command COM_CHANGE_USER, data
  @user = user
  @passwd = passwd
  @db = db
end

#character_set_name ⇒ Object 



217
218
219
 
# File 'lib/og/vendor/mysql.rb', line 217

def character_set_name()
  raise "not implemented"
end

#client_info ⇒ Object 



164
165
166
 
# File 'lib/og/vendor/mysql.rb', line 164

def get_client_info()
  VERSION
end

#close ⇒ Object 



221
222
223
224
225
226
 
# File 'lib/og/vendor/mysql.rb', line 221

def close()
  @status = :STATUS_READY
  command COM_QUIT, nil, true
  @net.close
  self
end

#connect ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/og/vendor/mysql.rb', line 154

def real_connect(host=nil, user=nil, passwd=nil, db=nil, port=nil, socket=nil, flag=nil)
  @server_status = SERVER_STATUS_AUTOCOMMIT
  if (host == nil or host == "localhost") and defined? UNIXSocket then
    unix_socket = socket || ENV["MYSQL_UNIX_PORT"] || MYSQL_UNIX_ADDR
    sock = UNIXSocket::new(unix_socket)
    @host_info = Error::err(Error::CR_LOCALHOST_CONNECTION)
    @unix_socket = unix_socket
  else      
    sock = TCPSocket::new(host, port||ENV["MYSQL_TCP_PORT"]||(Socket::getservbyname("mysql","tcp") rescue MYSQL_PORT))
    @host_info = sprintf Error::err(Error::CR_TCP_CONNECTION), host
  end
  @host = host ? host.dup : nil
  sock.setsockopt Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true
  @net = Net::new sock

  a = read
  @protocol_version = a.slice!(0)
  @server_version, a = a.split(/\0/,2)
  @thread_id, @scramble_buff = a.slice!(0,13).unpack("La8")
  if a.size >= 2 then
    @server_capabilities, = a.slice!(0,2).unpack("v")
  end
  if a.size >= 16 then
    @server_language, @server_status = a.slice!(0,3).unpack("cv")
  end

  flag = 0 if flag == nil
  flag |= @client_flag | CLIENT_CAPABILITIES
  flag |= CLIENT_CONNECT_WITH_DB if db

  @pre_411 = (0 == @server_capabilities & PROTO_AUTH41)
  if @pre_411
    data = Net::int2str(flag)+Net::int3str(@max_allowed_packet)+
           (user||"")+"\0"+
                 scramble(passwd, @scramble_buff, @protocol_version==9)
  else
    dummy, @salt2 = a.unpack("a13a12")
    @scramble_buff += @salt2
    flag |= PROTO_AUTH41
    data = Net::int4str(flag) + Net::int4str(@max_allowed_packet) +
           ([8] + Array.new(23, 0)).pack("c24") + (user||"")+"\0"+
           scramble41(passwd, @scramble_buff)
  end

  if db and @server_capabilities & CLIENT_CONNECT_WITH_DB != 0
    data << "\0" if @pre_411
    data << db
    @db = db.dup
  end
  write data
  read
  ObjectSpace.define_finalizer(self, Mysql.finalizer(@net))
  self
end

#create_db(db) ⇒ Object 



228
229
230
231
 
# File 'lib/og/vendor/mysql.rb', line 228

def create_db(db)
  command COM_CREATE_DB, db
  self
end

#drop_db(db) ⇒ Object 



233
234
235
236
 
# File 'lib/og/vendor/mysql.rb', line 233

def drop_db(db)
  command COM_DROP_DB, db
  self
end

#dump_debug_info ⇒ Object 



238
239
240
241
 
# File 'lib/og/vendor/mysql.rb', line 238

def dump_debug_info()
  command COM_DEBUG
  self
end

#escape_string(str) ⇒ Object 



156
157
158
 
# File 'lib/og/vendor/mysql.rb', line 156

def escape_string(str)
  Mysql::escape_string str
end

#get_client_info ⇒ Object 



161
162
163
 
# File 'lib/og/vendor/mysql.rb', line 161

def get_client_info()
  VERSION
end

#get_host_info ⇒ Object Also known as: host_info 



243
244
245
 
# File 'lib/og/vendor/mysql.rb', line 243

def get_host_info()
  @host_info
end

#get_proto_info ⇒ Object Also known as: proto_info 



248
249
250
 
# File 'lib/og/vendor/mysql.rb', line 248

def get_proto_info()
  @protocol_version
end

#get_server_info ⇒ Object Also known as: server_info 



253
254
255
 
# File 'lib/og/vendor/mysql.rb', line 253

def get_server_info()
  @server_version
end

#inspect ⇒ Object 



374
375
376
 
# File 'lib/og/vendor/mysql.rb', line 374

def inspect()
  "#<#{self.class}>"
end

#kill(id) ⇒ Object 



258
259
260
261
 
# File 'lib/og/vendor/mysql.rb', line 258

def kill(id)
  command COM_PROCESS_KILL, Net::int4str(id)
  self
end

#list_dbs(db = nil) ⇒ Object 



263
264
265
266
267
 
# File 'lib/og/vendor/mysql.rb', line 263

def list_dbs(db=nil)
  real_query "show databases #{db}"
  @status = :STATUS_READY
  read_rows(1).flatten
end

#list_fields(table, field = nil) ⇒ Object 



269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/og/vendor/mysql.rb', line 269

def list_fields(table, field=nil)
  command COM_FIELD_LIST, "#{table}\0#{field}", true
  if @pre_411
    f = read_rows 6
  else
    f = read_rows 7
  end
  fields = unpack_fields(f, @server_capabilities & CLIENT_LONG_FLAG != 0)
  res = Result::new self, fields, f.length
  res.eof = true
  res
end

#list_processes ⇒ Object 



282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/og/vendor/mysql.rb', line 282

def list_processes()
  data = command COM_PROCESS_INFO
  @field_count = get_length data
  if @pre_411
    fields = read_rows 5
  else
    fields = read_rows 7
  end
  @fields = unpack_fields(fields, @server_capabilities & CLIENT_LONG_FLAG != 0)
  @status = :STATUS_GET_RESULT
  store_result
end

#list_tables(table = nil) ⇒ Object 



295
296
297
298
299
 
# File 'lib/og/vendor/mysql.rb', line 295

def list_tables(table=nil)
  real_query "show tables #{table}"
  @status = :STATUS_READY
  read_rows(1).flatten
end

#options(option, arg = nil) ⇒ Object 



166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/og/vendor/mysql.rb', line 166

def options(option, arg=nil)
  if option == OPT_LOCAL_INFILE then
    if arg == false or arg == 0 then
@client_flag &= ~CLIENT_LOCAL_FILES
    else
@client_flag |= CLIENT_LOCAL_FILES
    end
  else
    raise "not implemented"
  end
end

#ping ⇒ Object 



301
302
303
304
 
# File 'lib/og/vendor/mysql.rb', line 301

def ping()
  command COM_PING
  self
end

#query(query) ⇒ Object 



306
307
308
309
310
311
312
313
314
315
 
# File 'lib/og/vendor/mysql.rb', line 306

def query(query)
  real_query query
  if not @query_with_result then
    return self
  end
  if @field_count == 0 then
    return nil
  end
  store_result
end

#quote ⇒ Object 



159
160
161
 
# File 'lib/og/vendor/mysql.rb', line 159

def escape_string(str)
  Mysql::escape_string str
end

#read_one_row(field_count) ⇒ Object 



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/og/vendor/mysql.rb', line 345

def read_one_row(field_count)
  data = read
  if data[0] == 254 and data.length == 1 ## EOF
    return
  elsif data[0] == 254 and data.length == 5
    return
  end
  rec = []
  field_count.times do
    len = get_length data
    if len == nil then
rec << len
    else
rec << data.slice!(0,len)
    end
  end
  rec
end

#real_connect(host = nil, user = nil, passwd = nil, db = nil, port = nil, socket = nil, flag = nil) ⇒ Object 



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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/og/vendor/mysql.rb', line 100

def real_connect(host=nil, user=nil, passwd=nil, db=nil, port=nil, socket=nil, flag=nil)
  @server_status = SERVER_STATUS_AUTOCOMMIT
  if (host == nil or host == "localhost") and defined? UNIXSocket then
    unix_socket = socket || ENV["MYSQL_UNIX_PORT"] || MYSQL_UNIX_ADDR
    sock = UNIXSocket::new(unix_socket)
    @host_info = Error::err(Error::CR_LOCALHOST_CONNECTION)
    @unix_socket = unix_socket
  else      
    sock = TCPSocket::new(host, port||ENV["MYSQL_TCP_PORT"]||(Socket::getservbyname("mysql","tcp") rescue MYSQL_PORT))
    @host_info = sprintf Error::err(Error::CR_TCP_CONNECTION), host
  end
  @host = host ? host.dup : nil
  sock.setsockopt Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true
  @net = Net::new sock

  a = read
  @protocol_version = a.slice!(0)
  @server_version, a = a.split(/\0/,2)
  @thread_id, @scramble_buff = a.slice!(0,13).unpack("La8")
  if a.size >= 2 then
    @server_capabilities, = a.slice!(0,2).unpack("v")
  end
  if a.size >= 16 then
    @server_language, @server_status = a.slice!(0,3).unpack("cv")
  end

  flag = 0 if flag == nil
  flag |= @client_flag | CLIENT_CAPABILITIES
  flag |= CLIENT_CONNECT_WITH_DB if db

  @pre_411 = (0 == @server_capabilities & PROTO_AUTH41)
  if @pre_411
    data = Net::int2str(flag)+Net::int3str(@max_allowed_packet)+
           (user||"")+"\0"+
                 scramble(passwd, @scramble_buff, @protocol_version==9)
  else
    dummy, @salt2 = a.unpack("a13a12")
    @scramble_buff += @salt2
    flag |= PROTO_AUTH41
    data = Net::int4str(flag) + Net::int4str(@max_allowed_packet) +
           ([8] + Array.new(23, 0)).pack("c24") + (user||"")+"\0"+
           scramble41(passwd, @scramble_buff)
  end

  if db and @server_capabilities & CLIENT_CONNECT_WITH_DB != 0
    data << "\0" if @pre_411
    data << db
    @db = db.dup
  end
  write data
  read
  ObjectSpace.define_finalizer(self, Mysql.finalizer(@net))
  self
end

#real_query(query) ⇒ Object 



178
179
180
181
182
 
# File 'lib/og/vendor/mysql.rb', line 178

def real_query(query)
  command COM_QUERY, query, true
  read_query_result
  self
end

#refresh(r) ⇒ Object 



317
318
319
320
 
# File 'lib/og/vendor/mysql.rb', line 317

def refresh(r)
  command COM_REFRESH, r.chr
  self
end

#reload ⇒ Object 



322
323
324
325
 
# File 'lib/og/vendor/mysql.rb', line 322

def reload()
  refresh REFRESH_GRANT
  self
end

#select_db(db) ⇒ Object 



327
328
329
330
331
 
# File 'lib/og/vendor/mysql.rb', line 327

def select_db(db)
  command COM_INIT_DB, db
  @db = db
  self
end

#shutdown ⇒ Object 



333
334
335
336
 
# File 'lib/og/vendor/mysql.rb', line 333

def shutdown()
  command COM_SHUTDOWN
  self
end

#skip_result ⇒ Object 



364
365
366
367
368
369
370
371
372
 
# File 'lib/og/vendor/mysql.rb', line 364

def skip_result()
  if @status == :STATUS_USE_RESULT then
    loop do
data = read
break if data[0] == 254 and data.length == 1
    end
    @status = :STATUS_READY
  end
end

#stat ⇒ Object 



338
339
340
 
# File 'lib/og/vendor/mysql.rb', line 338

def stat()
  command COM_STATISTICS
end

#store_result ⇒ Object 



193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/og/vendor/mysql.rb', line 193

def store_result()
  if @status != :STATUS_GET_RESULT then
    error Error::CR_COMMANDS_OUT_OF_SYNC
  end
  @status = :STATUS_READY
  data = read_rows @field_count
  res = Result::new self, @fields, @field_count, data
  @fields = nil
  @affected_rows = data.length
  res
end

#use_result ⇒ Object 



184
185
186
187
188
189
190
191
 
# File 'lib/og/vendor/mysql.rb', line 184

def use_result()
  if @status != :STATUS_GET_RESULT then
    error Error::CR_COMMANDS_OUT_OF_SYNC
  end
  res = Result::new self, @fields, @field_count
  @status = :STATUS_USE_RESULT
  res
end