Skip to content

Commit

Permalink
remove abstracts (#753)
Browse files Browse the repository at this point in the history
We no longer use abstracts in the docs.
  • Loading branch information
JPryce-Aklundh authored Oct 2, 2023
1 parent b74d23f commit 1b246f3
Show file tree
Hide file tree
Showing 61 changed files with 52 additions and 273 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
5 changes: 1 addition & 4 deletions modules/ROOT/pages/administration/aliases.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 2 additions & 4 deletions modules/ROOT/pages/administration/databases.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 0 additions & 3 deletions modules/ROOT/pages/clauses/call.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions modules/ROOT/pages/clauses/clause_composition.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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].
Expand Down
3 changes: 0 additions & 3 deletions modules/ROOT/pages/clauses/delete.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
7 changes: 1 addition & 6 deletions modules/ROOT/pages/clauses/foreach.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 0 additions & 3 deletions modules/ROOT/pages/clauses/limit.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
5 changes: 0 additions & 5 deletions modules/ROOT/pages/clauses/listing-functions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
5 changes: 0 additions & 5 deletions modules/ROOT/pages/clauses/listing-procedures.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
3 changes: 0 additions & 3 deletions modules/ROOT/pages/clauses/load-csv.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions modules/ROOT/pages/clauses/order-by.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 0 additions & 3 deletions modules/ROOT/pages/clauses/remove.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
====
Expand Down
3 changes: 0 additions & 3 deletions modules/ROOT/pages/clauses/set.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 1 addition & 3 deletions modules/ROOT/pages/clauses/skip.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
5 changes: 1 addition & 4 deletions modules/ROOT/pages/clauses/transaction-clauses.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 0 additions & 5 deletions modules/ROOT/pages/clauses/union.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
5 changes: 0 additions & 5 deletions modules/ROOT/pages/clauses/unwind.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
3 changes: 0 additions & 3 deletions modules/ROOT/pages/clauses/with.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
====
Expand Down
6 changes: 1 addition & 5 deletions modules/ROOT/pages/constraints/examples.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 1 addition & 4 deletions modules/ROOT/pages/constraints/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 1 addition & 4 deletions modules/ROOT/pages/execution-plans/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
====
Expand Down
7 changes: 2 additions & 5 deletions modules/ROOT/pages/execution-plans/operator-summary.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
5 changes: 1 addition & 4 deletions modules/ROOT/pages/execution-plans/operators.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading

0 comments on commit 1b246f3

Please sign in to comment.