Skip to content

Commit f408959

Browse files
ligurioligurio
committed
readme: remove usage example
The similar example was already exist in example_test.go, so example in a README was removed and example in tests has been updated: - Remove duplicate code with printing response and error after each method - Builtin fmt module is used to make output deterministic
1 parent ddcc010 commit f408959

File tree

2 files changed

+32
-179
lines changed

2 files changed

+32
-179
lines changed

‎README.md

Lines changed: 0 additions & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -174,117 +174,6 @@ will also be happy to provide advice or receive feedback.
174174

175175
## Usage
176176

177-
```go
178-
package main
179-
180-
import (
181-
"github.com/tarantool/go-tarantool"
182-
"log"
183-
"time"
184-
)
185-
186-
func main() {
187-
spaceNo := uint32(512)
188-
indexNo := uint32(0)
189-
190-
server := "127.0.0.1:3013"
191-
opts := tarantool.Opts{
192-
Timeout: 500 * time.Millisecond,
193-
Reconnect: 1 * time.Second,
194-
MaxReconnects: 3,
195-
User: "test",
196-
Pass: "test",
197-
}
198-
client, err := tarantool.Connect(server, opts)
199-
if err != nil {
200-
log.Fatalf("Failed to connect: %s", err.Error())
201-
}
202-
203-
resp, err := client.Ping()
204-
log.Println(resp.Code)
205-
log.Println(resp.Data)
206-
log.Println(err)
207-
208-
// insert new tuple { 10, 1 }
209-
resp, err = client.Insert(spaceNo, []interface{}{uint(10), 1})
210-
// or
211-
resp, err = client.Insert("test", []interface{}{uint(10), 1})
212-
log.Println("Insert")
213-
log.Println("Error", err)
214-
log.Println("Code", resp.Code)
215-
log.Println("Data", resp.Data)
216-
217-
// delete tuple with primary key { 10 }
218-
resp, err = client.Delete(spaceNo, indexNo, []interface{}{uint(10)})
219-
// or
220-
resp, err = client.Delete("test", "primary", []interface{}{uint(10)})
221-
log.Println("Delete")
222-
log.Println("Error", err)
223-
log.Println("Code", resp.Code)
224-
log.Println("Data", resp.Data)
225-
226-
// replace tuple with { 13, 1 }
227-
resp, err = client.Replace(spaceNo, []interface{}{uint(13), 1})
228-
// or
229-
resp, err = client.Replace("test", []interface{}{uint(13), 1})
230-
log.Println("Replace")
231-
log.Println("Error", err)
232-
log.Println("Code", resp.Code)
233-
log.Println("Data", resp.Data)
234-
235-
// update tuple with primary key { 13 }, incrementing second field by 3
236-
resp, err = client.Update(spaceNo, indexNo, []interface{}{uint(13)}, []interface{}{[]interface{}{"+", 1, 3}})
237-
// or
238-
resp, err = client.Update("test", "primary", []interface{}{uint(13)}, []interface{}{[]interface{}{"+", 1, 3}})
239-
log.Println("Update")
240-
log.Println("Error", err)
241-
log.Println("Code", resp.Code)
242-
log.Println("Data", resp.Data)
243-
244-
// insert tuple {15, 1} or increment second field by 1
245-
resp, err = client.Upsert(spaceNo, []interface{}{uint(15), 1}, []interface{}{[]interface{}{"+", 1, 1}})
246-
// or
247-
resp, err = client.Upsert("test", []interface{}{uint(15), 1}, []interface{}{[]interface{}{"+", 1, 1}})
248-
log.Println("Upsert")
249-
log.Println("Error", err)
250-
log.Println("Code", resp.Code)
251-
log.Println("Data", resp.Data)
252-
253-
// select just one tuple with primay key { 15 }
254-
resp, err = client.Select(spaceNo, indexNo, 0, 1, tarantool.IterEq, []interface{}{uint(15)})
255-
// or
256-
resp, err = client.Select("test", "primary", 0, 1, tarantool.IterEq, []interface{}{uint(15)})
257-
log.Println("Select")
258-
log.Println("Error", err)
259-
log.Println("Code", resp.Code)
260-
log.Println("Data", resp.Data)
261-
262-
// select tuples by condition ( primay key > 15 ) with offset 7 limit 5
263-
// BTREE index supposed
264-
resp, err = client.Select(spaceNo, indexNo, 7, 5, tarantool.IterGt, []interface{}{uint(15)})
265-
// or
266-
resp, err = client.Select("test", "primary", 7, 5, tarantool.IterGt, []interface{}{uint(15)})
267-
log.Println("Select")
268-
log.Println("Error", err)
269-
log.Println("Code", resp.Code)
270-
log.Println("Data", resp.Data)
271-
272-
// call function 'func_name' with arguments
273-
resp, err = client.Call("func_name", []interface{}{1, 2, 3})
274-
log.Println("Call")
275-
log.Println("Error", err)
276-
log.Println("Code", resp.Code)
277-
log.Println("Data", resp.Data)
278-
279-
// run raw lua code
280-
resp, err = client.Eval("return 1 + 2", []interface{}{})
281-
log.Println("Eval")
282-
log.Println("Error", err)
283-
log.Println("Code", resp.Code)
284-
log.Println("Data", resp.Data)
285-
}
286-
```
287-
288177
To enable support of UUID in msgpack with [google/uuid](https://github.com/google/uuid),
289178
import tarantool/uuid submodule.
290179
```go

‎example_test.go

Lines changed: 32 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -103,72 +103,60 @@ func Example() {
103103
return
104104
}
105105

106+
// Ping a Tarantool instance to check connection
106107
resp, err := client.Ping()
107108
fmt.Println("Ping Code", resp.Code)
108109
fmt.Println("Ping Data", resp.Data)
109110
fmt.Println("Ping Error", err)
110111

111-
// delete tuple for cleaning
112+
// Delete tuples with primary key { 10 } and { 11 }
112113
client.Delete(spaceNo, indexNo, []interface{}{uint(10)})
113-
client.Delete(spaceNo, indexNo, []interface{}{uint(11)})
114+
// the same:
115+
client.Delete("test", "primary", []interface{}{uint(11)})
114116

115-
// insert new tuple { 10, 1 }
117+
// Insert a new tuple { 10, 1 }
116118
resp, err = client.Insert(spaceNo, []interface{}{uint(10), "test", "one"})
117-
fmt.Println("Insert Error", err)
118-
fmt.Println("Insert Code", resp.Code)
119-
fmt.Println("Insert Data", resp.Data)
120119

121-
// insert new tuple { 11, 1 }
120+
// Insert a new tuple { 11, 1 }
122121
resp, err = client.Insert("test", &Tuple{Id: 11, Msg: "test", Name: "one"})
123-
fmt.Println("Insert Error", err)
124-
fmt.Println("Insert Code", resp.Code)
125-
fmt.Println("Insert Data", resp.Data)
126122

127-
// delete tuple with primary key { 10 }
123+
// Delete a tuple with primary key { 10 }
128124
resp, err = client.Delete(spaceNo, indexNo, []interface{}{uint(10)})
129-
// or
130-
// resp, err = client.Delete("test", "primary", UintKey{10}})
131-
fmt.Println("Delete Error", err)
132-
fmt.Println("Delete Code", resp.Code)
133-
fmt.Println("Delete Data", resp.Data)
134-
135-
// replace tuple with primary key 13
136-
// note, Tuple is defined within tests, and has EncdodeMsgpack and DecodeMsgpack
137-
// methods
125+
// the same:
126+
//resp, err = client.Delete("test", "primary", UintKey{10})
127+
128+
// Replace tuple with primary key 13.
129+
// Note, Tuple is defined within tests, and has EncdodeMsgpack and
130+
// DecodeMsgpack methods.
138131
resp, err = client.Replace(spaceNo, []interface{}{uint(13), 1})
139-
fmt.Println("Replace Error", err)
140-
fmt.Println("Replace Code", resp.Code)
141-
fmt.Println("Replace Data", resp.Data)
132+
// the same:
133+
resp, err = client.Replace("test", []interface{}{uint(13), 1})
142134

143-
// update tuple with primary key { 13 }, incrementing second field by 3
135+
// Update tuple with primary key { 13 }, incrementing second field by 3
144136
resp, err = client.Update("test", "primary", tarantool.UintKey{13}, []tarantool.Op{{"+", 1, 3}})
145-
// or
146-
// resp, err = client.Update(spaceNo, indexNo, []interface{}{uint(13)}, []interface{}{[]interface{}{"+", 1, 3}})
147-
fmt.Println("Update Error", err)
148-
fmt.Println("Update Code", resp.Code)
149-
fmt.Println("Update Data", resp.Data)
137+
// the same:
138+
resp, err = client.Update(spaceNo, indexNo, []interface{}{uint(13)}, []interface{}{[]interface{}{"+", 1, 3}})
150139

151-
// select just one tuple with primay key { 15 }
140+
// Select just one tuple with primary key { 15 }
152141
resp, err = client.Select(spaceNo, indexNo, 0, 1, tarantool.IterEq, []interface{}{uint(15)})
153-
// or
154-
// resp, err = client.Select("test", "primary", 0, 1, tarantool.IterEq, tarantool.UintKey{15})
155-
fmt.Println("Select Error", err)
156-
fmt.Println("Select Code", resp.Code)
157-
fmt.Println("Select Data", resp.Data)
142+
// the same:
143+
resp, err = client.Select("test", "primary", 0, 1, tarantool.IterEq, tarantool.UintKey{15})
144+
145+
// Select tuples by condition ( primary key > 15 ) with offset 7 and limit 5.
146+
// BTREE index is supposed.
147+
resp, err = client.Select(spaceNo, indexNo, 7, 5, tarantool.IterGt, []interface{}{uint(15)})
148+
// the same:
149+
resp, err = client.Select("test", "primary", 7, 5, tarantool.IterGt, []interface{}{uint(15)})
158150

159-
// call function 'func_name' with arguments
151+
// Call function 'func_name' with arguments
160152
resp, err = client.Call17("simple_incr", []interface{}{1})
161-
fmt.Println("Call17 Error", err)
162-
fmt.Println("Call17 Code", resp.Code)
163-
fmt.Println("Call17 Data", resp.Data)
164153

165-
// run raw Lua code
154+
// Run raw Lua code
166155
resp, err = client.Eval("return 1 + 2", []interface{}{})
167-
fmt.Println("Eval Error", err)
168-
fmt.Println("Eval Code", resp.Code)
169-
fmt.Println("Eval Data", resp.Data)
170156

157+
// Replace
171158
resp, err = client.Replace("test", &Tuple{Id: 11, Msg: "test", Name: "eleven"})
159+
// the same:
172160
resp, err = client.Replace("test", &Tuple{Id: 12, Msg: "test", Name: "twelve"})
173161

174162
var futs [3]*tarantool.Future
@@ -191,34 +179,10 @@ func Example() {
191179
// Ping Code 0
192180
// Ping Data []
193181
// Ping Error <nil>
194-
// Insert Error <nil>
195-
// Insert Code 0
196-
// Insert Data [[10 test one]]
197-
// Insert Error <nil>
198-
// Insert Code 0
199-
// Insert Data [[11 test one]]
200-
// Delete Error <nil>
201-
// Delete Code 0
202-
// Delete Data [[10 test one]]
203-
// Replace Error <nil>
204-
// Replace Code 0
205-
// Replace Data [[13 1]]
206-
// Update Error <nil>
207-
// Update Code 0
208-
// Update Data [[13 4]]
209-
// Select Error <nil>
210-
// Select Code 0
211-
// Select Data [[15 val 15 bla]]
212-
// Call17 Error <nil>
213-
// Call17 Code 0
214-
// Call17 Data [2]
215-
// Eval Error <nil>
216-
// Eval Code 0
217-
// Eval Data [3]
218182
// Fut 0 Error <nil>
219183
// Fut 0 Data [{{} 12 test twelve} {{} 11 test eleven}]
220184
// Fut 1 Error <nil>
221-
// Fut 1 Data [[13 4]]
185+
// Fut 1 Data [[13 7]]
222186
// Fut 2 Error <nil>
223187
// Fut 2 Data [[15 val 15 bla]]
224188
}

0 commit comments

Comments
 (0)