Skip to content

Commit 7926045

Browse files
committed
docs : update
1 parent e680c2e commit 7926045

File tree

4 files changed

+213
-0
lines changed

4 files changed

+213
-0
lines changed

script-base64.md

+17
Original file line numberDiff line numberDiff line change
@@ -1 +1,18 @@
11
# Base64
2+
3+
```lua
4+
local base64 = require("base64")
5+
```
6+
7+
* Encode
8+
* Decode
9+
10+
### Encode
11+
```lua
12+
base64.encode()
13+
```
14+
15+
### Decode
16+
```lua
17+
base64.decode()
18+
```

script-http.md

+42
Original file line numberDiff line numberDiff line change
@@ -1 +1,43 @@
11
# HTTP
2+
3+
4+
```lua
5+
local http = require("http")
6+
```
7+
8+
### POST
9+
```lua
10+
11+
-- Request body
12+
reqTable = {
13+
body = {}, -- post body
14+
timeout = "10s", -- http timeout
15+
headers = {}, -- http headers
16+
}
17+
18+
-- post
19+
res, err = http.post("url", reqTable)
20+
--[[
21+
res : userdata
22+
res["body"] : http response body
23+
res["body_size"] :
24+
res["headers"] : http headers
25+
res["cookies"] : http cookies
26+
res["status_code"] : http status code
27+
res["url"] : request url
28+
29+
err : error message
30+
]]--
31+
32+
```
33+
34+
### GET
35+
```lua
36+
res, err = http.get("url", {})
37+
```
38+
39+
### PUT
40+
```lua
41+
res, err = http.get("put", {})
42+
```
43+

script-mongodb.md

+134
Original file line numberDiff line numberDiff line change
@@ -1 +1,135 @@
11
# MongoDB
2+
3+
```lua
4+
local mgo = require("mgo")
5+
```
6+
7+
### conn
8+
```lua
9+
local mgo = require("mgo")
10+
11+
-- "bot"
12+
-- "mongodb://" connect url
13+
-- https://www.docs4dev.com/docs/zh/mongodb/v3.6/reference/reference-connection-string.html#connections-connection-examples
14+
15+
ret = mgo.conn("bot", "mongodb://127.0.0.1:27017")
16+
assert(ret == "succ", "mgo connect err " .. ret)
17+
```
18+
19+
### disconn
20+
21+
```lua
22+
mgo.disconn()
23+
```
24+
25+
### insert_one
26+
27+
```lua
28+
ret = mgo.insert_one(testdb, {_id = "001", msg = "aa"})
29+
assert(ret == "succ", "mgo insert_one err " .. ret)
30+
31+
--[[
32+
{
33+
_id : "001",
34+
msg : "aa"
35+
}
36+
]]--
37+
```
38+
39+
### insert_many
40+
41+
```lua
42+
doc = {
43+
{a = 1, b = "a", c = false},
44+
{a = 2, b = "b", c = true},
45+
{a = { b = "c" }},
46+
{a = {"a", "b", "c", "d"}},
47+
{a = {1, 2, 3, 4}}
48+
}
49+
50+
ret = mgo.insert_many(testdb, doc)
51+
assert(ret == "succ", "mgo insert many err " .. ret)
52+
53+
--[[
54+
[
55+
{
56+
"_id":{
57+
"$oid":"6288e5aa2a534719e4103d72"
58+
},
59+
"b":"a",
60+
"c":false,
61+
"a":1
62+
},
63+
{
64+
"_id":{
65+
"$oid":"6288e5aa2a534719e4103d73"
66+
},
67+
"a":2,
68+
"b":"b",
69+
"c":true
70+
},
71+
{
72+
"_id":{
73+
"$oid":"6288e5aa2a534719e4103d74"
74+
},
75+
"a":{
76+
"b":"c"
77+
}
78+
},
79+
{
80+
"_id":{
81+
"$oid":"6288e5aa2a534719e4103d75"
82+
},
83+
"a":[ "a", "b", "c", "d" ]
84+
},
85+
{
86+
"_id":{
87+
"$oid":"6288e5aa2a534719e4103d76"
88+
},
89+
"a":[ 1, 2, 3, 4 ]
90+
}
91+
]
92+
]]--
93+
```
94+
95+
### find
96+
97+
```lua
98+
val, ret = mgo.find(testdb, {})
99+
assert(ret == "succ", "mgo find err " .. ret)
100+
```
101+
102+
### find_one
103+
104+
```lua
105+
ret = mgo.insert_one(testdb, {a = 1, b = "aa"})
106+
assert(ret == "succ", "mgo insert one err " .. ret)
107+
108+
val, ret = mgo.find_one(testdb, {a = 1})
109+
assert(ret == "succ", "mgo find err " .. ret)
110+
```
111+
112+
### update_one
113+
114+
```lua
115+
ret = mgo.insert_one(testdb, {a = 1, b = "aa"})
116+
assert(ret == "succ", "mgo insert one err " .. ret)
117+
118+
settable = {}
119+
settable["$set"] = {b = "bb"}
120+
mgo.update_one(testdb, {a = 1}, settable)
121+
```
122+
123+
### update_many
124+
125+
### delete_one
126+
127+
```lua
128+
ret = mgo.insert_one(testdb, {_id = test1id, msg = "aa"})
129+
assert(ret == "succ", "mgo insert_one err " .. ret)
130+
131+
assert(lt._id == test1id, "find err " .. test1id)
132+
mgo.delete_one(testdb, {_id = test1id})
133+
```
134+
135+
### delete_many

script-utils.md

+20
Original file line numberDiff line numberDiff line change
@@ -1 +1,21 @@
11
# Utils
2+
3+
4+
```lua
5+
local utils = require("utils")
6+
```
7+
8+
* UUID
9+
* Random
10+
11+
### UUID
12+
```lua
13+
-- 00d460f0-ec1a-4a0f-a452-1afb4b5d1686
14+
utils.uuid()
15+
```
16+
17+
### Random
18+
```lua
19+
-- random [0 ~ 100] seed = time.now().unixnano()
20+
utils.random(100)
21+
```

0 commit comments

Comments
 (0)