Skip to content

Commit 70216b8

Browse files
committed
readme: move usage examples to tests
README contains an example like already exist in a example_test.go, so example in a README was removed and example in tests has been updated: - single example splitted to multiple examples for Connection methods - added new examples for Ping(), Insert(), Delete(), Replace(), Update(), Call17(), Eval() and Connect() Part of #123
1 parent 91a07ab commit 70216b8

File tree

2 files changed

+260
-232
lines changed

2 files changed

+260
-232
lines changed

README.md

-111
Original file line numberDiff line numberDiff line change
@@ -177,117 +177,6 @@ will also be happy to provide advice or receive feedback.
177177

178178
## Usage
179179

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

0 commit comments

Comments
 (0)