Skip to content

Commit 050b67b

Browse files
committed
readme: update section about API reference
1 parent 369a326 commit 050b67b

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
@@ -72,39 +72,20 @@ database.
7272

7373
<h2>API reference</h2>
7474

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

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

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

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

10990
## Help
11091

0 commit comments

Comments
 (0)