Skip to content

Commit 7649f98

Browse files
dedokdedok
committed
Update readme
1 parent db9356e commit 7649f98

File tree

1 file changed

+157
-0
lines changed

1 file changed

+157
-0
lines changed

‎README.md‎

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -967,6 +967,29 @@ This directive allows executing an insert query with Tarantool.
967967
* The first argument is a space id.
968968
* The second argument is a [format](#format) string.
969969

970+
Returns HTTP code 4XX if client's request doesn't well formatted. It means, that
971+
this error raised if some of values missed or has wrong type.
972+
973+
Returns HTTP code 5XX if upstream is dead (no ping).
974+
975+
Also it can return an HTTP code 200 with an error formatted in JSON.
976+
It happens when Tarantool can't issue a query.
977+
978+
Here is a description:
979+
```
980+
{"error": { "message": STR, "code": INT } }
981+
```
982+
983+
* **error** - a structured object which contains an internal error message.
984+
This field exists only if an internal error occurred, for instance:
985+
"too large request", "input json parse error", etc.
986+
987+
If this field exists, the input message was _probably_ not passed to
988+
the Tarantool backend.
989+
990+
See "message"/"code" fields for details.
991+
992+
970993
[Back to contents](#contents)
971994

972995
tnt_replace
@@ -982,6 +1005,28 @@ This directive allows executing a replace query with Tarantool.
9821005
* The first argument is a space id.
9831006
* The second argument is a [format](#format) string.
9841007

1008+
Returns HTTP code 4XX if client's request doesn't well formatted. It means, that
1009+
this error raised if some of values missed or has wrong type.
1010+
1011+
Returns HTTP code 5XX if upstream is dead (no ping).
1012+
1013+
Also it can return an HTTP code 200 with an error formatted in JSON.
1014+
It happens when Tarantool can't issue a query.
1015+
1016+
Here is a description:
1017+
```
1018+
{"error": { "message": STR, "code": INT } }
1019+
```
1020+
1021+
* **error** - a structured object which contains an internal error message.
1022+
This field exists only if an internal error occurred, for instance:
1023+
"too large request", "input json parse error", etc.
1024+
1025+
If this field exists, the input message was _probably_ not passed to
1026+
the Tarantool backend.
1027+
1028+
See "message"/"code" fields for details.
1029+
9851030
[Back to contents](#contents)
9861031

9871032
tnt_delete
@@ -998,6 +1043,29 @@ This directive allows executing a delete query with Tarantool.
9981043
* The second argument is an index id.
9991044
* The third argument is a [format](#format) string.
10001045

1046+
Returns HTTP code 4XX if client's request doesn't well formatted. It means, that
1047+
this error raised if some of values missed or has wrong type.
1048+
1049+
Returns HTTP code 5XX if upstream is dead (no ping).
1050+
1051+
Also it can return an HTTP code 200 with an error formatted in JSON.
1052+
It happens when Tarantool can't issue a query.
1053+
1054+
Here is a description:
1055+
```
1056+
{"error": { "message": STR, "code": INT } }
1057+
```
1058+
1059+
* **error** - a structured object which contains an internal error message.
1060+
This field exists only if an internal error occurred, for instance:
1061+
"too large request", "input json parse error", etc.
1062+
1063+
If this field exists, the input message was _probably_ not passed to
1064+
the Tarantool backend.
1065+
1066+
See "message"/"code" fields for details.
1067+
1068+
10011069
[Back to contents](#contents)
10021070

10031071
tnt_select
@@ -1019,6 +1087,28 @@ This directive allows executing a select query with Tarantool.
10191087
`all_non_set`, `overlaps`, `neighbor`.
10201088
* The six argument is a [format](#format) string.
10211089

1090+
Returns HTTP code 4XX if client's request doesn't well formatted. It means, that
1091+
this error raised if some of values missed or has wrong type.
1092+
1093+
Returns HTTP code 5XX if upstream is dead (no ping).
1094+
1095+
Also it can return an HTTP code 200 with an error formatted in JSON.
1096+
It happens when Tarantool can't issue a query.
1097+
1098+
Here is a description:
1099+
```
1100+
{"error": { "message": STR, "code": INT } }
1101+
```
1102+
1103+
* **error** - a structured object which contains an internal error message.
1104+
This field exists only if an internal error occurred, for instance:
1105+
"too large request", "input json parse error", etc.
1106+
1107+
If this field exists, the input message was _probably_ not passed to
1108+
the Tarantool backend.
1109+
1110+
See "message"/"code" fields for details.
1111+
10221112
[Back to contents](#contents)
10231113

10241114
tnt_select_limit_max
@@ -1033,6 +1123,28 @@ This is a constraint to avoid *large selects*. This is the maximum number
10331123
of returned tuples per select operation. If the client reaches this limit, then
10341124
the client gets an error on its side.
10351125

1126+
Returns HTTP code 4XX if client's request doesn't well formatted. It means, that
1127+
this error raised if some of values missed or has wrong type.
1128+
1129+
Returns HTTP code 5XX if upstream is dead (no ping).
1130+
1131+
Also it can return an HTTP code 200 with an error formatted in JSON.
1132+
It happens when Tarantool can't issue a query.
1133+
1134+
Here is a description:
1135+
```
1136+
{"error": { "message": STR, "code": INT } }
1137+
```
1138+
1139+
* **error** - a structured object which contains an internal error message.
1140+
This field exists only if an internal error occurred, for instance:
1141+
"too large request", "input json parse error", etc.
1142+
1143+
If this field exists, the input message was _probably_ not passed to
1144+
the Tarantool backend.
1145+
1146+
See "message"/"code" fields for details.
1147+
10361148
[Back to contents](#contents)
10371149

10381150
tnt_allowed_spaces
@@ -1098,6 +1210,28 @@ This directive allows executing an update query with Tarantool.
10981210
* The second argument is a [KEYS (for UPDATE)](#format) string.
10991211
* The third argument is a [format](#format) string.
11001212

1213+
Returns HTTP code 4XX if client's request doesn't well formatted. It means, that
1214+
this error raised if some of values missed or has wrong type.
1215+
1216+
Returns HTTP code 5XX if upstream is dead (no ping).
1217+
1218+
Also it can return an HTTP code 200 with an error formatted in JSON.
1219+
It happens when Tarantool can't issue a query.
1220+
1221+
Here is a description:
1222+
```
1223+
{"error": { "message": STR, "code": INT } }
1224+
```
1225+
1226+
* **error** - a structured object which contains an internal error message.
1227+
This field exists only if an internal error occurred, for instance:
1228+
"too large request", "input json parse error", etc.
1229+
1230+
If this field exists, the input message was _probably_ not passed to
1231+
the Tarantool backend.
1232+
1233+
See "message"/"code" fields for details.
1234+
11011235
[Back to contents](#contents)
11021236

11031237
tnt_upsert
@@ -1114,6 +1248,29 @@ This directive allows executing an upsert query with Tarantool.
11141248
* The second argument is a [format](#format) string.
11151249
* The third argument is a [OPERATIONS (for UPSERT)](#format) string.
11161250

1251+
Returns HTTP code 4XX if client's request doesn't well formatted. It means, that
1252+
this error raised if some of values missed or has wrong type.
1253+
1254+
Returns HTTP code 5XX if upstream is dead (no ping).
1255+
1256+
Also it can return an HTTP code 200 with an error formatted in JSON.
1257+
It happens when Tarantool can't issue a query.
1258+
1259+
Here is a description:
1260+
```
1261+
{"error": { "message": STR, "code": INT } }
1262+
```
1263+
1264+
* **error** - a structured object which contains an internal error message.
1265+
This field exists only if an internal error occurred, for instance:
1266+
"too large request", "input json parse error", etc.
1267+
1268+
If this field exists, the input message was _probably_ not passed to
1269+
the Tarantool backend.
1270+
1271+
See "message"/"code" fields for details.
1272+
1273+
11171274
[Back to contents](#contents)
11181275

11191276
## Examples

0 commit comments

Comments
 (0)