diff --git a/modules/ROOT/pages/administration/access-control/manage-privileges.adoc b/modules/ROOT/pages/administration/access-control/manage-privileges.adoc index 7521a8ecc..155a8c235 100644 --- a/modules/ROOT/pages/administration/access-control/manage-privileges.adoc +++ b/modules/ROOT/pages/administration/access-control/manage-privileges.adoc @@ -250,7 +250,7 @@ Results will include multiple columns describing the privileges: | scope | List of possible scopes for the privilege (`elements`, `nodes`, `relationships`) or null if not applicable. -| LIST OF STRING +| LIST | description | A short description of the privilege. diff --git a/modules/ROOT/pages/administration/access-control/manage-users.adoc b/modules/ROOT/pages/administration/access-control/manage-users.adoc index 914fb4277..b677ada57 100644 --- a/modules/ROOT/pages/administration/access-control/manage-users.adoc +++ b/modules/ROOT/pages/administration/access-control/manage-users.adoc @@ -364,7 +364,7 @@ The currently logged-in user can be seen using `SHOW CURRENT USER`, which will p | Roles granted to the user. Will return `null` in community edition. -| LIST OF STRING +| LIST | {cross-mark} | {check-mark} @@ -444,7 +444,7 @@ Available users can be seen using `SHOW USERS`, which will produce a table of us | Roles granted to the user. Will return `null` in community edition. -| LIST OF STRING +| LIST | {cross-mark} | {check-mark} diff --git a/modules/ROOT/pages/administration/databases.adoc b/modules/ROOT/pages/administration/databases.adoc index cf5f236f3..1dc54e92c 100644 --- a/modules/ROOT/pages/administration/databases.adoc +++ b/modules/ROOT/pages/administration/databases.adoc @@ -146,7 +146,7 @@ These commands return the following columns: | aliases | The names of any aliases the database may have. label:default-output[] -| LIST OF STRING +| LIST | access | The database access mode, either `read-write` or `read-only`. label:default-output[] @@ -279,7 +279,7 @@ The lag is expressed in negative integers. In standalone environments, the value |constituents |The names of any constituents the database may have. label:default-output[] -| LIST OF STRING +| LIST |=== diff --git a/modules/ROOT/pages/administration/servers.adoc b/modules/ROOT/pages/administration/servers.adoc index 89e3c8d36..8e289eefc 100644 --- a/modules/ROOT/pages/administration/servers.adoc +++ b/modules/ROOT/pages/administration/servers.adoc @@ -232,32 +232,32 @@ The table of results shows information about the servers: | hosting | A list of databases currently hosted on the server. -| LIST OF STRING +| LIST | {check-mark} | {check-mark} | requestedHosting | A list of databases that should be hosted on the server. Composite databases do not currently appear in this list, though they do appear in `hosting` for all servers. -| LIST OF STRING +| LIST | | {check-mark} | tags | Tags are user provided strings that can be used while allocating databases. -| LIST OF STRING +| LIST | | {check-mark} | allowedDatabases | A list of databases allowed to be hosted on the server. -| LIST OF STRING +| LIST | | {check-mark} | deniedDatabases | A list of databases not allowed to be hosted on the server. -| LIST OF STRING +| LIST | | {check-mark} diff --git a/modules/ROOT/pages/clauses/listing-functions.adoc b/modules/ROOT/pages/clauses/listing-functions.adoc index c66903bd5..490cec8cc 100644 --- a/modules/ROOT/pages/clauses/listing-functions.adoc +++ b/modules/ROOT/pages/clauses/listing-functions.adoc @@ -47,7 +47,7 @@ m| BOOLEAN m| argumentDescription a| List of the arguments for the function, as map of strings and booleans with `name`, `type`, `default`, `isDeprecated`, and `description`. -m| LIST OF MAP +m| LIST m| returnDescription a| The return value type. @@ -61,13 +61,13 @@ m| rolesExecution a| List of roles permitted to execute this function. Is `null` without the xref::administration/access-control/dbms-administration.adoc#access-control-dbms-administration-role-management[`SHOW ROLE`] privilege. -m| LIST OF STRING +m| LIST m| rolesBoostedExecution a| List of roles permitted to use boosted mode when executing this function. Is `null` without the xref::administration/access-control/dbms-administration.adoc#access-control-dbms-administration-role-management[`SHOW ROLE`] privilege. -m| LIST OF STRING +m| LIST m| isDeprecated a| Whether the function is deprecated. @@ -151,31 +151,31 @@ SHOW FUNCTIONS | "abs" | "Numeric" -| "Returns the absolute value of an integer." +| "Returns the absolute value of an `INTEGER`." | "abs" | "Numeric" -| "Returns the absolute value of a floating point number." +| "Returns the absolute value of a `FLOAT`." | "acos" | "Trigonometric" -| "Returns the arccosine of a number in radians." +| "Returns the arccosine of a `FLOAT` in radians." | "all" | "Predicate" -| "Returns true if the predicate holds for all elements in the given list." +| "Returns true if the predicate holds for all elements in the given `LIST`." | "any" | "Predicate" -| "Returns true if the predicate holds for at least one element in the given list." +| "Returns true if the predicate holds for at least one element in the given `LIST`." | "asin" | "Trigonometric" -| "Returns the arcsine of a number in radians." +| "Returns the arcsine of a `FLOAT` in radians." | "atan" | "Trigonometric" -| "Returns the arctangent of a number in radians." +| "Returns the arctangent of a `FLOAT` in radians." | "atan2" | "Trigonometric" @@ -183,19 +183,19 @@ SHOW FUNCTIONS | "avg" | "Aggregating" -| "Returns the average of a set of integer values." +| "Returns the average of a set of `INTEGER` values." | "avg" | "Aggregating" -| "Returns the average of a set of floating point values." +| "Returns the average of a set of `FLOAT` values." | "avg" | "Aggregating" -| "Returns the average of a set of duration values." +| "Returns the average of a set of `DURATION` values." | "ceil" | "Numeric" -| "Returns the smallest floating point number that is greater than or equal to a number and equal to a mathematical integer." +| "Returns the smallest `FLOAT` that is greater than or equal to a number and equal to an `INTEGER`." | "coalesce" | "Scalar" @@ -207,11 +207,11 @@ SHOW FUNCTIONS | "cos" | "Trigonometric" -| "Returns the cosine of a number." +| "Returns the cosine of a `FLOAT`." | "cot" | "Trigonometric" -| "Returns the cotangent of a number." +| "Returns the cotangent of a `FLOAT`." | "count" | "Aggregating" @@ -219,15 +219,15 @@ SHOW FUNCTIONS | "date" | "Temporal" -| "Create a Date instant." +| "Creates a `DATE` instant." | "date.realtime" | "Temporal" -| "Get the current Date instant using the realtime clock." +| "Returns the current `DATE` instant using the realtime clock." | "date.statement" | "Temporal" -| "Get the current Date instant using the statement clock." +| "Returns the current `DATE` instant using the statement clock." 3+d|Rows: 20 |=== @@ -292,49 +292,49 @@ SHOW FUNCTIONS EXECUTABLE BY CURRENT USER YIELD * | "abs" | "Numeric" -| "Returns the absolute value of an integer." +| "Returns the absolute value of an `INTEGER`." | | | | "abs" | "Numeric" -| "Returns the absolute value of a floating point number." +| "Returns the absolute value of a `FLOAT`." | | | | "acos" | "Trigonometric" -| "Returns the arccosine of a number in radians." +| "Returns the arccosine of a `FLOAT` in radians." | | | | "all" | "Predicate" -| "Returns true if the predicate holds for all elements in the given list." +| "Returns true if the predicate holds for all elements in the given `LIST`." | | | | "any" | "Predicate" -| "Returns true if the predicate holds for at least one element in the given list." +| "Returns true if the predicate holds for at least one element in the given `LIST`." | | | | "asin" | "Trigonometric" -| "Returns the arcsine of a number in radians." +| "Returns the arcsine of a `FLOAT` in radians." | | | | "atan" | "Trigonometric" -| "Returns the arctangent of a number in radians." +| "Returns the arctangent of a `FLOAT` in radians." | | | @@ -348,14 +348,14 @@ SHOW FUNCTIONS EXECUTABLE BY CURRENT USER YIELD * | "avg" | "Aggregating" -| "Returns the average of a set of integer values." +| "Returns the average of a set of `INTEGER` values." | | | | "avg" | "Aggregating" -| "Returns the average of a set of floating point values." +| "Returns the average of a set of `FLOAT` values." | | | @@ -388,31 +388,31 @@ SHOW FUNCTIONS EXECUTABLE BY jake | "abs" | "Numeric" -| "Returns the absolute value of an integer." +| "Returns the absolute value of an `INTEGER`." | "abs" | "Numeric" -| "Returns the absolute value of a floating point number." +| "Returns the absolute value of a `FLOAT`." | "acos" | "Trigonometric" -| "Returns the arccosine of a number in radians." +| "Returns the arccosine of a `FLOAT` in radians." | "all" | "Predicate" -| "Returns true if the predicate holds for all elements in the given list." +| "Returns true if the predicate holds for all elements in the given `LIST`." | "any" | "Predicate" -| "Returns true if the predicate holds for at least one element in the given list." +| "Returns true if the predicate holds for at least one element in the given `LIST`." | "asin" | "Trigonometric" -| "Returns the arcsine of a number in radians." +| "Returns the arcsine of a `FLOAT` in radians." | "atan" | "Trigonometric" -| "Returns the arctangent of a number in radians." +| "Returns the arctangent of a `FLOAT` in radians." | "atan2" | "Trigonometric" @@ -420,11 +420,11 @@ SHOW FUNCTIONS EXECUTABLE BY jake | "avg" | "Aggregating" -| "Returns the average of a set of integer values." +| "Returns the average of a set of `INTEGER` values." | "avg" | "Aggregating" -| "Returns the average of a set of floating point values." +| "Returns the average of a set of `FLOAT` values." 3+d|Rows: 10 |=== diff --git a/modules/ROOT/pages/clauses/listing-procedures.adoc b/modules/ROOT/pages/clauses/listing-procedures.adoc index cf9952882e..0bc840b30 100644 --- a/modules/ROOT/pages/clauses/listing-procedures.adoc +++ b/modules/ROOT/pages/clauses/listing-procedures.adoc @@ -45,11 +45,11 @@ m| STRING m| argumentDescription a| List of the arguments for the procedure, as map of strings and booleans with `name`, `type`, `default`, `isDeprecated`, and `description`. -m| LIST OF MAP +m| LIST m| returnDescription a| List of the returned values for the procedure, as map of strings and booleans with `name`, `type`, `isDeprecated`, and `description`. -m| LIST OF MAP +m| LIST m| admin a| `true` if this procedure is an admin procedure. @@ -59,13 +59,13 @@ m| rolesExecution a| List of roles permitted to execute this procedure. Is `null` without the xref::administration/access-control/dbms-administration.adoc#access-control-dbms-administration-role-management[`SHOW ROLE`] privilege. -m| LIST OF STRING +m| LIST m| rolesBoostedExecution a| List of roles permitted to use boosted mode when executing this procedure. Is `null` without the xref::administration/access-control/dbms-administration.adoc#access-control-dbms-administration-role-management[`SHOW ROLE`] privilege. -m| LIST OF STRING +m| LIST m| isDeprecated a| Whether the procedure is deprecated. @@ -259,7 +259,7 @@ WHERE admin | "db.stats.retrieveAllAnonymized" | true | "db.stats.status" | true | "db.stats.stop" | true -| "dbms.checkConfigValue" | true+ +| "dbms.checkConfigValue" | true | "dbms.cluster.checkConnectivity" | true | "dbms.cluster.cordonServer" | true | "dbms.cluster.readReplicaToggle" | true diff --git a/modules/ROOT/pages/clauses/set.adoc b/modules/ROOT/pages/clauses/set.adoc index ee3e50b70..35cfc804a 100644 --- a/modules/ROOT/pages/clauses/set.adoc +++ b/modules/ROOT/pages/clauses/set.adoc @@ -151,7 +151,7 @@ SET n.age = toString(n.age) RETURN n.name, n.age ---- -The `age` property has been converted to the string `'36'`. +The `age` property has been converted to the `STRING` `'36'`. .Result [role="queryresult",options="header,footer",cols="2* // New in 5.0 m| currentQueryStartTime diff --git a/modules/ROOT/pages/clauses/where.adoc b/modules/ROOT/pages/clauses/where.adoc index d37f8de9d..1c40809da 100644 --- a/modules/ROOT/pages/clauses/where.adoc +++ b/modules/ROOT/pages/clauses/where.adoc @@ -469,7 +469,7 @@ WHERE n.name =~ '(?i)AND.*' RETURN n.name, n.age ---- -The `name` and `age`` for `Andy` are returned because his name starts with 'AND' irrespective of casing: +The `name` and `age` for `Andy` are returned because his name starts with 'AND' irrespective of casing: .Result [role="queryresult",options="header,footer",cols="2* | properties | The properties of this constraint. label:default-output[] -| LIST OF STRING +| LIST | ownedIndex | The name of the index associated with the constraint or `null`, in case no index is associated with it. label:default-output[] diff --git a/modules/ROOT/pages/functions/aggregating.adoc b/modules/ROOT/pages/functions/aggregating.adoc index 015826f19..a6352ad13 100644 --- a/modules/ROOT/pages/functions/aggregating.adoc +++ b/modules/ROOT/pages/functions/aggregating.adoc @@ -31,7 +31,7 @@ For more information, see xref:functions/aggregating.adoc#grouping-keys[Grouping RETURN n.x + count(*) ---- -To sort the result set using aggregating functions, the aggregation must be included in the `ORDER BY` sub-clause following the`RETURN` clause. +To sort the result set using aggregating functions, the aggregation must be included in the `ORDER BY` sub-clause following the `RETURN` clause. The `DISTINCT` operator works in conjunction with aggregation. It is used to make all values unique before running them through an aggregating function. @@ -65,7 +65,7 @@ CREATE [[functions-avg]] == avg() - Numeric values -The function `avg()` returns the average of a set of numeric values. +The function `avg()` returns the average of a set of `INTEGER` or `FLOAT` values. [source, syntax] ---- @@ -76,7 +76,7 @@ avg(expression) |=== -| Either an Integer or a Float, depending on the values returned by `expression` and whether or not the calculation overflows. +| Either an `INTEGER` or a `FLOAT`, depending on the values returned by `expression` and whether or not the calculation overflows. |=== @@ -129,7 +129,7 @@ The average of all the values in the property `age` is returned: [[functions-avg-duration]] == avg() - Durations -The function `avg()` returns the average of a set of Durations. +The function `avg()` returns the average of a set of `DURATION` values. [source, syntax] ---- @@ -140,7 +140,7 @@ avg(expression) |=== -| A Duration. +| `DURATION` |=== @@ -152,7 +152,7 @@ avg(expression) | Name | Description | `expression` -| An expression returning a set of Durations. +| An expression returning a set of `DURATION` values. |=== @@ -177,7 +177,7 @@ UNWIND [duration('P2DT3H'), duration('PT1H45S')] AS dur RETURN avg(dur) ---- -The average of the two supplied Durations is returned: +The average of the two supplied `DURATION` values is returned: .Result [role="queryresult",options="header,footer",cols="1*`. 1.1+| xref::functions/predicate.adoc#functions-any[`any()`] | `any(variable :: VARIABLE IN list :: LIST OF ANY? WHERE predicate :: ANY?) :: (BOOLEAN?)` -| Returns true if the predicate holds for at least one element in the given list. +| Returns true if the predicate holds for at least one element in the given `LIST`. 1.1+| xref::functions/predicate.adoc#functions-exists[`exists()`] | `exists(input :: ANY?) :: (BOOLEAN?)` @@ -67,19 +67,19 @@ These functions return either true or false for the given arguments. 1.3+| xref::functions/predicate.adoc#functions-isempty[`isEmpty()`] | `isEmpty(input :: LIST? OF ANY?) :: (BOOLEAN?)` -| Checks whether a list is empty. +| Checks whether a `LIST` is empty. | `isEmpty(input :: MAP?) :: (BOOLEAN?)` -| Checks whether a map is empty. +| Checks whether a `MAP` is empty. | `isEmpty(input :: STRING?) :: (BOOLEAN?)` -| Checks whether a string is empty. +| Checks whether a `STRING` is empty. 1.1+| xref::functions/predicate.adoc#functions-none[`none()`] | `none(variable :: VARIABLE IN list :: LIST OF ANY? WHERE predicate :: ANY?) :: (BOOLEAN?)` -| Returns true if the predicate holds for no element in the given list. +| Returns true if the predicate holds for no element in the given `LIST`. 1.1+| xref::functions/predicate.adoc#functions-single[`single()`] | `single(variable :: VARIABLE IN list :: LIST OF ANY? WHERE predicate :: ANY?) :: (BOOLEAN?)` -| Returns true if the predicate holds for exactly one of the elements in the given list. +| Returns true if the predicate holds for exactly one of the elements in the given `LIST`. |=== @@ -99,33 +99,33 @@ These functions return a single value. 1.1+| xref::functions/scalar.adoc#functions-endnode[`endNode()`] | `endNode(input :: RELATIONSHIP?) :: (NODE?)` -| Returns the end node of a relationship. +| Returns the end `NODE` of a `RELATIONSHIP`. 1.1+| xref::functions/scalar.adoc#functions-head[`head()`] | `head(list :: LIST? OF ANY?) :: (ANY?)` -| Returns the first element in a list. +| Returns the first element in a `LIST`. 1.2+| xref::functions/scalar.adoc#functions-id[`id()`] | `id(input :: NODE?) :: (INTEGER?)` -| label:deprecated[] Returns the id of a node. Replaced by `elementId()` +| label:deprecated[] Returns the id of a `NODE`. Replaced by `elementId()` | `id(input :: RELATIONSHIP?) :: (INTEGER?)` -| label:deprecated[] Returns the id of a relationship. Replaced by `elementId()`. +| label:deprecated[] Returns the id of a `RELATIONSHIP`. Replaced by `elementId()`. 1.1+| xref::functions/scalar.adoc#functions-last[`last()`] | `last(list :: LIST? OF ANY?) :: (ANY?)` -| Returns the last element in a list. +| Returns the last element in a `LIST`. 1.1+| xref::functions/scalar.adoc#functions-length[`length()`] | `length(input :: PATH?) :: (INTEGER?)` -| Returns the length of a path. +| Returns the length of a `PATH`. 1.3+| xref::functions/scalar.adoc#functions-properties[`properties()`] | `properties(input :: MAP?) :: (MAP?)` -| Returns a map containing all the properties of a map. +| Returns a `MAP` containing all the properties of a `MAP`. | `properties(input :: NODE?) :: (MAP?)` -| Returns a map containing all the properties of a node. +| Returns a `MAP` containing all the properties of a `NODE`. | `properties(input :: RELATIONSHIP?) :: (MAP?)` -| Returns a map containing all the properties of a relationship. +| Returns a `MAP` containing all the properties of a `RELATIONSHIP`. 1.1+| xref::functions/scalar.adoc#functions-randomuuid[`randomUUID()`] | `randomUUID() :: (STRING?)` @@ -133,51 +133,51 @@ These functions return a single value. 1.2+| xref::functions/scalar.adoc#functions-size[`size()`] | `size(input :: LIST? OF ANY?) :: (INTEGER?)` -| Returns the number of items in a list. +| Returns the number of items in a `LIST`. | `size(input :: STRING?) :: (INTEGER?)` -| Returns the number of Unicode characters in a string. +| Returns the number of Unicode characters in a `STRING`. 1.1+| xref::functions/scalar.adoc#functions-startnode[`startNode()`] | `startNode(input :: RELATIONSHIP?) :: (NODE?)` -| Returns the start node of a relationship. +| Returns the start `NODE` of a `RELATIONSHIP`. 1.3+| xref::functions/scalar.adoc#functions-toboolean[`toBoolean()`] | `toBoolean(input :: STRING?) :: (BOOLEAN?)` -| Converts a string value to a boolean value. +| Converts a `STRING` value to a `BOOLEAN` value. | `toBoolean(input :: BOOLEAN?) :: (BOOLEAN?)` -| Converts a boolean value to a boolean value. +| Converts a `BOOLEAN` value to a `BOOLEAN` value. | `toBoolean(input :: INTEGER?) :: (BOOLEAN?)` -| Converts an integer value to a boolean value. +| Converts an `INTEGER` value to a `BOOLEAN` value. 1.1+| xref::functions/scalar.adoc#functions-tobooleanornull[`toBooleanOrNull()`] | `toBooleanOrNull(input :: ANY?) :: (BOOLEAN?)` -| Converts a value to a boolean value, or null if the value cannot be converted. +| Converts a value to a `BOOLEAN` value, or null if the value cannot be converted. 1.2+| xref::functions/scalar.adoc#functions-tofloat[`toFloat()`] | `toFloat(input :: NUMBER?) :: (FLOAT?)` -| Converts a number value to a floating point value. +| Converts an `INTEGER` value to a `FLOAT` value. | `toFloat(input :: STRING?) :: (FLOAT?)` -| Converts a string value to a floating point value. +| Converts a `STRING` value to a `FLOAT` value. 1.1+| xref::functions/scalar.adoc#functions-tofloatornull[`toFloatOrNull()`] | `toFloatOrNull(input :: ANY?) :: (FLOAT?)` -| Converts a value to a floating point value, or null if the value cannot be converted. +| Converts a value to a `FLOAT` value, or null if the value cannot be converted. 1.3+| xref::functions/scalar.adoc#functions-tointeger[`toInteger()`] | `toInteger(input :: NUMBER?) :: (INTEGER?)` -| Converts a number value to an integer value. +| Converts a `FLOAT` value to an `INTEGER` value. | `toInteger(input :: BOOLEAN?) :: (INTEGER?)` -| Converts a boolean value to an integer value. +| Converts a `BOOLEAN` value to an `INTEGER` value. | `toInteger(input :: STRING?) :: (INTEGER?)` -| Converts a string value to an integer value. +| Converts a `STRING` value to an `INTEGER` value. 1.1+| xref::functions/scalar.adoc#functions-tointegerornull[`toIntegerOrNull()`] | `toIntegerOrNull(input :: ANY?) :: (INTEGER?)` -| Converts a value to an integer value, or null if the value cannot be converted. +| Converts a value to an `INTEGER` value, or null if the value cannot be converted. 1.1+| xref::functions/scalar.adoc#functions-type[`type()`] | `type(input :: RELATIONSHIP?) :: (STRING?)` -| Returns the string representation of the relationship type. +| Returns a `STRING` representation of the `RELATIONSHIP` type. |=== @@ -193,11 +193,11 @@ These functions take multiple values as arguments, and calculate and return an a 1.3+| xref::functions/aggregating.adoc#functions-avg[`avg()`] | `avg(input :: DURATION?) :: (DURATION?)` -| Returns the average of a set of duration values. +| Returns the average of a set of `DURATION` values. | `avg(input :: FLOAT?) :: (FLOAT?)` -| Returns the average of a set of floating point values. +| Returns the average of a set of `FLOAT` values. | `avg(input :: INTEGER?) :: (INTEGER?)` -| Returns the average of a set of integer values. +| Returns the average of a set of `INTEGER` values. 1.1+| xref::functions/aggregating.adoc#functions-collect[`collect()`] | `collect(input :: ANY?) :: (LIST? OF ANY?)` @@ -221,9 +221,9 @@ These functions take multiple values as arguments, and calculate and return an a 1.2+| xref::functions/aggregating.adoc#functions-percentiledisc[`percentileDisc()`] | `percentileDisc(input :: FLOAT?, percentile :: FLOAT?) :: (FLOAT?)` -| Returns the nearest floating point value to the given percentile over a group using a rounding method. +| Returns the nearest `FLOAT` value to the given percentile over a group using a rounding method. | `percentileDisc(input :: INTEGER?, percentile :: FLOAT?) :: (INTEGER?)` -| Returns the nearest integer value to the given percentile over a group using a rounding method. +| Returns the nearest `INTEGER` value to the given percentile over a group using a rounding method. 1.1+| xref::functions/aggregating.adoc#functions-stdev[`stdev()`] | `stdev(input :: FLOAT?) :: (FLOAT?)` @@ -235,11 +235,11 @@ These functions take multiple values as arguments, and calculate and return an a 1.3+| xref::functions/aggregating.adoc#functions-sum[`sum()`] | `sum(input :: DURATION?) :: (DURATION?)` -| Returns the sum of a set of durations +| Returns the sum of a set of `DURATION` values. | `sum(input :: FLOAT?) :: (FLOAT?)` -| Returns the sum of a set of floats +| Returns the sum of a set of `FLOAT` values. | `sum(input :: INTEGER?) :: (INTEGER?)` -| Returns the sum of a set of integers +| Returns the sum of a set of `INTEGER` values. |=== @@ -257,65 +257,65 @@ Further details and examples of lists may be found in xref::values-and-types/lis 1.3+| xref::functions/list.adoc#functions-keys[`keys()`] | `keys(input :: MAP?) :: (LIST? OF STRING?)` -| Returns a list containing the string representations for all the property names of a map. +| Returns a `LIST` containing the `STRING` representations for all the property names of a `MAP`. | `keys(input :: NODE?) :: (LIST? OF STRING?)` -| Returns a list containing the string representations for all the property names of a node. +| Returns a `LIST` containing the `STRING` representations for all the property names of a `NODE`. | `keys(input :: RELATIONSHIP?) :: (LIST? OF STRING?)` -| Returns a list containing the string representations for all the property names of a relationship. +| Returns a `LIST` containing the `STRING` representations for all the property names of a `RELATIONSHIP`. 1.1+| xref::functions/list.adoc#functions-labels[`labels()`] | `labels(input :: NODE?) :: (LIST? OF STRING?)` -| Returns a list containing the string representations for all the labels of a node. +| Returns a `LIST` containing the `STRING` representations for all the labels of a `NODE`. 1.1+| xref::functions/list.adoc#functions-nodes[`nodes()`] | `nodes(input :: PATH?) :: (LIST? OF NODE?)` -| Returns a list containing all the nodes in a path. +| Returns a `LIST` containing all the `NODE` values in a `PATH`. 1.2+| xref::functions/list.adoc#functions-range[`range()`] | `range(start :: INTEGER?, end :: INTEGER?) :: (LIST? OF INTEGER?)` -| Returns a list comprising all integer values within a specified range. +| Returns a `LIST` comprising all `INTEGER` values within a specified range. | `range(start :: INTEGER?, end :: INTEGER?, step :: INTEGER?) :: (LIST? OF INTEGER?)` -| Returns a list comprising all integer values within a specified range created with step length. +| Returns a `LIST` comprising all `INTEGER` values within a specified range created with step length. 1.1+| xref::functions/list.adoc#functions-reduce[`reduce()`] | `reduce(accumulator :: VARIABLE = initial :: ANY?, variable :: VARIABLE IN list :: LIST OF ANY? \| expression :: ANY) :: (ANY?)` -| Runs an expression against individual elements of a list, storing the result of the expression in an accumulator. +| Runs an expression against individual elements of a `LIST`, storing the result of the expression in an accumulator. 1.1+| xref::functions/list.adoc#functions-relationships[`relationships()`] | `relationships(input :: PATH?) :: (LIST? OF RELATIONSHIP?)` -| Returns a list containing all the relationships in a path. +| Returns a `LIST` containing all the `RELATIONSHIP` values in a `PATH`. 1.1+| xref::functions/string.adoc#functions-reverse[`reverse()`] | `reverse(input :: LIST? OF ANY?) :: (LIST? OF ANY?)` -| Returns a list in which the order of all elements in the original list have been reversed. +| Returns a `LIST` in which the order of all elements in the given `LIST` have been reversed. 1.1+| xref::functions/list.adoc#functions-tail[`tail()`] | `tail(input :: LIST? OF ANY?) :: (LIST? OF ANY?)` -| Returns all but the first element in a list. +| Returns all but the first element in a `LIST`. 1.1+| xref::functions/list.adoc#functions-tobooleanlist[`toBooleanList()`] | `toBooleanList(input :: LIST? OF ANY?) :: (LIST? OF BOOLEAN?)` a| -Converts a list of values to a list of boolean values. -If any values are not convertible to boolean they will be null in the list returned. +Converts a `LIST` of values to a `LIST` values. +If any values are not convertible to `BOOLEAN` they will be null in the `LIST` returned. 1.1+| xref::functions/list.adoc#functions-tofloatlist[`toFloatList()`] | `toFloatList(input :: LIST? OF ANY?) :: (LIST? OF FLOAT?)` a| -Converts a list of values to a list of floating point values. -If any values are not convertible to floating point they will be null in the list returned. +Converts a `LIST` to a `LIST` values. +If any values are not convertible to `FLOAT` they will be null in the `LIST` returned. 1.1+| xref::functions/list.adoc#functions-tointegerlist[`toIntegerList()`] | `toIntegerList(input :: LIST? OF ANY?) :: (LIST? OF INTEGER?)` a| -Converts a list of values to a list of integer values. -If any values are not convertible to integer they will be null in the list returned. +Converts a `LIST` to a `LIST` values. +If any values are not convertible to `INTEGER` they will be null in the `LIST` returned. 1.1+| xref::functions/list.adoc#functions-tostringlist[`toStringList()`] | `toStringList(input :: LIST? OF ANY?) :: (LIST? OF STRING?)` a| -Converts a list of values to a list of string values. -If any values are not convertible to string they will be null in the list returned. +Converts a `LIST` to a `LIST` values. +If any values are not convertible to `STRING` they will be null in the `LIST` returned. |=== @@ -331,17 +331,17 @@ These functions all operate on numerical expressions only, and will return an er 1.2+| xref::functions/mathematical-numeric.adoc#functions-abs[`abs()`] | `abs(input :: FLOAT?) :: (FLOAT?)` -| Returns the absolute value of a floating point number. +| Returns the absolute value of a `FLOAT`. | `abs(input :: INTEGER?) :: (INTEGER?)` -| Returns the absolute value of an integer. +| Returns the absolute value of an `INTEGER`. 1.1+| xref::functions/mathematical-numeric.adoc#functions-ceil[`ceil()`] | `ceil(input :: FLOAT?) :: (FLOAT?)` -| Returns the smallest floating point number that is greater than or equal to a number and equal to a mathematical integer. +| Returns the smallest `FLOAT` that is greater than or equal to a number and equal to an `INTEGER`. 1.1+| xref::functions/mathematical-numeric.adoc#functions-floor[`floor()`] | `floor(input :: FLOAT?) :: (FLOAT?)` -| Returns the largest floating point number that is less than or equal to a number and equal to a mathematical integer. +| Returns the largest `FLOAT` that is less than or equal to a number and equal to an `INTEGER`. 1.2+| xref::functions/mathematical-numeric.adoc#functions-isnan[`isNaN()`] | `isNaN(input :: FLOAT?) :: (BOOLEAN?)` @@ -351,11 +351,11 @@ These functions all operate on numerical expressions only, and will return an er 1.1+| xref::functions/mathematical-numeric.adoc#functions-rand[`rand()`] | `rand() :: (FLOAT?)` -| Returns a random floating point number in the range from 0 (inclusive) to 1 (exclusive); i.e. [0,1). +| Returns a random `FLOAT` in the range from 0 (inclusive) to 1 (exclusive). 1.3+| xref::functions/mathematical-numeric.adoc#functions-round[`round()`] | `round(input :: FLOAT?) :: (FLOAT?)` -| Returns the value of a number rounded to the nearest integer. +| Returns the value of a number rounded to the nearest `INTEGER`. | `round(value :: FLOAT?, precision :: NUMBER?) :: (FLOAT?)` | Returns the value of a number rounded to the specified precision using rounding mode HALF_UP. | `round(value :: FLOAT?, precision :: NUMBER?, mode :: STRING?) :: (FLOAT?)` @@ -363,9 +363,9 @@ These functions all operate on numerical expressions only, and will return an er 1.2+| xref::functions/mathematical-numeric.adoc#functions-sign[`sign()`] | `sign(input :: FLOAT?) :: (INTEGER?)` -| Returns the signum of a floating point number: 0 if the number is 0, -1 for any negative number, and 1 for any positive number. +| Returns the signum of a `FLOAT`: 0 if the number is 0, -1 for any negative number, and 1 for any positive number. | `sign(input :: INTEGER?) :: (INTEGER?)` -| Returns the signum of an integer number: 0 if the number is 0, -1 for any negative number, and 1 for any positive number. +| Returns the signum of an `INTEGER`: 0 if the number is 0, -1 for any negative number, and 1 for any positive number. |=== @@ -389,15 +389,15 @@ These functions all operate on numerical expressions only, and will return an er 1.1+| xref::functions/mathematical-logarithmic.adoc#functions-log[`log()`] | `log(input :: FLOAT?) :: (FLOAT?)` -| Returns the natural logarithm of a number. +| Returns the natural logarithm of a `FLOAT`. 1.1+| xref::functions/mathematical-logarithmic.adoc#functions-log10[`log10()`] | `log10(input :: FLOAT?) :: (FLOAT?)` -| Returns the common logarithm (base 10) of a number. +| Returns the common logarithm (base 10) of a `FLOAT`. 1.1+| xref::functions/mathematical-logarithmic.adoc#functions-sqrt[`sqrt()`] | `sqrt(input :: FLOAT?) :: (FLOAT?)` -| Returns the square root of a number. +| Returns the square root of a `FLOAT`. |=== @@ -415,15 +415,15 @@ All trigonometric functions operate on radians, unless otherwise specified. 1.1+| xref::functions/mathematical-trigonometric.adoc#functions-acos[`acos()`] | `acos(input :: FLOAT?) :: (FLOAT?)` -| Returns the arccosine of a number in radians. +| Returns the arccosine of a `FLOAT` in radians. 1.1+| xref::functions/mathematical-trigonometric.adoc#functions-asin[`asin()`] | `asin(input :: FLOAT?) :: (FLOAT?)` -| Returns the arcsine of a number in radians. +| Returns the arcsine of a `FLOAT` in radians. 1.1+| xref::functions/mathematical-trigonometric.adoc#functions-atan[`atan()`] | `atan(input :: FLOAT?) :: (FLOAT?)` -| Returns the arctangent of a number in radians. +| Returns the arctangent of a `FLOAT` in radians. 1.1+| xref::functions/mathematical-trigonometric.adoc#functions-atan2[`atan2()`] | `atan2(y :: FLOAT?, x :: FLOAT?) :: (FLOAT?)` @@ -431,11 +431,11 @@ All trigonometric functions operate on radians, unless otherwise specified. 1.1+| xref::functions/mathematical-trigonometric.adoc#functions-cos[`cos()`] | `cos(input :: FLOAT?) :: (FLOAT?)` -| Returns the cosine of a number. +| Returns the cosine of a `FLOAT`. 1.1+| xref::functions/mathematical-trigonometric.adoc#functions-cot[`cot()`] | `cot(input :: FLOAT?) :: (FLOAT?)` -| Returns the cotangent of a number. +| Returns the cotangent of a `FLOAT`. 1.1+| xref::functions/mathematical-trigonometric.adoc#functions-degrees[`degrees()`] | `degrees(input :: FLOAT?) :: (FLOAT?)` @@ -455,11 +455,11 @@ All trigonometric functions operate on radians, unless otherwise specified. 1.1+| xref::functions/mathematical-trigonometric.adoc#functions-sin[`sin()`] | `sin(input :: FLOAT?) :: (FLOAT?)` -| Returns the sine of a number. +| Returns the sine of a `FLOAT`. 1.1+| xref::functions/mathematical-trigonometric.adoc#functions-tan[`tan()`] | `tan(input :: FLOAT?) :: (FLOAT?)` -| Returns the tangent of a number. +| Returns the tangent of a `FLOAT`. |=== @@ -475,59 +475,59 @@ These functions are used to manipulate strings or to create a string representat 1.1+| xref::functions/string.adoc#functions-left[`left()`] | `left(original :: STRING?, length :: INTEGER?) :: (STRING?)` -| Returns a string containing the specified number of leftmost characters of the original string. +| Returns a `STRING` containing the specified number (`INTEGER`) of leftmost characters in the given `STRING`. 1.1+| xref::functions/string.adoc#functions-ltrim[`ltrim()`] | `ltrim(input :: STRING?) :: (STRING?)` -| Returns the original string with leading whitespace removed. +| Returns the given `STRING` with leading whitespace removed. 1.1+| xref::functions/string.adoc#functions-replace[`replace()`] | `replace(original :: STRING?, search :: STRING?, replace :: STRING?) :: (STRING?)` -| Returns a string in which all occurrences of a specified search string in the original string have been replaced by another (specified) replace string. +| Returns a `STRING` in which all occurrences of a specified search `STRING` in the given `STRING` have been replaced by another (specified) replacement `STRING`. 1.1+| xref::functions/string.adoc#functions-reverse[`reverse()`] | `reverse(input :: STRING?) :: (STRING?)` -| Returns a string in which the order of all characters in the original string have been reversed. +| Returns a `STRING` in which the order of all characters in the given `STRING` have been reversed. 1.1+| xref::functions/string.adoc#functions-right[`right()`] | `right(original :: STRING?, length :: INTEGER?) :: (STRING?)` -| Returns a string containing the specified number of rightmost characters of the original string. +| Returns a `STRING` containing the specified number of rightmost characters in the given `STRING`. 1.1+| xref::functions/string.adoc#functions-rtrim[`rtrim()`] | `rtrim(input :: STRING?) :: (STRING?)` -| Returns the original string with trailing whitespace removed. +| Returns the given `STRING` with trailing whitespace removed. 1.2+| xref::functions/string.adoc#functions-split[`split()`] | `split(original :: STRING?, splitDelimiter :: STRING?) :: (LIST? OF STRING?)` -| Returns a list of strings resulting from the splitting of the original string around matches of the given delimiter. +| Returns a `LIST` resulting from the splitting of the given `STRING` around matches of the given delimiter. | `split(original :: STRING?, splitDelimiters :: LIST? OF STRING?) :: (LIST? OF STRING?)` -| Returns a list of strings resulting from the splitting of the original string around matches of any of the given delimiters. +| Returns a `LIST` resulting from the splitting of the given `STRING` around matches of any of the given delimiters. 1.2+| xref::functions/string.adoc#functions-substring[`substring()`] | `substring(original :: STRING?, start :: INTEGER?) :: (STRING?)` -| Returns a substring of the original string, beginning with a 0-based index start. +| Returns a substring of the given `STRING`, beginning with a 0-based index start. | `substring(original :: STRING?, start :: INTEGER?, length :: INTEGER?) :: (STRING?)` -| Returns a substring of length 'length' of the original string, beginning with a 0-based index start. +| Returns a substring of a given `length` from the given `STRING`, beginning with a 0-based index start. 1.1+| xref::functions/string.adoc#functions-tolower[`toLower()`] | `toLower(input :: STRING?) :: (STRING?)` -| Returns the original string in lowercase. +| Returns the given `STRING` in lowercase. 1.1+| xref::functions/string.adoc#functions-tostring[`toString()`] | `toString(input :: ANY?) :: (STRING?)` -| Converts an integer, float, boolean, point or temporal type (i.e. Date, Time, LocalTime, DateTime, LocalDateTime or Duration) value to a string. +| Converts an `INTEGER`, `FLOAT`, `BOOLEAN`, `POINT` or temporal type (i.e. `DATE`, `ZONED TIME`, `LOCAL TIME`, `ZONED DATETIME`, `LOCAL DATETIME` or `DURATION`) value to a `STRING`. 1.1+| xref::functions/string.adoc#functions-tostringornull[`toStringOrNull()`] | `toStringOrNull(input :: ANY?) :: (STRING?)` -| Converts an integer, float, boolean, point or temporal type (i.e. Date, Time, LocalTime, DateTime, LocalDateTime or Duration) value to a string, or null if the value cannot be converted. +| Converts an `INTEGER`, `FLOAT`, `BOOLEAN`, `POINT` or temporal type (i.e. `DATE`, `ZONED TIME`, `LOCAL TIME`, `ZONED DATETIME`, `LOCAL DATETIME` or `DURATION`) value to a `STRING`, or null if the value cannot be converted. 1.1+| xref::functions/string.adoc#functions-toupper[`toUpper()`] | `toUpper(input :: STRING?) :: (STRING?)` -| Returns the original string in uppercase. +| Returns the given `STRING` in uppercase. 1.1+| xref::functions/string.adoc#functions-trim[`trim()`] | `trim(input :: STRING?) :: (STRING?)` -| Returns the original string with leading and trailing whitespace removed. +| Returns the given `STRING` with leading and trailing whitespace removed. |=== @@ -535,7 +535,7 @@ These functions are used to manipulate strings or to create a string representat [[header-query-functions-temporal-instant-types]] **xref::functions/temporal/index.adoc[Temporal instant types functions]** -Values of the xref::values-and-types/temporal.adoc[temporal types] -- _Date_, _Time_, _LocalTime_, _DateTime_, and _LocalDateTime_ -- can be created manipulated using the following functions: +Values of the xref::values-and-types/temporal.adoc[temporal types] -- `DATE`, `ZONED TIME`, `LOCAL TIME`, `ZONED DATETIME`, and `LOCAL DATETIME` -- can be created manipulated using the following functions: [options="header"] |=== @@ -543,111 +543,111 @@ Values of the xref::values-and-types/temporal.adoc[temporal types] -- _Date_, _T 1.1+| xref::functions/temporal/index.adoc#functions-date[`date()`] | `date(input = DEFAULT_TEMPORAL_ARGUMENT :: ANY?) :: (DATE?)` -| Create a Date instant. +| Creates a `DATE` instant. 1.1+| xref::functions/temporal/index.adoc#functions-date-realtime[`date.realtime()`] | `date.realtime(timezone = DEFAULT_TEMPORAL_ARGUMENT :: ANY?) :: (DATE?)` -| Get the current Date instant using the realtime clock. +| Returns the current `DATE` instant using the realtime clock. 1.1+| xref::functions/temporal/index.adoc#functions-date-statement[`date.statement()`] | `date.statement(timezone = DEFAULT_TEMPORAL_ARGUMENT :: ANY?) :: (DATE?)` -| Get the current Date instant using the statement clock. +| Returns the current `DATE` instant using the statement clock. 1.1+| xref::functions/temporal/index.adoc#functions-date-transaction[`date.transaction()`] | `date.transaction(timezone = DEFAULT_TEMPORAL_ARGUMENT :: ANY?) :: (DATE?)` -| Get the current Date instant using the transaction clock. +| Returns the current `DATE` instant using the transaction clock. 1.1+| xref::functions/temporal/index.adoc#functions-date-truncate[`date.truncate()`] | `date.truncate(unit :: STRING?, input = DEFAULT_TEMPORAL_ARGUMENT :: ANY?, fields = null :: MAP?) :: (DATE?)` -| Truncate the input temporal value to a Date instant using the specified unit. +| Truncates the given temporal value to a `DATE` instant using the specified unit. 1.1+| xref::functions/temporal/index.adoc#functions-datetime[`datetime()`] | `datetime(input = DEFAULT_TEMPORAL_ARGUMENT :: ANY?) :: (DATETIME?)` -| Create a DateTime instant. +| Creates a `ZONED DATETIME` instant. 1.1+| xref::functions/temporal/index.adoc#functions-datetime-timestamp[`datetime.fromepoch()`] | `datetime.fromepoch(seconds :: NUMBER?, nanoseconds :: NUMBER?) :: (DATETIME?)` -| Create a DateTime given the seconds and nanoseconds since the start of the epoch. +| Creates a `ZONED DATETIME` given the seconds and nanoseconds since the start of the epoch. 1.1+| xref::functions/temporal/index.adoc#functions-datetime-timestamp[`datetime.fromepochmillis()`] | `datetime.fromepochmillis(milliseconds :: NUMBER?) :: (DATETIME?)` -| Create a DateTime given the milliseconds since the start of the epoch. +| Creates a `ZONED DATETIME` given the milliseconds since the start of the epoch. 1.1+| xref::functions/temporal/index.adoc#functions-datetime-realtime[`datetime.realtime()`] | `datetime.realtime(timezone = DEFAULT_TEMPORAL_ARGUMENT :: ANY?) :: (DATETIME?)` -| Get the current DateTime instant using the realtime clock. +| Returns the current `ZONED DATETIME` instant using the realtime clock. 1.1+| xref::functions/temporal/index.adoc#functions-datetime-statement[`datetime.statement()`] | `datetime.statement(timezone = DEFAULT_TEMPORAL_ARGUMENT :: ANY?) :: (DATETIME?)` -| Get the current DateTime instant using the statement clock. +| Returns the current `ZONED DATETIME` instant using the statement clock. 1.1+| xref::functions/temporal/index.adoc#functions-datetime-transaction[`datetime.transaction()`] | `datetime.transaction(timezone = DEFAULT_TEMPORAL_ARGUMENT :: ANY?) :: (DATETIME?)` -| Get the current DateTime instant using the transaction clock. +| Returns the current `ZONED DATETIME` instant using the transaction clock. 1.1+| xref::functions/temporal/index.adoc#functions-datetime-truncate[`datetime.truncate()`] | `datetime.truncate(unit :: STRING?, input = DEFAULT_TEMPORAL_ARGUMENT :: ANY?, fields = null :: MAP?) :: (DATETIME?)` -| Truncate the input temporal value to a DateTime instant using the specified unit. +| Truncates the given temporal value to a `ZONED DATETIME` instant using the specified unit. 1.1+| xref::functions/temporal/index.adoc#functions-localdatetime[`localdatetime()`] | `localdatetime(input = DEFAULT_TEMPORAL_ARGUMENT :: ANY?) :: (LOCALDATETIME?)` -| Create a LocalDateTime instant. +| Creates a `LOCAL DATETIME` instant. 1.1+| xref::functions/temporal/index.adoc#functions-localdatetime-realtime[`localdatetime.realtime()`] | `localdatetime.realtime(timezone = DEFAULT_TEMPORAL_ARGUMENT :: ANY?) :: (LOCALDATETIME?)` -| Get the current LocalDateTime instant using the realtime clock. +| Returns the current `LOCAL DATETIME` instant using the realtime clock. 1.1+| xref::functions/temporal/index.adoc#functions-localdatetime-statement[`localdatetime.statement()`] | `localdatetime.statement(timezone = DEFAULT_TEMPORAL_ARGUMENT :: ANY?) :: (LOCALDATETIME?)` -| Get the current LocalDateTime instant using the statement clock. +| Returns the current `LOCAL DATETIME` instant using the statement clock. 1.1+| xref::functions/temporal/index.adoc#functions-localdatetime-transaction[`localdatetime.transaction()`] | `localdatetime.transaction(timezone = DEFAULT_TEMPORAL_ARGUMENT :: ANY?) :: (LOCALDATETIME?)` -| Get the current LocalDateTime instant using the transaction clock. +| Returns the current `LOCAL DATETIME` instant using the transaction clock. 1.1+| xref::functions/temporal/index.adoc#functions-localdatetime-truncate[`localdatetime.truncate()`] | `localdatetime.truncate(unit :: STRING?, input = DEFAULT_TEMPORAL_ARGUMENT :: ANY?, fields = null :: MAP?) :: (LOCALDATETIME?)` -| Truncate the input temporal value to a LocalDateTime instant using the specified unit. +| Truncates the given temporal value to a `LOCAL DATETIME` instant using the specified unit. 1.1+| xref::functions/temporal/index.adoc#functions-localtime[`localtime()`] | `localtime(input = DEFAULT_TEMPORAL_ARGUMENT :: ANY?) :: (LOCALTIME?)` -| Create a LocalTime instant. +| Creates a `LOCAL TIME` instant. 1.1+| xref::functions/temporal/index.adoc#functions-localtime-realtime[`localtime.realtime()`] | `localtime.realtime(timezone = DEFAULT_TEMPORAL_ARGUMENT :: ANY?) :: (LOCALTIME?)` -| Get the current LocalTime instant using the realtime clock. +| Returns the current `LOCAL TIME` instant using the realtime clock. 1.1+| xref::functions/temporal/index.adoc#functions-localtime-statement[`localtime.statement()`] | `localtime.statement(timezone = DEFAULT_TEMPORAL_ARGUMENT :: ANY?) :: (LOCALTIME?)` -| Get the current LocalTime instant using the statement clock. +| Returns the current `LOCAL TIME` instant using the statement clock. 1.1+| xref::functions/temporal/index.adoc#functions-localtime-transaction[`localtime.transaction()`] | `localtime.transaction(timezone = DEFAULT_TEMPORAL_ARGUMENT :: ANY?) :: (LOCALTIME?)` -| Get the current LocalTime instant using the transaction clock. +| Returns the current `LOCAL TIME` instant using the transaction clock. 1.1+| xref::functions/temporal/index.adoc#functions-localtime-truncate[`localtime.truncate()`] | `localtime.truncate(unit :: STRING?, input = DEFAULT_TEMPORAL_ARGUMENT :: ANY?, fields = null :: MAP?) :: (LOCALTIME?)` -| Truncate the input temporal value to a LocalTime instant using the specified unit. +| Truncates the given temporal value to a `LOCAL TIME` instant using the specified unit. 1.1+| xref::functions/temporal/index.adoc#functions-time[`time()`] | `time(input = DEFAULT_TEMPORAL_ARGUMENT :: ANY?) :: (TIME?)` -| Create a Time instant. +| Creates a `ZONED TIME` instant. 1.1+| xref::functions/temporal/index.adoc#functions-time-realtime[`time.realtime()`] | `time.realtime(timezone = DEFAULT_TEMPORAL_ARGUMENT :: ANY?) :: (TIME?)` -| Get the current Time instant using the realtime clock. +| Returns the current `ZONED TIME` instant using the realtime clock. 1.1+| xref::functions/temporal/index.adoc#functions-time-statement[`time.statement()`] | `time.statement(timezone = DEFAULT_TEMPORAL_ARGUMENT :: ANY?) :: (TIME?)` -| Get the current Time instant using the statement clock. +| Returns the current `ZONED TIME` instant using the statement clock. 1.1+| xref::functions/temporal/index.adoc#functions-time-transaction[`time.transaction()`] | `time.transaction(timezone = DEFAULT_TEMPORAL_ARGUMENT :: ANY?) :: (TIME?)` -| Get the current Time instant using the transaction clock. +| Returns the current `ZONED TIME` instant using the transaction clock. 1.1+| xref::functions/temporal/index.adoc#functions-time-truncate[`time.truncate()`] | `time.truncate(unit :: STRING?, input = DEFAULT_TEMPORAL_ARGUMENT :: ANY?, fields = null :: MAP?) :: (TIME?)` -| Truncate the input temporal value to a Time instant using the specified unit. +| Truncates the given temporal value to a `ZONED TIME` instant using the specified unit. |=== @@ -655,7 +655,7 @@ Values of the xref::values-and-types/temporal.adoc[temporal types] -- _Date_, _T [[header-query-functions-temporal-duration]] **xref::functions/temporal/duration.adoc[Temporal duration functions]** -Duration values of the xref::values-and-types/temporal.adoc[temporal types] can be created manipulated using the following functions: +`DURATION` values of the xref::values-and-types/temporal.adoc[temporal types] can be created manipulated using the following functions: [options="header"] |=== @@ -663,23 +663,23 @@ Duration values of the xref::values-and-types/temporal.adoc[temporal types] can 1.1+| xref::functions/temporal/duration.adoc#functions-duration[`duration()`] | `duration(input :: ANY?) :: (DURATION?)` -| Construct a Duration value. +| Constructs a `DURATION` value. 1.1+| xref::functions/temporal/duration.adoc#functions-duration-between[`duration.between()`] | `duration.between(from :: ANY?, to :: ANY?) :: (DURATION?)` -| Compute the duration between the 'from' instant (inclusive) and the 'to' instant (exclusive) in logical units. +| Computes the `DURATION` between the `from` instant (inclusive) and the `to` instant (exclusive) in logical units. 1.1+| xref::functions/temporal/duration.adoc#functions-duration-indays[`duration.inDays()`] | `duration.inDays(from :: ANY?, to :: ANY?) :: (DURATION?)` -| Compute the duration between the 'from' instant (inclusive) and the 'to' instant (exclusive) in days. +| Computes the `DURATION` between the `from` instant (inclusive) and the `to` instant (exclusive) in days. 1.1+| xref::functions/temporal/duration.adoc#functions-duration-inmonths[`duration.inMonths()`] | `duration.inMonths(from :: ANY?, to :: ANY?) :: (DURATION?)` -| Compute the duration between the 'from' instant (inclusive) and the 'to' instant (exclusive) in months. +| Computes the `DURATION` between the `from` instant (inclusive) and the `to` instant (exclusive) in months. 1.1+| xref::functions/temporal/duration.adoc#functions-duration-inseconds[`duration.inSeconds()`] | `duration.inSeconds(from :: ANY?, to :: ANY?) :: (DURATION?)` -| Compute the duration between the 'from' instant (inclusive) and the 'to' instant (exclusive) in seconds. +| Computes the `DURATION` between the `from` instant (inclusive) and the `to` instant (exclusive) in seconds. |=== @@ -695,7 +695,7 @@ These functions are used to specify 2D or 3D points in a geographic or cartesian 1.1+| xref::functions/spatial.adoc#functions-distance[`point.distance()`] | `point.distance(from :: POINT?, to :: POINT?) :: (FLOAT?)` -| Returns a floating point number representing the geodesic distance between any two points in the same CRS. +| Returns a `FLOAT` representing the geodesic distance between any two points in the same CRS. 1.1+| xref::functions/spatial.adoc#functions-point-cartesian-2d[`point()` - Cartesian 2D] | `point(input :: MAP?) :: (POINT?)` diff --git a/modules/ROOT/pages/functions/list.adoc b/modules/ROOT/pages/functions/list.adoc index e1659fe5e..52e52ffca 100644 --- a/modules/ROOT/pages/functions/list.adoc +++ b/modules/ROOT/pages/functions/list.adoc @@ -36,7 +36,7 @@ CREATE [[functions-keys]] == keys() -`keys` returns a list containing the string representations for all the property names of a node, relationship, or map. +`keys` returns a `LIST` containing the string representations for all the property names of a `NODE`, `RELATIONSHIP`, or `MAP`. *Syntax:* @@ -49,7 +49,7 @@ keys(expression) |=== -| A list containing String elements. +| `LIST` |=== @@ -60,7 +60,7 @@ keys(expression) | Name | Description | `expression` -| An expression that returns a node, a relationship, or a map. +| An expression that returns a `NODE`, `RELATIONSHIP`, or `MAP`. |=== @@ -83,7 +83,7 @@ MATCH (a) WHERE a.name = 'Alice' RETURN keys(a) ---- -A list containing the names of all the properties on the node bound to `a` is returned. +A `LIST` containing the names of all the properties on the node bound to `a` is returned. .Result [role="queryresult",options="header,footer",cols="1*` containing the string representations for all the labels of a `NODE`. *Syntax:* @@ -114,7 +114,7 @@ labels(node) |=== -| A list containing String elements. +| `LIST` |=== @@ -125,7 +125,7 @@ labels(node) | Name | Description | `node` -| An expression that returns a single node. +| An expression that returns a single `NODE`. |=== @@ -148,7 +148,7 @@ MATCH (a) WHERE a.name = 'Alice' RETURN labels(a) ---- -A list containing all the labels of the node bound to `a` is returned. +A `LIST` containing all the labels of the node bound to `a` is returned. .Result [role="queryresult",options="header,footer",cols="1*` containing all the `NODE` values in a `PATH`. *Syntax:* @@ -179,7 +179,7 @@ nodes(path) |=== -| A list containing Node elements. +| `LIST` |=== @@ -190,7 +190,7 @@ nodes(path) | Name | Description | `path` -| An expression that returns a path. +| An expression that returns a `PATH`. |=== @@ -214,7 +214,7 @@ WHERE a.name = 'Alice' AND c.name = 'Eskil' RETURN nodes(p) ---- -A list containing all the nodes in the path `p` is returned. +A `LIST` containing all the nodes in the path `p` is returned. .Result [role="queryresult",options="header,footer",cols="1*` comprising all `INTEGER` values within a range bounded by a `start` value and an `end` value, where the difference `step` between any two consecutive values is constant; i.e. an arithmetic progression. +To create ranges with decreasing `INTEGER` values, use a negative value `step`. The range is inclusive for non-empty ranges, and the arithmetic progression will therefore always contain `start` and -- depending on the values of `start`, `step` and `end` -- `end`. The only exception where the range does not contain `start` are empty ranges. An empty range will be returned if the value `step` is negative and `start - end` is positive, or vice versa, e.g. `range(0, 5, -1)`. @@ -249,7 +249,7 @@ range(start, end [, step]) |=== -| A list of Integer elements. +| `LIST` |=== @@ -260,10 +260,10 @@ range(start, end [, step]) | Name | Description | `start` -| An expression that returns an integer value. +| An expression that returns an `INTEGER` value. | `end` -| An expression that returns an integer value. +| An expression that returns an `INTEGER` value. | `step` | A numeric expression defining the difference between any two consecutive values, with a default of `1`. @@ -330,7 +330,7 @@ reduce(accumulator = initial, variable IN list | expression) | An expression that runs once to give a starting value to the accumulator. | `list` -| An expression that returns a list. +| An expression that returns a `LIST`. | `variable` | The closure will have a variable introduced in its context. We decide here which variable to use. @@ -352,7 +352,7 @@ WHERE a.name = 'Alice' AND b.name = 'Bob' AND c.name = 'Daniel' RETURN reduce(totalAge = 0, n IN nodes(p) | totalAge + n.age) AS reduction ---- -The `age` property of all nodes in the path are summed and returned as a single value. +The `age` property of all `NODE` values in the `PATH` are summed and returned as a single value. .Result [role="queryresult",options="header,footer",cols="1*` containing all the `RELATIONSHIP` values in a `PATH`.. *Syntax:* @@ -383,7 +383,7 @@ relationships(path) |=== -| A list containing Relationship elements. +| `LIST` |=== @@ -394,7 +394,7 @@ relationships(path) | Name | Description | `path` -| An expression that returns a path. +| An expression that returns a `PATH`. |=== @@ -418,7 +418,7 @@ WHERE a.name = 'Alice' AND c.name = 'Eskil' RETURN relationships(p) ---- -A list containing all the relationships in the path `p` is returned. +A `LIST` containing all the `RELATIONSHIP` values in the `PATH` `p` is returned. .Result [role="queryresult",options="header,footer",cols="1*` in which the order of all elements in the given `LIST` have been reversed. *Syntax:* @@ -449,7 +449,7 @@ reverse(original) |=== -| A list containing homogeneous or heterogeneous elements; the types of the elements are determined by the elements within `original`. +| A `LIST` containing homogeneous or heterogeneous elements; the types of the elements are determined by the elements within `original`. |=== @@ -459,7 +459,7 @@ reverse(original) | Name | Description | `original` -| An expression that returns a list. +| An expression that returns a `LIST`. |=== @@ -498,7 +498,7 @@ RETURN reverse(ids) [[functions-tail]] == tail() -`tail()` returns a list `l~result~` containing all the elements, excluding the first one, from a list `list`. +`tail()` returns a `LIST` `l~result~` containing all the elements, excluding the first one, from a list `list`. *Syntax:* @@ -511,7 +511,7 @@ tail(list) |=== -| A list containing heterogeneous elements; the types of the elements are determined by the elements in `list`. +| A `LIST` containing heterogeneous elements; the types of the elements are determined by the elements in `list`. |=== @@ -521,7 +521,7 @@ tail(list) | Name | Description | `list` -| An expression that returns a list. +| An expression that returns a `LIST`. |=== @@ -536,7 +536,7 @@ MATCH (a) WHERE a.name = 'Eskil' RETURN a.array, tail(a.array) ---- -The property named `array` and a list comprising all but the first element of the `array` property are returned. +The property named `array` and a `LIST` comprising all but the first element of the `array` property are returned. .Result [role="queryresult",options="header,footer",cols="2*` and returns a `LIST`. +If any values are not convertible to `BOOLEAN` they will be `null` in the `LIST` returned. *Syntax:* @@ -568,7 +568,7 @@ toBooleanList(list) |=== -| A list containing the converted elements; depending on the input value a converted value is either a boolean value or `null`. +| A `LIST` containing the converted elements; depending on the input value a converted value is either a `BOOLEAN` value or `null`. |=== @@ -578,7 +578,7 @@ toBooleanList(list) | Name | Description | `list` -| An expression that returns a list. +| An expression that returns a `LIST`. |=== @@ -587,9 +587,9 @@ toBooleanList(list) |=== | Any `null` element in `list` is preserved. -| Any boolean value in `list` is preserved. +| Any `BOOLEAN` value in `list` is preserved. | If the `list` is `null`, `null` will be returned. -| If the `list` is not a list, an error will be returned. +| If the `list` is not a `LIST`, an error will be returned. | The conversion for each value in `list` is done according to the xref::functions/scalar.adoc#functions-tobooleanornull[`toBooleanOrNull()` function]. |=== @@ -622,8 +622,8 @@ toBooleanList(['a string', true, 'false', null, ['A','B']]) as mixedList [[functions-tofloatlist]] == toFloatList() -`toFloatList()` converts a list of values and returns a list of floating point values. -If any values are not convertible to floating point they will be `null` in the list returned. +`toFloatList()` converts a `LIST` of values and returns a `LIST`. +If any values are not convertible to `FLOAT` they will be `null` in the `LIST` returned. *Syntax:* @@ -636,7 +636,7 @@ toFloatList(list) |=== -| A list containing the converted elements; depending on the input value a converted value is either a floating point value or `null`. +| A `LIST` containing the converted elements; depending on the input value a converted value is either a `FLOAT` value or `null`. |=== @@ -646,7 +646,7 @@ toFloatList(list) | Name | Description | `list` -| An expression that returns a list. +| An expression that returns a `LIST`. |=== @@ -655,9 +655,9 @@ toFloatList(list) |=== | Any `null` element in `list` is preserved. -| Any floating point value in `list` is preserved. +| Any `FLOAT` value in `list` is preserved. | If the `list` is `null`, `null` will be returned. -| If the `list` is not a list, an error will be returned. +| If the `list` is not a `LIST`, an error will be returned. | The conversion for each value in `list` is done according to the xref::functions/scalar.adoc#functions-tofloatornull[`toFloatOrNull()` function]. |=== @@ -690,8 +690,8 @@ toFloatList(['a string', 2.5, '3.14159', null, ['A','B']]) as mixedList [[functions-tointegerlist]] == toIntegerList() -`toIntegerList()` converts a list of values and returns a list of integer values. -If any values are not convertible to integer they will be `null` in the list returned. +`toIntegerList()` converts a `LIST` of values and returns a `LIST`. +If any values are not convertible to `INTEGER` they will be `null` in the `LIST` returned. *Syntax:* @@ -704,7 +704,7 @@ toIntegerList(list) |=== -| A list containing the converted elements; depending on the input value a converted value is either a integer value or `null`. +| A `LIST` containing the converted elements; depending on the input value a converted value is either an `INTEGER` value or `null`. |=== @@ -715,7 +715,7 @@ toIntegerList(list) | Name | Description | `list` -| An expression that returns a list. +| An expression that returns a `LIST`. |=== @@ -723,9 +723,9 @@ toIntegerList(list) |=== | Any `null` element in `list` is preserved. -| Any integer value in `list` is preserved. +| Any `INTEGER` value in `list` is preserved. | If the `list` is `null`, `null` will be returned. -| If the `list` is not a list, an error will be returned. +| If the `list` is not a `LIST`, an error will be returned. | The conversion for each value in `list` is done according to the xref::functions/scalar.adoc#functions-tointegerornull[`toIntegerOrNull()` function]. |=== @@ -758,8 +758,8 @@ toIntegerList(['a string', 2, '5', null, ['A','B']]) as mixedList [[functions-tostringlist]] == toStringList() -`toStringList()` converts a list of values and returns a list of string values. -If any values are not convertible to string they will be `null` in the list returned. +`toStringList()` converts a `LIST` of values and returns a `LIST`. +If any values are not convertible to `STRING` they will be `null` in the `LIST` returned. *Syntax:* @@ -772,7 +772,7 @@ toStringList(list) |=== -| A list containing the converted elements; depending on the input value a converted value is either a string value or `null`. +| A `LIST` containing the converted elements; depending on the input value a converted value is either a `STRING` value or `null`. |=== @@ -783,7 +783,7 @@ toStringList(list) | Name | Description | `list` -| An expression that returns a list. +| An expression that returns a `LIST`. |=== @@ -792,9 +792,9 @@ toStringList(list) |=== | Any `null` element in `list` is preserved. -| Any string value in `list` is preserved. +| Any `STRING` value in `list` is preserved. | If the `list` is `null`, `null` will be returned. -| If the `list` is not a list, an error will be returned. +| If the `list` is not a `LIST`, an error will be returned. | The conversion for each value in `list` is done according to the xref::functions/string.adoc#functions-tostringornull[`toStringOrNull()` function]. |=== diff --git a/modules/ROOT/pages/functions/load-csv.adoc b/modules/ROOT/pages/functions/load-csv.adoc index 7626d5690..54e8af4f6 100644 --- a/modules/ROOT/pages/functions/load-csv.adoc +++ b/modules/ROOT/pages/functions/load-csv.adoc @@ -31,7 +31,7 @@ linenumber() |=== -| An Integer. +| `INTEGER` |=== @@ -60,7 +60,7 @@ file() |=== -| A String. +| `STRING` |=== diff --git a/modules/ROOT/pages/functions/mathematical-logarithmic.adoc b/modules/ROOT/pages/functions/mathematical-logarithmic.adoc index 5bf428593..6b98ea3d0 100644 --- a/modules/ROOT/pages/functions/mathematical-logarithmic.adoc +++ b/modules/ROOT/pages/functions/mathematical-logarithmic.adoc @@ -24,7 +24,7 @@ e() |=== -| A Float. +| `FLOAT` |=== @@ -69,7 +69,7 @@ e(expression) |=== -| A Float. +| `FLOAT` |=== @@ -133,7 +133,7 @@ log(expression) |=== -| A Float. +| `FLOAT` |=== @@ -197,7 +197,7 @@ log10(expression) |=== -|A Float. +| `FLOAT` |=== @@ -262,7 +262,7 @@ sqrt(expression) |=== -| A Float. +| `FLOAT` |=== diff --git a/modules/ROOT/pages/functions/mathematical-numeric.adoc b/modules/ROOT/pages/functions/mathematical-numeric.adoc index cd4196fa4..898445851 100644 --- a/modules/ROOT/pages/functions/mathematical-numeric.adoc +++ b/modules/ROOT/pages/functions/mathematical-numeric.adoc @@ -98,7 +98,7 @@ The absolute value of the age difference is returned. [[functions-ceil]] == ceil() -`ceil()` returns the smallest floating point number that is greater than or equal to the given number and equal to a mathematical integer. +`ceil()` returns the smallest `FLOAT` that is greater than or equal to the given number and equal to an `INTEGER`. *Syntax:* @@ -111,7 +111,7 @@ ceil(expression) |=== -| A Float. +| `FLOAT` |=== @@ -162,7 +162,7 @@ The ceil of `0.1` is returned. [[functions-floor]] == floor() -`floor()` returns the largest floating point number that is less than or equal to the given number and equal to a mathematical integer. +`floor()` returns the largest `FLOAT` that is less than or equal to the given number and equal to an `INTEGER`. *Syntax:* @@ -175,7 +175,7 @@ floor(expression) |=== -| A Float. +| `FLOAT` |=== @@ -237,7 +237,7 @@ isNaN(expression) |=== -| A Boolean. +| `BOOLEAN` |=== @@ -288,7 +288,7 @@ RETURN isNaN(0/0.0) [[functions-rand]] == rand() -`rand()` returns a random floating point number in the range from 0 (inclusive) to 1 (exclusive); i.e. `[0,1)`. The numbers returned follow an approximate uniform distribution. +`rand()` returns a random `FLOAT` in the range from 0 (inclusive) to 1 (exclusive); i.e. `[0,1)`. The numbers returned follow an approximate uniform distribution. *Syntax:* @@ -301,7 +301,7 @@ rand() |=== -| A Float. +| `FLOAT` |=== @@ -333,7 +333,7 @@ A random number is returned. [[functions-round]] == round() -`round()` returns the value of the given number rounded to the nearest integer, with ties always rounded towards positive infinity. +`round()` returns the value of the given number rounded to the nearest `INTEGER`, with ties always rounded towards positive infinity. *Syntax:* @@ -346,7 +346,7 @@ round(expression) |=== -| A Float. +| `FLOAT` |=== @@ -427,7 +427,7 @@ round(expression, precision) *Returns:* |=== -| A Float. +| `FLOAT` |=== @@ -540,7 +540,7 @@ round(expression, precision, mode) |=== -| A Float. +| `FLOAT` |=== @@ -800,7 +800,7 @@ sign(expression) |=== -| An Integer. +| `INTEGER` |=== diff --git a/modules/ROOT/pages/functions/mathematical-trigonometric.adoc b/modules/ROOT/pages/functions/mathematical-trigonometric.adoc index 75c2c0800..52bec4815 100644 --- a/modules/ROOT/pages/functions/mathematical-trigonometric.adoc +++ b/modules/ROOT/pages/functions/mathematical-trigonometric.adoc @@ -11,7 +11,7 @@ These functions all operate on numeric expressions only, and will return an erro [[functions-acos]] == acos() -`acos()` returns the arccosine of a number in radians. +`acos()` returns the arccosine of a `FLOAT` in radians. *Syntax:* @@ -23,7 +23,7 @@ acos(expression) *Returns:* |=== -|A Float. +| `FLOAT` |=== @@ -72,7 +72,7 @@ The arccosine of `0.5` is returned. [[functions-asin]] == asin() -`asin()` returns the arcsine of a number in radians. +`asin()` returns the arcsine of a `FLOAT` in radians. *Syntax:* @@ -85,7 +85,7 @@ asin(expression) |=== -| A Float. +| `FLOAT` |=== @@ -134,7 +134,7 @@ The arcsine of `0.5` is returned. [[functions-atan]] == atan() -`atan()` returns the arctangent of a number in radians. +`atan()` returns the arctangent of a `FLOAT` in radians. *Syntax:* @@ -147,7 +147,7 @@ atan(expression) |=== -| A Float. +| `FLOAT` |=== @@ -211,7 +211,7 @@ atan2(expression1, expression2) |=== -| A Float. +| `FLOAT` |=== @@ -264,7 +264,7 @@ The arctangent2 of `0.5` and `0.6` is returned. [[functions-cos]] == cos() -`cos()` returns the cosine of a number. +`cos()` returns the cosine of a `FLOAT`. *Syntax:* @@ -277,7 +277,7 @@ cos(expression) |=== -| A Float. +| `FLOAT` |=== @@ -328,7 +328,7 @@ The cosine of `0.5` is returned. [[functions-cot]] == cot() -`cot()` returns the cotangent of a number. +`cot()` returns the cotangent of a `FLOAT`. *Syntax:* @@ -341,7 +341,7 @@ cot(expression) |=== -|A Float. +| `FLOAT` |=== @@ -405,7 +405,7 @@ degrees(expression) |=== -| A Float. +| `FLOAT` |=== @@ -468,7 +468,7 @@ haversin(expression) |=== -| A Float. +| `FLOAT` |=== @@ -569,7 +569,7 @@ pi() |=== -| A Float. +| `FLOAT` |=== @@ -614,7 +614,7 @@ radians(expression) |=== -| A Float. +| `FLOAT` |=== @@ -678,7 +678,7 @@ sin(expression) |=== -| A Float. +| `FLOAT` |=== @@ -741,7 +741,7 @@ tan(expression) |=== -| A Float. +| `FLOAT` |=== diff --git a/modules/ROOT/pages/functions/predicate.adoc b/modules/ROOT/pages/functions/predicate.adoc index 156f66ffd..9c08fef4d 100644 --- a/modules/ROOT/pages/functions/predicate.adoc +++ b/modules/ROOT/pages/functions/predicate.adoc @@ -54,7 +54,7 @@ all(variable IN list WHERE predicate) |=== -| A Boolean. +| `BOOLEAN` |=== @@ -129,7 +129,7 @@ any(variable IN list WHERE predicate) |=== -| A Boolean. +| `BOOLEAN` |=== @@ -205,7 +205,7 @@ exists(pattern) |=== -| A Boolean. +| `BOOLEAN` |=== @@ -276,7 +276,7 @@ isEmpty(list) |=== -| A Boolean. +| `BOOLEAN` |=== @@ -331,7 +331,7 @@ isEmpty(map) |=== -| A Boolean. +| `BOOLEAN` |=== @@ -378,7 +378,7 @@ isEmpty(string) *Returns:* |=== -| A Boolean. +| `BOOLEAN` |=== @@ -445,7 +445,7 @@ none(variable IN list WHERE predicate) *Returns:* |=== -|A Boolean. +| `BOOLEAN` |=== @@ -519,7 +519,7 @@ single(variable IN list WHERE predicate) *Returns:* |=== -| A Boolean. +| `BOOLEAN` |=== diff --git a/modules/ROOT/pages/functions/scalar.adoc b/modules/ROOT/pages/functions/scalar.adoc index 0d611a66e..752ea8d64 100644 --- a/modules/ROOT/pages/functions/scalar.adoc +++ b/modules/ROOT/pages/functions/scalar.adoc @@ -127,7 +127,7 @@ elementId(expression) |=== -| A String. +| `STRING` |=== @@ -139,7 +139,7 @@ elementId(expression) | Name | Description | `expression` -| An expression that returns a node or a relationship. +| An expression that returns a `NODE` or a `RELATIONSHIP`. |=== @@ -149,7 +149,7 @@ elementId(expression) |=== | `elementId(null)` returns `null`. -| `elementId` on values other than a node, relationship, or null will fail the query. +| `elementId` on values other than a `NODE`, `RELATIONSHIP`, or null will fail the query. |=== @@ -198,7 +198,7 @@ The node identifier for each of the nodes is returned. [[functions-endnode]] == endNode() -The function `endNode()` returns the end node of a relationship. +The function `endNode()` returns the end `NODE` of a `RELATIONSHIP`. *Syntax:* @@ -211,7 +211,7 @@ endNode(relationship) |=== -| A Node. +| `NODE` |=== @@ -222,7 +222,7 @@ endNode(relationship) | Name | Description | `relationship` -| An expression that returns a relationship. +| An expression that returns a `RELATIONSHIP`. |=== @@ -373,7 +373,7 @@ id(expression) |=== -| An Integer. +| `INTEGER` |=== @@ -383,7 +383,7 @@ id(expression) | Name | Description | `expression` -| An expression that returns a node or a relationship. +| An expression that returns a `NODE` or a `RELATIONSHIP`. |=== @@ -495,7 +495,7 @@ The last element in the list is returned. [[functions-length]] == length() -The function `length()` returns the length of a path. +The function `length()` returns the length of a `PATH`. *Syntax:* @@ -508,7 +508,7 @@ length(path) |=== -| An Integer. +| `INTEGER` |=== @@ -519,7 +519,7 @@ length(path) | Name | Description | `path` -| An expression that returns a path. +| An expression that returns a `PATH`. |=== @@ -563,8 +563,8 @@ The length of the path `p` is returned. [[functions-properties]] == properties() -The function `properties()` returns a map containing all the properties; the function can be utilized for a relationship or a node. -If the argument is already a map, it is returned unchanged. +The function `properties()` returns a `MAP` containing all the properties; the function can be utilized for a relationship or a node. +If the argument is already a `MAP`, it is returned unchanged. *Syntax:* @@ -577,7 +577,7 @@ properties(expression) |=== -| A Map. +| `MAP` |=== @@ -588,7 +588,7 @@ properties(expression) | Name | Description | `expression` -| An expression that returns a relationship, a node, or a map. +| An expression that returns a `RELATIONSHIP`, a `NODE`, or a `MAP`. |=== @@ -644,7 +644,7 @@ randomUUID() |=== -| A String. +| `STRING` |=== @@ -687,7 +687,7 @@ size(list) |=== -| An Integer. +| `INTEGER` |=== @@ -738,7 +738,7 @@ The number of elements in the list is returned. == size() applied to pattern comprehension This is the same function `size()` as described above, but you pass in a pattern comprehension. -The function size will then calculate on a _list_ of paths. +The function size will then calculate on a `LIST`. *Syntax:* @@ -788,7 +788,7 @@ The number of paths matching the pattern expression is returned. (The size of th [[functions-size-of-string]] == size() applied to string -The function `size()` returns the number of Unicode characters in a string. +The function `size()` returns the number of Unicode characters in a `STRING`. *Syntax:* @@ -801,7 +801,7 @@ size(string) |=== -| An Integer. +| `INTEGER` |=== @@ -812,7 +812,7 @@ size(string) | Name | Description | `string` -| An expression that returns a string value. +| An expression that returns a `STRING` value. |=== @@ -854,7 +854,7 @@ The number of characters in the string `'Charlie'` is returned. [[functions-startnode]] == startNode() -The function `startNode()` returns the start node of a relationship. +The function `startNode()` returns the start `NODE` of a `RELATIONSHIP`. *Syntax:* @@ -867,7 +867,7 @@ startNode(relationship) |=== -| A Node. +| `NODE` |=== @@ -878,7 +878,7 @@ startNode(relationship) | Name | Description | `relationship` -| An expression that returns a relationship. +| An expression that returns a `RELATIONSHIP`. |=== @@ -936,7 +936,7 @@ timestamp() |=== -| An Integer. +| `INTEGER` |=== @@ -976,7 +976,7 @@ The time in milliseconds is returned. [[functions-toboolean]] == toBoolean() -The function `toBoolean()` converts a string, integer or boolean value to a boolean value. +The function `toBoolean()` converts a `STRING`, `INTEGER` or `BOOLEAN` value to a `BOOLEAN` value. *Syntax:* @@ -989,7 +989,7 @@ toBoolean(expression) |=== -| A Boolean. +| `BOOLEAN` |=== @@ -1000,7 +1000,7 @@ toBoolean(expression) | Name | Description | `expression` -| An expression that returns a boolean, string or integer value. +| An expression that returns a `BOOLEAN`, `STRING` or `INTEGER` value. |=== @@ -1009,10 +1009,10 @@ toBoolean(expression) |=== | `toBoolean(null)` returns `null`. -| If `expression` is a boolean value, it will be returned unchanged. +| If `expression` is a `BOOLEAN` value, it will be returned unchanged. | If the parsing fails, `null` will be returned. -| If `expression` is the integer value `0`, `false` will be returned. For any other integer value `true` will be returned. -| This function will return an error if provided with an expression that is not a string, integer or boolean value. +| If `expression` is the `INTEGER` value `0`, `false` will be returned. For any other `INTEGER` value `true` will be returned. +| This function will return an error if provided with an expression that is not a `STRING`, `INTEGER` or `BOOLEAN` value. |=== @@ -1041,7 +1041,7 @@ RETURN toBoolean('true'), toBoolean('not a boolean'), toBoolean(0) [[functions-tobooleanornull]] == toBooleanOrNull() -The function `toBooleanOrNull()` converts a string, integer or boolean value to a boolean value. For any other input value, `null` will be returned. +The function `toBooleanOrNull()` converts a `STRING`, `INTEGER` or `BOOLEAN` value to a `BOOLEAN` value. For any other input value, `null` will be returned. *Syntax:* @@ -1054,7 +1054,7 @@ toBooleanOrNull(expression) |=== -| A Boolean or `null`. +| `BOOLEAN` or `null`. |=== @@ -1074,10 +1074,10 @@ toBooleanOrNull(expression) |=== | `toBooleanOrNull(null)` returns `null`. -| If `expression` is a boolean value, it will be returned unchanged. +| If `expression` is a `BOOLEAN` value, it will be returned unchanged. | If the parsing fails, `null` will be returned. -| If `expression` is the integer value `0`, `false` will be returned. For any other integer value `true` will be returned. -| If the `expression` is not a string, integer or boolean value, `null` will be returned. +| If `expression` is the `INTEGER` value `0`, `false` will be returned. For any other `INTEGER` value `true` will be returned. +| If the `expression` is not a `STRING`, `INTEGER` or `BOOLEAN` value, `null` will be returned. |=== @@ -1104,7 +1104,7 @@ RETURN toBooleanOrNull('true'), toBooleanOrNull('not a boolean'), toBooleanOrNul [[functions-tofloat]] == toFloat() -The function `toFloat()` converts an integer, floating point or a string value to a floating point number. +The function `toFloat()` converts an `INTEGER`, `FLOAT` or a `STRING` value to a `FLOAT`. *Syntax:* @@ -1116,7 +1116,7 @@ toFloat(expression) *Returns:* |=== -| A Float. +| `FLOAT` |=== @@ -1127,7 +1127,7 @@ toFloat(expression) | Name | Description | `expression` -| An expression that returns a numeric or a string value. +| An expression that returns an `INTEGER`, `FLOAT` or a `STRING` value. |=== @@ -1136,9 +1136,9 @@ toFloat(expression) |=== | `toFloat(null)` returns `null`. -| If `expression` is a floating point number, it will be returned unchanged. +| If `expression` is a `FLOAT`, it will be returned unchanged. | If the parsing fails, `null` will be returned. -| This function will return an error if provided with an expression that is not an integer, floating point or a string value. +| This function will return an error if provided with an expression that is not an `INTEGER`, `FLOAT` or a `STRING` value. |=== @@ -1167,7 +1167,7 @@ RETURN toFloat('11.5'), toFloat('not a number') [[functions-tofloatornull]] == toFloatOrNull() -The function `toFloatOrNull()` converts an integer, floating point or a string value to a floating point number. +The function `toFloatOrNull()` converts an `INTEGER`, `FLOAT` or a `STRING` value to a `FLOAT`. For any other input value, `null` will be returned. *Syntax:* @@ -1180,7 +1180,7 @@ toFloatOrNull(expression) *Returns:* |=== -| A Float or `null`. +| `FLOAT` or `null`. |=== @@ -1200,9 +1200,9 @@ toFloatOrNull(expression) |=== |`toFloatOrNull(null)` returns `null`. -|If `expression` is a floating point number, it will be returned unchanged. +|If `expression` is a `FLOAT`, it will be returned unchanged. |If the parsing fails, `null` will be returned. -|If the `expression` is not an integer, floating point or a string value, `null` will be returned. +|If the `expression` is not an `INTEGER`, `FLOAT` or a `STRING` value, `null` will be returned. |=== @@ -1232,7 +1232,7 @@ RETURN toFloatOrNull('11.5'), toFloatOrNull('not a number'), toFloatOrNull(true) [[functions-tointeger]] == toInteger() -The function `toInteger()` converts a boolean, integer, floating point or a string value to an integer value. +The function `toInteger()` converts a `BOOLEAN`, `INTEGER`, `FLOAT` or a `STRING` value to an `INTEGER` value. *Syntax:* @@ -1245,7 +1245,7 @@ toInteger(expression) |=== -| An Integer. +| `INTEGER` |=== @@ -1256,7 +1256,7 @@ toInteger(expression) | Name | Description | `expression` -| An expression that returns a boolean, numeric or a string value. +| An expression that returns a `BOOLEAN`, `FLOAT`, `INTEGER` or a `STRING` value. |=== @@ -1299,7 +1299,7 @@ RETURN toInteger('42'), toInteger('not a number'), toInteger(true) [[functions-tointegerornull]] == toIntegerOrNull() -The function `toIntegerOrNull()` converts a boolean, integer, floating point or a string value to an integer value. For any other input value, `null` will be returned. +The function `toIntegerOrNull()` converts a `BOOLEAN`, `INTEGER`, `FLOAT` or a `STRING` value to an `INTEGER` value. For any other input value, `null` will be returned. *Syntax:* @@ -1311,7 +1311,7 @@ toIntegerOrNull(expression) *Returns:* |=== -| An Integer or `null`. +| `INTEGER` or `null`. |=== @@ -1332,9 +1332,9 @@ toIntegerOrNull(expression) | `toIntegerOrNull(null)` returns `null`. | If `expression` is an integer value, it will be returned unchanged. | If the parsing fails, `null` will be returned. -| If `expression` is the boolean value `false`, `0` will be returned. -| If `expression` is the boolean value `true`, `1` will be returned. -| If the `expression` is not a boolean, floating point, integer or a string value, `null` will be returned. +| If `expression` is the `BOOLEAN` value `false`, `0` will be returned. +| If `expression` is the `BOOLEAN` value `true`, `1` will be returned. +| If the `expression` is not a `BOOLEAN`, `FLOAT`, `INTEGER` or a `STRING` value, `null` will be returned. |=== @@ -1364,7 +1364,7 @@ RETURN toIntegerOrNull('42'), toIntegerOrNull('not a number'), toIntegerOrNull(t [[functions-type]] == type() -The function `type()` returns the string representation of the relationship type. +The function `type()` returns the `STRING` representation of the `RELATIONSHIP` type. *Syntax:* @@ -1377,7 +1377,7 @@ type(relationship) |=== -| A String. +| `STRING` |=== @@ -1388,7 +1388,7 @@ type(relationship) | Name | Description | `relationship` -| An expression that returns a relationship. +| An expression that returns a `RELATIONSHIP`. |=== diff --git a/modules/ROOT/pages/functions/spatial.adoc b/modules/ROOT/pages/functions/spatial.adoc index 777c94178..68bba0c7c 100644 --- a/modules/ROOT/pages/functions/spatial.adoc +++ b/modules/ROOT/pages/functions/spatial.adoc @@ -5,7 +5,7 @@ [abstract] -- -These functions are used to specify 2D or 3D points in a Coordinate Reference System (CRS) and to calculate the geodesic distance between two points. +These functions are used to specify 2D or 3D `POINT` values in a Coordinate Reference System (CRS) and to calculate the geodesic distance between two `POINT` values. -- The following graph is used for some of the examples below. @@ -25,11 +25,11 @@ CREATE [[functions-distance]] == point.distance() -`point.distance()` returns a floating point number representing the geodesic distance between two points in the same Coordinate Reference System (CRS). +`point.distance()` returns a `FLOAT` representing the geodesic distance between two points in the same Coordinate Reference System (CRS). -* If the points are in the _Cartesian_ CRS (2D or 3D), then the units of the returned distance will be the same as the units of the points, calculated using Pythagoras' theorem. -* If the points are in the _WGS-84_ CRS (2D), then the units of the returned distance will be meters, based on the haversine formula over a spherical earth approximation. -* If the points are in the _WGS-84_ CRS (3D), then the units of the returned distance will be meters. +* If the `POINT` values are in the _Cartesian_ CRS (2D or 3D), then the units of the returned distance will be the same as the units of the points, calculated using Pythagoras' theorem. +* If the `POINT` values are in the _WGS-84_ CRS (2D), then the units of the returned distance will be meters, based on the haversine formula over a spherical earth approximation. +* If the `POINT` values are in the _WGS-84_ CRS (3D), then the units of the returned distance will be meters. ** The distance is calculated in two steps. *** First, a haversine formula over a spherical earth is used, at the average height of the two points. *** To account for the difference in height, Pythagoras' theorem is used, combining the previously calculated spherical distance with the height difference. @@ -45,7 +45,7 @@ point.distance(point1, point2) |=== -| A Float. +| `FLOAT` |=== @@ -56,10 +56,10 @@ point.distance(point1, point2) | Name | Description | `point1` -| A point in either a geographic or cartesian coordinate system. +| A `POINT` in either a geographic or cartesian coordinate system. | `point2` -| A point in the same CRS as `point1`. +| A `POINT` in the same CRS as `point1`. |=== @@ -185,9 +185,9 @@ If `null` is provided as one or both of the arguments, `null` is returned. `point.withinBBox()` takes the following arguments: -* The point to check. -* The lower-left (south-west) point of a bounding box. -* The upper-right (or north-east) point of a bounding box. +* The `POINT` to check. +* The lower-left (south-west) `POINT` of a bounding box. +* The upper-right (or north-east) `POINT` of a bounding box. The return value will be true if the provided point is contained in the bounding box (boundary included), otherwise the return value will be false. @@ -200,7 +200,7 @@ point.withinBBox(point, lowerLeft, upperRight) |=== -| A Boolean. +| `BOOLEAN` |=== @@ -211,13 +211,13 @@ point.withinBBox(point, lowerLeft, upperRight) | Name | Description | `point` -| A point in either a geographic or cartesian coordinate system. +| A `POINT` in either a geographic or cartesian coordinate system. | `lowerLeft` -| A point in the same CRS as 'point'. +| A `POINT` in the same CRS as 'point'. | `upperRight` -| A point in the same CRS as 'point'. +| A `POINT` in the same CRS as 'point'. |=== @@ -226,7 +226,7 @@ point.withinBBox(point, lowerLeft, upperRight) |=== | `point.withinBBox(p1, p2, p3)` will return `null` if any of the arguments evaluate to `null`. -| Attempting to use points with different Coordinate Reference Systems (such as WGS 84 2D and WGS 84 3D) will return `null`. +| Attempting to use `POINT` values with different Coordinate Reference Systems (such as WGS 84 2D and WGS 84 3D) will return `null`. | `point.withinBBox` will handle crossing the 180th meridian in geographic coordinates. | Switching the longitude of the `lowerLeft` and `upperRight` in geographic coordinates will switch the direction of the resulting bounding box. | Switching the latitude of the `lowerLeft` and `upperRight` in geographic coordinates so that the former is north of the latter will result in an empty range. @@ -349,7 +349,7 @@ If `null` is provided as any of the arguments, `null` is returned. [[functions-point-wgs84-2d]] == point() - WGS 84 2D -`point({longitude | x, latitude | y [, crs][, srid]})` returns a 2D point in the _WGS 84_ CRS corresponding to the given coordinate values. +`point({longitude | x, latitude | y [, crs][, srid]})` returns a 2D `POINT` in the _WGS 84_ CRS corresponding to the given coordinate values. [source, syntax] ---- @@ -360,7 +360,7 @@ point({longitude | x, latitude | y [, crs][, srid]}) |=== -| A 2D point in _WGS 84_. +| A 2D `POINT` in _WGS 84_. |=== @@ -380,10 +380,10 @@ point({longitude | x, latitude | y [, crs][, srid]}) | A numeric expression that represents the latitude/y value in decimal degrees. | `crs` -| The optional string `'WGS-84'`. +| The optional `STRING` `'WGS-84'`. | `srid` -| The optional number `4326`. +| The optional `INTEGER` `4326`. |=== @@ -407,7 +407,7 @@ point({longitude | x, latitude | y [, crs][, srid]}) RETURN point({longitude: 56.7, latitude: 12.78}) AS point ---- -A 2D point with a `longitude` of `56.7` and a `latitude` of `12.78` in the _WGS 84_ CRS is returned. +A 2D `POINT` with a `longitude` of `56.7` and a `latitude` of `12.78` in the _WGS 84_ CRS is returned. .Result [role="queryresult",options="header,footer",cols="1*` resulting from the splitting of the given `STRING` around matches of the given delimiter. *Syntax:* @@ -428,7 +428,7 @@ split(original, splitDelimiter) |=== -| A list of Strings. +| `LIST` |=== @@ -438,10 +438,10 @@ split(original, splitDelimiter) | Name | Description | `original` -| An expression that returns a string. +| An expression that returns a `STRING`. | `splitDelimiter` -| The string with which to split `original`. +| The `STRING` with which to split `original`. |=== @@ -480,7 +480,7 @@ RETURN split('one,two', ',') [[functions-substring]] == substring() -`substring()` returns a substring of the original string, beginning with a zero-based index start and length. +`substring()` returns a substring of the given `STRING`, beginning with a zero-based index start and length. *Syntax:* @@ -493,7 +493,7 @@ substring(original, start [, length]) |=== -| A String. +| `STRING` |=== @@ -503,13 +503,13 @@ substring(original, start [, length]) | Name | Description | `original` -| An expression that returns a string. +| An expression that returns a `STRING`. | `start` -| An expression that returns a positive integer, denoting the position at which the substring will begin. +| An expression that returns a positive `INTEGER`, denoting the position at which the substring will begin. | `length` -| An expression that returns a positive integer, denoting how many characters of `original` will be returned. +| An expression that returns a positive `INTEGER`, denoting how many characters of `original` will be returned. |=== @@ -521,7 +521,7 @@ substring(original, start [, length]) | If `original` is `null`, `null` is returned. | If either `start` or `length` is `null` or a negative integer, an error is raised. | If `start` is `0`, the substring will start at the beginning of `original`. -| If `length` is `0`, the empty string will be returned. +| If `length` is `0`, the empty `STRING` will be returned. |=== @@ -551,7 +551,7 @@ RETURN substring('hello', 1, 3), substring('hello', 2) [[functions-tolower]] == toLower() -`toLower()` returns the original string in lowercase. +`toLower()` returns the given `STRING` in lowercase. *Syntax:* @@ -564,7 +564,7 @@ toLower(original) |=== -| A String. +| `STRING` |=== @@ -575,7 +575,7 @@ toLower(original) | Name | Description | `original` -| An expression that returns a string. +| An expression that returns a `STRING`. |=== @@ -610,7 +610,7 @@ RETURN toLower('HELLO') [[functions-tostring]] == toString() -`toString()` converts an integer, float, boolean, string, point, duration, date, time, localtime, localdatetime, or datetime value to a string. +`toString()` converts an `INTEGER`, `FLOAT`, `BOOLEAN`, `STRING`, `POINT`, `DURATION`, `DATE`, `ZONED TIME`, `LOCAL TIME`, `LOCAL DATETIME` or `ZONED DATETIME` value to a `STRING`. *Syntax:* @@ -623,7 +623,7 @@ toString(expression) |=== -| A String. +| `STRING` |=== @@ -634,7 +634,7 @@ toString(expression) | Name | Description | `expression` -| An expression that returns a number, a boolean, string, temporal, or spatial value. +| An expression that returns an `INTEGER`, `FLOAT`, `BOOLEAN`, `STRING`, `POINT`, `DURATION`, `DATE`, `ZONED TIME`, `LOCAL TIME`, `LOCAL DATETIME` or `ZONED DATETIME` value. |=== @@ -643,8 +643,8 @@ toString(expression) |=== | `toString(null)` returns `null`. -| If `expression` is a string, it will be returned unchanged. -| This function will return an error if provided with an expression that is not an integer, float, string, boolean, point, duration, date, time, localtime, localdatetime or datetime value. +| If `expression` is a `STRING`, it will be returned unchanged. +| This function will return an error if provided with an expression that is not an `INTEGER`, `FLOAT`, `BOOLEAN`, `STRING`, `POINT`, `DURATION`, `DATE`, `ZONED TIME`, `LOCAL TIME`, `LOCAL DATETIME` or `ZONED DATETIME` value. |=== @@ -680,7 +680,7 @@ RETURN [[functions-tostringornull]] == toStringOrNull() -The function `toStringOrNull()` converts an integer, float, boolean, string, point, duration, date, time, localtime, localdatetime, or datetime value to a string. +The function `toStringOrNull()` converts an `INTEGER`, `FLOAT`, `BOOLEAN`, `STRING`, `POINT`, `DURATION`, `DATE`, `ZONED TIME`, `LOCAL TIME`, `LOCAL DATETIME` or `ZONED DATETIME` value to a `STRING`. *Syntax:* @@ -693,7 +693,7 @@ toStringOrNull(expression) |=== -| A String or `null`. +| `STRING` or `null`. |=== @@ -711,7 +711,7 @@ toStringOrNull(expression) *Considerations:* |=== | `toStringOrNull(null)` returns `null`. -| If the `expression` is not an integer, float, string, boolean, point, duration, date, time, localtime, localdatetime, or datetime value, `null` will be returned. +| If the `expression` is not an `INTEGER`, `FLOAT`, `BOOLEAN`, `STRING`, `POINT`, `DURATION`, `DATE`, `ZONED TIME`, `LOCAL TIME`, `LOCAL DATETIME` or `ZONED DATETIME` value, `null` will be returned. |=== @@ -746,7 +746,7 @@ toStringOrNull(['A', 'B', 'C']) AS list [[functions-toupper]] == toUpper() -`toUpper()` returns the original string in uppercase. +`toUpper()` returns the given `STRING` in uppercase. *Syntax:* @@ -759,7 +759,7 @@ toUpper(original) |=== -| A String. +| `STRING` |=== @@ -770,7 +770,7 @@ toUpper(original) | Name | Description | `original` -| An expression that returns a string. +| An expression that returns a `STRING`. |=== @@ -808,7 +808,7 @@ RETURN toUpper('hello') [[functions-trim]] == trim() -`trim()` returns the original string with leading and trailing whitespace removed. +`trim()` returns the given `STRING` with leading and trailing whitespace removed. *Syntax:* @@ -821,7 +821,7 @@ trim(original) |=== -| A String. +| `STRING` |=== @@ -832,7 +832,7 @@ trim(original) | Name | Description | `original` -| An expression that returns a string. +| An expression that returns a `STRING`. |=== diff --git a/modules/ROOT/pages/functions/temporal/duration.adoc b/modules/ROOT/pages/functions/temporal/duration.adoc index 792daaacc..e9cc2f191 100644 --- a/modules/ROOT/pages/functions/temporal/duration.adoc +++ b/modules/ROOT/pages/functions/temporal/duration.adoc @@ -1,11 +1,11 @@ -:description: Cypher provides functions allowing for the creation and manipulation of values for a _Duration_ temporal type. +:description: Cypher provides functions allowing for the creation and manipulation of temporal `DURATION` values. [[query-functions-temporal-duration]] = Temporal functions - duration [abstract] -- -Cypher provides functions allowing for the creation and manipulation of values for a _Duration_ temporal type. +Cypher provides functions allowing for the creation and manipulation of temporal `DURATION` values. -- [NOTE] @@ -15,16 +15,16 @@ See also xref::values-and-types/temporal.adoc[Temporal (Date/Time) values] and x duration(): -* xref::functions/temporal/duration.adoc#functions-duration[Creating a _Duration_ from duration components] -* xref::functions/temporal/duration.adoc#functions-duration-create-string[Creating a _Duration_ from a string] -* xref::functions/temporal/duration.adoc#functions-duration-computing[Computing the _Duration_ between two temporal instants] +* xref::functions/temporal/duration.adoc#functions-duration[Creating a `DURATION` from duration components] +* xref::functions/temporal/duration.adoc#functions-duration-create-string[Creating a `DURATION` from a string] +* xref::functions/temporal/duration.adoc#functions-duration-computing[Computing the `DURATION` between two temporal instants] -Information regarding specifying and accessing components of a _Duration_ value can be found xref::values-and-types/temporal.adoc#cypher-temporal-durations[here]. +Information regarding specifying and accessing components of a `DURATION` value can be found xref::values-and-types/temporal.adoc#cypher-temporal-durations[here]. [[functions-duration]] -== Creating a _Duration_ from duration components +== Creating a `DURATION` from duration components -`duration()` can construct a _Duration_ from a map of its components in the same way as the temporal instant types. +`duration()` can construct a `DURATION` from a `MAP` of its components in the same way as the temporal instant types. * `years` * `quarters` @@ -49,7 +49,7 @@ duration([ {years, quarters, months, weeks, days, hours, minutes, seconds, milli |=== -| A Duration. +| `DURATION` |=== @@ -103,7 +103,7 @@ duration([ {years, quarters, months, weeks, days, hours, minutes, seconds, milli | At least one parameter must be provided (`duration()` and `+duration({})+` are invalid). | There is no constraint on how many of the parameters are provided. -| It is possible to have a _Duration_ where the amount of a smaller unit (e.g. `seconds`) exceeds the threshold of a larger unit (e.g. `days`). +| It is possible to have a `DURATION` where the amount of a smaller unit (e.g. `seconds`) exceeds the threshold of a larger unit (e.g. `days`). | The values of the parameters may be expressed as decimal fractions. | The values of the parameters may be arbitrarily large. | The values of the parameters may be negative. @@ -146,9 +146,9 @@ RETURN aDuration [[functions-duration-create-string]] -== Creating a _Duration_ from a string +== Creating a `DURATION` from a string -`duration()` returns the _Duration_ value obtained by parsing a string representation of a temporal amount. +`duration()` returns the `DURATION` value obtained by parsing a `STRING` representation of a temporal amount. *Syntax:* @@ -161,7 +161,7 @@ duration(temporalAmount) |=== -| A Duration. +| `DURATION` |=== @@ -172,7 +172,7 @@ duration(temporalAmount) | Name | Description | `temporalAmount` -| A string representing a temporal amount. +| A `STRING` representing a temporal amount. |=== @@ -180,7 +180,7 @@ duration(temporalAmount) |=== -| `temporalAmount` must comply with either the xref::values-and-types/temporal.adoc#cypher-temporal-specifying-durations[unit based form or date-and-time based form defined for _Durations_]. +| `temporalAmount` must comply with either the xref::values-and-types/temporal.adoc#cypher-temporal-specifying-durations[unit based form or date-and-time based form defined for `DURATION` values]. |=== @@ -219,7 +219,7 @@ RETURN aDuration [[functions-duration-computing]] -== Computing the _Duration_ between two temporal instants +== Computing the `DURATION` between two temporal instants `duration()` has sub-functions which compute the _logical difference_ (in days, months, etc) between two temporal instant values: @@ -232,7 +232,7 @@ RETURN aDuration [[functions-duration-between]] === duration.between() -`duration.between()` returns the _Duration_ value equal to the difference between the two given instants. +`duration.between()` returns the `DURATION` value equal to the difference between the two given instants. *Syntax:* @@ -245,7 +245,7 @@ duration.between(instant1, instant2) |=== -| A Duration. +| `DURATION` |=== @@ -256,10 +256,10 @@ duration.between(instant1, instant2) | Name | Description | `instant1` -| An expression returning any temporal instant type (_Date_ etc) that represents the starting instant. +| An expression returning any temporal instant type (`DATE` etc.) that represents the starting instant. | `instant2` -| An expression returning any temporal instant type (_Date_ etc) that represents the ending instant. +| An expression returning any temporal instant type (`DATE` etc.) that represents the ending instant. |=== @@ -267,7 +267,7 @@ duration.between(instant1, instant2) |=== -| If `instant2` occurs earlier than `instant1`, the resulting _Duration_ will be negative. +| If `instant2` occurs earlier than `instant1`, the resulting `DURATION` will be negative. | If `instant1` has a time component and `instant2` does not, the time component of `instant2` is assumed to be midnight, and vice versa. | If `instant1` has a time zone component and `instant2` does not, the time zone component of `instant2` is assumed to be the same as that of `instant1`, and vice versa. | If `instant1` has a date component and `instant2` does not, the date component of `instant2` is assumed to be the same as that of `instant1`, and vice versa. @@ -315,7 +315,7 @@ RETURN aDuration [[functions-duration-inmonths]] === duration.inMonths() -`duration.inMonths()` returns the _Duration_ value equal to the difference in whole months, quarters or years between the two given instants. +`duration.inMonths()` returns the `DURATION` value equal to the difference in whole months, quarters or years between the two given instants. *Syntax:* @@ -328,7 +328,7 @@ duration.inMonths(instant1, instant2) |=== -| A Duration. +| `DURATION` |=== @@ -339,17 +339,17 @@ duration.inMonths(instant1, instant2) | Name | Description | `instant1` -| An expression returning any temporal instant type (_Date_ etc) that represents the starting instant. +| An expression returning any temporal instant type (`DATE` etc.) that represents the starting instant. | `instant2` -| An expression returning any temporal instant type (_Date_ etc) that represents the ending instant. +| An expression returning any temporal instant type (`DATE` etc.) that represents the ending instant. |=== *Considerations:* |=== -| If `instant2` occurs earlier than `instant1`, the resulting _Duration_ will be negative. +| If `instant2` occurs earlier than `instant1`, the resulting `DURATION` will be negative. | If `instant1` has a time component and `instant2` does not, the time component of `instant2` is assumed to be midnight, and vice versa. | If `instant1` has a time zone component and `instant2` does not, the time zone component of `instant2` is assumed to be the same as that of `instant1`, and vice versa. | If `instant1` has a date component and `instant2` does not, the date component of `instant2` is assumed to be the same as that of `instant1`, and vice versa. @@ -396,7 +396,7 @@ RETURN aDuration [[functions-duration-indays]] === duration.inDays() -`duration.inDays()` returns the _Duration_ value equal to the difference in whole days or weeks between the two given instants. +`duration.inDays()` returns the `DURATION` value equal to the difference in whole days or weeks between the two given instants. *Syntax:* @@ -409,7 +409,7 @@ duration.inDays(instant1, instant2) |=== -| A Duration. +| `DURATION` |=== @@ -420,10 +420,10 @@ duration.inDays(instant1, instant2) | Name | Description | `instant1` -| An expression returning any temporal instant type (_Date_ etc) that represents the starting instant. +| An expression returning any temporal instant type (`DATE` etc.) that represents the starting instant. | `instant2` -| An expression returning any temporal instant type (_Date_ etc) that represents the ending instant. +| An expression returning any temporal instant type (`DATE` etc.) that represents the ending instant. |=== @@ -431,7 +431,7 @@ duration.inDays(instant1, instant2) |=== -| If `instant2` occurs earlier than `instant1`, the resulting _Duration_ will be negative. +| If `instant2` occurs earlier than `instant1`, the resulting `DURATION` will be negative. | If `instant1` has a time component and `instant2` does not, the time component of `instant2` is assumed to be midnight, and vice versa. | If `instant1` has a time zone component and `instant2` does not, the time zone component of `instant2` is assumed to be the same as that of `instant1`, and vice versa. | If `instant1` has a date component and `instant2` does not, the date component of `instant2` is assumed to be the same as that of `instant1`, and vice versa. @@ -478,7 +478,7 @@ RETURN aDuration [[functions-duration-inseconds]] === duration.inSeconds() -`duration.inSeconds()` returns the _Duration_ value equal to the difference in seconds and fractions of seconds, or minutes or hours, between the two given instants. +`duration.inSeconds()` returns the `DURATION` value equal to the difference in seconds and fractions of seconds, or minutes or hours, between the two given instants. *Syntax:* @@ -491,7 +491,7 @@ duration.inSeconds(instant1, instant2) |=== -| A Duration. +| `DURATION` |=== @@ -501,10 +501,10 @@ duration.inSeconds(instant1, instant2) | Name | Description | `instant1` -| An expression returning any temporal instant type (_Date_ etc) that represents the starting instant. +| An expression returning any temporal instant type (`DATE` etc.) that represents the starting instant. | `instant2` -| An expression returning any temporal instant type (_Date_ etc) that represents the ending instant. +| An expression returning any temporal instant type (`DATE` etc.) that represents the ending instant. |=== @@ -512,7 +512,7 @@ duration.inSeconds(instant1, instant2) |=== -| If `instant2` occurs earlier than `instant1`, the resulting _Duration_ will be negative. +| If `instant2` occurs earlier than `instant1`, the resulting `DURATION` will be negative. | If `instant1` has a time component and `instant2` does not, the time component of `instant2` is assumed to be midnight, and vice versa. | If `instant1` has a time zone component and `instant2` does not, the time zone component of `instant2` is assumed to be the same as that of `instant1`, and vice versa. | If `instant1` has a date component and `instant2` does not, the date component of `instant2` is assumed to be the same as that of `instant1`, and vice versa. diff --git a/modules/ROOT/pages/functions/temporal/index.adoc b/modules/ROOT/pages/functions/temporal/index.adoc index 19db53173..78d597bde 100644 --- a/modules/ROOT/pages/functions/temporal/index.adoc +++ b/modules/ROOT/pages/functions/temporal/index.adoc @@ -1,11 +1,11 @@ -:description: Cypher provides functions allowing for the creation and manipulation of values for each temporal type -- _Date_, _Time_, _LocalTime_, _DateTime_, and _LocalDateTime_. +:description: Cypher provides functions allowing for the creation and manipulation of values for each temporal type -- `DATE`, `ZONED TIME`, `LOCAL TIME`, `ZONED DATETIME`, and `LOCAL DATETIME`. [[query-functions-temporal-instant-types]] = Temporal functions - instant types [abstract] -- -Cypher provides functions allowing for the creation and manipulation of values for each temporal type -- _Date_, _Time_, _LocalTime_, _DateTime_, and _LocalDateTime_. +Cypher provides functions allowing for the creation and manipulation of values for each temporal type -- `DATE`, `ZONED TIME`, `LOCAL TIME`, `ZONED DATETIME`, and `LOCAL DATETIME`. -- [NOTE] @@ -26,10 +26,10 @@ Each function bears the same name as the type, and construct the type they corre * Composing the components of the type. * Parsing a string representation of the temporal value. * Selecting and composing components from another temporal value by - ** either combining temporal values (such as combining a _Date_ with a _Time_ to create a _DateTime_), or - ** selecting parts from a temporal value (such as selecting the _Date_ from a _DateTime_); the _extractors_ -- groups of components which can be selected -- are: - *** `date` -- contains all components for a _Date_ (conceptually _year_, _month_ and _day_). - *** `time` -- contains all components for a _Time_ (_hour_, _minute_, _second_, and sub-seconds; namely _millisecond_, _microsecond_ and _nanosecond_). + ** either combining temporal values (such as combining a `DATE` with a `ZONED TIME` to create a `ZONED DATETIME`), or + ** selecting parts from a temporal value (such as selecting the `DATE` from a `ZONED DATETIME`); the _extractors_ -- groups of components which can be selected -- are: + *** `date` -- contains all components for a `DATE` (conceptually _year_, _month_ and _day_). + *** `time` -- contains all components for a `ZONED TIME` (_hour_, _minute_, _second_, and sub-seconds; namely _millisecond_, _microsecond_ and _nanosecond_). If the type being created and the type from which the time component is being selected both contain `timezone` (and a `timezone` is not explicitly specified) the `timezone` is also selected. *** `datetime` -- selects all components, and is useful for overriding specific components. Analogously to `time`, if the type being created and the type from which the time component is being selected both contain `timezone` (and a `timezone` is not explicitly specified) the `timezone` is also selected. @@ -109,7 +109,7 @@ Each function bears the same name as the type, and construct the type they corre [NOTE] ==== -All the temporal instant types -- including those that do not contain time zone information support such as _Date_, _LocalTime_ and _DateTime_ -- allow for a time zone to specified for the functions that retrieve the current instant. +All the temporal instant types -- including those that do not contain time zone information support such as `DATE`, `LOCAL TIME` and `ZONED DATETIME` -- allow for a time zone to specified for the functions that retrieve the current instant. This allows for the retrieval of the current instant in the specified time zone. ==== @@ -305,25 +305,25 @@ The following table lists the supported truncation units and the corresponding s Details for using the `date()` function. -* xref::functions/temporal/index.adoc#functions-date-current[Getting the current _Date_] +* xref::functions/temporal/index.adoc#functions-date-current[Getting the current `DATE`] ** xref::/functions/temporal/index.adoc#functions-date-transaction[+date.transaction()+] ** xref::/functions/temporal/index.adoc#functions-date-statement[+date.statement()+] ** xref::/functions/temporal/index.adoc#functions-date-realtime[+date.realtime()+] -* xref::functions/temporal/index.adoc#functions-date-calendar[Creating a calendar (Year-Month-Day) _Date_] -* xref::functions/temporal/index.adoc#functions-date-week[Creating a week (Year-Week-Day) _Date_] -* xref::functions/temporal/index.adoc#functions-date-quarter[Creating a quarter (Year-Quarter-Day) _Date_] -* xref::functions/temporal/index.adoc#functions-date-ordinal[Creating an ordinal (Year-Day) _Date_] -* xref::functions/temporal/index.adoc#functions-date-create-string[Creating a _Date_ from a string] -* xref::functions/temporal/index.adoc#functions-date-temporal[Creating a _Date_ using other temporal values as components] -* xref::functions/temporal/index.adoc#functions-date-truncate[Truncating a _Date_] +* xref::functions/temporal/index.adoc#functions-date-calendar[Creating a calendar (Year-Month-Day) `DATE`] +* xref::functions/temporal/index.adoc#functions-date-week[Creating a week (Year-Week-Day) `DATE`] +* xref::functions/temporal/index.adoc#functions-date-quarter[Creating a quarter (Year-Quarter-Day) `DATE`] +* xref::functions/temporal/index.adoc#functions-date-ordinal[Creating an ordinal (Year-Day) `DATE`] +* xref::functions/temporal/index.adoc#functions-date-create-string[Creating a `DATE` from a string] +* xref::functions/temporal/index.adoc#functions-date-temporal[Creating a `DATE` using other temporal values as components] +* xref::functions/temporal/index.adoc#functions-date-truncate[Truncating a `DATE`] [discrete] [[functions-date-current]] -=== Getting the current _Date_ +=== Getting the current `DATE` -`date()` returns the current _Date_ value. +`date()` returns the current `DATE` value. If no time zone parameter is specified, the local time zone will be used. *Syntax:* @@ -337,7 +337,7 @@ date([{timezone}]) |=== -| A Date. +| `DATE` |=== @@ -416,7 +416,7 @@ The current date in California is returned. [[functions-date-transaction]] ==== +date.transaction()+ -`date.transaction()` returns the current _Date_ value using the `transaction` clock. +`date.transaction()` returns the current `DATE` value using the `transaction` clock. This value will be the same for each invocation within the same transaction. However, a different value may be produced for different transactions. @@ -431,7 +431,7 @@ date.transaction([{timezone}]) |=== -| A Date. +| `DATE` |=== @@ -472,7 +472,7 @@ RETURN date.transaction() AS currentDate [[functions-date-statement]] ==== +date.statement()+ -`date.statement()` returns the current _Date_ value using the `statement` clock. +`date.statement()` returns the current `DATE` value using the `statement` clock. This value will be the same for each invocation within the same statement. However, a different value may be produced for different statements within the same transaction. @@ -487,7 +487,7 @@ date.statement([{timezone}]) |=== -| A Date. +| `DATE` |=== @@ -529,7 +529,7 @@ RETURN date.statement() AS currentDate [[functions-date-realtime]] ==== date.realtime() -`date.realtime()` returns the current _Date_ value using the `realtime` clock. +`date.realtime()` returns the current `DATE` value using the `realtime` clock. This value will be the live clock of the system. *Syntax:* @@ -543,7 +543,7 @@ date.realtime([{timezone}]) |=== -| A Date. +| `DATE` |=== @@ -605,9 +605,9 @@ RETURN date.realtime('America/Los Angeles') AS currentDateInLA [discrete] [[functions-date-calendar]] -=== Creating a calendar (Year-Month-Day) _Date_ +=== Creating a calendar (Year-Month-Day) `DATE` -`date()` returns a _Date_ value with the specified _year_, _month_ and _day_ component values. +`date()` returns a `DATE` value with the specified _year_, _month_ and _day_ component values. *Syntax:* @@ -620,7 +620,7 @@ date({year [, month, day]}) |=== -| A Date. +| `DATE` |=== @@ -686,9 +686,9 @@ RETURN theDate [[functions-date-week]] [discrete] -=== Creating a week (Year-Week-Day) _Date_ +=== Creating a week (Year-Week-Day) `DATE` -`date()` returns a _Date_ value with the specified _year_, _week_ and _dayOfWeek_ component values. +`date()` returns a `DATE` value with the specified _year_, _week_ and _dayOfWeek_ component values. *Syntax:* @@ -701,7 +701,7 @@ date({year [, week, dayOfWeek]}) |=== -| A Date. +| `DATE` |=== @@ -767,9 +767,9 @@ RETURN theDate [discrete] [[functions-date-quarter]] -=== Creating a quarter (Year-Quarter-Day) _Date_ +=== Creating a quarter (Year-Quarter-Day) `DATE` -`date()` returns a _Date_ value with the specified _year_, _quarter_ and _dayOfQuarter_ component values. +`date()` returns a `DATE` value with the specified _year_, _quarter_ and _dayOfQuarter_ component values. *Syntax:* @@ -782,7 +782,7 @@ date({year [, quarter, dayOfQuarter]}) |=== -| A Date. +| `DATE` |=== @@ -848,9 +848,9 @@ RETURN theDate [discrete] [[functions-date-ordinal]] -=== Creating an ordinal (Year-Day) _Date_ +=== Creating an ordinal (Year-Day) `DATE` -`date()` returns a _Date_ value with the specified _year_ and _ordinalDay_ component values. +`date()` returns a `DATE` value with the specified _year_ and _ordinalDay_ component values. *Syntax:* @@ -863,7 +863,7 @@ date({year [, ordinalDay]}) |=== -| A Date. +| `DATE` |=== @@ -924,9 +924,9 @@ The date corresponding to `11 February 1984` is returned. [discrete] [[functions-date-create-string]] -=== Creating a _Date_ from a string +=== Creating a `DATE` from a `STRING` -`date()` returns the _Date_ value obtained by parsing a string representation of a temporal value. +`date()` returns the `DATE` value obtained by parsing a `STRING` representation of a temporal value. *Syntax:* @@ -939,7 +939,7 @@ date(temporalValue) |=== -|A Date. +| `DATE` |=== @@ -1002,10 +1002,10 @@ RETURN theDate [discrete] [[functions-date-temporal]] -=== Creating a _Date_ using other temporal values as components +=== Creating a `DATE` using other temporal values as components -`date()` returns the _Date_ value obtained by selecting and composing components from another temporal value. -In essence, this allows a _DateTime_ or _LocalDateTime_ value to be converted to a _Date_, and for "missing" components to be provided. +`date()` returns the `DATE` value obtained by selecting and composing components from another temporal value. +In essence, this allows a `ZONED DATETIME` or `LOCAL DATETIME` value to be converted to a `DATE`, and for "missing" components to be provided. *Syntax:* @@ -1018,7 +1018,7 @@ date({date [, year, month, day, week, dayOfWeek, quarter, dayOfQuarter, ordinalD |=== -| A Date. +| `DATE` |=== @@ -1032,7 +1032,7 @@ date({date [, year, month, day, week, dayOfWeek, quarter, dayOfQuarter, ordinalD | | `date` -| A _Date_ value. +| A `DATE` value. | `year` | An expression consisting of at xref::values-and-types/temporal.adoc#cypher-temporal-year[least four digits] that specifies the year. @@ -1100,10 +1100,10 @@ RETURN date({date: dd}) AS dateOnly, date({date: dd, day: 28}) AS dateDay [[functions-date-truncate]] [discrete] -=== Truncating a _Date_ +=== Truncating a `DATE` -`date.truncate()` returns the _Date_ value obtained by truncating a specified temporal instant value at the nearest preceding point in time at the specified component boundary (which is denoted by the truncation unit passed as a parameter to the function). -In other words, the _Date_ returned will have all components that are less significant than the specified truncation unit set to their default values. +`date.truncate()` returns the `DATE` value obtained by truncating a specified temporal instant value at the nearest preceding point in time at the specified component boundary (which is denoted by the truncation unit passed as a parameter to the function). +In other words, the `DATE` returned will have all components that are less significant than the specified truncation unit set to their default values. It is possible to supplement the truncated value by providing a map containing components which are less significant than the truncation unit. This will have the effect of _overriding_ the default values which would otherwise have been set for these less significant components. @@ -1120,7 +1120,7 @@ date.truncate(unit [, temporalInstantValue [, mapOfComponents ] ]) |=== -| A Date. +| `DATE` |=== @@ -1134,7 +1134,7 @@ date.truncate(unit [, temporalInstantValue [, mapOfComponents ] ]) | A string expression evaluating to one of the following strings: `'millennium'`, `'century'`, `'decade'`, `'year'`, `'weekYear'`, `'quarter'`, `'month'`, `'week'`, `'day'`. | `temporalInstantValue` -| An expression of one of the following types: _DateTime_, _LocalDateTime_, _Date_. +| An expression of one of the following types: `ZONED DATETIME`, `LOCAL DATETIME`, `DATE`. | `mapOfComponents` | An expression evaluating to a map containing components less significant than `unit`. @@ -1195,26 +1195,26 @@ RETURN Details for using the `datetime()` function. -* xref::functions/temporal/index.adoc#functions-datetime-current[Getting the current _DateTime_] +* xref::functions/temporal/index.adoc#functions-datetime-current[Getting the current `ZONED DATETIME`] ** xref::functions/temporal/index.adoc#functions-datetime-transaction[+datetime.transaction()+] ** xref::functions/temporal/index.adoc#functions-datetime-statement[+datetime.statement()+] ** xref::functions/temporal/index.adoc#functions-datetime-realtime[+datetime.realtime()+] -* xref::functions/temporal/index.adoc#functions-datetime-calendar[Creating a calendar (Year-Month-Day) _DateTime_] -* xref::functions/temporal/index.adoc#functions-datetime-week[Creating a week (Year-Week-Day) _DateTime_] -* xref::functions/temporal/index.adoc#functions-datetime-quarter[Creating a quarter (Year-Quarter-Day) _DateTime_] -* xref::functions/temporal/index.adoc#functions-datetime-ordinal[Creating an ordinal (Year-Day) _DateTime_] -* xref::functions/temporal/index.adoc#functions-datetime-create-string[Creating a _DateTime_ from a string] -* xref::functions/temporal/index.adoc#functions-datetime-temporal[Creating a _DateTime_ using other temporal values as components] -* xref::functions/temporal/index.adoc#functions-datetime-timestamp[Creating a _DateTime_ from a timestamp] -* xref::functions/temporal/index.adoc#functions-datetime-truncate[Truncating a _DateTime_] +* xref::functions/temporal/index.adoc#functions-datetime-calendar[Creating a calendar (Year-Month-Day) `ZONED DATETIME`] +* xref::functions/temporal/index.adoc#functions-datetime-week[Creating a week (Year-Week-Day) `ZONED DATETIME`] +* xref::functions/temporal/index.adoc#functions-datetime-quarter[Creating a quarter (Year-Quarter-Day) `ZONED DATETIME`] +* xref::functions/temporal/index.adoc#functions-datetime-ordinal[Creating an ordinal (Year-Day) `ZONED DATETIME`] +* xref::functions/temporal/index.adoc#functions-datetime-create-string[Creating a `ZONED DATETIME` from a string] +* xref::functions/temporal/index.adoc#functions-datetime-temporal[Creating a `ZONED DATETIME` using other temporal values as components] +* xref::functions/temporal/index.adoc#functions-datetime-timestamp[Creating a `ZONED DATETIME` from a timestamp] +* xref::functions/temporal/index.adoc#functions-datetime-truncate[Truncating a `ZONED DATETIME`] [discrete] [[functions-datetime-current]] -=== Getting the current _DateTime_ +=== Getting the current `ZONED DATETIME` -`datetime()` returns the current _DateTime_ value. +`datetime()` returns the current `ZONED DATETIME` value. If no time zone parameter is specified, the default time zone will be used. *Syntax:* @@ -1228,7 +1228,7 @@ datetime([{timezone}]) |=== -| A DateTime. +| `ZONED DATETIME` |=== @@ -1307,7 +1307,7 @@ The current date and time of day in California is returned. [[functions-datetime-transaction]] ==== datetime.transaction() -`datetime.transaction()` returns the current _DateTime_ value using the `transaction` clock. +`datetime.transaction()` returns the current `ZONED DATETIME` value using the `transaction` clock. This value will be the same for each invocation within the same transaction. However, a different value may be produced for different transactions. @@ -1322,7 +1322,7 @@ datetime.transaction([{timezone}]) |=== -| A DateTime. +| `ZONED DATETIME` |=== @@ -1386,7 +1386,7 @@ RETURN datetime.transaction('America/Los Angeles') AS currentDateTimeInLA [[functions-datetime-statement]] ==== datetime.statement() -`datetime.statement()` returns the current _DateTime_ value using the `statement` clock. +`datetime.statement()` returns the current `ZONED DATETIME` value using the `statement` clock. This value will be the same for each invocation within the same statement. However, a different value may be produced for different statements within the same transaction. @@ -1400,7 +1400,7 @@ datetime.statement([{timezone}]) *Returns:* |=== -| A DateTime. +| `ZONED DATETIME` |=== @@ -1442,7 +1442,7 @@ RETURN datetime.statement() AS currentDateTime [[functions-datetime-realtime]] ==== datetime.realtime() -`datetime.realtime()` returns the current _DateTime_ value using the `realtime` clock. +`datetime.realtime()` returns the current `ZONED DATETIME` value using the `realtime` clock. This value will be the live clock of the system. *Syntax:* @@ -1456,7 +1456,7 @@ datetime.realtime([{timezone}]) |=== -| A DateTime. +| `ZONED DATETIME` |=== @@ -1496,9 +1496,9 @@ RETURN datetime.realtime() AS currentDateTime [discrete] [[functions-datetime-calendar]] -=== Creating a calendar (Year-Month-Day) _DateTime_ +=== Creating a calendar (Year-Month-Day) `ZONED DATETIME` -`datetime()` returns a _DateTime_ value with the specified _year_, _month_, _day_, _hour_, _minute_, _second_, _millisecond_, _microsecond_, _nanosecond_ and _timezone_ component values. +`datetime()` returns a `ZONED DATETIME` value with the specified _year_, _month_, _day_, _hour_, _minute_, _second_, _millisecond_, _microsecond_, _nanosecond_ and _timezone_ component values. *Syntax:* @@ -1511,7 +1511,7 @@ datetime({year [, month, day, hour, minute, second, millisecond, microsecond, na |=== -| A DateTime. +| `ZONED DATETIME` |=== @@ -1615,9 +1615,9 @@ RETURN theDate [discrete] [[functions-datetime-week]] -=== Creating a week (Year-Week-Day) _DateTime_ +=== Creating a week (Year-Week-Day) `ZONED DATETIME` -`datetime()` returns a _DateTime_ value with the specified _year_, _week_, _dayOfWeek_, _hour_, _minute_, _second_, _millisecond_, _microsecond_, _nanosecond_ and _timezone_ component values. +`datetime()` returns a `ZONED DATETIME` value with the specified _year_, _week_, _dayOfWeek_, _hour_, _minute_, _second_, _millisecond_, _microsecond_, _nanosecond_ and _timezone_ component values. *Syntax:* @@ -1630,7 +1630,7 @@ datetime({year [, week, dayOfWeek, hour, minute, second, millisecond, microsecon |=== -| A DateTime. +| `ZONED DATETIME` |=== @@ -1732,9 +1732,9 @@ RETURN theDate [discrete] [[functions-datetime-quarter]] -=== Creating a quarter (Year-Quarter-Day) _DateTime_ +=== Creating a quarter (Year-Quarter-Day) `ZONED DATETIME` -`datetime()` returns a _DateTime_ value with the specified _year_, _quarter_, _dayOfQuarter_, _hour_, _minute_, _second_, _millisecond_, _microsecond_, _nanosecond_ and _timezone_ component values. +`datetime()` returns a `ZONED DATETIME` value with the specified _year_, _quarter_, _dayOfQuarter_, _hour_, _minute_, _second_, _millisecond_, _microsecond_, _nanosecond_ and _timezone_ component values. *Syntax:* @@ -1747,7 +1747,7 @@ datetime({year [, quarter, dayOfQuarter, hour, minute, second, millisecond, micr |=== -| A DateTime. +| `ZONED DATETIME` |=== @@ -1843,9 +1843,9 @@ RETURN theDate [discrete] [[functions-datetime-ordinal]] -=== Creating an ordinal (Year-Day) _DateTime_ +=== Creating an ordinal (Year-Day) `ZONED DATETIME` -`datetime()` returns a _DateTime_ value with the specified _year_, _ordinalDay_, _hour_, _minute_, _second_, _millisecond_, _microsecond_, _nanosecond_ and _timezone_ component values. +`datetime()` returns a `ZONED DATETIME` value with the specified _year_, _ordinalDay_, _hour_, _minute_, _second_, _millisecond_, _microsecond_, _nanosecond_ and _timezone_ component values. *Syntax:* @@ -1858,7 +1858,7 @@ datetime({year [, ordinalDay, hour, minute, second, millisecond, microsecond, na |=== -| A DateTime. +| `ZONED DATETIME` |=== @@ -1950,9 +1950,9 @@ RETURN theDate [discrete] [[functions-datetime-create-string]] -=== Creating a _DateTime_ from a string +=== Creating a `ZONED DATETIME` from a `STRING` -`datetime()` returns the _DateTime_ value obtained by parsing a string representation of a temporal value. +`datetime()` returns the `ZONED DATETIME` value obtained by parsing a `STRING` representation of a temporal value. *Syntax:* @@ -1965,7 +1965,7 @@ datetime(temporalValue) |=== -| A DateTime. +| `ZONED DATETIME` |=== @@ -2033,10 +2033,10 @@ RETURN theDate [discrete] [[functions-datetime-temporal]] -=== Creating a _DateTime_ using other temporal values as components +=== Creating a `ZONED DATETIME` using other temporal values as components -`datetime()` returns the _DateTime_ value obtained by selecting and composing components from another temporal value. -In essence, this allows a _Date_, _LocalDateTime_, _Time_ or _LocalTime_ value to be converted to a _DateTime_, and for "missing" components to be provided. +`datetime()` returns the `ZONED DATETIME` value obtained by selecting and composing components from another temporal value. +In essence, this allows a `DATE`, `LOCAL DATETIME`, `ZONED TIME` or `LOCAL TIME` value to be converted to a `ZONED DATETIME`, and for "missing" components to be provided. *Syntax:* @@ -2049,7 +2049,7 @@ datetime({datetime [, year, ..., timezone]}) | datetime({date [, year, ..., time |=== -|A DateTime. +| `ZONED DATETIME` |=== @@ -2063,13 +2063,13 @@ datetime({datetime [, year, ..., timezone]}) | datetime({date [, year, ..., time | | `datetime` -| A _DateTime_ value. +| A `ZONED DATETIME` value. | `date` -| A _Date_ value. +| A `DATE` value. | `time` -| A _Time_ value. +| A `ZONED TIME` value. | `year` | An expression consisting of at xref::values-and-types/temporal.adoc#cypher-temporal-year[least four digits] that specifies the year. @@ -2124,9 +2124,9 @@ datetime({datetime [, year, ..., timezone]}) | datetime({date [, year, ..., time | If any of the optional parameters are provided, these will override the corresponding components of `datetime`, `date` and/or `time`. | `datetime(dd)` may be written instead of `+datetime({datetime: dd})+`. -| Selecting a _Time_ or _DateTime_ value as the `time` component also selects its time zone. If a _LocalTime_ or _LocalDateTime_ is selected instead, the default time zone is used. In any case, the time zone can be overridden explicitly. -| Selecting a _DateTime_ as the `datetime` component and overwriting the time zone will adjust the local time to keep the same point in time. -| Selecting a _DateTime_ or _Time_ as the `time` component and overwriting the time zone will adjust the local time to keep the same point in time. +| Selecting a `ZONED TIME` or `ZONED DATETIME` value as the `time` component also selects its time zone. If a `LOCAL TIME` or `LOCAL DATETIME` is selected instead, the default time zone is used. In any case, the time zone can be overridden explicitly. +| Selecting a `ZONED DATETIME` as the `datetime` component and overwriting the time zone will adjust the local time to keep the same point in time. +| Selecting a `ZONED DATETIME` or `ZONED TIME` as the `time` component and overwriting the time zone will adjust the local time to keep the same point in time. |=== @@ -2192,7 +2192,7 @@ RETURN .+datetime()+ ====== -The following query shows the various usages of `+datetime({date, time [, year, ..., timezone]})+`; i.e. combining a _Date_ and a _Time_ value to create a single _DateTime_ value. +The following query shows the various usages of `+datetime({date, time [, year, ..., timezone]})+`; i.e. combining a `DATE` and a `ZONED TIME` value to create a single `ZONED DATETIME` value. .Query [source, cypher] @@ -2256,11 +2256,11 @@ RETURN [discrete] [[functions-datetime-timestamp]] -=== Creating a _DateTime_ from a timestamp +=== Creating a `ZONED DATETIME` from a timestamp -`datetime()` returns the _DateTime_ value at the specified number of _seconds_ or _milliseconds_ from the UNIX epoch in the UTC time zone. +`datetime()` returns the `ZONED DATETIME` value at the specified number of _seconds_ or _milliseconds_ from the UNIX epoch in the UTC time zone. -Conversions to other temporal instant types from UNIX epoch representations can be achieved by transforming a _DateTime_ value to one of these types. +Conversions to other temporal instant types from UNIX epoch representations can be achieved by transforming a `ZONED DATETIME` value to one of these types. *Syntax:* @@ -2273,7 +2273,7 @@ datetime({ epochSeconds | epochMillis }) |=== -| A DateTime. +| `ZONED DATETIME` |=== @@ -2349,10 +2349,10 @@ RETURN datetime({epochMillis: 424797300000}) AS theDate [discrete] [[functions-datetime-truncate]] -=== Truncating a _DateTime_ +=== Truncating a `ZONED DATETIME` -`datetime.truncate()` returns the _DateTime_ value obtained by truncating a specified temporal instant value at the nearest preceding point in time at the specified component boundary (which is denoted by the truncation unit passed as a parameter to the function). -In other words, the _DateTime_ returned will have all components that are less significant than the specified truncation unit set to their default values. +`datetime.truncate()` returns the `ZONED DATETIME` value obtained by truncating a specified temporal instant value at the nearest preceding point in time at the specified component boundary (which is denoted by the truncation unit passed as a parameter to the function). +In other words, the `ZONED DATETIME` returned will have all components that are less significant than the specified truncation unit set to their default values. It is possible to supplement the truncated value by providing a map containing components which are less significant than the truncation unit. This will have the effect of _overriding_ the default values which would otherwise have been set for these less significant components. @@ -2369,7 +2369,7 @@ datetime.truncate(unit [, temporalInstantValue [, mapOfComponents ] ]) |=== -| A DateTime. +| `ZONED DATETIME` |=== @@ -2383,7 +2383,7 @@ datetime.truncate(unit [, temporalInstantValue [, mapOfComponents ] ]) | A string expression evaluating to one of the following strings: `'millennium'`, `'century'`, `'decade'`, `'year'`, `'weekYear'`, `'quarter'`, `'month'`, `'week'`, `'day'`, `'hour'`, `'minute'`, `'second'`, `'millisecond'`, `'microsecond'`. | `temporalInstantValue` -| An expression of one of the following types: _DateTime_, _LocalDateTime_, _Date_. +| An expression of one of the following types: `ZONED DATETIME`, `LOCAL DATETIME`, `DATE`. | `mapOfComponents` a| @@ -2396,10 +2396,10 @@ During truncation, a time zone can be attached or overridden using the key `time |=== -| `temporalInstantValue` cannot be a _Date_ value if `unit` is one of: `'hour'`, `'minute'`, `'second'`, `'millisecond'`, `'microsecond'`. +| `temporalInstantValue` cannot be a `DATE` value if `unit` is one of: `'hour'`, `'minute'`, `'second'`, `'millisecond'`, `'microsecond'`. | The time zone of `temporalInstantValue` may be overridden; for example, `+datetime.truncate('minute', input, {timezone: '+0200'})+`. -| If `temporalInstantValue` is one of _Time_, _DateTime_ -- a value with a time zone -- and the time zone is overridden, no time conversion occurs. -| If `temporalInstantValue` is one of _LocalDateTime_, _Date_ -- a value without a time zone -- and the time zone is not overridden, the configured default time zone will be used. +| If `temporalInstantValue` is one of `ZONED TIME`, `ZONED DATETIME` -- a value with a time zone -- and the time zone is overridden, no time conversion occurs. +| If `temporalInstantValue` is one of `LOCAL DATETIME`, `DATE` -- a value without a time zone -- and the time zone is not overridden, the configured default time zone will be used. | Any component that is provided in `mapOfComponents` must be less significant than `unit`; i.e. if `unit` is `'day'`, `mapOfComponents` cannot contain information pertaining to a _month_. | Any component that is not contained in `mapOfComponents` and which is less significant than `unit` will be set to its xref::values-and-types/temporal.adoc#cypher-temporal-accessing-components-temporal-instants[minimal value]. | If `mapOfComponents` is not provided, all components of the returned value which are less significant than `unit` will be set to their default values. @@ -2447,25 +2447,25 @@ RETURN Details for using the `localdatetime()` function. -* xref::functions/temporal/index.adoc#functions-localdatetime-current[Getting the current _LocalDateTime_] +* xref::functions/temporal/index.adoc#functions-localdatetime-current[Getting the current `LOCAL DATETIME`] ** xref::functions/temporal/index.adoc#functions-localdatetime-transaction[+localdatetime.transaction()+] ** xref::functions/temporal/index.adoc#functions-localdatetime-statement[+localdatetime.statement()+] ** xref::functions/temporal/index.adoc#functions-localdatetime-realtime[+localdatetime.realtime()+] -* xref::functions/temporal/index.adoc#functions-localdatetime-calendar[Creating a calendar (Year-Month-Day) _LocalDateTime_] -* xref::functions/temporal/index.adoc#functions-localdatetime-week[Creating a week (Year-Week-Day) _LocalDateTime_] -* xref::functions/temporal/index.adoc#functions-localdatetime-quarter[Creating a quarter (Year-Quarter-Day) _LocalDateTime_] -* xref::functions/temporal/index.adoc#functions-localdatetime-ordinal[Creating an ordinal (Year-Day) _LocalDateTime_] -* xref::functions/temporal/index.adoc#functions-localdatetime-create-string[Creating a _LocalDateTime_ from a string] -* xref::functions/temporal/index.adoc#functions-localdatetime-temporal[Creating a _LocalDateTime_ using other temporal values as components] -* xref::functions/temporal/index.adoc#functions-localdatetime-truncate[Truncating a _LocalDateTime_] +* xref::functions/temporal/index.adoc#functions-localdatetime-calendar[Creating a calendar (Year-Month-Day) `LOCAL DATETIME`] +* xref::functions/temporal/index.adoc#functions-localdatetime-week[Creating a week (Year-Week-Day) `LOCAL DATETIME`] +* xref::functions/temporal/index.adoc#functions-localdatetime-quarter[Creating a quarter (Year-Quarter-Day) `LOCAL DATETIME`] +* xref::functions/temporal/index.adoc#functions-localdatetime-ordinal[Creating an ordinal (Year-Day) `LOCAL DATETIME`] +* xref::functions/temporal/index.adoc#functions-localdatetime-create-string[Creating a `LOCAL DATETIME` from a string] +* xref::functions/temporal/index.adoc#functions-localdatetime-temporal[Creating a `LOCAL DATETIME` using other temporal values as components] +* xref::functions/temporal/index.adoc#functions-localdatetime-truncate[Truncating a `LOCAL DATETIME`] [discrete] [[functions-localdatetime-current]] -=== Getting the current _LocalDateTime_ +=== Getting the current `LOCAL DATETIME` -`localdatetime()` returns the current _LocalDateTime_ value. +`localdatetime()` returns the current `LOCAL DATETIME` value. If no time zone parameter is specified, the local time zone will be used. *Syntax:* @@ -2479,7 +2479,7 @@ localdatetime([{timezone}]) |=== -| A LocalDateTime. +| `LOCAL DATETIME` |=== @@ -2558,7 +2558,7 @@ The current local date and time in California is returned. [[functions-localdatetime-transaction]] ==== localdatetime.transaction() -`localdatetime.transaction()` returns the current _LocalDateTime_ value using the `transaction` clock. +`localdatetime.transaction()` returns the current `LOCAL DATETIME` value using the `transaction` clock. This value will be the same for each invocation within the same transaction. However, a different value may be produced for different transactions. @@ -2573,7 +2573,7 @@ localdatetime.transaction([{timezone}]) |=== -| A LocalDateTime. +| `LOCAL DATETIME` |=== @@ -2615,7 +2615,7 @@ RETURN localdatetime.transaction() AS now [[functions-localdatetime-statement]] ==== localdatetime.statement() -`localdatetime.statement()` returns the current _LocalDateTime_ value using the `statement` clock. +`localdatetime.statement()` returns the current `LOCAL DATETIME` value using the `statement` clock. This value will be the same for each invocation within the same statement. However, a different value may be produced for different statements within the same transaction. @@ -2630,7 +2630,7 @@ localdatetime.statement([{timezone}]) |=== -| A LocalDateTime. +| `LOCAL DATETIME` |=== @@ -2672,7 +2672,7 @@ RETURN localdatetime.statement() AS now [[functions-localdatetime-realtime]] ==== localdatetime.realtime() -`localdatetime.realtime()` returns the current _LocalDateTime_ value using the `realtime` clock. +`localdatetime.realtime()` returns the current `LOCAL DATETIME` value using the `realtime` clock. This value will be the live clock of the system. *Syntax:* @@ -2686,7 +2686,7 @@ localdatetime.realtime([{timezone}]) |=== -| A LocalDateTime. +| `LOCAL DATETIME` |=== @@ -2748,9 +2748,9 @@ RETURN localdatetime.realtime('America/Los Angeles') AS nowInLA [discrete] [[functions-localdatetime-calendar]] -=== Creating a calendar (Year-Month-Day) _LocalDateTime_ +=== Creating a calendar (Year-Month-Day) `LOCAL DATETIME` -`localdatetime()` returns a _LocalDateTime_ value with the specified _year_, _month_, _day_, _hour_, _minute_, _second_, _millisecond_, _microsecond_ and _nanosecond_ component values. +`localdatetime()` returns a `LOCAL DATETIME` value with the specified _year_, _month_, _day_, _hour_, _minute_, _second_, _millisecond_, _microsecond_ and _nanosecond_ component values. *Syntax:* @@ -2763,7 +2763,7 @@ localdatetime({year [, month, day, hour, minute, second, millisecond, microsecon |=== -| A LocalDateTime. +| `LOCAL DATETIME` |=== @@ -2850,9 +2850,9 @@ RETURN [discrete] [[functions-localdatetime-week]] -=== Creating a week (Year-Week-Day) _LocalDateTime_ +=== Creating a week (Year-Week-Day) `LOCAL DATETIME` -`localdatetime()` returns a _LocalDateTime_ value with the specified _year_, _week_, _dayOfWeek_, _hour_, _minute_, _second_, _millisecond_, _microsecond_ and _nanosecond_ component values. +`localdatetime()` returns a `LOCAL DATETIME` value with the specified _year_, _week_, _dayOfWeek_, _hour_, _minute_, _second_, _millisecond_, _microsecond_ and _nanosecond_ component values. *Syntax:* @@ -2865,7 +2865,7 @@ localdatetime({year [, week, dayOfWeek, hour, minute, second, millisecond, micro |=== -| A LocalDateTime. +| `LOCAL DATETIME` |=== @@ -2952,9 +2952,9 @@ RETURN [discrete] [[functions-localdatetime-quarter]] -=== Creating a quarter (Year-Quarter-Day) _DateTime_ +=== Creating a quarter (Year-Quarter-Day) `ZONED DATETIME` -`localdatetime()` returns a _LocalDateTime_ value with the specified _year_, _quarter_, _dayOfQuarter_, _hour_, _minute_, _second_, _millisecond_, _microsecond_ and _nanosecond_ component values. +`localdatetime()` returns a `LOCAL DATETIME` value with the specified _year_, _quarter_, _dayOfQuarter_, _hour_, _minute_, _second_, _millisecond_, _microsecond_ and _nanosecond_ component values. *Syntax:* @@ -2967,7 +2967,7 @@ localdatetime({year [, quarter, dayOfQuarter, hour, minute, second, millisecond, |=== -| A LocalDateTime. +| `LOCAL DATETIME` |=== @@ -3054,9 +3054,9 @@ RETURN [discrete] [[functions-localdatetime-ordinal]] -=== Creating an ordinal (Year-Day) _LocalDateTime_ +=== Creating an ordinal (Year-Day) `LOCAL DATETIME` -`localdatetime()` returns a _LocalDateTime_ value with the specified _year_, _ordinalDay_, _hour_, _minute_, _second_, _millisecond_, _microsecond_ and _nanosecond_ component values. +`localdatetime()` returns a `LOCAL DATETIME` value with the specified _year_, _ordinalDay_, _hour_, _minute_, _second_, _millisecond_, _microsecond_ and _nanosecond_ component values. *Syntax:* @@ -3069,7 +3069,7 @@ localdatetime({year [, ordinalDay, hour, minute, second, millisecond, microsecon |=== -| A LocalDateTime. +| `LOCAL DATETIME` |=== @@ -3152,9 +3152,9 @@ RETURN [discrete] [[functions-localdatetime-create-string]] -=== Creating a _LocalDateTime_ from a string +=== Creating a `LOCAL DATETIME` from a `STRING` -`localdatetime()` returns the _LocalDateTime_ value obtained by parsing a string representation of a temporal value. +`localdatetime()` returns the `LOCAL DATETIME` value obtained by parsing a `STRING` representation of a temporal value. *Syntax:* @@ -3167,7 +3167,7 @@ localdatetime(temporalValue) |=== -| A LocalDateTime. +| `LOCAL DATETIME` |=== @@ -3226,10 +3226,10 @@ RETURN theDate [discrete] [[functions-localdatetime-temporal]] -=== Creating a _LocalDateTime_ using other temporal values as components +=== Creating a `LOCAL DATETIME` using other temporal values as components -`localdatetime()` returns the _LocalDateTime_ value obtained by selecting and composing components from another temporal value. -In essence, this allows a _Date_, _DateTime_, _Time_ or _LocalTime_ value to be converted to a _LocalDateTime_, and for "missing" components to be provided. +`localdatetime()` returns the `LOCAL DATETIME` value obtained by selecting and composing components from another temporal value. +In essence, this allows a `DATE`, `ZONED DATETIME`, `ZONED TIME` or `LOCAL TIME` value to be converted to a `LOCAL DATETIME`, and for "missing" components to be provided. *Syntax:* @@ -3242,7 +3242,7 @@ localdatetime({datetime [, year, ..., nanosecond]}) | localdatetime({date [, yea |=== -| A LocalDateTime. +| `LOCAL DATETIME` |=== @@ -3255,13 +3255,13 @@ localdatetime({datetime [, year, ..., nanosecond]}) | localdatetime({date [, yea | `A single map consisting of the following:` | -| `datetime` | A _DateTime_ value. +| `datetime` | A `ZONED DATETIME` value. | `date` -| A _Date_ value. +| A `DATE` value. | `time` -| A _Time_ value. +| A `ZONED TIME` value. | `year` | An expression consisting of at xref::values-and-types/temporal.adoc#cypher-temporal-year[least four digits] that specifies the year. @@ -3374,7 +3374,7 @@ RETURN .+localdatetime()+ ====== -The following query shows the various usages of `+localdatetime({date, time [, year, ..., nanosecond]})+`; i.e. combining a _Date_ and a _Time_ value to create a single _LocalDateTime_ value. +The following query shows the various usages of `+localdatetime({date, time [, year, ..., nanosecond]})+`; i.e. combining a `DATE` and a `ZONED TIME` value to create a single `LOCAL DATETIME` value. .Query [source, cypher] @@ -3434,10 +3434,10 @@ RETURN [discrete] [[functions-localdatetime-truncate]] -=== Truncating a _LocalDateTime_ +=== Truncating a `LOCAL DATETIME` -`localdatetime.truncate()` returns the _LocalDateTime_ value obtained by truncating a specified temporal instant value at the nearest preceding point in time at the specified component boundary (which is denoted by the truncation unit passed as a parameter to the function). -In other words, the _LocalDateTime_ returned will have all components that are less significant than the specified truncation unit set to their default values. +`localdatetime.truncate()` returns the `LOCAL DATETIME` value obtained by truncating a specified temporal instant value at the nearest preceding point in time at the specified component boundary (which is denoted by the truncation unit passed as a parameter to the function). +In other words, the `LOCAL DATETIME` returned will have all components that are less significant than the specified truncation unit set to their default values. It is possible to supplement the truncated value by providing a map containing components which are less significant than the truncation unit. This will have the effect of _overriding_ the default values which would otherwise have been set for these less significant components. @@ -3454,7 +3454,7 @@ localdatetime.truncate(unit [, temporalInstantValue [, mapOfComponents ] ]) |=== -| A LocalDateTime. +| `LOCAL DATETIME` |=== @@ -3468,7 +3468,7 @@ localdatetime.truncate(unit [, temporalInstantValue [, mapOfComponents ] ]) | A string expression evaluating to one of the following strings: `'millennium'`, `'century'`, `'decade'`, `'year'`, `'weekYear'`, `'quarter'`, `'month'`, `'week'`, `'day'`, `'hour'`, `'minute'`, `'second'`, `'millisecond'`, `'microsecond'`. | `temporalInstantValue` -| An expression of one of the following types: _DateTime_, _LocalDateTime_, _Date_. +| An expression of one of the following types: `ZONED DATETIME`, `LOCAL DATETIME`, `DATE`. | `mapOfComponents` | An expression evaluating to a map containing components less significant than `unit`. @@ -3479,7 +3479,7 @@ localdatetime.truncate(unit [, temporalInstantValue [, mapOfComponents ] ]) |=== -| `temporalInstantValue` cannot be a _Date_ value if `unit` is one of: `'hour'`, `'minute'`, `'second'`, `'millisecond'`, `'microsecond'`. +| `temporalInstantValue` cannot be a `DATE` value if `unit` is one of: `'hour'`, `'minute'`, `'second'`, `'millisecond'`, `'microsecond'`. | Any component that is provided in `mapOfComponents` must be less significant than `unit`; i.e. if `unit` is `'day'`, `mapOfComponents` cannot contain information pertaining to a _month_. | Any component that is not contained in `mapOfComponents` and which is less significant than `unit` will be set to its xref::values-and-types/temporal.adoc#cypher-temporal-accessing-components-temporal-instants[minimal value]. | If `mapOfComponents` is not provided, all components of the returned value which are less significant than `unit` will be set to their default values. @@ -3526,22 +3526,22 @@ RETURN Details for using the `localtime()` function. -* xref::functions/temporal/index.adoc#functions-localtime-current[Getting the current _LocalTime_] +* xref::functions/temporal/index.adoc#functions-localtime-current[Getting the current `LOCAL TIME`] ** xref::functions/temporal/index.adoc#functions-localtime-transaction[+localtime.transaction()+] ** xref::functions/temporal/index.adoc#functions-localtime-statement[+localtime.statement()+] ** xref::functions/temporal/index.adoc#functions-localtime-realtime[+localtime.realtime()+] -* xref::functions/temporal/index.adoc#functions-localtime-create[Creating a _LocalTime_] -* xref::functions/temporal/index.adoc#functions-localtime-create-string[Creating a _LocalTime_ from a string] -* xref::functions/temporal/index.adoc#functions-localtime-temporal[Creating a _LocalTime_ using other temporal values as components] -* xref::functions/temporal/index.adoc#functions-localtime-truncate[Truncating a _LocalTime_] +* xref::functions/temporal/index.adoc#functions-localtime-create[Creating a `LOCAL TIME`] +* xref::functions/temporal/index.adoc#functions-localtime-create-string[Creating a `LOCAL TIME` from a string] +* xref::functions/temporal/index.adoc#functions-localtime-temporal[Creating a `LOCAL TIME` using other temporal values as components] +* xref::functions/temporal/index.adoc#functions-localtime-truncate[Truncating a `LOCAL TIME`] [discrete] [[functions-localtime-current]] -=== Getting the current _LocalTime_ +=== Getting the current `LOCAL TIME` -`localtime()` returns the current _LocalTime_ value. +`localtime()` returns the current `LOCAL TIME` value. If no time zone parameter is specified, the local time zone will be used. *Syntax:* @@ -3555,7 +3555,7 @@ localtime([{timezone}]) |=== -| A LocalTime. +| `LOCAL TIME` |=== @@ -3634,7 +3634,7 @@ The current local time in California is returned. [[functions-localtime-transaction]] ==== localtime.transaction() -`localtime.transaction()` returns the current _LocalTime_ value using the `transaction` clock. +`localtime.transaction()` returns the current `LOCAL TIME` value using the `transaction` clock. This value will be the same for each invocation within the same transaction. However, a different value may be produced for different transactions. @@ -3649,7 +3649,7 @@ localtime.transaction([{timezone}]) |=== -| A LocalTime. +| `LOCAL TIME` |=== @@ -3691,7 +3691,7 @@ RETURN localtime.transaction() AS now [[functions-localtime-statement]] ==== localtime.statement() -`localtime.statement()` returns the current _LocalTime_ value using the `statement` clock. +`localtime.statement()` returns the current `LOCAL TIME` value using the `statement` clock. This value will be the same for each invocation within the same statement. However, a different value may be produced for different statements within the same transaction. @@ -3706,7 +3706,7 @@ localtime.statement([{timezone}]) |=== -| A LocalTime. +| `LOCAL TIME` |=== @@ -3770,7 +3770,7 @@ RETURN localtime.statement('America/Los Angeles') AS nowInLA [[functions-localtime-realtime]] ==== localtime.realtime() -`localtime.realtime()` returns the current _LocalTime_ value using the `realtime` clock. +`localtime.realtime()` returns the current `LOCAL TIME` value using the `realtime` clock. This value will be the live clock of the system. *Syntax:* @@ -3784,7 +3784,7 @@ localtime.realtime([{timezone}]) |=== -| A LocalTime. +| `LOCAL TIME` |=== @@ -3824,9 +3824,9 @@ RETURN localtime.realtime() AS now [discrete] [[functions-localtime-create]] -=== Creating a _LocalTime_ +=== Creating a `LOCAL TIME` -`localtime()` returns a _LocalTime_ value with the specified _hour_, _minute_, _second_, _millisecond_, _microsecond_ and _nanosecond_ component values. +`localtime()` returns a `LOCAL TIME` value with the specified _hour_, _minute_, _second_, _millisecond_, _microsecond_ and _nanosecond_ component values. *Syntax:* @@ -3839,7 +3839,7 @@ localtime({hour [, minute, second, millisecond, microsecond, nanosecond]}) |=== -| A LocalTime. +| `LOCAL TIME` |=== @@ -3917,9 +3917,9 @@ RETURN theTime [discrete] [[functions-localtime-create-string]] -=== Creating a _LocalTime_ from a string +=== Creating a `LOCAL TIME` from a `STRING` -`localtime()` returns the _LocalTime_ value obtained by parsing a string representation of a temporal value. +`localtime()` returns the `LOCAL TIME` value obtained by parsing a `STRING` representation of a temporal value. *Syntax:* @@ -3932,7 +3932,7 @@ localtime(temporalValue) |=== -| A LocalTime. +| `LOCAL TIME` |=== @@ -3991,10 +3991,10 @@ RETURN theTime [discrete] [[functions-localtime-temporal]] -=== Creating a _LocalTime_ using other temporal values as components +=== Creating a `LOCAL TIME` using other temporal values as components -`localtime()` returns the _LocalTime_ value obtained by selecting and composing components from another temporal value. -In essence, this allows a _DateTime_, _LocalDateTime_ or _Time_ value to be converted to a _LocalTime_, and for "missing" components to be provided. +`localtime()` returns the `LOCAL TIME` value obtained by selecting and composing components from another temporal value. +In essence, this allows a `ZONED DATETIME`, `LOCAL DATETIME` or `ZONED TIME` value to be converted to a `LOCAL TIME`, and for "missing" components to be provided. *Syntax:* @@ -4007,7 +4007,7 @@ localtime({time [, hour, ..., nanosecond]}) |=== -| A LocalTime. +| `LOCAL TIME` |=== @@ -4021,7 +4021,7 @@ localtime({time [, hour, ..., nanosecond]}) | | `time` -| A _Time_ value. +| A `ZONED TIME` value. | `hour` | An integer between `0` and `23` that specifies the hour of the day. @@ -4080,10 +4080,10 @@ RETURN [discrete] [[functions-localtime-truncate]] -=== Truncating a _LocalTime_ +=== Truncating a `LOCAL TIME` -`localtime.truncate()` returns the _LocalTime_ value obtained by truncating a specified temporal instant value at the nearest preceding point in time at the specified component boundary (which is denoted by the truncation unit passed as a parameter to the function). -In other words, the _LocalTime_ returned will have all components that are less significant than the specified truncation unit set to their default values. +`localtime.truncate()` returns the `LOCAL TIME` value obtained by truncating a specified temporal instant value at the nearest preceding point in time at the specified component boundary (which is denoted by the truncation unit passed as a parameter to the function). +In other words, the `LOCAL TIME` returned will have all components that are less significant than the specified truncation unit set to their default values. It is possible to supplement the truncated value by providing a map containing components which are less significant than the truncation unit. This will have the effect of _overriding_ the default values which would otherwise have been set for these less significant components. @@ -4100,7 +4100,7 @@ localtime.truncate(unit [, temporalInstantValue [, mapOfComponents ] ]) |=== -| A LocalTime. +| `LOCAL TIME` |=== @@ -4114,7 +4114,7 @@ localtime.truncate(unit [, temporalInstantValue [, mapOfComponents ] ]) | A string expression evaluating to one of the following strings: `'day'`, `'hour'`, `'minute'`, `'second'`, `'millisecond'`, `'microsecond'`. | `temporalInstantValue` -| An expression of one of the following types: _DateTime_, _LocalDateTime_, _Time_, _LocalTime_. +| An expression of one of the following types: `ZONED DATETIME`, `LOCAL DATETIME`, `ZONED TIME`, `LOCAL TIME`. | `mapOfComponents` | An expression evaluating to a map containing components less significant than `unit`. @@ -4170,22 +4170,22 @@ RETURN Details for using the `time()` function. -* xref::functions/temporal/index.adoc#functions-time-current[Getting the current _Time_] +* xref::functions/temporal/index.adoc#functions-time-current[Getting the current `ZONED TIME`] ** xref::functions/temporal/index.adoc#functions-time-transaction[+time.transaction()+] ** xref::functions/temporal/index.adoc#functions-time-statement[+time.statement()+] ** xref::functions/temporal/index.adoc#functions-time-realtime[+time.realtime()+] -* xref::functions/temporal/index.adoc#functions-time-create[Creating a _Time_] -* xref::functions/temporal/index.adoc#functions-time-create-string[Creating a _Time_ from a string] -* xref::functions/temporal/index.adoc#functions-time-temporal[Creating a _Time_ using other temporal values as components] -* xref::functions/temporal/index.adoc#functions-time-truncate[Truncating a _Time_] +* xref::functions/temporal/index.adoc#functions-time-create[Creating a `ZONED TIME`] +* xref::functions/temporal/index.adoc#functions-time-create-string[Creating a `ZONED TIME` from a string] +* xref::functions/temporal/index.adoc#functions-time-temporal[Creating a `ZONED TIME` using other temporal values as components] +* xref::functions/temporal/index.adoc#functions-time-truncate[Truncating a `ZONED TIME`] [discrete] [[functions-time-current]] -=== Getting the current _Time_ +=== Getting the current `ZONED TIME` -`time()` returns the current _Time_ value. +`time()` returns the current `ZONED TIME` value. If no time zone parameter is specified, the local time zone will be used. *Syntax:* @@ -4199,7 +4199,7 @@ time([{timezone}]) |=== -| A Time. +| `ZONED TIME` |=== @@ -4278,7 +4278,7 @@ The current time of day in California is returned. [[functions-time-transaction]] ==== time.transaction() -`time.transaction()` returns the current _Time_ value using the `transaction` clock. +`time.transaction()` returns the current `ZONED TIME` value using the `transaction` clock. This value will be the same for each invocation within the same transaction. However, a different value may be produced for different transactions. @@ -4293,7 +4293,7 @@ time.transaction([{timezone}]) |=== -| A Time. +| `ZONED TIME` |=== @@ -4332,7 +4332,7 @@ RETURN time.transaction() AS currentTime [[functions-time-statement]] ==== time.statement() -`time.statement()` returns the current _Time_ value using the `statement` clock. +`time.statement()` returns the current `ZONED TIME` value using the `statement` clock. This value will be the same for each invocation within the same statement. However, a different value may be produced for different statements within the same transaction. @@ -4347,7 +4347,7 @@ time.statement([{timezone}]) |=== -| A Time. +| `ZONED TIME` |=== @@ -4410,7 +4410,7 @@ RETURN time.statement('America/Los Angeles') AS currentTimeInLA [[functions-time-realtime]] ==== time.realtime() -`time.realtime()` returns the current _Time_ value using the `realtime` clock. +`time.realtime()` returns the current `ZONED TIME` value using the `realtime` clock. This value will be the live clock of the system. *Syntax:* @@ -4424,7 +4424,7 @@ time.realtime([{timezone}]) |=== -| A Time. +| `ZONED TIME` |=== @@ -4464,9 +4464,9 @@ RETURN time.realtime() AS currentTime [discrete] [[functions-time-create]] -=== Creating a _Time_ +=== Creating a `ZONED TIME` -`time()` returns a _Time_ value with the specified _hour_, _minute_, _second_, _millisecond_, _microsecond_, _nanosecond_ and _timezone_ component values. +`time()` returns a `ZONED TIME` value with the specified _hour_, _minute_, _second_, _millisecond_, _microsecond_, _nanosecond_ and _timezone_ component values. *Syntax:* @@ -4479,7 +4479,7 @@ time({hour [, minute, second, millisecond, microsecond, nanosecond, timezone]}) |=== -| A Time. +| `ZONED TIME` |=== @@ -4566,9 +4566,9 @@ RETURN theTime [discrete] [[functions-time-create-string]] -=== Creating a _Time_ from a string +=== Creating a `ZONED TIME` from a `STRING` -`time()` returns the _Time_ value obtained by parsing a string representation of a temporal value. +`time()` returns the `ZONED TIME` value obtained by parsing a `STRING` representation of a temporal value. *Syntax:* @@ -4581,7 +4581,7 @@ time(temporalValue) |=== -| A Time. +| `ZONED TIME` |=== @@ -4649,10 +4649,10 @@ RETURN theTime [discrete] [[functions-time-temporal]] -=== Creating a _Time_ using other temporal values as components +=== Creating a `ZONED TIME` using other temporal values as components -`time()` returns the _Time_ value obtained by selecting and composing components from another temporal value. -In essence, this allows a _DateTime_, _LocalDateTime_ or _LocalTime_ value to be converted to a _Time_, and for "missing" components to be provided. +`time()` returns the `ZONED TIME` value obtained by selecting and composing components from another temporal value. +In essence, this allows a `ZONED DATETIME`, `LOCAL DATETIME` or `LOCAL TIME` value to be converted to a `ZONED TIME`, and for "missing" components to be provided. *Syntax:* @@ -4665,7 +4665,7 @@ time({time [, hour, ..., timezone]}) |=== -| A Time. +| `ZONED TIME` |=== @@ -4679,7 +4679,7 @@ time({time [, hour, ..., timezone]}) | | `time` -| A _Time_ value. +| A `ZONED TIME` value. | `hour` | An integer between `0` and `23` that specifies the hour of the day. @@ -4710,8 +4710,8 @@ time({time [, hour, ..., timezone]}) | If any of the optional parameters are provided, these will override the corresponding components of `time`. | `time(tt)` may be written instead of `+time({time: tt})+`. -| Selecting a _Time_ or _DateTime_ value as the `time` component also selects its time zone. If a _LocalTime_ or _LocalDateTime_ is selected instead, the default time zone is used. In any case, the time zone can be overridden explicitly. -| Selecting a _DateTime_ or _Time_ as the `time` component and overwriting the time zone will adjust the local time to keep the same point in time. +| Selecting a `ZONED TIME` or `ZONED DATETIME` value as the `time` component also selects its time zone. If a `LOCAL TIME` or `LOCAL DATETIME` is selected instead, the default time zone is used. In any case, the time zone can be overridden explicitly. +| Selecting a `ZONED DATETIME` or `ZONED TIME` as the `time` component and overwriting the time zone will adjust the local time to keep the same point in time. |=== @@ -4745,10 +4745,10 @@ RETURN [discrete] [[functions-time-truncate]] -=== Truncating a _Time_ +=== Truncating a `ZONED TIME` -`time.truncate()` returns the _Time_ value obtained by truncating a specified temporal instant value at the nearest preceding point in time at the specified component boundary (which is denoted by the truncation unit passed as a parameter to the function). -In other words, the _Time_ returned will have all components that are less significant than the specified truncation unit set to their default values. +`time.truncate()` returns the `ZONED TIME` value obtained by truncating a specified temporal instant value at the nearest preceding point in time at the specified component boundary (which is denoted by the truncation unit passed as a parameter to the function). +In other words, the `ZONED TIME` returned will have all components that are less significant than the specified truncation unit set to their default values. It is possible to supplement the truncated value by providing a map containing components which are less significant than the truncation unit. This will have the effect of _overriding_ the default values which would otherwise have been set for these less significant components. @@ -4765,7 +4765,7 @@ time.truncate(unit [, temporalInstantValue [, mapOfComponents ] ]) |=== -| A Time. +| `ZONED TIME` |=== @@ -4779,7 +4779,7 @@ time.truncate(unit [, temporalInstantValue [, mapOfComponents ] ]) | A string expression evaluating to one of the following strings: `'day'`, `'hour'`, `'minute'`, `'second'`, `'millisecond'`, `'microsecond'`. | `temporalInstantValue` -| An expression of one of the following types: _DateTime_, _LocalDateTime_, _Time_, _LocalTime_. +| An expression of one of the following types: `ZONED DATETIME`, `LOCAL DATETIME`, `ZONED TIME`, `LOCAL TIME`. | `mapOfComponents` a| @@ -4794,8 +4794,8 @@ During truncation, a time zone can be attached or overridden using the key `time | Truncating time to day -- i.e. `unit` is `'day'` -- is supported, and yields midnight at the start of the day (`00:00`), regardless of the value of `temporalInstantValue`. However, the time zone of `temporalInstantValue` is retained. | The time zone of `temporalInstantValue` may be overridden; for example, `+time.truncate('minute', input, {timezone: '+0200'})+`. -| If `temporalInstantValue` is one of _Time_, _DateTime_ -- a value with a time zone -- and the time zone is overridden, no time conversion occurs. -| If `temporalInstantValue` is one of _LocalTime_, _LocalDateTime_, _Date_ -- a value without a time zone -- and the time zone is not overridden, the configured default time zone will be used. +| If `temporalInstantValue` is one of `ZONED TIME`, `ZONED DATETIME` -- a value with a time zone -- and the time zone is overridden, no time conversion occurs. +| If `temporalInstantValue` is one of `LOCAL TIME`, `LOCAL DATETIME`, `DATE` -- a value without a time zone -- and the time zone is not overridden, the configured default time zone will be used. | Any component that is provided in `mapOfComponents` must be less significant than `unit`; i.e. if `unit` is `'second'`, `mapOfComponents` cannot contain information pertaining to a _minute_. | Any component that is not contained in `mapOfComponents` and which is less significant than `unit` will be set to its xref::values-and-types/temporal.adoc#cypher-temporal-accessing-components-temporal-instants[minimal value]. | If `mapOfComponents` is not provided, all components of the returned value which are less significant than `unit` will be set to their default values. diff --git a/modules/ROOT/pages/indexes-for-search-performance.adoc b/modules/ROOT/pages/indexes-for-search-performance.adoc index 2734ed7fa..2b793e6ba 100644 --- a/modules/ROOT/pages/indexes-for-search-performance.adoc +++ b/modules/ROOT/pages/indexes-for-search-performance.adoc @@ -649,11 +649,11 @@ This command will produce a table with the following columns: | `labelsOrTypes` | The labels or relationship types of this index. label:default-output[] -| `LIST OF STRING` +| `LIST` | `properties` | The properties of this index. label:default-output[] -| `LIST OF STRING` +| `LIST` | `indexProvider` | The index provider for this index. label:default-output[] diff --git a/modules/ROOT/pages/introduction/cypher_tutorial.adoc b/modules/ROOT/pages/introduction/cypher_tutorial.adoc index 399776c81..b2ae94890 100644 --- a/modules/ROOT/pages/introduction/cypher_tutorial.adoc +++ b/modules/ROOT/pages/introduction/cypher_tutorial.adoc @@ -16,13 +16,13 @@ image::introduction_schema.svg[width="800",role="middle"] It includes two types of node labels: -* `Person` nodes, which have the following properties: `name` (string) and `born` (integer). -* `Movie` nodes, which have the following properties: `title` (string), `released` (integer), and `tagline` (string). +* `Person` nodes, which have the following properties: `name` (`STRING`) and `born` (`INTEGER`). +* `Movie` nodes, which have the following properties: `title` (`STRING`), `released` (`INTEGER`), and `tagline` (`STRING`). The data model also contains five different relationship types between the `Person` and `Movie` nodes: `ACTED_IN`, `DIRECTED`, `PRODUCED`, `WROTE`, and `REVIEWED`. Two of the relationship types have properties: -* The `ACTED_IN` relationship type, which has the `roles` property (string). -* The `REVIEWED` relationship type, which has a `summary` property (string) and a `rating` property (float). +* The `ACTED_IN` relationship type, which has the `roles` property (`STRING`). +* The `REVIEWED` relationship type, which has a `summary` property (`STRING`) and a `rating` property (`FLOAT`). _To learn more about data modelling for graph databases, enroll in the free https://graphacademy.neo4j.com/courses/modeling-fundamentals/[Graph Data Modelling Fundamentals] course offered by GraphAcademy._ diff --git a/modules/ROOT/pages/keyword-glossary.adoc b/modules/ROOT/pages/keyword-glossary.adoc index e38cf5f0f..b726cfbcd 100644 --- a/modules/ROOT/pages/keyword-glossary.adoc +++ b/modules/ROOT/pages/keyword-glossary.adoc @@ -443,27 +443,27 @@ Duplicates are retained. | xref::functions/mathematical-numeric.adoc#functions-abs[abs()] | Numeric -| Returns the absolute value of a number. +| Returns the absolute value of a `FLOAT`. | xref::functions/mathematical-trigonometric.adoc#functions-acos[acos()] | Trigonometric -| Returns the arccosine of a number in radians. +| Returns the arccosine of a `FLOAT` in radians. | xref::functions/predicate.adoc#functions-all[all()] | Predicate -| Tests whether the predicate holds for all elements in a list. +| Returns true if the predicate holds for all elements in the given `LIST`. | xref::functions/predicate.adoc#functions-any[any()] | Predicate -| Tests whether the predicate holds for at least one element in a list. +| Returns true if the predicate holds for at least one element in the given `LIST`. | xref::functions/mathematical-trigonometric.adoc#functions-asin[asin()] | Trigonometric -| Returns the arcsine of a number in radians. +| Returns the arcsine of a `FLOAT` in radians. | xref::functions/mathematical-trigonometric.adoc#functions-atan[atan()] | Trigonometric -| Returns the arctangent of a number in radians. +| Returns the arctangent of a `FLOAT` in radians. | xref::functions/mathematical-trigonometric.adoc#functions-atan2[atan2()] | Trigonometric @@ -475,7 +475,7 @@ Duplicates are retained. | xref::functions/mathematical-numeric.adoc#functions-ceil[ceil()] | Numeric -| Returns the smallest floating point number that is greater than or equal to a number and equal to a mathematical integer. +| Returns the smallest `FLOAT` that is greater than or equal to a number and equal to an `INTEGER`. | xref::functions/scalar.adoc#functions-coalesce[coalesce()] | Scalar @@ -487,11 +487,11 @@ Duplicates are retained. | xref::functions/mathematical-trigonometric.adoc#functions-cos[cos()] | Trigonometric -| Returns the cosine of a number. +| Returns the cosine of a `FLOAT`. | xref::functions/mathematical-trigonometric.adoc#functions-cot[cot()] | Trigonometric -| Returns the cotangent of a number. +| Returns the cotangent of a `FLOAT`. | xref::functions/aggregating.adoc#functions-count[count()] | Aggregating @@ -499,96 +499,96 @@ Duplicates are retained. | xref::functions/temporal/index.adoc#functions-date-current[date()] | Temporal -| Returns the current _Date_. +| Returns the current `DATE`. | xref::functions/temporal/index.adoc#functions-date-calendar[date({year [, month, day\]})] | Temporal -| Returns a calendar (Year-Month-Day) _Date_. +| Returns a calendar (Year-Month-Day) `DATE`. | xref::functions/temporal/index.adoc#functions-date-week[date({year [, week, dayOfWeek\]})] | Temporal -| Returns a week (Year-Week-Day) _Date_. +| Returns a week (Year-Week-Day) `DATE`. | xref::functions/temporal/index.adoc#functions-date-quarter[date({year [, quarter, dayOfQuarter\]})] | Temporal -| Returns a quarter (Year-Quarter-Day) _Date_. +| Returns a quarter (Year-Quarter-Day) `DATE`. | xref::functions/temporal/index.adoc#functions-date-ordinal[date({year [, ordinalDay\]})] | Temporal -| Returns an ordinal (Year-Day) _Date_. +| Returns an ordinal (Year-Day) `DATE`. | xref::functions/temporal/index.adoc#functions-date-create-string[date(string)] | Temporal -| Returns a _Date_ by parsing a string. +| Returns a `DATE` by parsing a `STRING`. | xref::functions/temporal/index.adoc#functions-date-temporal[+date({map})+] | Temporal -| Returns a _Date_ from a map of another temporal value's components. +| Returns a `DATE` from a map of another temporal value's components. | xref::functions/temporal/index.adoc#functions-date-realtime[date.realtime()] | Temporal -| Returns the current _Date_ using the `realtime` clock. +| Returns the current `DATE` using the `realtime` clock. | xref::functions/temporal/index.adoc#functions-date-statement[date.statement()] | Temporal -| Returns the current _Date_ using the `statement` clock. +| Returns the current `DATE` using the `statement` clock. | xref::functions/temporal/index.adoc#functions-date-transaction[date.transaction()] | Temporal -| Returns the current _Date_ using the `transaction` clock. +| Returns the current `DATE` using the `transaction` clock. | xref::functions/temporal/index.adoc#functions-date-truncate[date.truncate()] | Temporal -| Returns a _Date_ obtained by truncating a value at a specific component boundary. xref::functions/temporal/index.adoc#functions-temporal-truncate-overview[Truncation summary]. +| Returns a `DATE` obtained by truncating a value at a specific component boundary. xref::functions/temporal/index.adoc#functions-temporal-truncate-overview[Truncation summary]. | xref::functions/temporal/index.adoc#functions-datetime-current[datetime()] | Temporal -| Returns the current _DateTime_. +| Returns the current `ZONED DATETIME`. | xref::functions/temporal/index.adoc#functions-datetime-calendar[datetime({year [, month, day, ...\]})] | Temporal -| Returns a calendar (Year-Month-Day) _DateTime_. +| Returns a calendar (Year-Month-Day) `ZONED DATETIME`. | xref::functions/temporal/index.adoc#functions-datetime-week[datetime({year [, week, dayOfWeek, ...\]})] | Temporal -| Returns a week (Year-Week-Day) _DateTime_. +| Returns a week (Year-Week-Day) `ZONED DATETIME`. | xref::functions/temporal/index.adoc#functions-datetime-quarter[datetime({year [, quarter, dayOfQuarter, ...\]})] | Temporal -| Returns a quarter (Year-Quarter-Day) _DateTime_. +| Returns a quarter (Year-Quarter-Day) `ZONED DATETIME`. | xref::functions/temporal/index.adoc#functions-datetime-ordinal[datetime({year [, ordinalDay, ...\]})] | Temporal -| Returns an ordinal (Year-Day) _DateTime_. +| Returns an ordinal (Year-Day) `ZONED DATETIME`. | xref::functions/temporal/index.adoc#functions-datetime-create-string[datetime(string)] | Temporal -| Returns a _DateTime_ by parsing a string. +| Returns a `ZONED DATETIME` by parsing a `STRING`. | xref::functions/temporal/index.adoc#functions-datetime-temporal[+datetime({map})+] | Temporal -| Returns a _DateTime_ from a map of another temporal value's components. +| Returns a `ZONED DATETIME` from a map of another temporal value's components. | xref::functions/temporal/index.adoc#functions-datetime-timestamp[+datetime({epochSeconds})+] | Temporal -| Returns a _DateTime_ from a timestamp. +| Returns a `ZONED DATETIME` from a timestamp. | xref::functions/temporal/index.adoc#functions-datetime-realtime[datetime.realtime()] | Temporal -| Returns the current _DateTime_ using the `realtime` clock. +| Returns the current `ZONED DATETIME` using the `realtime` clock. | xref::functions/temporal/index.adoc#functions-datetime-statement[datetime.statement()] | Temporal -| Returns the current _DateTime_ using the `statement` clock. +| Returns the current `ZONED DATETIME` using the `statement` clock. | xref::functions/temporal/index.adoc#functions-datetime-transaction[datetime.transaction()] | Temporal -| Returns the current _DateTime_ using the `transaction` clock. +| Returns the current `ZONED DATETIME` using the `transaction` clock. | xref::functions/temporal/index.adoc#functions-datetime-truncate[datetime.truncate()] | Temporal | -Returns a _DateTime_ obtained by truncating a value at a specific component boundary. +Returns a `ZONED DATETIME` obtained by truncating a value at a specific component boundary. xref::functions/temporal/index.adoc#functions-temporal-truncate-overview[Truncation summary]. | xref::functions/mathematical-trigonometric.adoc#functions-degrees[degrees()] @@ -597,27 +597,27 @@ xref::functions/temporal/index.adoc#functions-temporal-truncate-overview[Truncat | xref::functions/temporal/duration.adoc#functions-duration[+duration({map})+] | Temporal -| Returns a _Duration_ from a map of its components. +| Returns a `DURATION` from a map of its components. | xref::functions/temporal/duration.adoc#functions-duration-create-string[duration(string)] | Temporal -| Returns a _Duration_ by parsing a string. +| Returns a `DURATION` by parsing a `STRING`. | xref::functions/temporal/duration.adoc#functions-duration-between[duration.between()] | Temporal -| Returns a _Duration_ equal to the difference between two given instants. +| Returns a `DURATION` equal to the difference between two given instants. | xref::functions/temporal/duration.adoc#functions-duration-indays[duration.inDays()] | Temporal -| Returns a _Duration_ equal to the difference in whole days or weeks between two given instants. +| Returns a `DURATION` equal to the difference in whole days or weeks between two given instants. | xref::functions/temporal/duration.adoc#functions-duration-inmonths[duration.inMonths()] | Temporal -| Returns a _Duration_ equal to the difference in whole months, quarters or years between two given instants. +| Returns a `DURATION` equal to the difference in whole months, quarters or years between two given instants. | xref::functions/temporal/duration.adoc#functions-duration-inseconds[duration.inSeconds()] | Temporal -| Returns a _Duration_ equal to the difference in seconds and fractions of seconds, or minutes or hours, between two given instants. +| Returns a `DURATION` equal to the difference in seconds and fractions of seconds, or minutes or hours, between two given instants. | xref::functions/mathematical-logarithmic.adoc#functions-e[e()] | Logarithmic @@ -625,7 +625,7 @@ xref::functions/temporal/index.adoc#functions-temporal-truncate-overview[Truncat | xref::functions/scalar.adoc#functions-endnode[endNode()] | Scalar -| Returns the end node of a relationship. +| Returns the end `NODE` of a `RELATIONSHIP`. | xref::functions/predicate.adoc#functions-exists[exists()] | Predicate @@ -637,7 +637,7 @@ xref::functions/temporal/index.adoc#functions-temporal-truncate-overview[Truncat | xref::functions/mathematical-numeric.adoc#functions-floor[floor()] | Numeric -| Returns the largest floating point number that is less than or equal to a number and equal to a mathematical integer. +| Returns the largest `FLOAT` that is less than or equal to a number and equal to an `INTEGER`. | xref::functions/mathematical-trigonometric.adoc#functions-haversin[haversin()] | Trigonometric @@ -645,15 +645,15 @@ xref::functions/temporal/index.adoc#functions-temporal-truncate-overview[Truncat | xref::functions/scalar.adoc#functions-head[head()] | Scalar -| Returns the first element in a list. +| Returns the first element in a `LIST`. | xref::functions/scalar.adoc#functions-id[id()] | Scalar -| Returns the id of a relationship or node. +| Returns the id of a `RELATIONSHIP` or `NODE`. | xref::functions/predicate.adoc#functions-isempty[isEmpty()] | Predicate -| Returns true if the given list or map contains no elements or if the given string contains no characters. +| Returns true if the given `LIST` or `MAP` contains no elements or if the given `STRING` contains no characters. | xref::functions/mathematical-numeric.adoc#functions-isnan[isNaN()] | Numeric @@ -661,115 +661,115 @@ xref::functions/temporal/index.adoc#functions-temporal-truncate-overview[Truncat | xref::functions/list.adoc#functions-keys[keys()] | List -| Returns a list containing the string representations for all the property names of a node, relationship, or map. +| Returns a `LIST` containing the `STRING` representations for all the property names of a `NODE`, `RELATIONSHIP`, or `MAP`. | xref::functions/list.adoc#functions-labels[labels()] | List -| Returns a list containing the string representations for all the labels of a node. +| Returns a `LIST` containing the `STRING` representations for all the labels of a `NODE`. | xref::functions/scalar.adoc#functions-last[last()] | Scalar -| Returns the last element in a list. +| Returns the last element in a `LIST`. | xref::functions/string.adoc#functions-left[left()] | String -| Returns a string containing the specified number of leftmost characters of the original string. +| Returns a `STRING` containing the specified number (`INTEGER`) of leftmost characters in the given `STRING`. | xref::functions/scalar.adoc#functions-length[length()] | Scalar -| Returns the length of a path. +| Returns the length of a `PATH`. | xref::functions/temporal/index.adoc#functions-localdatetime-current[localdatetime()] | Temporal -| Returns the current _LocalDateTime_. +| Returns the current `LOCAL DATETIME`. | xref::functions/temporal/index.adoc#functions-localdatetime-calendar[localdatetime({year [, month, day, ...\]})] | Temporal -| Returns a calendar (Year-Month-Day) _LocalDateTime_. +| Returns a calendar (Year-Month-Day) `LOCAL DATETIME`. | xref::functions/temporal/index.adoc#functions-localdatetime-week[localdatetime({year [, week, dayOfWeek, ...\]})] | Temporal -| Returns a week (Year-Week-Day) _LocalDateTime_. +| Returns a week (Year-Week-Day) `LOCAL DATETIME`. | xref::functions/temporal/index.adoc#functions-localdatetime-quarter[localdatetime({year [, quarter, dayOfQuarter, ...\]})] | Temporal -| Returns a quarter (Year-Quarter-Day) _DateTime_. +| Returns a quarter (Year-Quarter-Day) `ZONED DATETIME`. | xref::functions/temporal/index.adoc#functions-localdatetime-ordinal[localdatetime({year [, ordinalDay, ...\]})] | Temporal -| Returns an ordinal (Year-Day) _LocalDateTime_. +| Returns an ordinal (Year-Day) `LOCAL DATETIME`. | xref::functions/temporal/index.adoc#functions-localdatetime-create-string[localdatetime(string)] | Temporal -| Returns a _LocalDateTime_ by parsing a string. +| Returns a `LOCAL DATETIME` by parsing a `STRING`. | xref::functions/temporal/index.adoc#functions-localdatetime-temporal[localdatetime(+{map}+)] | Temporal -| Returns a _LocalDateTime_ from a map of another temporal value's components. +| Returns a `LOCAL DATETIME` from a map of another temporal value's components. | xref::functions/temporal/index.adoc#functions-localdatetime-realtime[localdatetime.realtime()] | Temporal -| Returns the current _LocalDateTime_ using the `realtime` clock. +| Returns the current `LOCAL DATETIME` using the `realtime` clock. | xref::functions/temporal/index.adoc#functions-localdatetime-statement[localdatetime.statement()] | Temporal -| Returns the current _LocalDateTime_ using the `statement` clock. +| Returns the current `LOCAL DATETIME` using the `statement` clock. | xref::functions/temporal/index.adoc#functions-localdatetime-transaction[localdatetime.transaction()] | Temporal -| Returns the current _LocalDateTime_ using the `transaction` clock. +| Returns the current `LOCAL DATETIME` using the `transaction` clock. | xref::functions/temporal/index.adoc#functions-localdatetime-truncate[localdatetime.truncate()] | Temporal | -Returns a _LocalDateTime_ obtained by truncating a value at a specific component boundary. +Returns a `LOCAL DATETIME` obtained by truncating a value at a specific component boundary. xref::functions/temporal/index.adoc#functions-temporal-truncate-overview[Truncation summary]. | xref::functions/temporal/index.adoc#functions-localtime-current[localtime()] | Temporal -| Returns the current _LocalTime_. +| Returns the current `LOCAL TIME`. | xref::functions/temporal/index.adoc#functions-localtime-create[localtime({hour [, minute, second, ...\]})] | Temporal -| Returns a _LocalTime_ with the specified component values. +| Returns a `LOCAL TIME` with the specified component values. | xref::functions/temporal/index.adoc#functions-localtime-create-string[localtime(string)] | Temporal -| Returns a _LocalTime_ by parsing a string. +| Returns a `LOCAL TIME` by parsing a `STRING`. | xref::functions/temporal/index.adoc#functions-localtime-temporal[localtime({time [, hour, ...\]})] | Temporal -| Returns a _LocalTime_ from a map of another temporal value's components. +| Returns a `LOCAL TIME` from a map of another temporal value's components. | xref::functions/temporal/index.adoc#functions-localtime-realtime[localtime.realtime()] | Temporal -| Returns the current _LocalTime_ using the `realtime` clock. +| Returns the current `LOCAL TIME` using the `realtime` clock. | xref::functions/temporal/index.adoc#functions-localtime-statement[localtime.statement()] | Temporal -| Returns the current _LocalTime_ using the `statement` clock. +| Returns the current `LOCAL TIME` using the `statement` clock. | xref::functions/temporal/index.adoc#functions-localtime-transaction[localtime.transaction()] | Temporal -| Returns the current _LocalTime_ using the `transaction` clock. +| Returns the current `LOCAL TIME` using the `transaction` clock. | xref::functions/temporal/index.adoc#functions-localtime-truncate[localtime.truncate()] | Temporal | -Returns a _LocalTime_ obtained by truncating a value at a specific component boundary. +Returns a `LOCAL TIME` obtained by truncating a value at a specific component boundary. xref::functions/temporal/index.adoc#functions-temporal-truncate-overview[Truncation summary]. | xref::functions/mathematical-logarithmic.adoc#functions-log[log()] | Logarithmic -| Returns the natural logarithm of a number. +| Returns the natural logarithm of a `FLOAT`. | xref::functions/mathematical-logarithmic.adoc#functions-log10[log10()] | Logarithmic -| Returns the common logarithm (base 10) of a number. +| Returns the common logarithm (base 10) of a `FLOAT`. | xref::functions/string.adoc#functions-ltrim[lTrim()] | String -| Returns the original string with leading whitespace removed. +| Returns the given `STRING` with leading whitespace removed. | xref::functions/aggregating.adoc#functions-max[max()] | Aggregating @@ -781,11 +781,11 @@ xref::functions/temporal/index.adoc#functions-temporal-truncate-overview[Truncat | xref::functions/list.adoc#functions-nodes[nodes()] | List -| Returns a list containing all the nodes in a path. +| Returns a `LIST` containing all the `NODE` values in a `PATH`. | xref::functions/predicate.adoc#functions-none[none()] | Predicate -| Returns true if the predicate holds for no element in a list. +| Returns true if the predicate holds for no element in the given `LIST`. | xref::functions/aggregating.adoc#functions-percentilecont[percentileCont()] | Aggregating @@ -801,31 +801,31 @@ xref::functions/temporal/index.adoc#functions-temporal-truncate-overview[Truncat | xref::functions/spatial.adoc#functions-point-cartesian-2d[point() - Cartesian 2D] | Spatial -| Returns a 2D point object, given two coordinate values in the Cartesian coordinate system. +| Returns a 2D `POINT` object, given two coordinate values in the Cartesian coordinate system. | xref::functions/spatial.adoc#functions-point-cartesian-3d[point() - Cartesian 3D] | Spatial -| Returns a 3D point object, given three coordinate values in the Cartesian coordinate system. +| Returns a 3D `POINT` object, given three coordinate values in the Cartesian coordinate system. | xref::functions/spatial.adoc#functions-point-wgs84-2d[point() - WGS 84 2D] | Spatial -| Returns a 2D point object, given two coordinate values in the WGS 84 coordinate system. +| Returns a 2D `POINT` object, given two coordinate values in the WGS 84 coordinate system. | xref::functions/spatial.adoc#functions-point-wgs84-3d[point() - WGS 84 3D] | Spatial -| Returns a 3D point object, given three coordinate values in the WGS 84 coordinate system. +| Returns a 3D `POINT` object, given three coordinate values in the WGS 84 coordinate system. | xref::functions/spatial.adoc#functions-distance[point.distance()] | Spatial -| Returns true if the provided point is within the bounding box defined by the two provided points. +| Returns true if the provided `POINT` is within the bounding box defined by the two provided points. | xref::functions/spatial.adoc#functions-distance[point.withinBBox()] | Spatial -| Returns a floating point number representing the geodesic distance between any two points in the same CRS. +| Returns a `FLOAT` representing the geodesic distance between any two points in the same CRS. | xref::functions/scalar.adoc#functions-properties[properties()] | Scalar -| Returns a map containing all the properties of a node or relationship. +| Returns a `MAP` containing all the properties of a `NODE` or `RELATIONSHIP`. | xref::functions/mathematical-trigonometric.adoc#functions-radians[radians()] | Trigonometric @@ -833,55 +833,55 @@ xref::functions/temporal/index.adoc#functions-temporal-truncate-overview[Truncat | xref::functions/mathematical-numeric.adoc#functions-rand[rand()] | Numeric -| Returns a random floating point number in the range from 0 (inclusive) to 1 (exclusive); i.e. `[0, 1)`. +| Returns a random `FLOAT` in the range from 0 (inclusive) to 1 (exclusive); i.e. `[0, 1)`. | xref::functions/scalar.adoc#functions-randomuuid[randomUUID()] | Scalar -| Returns a string value corresponding to a randomly-generated UUID. +| Returns a `STRING` value corresponding to a randomly-generated UUID. | xref::functions/list.adoc#functions-range[range()] | List -| Returns a list comprising all integer values within a specified range. +| Returns a `LIST` comprising all `INTEGER` values within a specified range. | xref::functions/list.adoc#functions-reduce[reduce()] | List -| Runs an expression against individual elements of a list, storing the result of the expression in an accumulator. +| Runs an expression against individual elements of a `LIST`, storing the result of the expression in an accumulator. | xref::functions/list.adoc#functions-relationships[relationships()] | List -| Returns a list containing all the relationships in a path. +| Returns a `LIST` containing all the `RELATIONSHIP` values in a `PATH`. | xref::functions/string.adoc#functions-replace[replace()] | String -| Returns a string in which all occurrences of a specified string in the original string have been replaced by another (specified) string. +| Returns a `STRING` in which all occurrences of a specified string in the given `STRING` have been replaced by another (specified) `STRING`. | xref::functions/list.adoc#functions-reverse-list[reverse()] | List -| Returns a list in which the order of all elements in the original list have been reversed. +| Returns a `LIST` in which the order of all elements in the given `LIST` have been reversed. | xref::functions/string.adoc#functions-reverse[reverse()] | String -| Returns a string in which the order of all characters in the original string have been reversed. +| Returns a `STRING` in which the order of all characters in the given `STRING` have been reversed. | xref::functions/string.adoc#functions-right[right()] | String -| Returns a string containing the specified number of rightmost characters of the original string. +| Returns a `STRING` containing the specified number of rightmost characters in the given `STRING`. | xref::functions/mathematical-numeric.adoc#functions-round[round()] | Numeric -| Returns the floating point value of the given number rounded to the nearest mathematical integer, with half-way values always rounded up. +| Returns the `FLOAT` of the given number rounded to the nearest mathematical `INTEGER`, with half-way values always rounded up. | xref::functions/mathematical-numeric.adoc#functions-round2[round(), with precision] | Numeric -| Returns the floating point value of the given number rounded with the specified precision, with half-values always being rounded up. +| Returns the `FLOAT` of the given number rounded with the specified precision, with half-values always being rounded up. | xref::functions/mathematical-numeric.adoc#functions-round3[round(), with precision and rounding mode] | Numeric -| Returns the floating point value of the given number rounded with the specified precision and the specified rounding mode. +| Returns the `FLOAT` of the given number rounded with the specified precision and the specified rounding mode. | xref::functions/string.adoc#functions-rtrim[rTrim()] | String -| Returns the original string with trailing whitespace removed. +| Returns the given `STRING` with trailing whitespace removed. | xref::functions/mathematical-numeric.adoc#functions-sign[sign()] | Numeric @@ -889,15 +889,15 @@ xref::functions/temporal/index.adoc#functions-temporal-truncate-overview[Truncat | xref::functions/mathematical-trigonometric.adoc#functions-sin[sin()] | Trigonometric -| Returns the sine of a number. +| Returns the sine of a `FLOAT`. | xref::functions/predicate.adoc#functions-single[single()] | Predicate -| Returns true if the predicate holds for exactly one of the elements in a list. +| Returns true if the predicate holds for exactly one of the elements in the given `LIST`. | xref::functions/scalar.adoc#functions-size[size()] | Scalar -| Returns the number of items in a list. +| Returns the number of items in a `LIST`. | xref::functions/scalar.adoc#functions-size-of-pattern-comprehension[size() applied to pattern comprehension] | Scalar @@ -905,19 +905,19 @@ xref::functions/temporal/index.adoc#functions-temporal-truncate-overview[Truncat | xref::functions/scalar.adoc#functions-size-of-string[size() applied to string] | Scalar -| Returns the number of Unicode characters in a string. +| Returns the number of Unicode characters in a `STRING`. | xref::functions/string.adoc#functions-split[split()] | String -| Returns a list of strings resulting from the splitting of the original string around matches of the given delimiter. +| Returns a `LIST` resulting from the splitting of the given `STRING` around matches of the given delimiter. | xref::functions/mathematical-logarithmic.adoc#functions-sqrt[sqrt()] | Logarithmic -| Returns the square root of a number. +| Returns the square root of a `FLOAT`. | xref::functions/scalar.adoc#functions-startnode[startNode()] | Scalar -| Returns the start node of a relationship. +| Returns the start `NODE` of a `RELATIONSHIP`. | xref::functions/aggregating.adoc#functions-stdev[stDev()] | Aggregating @@ -929,7 +929,7 @@ xref::functions/temporal/index.adoc#functions-temporal-truncate-overview[Truncat | xref::functions/string.adoc#functions-substring[substring()] | String -| Returns a substring of the original string, beginning with a 0-based index start and length. +| Returns a substring of the given `STRING`, beginning with a 0-based index start and length. | xref::functions/aggregating.adoc#functions-sum[sum()] | Aggregating @@ -937,44 +937,44 @@ xref::functions/temporal/index.adoc#functions-temporal-truncate-overview[Truncat | xref::functions/list.adoc#functions-tail[tail()] | List -| Returns all but the first element in a list. +| Returns all but the first element in a `LIST`. | xref::functions/mathematical-trigonometric.adoc#functions-tan[tan()] | Trigonometric -| Returns the tangent of a number. +| Returns the tangent of a `FLOAT`. | xref::functions/temporal/index.adoc#functions-time-current[time()] | Temporal -| Returns the current _Time_. +| Returns the current `ZONED TIME`. | xref::functions/temporal/index.adoc#functions-time-create[time({hour [, minute, ...\]})] | Temporal -| Returns a _Time_ with the specified component values. +| Returns a `ZONED TIME` with the specified component values. | xref::functions/temporal/index.adoc#functions-time-create-string[time(string)] | Temporal -| Returns a _Time_ by parsing a string. +| Returns a `ZONED TIME` by parsing a `STRING`. | xref::functions/temporal/index.adoc#functions-time-temporal[time({time [, hour, ..., timezone\]})] | Temporal -| Returns a _Time_ from a map of another temporal value's components. +| Returns a `ZONED TIME` from a map of another temporal value's components. | xref::functions/temporal/index.adoc#functions-time-realtime[time.realtime()] | Temporal -| Returns the current _Time_ using the `realtime` clock. +| Returns the current `ZONED TIME` using the `realtime` clock. | xref::functions/temporal/index.adoc#functions-time-statement[time.statement()] | Temporal -| Returns the current _Time_ using the `statement` clock. +| Returns the current `ZONED TIME` using the `statement` clock. | xref::functions/temporal/index.adoc#functions-time-transaction[time.transaction()] | Temporal -| Returns the current _Time_ using the `transaction` clock. +| Returns the current `ZONED TIME` using the `transaction` clock. | xref::functions/temporal/index.adoc#functions-time-truncate[time.truncate()] | Temporal | -Returns a _Time_ obtained by truncating a value at a specific component boundary. +Returns a `ZONED TIME` obtained by truncating a value at a specific component boundary. xref::functions/temporal/index.adoc#functions-temporal-truncate-overview[Truncation summary]. | xref::functions/scalar.adoc#functions-timestamp[timestamp()] @@ -983,35 +983,35 @@ xref::functions/temporal/index.adoc#functions-temporal-truncate-overview[Truncat | xref::functions/scalar.adoc#functions-toboolean[toBoolean()] | Scalar -| Converts a string value to a boolean value. +| Converts a `STRING` value to a `BOOLEAN` value. | xref::functions/scalar.adoc#functions-tofloat[toFloat()] | Scalar -| Converts an integer or string value to a floating point number. +| Converts an `INTEGER` or `STRING` value to a `FLOAT`. | xref::functions/scalar.adoc#functions-tointeger[toInteger()] | Scalar -| Converts a floating point or string value to an integer value. +| Converts a `FLOAT` or `STRING` value to an `INTEGER` value. | xref::functions/string.adoc#functions-tolower[toLower()] | String -| Returns the original string in lowercase. +| Returns the given `STRING` in lowercase. | xref::functions/string.adoc#functions-tostring[toString()] | String -| Converts an integer, float, boolean or temporal (i.e. Date, Time, LocalTime, DateTime, LocalDateTime or Duration) value to a string. +| Converts an `INTEGER`, `FLOAT`, `BOOLEAN` or temporal (i.e. `DATE`, `ZONED TIME`, `LOCAL TIME`, `ZONED DATETIME`, `LOCAL DATETIME` or `DURATION`) value to a `STRING`. | xref::functions/string.adoc#functions-toupper[toUpper()] | String -| Returns the original string in uppercase. +| Returns the given `STRING` in uppercase. | xref::functions/string.adoc#functions-trim[trim()] | String -| Returns the original string with leading and trailing whitespace removed. +| Returns the given `STRING` with leading and trailing whitespace removed. | xref::functions/scalar.adoc#functions-type[type()] | Scalar -| Returns the string representation of the relationship type. +| Returns a `STRING` representation of the `RELATIONSHIP` type. |=== diff --git a/modules/ROOT/pages/syntax/operators.adoc b/modules/ROOT/pages/syntax/operators.adoc index 4a938aed9..5dc9b28c9 100644 --- a/modules/ROOT/pages/syntax/operators.adoc +++ b/modules/ROOT/pages/syntax/operators.adoc @@ -571,10 +571,10 @@ RETURN 'neo' + '4j' AS result Temporal operators comprise: -* adding a xref::values-and-types/temporal.adoc#cypher-temporal-durations[_Duration_] to either a xref::values-and-types/temporal.adoc#cypher-temporal-instants[temporal instant] or another _Duration_: `+` -* subtracting a _Duration_ from either a temporal instant or another _Duration_: `-` -* multiplying a _Duration_ with a number: `*` -* dividing a _Duration_ by a number: `/` +* adding a xref::values-and-types/temporal.adoc#cypher-temporal-durations[`DURATION`] to either a xref::values-and-types/temporal.adoc#cypher-temporal-instants[temporal instant] or another `DURATION`: `+` +* subtracting a `DURATION` from either a temporal instant or another `DURATION`: `-` +* multiplying a `DURATION` with a number: `*` +* dividing a `DURATION` by a number: `/` The following table shows -- for each combination of operation and operand type -- the type of the value returned from the application of each temporal operator: @@ -584,49 +584,49 @@ The following table shows -- for each combination of operation and operand type | xref::syntax/operators.adoc#syntax-add-subtract-duration-to-temporal-instant[`+`] | Temporal instant -| _Duration_ +| `DURATION` | The type of the temporal instant | xref::syntax/operators.adoc#syntax-add-subtract-duration-to-temporal-instant[`+`] -| _Duration_ +| `DURATION` | Temporal instant | The type of the temporal instant | xref::syntax/operators.adoc#syntax-add-subtract-duration-to-temporal-instant[`-`] | Temporal instant -| _Duration_ +| `DURATION` | The type of the temporal instant | xref::syntax/operators.adoc#syntax-add-subtract-duration-to-duration[`+`] -| _Duration_ -| _Duration_ -| _Duration_ +| `DURATION` +| `DURATION` +| `DURATION` | xref::syntax/operators.adoc#syntax-add-subtract-duration-to-duration[`-`] -| _Duration_ -| _Duration_ -| _Duration_ +| `DURATION` +| `DURATION` +| `DURATION` | xref::syntax/operators.adoc#syntax-multiply-divide-duration-number[`*`] -| _Duration_ +| `DURATION` | xref::values-and-types/property-structural-constructed.adoc#property-types[Number] -| _Duration_ +| `DURATION` | xref::syntax/operators.adoc#syntax-multiply-divide-duration-number[`*`] | xref::values-and-types/property-structural-constructed.adoc#property-types[Number] -| _Duration_ -| _Duration_ +| `DURATION` +| `DURATION` | xref::syntax/operators.adoc#syntax-multiply-divide-duration-number[`/`] -| _Duration_ +| `DURATION` | xref::values-and-types/property-structural-constructed.adoc#property-types[Number] -| _Duration_ +| `DURATION` |=== [[syntax-add-subtract-duration-to-temporal-instant]] -=== Adding and subtracting a _Duration_ to or from a temporal instant +=== Adding and subtracting a `DURATION` to or from a temporal instant .Query [source, cypher] @@ -645,8 +645,8 @@ RETURN aDateTime + aDuration, aDateTime - aDuration 2+d|Rows: 1 |=== -xref::values-and-types/temporal.adoc#cypher-temporal-duration-component[Components of a _Duration_] that do not apply to the temporal instant are ignored. -For example, when adding a _Duration_ to a _Date_, the _hours_, _minutes_, _seconds_ and _nanoseconds_ of the _Duration_ are ignored (_Time_ behaves in an analogous manner): +xref::values-and-types/temporal.adoc#cypher-temporal-duration-component[Components of a `DURATION`] that do not apply to the temporal instant are ignored. +For example, when adding a `DURATION` to a `DATE`, the _hours_, _minutes_, _seconds_ and _nanoseconds_ of the `DURATION` are ignored (`ZONED TIME` and `LOCAL TIME` behaves in an analogous manner): .Query [source, cypher] @@ -686,7 +686,7 @@ RETURN [[syntax-add-subtract-duration-to-duration]] -=== Adding and subtracting a _Duration_ to or from another _Duration_ +=== Adding and subtracting a `DURATION` to or from another `DURATION` .Query [source, cypher] @@ -707,7 +707,7 @@ RETURN duration1, duration2, duration1 + duration2, duration1 - duration2 [[syntax-multiply-divide-duration-number]] -=== Multiplying and dividing a _Duration_ with or by a number +=== Multiplying and dividing a `DURATION` with or by a number These operations are interpreted simply as component-wise operations with overflow to smaller units based on an average length of units in the case of division (and multiplication with fractions). diff --git a/modules/ROOT/pages/values-and-types/casting-data.adoc b/modules/ROOT/pages/values-and-types/casting-data.adoc index 8e5f7b839..d53a0153d 100644 --- a/modules/ROOT/pages/values-and-types/casting-data.adoc +++ b/modules/ROOT/pages/values-and-types/casting-data.adoc @@ -13,36 +13,36 @@ The following functions are available for casting data values: |=== | Function | Description -| toBoolean() | Converts a string, integer, or boolean value to a boolean value. +| toBoolean() | Converts a `STRING`, `INTEGER`, or `BOOLEAN` value to a `BOOLEAN` value. -| toBooleanList() | Converts a list of values and returns a list of boolean values. -If any values are not convertible to boolean they will be `null` in the list returned. +| toBooleanList() | Converts a `LIST` and returns a `LIST` values. +If any values are not convertible to `BOOLEAN` they will be `null` in the `LIST` returned. -| toBooleanOrNull() | Converts a string, integer or boolean value to a boolean value. +| toBooleanOrNull() | Converts a `STRING`, `INTEGER` or `BOOLEAN` value to a `BOOLEAN` value. For any other input value, `null` will be returned. -| toFloat() | Converts an integer, floating point, or a string value to a floating point number value. +| toFloat() | Converts an `INTEGER`, `FLOAT`, or a `STRING` value to a `FLOAT` value. Otherwise `null` is returned. -| toFloatList() | Converts a list of values and returns a list of floating point values. -If any values are not convertible to floating point they will be `null` in the list returned. +| toFloatList() | Converts a `LIST` and returns a `LIST` values. +If any values are not convertible to `FLOAT` they will be `null` in the `LIST` returned. -| toFloatOrNull() | Converts an integer, floating point, or a string value to a floating point number. +| toFloatOrNull() | Converts an `INTEGER`, `FLOAT`, or a `STRING` value to a `FLOAT`. For any other input value, `null` will be returned. -| toInteger() | Converts a boolean, integer, floating point or a string value to an integer value. +| toInteger() | Converts a `BOOLEAN`, `INTEGER`, `FLOAT` or a `STRING` value to an `INTEGER` value. -| toIntegerList() | Converts a list of values and returns a list of integer values. If any values are not convertible to integer they will be `null` in the list returned. +| toIntegerList() | Converts a `LIST` to a `LIST` values. If any values are not convertible to `INTEGER` they will be null in the `LIST` returned. -| toIntegerOrNull() | Converts a boolean, integer, floating point or a string value to an integer value. +| toIntegerOrNull() | Converts a `BOOLEAN`, `INTEGER`, `FLOAT` or a `STRING` value to an `INTEGER` value. For any other input value, `null` will be returned. -| toString() | Converts an integer, float, boolean, string, point, duration, date, time, localtime, localdatetime, or datetime value to a string value. +| toString() | Converts an `INTEGER`, `FLOAT`, `BOOLEAN`, `STRING`, `POINT`, `DURATION`, `DATE`, `ZONED TIME`, `LOCAL TIME`, `LOCAL DATETIME`, or `ZONED DATETIME` value to a `STRING` value. -| toStringList() | Converts a list of values and returns a list of string values. -If any values are not convertible to string they will be `null` in the list returned. +| toStringList() | Converts a `LIST` and returns a `LIST` values. +If any values are not convertible to `STRING` they will be `null` in the `LIST` returned. -| toStringOrNull() | Converts an integer, float, boolean, string, point, duration, date, time, localtime, localdatetime, or datetime value to a string. +| toStringOrNull() | Converts an `INTEGER`, `FLOAT`, `BOOLEAN`, `STRING`, `POINT`, `DURATION`, `DATE`, `ZONED TIME`, `LOCAL TIME`, `LOCAL DATETIME`, or `ZONED DATETIME` value to a `STRING`. For any other input value, `null` will be returned. |=== @@ -67,7 +67,7 @@ CREATE (keanu:Person {name:'Keanu Reeves', age: 58, active:true}), [[converting-data-values-examples-returning-converted-values]] === Returning converted values -In the below query, the function `toFloat` is used to cast two string values. +In the below query, the function `toFloat` is used to cast two `STRING` values. It shows that `null` is returned if the data casting is not possible. [source, cypher] @@ -87,7 +87,7 @@ RETURN toFloat(keanu.age), toInteger(keanu.name) |=== -If the function `toFloat` is passed an unsupported value (such as a date), it will throw an error: +If the function `toFloat` is passed an unsupported value (such as a `DATE` value), it will throw an error: .Query [source,cypher, role=test-fail] @@ -125,7 +125,7 @@ RETURN toFloatOrNull(d) |=== It is also possible to return casted values as a list. -The below query uses the `toStringList` to cast all passed values into strings, and return them in a list: +The below query uses the `toStringList` to cast all passed values into `STRING` values, and return them in as a `LIST`: [source,cypher] ---- @@ -147,7 +147,7 @@ RETURN toStringList([keanu.name, keanu.age]) AS keanuList === Updating property value types The functions to cast data values can be used to update property values on nodes and relationships. -The below query casts the `age` (integer), `active` (boolean), and `since`(integer) properties to string values: +The below query casts the `age` (`INTEGER`), `active` (`BOOLEAN`), and `since`(`INTEGER`) properties to `STRING` values: [source, cypher] ---- diff --git a/modules/ROOT/pages/values-and-types/spatial.adoc b/modules/ROOT/pages/values-and-types/spatial.adoc index 4e77bd17a..243f7e5d7 100644 --- a/modules/ROOT/pages/values-and-types/spatial.adoc +++ b/modules/ROOT/pages/values-and-types/spatial.adoc @@ -3,10 +3,10 @@ [[spatial-values]] = Spatial values -Cypher has built-in support for handling spatial values (points), which can be stored as properties on nodes and relationships in Neo4j databases. +Cypher has built-in support for handling spatial values (`POINT` values), which can be stored as properties on nodes and relationships in Neo4j databases. This section begins with an explanation of the `POINT` type. -It then proceeds to discuss Cypher's support of Coordinate Reference Systems, and how to work with spatial instants in Cypher, including how spatial point instants work with Cypher indexing. +It then proceeds to discuss Cypher's support of Coordinate Reference Systems, and how to work with spatial instants in Cypher, including how spatial point instants work with Cypher indexing. Finally, it briefly explains comparability and orderability with regard to spatial instants. [NOTE] @@ -24,7 +24,7 @@ Neo4j supports the `POINT` type for values of spatial geometry. Values with the `POINT` type have the following characteristics: * Each point can have either 2 or 3 dimensions. -This means it contains either 2 or 3 64-bit floating point values, which together are called the _Coordinate_. +This means it contains either 2 or 3 64-bit `FLOAT` values, which together are called the _Coordinate_. * Each point will also be associated with a specific xref::values-and-types/spatial.adoc#spatial-values-crs[Coordinate Reference System] (CRS) that determines the meaning of the values in the _Coordinate_. * Instances of `POINT` and `LIST` can be assigned to node and relationship properties. * Nodes and relationships with `POINT` or `LIST` properties can be indexed using a xref::indexes-for-search-performance.adoc#indexes-create-a-node-point-index[point index]. @@ -135,7 +135,7 @@ RETURN All `POINT` types are created from two components: -* The _Coordinate_ containing either 2 or 3 floating point values (64-bit). +* The _Coordinate_ containing either 2 or 3 `FLOAT` values (64-bit). * The Coordinate Reference System (or CRS) defining the meaning (and possibly units) of the values in the _Coordinate_. For most use cases, it is not necessary to specify the CRS explicitly as it will be deduced from the keys used to specify the coordinate. @@ -202,7 +202,7 @@ Components of `POINT` values can be accessed as properties. === Examples -The following query shows how to extract the components of a _Cartesian 2D_ point value: +The following query shows how to extract the components of a _Cartesian 2D_ `POINT` value: .Query [source, cypher, indent=0] @@ -223,7 +223,7 @@ RETURN 4+d|Rows: 1 |=== -The following query shows how to extract the components of a _WGS-84 3D_ point value: +The following query shows how to extract the components of a _WGS-84 3D_ `POINT` value: .Query [source, cypher, indent=0] diff --git a/modules/ROOT/pages/values-and-types/temporal.adoc b/modules/ROOT/pages/values-and-types/temporal.adoc index 8a82d741b..45f92cfa1 100644 --- a/modules/ROOT/pages/values-and-types/temporal.adoc +++ b/modules/ROOT/pages/values-and-types/temporal.adoc @@ -1167,7 +1167,7 @@ RETURN duration({days: 1, hours: 12}) AS theDuration .+duration.between+ ====== -Compute the duration between two temporal instants: +Computes the `DURATION` between two temporal instants: .Query [source, cypher] @@ -1210,7 +1210,7 @@ RETURN duration.inDays(date('2014-10-11'), date('2015-08-06')) AS theDuration .+date.truncate+ ====== -Get the date of the last day of the next month: +Get the `DATE` of the last day of the next month: .Query [source, cypher] @@ -1232,7 +1232,7 @@ RETURN date.truncate('month', date() + duration('P2M')) - duration('P1D') AS las .+time+ ====== -Add a duration to a date: +Add a `DURATION` to a `DATE`: .Query [source, cypher] @@ -1276,7 +1276,7 @@ RETURN duration({days: 2, hours: 7}) + duration({months: 1, hours: 18}) AS theDu .+duration+ ====== -Multiply a duration by a number: +Multiply a `DURATION` by a number: .Query [source, cypher] @@ -1298,7 +1298,7 @@ RETURN duration({hours: 5, minutes: 21}) * 14 AS theDuration .+duration+ ====== -Divide a duration by a number: +Divide a `DURATION` by a number: .Query [source, cypher]