Skip to content

Commit 30da29a

Browse files
committed
readme: update section about API reference
1 parent b6029e2 commit 30da29a

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
@@ -69,39 +69,20 @@ database.
6969

7070
<h2>API reference</h2>
7171

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

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

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

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

10687
## Help
10788

0 commit comments

Comments
 (0)