Ruby使用Mysql2連接操作MySQL

更新時間：2022年04月18日 15:44:14 作者：駿馬金龍

這篇文章主要介紹了Ruby使用Mysql2連接操作MySQL,需要的朋友可以參考下

Ruby操作MySQL

使用mysql2連接mysql并操作mysql。相關(guān)文檔參見：

https://www.rubydoc.info/gems/mysql2/0.5.2
https://github.com/brianmario/mysql2

gem install mysql2

連接mysql

建立連接：

require 'mysql2'

conn = Mysql2::Client.new({ 
  host: '192.168.200.73',
  username: 'root',
  password: 'P@ssword1!'
})

接受的連接選項包括：

Mysql2::Client.new(
  :host,
  :username,
  :password,
  :port,
  :database,
  :socket = '/path/to/mysql.sock',
  :flags = REMEMBER_OPTIONS | LONG_PASSWORD | LONG_FLAG | TRANSACTIONS | PROTOCOL_41 | SECURE_CONNECTION | MULTI_STATEMENTS,
  :encoding = 'utf8',
  :read_timeout = seconds,
  :write_timeout = seconds,
  :connect_timeout = seconds,
  :connect_attrs = {:program_name => $PROGRAM_NAME, ...},
  :reconnect = true/false,
  :local_infile = true/false,
  :secure_auth = true/false,
  :ssl_mode = :disabled / :preferred / :required / :verify_ca / :verify_identity,
  :default_file = '$HOME/.my.cnf',   #=> 從文件讀取連接信息
  :default_group = 'my.cfg section', #=> 選擇.my.cnf中的section
  :default_auth = 'authentication_windows_client',
  :init_command => SQL_Statement  #=>主要用于設(shè)置本次連接時的某些變量
)

連接建立后就可以操作數(shù)據(jù)庫了，比如執(zhí)行SQL語句：

conn. query('create databse mytest')
conn.select_ db( 'mytest' )
# conn.query('use mytest' )
conn. query('create table tb(name varchar(1024),age int)')
conn. query <<-SQL
    insert into tb values 
    ('junmajinlong', 23), 
    ( 'woniu', 25),
    ('fairy', 26)
SQL

如果測試和mysql的連接是否斷開，可執(zhí)行ping()：

conn.ping

如果連接未斷開，ping()返回true，如果連接已斷開但已啟用auto-reconnect，則ping()會嘗試依次reconnect，連接成功則返回true，否則報錯。如果連接已斷開，且未啟用auto-reconnect，則報錯。

query()查詢和結(jié)果處理

query()用于執(zhí)行任何允許的SQL語句，比如執(zhí)行查詢語句。

查詢結(jié)果可使用each進(jìn)行迭代，迭代時傳遞查詢到的每一行記錄，可使用hash索引的方式(默認(rèn)以hash類型保存每一行)查詢某個字段的內(nèi)容：

conn.query("show databases").each do |row| pp row end
=begin
{"Database"=>"information_schema"}
{"Database"=>"mysql"}
{"Database"=>"mytest"}
{"Database"=>"performance_schema"}
{"Database"=>"sys"}
=end

conn.query("select * from mytest.tb").each do |row|
  pp row
  pp row["name"]
end
=begin
{"name"=>"junmajinlong", "age"=>23}
"junmajinlong"
{"name"=>"woniu", "age"=>25}
"woniu"
{"name"=>"fairy", "age"=>26}
"fairy"
=end

可見，查詢結(jié)果中，每一行數(shù)據(jù)默認(rèn)以hash格式保存。

實際上，對于增刪改的SQL語句，query()的返回值為nil，對于查詢類的語句，其返回值以Mysql2::Result對象返回

conn.query("create table mytest.t1(id int)")
#=> nil
res = conn.query("select * from mytest.tb")
p res

結(jié)果：

#<Mysql2::Result:0x00007fffe833a230
 @query_options=
  {:as=>:hash,
   :async=>false,
   :cast_booleans=>false,
   :symbolize_keys=>false,
   :database_timezone=>:local,
   :application_timezone=>nil,
   :cache_rows=>true,
   :connect_flags=>2148540933,
   :cast=>true,
   :default_file=>nil,
   :default_group=>nil,
   :host=>"192.168.200.73",
   :username=>"root",
   :password=>"P@ssword1!"},
 @server_flags=
   {:no_good_index_used=>false, 
     :no_index_used=>true, 
     :query_was_slow=>false}>

query()各查詢選項的含義以及默認(rèn)的查詢選項參見下文。先了解兩個：

:as項表示以數(shù)組方式(:as=>:array)還是hash方式(:as=>:hash)存儲查詢結(jié)果
:symbolize_keys表示返回hash結(jié)果時，其key是否設(shè)置為符號類型，默認(rèn)為false，即key是字符串類型

可在查詢時指定這些參數(shù)，也可在each迭代時指定這些參數(shù)，例如：

conn.query("select * from mytest.tb", symbolize_keys: true).each do |row|
  pp row
end

conn.query("select * from mytest.tb").each(symbolize_keys: true) do |row|
  pp row
end

結(jié)果：

{:name=>"junmajinlong", :age=>23}
{:name=>"woniu", :age=>25}
{:name=>"fairy", :age=>26}

雖然大多數(shù)時候使用hash保存每一行數(shù)據(jù)更方便，但有時候也會想要以數(shù)組方式操作每一行數(shù)據(jù)，例如連接每一個字段的值：

sql = 'select * from mytest.tb'
res = conn.query(sql)
res.each(as: :array) do |row|
  p row.join(",")
end

結(jié)果：

"junmajinlong,23"
"woniu,25"
"fairy,26"

Mysql2::Result自身具備的方法不多：

#count ? Object (also: #size)
#each(*args) ? Object
#fields ? Object
#free ? Object

外，Mysql2::Result已經(jīng)mix-in了Enumerable模塊，所以可直接使用該模塊中的方法，例如first表示取第一行記錄。

sql = 'select * from mytest.tb'
res = conn.query(sql)
res.first
#=>{"name"=>"junmajinlong", "age"=>23}

需注意，所有SQL語句中涉及到的值都是未經(jīng)轉(zhuǎn)義的，有時候需要也建議在執(zhí)行它們之前先對它們進(jìn)行轉(zhuǎn)義。

escaped = conn.escape("gi'thu\"bbe\0r's")
results = conn.query("SELECT * FROM users WHERE group='#{escaped}'")

查詢選項含義以及默認(rèn)查詢選項

query()默認(rèn)的查詢選項可以通過Mysql2::Client.default_query_options獲取，它是一個hash結(jié)果：

Mysql2::Client.default_query_options
=begin
{:as=>:hash,
 :async=>false,
 :cast_booleans=>false,
 :symbolize_keys=>false,
 :database_timezone=>:local,
 :application_timezone=>nil,
 :cache_rows=>true,
 :connect_flags=>2148540933,
 :cast=>true,
 :default_file=>nil,
 :default_group=>nil}
=end

其中(重要)：

:as項表示以數(shù)組方式(:as=>:array)還是hash方式(:as=>:hash)存儲查詢結(jié)果
:symbolize_keys表示返回hash結(jié)果時，其key是否設(shè)置為符號類型，默認(rèn)為false，即key是字符串類型
:async表示查詢是否異步模式，即是否非阻塞的查詢，參考https://github.com/brianmario/mysql2#async
:cast指示MySQL的查詢結(jié)果轉(zhuǎn)換為Ruby數(shù)據(jù)時是否進(jìn)行類型轉(zhuǎn)換，如果確定本次查詢的字段類型和Ruby的類型完全對應(yīng)，可禁用casting功能提升效率
:database_timezone指示Ruby接收MySQL返回的日期時間數(shù)據(jù)時的時區(qū)，mysql2將先以該時區(qū)創(chuàng)建日期時間對象來保存對應(yīng)字段的值。僅支持:local和:utc兩個值
:application_timezone指示最終Mysql2::Result中的日期時間的時區(qū)，即程序端的時區(qū)。因此，mysql2先以”無損”的時區(qū)從MySQL獲取日期時間數(shù)據(jù)，并根據(jù)application_timezone將其轉(zhuǎn)換成程序端時區(qū)的日期時間對象
:cache_rows指示是否緩存構(gòu)建出來的hash行或array行
Mysql2處理查詢結(jié)果的流程：
- Mysql2的MySQL C api從MySQL服務(wù)端查詢數(shù)據(jù)，并保存在Ruby的查詢結(jié)果集(結(jié)果集屬于C)
- Mysql2::Result和C端結(jié)果集是關(guān)聯(lián)的，當(dāng)釋放Mysql2::Result，也會對C結(jié)果集進(jìn)行GC
- Mysql2在需要取得結(jié)果集中的數(shù)據(jù)時(比如each迭代)，才從結(jié)果集中根據(jù)查詢選項構(gòu)建所需行并返回，比如構(gòu)建hash結(jié)構(gòu)的行，構(gòu)建數(shù)組結(jié)構(gòu)的行，構(gòu)建hash結(jié)構(gòu)時將key轉(zhuǎn)換為Symbol類型等
- 默認(rèn)情況下，從結(jié)果集中查詢并構(gòu)建出來的hash行或array行會緩存在Ruby中，使得下次再次請求這一行時(比如再次迭代)，可用直接從緩存中取得hash行或array行
- 比如從MySQL服務(wù)端查詢了100行數(shù)據(jù)保存在C的結(jié)果集中，第一次以hash方式請求其中4行，這4行hash數(shù)據(jù)會緩存起來，如果下次再從頭開始以hash方式請求15行，則前4行來自于緩存，后11行來自于結(jié)果集的臨時構(gòu)建
- 如果:cache_rows未禁用，當(dāng)結(jié)果集中的所有行都被緩存，Mysql2::Result將會去釋放C端的結(jié)果集
- 如果能確保查詢的結(jié)果集只使用一次，可禁用:cache_rows，這會提升效率
:stream: true表示以Stream的方式處理查詢結(jié)果。有時候查詢結(jié)果數(shù)據(jù)量非常大，Ruby端不方便存放所有結(jié)果，可采用stream的方式去處理本次查詢：一邊從MySQL服務(wù)端取數(shù)據(jù)放進(jìn)結(jié)果集，一邊從結(jié)果集中取數(shù)據(jù)進(jìn)行處理(比如迭代)。使用stream時，會自動關(guān)閉cache_rows，因為它們是互相沖突的概念。此外，使用stream模式要求必須迭代完所有數(shù)據(jù)集才會執(zhí)行下一條查詢，因為一個mysql連接在某一時刻只能執(zhí)行一個操作，在迭代完之前，本次查詢操作還尚未完成。

修改Mysql2::Client.default_query_options可以設(shè)置默認(rèn)query()的查詢選項。如果想要設(shè)置其中某選項，可以通過hash合并的方式來設(shè)置該選項。

Mysql2::Client.default_query_options
#=> {:as=>:hash, ...}

Mysql2::Client.default_query_options.merge!(:as => :array)
#=> {:as=>:array, ...}

prepare()+execute()

除了直接使用query()執(zhí)行SQL語句查詢數(shù)據(jù)庫，也可以使用prepare()方法將字符串準(zhǔn)備成一個待執(zhí)行的SQL語句，其中可以使用?充當(dāng)占位符。

prepare后的語句是一個Mysql2::Statement對象，該對象有一個execute()方法，可以用來執(zhí)行這個準(zhǔn)備好的語句，它可指定查詢選項，且其返回值同query()一樣：對于增刪改操作，返回值為nil，對于查詢類操作，返回Mysql2::Result結(jié)果對象。

res_sql = conn.prepare('select * from mytest.tb where age >= ? and name like ?')
res = res_sql.execute(20, '%junma%', as: :array)
res.first

處理多結(jié)果集

有些存儲過程中可能包含多個查詢結(jié)果集，或者有時候會在一行SQL中包含多個select語句而同時返回多個結(jié)果集，Mysql2能很好地處理多結(jié)果集問題。

要處理多結(jié)果集，連接mysql時必須指定一個flag：

conn = Mysql2::Client.new({
  host: "192.168.200.73",
  username: "root",
  password: "P@ssword1!",
  flags: Mysql2::Client::MULTI_STATEMENTS
})

然后執(zhí)行多結(jié)果集的多個查詢語句：

res = conn.query('select 1;select 2;select 3')

雖然本次query()涉及了多個select語句，Mysql2也已經(jīng)保存了這三個select的查詢結(jié)果集(保存在結(jié)果集隊列中)，但本次query()方法的返回值僅是第一個結(jié)果集，所以res中保存的是第一個結(jié)果集的內(nèi)容。

res.first   #=> {"1"=>1}

要獲取剩余的結(jié)果集，可通過conn.next_result將結(jié)果集偏移指針移到下一個結(jié)果集，然后通過conn.store_result獲取下一個結(jié)果集，依次類推，直到?jīng)]有剩余結(jié)果集后，conn.next_result返回false?？赏ㄟ^more_results?()方法判斷是否還有剩余的結(jié)果集。

conn.next_result
res = conn.store_result
res.first #=> {"2"=>2}

conn.next_result
res = conn.store_result
res.first #=> {"3"=>3}

conn.next_result  #=> false

所以，可遍歷多個結(jié)果集：

res = conn.query('select 1;select 2;select 3')
loop do
  p res.first
  break unless conn.next_result
  res = conn.store_result
end

# 或者
p res.first
while conn.next_result
  res = conn.store_result
  p res.first
end

輸出結(jié)果：

{"1"=>1}
{"2"=>2}
{"3"=>3}

需注意，開啟多行語句(即多結(jié)果集)功能后，所查詢得到的所有結(jié)果集必須已經(jīng)處理完成(嚴(yán)格來說，是存放結(jié)果集的隊列已經(jīng)為空)，才能繼續(xù)執(zhí)行后續(xù)的SQL語句(事實上，經(jīng)測試，結(jié)果集隊列未空的情況下執(zhí)行其它SQL語句會導(dǎo)致直接斷開mysql連接)?？墒褂?code>abandon_results!()方法強行丟棄所有剩余結(jié)果集，使得Mysql2馬上回歸正常狀態(tài)：可向MySQL服務(wù)端發(fā)送SQL語句。

# res和res1都只保存第一個結(jié)果集
# 但結(jié)果集隊列中保留的是select 5和select 6的結(jié)果集
res = conn.query('select 1;select 2;select 3')
conn.abandon_results!  # 丟棄所有剩余結(jié)果集
res1 = conn.query('select 4;select 5;select 6')

另外，如果多個查詢語句中間的某個查詢語句報錯，它將影響其后面的語句不會執(zhí)行，所以無法獲取后面的結(jié)果集。

res = conn.query('select 1;select 2;select A;select 3')
loop do
  p res.first
  break unless conn.next_result
  res = conn.store_result
end

結(jié)果：

{"1"=>1}
{"2"=>2}
Mysql2::Error: Unknown column 'A' in 'field list'

Mysql2的EventMachine

Mysql2支持EM，可以執(zhí)行異步的query()，此外，可以指定當(dāng)query()查詢成功或失敗時的回調(diào)語句塊：

require 'mysql2/em'

EM.run do
  client1 = Mysql2::EM::Client.new
  defer1 = client1.query "SELECT sleep(3) as first_query"
  defer1.callback do |result|
    puts "Result: #{result.to_a.inspect}"
  end

  client2 = Mysql2::EM::Client.new
  defer2 = client2.query "SELECT sleep(1) second_query"
  defer2.callback do |result|
    puts "Result: #{result.to_a.inspect}"
  end
end

ORM之：Sequel

Active:Record應(yīng)該是最為人熟知的orm，其功能極其豐富。

另一個輕量級的ORM是Sequel，它支持ADO, JDBC, MySQL, Mysql2, ODBC, Oracle, PostgreSQL, SQLite3等等。

Sequel官方手冊：

https://github.com/jeremyevans/sequel
http://sequel.jeremyevans.net/rdoc/

例如：

require 'sequel'

# 創(chuàng)建數(shù)據(jù)庫實例
DB = Sequel.connect(
  adapter: :mysql2,
  user: 'root',
  password: 'P@ssword1!',
  host: '192.168.200.73',
  port: 3306,
  database: 'mytest'
)

# 創(chuàng)建數(shù)據(jù)集，數(shù)據(jù)集表示的是一張表或表部分?jǐn)?shù)據(jù)
# 此時不會去查詢數(shù)據(jù)，會推遲到需要數(shù)據(jù)時才查詢
dataset = DB[:tb]

# 迭代表數(shù)據(jù)
dataset.each do |row|
  pp row
end

# 條件查詢
pp dataset.where(name: 'junmajinlong', age: 23).first
pp dataset.where { name =~ "junmajinlong" and age =~ 23 }.first

您可能感興趣的文章: