From 8294bb34362672014b33b192f22668f0522a9d15 Mon Sep 17 00:00:00 2001 From: Reneta Popova Date: Mon, 3 Mar 2025 16:35:03 +0000 Subject: [PATCH 01/11] Add examples to the glossary descriptions --- .../ROOT/pages/errors/gql-errors/52N36.adoc | 1 + .../notifications/all-notifications.adoc | 8 +- modules/ROOT/partials/glossary.adoc | 126 ++++++++++-------- 3 files changed, 74 insertions(+), 61 deletions(-) diff --git a/modules/ROOT/pages/errors/gql-errors/52N36.adoc b/modules/ROOT/pages/errors/gql-errors/52N36.adoc index dc6b90b2..58c6b95d 100644 --- a/modules/ROOT/pages/errors/gql-errors/52N36.adoc +++ b/modules/ROOT/pages/errors/gql-errors/52N36.adoc @@ -3,6 +3,7 @@ == Status description error: procedure exception - invalid procedure argument with API documentation hint. Invalid argument `{ <> }` for `{ <> }` on procedure `{ <> }`. The expected format of `{ <> }` is outlined in the `{ <> }` API documentation. + ifndef::backend-pdf[] [discrete.glossary] == Glossary diff --git a/modules/ROOT/pages/notifications/all-notifications.adoc b/modules/ROOT/pages/notifications/all-notifications.adoc index 90b09bba..0328326a 100644 --- a/modules/ROOT/pages/notifications/all-notifications.adoc +++ b/modules/ROOT/pages/notifications/all-notifications.adoc @@ -1242,7 +1242,7 @@ m|UNSUPPORTED m|01N40 |Status description a|warn: unsupported runtime. -The query cannot be executed with `{ $preparser_input1 }`, `{ $preparser_input2 }` is used. +The query cannot be executed with `{ $preparserInput1 }`, `{ $preparserInput2 }` is used. Cause: `{ $msg }`. |Classification m|UNSUPPORTED @@ -3604,7 +3604,7 @@ m|SECURITY |GQLSTATUS code m|01N72 |Status description -a|warn: insecure URL protocol. Query uses an insecure protocol. Consider using 'https' instead. +a|warn: insecure URL protocol. Query uses an insecure protocol. Consider using 'https' instead. |Classification m|SECURITY |SeverityLevel @@ -4299,7 +4299,7 @@ m|00NA0 |Status description a|note: successful completion - index or constraint already exists. `{ $cmd }` has no effect. -`{ $index_constr_pat }` already exists. +`{ $idxOrConstrPat }` already exists. |SeverityLevel m|INFORMATION |=== @@ -4530,7 +4530,7 @@ m|00NA1 |Status description a|note: successful completion - index or constraint does not exist. `{ $cmd }` has no effect. -`{ $index_constr_name }` does not exist. +`{ $idxOrConstr }` does not exist. |SeverityLevel m|INFORMATION |=== diff --git a/modules/ROOT/partials/glossary.adoc b/modules/ROOT/partials/glossary.adoc index c9171aa9..aedadbd7 100644 --- a/modules/ROOT/partials/glossary.adoc +++ b/modules/ROOT/partials/glossary.adoc @@ -1,82 +1,94 @@ [glossary] [[action]]$action:: Freeform description of an action. -[[alias]]$alias:: An alias name. -[[alloc]]$alloc:: Allocator name. -[[allocType]]$allocType:: Allocation type. -[[auth]]$auth:: Auth provider name. -[[boltMsgLenLimit]]$boltMsgLenLimit:: Bolt message length limit. -[[boltServerState]]$boltServerState:: Bolt server state. +//$action will be replaced by cmd and msg depending on the usage. +[[alias]]$alias:: An alias name, `mydb-alias`. +[[allocType]]$allocType:: Allocation type (`primary` or `secondary`). +[[arg]]$arg:: Procedure or function argument, for example, `database`, `pause`, `dryrun`, etc. +[[argType]]$argType:: Argument type, either input or output. +[[auth]]$auth:: Auth provider name, for example, `ldap`, `native`. +[[boltServerState]]$boltServerState:: Bolt server state, for example, `READY`. [[cause]]$cause:: Freeform description of what caused the error. [[cfgSetting]]$cfgSetting:: Configuration setting key, for example, `server.https.enabled`. -[[clause]]$clause:: A clause, for example, `USE`. -[[cmd]]$cmd:: Cypher administrative command, for example, `DROP DATABASE`. -[[component]]$component:: Component name. -[[constr]]$constr:: Constraint name. -[[constrDescrOrName]]$constrDescrOrName:: Constraint descriptor or name. -[[context]]$context:: Freeform description of a context. -[[coordinates]]$coordinates:: Coordinate value. -[[count]]$count:: Amount +[[clause]]$clause:: A Cypher clause, for example, `USE`, `MATCH`. +[[cmd]]$cmd:: A Cypher command, for example, `DROP DATABASE`, `PROFILE`, `SHOW PROCEDURES`. +[[component]]$component:: Data type component, for example, `year`, `month`, `hour`, etc. +// we need to change the parameter $component in 51N27 to `$feat` maybe. +[[constr]]$constr:: Constraint name, for example, `book_isbn`. +//Change $constr to $constrName +[[constrDescrOrName]]$constrDescrOrName:: Constraint description, `(:Label {property0, property1, property2, property1, property3})`. +//Change $constrDescrOrName to $constrDescr +[[context]]$context:: Freeform description of a context, where something is invalid or unsupported, `OPTIONS`, `URL`, `username`, etc. +[[coordinates]]$coordinates:: Coordinate value, for example, `[3.15, 4.012, 5.905]`. +[[count]]$count:: Number of something, example, `3`. [[countAllocs]]$countAllocs:: Desired number of servers to use. [[countSeeders]]$countSeeders:: Number of seeding servers. -[[crs]]$crs:: Coordinate reference system, for example, WGS84. +//To check with the clustering team about $countAllocs and $countSeeders. +[[crs]]$crs:: Coordinate reference system, for example, `WGS84`. [[db]]$db:: Database name, for example, `myDb`. -[[dim]]$dim:: Number representing index dimenionality. -[[edition]]$edition:: Freeform edition description. -[[endpointType]]$endpointType:: One of `start`, `end`. +[[dim]]$dim:: Number representing index or point dimenionality. +[[edition]]$edition:: Neo4j edition, for example, Community or Enterprise. +[[endpointType]]$endpointType:: One of `start` or `end` of a relationship. [[entityId]]$entityId:: ID of a node or a relationship. [[entityType]]$entityType:: A node or a relationship. [[expr]]$expr:: Cypher expression, for example, `1 + n.prop`. -[[exprType]]$exprType:: Freeform expression type. +[[exprType]]$exprType:: Freeform expression type, for example, `EXISTS`, `COUNT`, `COLLECT`. [[feat]]$feat:: Freeform feature description. -[[field]]$field:: Input field, for example, for a procedure or deserialization. -[[format]]$format:: Duration format. -[[fun]]$fun:: Function name. -[[funClass]]$funClass:: User defined function implementation class name. +[[field]]$field:: Input field, for example, of a procedure, function, or deserialization. +//52N22 and 52N36 to change $field to $arg. Check 22N98 with Antonio. +[[fun]]$fun:: Function name, for example, `collect()`. +[[funClass]]$funClass:: User-defined function implementation class name, for example, `MyFunctionClass`. [[graph]]$graph:: The name of a graph, for example, `myGraph`. -[[graphTypeDependence]]$graphTypeDependence:: Graph type dependencency for constraint. -[[hint]]$hint:: Freeform description of a "hint". -[[hintList]]$hintList:: Comma-separated list of free form descriptions of hints. -[[ident]]$ident:: Generic identifier. -[[idx]]$idx:: Index name. -[[idxDescr]]$idxDescr:: Index descriptor. +[[graphTypeDependence]]$graphTypeDependence:: Graph type dependencency for constraint, one of `UNDESIGNATED`, `INDEPENDENT`, or `DEPENDENT`. +[[hint]]$hint:: Freeform description of a hint, for example, `USING INDEX n:N(prop)`. +[[hintList]]$hintList:: A list of free form descriptions of hints like `USING INDEX n:N(prop)`. +[[idx]]$idx:: Index name, `my_index`. +//Change $idx to $idxName +[[idxDescr]]$idxDescr:: Index description, for example, `INDEX :Person(name)`. [[idxDescrOrName]]$idxDescrOrName:: Index descriptor or name. -[[idxOrConstr]]$idxOrConstr:: Index or constraint name -[[idxOrConstrPat]]$idxOrConstrPat:: Index or constraint pattern +//Change all error parameters to $idxDescr or $idxName, and remove $idxDescrOrName. +[[idxOrConstr]]$idxOrConstr:: Index or constraint name, for example, `my_index` or `book_isbn`. +[[idxOrConstrPat]]$idxOrConstrPat:: Index or constraint pattern, for example, `CREATE CONSTRAINT bar IF NOT EXISTS FOR (n:L) REQUIRE (n.p1) IS NODE KEY`. [[idxType]]$idxType:: Index type, for example, text, vector, etc. -[[input]]$input:: Piece of input. -[[inputList]]$inputList:: Comma-separated list of inputs. +[[input]]$input:: Piece of user input. +[[inputList]]$inputList:: A list of user inputs. [[item]]$item:: Freeform description of an item. +//Change 22N90 to $valType, 51N30 to $feat maybe (check with Lasse). Remove $item. [[keyword]]$keyword:: Cypher keyword, for example, `MERGE`. [[label]]$label:: Label name, for example, `Person`. -[[labelExpr]]$labelExpr:: Label expression, for example, `Person&Human`. -[[labelList]]$labelList:: Comma-separated list of label names, for example, `Person, Actor`. -[[lower]]$lower:: Lower bound. +[[labelExpr]]$labelExpr:: Label expression, for example, `(n:Movie|Person)`. +[[labelList]]$labelList:: A list of label names, for example, `Person, Actor`. +[[lower]]$lower:: The lowest accepted number of a range. [[mapKey]]$mapKey:: Map key. -[[mapKeyList]]$mapKeyList:: Comma-separated list of keys. -[[matchMode]]$matchMode:: GPM match mode. -[[maxTokenLength]]$maxTokenLength:: Maximum token length. -[[msg]]$msg:: Freeform message, for example, "Howdy, Partner!". +[[mapKeyList]]$mapKeyList:: A list of map keys, for example, `x and y`. +[[matchMode]]$matchMode:: GPM match mode, for example, `REPEATABLE ELEMENTS`. +[[msg]]$msg:: Freeform message. [[msgTitle]]$msgTitle:: Freeform message title. -[[namespace]]$namespace:: Namespace -[[namespaceList]]$namespaceList:: Comma-separated list of namespaces. -[[operation]]$operation:: Operation, for example, a function. +//Change $msgTitle to $excClass +[[namespaceList]]$namespaceList:: A list of namespaces of procedures, for example, `apoc.math.`. +[[operation]]$operation:: A mathematical operation, for example, `/ by zero`, `>`. +//Change 51N69 to something else. [[option]]$option:: Option name -[[optionList]]$optionList:: Comma-separated list of option names. -[[param]]$param:: Parameter name -[[paramList]]$paramList:: Parameter list +//This needs further investigation. +[[optionList]]$optionList:: A list of option names. +//This needs further investigation. +[[param]]$param:: Parameter name, for example, `$pattern`. +[[paramList]]$paramList:: A list of parameters, for example `$pattern, $prop`. [[pat]]$pat:: Pattern, for example, `(:Person)`. -[[port]]$port:: Port name -[[portList]]$portList:: Comma-separated list of port names. -[[pos]]$pos:: A position, for example, in a sequence. -[[pred]]$pred:: A predicate, for example, `'x = 3'`. -[[predList]]$predList:: Comma-separated list of predicates, for example, `'x = 3', 'y > 4'`. +[[port]]$port:: Port name, for example, `6362`. +[[portList]]$portList:: A list of port names, for example, `6362, 6000, 7000`. +[[pos]]$pos:: A position, for example, in a sequence, for example, `2` +[[pred]]$pred:: A predicate, for example, `x = 3`. +[[predList]]$predList:: A list of predicates, for example, `'x = 3', 'y > 4'`. [[preparserInput]]$preparserInput:: Piece of preparser input. -[[proc]]$proc:: Procedure name, for example, `lauchRocket`. -[[procClass]]$procClass:: Procedure implementation class name. -[[procExeMode]]$procExeMode:: Procedure execution mode -[[procField]]$procField:: Procedure implementation class field name, for example, `someField`. -[[procFieldType]]$procFieldType:: Procedure implmenetation class field type. +//Change in the code to $input and update the notifications. +[[proc]]$proc:: Procedure name, for example, `db.labels()`. +[[procClass]]$procClass:: User-defined procedure implementation class name, for example, `MyProcedureClass`. +[[procExeMode]]$procExeMode:: Procedure execution mode, one of `READ`, `WRITE`, `SCHEMA`, and `DBMS`. +[[procField]]$procField:: Procedure implementation class argument name, for example, `myArgument`. +//Change $proField to $arg +[[procFieldType]]$procFieldType:: Procedure implmenetation class argument type, one of `input` or `output`. +//Change $procFieldType to $argType //// //// //// //// //// //// [[procFun]]$procFun:: Procedure or function name or ID. [[procMethod]]$procMethod:: Procedure implmenetation class method name. [[procParam]]$procParam:: Procedure parameter name. @@ -99,7 +111,7 @@ [[serverType]]$serverType:: Server type. [[sig]]$sig:: Procedure or function signature. [[syntax]]$syntax:: Freeform syntax or keyword. -[[temporal]]$temporal:: Temporal value. +[[temporal]]$temporal:: Temporal value, for example, `2025-02-18`. [[timeAmount]]$timeAmount:: Integral amount of time unit. [[timeUnit]]$timeUnit:: Common time unit name. [[token]]$token:: Token name. From af920c1a7574bb9d33e51867c5c0c044b1fa0c3e Mon Sep 17 00:00:00 2001 From: Reneta Popova Date: Tue, 4 Mar 2025 10:11:54 +0000 Subject: [PATCH 02/11] update serverType --- modules/ROOT/partials/glossary.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/partials/glossary.adoc b/modules/ROOT/partials/glossary.adoc index aedadbd7..51e8dd3e 100644 --- a/modules/ROOT/partials/glossary.adoc +++ b/modules/ROOT/partials/glossary.adoc @@ -108,7 +108,7 @@ [[selectorType]]$selectorType:: Selector type. [[server]]$server:: Server name or ID, for example, `25a7efc7-d063-44b8-bdee-f23357f89f01`. [[serverList]]$serverList:: Comma-separated list of server names or IDs, for example, `'server-1', 'server-2'`. -[[serverType]]$serverType:: Server type. +[[serverType]]$serverType:: Server type, `PRIMARY` (primaryConstrained), `SECONDARY` (secondaryConstrained), or NONE. [[sig]]$sig:: Procedure or function signature. [[syntax]]$syntax:: Freeform syntax or keyword. [[temporal]]$temporal:: Temporal value, for example, `2025-02-18`. From 9ba8c612122c51dd44901aae7ed1973e959f6023 Mon Sep 17 00:00:00 2001 From: Reneta Popova Date: Fri, 14 Mar 2025 18:31:40 +0000 Subject: [PATCH 03/11] Update the rest of the parameters descriptions, add hover-over to notifictaions, and fix inconsistencies in variables and descriptions --- .../ROOT/pages/errors/gql-errors/50N21.adoc | 7 + .../notifications/all-notifications.adoc | 122 +++++++++--------- modules/ROOT/partials/glossary.adoc | 63 ++++----- 3 files changed, 102 insertions(+), 90 deletions(-) diff --git a/modules/ROOT/pages/errors/gql-errors/50N21.adoc b/modules/ROOT/pages/errors/gql-errors/50N21.adoc index bdc518ad..c1524eba 100644 --- a/modules/ROOT/pages/errors/gql-errors/50N21.adoc +++ b/modules/ROOT/pages/errors/gql-errors/50N21.adoc @@ -3,6 +3,13 @@ == Status description error: general processing exception - no such schema descriptor. The `{ <> }` was not found for `{ <> }`. Verify that the spelling is correct. +For example: + +[source, shell] +---- +error: general processing exception - no such schema descriptor. The label property existence constraint was not found for '(:Label1 {prop1})'. Verify that the spelling is correct.") +---- + ifndef::backend-pdf[] [discrete.glossary] == Glossary diff --git a/modules/ROOT/pages/notifications/all-notifications.adoc b/modules/ROOT/pages/notifications/all-notifications.adoc index 0328326a..d35ddefa 100644 --- a/modules/ROOT/pages/notifications/all-notifications.adoc +++ b/modules/ROOT/pages/notifications/all-notifications.adoc @@ -46,7 +46,7 @@ m|PERFORMANCE m|03N90 |Status description a|info: cartesian product. -The disconnected patterns `{ $pat }` build a cartesian product. +The disconnected patterns `{ <> }` build a cartesian product. A cartesian product may produce a large amount of data and slow down query processing. |Classification m|PERFORMANCE @@ -137,7 +137,7 @@ m|PERFORMANCE |GQLSTATUS code m|03N91 |Status description -a|info: unbounded variable length pattern. The provided pattern `{ $pat }` is unbounded. +a|info: unbounded variable length pattern. The provided pattern `{ <> }` is unbounded. Shortest path with an unbounded pattern may result in long execution times. Use an upper limit (e.g. `[*..5]`) on the number of node hops in your pattern. |Classification @@ -229,7 +229,7 @@ m|PERFORMANCE m|03N92 |Status description a|info: exhaustive shortest path. -The query runs with exhaustive shortest path due to the existential predicate(s) `{ $pred_list }`. +The query runs with exhaustive shortest path due to the existential predicate(s) `{ <> }`. It may be possible to use `WITH` to separate the `MATCH` from the existential predicate(s). |Classification m|PERFORMANCE @@ -322,7 +322,7 @@ m|03N93 |Status description a|info: no applicable index. `LOAD CSV` in combination with `MATCH` or `MERGE` on a label that does not have an index may result in long execution times. -Consider adding an index for label `{ $label }`. +Consider adding an index for label `{ <