Skip to content

Commit 8d385d6

Browse files
sjnamagentzh
authored andcommitted
doc: renamed the "errno" return value to "errcode" for consistency.
Signed-off-by: Yichun Zhang (agentzh) <agentzh@gmail.com>
1 parent 875f09c commit 8d385d6

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

README.markdown

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -79,14 +79,14 @@ Synopsis
7979

8080
-- or connect to a unix domain socket file listened
8181
-- by a mysql server:
82-
-- local ok, err, errno, sqlstate =
82+
-- local ok, err, errcode, sqlstate =
8383
-- db:connect{
8484
-- path = "/path/to/mysql.sock",
8585
-- database = "ngx_test",
8686
-- user = "ngx_test",
8787
-- password = "ngx_test" }
8888

89-
local ok, err, errno, sqlstate = db:connect{
89+
local ok, err, errcode, sqlstate = db:connect{
9090
host = "127.0.0.1",
9191
port = 3306,
9292
database = "ngx_test",
@@ -95,35 +95,35 @@ Synopsis
9595
max_packet_size = 1024 * 1024 }
9696

9797
if not ok then
98-
ngx.say("failed to connect: ", err, ": ", errno, " ", sqlstate)
98+
ngx.say("failed to connect: ", err, ": ", errcode, " ", sqlstate)
9999
return
100100
end
101101

102102
ngx.say("connected to mysql.")
103103

104-
local res, err, errno, sqlstate =
104+
local res, err, errcode, sqlstate =
105105
db:query("drop table if exists cats")
106106
if not res then
107-
ngx.say("bad result: ", err, ": ", errno, ": ", sqlstate, ".")
107+
ngx.say("bad result: ", err, ": ", errcode, ": ", sqlstate, ".")
108108
return
109109
end
110110

111-
res, err, errno, sqlstate =
111+
res, err, errcode, sqlstate =
112112
db:query("create table cats "
113113
.. "(id serial primary key, "
114114
.. "name varchar(5))")
115115
if not res then
116-
ngx.say("bad result: ", err, ": ", errno, ": ", sqlstate, ".")
116+
ngx.say("bad result: ", err, ": ", errcode, ": ", sqlstate, ".")
117117
return
118118
end
119119

120120
ngx.say("table cats created.")
121121

122-
res, err, errno, sqlstate =
122+
res, err, errcode, sqlstate =
123123
db:query("insert into cats (name) "
124124
.. "values (\'Bob\'),(\'\'),(null)")
125125
if not res then
126-
ngx.say("bad result: ", err, ": ", errno, ": ", sqlstate, ".")
126+
ngx.say("bad result: ", err, ": ", errcode, ": ", sqlstate, ".")
127127
return
128128
end
129129

@@ -132,10 +132,10 @@ Synopsis
132132

133133
-- run a select query, expected about 10 rows in
134134
-- the result set:
135-
res, err, errno, sqlstate =
135+
res, err, errcode, sqlstate =
136136
db:query("select * from cats order by id asc", 10)
137137
if not res then
138-
ngx.say("bad result: ", err, ": ", errno, ": ", sqlstate, ".")
138+
ngx.say("bad result: ", err, ": ", errcode, ": ", sqlstate, ".")
139139
return
140140
end
141141

@@ -284,9 +284,9 @@ You should use the [read_result](#read_result) method to read the MySQL replies
284284

285285
read_result
286286
-----------
287-
`syntax: res, err, errno, sqlstate = db:read_result()`
287+
`syntax: res, err, errcode, sqlstate = db:read_result()`
288288

289-
`syntax: res, err, errno, sqlstate = db:read_result(nrows)`
289+
`syntax: res, err, errcode, sqlstate = db:read_result(nrows)`
290290

291291
Reads in one result returned from the MySQL server.
292292

@@ -381,31 +381,31 @@ Below is a trivial example for this:
381381
local mysql = require "resty.mysql"
382382

383383
local db = mysql:new()
384-
local ok, err, errno, sqlstate = db:connect({
384+
local ok, err, errcode, sqlstate = db:connect({
385385
host = "127.0.0.1",
386386
port = 3306,
387387
database = "world",
388388
user = "monty",
389389
password = "pass"})
390390

391391
if not ok then
392-
ngx.log(ngx.ERR, "failed to connect: ", err, ": ", errno, " ", sqlstate)
392+
ngx.log(ngx.ERR, "failed to connect: ", err, ": ", errcode, " ", sqlstate)
393393
return ngx.exit(500)
394394
end
395395

396-
res, err, errno, sqlstate = db:query("select 1; select 2; select 3;")
396+
res, err, errcode, sqlstate = db:query("select 1; select 2; select 3;")
397397
if not res then
398-
ngx.log(ngx.ERR, "bad result #1: ", err, ": ", errno, ": ", sqlstate, ".")
398+
ngx.log(ngx.ERR, "bad result #1: ", err, ": ", errcode, ": ", sqlstate, ".")
399399
return ngx.exit(500)
400400
end
401401

402402
ngx.say("result #1: ", cjson.encode(res))
403403

404404
local i = 2
405405
while err == "again" do
406-
res, err, errno, sqlstate = db:read_result()
406+
res, err, errcode, sqlstate = db:read_result()
407407
if not res then
408-
ngx.log(ngx.ERR, "bad result #", i, ": ", err, ": ", errno, ": ", sqlstate, ".")
408+
ngx.log(ngx.ERR, "bad result #", i, ": ", err, ": ", errcode, ": ", sqlstate, ".")
409409
return ngx.exit(500)
410410
end
411411

0 commit comments

Comments
 (0)