Skip to content

Commit f4f9e3e

Browse files
committed
readme: update section about API reference
1 parent 114d2a6 commit f4f9e3e

File tree

1 file changed

+11
-30
lines changed

1 file changed

+11
-30
lines changed

README.md

Lines changed: 11 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -70,39 +70,20 @@ database.
7070

7171
<h2>API reference</h2>
7272

73-
Read the [Tarantool manual](http://tarantool.org/doc.html) to find descriptions
74-
of terms like "connect", "space", "index", and the requests for creating and
75-
manipulating database objects or Lua functions.
73+
Read the [Tarantool documentation](https://www.tarantool.io/en/doc/latest/book/box/data_model/)
74+
to find descriptions of terms like "connect", "space", "index", and the
75+
requests for creating and manipulating database objects or Lua functions.
7676

77-
The source files for the requests library are:
78-
* [connection.go](https://github.com/tarantool/go-tarantool/blob/master/connection.go)
79-
for the `Connect()` function plus functions related to connecting, and
80-
* [request.go](https://github.com/tarantool/go-tarantool/blob/master/request.go)
81-
for data-manipulation functions and Lua invocations.
77+
Learn API documentation and examples at
78+
[pkg.go.dev](https://pkg.go.dev/github.com/tarantool/go-tarantool).
8279

83-
See comments in those files for syntax details:
84-
```
85-
Ping
86-
closeConnection
87-
Select
88-
Insert
89-
Replace
90-
Delete
91-
Update
92-
Upsert
93-
Call
94-
Call17
95-
Eval
96-
```
97-
98-
The supported requests have parameters and results equivalent to requests in the
99-
Tarantool manual. There are also Typed and Async versions of each data-manipulation
100-
function.
80+
In general connector methods can be divided into two main parts:
81+
- `Connect()` function plus functions related to connecting, and
82+
- data-manipulation functions and Lua invocations.
10183

102-
The source file for error-handling tools is
103-
[errors.go](https://github.com/tarantool/go-tarantool/blob/master/errors.go),
104-
which has structure definitions and constants whose names are equivalent to names
105-
of errors that the Tarantool server returns.
84+
The supported requests have parameters and results equivalent to requests in
85+
the [Tarantool CRUD operations](https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_space/).
86+
There are also Typed and Async versions of each data-manipulation function.
10687

10788
## Walking-through example
10889

0 commit comments

Comments
 (0)