Skip to content

Commit d031ea6

Browse files
committed
Update README
1 parent 9c2ddbb commit d031ea6

File tree

1 file changed

+37
-43
lines changed

1 file changed

+37
-43
lines changed

README.md

Lines changed: 37 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ https://hub.docker.com/r/tarantool/tarantool
7777
* [tnt_allowed_indexes](#tnt_allowed_indexes)
7878
* [Performance tuning](#performance-tuning)
7979
* [Examples](#examples)
80-
* [Copyright & License](#copyright--license)
80+
* [Copyright & license](#copyright--license)
8181
* [See also](#see-also)
8282
* [Contacts](#contacts)
8383

@@ -98,7 +98,7 @@ apt-get install libpcre++0 gcc unzip libpcre3-dev zlib1g-dev libssl-dev libxslt-
9898
make build-all
9999
```
100100

101-
[Back to content](#content)
101+
[Back to contents](#contents)
102102

103103
### Build via nginx 'configure'
104104

@@ -131,7 +131,7 @@ make build-all
131131
132132
```
133133

134-
[Back to content](#content)
134+
[Back to contents](#contents)
135135

136136
## REST
137137
-------
@@ -177,7 +177,7 @@ end
177177
$> wget NGX_HOST/tnt_rest?arg1=1&argN=N
178178
```
179179

180-
[Back to content](#content)
180+
[Back to contents](#contents)
181181

182182
## JSON
183183
-------
@@ -313,7 +313,7 @@ rpc call Batch with invalid JSON:
313313
<-- { "error": { "code": -32700, "message": "Parse error" } }
314314
```
315315

316-
[Back to content](#content)
316+
[Back to contents](#contents)
317317

318318
## HTTP headers and status
319319
--------------------------
@@ -410,11 +410,10 @@ Here is an example with `ngx_lua`:
410410
411411
```
412412

413-
[Back to content](#content)
413+
[Back to contents](#contents)
414414

415415
## Directives
416416
-------------
417-
[Back to content](#content)
418417

419418
tnt_pass
420419
--------
@@ -441,7 +440,7 @@ Specify the Tarantool server backend.
441440
}
442441
```
443442

444-
[Back to content](#content)
443+
[Back to contents](#contents)
445444

446445
tnt_http_methods
447446
----------------
@@ -471,7 +470,7 @@ Example:
471470
$> wget --method=delete --body-data='{"method":"lua_function", "params": [], "id": 0}' NGINX_HOST/tnt
472471
```
473472

474-
[Back to content](#content)
473+
[Back to contents](#contents)
475474

476475
tnt_http_rest_methods
477476
---------------------
@@ -499,7 +498,7 @@ Example:
499498
$> wget NGINX_HOST/tarantool_stored_procedure_name/some/mega/path?q=1
500499
```
501500

502-
[Back to content](#content)
501+
[Back to contents](#contents)
503502

504503
tnt_pass_http_request
505504
---------------------
@@ -595,7 +594,7 @@ Examples #3 (parse_urlencoded):
595594
$> wget NGINX_HOST/tarantool_stored_procedure_name/some/mega/path?q=1&q=2&q=3
596595
```
597596

598-
[Back to content](#content)
597+
[Back to contents](#contents)
599598

600599
tnt_pass_http_request_buffer_size
601600
---------------------------------
@@ -607,7 +606,7 @@ tnt_pass_http_request_buffer_size
607606

608607
Specify the size of the buffer used for `tnt_pass_http_request`.
609608

610-
[Back to content](#content)
609+
[Back to contents](#contents)
611610

612611
tnt_method
613612
----------
@@ -670,7 +669,7 @@ Examples:
670669

671670
```
672671

673-
[Back to content](#content)
672+
[Back to contents](#contents)
674673

675674
tnt_set_header
676675
--------------
@@ -714,7 +713,7 @@ Examples:
714713
$> wget NGINX_HOST/tarantool_stored_procedure_name/some/mega/path?q=1
715714
```
716715

717-
[Back to content](#content)
716+
[Back to contents](#contents)
718717

719718
tnt_send_timeout
720719
----------------
@@ -732,7 +731,7 @@ Time units supported are:
732731
`s`(seconds), `ms`(milliseconds), `y`(years), `M`(months), `w`(weeks),
733732
`d`(days), `h`(hours), and `m`(minutes).
734733

735-
[Back to content](#content)
734+
[Back to contents](#contents)
736735

737736
tnt_read_timeout
738737
-------------------
@@ -749,7 +748,7 @@ It's wise to always explicitly specify the time unit to avoid confusion.
749748
Time units supported are: `s`(seconds), `ms`(milliseconds), `y`(years),
750749
`M`(months), `w`(weeks), `d`(days), `h`(hours), and `m`(minutes).
751750

752-
[Back to content](#content)
751+
[Back to contents](#contents)
753752

754753
tnt_connect_timeout
755754
-------------------
@@ -766,7 +765,7 @@ Time units supported are: `s`(seconds), `ms`(milliseconds), `y`(years),
766765
`M`(months), `w`(weeks), `d`(days), `h`(hours), and `m`(minutes).
767766
This time must be strictly less than 597 hours.
768767

769-
[Back to content](#content)
768+
[Back to contents](#contents)
770769

771770
tnt_buffer_size
772771
---------------
@@ -779,7 +778,7 @@ tnt_buffer_size
779778
This buffer size is used for reading Tarantool replies,
780779
but it's not required to be as big as the largest possible Tarantool reply.
781780

782-
[Back to content](#content)
781+
[Back to contents](#contents)
783782

784783
tnt_next_upstream
785784
--------------------
@@ -793,7 +792,7 @@ Specify which failure conditions should cause the request to be forwarded to
793792
another upstream server. Applies only when the value in [tnt_pass](#tnt_pass)
794793
is an upstream with two or more servers.
795794

796-
[Back to content](#content)
795+
[Back to contents](#contents)
797796

798797
tnt_next_upstream_tries
799798
-----------------------
@@ -806,6 +805,8 @@ tnt_next_upstream_tries
806805
Limit the number of possible tries for passing a request to the next server.
807806
The 0 value turns off this limitation.
808807

808+
[Back to contents](#contents)
809+
809810
tnt_next_upstream_timeout
810811
-------------------------
811812
**syntax:** *tnt_next_upstream_timeout TIME*
@@ -817,7 +818,7 @@ tnt_next_upstream_timeout
817818
Limit the time during which a request can be passed to the next server.
818819
The 0 value turns off this limitation.
819820

820-
[Back to content](#content)
821+
[Back to contents](#contents)
821822

822823
tnt_pure_result
823824
---------------
@@ -838,7 +839,7 @@ When this option is on:
838839
[[1]]
839840
```
840841

841-
[Back to content](#content)
842+
[Back to contents](#contents)
842843

843844
tnt_multireturn_skip_count
844845
--------------------------
@@ -873,16 +874,7 @@ When it is set to 2:
873874
{"id": 0, "result": 1}
874875
```
875876

876-
```
877-
{"id":0, "result": [1]}
878-
```
879-
880-
When it is set to 1:
881-
```
882-
{"id":0, "result": 1}
883-
```
884-
885-
[Back to content](#content)
877+
[Back to contents](#contents)
886878

887879
Format
888880
------
@@ -928,7 +920,7 @@ Examples can be found at:
928920
* `./t/ngx_confs/tnt_server_test.conf:342`
929921
* `./t/v26_features.py`
930922

931-
[Back to content](#content)
923+
[Back to contents](#contents)
932924

933925
tnt_insert
934926
----------
@@ -943,7 +935,7 @@ This directive allows executing an insert query with Tarantool.
943935
* The first argument is a space id.
944936
* The second argument is a [format](#format) string.
945937

946-
[Back to content](#content)
938+
[Back to contents](#contents)
947939

948940
tnt_insert
949941
----------
@@ -958,7 +950,7 @@ This directive allows executing a replace query with Tarantool.
958950
* The first argument is a space id.
959951
* The second argument is a [format](#format) string.
960952

961-
[Back to content](#content)
953+
[Back to contents](#contents)
962954

963955
tnt_delete
964956
----------
@@ -974,7 +966,7 @@ This directive allows executing a delete query with Tarantool.
974966
* The second argument is an index id.
975967
* The third argument is a [format](#format) string.
976968

977-
[Back to content](#content)
969+
[Back to contents](#contents)
978970

979971
tnt_select
980972
----------
@@ -995,7 +987,7 @@ This directive allows executing a select query with Tarantool.
995987
`all_non_set`, `overlaps`, `neighbor`.
996988
* The six argument is a [format](#format) string.
997989

998-
[Back to content](#content)
990+
[Back to contents](#contents)
999991

1000992
tnt_select_limit_max
1001993
--------------------
@@ -1009,7 +1001,7 @@ This is a constraint to avoid *large selects*. This is the maximum number
10091001
of returned tuples per select operation. If the client reaches this limit, then
10101002
the client gets an error on its side.
10111003

1012-
[Back to content](#content)
1004+
[Back to contents](#contents)
10131005

10141006
tnt_allowed_spaces
10151007
------------------
@@ -1033,7 +1025,7 @@ location {
10331025
}
10341026
```
10351027

1036-
[Back to content](#content)
1028+
[Back to contents](#contents)
10371029

10381030
tnt_allowed_indexes
10391031
-------------------
@@ -1045,7 +1037,7 @@ tnt_allowed_indexes
10451037

10461038
This directive works like [tnt_allowed_spaces], but for indexes.
10471039

1048-
[Back to content](#content)
1040+
[Back to contents](#contents)
10491041

10501042
## Performance tuning
10511043
---------------------
@@ -1058,7 +1050,7 @@ This directive works like [tnt_allowed_spaces], but for indexes.
10581050
* Tune Linux network.
10591051
* Tune nginx buffers.
10601052

1061-
[Back to content](#content)
1053+
[Back to contents](#contents)
10621054

10631055
## Examples
10641056
-----------
@@ -1067,14 +1059,14 @@ Python test: `test/basic_features.py`, `test/v20_feautres.py`, `nginx.dev.conf`.
10671059

10681060
Client-side javascript example: `example/echo.html`, `example/echo.lua`.
10691061

1070-
[Back to content](#content)
1062+
[Back to contents](#contents)
10711063

10721064
## Copyright & license
10731065
----------------------
10741066

10751067
[LICENSE](https://github.com/tarantool/nginx_upstream_module/blob/master/LICENSE)
10761068

1077-
[Back to content](#content)
1069+
[Back to contents](#contents)
10781070

10791071
## See also
10801072
-----------
@@ -1083,11 +1075,13 @@ Client-side javascript example: `example/echo.html`, `example/echo.lua`.
10831075
* [lua-resty-tarantool](https://github.com/perusio/lua-resty-tarantool)
10841076
* Tarantool [protocol](http://tarantool.org/doc/dev_guide/box-protocol.html?highlight=protocol)
10851077

1086-
[Back to content](#content)
1078+
[Back to contents](#contents)
10871079

10881080
## Contacts
10891081

10901082
Please report bugs at https://github.com/tarantool/nginx_upstream_module/issues.
10911083

10921084
We also warmly welcome your feedback in the discussion mailing list,
10931085
tarantool@googlegroups.com
1086+
1087+
[Back to contents](#contents)

0 commit comments

Comments
 (0)