diff --git a/modules/ROOT/pages/administration/access-control/built-in-roles.adoc b/modules/ROOT/pages/administration/access-control/built-in-roles.adoc index 1b4ad9052..f57eccf25 100644 --- a/modules/ROOT/pages/administration/access-control/built-in-roles.adoc +++ b/modules/ROOT/pages/administration/access-control/built-in-roles.adoc @@ -3,10 +3,7 @@ [[access-control-built-in-roles]] = Built-in roles and privileges -[abstract] --- -This section explains the default privileges of the built-in roles in Neo4j and how to recreate them if needed. --- +This page explains the default privileges of the built-in roles in Neo4j and how to recreate them if needed. All of the commands described in this chapter require that the user executing the commands has the rights to do so. The privileges listed in the following sections are the default set of privileges for each built-in role: diff --git a/modules/ROOT/pages/administration/access-control/database-administration.adoc b/modules/ROOT/pages/administration/access-control/database-administration.adoc index 6b33cecfd..7162e971d 100644 --- a/modules/ROOT/pages/administration/access-control/database-administration.adoc +++ b/modules/ROOT/pages/administration/access-control/database-administration.adoc @@ -14,10 +14,7 @@ CREATE USER jake SET PASSWORD 'abcd1234' CHANGE NOT REQUIRED; [[access-control-database-administration]] = Database administration -[abstract] --- -This section explains how to use Cypher to manage Neo4j database administrative privileges. --- +This page explains how to use Cypher to manage Neo4j database administrative privileges. Administrators can use the following Cypher commands to manage Neo4j database administrative rights. diff --git a/modules/ROOT/pages/administration/access-control/dbms-administration.adoc b/modules/ROOT/pages/administration/access-control/dbms-administration.adoc index 03c165f01..b09c793ee 100644 --- a/modules/ROOT/pages/administration/access-control/dbms-administration.adoc +++ b/modules/ROOT/pages/administration/access-control/dbms-administration.adoc @@ -64,10 +64,7 @@ CREATE ROLE deniedConfigurationViewer IF NOT EXISTS; [[access-control-dbms-administration]] = DBMS administration -[abstract] --- -This section explains how to use Cypher to manage Neo4j DBMS administrative privileges. --- +This page explains how to use Cypher to manage Neo4j DBMS administrative privileges. All DBMS privileges are relevant system-wide. Like user management, they do not belong to one specific database or graph. diff --git a/modules/ROOT/pages/administration/access-control/limitations.adoc b/modules/ROOT/pages/administration/access-control/limitations.adoc index 25d563b31..8aea171ee 100644 --- a/modules/ROOT/pages/administration/access-control/limitations.adoc +++ b/modules/ROOT/pages/administration/access-control/limitations.adoc @@ -14,10 +14,7 @@ CREATE ROLE free; [[access-control-limitations]] = Limitations -[abstract] --- -This section lists the known limitations and implications of Neo4js role-based access control security. --- +This page lists the known limitations and implications of Neo4j's role-based access control security. [[access-control-limitations-indexes]] == Security and Indexes diff --git a/modules/ROOT/pages/administration/access-control/manage-privileges.adoc b/modules/ROOT/pages/administration/access-control/manage-privileges.adoc index a2729e052..877cef24d 100644 --- a/modules/ROOT/pages/administration/access-control/manage-privileges.adoc +++ b/modules/ROOT/pages/administration/access-control/manage-privileges.adoc @@ -4,10 +4,7 @@ = Managing privileges -[abstract] --- -This section explains how to use Cypher to manage privileges for Neo4j role-based access control and fine-grained security. --- +This page explains how to use Cypher to manage privileges for Neo4j role-based access control and fine-grained security. Privileges control the access rights to graph elements using a combined allowlist/denylist mechanism. It is possible to grant or deny access, or use a combination of the two. diff --git a/modules/ROOT/pages/administration/access-control/manage-roles.adoc b/modules/ROOT/pages/administration/access-control/manage-roles.adoc index d567aa522..1dd434cf1 100644 --- a/modules/ROOT/pages/administration/access-control/manage-roles.adoc +++ b/modules/ROOT/pages/administration/access-control/manage-roles.adoc @@ -17,10 +17,7 @@ CREATE ROLE role2 IF NOT EXISTS; ---- //// -[abstract] --- -This section explains how to use Cypher to manage roles in Neo4j. --- +This page explains how to use Cypher to manage roles in Neo4j. Roles can be created and managed using a set of Cypher administration commands executed against the `system` database. diff --git a/modules/ROOT/pages/administration/access-control/manage-users.adoc b/modules/ROOT/pages/administration/access-control/manage-users.adoc index b677ada57..f53f432c8 100644 --- a/modules/ROOT/pages/administration/access-control/manage-users.adoc +++ b/modules/ROOT/pages/administration/access-control/manage-users.adoc @@ -3,15 +3,11 @@ [[access-control-manage-users]] = Managing users -[abstract] --- -This section explains how to use Cypher to manage users in Neo4j. --- +This page explains how to use Cypher to manage users in Neo4j. Users can be created and managed using a set of Cypher administration commands executed against the `system` database. When connected to the DBMS over `bolt`, administration commands are automatically routed to the `system` database. - [[access-control-user-syntax]] == User management command syntax diff --git a/modules/ROOT/pages/administration/access-control/privileges-reads.adoc b/modules/ROOT/pages/administration/access-control/privileges-reads.adoc index dc76d6960..c8eb731a8 100644 --- a/modules/ROOT/pages/administration/access-control/privileges-reads.adoc +++ b/modules/ROOT/pages/administration/access-control/privileges-reads.adoc @@ -11,10 +11,8 @@ CREATE ROLE regularUsers; [[access-control-privileges-reads]] = Read privileges -[abstract] --- -This section explains how to use Cypher to manage read privileges on graphs. --- + +This page explains how to use Cypher to manage read privileges on graphs. There are three separate read privileges: diff --git a/modules/ROOT/pages/administration/access-control/privileges-writes.adoc b/modules/ROOT/pages/administration/access-control/privileges-writes.adoc index 71f6e2069..aef0fb916 100644 --- a/modules/ROOT/pages/administration/access-control/privileges-writes.adoc +++ b/modules/ROOT/pages/administration/access-control/privileges-writes.adoc @@ -11,10 +11,7 @@ CREATE ROLE regularUsers; [[access-control-privileges-writes]] = Write privileges -[abstract] --- -This section explains how to use Cypher to manage write privileges on graphs. --- +This page explains how to use Cypher to manage write privileges on graphs. Write privileges are defined for different parts of the graph: diff --git a/modules/ROOT/pages/administration/aliases.adoc b/modules/ROOT/pages/administration/aliases.adoc index d0f214eba..a28999411 100644 --- a/modules/ROOT/pages/administration/aliases.adoc +++ b/modules/ROOT/pages/administration/aliases.adoc @@ -3,10 +3,7 @@ [[alias-management]] = Database alias management -[abstract] --- -This section explains how to use Cypher to manage database aliases in Neo4j. --- +This page explains how to use Cypher to manage database aliases in Neo4j. There are two kinds of database aliases: local and remote. A local database alias can only target a database within the same DBMS. diff --git a/modules/ROOT/pages/administration/databases.adoc b/modules/ROOT/pages/administration/databases.adoc index 5ff27a220..c136c0cd7 100644 --- a/modules/ROOT/pages/administration/databases.adoc +++ b/modules/ROOT/pages/administration/databases.adoc @@ -12,10 +12,8 @@ CREATE ALIAS `motion pictures` FOR DATABASE `movies`; :description: How to use Cypher to manage databases in Neo4j DBMS: creating, modifying, deleting, starting, and stopping individual databases within a single server. :page-aliases: databases.adoc -[abstract] --- -This section explains how to use Cypher to manage databases in Neo4j DBMS: creating, modifying, deleting, starting, and stopping individual databases within a single server. --- +This section explains how to use Cypher to manage databases in Neo4j DBMS. +It describes how to create, modify, delete, start, and stop individual databases within a single server. Neo4j supports the management of multiple databases within the same DBMS. The metadata for these databases, including the associated security model, is maintained in a special database called the `system` database. diff --git a/modules/ROOT/pages/clauses/call.adoc b/modules/ROOT/pages/clauses/call.adoc index cd205151d..f2cf65652 100644 --- a/modules/ROOT/pages/clauses/call.adoc +++ b/modules/ROOT/pages/clauses/call.adoc @@ -3,10 +3,7 @@ [[query-call]] = CALL procedure -[abstract] --- The `CALL` clause is used to call a procedure deployed in the database. --- [[query-call-introduction]] == Introduction diff --git a/modules/ROOT/pages/clauses/clause_composition.adoc b/modules/ROOT/pages/clauses/clause_composition.adoc index 6833d7d92..78db4cdf5 100644 --- a/modules/ROOT/pages/clauses/clause_composition.adoc +++ b/modules/ROOT/pages/clauses/clause_composition.adoc @@ -3,10 +3,7 @@ [[cypher-clause-composition]] = Clause composition -[abstract] --- This section describes the semantics of Cypher when composing different read and write clauses. --- A query is made up from several clauses chained together. These are discussed in more detail in the chapter on xref::clauses/index.adoc[Clauses]. diff --git a/modules/ROOT/pages/clauses/delete.adoc b/modules/ROOT/pages/clauses/delete.adoc index de29778a5..ff0efc735 100644 --- a/modules/ROOT/pages/clauses/delete.adoc +++ b/modules/ROOT/pages/clauses/delete.adoc @@ -3,10 +3,7 @@ [[query-delete]] = DELETE -[abstract] --- The `DELETE` clause is used to delete nodes, relationships or paths. --- For removing properties and labels, see the xref::clauses/remove.adoc[REMOVE] clause. diff --git a/modules/ROOT/pages/clauses/foreach.adoc b/modules/ROOT/pages/clauses/foreach.adoc index 4fdc5b2e3..6851af6f8 100644 --- a/modules/ROOT/pages/clauses/foreach.adoc +++ b/modules/ROOT/pages/clauses/foreach.adoc @@ -3,12 +3,7 @@ [[query-foreach]] = FOREACH -[abstract] --- -The `FOREACH` clause is used to update data within a collection whether components of a path, or result of aggregation. --- - -Lists and paths are key concepts in Cypher. +xref:values-and-types/lists.adoc[Lists] and xref:patterns/concepts.adoc#path-patterns[paths] are key concepts in Cypher. The `FOREACH` clause can be used to update data, such as executing update commands on elements in a path, or on a list created by aggregation. The variable context within the `FOREACH` parenthesis is separate from the one outside it. diff --git a/modules/ROOT/pages/clauses/limit.adoc b/modules/ROOT/pages/clauses/limit.adoc index 273d4b285..056fa5cae 100644 --- a/modules/ROOT/pages/clauses/limit.adoc +++ b/modules/ROOT/pages/clauses/limit.adoc @@ -3,10 +3,7 @@ [[query-limit]] = LIMIT -[abstract] --- `LIMIT` constrains the number of returned rows. --- `LIMIT` accepts any expression that evaluates to a positive integer and does not refer to nodes or relationships. diff --git a/modules/ROOT/pages/clauses/listing-functions.adoc b/modules/ROOT/pages/clauses/listing-functions.adoc index 490cec8cc..7c419a99d 100644 --- a/modules/ROOT/pages/clauses/listing-functions.adoc +++ b/modules/ROOT/pages/clauses/listing-functions.adoc @@ -3,11 +3,6 @@ [[query-listing-functions]] = SHOW FUNCTIONS -[abstract] --- -This section explains the `SHOW FUNCTIONS` command. --- - Listing the available functions can be done with `SHOW FUNCTIONS`. [NOTE] diff --git a/modules/ROOT/pages/clauses/listing-procedures.adoc b/modules/ROOT/pages/clauses/listing-procedures.adoc index 2acf2af36..a8c2b1391 100644 --- a/modules/ROOT/pages/clauses/listing-procedures.adoc +++ b/modules/ROOT/pages/clauses/listing-procedures.adoc @@ -3,11 +3,6 @@ [[query-listing-procedures]] = SHOW PROCEDURES -[abstract] --- -This section explains the `SHOW PROCEDURES` command. --- - Listing the available procedures can be done with `SHOW PROCEDURES`. [NOTE] diff --git a/modules/ROOT/pages/clauses/load-csv.adoc b/modules/ROOT/pages/clauses/load-csv.adoc index cfb410062..8b6597410 100644 --- a/modules/ROOT/pages/clauses/load-csv.adoc +++ b/modules/ROOT/pages/clauses/load-csv.adoc @@ -3,10 +3,7 @@ [[query-load-csv]] = LOAD CSV -[abstract] --- `LOAD CSV` is used to import data from CSV files. --- [[query-load-csv-introduction]] == Introduction diff --git a/modules/ROOT/pages/clauses/order-by.adoc b/modules/ROOT/pages/clauses/order-by.adoc index 56579f3ad..94bf8597e 100644 --- a/modules/ROOT/pages/clauses/order-by.adoc +++ b/modules/ROOT/pages/clauses/order-by.adoc @@ -3,10 +3,7 @@ [[query-order]] = ORDER BY -[abstract] --- `ORDER BY` is a sub-clause following `RETURN` or `WITH`, and it specifies that the output should be sorted and how. --- `ORDER BY` relies on comparisons to sort the output, see xref::syntax/operators.adoc#cypher-ordering[Ordering and comparison of values]. You can sort on many different values, e.g. node/relationship properties, the node/relationship ids, or on most expressions. diff --git a/modules/ROOT/pages/clauses/remove.adoc b/modules/ROOT/pages/clauses/remove.adoc index 1e294e79f..3df25fd26 100644 --- a/modules/ROOT/pages/clauses/remove.adoc +++ b/modules/ROOT/pages/clauses/remove.adoc @@ -3,10 +3,7 @@ [[query-remove]] = REMOVE -[abstract] --- The `REMOVE` clause is used to remove properties from nodes and relationships, and to remove labels from nodes. --- [TIP] ==== diff --git a/modules/ROOT/pages/clauses/set.adoc b/modules/ROOT/pages/clauses/set.adoc index 27340b5a2..2f0e53476 100644 --- a/modules/ROOT/pages/clauses/set.adoc +++ b/modules/ROOT/pages/clauses/set.adoc @@ -3,10 +3,7 @@ [[query-set]] = SET -[abstract] --- The `SET` clause is used to update labels on nodes and properties on nodes and relationships. --- The `SET` clause can be used with a map -- provided as a literal or a parameter -- to set properties. diff --git a/modules/ROOT/pages/clauses/skip.adoc b/modules/ROOT/pages/clauses/skip.adoc index e0da79704..89ce8641b 100644 --- a/modules/ROOT/pages/clauses/skip.adoc +++ b/modules/ROOT/pages/clauses/skip.adoc @@ -3,10 +3,8 @@ [[query-skip]] = SKIP -[abstract] --- `SKIP` defines from which row to start including the rows in the output. --- + By using `SKIP`, the result set will get trimmed from the top. Please note that no guarantees are made on the order of the result unless the query specifies the `ORDER BY` clause. diff --git a/modules/ROOT/pages/clauses/transaction-clauses.adoc b/modules/ROOT/pages/clauses/transaction-clauses.adoc index 6135229cf..41a6734b1 100644 --- a/modules/ROOT/pages/clauses/transaction-clauses.adoc +++ b/modules/ROOT/pages/clauses/transaction-clauses.adoc @@ -3,10 +3,7 @@ [[query-transaction-clauses]] = Transaction commands -[abstract] --- -This section explains the `SHOW TRANSACTIONS` and `TERMINATION TRANSACTIONS` commands. --- +This page explains the `SHOW TRANSACTIONS` and `TERMINATION TRANSACTIONS` commands. [[query-listing-transactions]] == SHOW TRANSACTIONS diff --git a/modules/ROOT/pages/clauses/union.adoc b/modules/ROOT/pages/clauses/union.adoc index 9bd257664..696c9580f 100644 --- a/modules/ROOT/pages/clauses/union.adoc +++ b/modules/ROOT/pages/clauses/union.adoc @@ -3,11 +3,6 @@ [[query-union]] = UNION -[abstract] --- -The `UNION` clause is used to combine the result of multiple queries. --- - `UNION` combines the results of two or more queries into a single result set that includes all the rows that belong to any queries in the union. The number and the names of the columns must be identical in all queries combined by using `UNION`. diff --git a/modules/ROOT/pages/clauses/unwind.adoc b/modules/ROOT/pages/clauses/unwind.adoc index 4e45a2b06..b133c8d99 100644 --- a/modules/ROOT/pages/clauses/unwind.adoc +++ b/modules/ROOT/pages/clauses/unwind.adoc @@ -3,11 +3,6 @@ [[query-unwind]] = UNWIND -[abstract] --- -`UNWIND` expands a list into a sequence of rows. --- - The `UNWIND` clause makes it possible to transform any list back into individual rows. These lists can be parameters that were passed in, previously `collect`-ed result, or other list expressions. diff --git a/modules/ROOT/pages/clauses/with.adoc b/modules/ROOT/pages/clauses/with.adoc index 045aabbd3..0aa2b0952 100644 --- a/modules/ROOT/pages/clauses/with.adoc +++ b/modules/ROOT/pages/clauses/with.adoc @@ -3,10 +3,7 @@ [[query-with]] = WITH -[abstract] --- The `WITH` clause allows query parts to be chained together, piping the results from one to be used as starting points or criteria in the next. --- [NOTE] ==== diff --git a/modules/ROOT/pages/constraints/examples.adoc b/modules/ROOT/pages/constraints/examples.adoc index 72c01abf3..f84686113 100644 --- a/modules/ROOT/pages/constraints/examples.adoc +++ b/modules/ROOT/pages/constraints/examples.adoc @@ -3,11 +3,7 @@ [[constraints-examples]] = Examples -[abstract] --- -Examples of how to manage constraints used for ensuring data integrity. --- - +This page contains examples of how to manage constraints used for ensuring data integrity. [[constraints-examples-node-uniqueness]] == Node property uniqueness constraints diff --git a/modules/ROOT/pages/constraints/index.adoc b/modules/ROOT/pages/constraints/index.adoc index 1e8761c8b..4bcf3b3e0 100644 --- a/modules/ROOT/pages/constraints/index.adoc +++ b/modules/ROOT/pages/constraints/index.adoc @@ -3,10 +3,7 @@ [[constraints]] = Constraints -[abstract] --- -This section explains how to manage constraints used for ensuring data integrity. --- +This page contains an overview of the available constraints in Cypher. [[types-of-constraint]] == Types of constraint diff --git a/modules/ROOT/pages/execution-plans/index.adoc b/modules/ROOT/pages/execution-plans/index.adoc index 5002f82f9..2c72d57cf 100644 --- a/modules/ROOT/pages/execution-plans/index.adoc +++ b/modules/ROOT/pages/execution-plans/index.adoc @@ -3,10 +3,7 @@ [[execution-plans]] = Execution plans -[abstract] --- -This section describes the characteristics of query execution plans and provides details about each of the operators. --- +This page describes the characteristics of query execution plans and provides details about each of the operators. [NOTE] ==== diff --git a/modules/ROOT/pages/execution-plans/operator-summary.adoc b/modules/ROOT/pages/execution-plans/operator-summary.adoc index 47790a89e..3177fbb9f 100644 --- a/modules/ROOT/pages/execution-plans/operator-summary.adoc +++ b/modules/ROOT/pages/execution-plans/operator-summary.adoc @@ -3,12 +3,9 @@ [[execution-plan-operators]] = Execution plan operators -[abstract] --- -This section contains the exection plan operators at a glance. --- +This section contains a summary of the execution plan operators. -This table comprises all the execution plan operators ordered lexicographically. +The below table comprises all the execution plan operators ordered lexicographically. * _Leaf_ operators, in most cases, locate the starting nodes and relationships required in order to execute the query. diff --git a/modules/ROOT/pages/execution-plans/operators.adoc b/modules/ROOT/pages/execution-plans/operators.adoc index ed91bc220..46c492311 100644 --- a/modules/ROOT/pages/execution-plans/operators.adoc +++ b/modules/ROOT/pages/execution-plans/operators.adoc @@ -3,10 +3,7 @@ [[execution-plans-operators]] = Execution plan operators in detail -[abstract] --- -All executing plan operators are listed here, grouped by the similarity of their characteristics. --- +This page lists all execution plan operators, grouped by the similarity of their characteristics. Certain operators are only used by a subset of the xref::query-tuning/index.adoc#cypher-runtime[runtimes] that Cypher can choose from. If that is the case, the example queries will be prefixed with an option to choose one of these runtimes. diff --git a/modules/ROOT/pages/execution-plans/shortestpath-planning.adoc b/modules/ROOT/pages/execution-plans/shortestpath-planning.adoc index d3ee1667d..1f32b3095 100644 --- a/modules/ROOT/pages/execution-plans/shortestpath-planning.adoc +++ b/modules/ROOT/pages/execution-plans/shortestpath-planning.adoc @@ -3,10 +3,7 @@ [[query-shortestpath-planning]] = Shortest path planning -[abstract] --- -Shortest path finding in Cypher and how it is planned. --- +This page contains an example of how to plan queries using the xref:patterns/concepts.adoc#shortest-path[shortestPath()] function. Planning shortest paths in Cypher can lead to different query plans depending on the predicates that need to be evaluated. Internally, Neo4j will use a fast bidirectional breadth-first search algorithm if the predicates can be evaluated whilst searching for the path. diff --git a/modules/ROOT/pages/functions/index.adoc b/modules/ROOT/pages/functions/index.adoc index 09e101a63..7f8ca400f 100644 --- a/modules/ROOT/pages/functions/index.adoc +++ b/modules/ROOT/pages/functions/index.adoc @@ -3,10 +3,7 @@ [[query-function]] = Functions -[abstract] --- This section contains information on all functions in the Cypher query language. --- * Predicate functions [xref::functions/index.adoc#header-query-functions-predicate[Summary]|xref::functions/predicate.adoc[Detail]] * Scalar functions [xref::functions/index.adoc#header-query-functions-scalar[Summary]|xref::functions/scalar.adoc[Detail]] diff --git a/modules/ROOT/pages/functions/list.adoc b/modules/ROOT/pages/functions/list.adoc index 52e52ffca..d5587169b 100644 --- a/modules/ROOT/pages/functions/list.adoc +++ b/modules/ROOT/pages/functions/list.adoc @@ -3,10 +3,7 @@ [[query-functions-list]] = List functions -[abstract] --- -List functions return lists of things -- nodes in a path, and so on. --- +List functions return lists of different data entities. Further details and examples of lists may be found in xref::values-and-types/lists.adoc[Lists] and xref::syntax/operators.adoc#query-operators-list[List operators]. diff --git a/modules/ROOT/pages/functions/load-csv.adoc b/modules/ROOT/pages/functions/load-csv.adoc index 54e8af4f6..bb651f179 100644 --- a/modules/ROOT/pages/functions/load-csv.adoc +++ b/modules/ROOT/pages/functions/load-csv.adoc @@ -3,10 +3,7 @@ [[query-functions-load-csv]] = LOAD CSV functions -[abstract] --- -LOAD CSV functions can be used to get information about the file that is processed by `LOAD CSV`. --- +LOAD CSV functions can be used to get information about the file that is processed by the `LOAD CSV` clause. [IMPORTANT] ==== diff --git a/modules/ROOT/pages/functions/mathematical-logarithmic.adoc b/modules/ROOT/pages/functions/mathematical-logarithmic.adoc index 6b98ea3d0..9377abcf3 100644 --- a/modules/ROOT/pages/functions/mathematical-logarithmic.adoc +++ b/modules/ROOT/pages/functions/mathematical-logarithmic.adoc @@ -3,10 +3,8 @@ [[query-functions-logarithmic]] = Mathematical functions - logarithmic -[abstract] --- -These functions all operate on numeric expressions only, and will return an error if used on any other values. See also xref::syntax/operators.adoc#query-operators-mathematical[Mathematical operators]. --- +Logarithmic mathematical functions operate on numeric expressions only, and will return an error if used on any other values. See also xref::syntax/operators.adoc#query-operators-mathematical[Mathematical operators]. + [[functions-e]] == e() diff --git a/modules/ROOT/pages/functions/mathematical-numeric.adoc b/modules/ROOT/pages/functions/mathematical-numeric.adoc index 898445851..2685a830b 100644 --- a/modules/ROOT/pages/functions/mathematical-numeric.adoc +++ b/modules/ROOT/pages/functions/mathematical-numeric.adoc @@ -3,11 +3,8 @@ [[query-functions-numeric]] = Mathematical functions - numeric -[abstract] --- -These functions all operate on numeric expressions only, and will return an error if used on any other values. +Numeric mathematical functions operate on numeric expressions only, and will return an error if used on any other values. See also xref::syntax/operators.adoc#query-operators-mathematical[Mathematical operators]. --- The following graph is used for the examples below: diff --git a/modules/ROOT/pages/functions/mathematical-trigonometric.adoc b/modules/ROOT/pages/functions/mathematical-trigonometric.adoc index 52bec4815..c90fa45f3 100644 --- a/modules/ROOT/pages/functions/mathematical-trigonometric.adoc +++ b/modules/ROOT/pages/functions/mathematical-trigonometric.adoc @@ -3,10 +3,8 @@ [[query-functions-trigonometric]] = Mathematical functions - trigonometric -[abstract] --- -These functions all operate on numeric expressions only, and will return an error if used on any other values. See also xref::syntax/operators.adoc#query-operators-mathematical[Mathematical operators]. --- + +Trigonometric mathematical functions operate on numeric expressions only, and will return an error if used on any other values. See also xref::syntax/operators.adoc#query-operators-mathematical[Mathematical operators]. [[functions-acos]] == acos() diff --git a/modules/ROOT/pages/functions/scalar.adoc b/modules/ROOT/pages/functions/scalar.adoc index 021c27785..7e1310808 100644 --- a/modules/ROOT/pages/functions/scalar.adoc +++ b/modules/ROOT/pages/functions/scalar.adoc @@ -3,10 +3,8 @@ [[query-functions-scalar]] = Scalar functions -[abstract] --- Scalar functions return a single value. --- + [IMPORTANT] ==== diff --git a/modules/ROOT/pages/functions/spatial.adoc b/modules/ROOT/pages/functions/spatial.adoc index 68bba0c7c..7243a0a72 100644 --- a/modules/ROOT/pages/functions/spatial.adoc +++ b/modules/ROOT/pages/functions/spatial.adoc @@ -3,10 +3,7 @@ [[query-functions-spatial]] = Spatial functions -[abstract] --- -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. --- +Spatial 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. diff --git a/modules/ROOT/pages/functions/string.adoc b/modules/ROOT/pages/functions/string.adoc index bba9ae310..ee3009dbf 100644 --- a/modules/ROOT/pages/functions/string.adoc +++ b/modules/ROOT/pages/functions/string.adoc @@ -3,11 +3,9 @@ [[query-functions-string]] = String functions -[abstract] --- -These functions all operate on string expressions only, and will return an error if used on any other values. + +String functions operate on string expressions only, and will return an error if used on any other values. The exception to this rule is `toString()`, which also accepts numbers, booleans and temporal values (i.e. `DATE`, `ZONED TIME`` `LOCAL TIME`, `ZONED DATETIME`, `LOCAL DATETIME` or `DURATION` values). --- Functions taking a string as input all operate on _Unicode characters_ rather than on a standard `char[]`. For example, the `size()` function applied to any _Unicode character_ will return `1`, even if the character does not fit in the 16 bits of one `char`. diff --git a/modules/ROOT/pages/functions/temporal/duration.adoc b/modules/ROOT/pages/functions/temporal/duration.adoc index e9cc2f191..88339b3cf 100644 --- a/modules/ROOT/pages/functions/temporal/duration.adoc +++ b/modules/ROOT/pages/functions/temporal/duration.adoc @@ -3,23 +3,15 @@ [[query-functions-temporal-duration]] = Temporal functions - duration -[abstract] --- -Cypher provides functions allowing for the creation and manipulation of temporal `DURATION` values. --- +Duration functions allow for the creation and manipulation of temporal `DURATION` values. + [NOTE] ==== See also xref::values-and-types/temporal.adoc[Temporal (Date/Time) values] and xref::syntax/operators.adoc#query-operators-temporal[Temporal operators]. ==== -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] - -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 in the page about xref::values-and-types/temporal.adoc#cypher-temporal-durations[Temporal values]. [[functions-duration]] == Creating a `DURATION` from duration components diff --git a/modules/ROOT/pages/functions/temporal/index.adoc b/modules/ROOT/pages/functions/temporal/index.adoc index 78d597bde..75e8cae47 100644 --- a/modules/ROOT/pages/functions/temporal/index.adoc +++ b/modules/ROOT/pages/functions/temporal/index.adoc @@ -3,10 +3,7 @@ [[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`, `ZONED TIME`, `LOCAL TIME`, `ZONED DATETIME`, and `LOCAL DATETIME`. --- +Temporal functions allow for the creation and manipulation of values for each temporal type -- `DATE`, `ZONED TIME`, `LOCAL TIME`, `ZONED DATETIME`, and `LOCAL DATETIME`. [NOTE] ==== diff --git a/modules/ROOT/pages/functions/user-defined.adoc b/modules/ROOT/pages/functions/user-defined.adoc index b62f7d750..6b3fb5209 100644 --- a/modules/ROOT/pages/functions/user-defined.adoc +++ b/modules/ROOT/pages/functions/user-defined.adoc @@ -4,10 +4,7 @@ [[query-functions-user-defined]] = User-defined functions -[abstract] --- User-defined functions are written in Java, deployed into the database and are called in the same way as any other Cypher function. --- There are two main types of functions that can be developed and used: diff --git a/modules/ROOT/pages/indexes-for-full-text-search.adoc b/modules/ROOT/pages/indexes-for-full-text-search.adoc index 726ad68a4..b25655f25 100644 --- a/modules/ROOT/pages/indexes-for-full-text-search.adoc +++ b/modules/ROOT/pages/indexes-for-full-text-search.adoc @@ -3,11 +3,6 @@ [[indexes-fulltext-search]] = Full-text search index -[abstract] --- -This chapter describes how to use full-text indexes, to enable full-text search. --- - Full-text indexes are powered by the link:https://lucene.apache.org/[Apache Lucene] indexing and search library, and can be used to index nodes and relationships by string properties. A full-text index allows you to write queries that match within the _contents_ of indexed string properties. For instance, the range and text indexes described in previous sections can only perform limited matching on strings; exact, prefix, substring, or suffix matches. diff --git a/modules/ROOT/pages/indexes-for-search-performance.adoc b/modules/ROOT/pages/indexes-for-search-performance.adoc index dd6ce6b57..6601c9a26 100644 --- a/modules/ROOT/pages/indexes-for-search-performance.adoc +++ b/modules/ROOT/pages/indexes-for-search-performance.adoc @@ -3,10 +3,7 @@ [[indexes-search-performance]] = Indexes for search performance -[abstract] --- -This section explains how to manage indexes used for search performance. --- +This page explains how to manage indexes used for search performance. For query performance purposes, it is important to also understand how the indexes are used by the Cypher planner. Refer to xref::query-tuning/index.adoc[] for examples and in-depth discussions on how query plans result from different index and query scenarios. diff --git a/modules/ROOT/pages/keyword-glossary.adoc b/modules/ROOT/pages/keyword-glossary.adoc index eb02e55e5..12e6bdb3a 100644 --- a/modules/ROOT/pages/keyword-glossary.adoc +++ b/modules/ROOT/pages/keyword-glossary.adoc @@ -3,18 +3,7 @@ [[cypher-glossary]] = Glossary of keywords -[abstract] --- -This section comprises a glossary of all the keywords -- grouped by category and thence ordered lexicographically -- in the Cypher query language. --- - -* xref::keyword-glossary.adoc#glossary-clauses[Clauses] -* xref::keyword-glossary.adoc#glossary-operators[Operators] -* xref::keyword-glossary.adoc#glossary-functions[Functions] -* xref::keyword-glossary.adoc#glossary-expressions[Expressions] -* xref::keyword-glossary.adoc#glossary-cypher-query-options[Cypher query options] -* xref::keyword-glossary.adoc#glossary-admin-commands[Administrative commands] -* xref::keyword-glossary.adoc#glossary-privileges[Privilege Actions] +This page contains a glossary of all the keywords -- grouped by category and thence ordered lexicographically -- in the Cypher query language. [[glossary-clauses]] diff --git a/modules/ROOT/pages/query-tuning/advanced-example.adoc b/modules/ROOT/pages/query-tuning/advanced-example.adoc index d92cb62bb..2f70ef8a3 100644 --- a/modules/ROOT/pages/query-tuning/advanced-example.adoc +++ b/modules/ROOT/pages/query-tuning/advanced-example.adoc @@ -4,10 +4,7 @@ [[advanced-query-tuning-example]] = Advanced query tuning example -[abstract] --- -This section describes some more subtle optimizations based on native index capabilities. --- +This page describes advanced query optimizations based on native index capabilities. One of the most important and useful ways of optimizing Cypher queries involves creating appropriate indexes. This is described in more detail in xref::indexes-for-search-performance.adoc[], and demonstrated in xref::query-tuning/basic-example.adoc[]. diff --git a/modules/ROOT/pages/query-tuning/basic-example.adoc b/modules/ROOT/pages/query-tuning/basic-example.adoc index a2d80718b..c7b2478f9 100644 --- a/modules/ROOT/pages/query-tuning/basic-example.adoc +++ b/modules/ROOT/pages/query-tuning/basic-example.adoc @@ -3,13 +3,7 @@ [[cypherdoc-basic-query-tuning-example]] = Basic query tuning example -[abstract] --- -This section describes how to profile a query, by using optimizations based on native index capabilities. --- - -Start with a basic example to help you get the hang of profiling queries. -The following examples will use a movies data set. +This page describes how to profile a query by using optimizations based on native index capabilities. [[basic-query-tuning-example-data-set]] == The data set diff --git a/modules/ROOT/pages/query-tuning/index.adoc b/modules/ROOT/pages/query-tuning/index.adoc index 34af94dcb..bd6b3aaa6 100644 --- a/modules/ROOT/pages/query-tuning/index.adoc +++ b/modules/ROOT/pages/query-tuning/index.adoc @@ -3,11 +3,6 @@ [[query-tuning]] = Query tuning -[abstract] --- -This section describes query tuning for the Cypher query language. --- - Neo4j aims to execute queries as fast as possible. However, when optimizing for maximum query execution performance, it may be helpful to rephrase queries using knowledge about the domain and the application. diff --git a/modules/ROOT/pages/query-tuning/indexes.adoc b/modules/ROOT/pages/query-tuning/indexes.adoc index 46305cb51..1bbf221fd 100644 --- a/modules/ROOT/pages/query-tuning/indexes.adoc +++ b/modules/ROOT/pages/query-tuning/indexes.adoc @@ -3,13 +3,7 @@ [[query-tuning-indexes]] = The use of indexes -[abstract] --- -This section describes the query plans when indexes are used in various scenarios. --- - -The task of tuning calls for different indexes depends on what the queries look like. -Therefore, it is important to have a fundamental understanding of how the indexes operate. +It is important to have a fundamental understanding of how indexes operate before using them to tune your Cypher queries. This section describes the query plans that result from different index scenarios. Node indexes and relationship indexes operate in the same way. diff --git a/modules/ROOT/pages/query-tuning/using.adoc b/modules/ROOT/pages/query-tuning/using.adoc index 6d7913d71..32864e424 100644 --- a/modules/ROOT/pages/query-tuning/using.adoc +++ b/modules/ROOT/pages/query-tuning/using.adoc @@ -3,11 +3,8 @@ [[query-using]] = Planner hints and the USING keyword -[abstract] --- A planner hint is used to influence the decisions of the planner when building an execution plan for a query. Planner hints are specified in a query with the `USING` keyword. --- [CAUTION] ==== diff --git a/modules/ROOT/pages/styleguide.adoc b/modules/ROOT/pages/styleguide.adoc index b99be669d..e95837226 100644 --- a/modules/ROOT/pages/styleguide.adoc +++ b/modules/ROOT/pages/styleguide.adoc @@ -4,25 +4,11 @@ [[cypher-styleguide]] = Cypher styleguide -[abstract] --- -The recommended style when writing Cypher queries. --- -This appendix contains the following: - -* xref::styleguide.adoc#cypher-styleguide-general-recommendations[General recommendations] -* xref::styleguide.adoc#cypher-styleguide-indentation-and-line-breaks[Indentations and line breaks] -* xref::styleguide.adoc#cypher-styleguide-casing[Casing] -* xref::styleguide.adoc#cypher-styleguide-spacing[Spacing] -* xref::styleguide.adoc#cypher-styleguide-patterns[Patterns] -* xref::styleguide.adoc#cypher-styleguide-meta-characters[Meta characters] - -The purpose of the styleguide is to make the code as easy to read as possible, and thereby contributing to lower cost of maintenance. +The purpose of the Cypher styleguide is to make queries as easy to read as possible. For rules and recommendations for naming of labels, relationship types and properties, please see the xref::syntax/naming.adoc[Naming rules and recommendations]. - [[cypher-styleguide-general-recommendations]] == General recommendations diff --git a/modules/ROOT/pages/syntax/comments.adoc b/modules/ROOT/pages/syntax/comments.adoc index 380bde029..efc1624c5 100644 --- a/modules/ROOT/pages/syntax/comments.adoc +++ b/modules/ROOT/pages/syntax/comments.adoc @@ -3,10 +3,7 @@ [[cypher-comments]] = Comments -[abstract] --- -This section describes how how to use comments in Cypher. --- +This page describes how how to use comments in Cypher. A comment begin with double slash (`//`) and continue to the end of the line. Comments do not execute, they are for humans to read. diff --git a/modules/ROOT/pages/syntax/naming.adoc b/modules/ROOT/pages/syntax/naming.adoc index 1db8cb98e..0601a130f 100644 --- a/modules/ROOT/pages/syntax/naming.adoc +++ b/modules/ROOT/pages/syntax/naming.adoc @@ -3,10 +3,7 @@ [[cypher-naming]] = Naming rules and recommendations -[abstract] --- -This section describes rules and recommendations for the naming of node labels, relationship types, property names, variables, indexes, and constraints. --- +This page describes rules and recommendations for the naming of node labels, relationship types, property names, variables, indexes, and constraints. == Naming rules diff --git a/modules/ROOT/pages/syntax/operators.adoc b/modules/ROOT/pages/syntax/operators.adoc index 614b9872f..5cc8c24f2 100644 --- a/modules/ROOT/pages/syntax/operators.adoc +++ b/modules/ROOT/pages/syntax/operators.adoc @@ -2,10 +2,7 @@ [[query-operators]] = Operators -[abstract] --- -This section contains an overview of operators. --- +This page contains an overview of the available Cypher operators. [[query-operators-summary]] == Operators at a glance diff --git a/modules/ROOT/pages/syntax/parameters.adoc b/modules/ROOT/pages/syntax/parameters.adoc index be724a0c3..c2afee26d 100644 --- a/modules/ROOT/pages/syntax/parameters.adoc +++ b/modules/ROOT/pages/syntax/parameters.adoc @@ -3,10 +3,7 @@ [[cypher-parameters]] = Parameters -[abstract] --- -This section describes parameterized querying. --- +This page describes parameterized querying. [[cypher-parameters-introduction]] == Introduction diff --git a/modules/ROOT/pages/syntax/parsing.adoc b/modules/ROOT/pages/syntax/parsing.adoc index 492146f48..3f67116d1 100644 --- a/modules/ROOT/pages/syntax/parsing.adoc +++ b/modules/ROOT/pages/syntax/parsing.adoc @@ -3,10 +3,7 @@ [[parsing]] = Parsing -[abstract] --- -This section provides a general overview of how Cypher parses an input string. --- +This page provides a general overview of how Cypher parses an input string. The Cypher parser takes an arbitrary input string. While the syntax of Cypher is described in subsequent chapters, the following details the general rules on which characters are considered valid input. diff --git a/modules/ROOT/pages/syntax/reserved.adoc b/modules/ROOT/pages/syntax/reserved.adoc index 759959525..e38ba0ed2 100644 --- a/modules/ROOT/pages/syntax/reserved.adoc +++ b/modules/ROOT/pages/syntax/reserved.adoc @@ -3,10 +3,8 @@ [[cypher-reserved]] = Reserved keywords -[abstract] --- -This section contains a list of reserved keywords in Cypher. --- + +This page contains a list of reserved keywords in Cypher. Reserved keywords are words that have a special meaning in Cypher. The listing of the reserved keywords are grouped by the categories from which they are drawn. diff --git a/modules/ROOT/pages/syntax/variables.adoc b/modules/ROOT/pages/syntax/variables.adoc index 9be462b80..2f4234691 100644 --- a/modules/ROOT/pages/syntax/variables.adoc +++ b/modules/ROOT/pages/syntax/variables.adoc @@ -3,10 +3,7 @@ [[cypher-variables]] = Variables -[abstract] --- -This section provides an overview of variables in Cypher. --- +This page provides an overview of variables in Cypher. When you reference parts of a pattern or a query, you do so by naming them. The names you give the different parts are called variables.