Skip to content

Commit 4ae5d32

Browse files
renetapopovarenetapopova
committed
Document GQLSTATUS parameters
1 parent dba3ded commit 4ae5d32

File tree

2 files changed

+122
-0
lines changed

2 files changed

+122
-0
lines changed

‎modules/ROOT/content-nav.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
** xref:errors/all-errors.adoc[]
55
* xref:notifications/index.adoc[]
66
** xref:notifications/all-notifications.adoc[]
7+
* xref:shared-parametes.adoc[]
78
* xref:changelogs.adoc[]
89
910

‎modules/ROOT/pages/shared-parametes.adoc‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
:description: This page lists all parameters that are used in the GQLSTATUS codes, with their descriptions and possible values, and variants.
2+
3+
= GQLSTATUS codes parameters
4+
5+
The following table lists all parameters that are used in the GQLSTATUS codes, with their descriptions and possible values, and variants.
6+
7+
[cols="3m,2m,3a,2a,2",options="header", background="header"]
8+
|===
9+
| Parameter | Processor | Description | Variants | Used in
10+
| $action | VERBATIM | Freeform description of some "action" | | errors
11+
| $alias | IDENT | Alias name | | errors
12+
| $alloc | IDENT | Allocator name | | errors
13+
| $allocType | STRLIT | Allocation type | | errors
14+
| $auth | IDENT | Auth provider name | | errors & notifications
15+
| $boltMsgLenLimit | NUM | Bolt message length limit | | errors
16+
| $boltServerState | STRLIT | Bolt server state | | errors
17+
| $cause | VERBATIM | Freeform cause | | errors & notifications
18+
| $cfgSetting | VERBATIM | Configuration setting key, e.g. `https.enabled` | | errors & notifications
19+
| $clause | UPPER(VERBATIM) | Clause | | errors
20+
| $cmd | STRLIT | Command, e.g. `DROP DATABASE` | | errors & notifications
21+
| $component | STRLIT | Component name | | errors
22+
| $constr | IDENT | Constraint name | | errors
23+
| $constrDescrOrName | STRLIT | Constraint descriptor or name | | errors
24+
| $context | VERBATIM | Freeform description of some "context" | | errors
25+
| $coordinates | COORDINATES | Coordinates | | errors
26+
| $count | NONNEG | Amount | `$count`, `$count1`, `$count2` | errors
27+
| $countAllocs | NUM | Desired number of servers to use | | errors
28+
| $countSeeders | NUM | Number of seeding servers | | errors
29+
| $crs | VERBATIM | Coordinate reference system, e.g. WGS84 | | errors
30+
| $db | IDENT | Database name, e.g. `myDb` | for notifications: `$db`; for errors: `$db`, `$db1`, etc. | errors & notifications
31+
| $dim | NONNEG | Number representing index dimenionality | `$dim1`, `$dim2` | errors
32+
| $edition | VERBATIM | Freeform edition description | | errors
33+
| $entityId | NUM | ID of a node or relationship | | errors
34+
| $entityType | VERBATIM | One of 'node', 'relationship' | | errors
35+
| $expr | STRLIT | Cypher expression, e.g. `1 + n.prop` | | errors
36+
| $exprType | VERBATIM | Freeform expression type | | errors
37+
| $feat | VERBATIM | Freeform feature description | for notifications: `$feat1`, `$feat2`; for errors: `$feat` | errors & notifications
38+
| $field | IDENT | Input field to e.g. a procedure or deserialization | | errors
39+
| $format | STRLIT | Duration format | |
40+
| $fun | CALLABLE_IDENT | Function name | | errors
41+
| $funClass | IDENT | User defined function implementation class name | |
42+
| $graph | IDENT | Graph name, e.g. `myGraph` | | errors
43+
| $hint | VERBATIM | Freeform description of some "hint" | | errors
44+
| $hintList | NELIST ($hint) | Comma-separated list of free form descriptions of some "hints" | | errors
45+
| $ident | IDENT | Generic identifier | |
46+
| $idx | IDENT | Index name | | errors
47+
| $idxDescr | STRLIT | Index descriptor | | notifications
48+
| $idxDescrOrName | STRLIT | Index descriptor or name | | errors
49+
| $idxOrConstr | IDENT | Index or constraint name | | notifications
50+
| $idxOrConstrPat | STRLIT | Index or constraint pattern | | notifications
51+
| $idxType | VERBATIM | Index type (e.g, text, vector, ...) | |
52+
| $input | STRLIT | Piece of input | `$input`, `$input1`, `$input2` | errors
53+
| $inputList | NELIST($input) | Comma-separated list of "inputs" | | errors
54+
| $item | VERBATIM | Freeform description of some "item" | | notifications, errors
55+
| $keyword | STRLIT | Cypher keyword, e.g. `MERGE` | | errors
56+
| $label | IDENT | Label name, e.g. `Person` | | notifications
57+
| $labelExpr | STRLIT | Label expression, e.g. `Person&Human` | | errors
58+
| $labelList | NELIST($label) | Comma-separated list of label names, e.g. `Person, Actor`| | notifications
59+
| $lower | NUM | Lower bound | | errors
60+
| $mapKey | STRLIT | Map key | | errors
61+
| $mapKeyList | NELIST($mapKey) | Comma-separated list of keys | | errors
62+
| $matchMode | VERBATIM | A GPM match mode | |
63+
| $msg | VERBATIM | Freeform message, e.g. Howdy, Partner! | | notifications, errors
64+
| $msgTitle | VERBATIM | Freeform message tite | | errors
65+
| $namespace | IDENT | Namespace | |
66+
| $namespaceList | NELIST($namespace)| Comma-separated list of namespaces | | errors
67+
| $operation | STRLIT | Operation | | errors
68+
| $option | STRLIT | Option name | `$option`, `$option1`, `$option2`| errors
69+
| $optionList | NELIST($option) | Comma-separated list of option names | | errors
70+
| $param | PARAM | Parameter name | `$param`, `$param1`, `$param2` | errors
71+
| $paramList | NELIST($param) | Parameter list | `$name`, `$age` | notifications, errors
72+
| $pat | STRLIT | Pattern `(:Person)` | | notifications
73+
| $port | IDENT | Port name | | errors
74+
| $portList | NELIST($port) | Comma-separated list of port names | | errors
75+
| $pos | NUM | A position (e.g., in a sequence) | | errors
76+
| $pred | STRLIT | Predicate, e.g. `'x < 3'` | | errors
77+
| $predList | NELIST($pred) | Comma-separated list of predicates, e.g. `'x < 3', 'y > 4'`| | notifications
78+
| $preparserInput | STRLIT | Piece of preparser input | `$preParserInput1`, `$preParserInput2` | notifications
79+
| $proc | CALLABLE_IDENT | Procedure name, e.g. `lauchRocket` | | notifications, errors
80+
| $procClass | IDENT | Procedure implementation class name | | errors
81+
| $procExeMode | STRLIT | Procedure execution mode | | errors
82+
| $procField | IDENT | Procedure implementation class field name, e.g. `someField` | | notifications, errors
83+
| $procFieldType | STRLIT | Procedure implmenetation class field type | | errors
84+
| $procFun | CALLABLE_IDENT | Procedure or function name or ID | | errors
85+
| $procMethod | IDENT | Procedure implmenetation class method name | | errors
86+
| $procParam | IDENT | Procedure parameter name | | errors
87+
| $procParamFmt | VERBATIM | Freeform procedure parameter format | | errors
88+
| $propKey | IDENT | Property key name, e.g. `name` | | notifications, errors
89+
| $propKeyList | NELIST($propKey) | Comma-separated list of property key names | | errors
90+
| $query | STRLIT | Query string extract, e.g. `MATCH (n) WHERE n.prop...`| | errors
91+
| $reasonList | NELIST($value) | Comma-separated list of reasons of the failure | | errors
92+
| $relType | IDENT | Relationship type name, e.g. `KNOWS` | | notifications
93+
| $replacement | STRLIT | Replacement | | errors
94+
| $role | IDENT | Role name | | errors
95+
| $routingPolicy | STRLIT | Routing policy | | errors
96+
| $runtime | STRLIT | Cypher runtime name | | errors
97+
| $schemaDescr | STRLIT | Schema descriptor | |
98+
| $selector | VERBATIM | A GPM path selector | |
99+
| $selectorType | STRLIT | Selector type | |
100+
| $server | STRLIT | Server, e.g. `example.com` | | notifications, errors
101+
| $serverList | NELIST($server) | Comma-separated list of servers, e.g. `'a.com', 'b.com'`| | notifications, errors
102+
| $serverType | STRLIT | Server type | | errors
103+
| $sig | VERBATIM | Procedure or function signature | | errors
104+
| $syntax | IDENT | Freeform syntax or keyword | | errors
105+
| $temporal | TEMPORAL | Temporal value | | errors
106+
| $timeAmount | NUM | Integral amount of some time unit | | errors
107+
| $timeUnit | VERBATIM | Common time unit name | | errors
108+
| $token | STRLIT | Token name | | errors
109+
| $tokenId | STRLIT | Token ID | |
110+
| $tokenType | VERBATIM | Token type | | errors
111+
| $transactionId | STRLIT | Transaction ID | `$transactionId`,` $transactionId1`, `$transactionId2` | errors
112+
| $upper | NUM | Upper bound | | errors
113+
| $url | VERBATIM | URL | | errors
114+
| $user | IDENT | User name | | errors
115+
| $value | VAL | Value | | errors
116+
| $valueList | NELIST($value) | Comma-separated list of values | | errors
117+
| $valueType | VALTYPE | Value type | | errors
118+
| $valueTypeList | NELIST(VALTYPE) | Comma-separated list of value types | | errors
119+
| $variable | IDENT | Variable name, e.g. `n` | | notifications, errors
120+
| $variableList | NELIST($var) | Comma-separated list of variable names, e.g. `a, b, c` | | notifications, errors
121+
|===

0 commit comments

Comments
 (0)