Skip to content

Commit 17c9346

Browse files
committed
readme: update section about API reference
Part of #123
1 parent 675b5c4 commit 17c9346

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
@@ -66,39 +66,18 @@ database.
6666

6767
<h2>API reference</h2>
6868

69-
Read the [Tarantool manual](http://tarantool.org/doc.html) to find descriptions
70-
of terms like "connect", "space", "index", and the requests for creating and
71-
manipulating database objects or Lua functions.
69+
Read the [Tarantool documentation](tarantool-doc-data-model-url)
70+
to find descriptions of terms such as "connect", "space", "index", and the
71+
requests to create and manipulate database objects or Lua functions.
7272

73-
The source files for the requests library are:
74-
* [connection.go](https://github.com/tarantool/go-tarantool/blob/master/connection.go)
75-
for the `Connect()` function plus functions related to connecting, and
76-
* [request.go](https://github.com/tarantool/go-tarantool/blob/master/request.go)
77-
for data-manipulation functions and Lua invocations.
73+
In general, connector methods can be divided into two main parts:
7874

79-
See comments in those files for syntax details:
80-
```
81-
Ping
82-
closeConnection
83-
Select
84-
Insert
85-
Replace
86-
Delete
87-
Update
88-
Upsert
89-
Call
90-
Call17
91-
Eval
92-
```
93-
94-
The supported requests have parameters and results equivalent to requests in the
95-
Tarantool manual. There are also Typed and Async versions of each data-manipulation
96-
function.
75+
* `Connect()` function and functions related to connecting, and
76+
* Data manipulation functions and Lua invocations such as `Insert()` or `Call()`.
9777

98-
The source file for error-handling tools is
99-
[errors.go](https://github.com/tarantool/go-tarantool/blob/master/errors.go),
100-
which has structure definitions and constants whose names are equivalent to names
101-
of errors that the Tarantool server returns.
78+
The supported requests have parameters and results equivalent to requests in
79+
the [Tarantool CRUD operations](tarantool-doc-box-space-url).
80+
There are also Typed and Async versions of each data-manipulation function.
10281

10382
## Walking-through example in Go
10483

@@ -192,3 +171,5 @@ See feature comparison in [documentation](https://www.tarantool.io/en/doc/latest
192171
[stackoverflow-url]: https://stackoverflow.com/questions/tagged/tarantool
193172
[golang-dl]: https://go.dev/dl/
194173
[go-tarantool]: https://github.com/tarantool/go-tarantool
174+
[tarantool-doc-data-model-url]: https://www.tarantool.io/en/doc/latest/book/box/data_model/
175+
[tarantool-doc-box-space-url]: https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_space/

0 commit comments

Comments
 (0)