Skip to content

Commit

Permalink
remove and update many more mentions of 5.x
Browse files Browse the repository at this point in the history
  • Loading branch information
renetapopova committed Jan 9, 2025
1 parent cbcdcbb commit 270f0ae
Show file tree
Hide file tree
Showing 65 changed files with 242 additions and 261 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:description: This section explains how to use Cypher to manage authentication and authorization at the user level using Cypher.
:page-role: enterprise-edition new-5.24
:page-role: enterprise-edition

[[access-control-auth-providers]]
= User auth providers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1574,13 +1574,7 @@ The ability to use elevated privileges when executing a procedure can be granted
A user with this privilege will not be restricted to their other privileges when executing the procedures matched by the <<access-control-name-globbing, name-globbing>>.
The `EXECUTE BOOSTED PROCEDURE` privilege only affects the elevation, and not the execution of the procedure.
Therefore, it is needed to grant `EXECUTE PROCEDURE` privilege for the procedures as well.


[NOTE]
====
Since Neo4j 5.0, both `EXECUTE PROCEDURE` and `EXECUTE BOOSTED PROCEDURE` are needed to execute a procedure with elevated privileges.
This differs from Neo4j 4.x, when only the `EXECUTE BOOSTED PROCEDURE` is required.
====
Both `EXECUTE PROCEDURE` and `EXECUTE BOOSTED PROCEDURE` are needed to execute a procedure with elevated privileges.

[source, cypher, role=noplay]
----
Expand Down Expand Up @@ -1873,13 +1867,7 @@ The ability to use elevated privileges when executing a user-defined function (U
A user with this privilege will not be restricted to their other privileges when executing the UDFs matched by the <<access-control-name-globbing, name-globbing>>.
The `EXECUTE BOOSTED USER DEFINED FUNCTION` privilege only affects the elevation and not the execution of the function.
Therefore, it is needed to grant `EXECUTE USER DEFINED FUNCTION` privilege for the functions as well.


[NOTE]
====
Since Neo4j 5.0, both `EXECUTE USER DEFINED FUNCTION` and `EXECUTE BOOSTED USER DEFINED FUNCTION` are needed to execute a function with elevated privileges.
This differs from Neo4j 4.x, when only the `EXECUTE BOOSTED USER DEFINED FUNCTION` is required.
====
oth `EXECUTE USER DEFINED FUNCTION` and `EXECUTE BOOSTED USER DEFINED FUNCTION` are needed to execute a function with elevated privileges.

[IMPORTANT]
====
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
:description: This section explains how to use Cypher to manage immutable roles and privileges.


Immutable privileges are useful for restricting the actions of users who can themselves administer xref:authentication-authorization/dbms-administration.adoc#access-control-dbms-administration-privilege-management[privileges].
Starting with Neo4j 5.26, Neo4j also introduces immutable roles.
Immutable privileges are useful for restricting the actions of users who can themselves administer xref:authentication-authorization/dbms-administration.adoc#access-control-dbms-administration-privilege-management[privileges].
Immutable roles are useful for providing _system roles_, which appear as permanent parts of the DBMS.


Expand Down Expand Up @@ -38,8 +37,8 @@ The following examples demonstrate how to use Cypher to manage immutable roles a

=== Restricting the actions of users who can manage privileges

To prevent all users (including those with `PRIVILEGE MANAGEMENT` privileges) from performing *database management*, attach an immutable privilege to the `PUBLIC` role.
The `PUBLIC` role implicitly and irrevocably applies to all users.
To prevent all users (including those with `PRIVILEGE MANAGEMENT` privileges) from performing *database management*, attach an immutable privilege to the `PUBLIC` role.
The `PUBLIC` role implicitly and irrevocably applies to all users.

. Ensure that you have completed steps 1 and 2 from <<administer-immutable-roles-and-privileges>>.
. Run the following command to deny the `IMMUTABLE DATABASE MANAGEMENT` privilege to the `PUBLIC` role:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ CREATE ROLE roleLoadCidr
[[access-control-load-privileges]]
= Load privileges

_This feature is available from Neo4j 5.13._

This section explains how to use Cypher to manage load privileges.
All load privileges apply to the whole system.
Like DBMS privileges, they do not belong to one specific database or graph.
Expand Down Expand Up @@ -102,8 +100,6 @@ The `LOAD ON ALL DATA` privilege is granted to the `PUBLIC` role by default.
[[access-control-load-cidr]]
== The `CIDR` privilege

_This feature is available from Neo4j 5.16._

The load privilege on `CIDR cidr` enables or disables loading data from the given IPv4 or IPv6 CIDR range.
If granted, the user can load data from sources in the given CIDR range.
If missing or denied, no data can be loaded from sources in the given CIDR range.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The components of the graph privilege commands are:
** `IMMUTABLE` can optionally be specified when performing a `GRANT` or `DENY` to indicate that the privilege cannot be subsequently removed unless auth is disabled.
Auth must also be disabled in order to `GRANT` or `DENY` an immutable privilege.
Contrastingly, when `IMMUTABLE` is specified in conjunction with a `REVOKE` command, it will act as a filter and only remove matching _immutable_ privileges.
Starting from Neo4j 5.26, immutable privileges can also be used together with immutable roles.
Immutable privileges can also be used together with immutable roles.
See xref:authentication-authorization/immutable-roles-privileges.adoc[] for more information.

* _graph-privilege_:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ For more information, see xref:authentication-authorization/dbms-administration.


You can view all available roles using the Cypher command `SHOW ROLES`, which returns a single column by default.
Starting from 5.26, you can optionally use `SHOW ROLES YIELD *` to see if the role is immutable.
Optionally, you can also use `SHOW ROLES YIELD *` to see if the role is immutable.
See <<access-control-immutable-roles, Immutable roles>> for more information.

.`SHOW ROLES` output
Expand Down Expand Up @@ -582,7 +582,6 @@ This is equivalent to running `DROP ROLE myrole IF EXISTS` followed by `CREATE R
The `CREATE OR REPLACE ROLE` command does not allow you to use the `IF NOT EXISTS`.
====

[role=new-in-5.26]
[[access-control-immutable-roles]]
== Immutable roles

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -752,7 +752,6 @@ You can create users using one of the following Cypher commands, depending on wh
In both cases, you can specify the user's password, whether they must change it at the next login, their status, home database, and auth provider settings.
The `SET` clauses can be applied in any order.
It is mandatory to specify a `SET PASSWORD` and/or at least one `SET AUTH` clause because users must have at least one auth provider.
`SET AUTH` is available from Neo4j 5.24 onwards.

.`CREATE USER` syntax
[source, syntax, role="noheader"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ CREATE ROLE regularUsers;
----
////

:page-role: enterprise-edition aura-db-business-critical aura-db-dedicated new-5.24
:page-role: enterprise-edition aura-db-business-critical aura-db-dedicated
[[property-based-access-control]]
= Property-based access control

Expand Down Expand Up @@ -106,7 +106,7 @@ GRANT READ {*} ON GRAPH * FOR (n) WHERE n.createdAt > date() TO regularUsers
----
[NOTE]
====
The `date()` function is evaluated, and the value used to evaluate the privilege is the date when the property-based privilege is created.
The `date()` function is evaluated, and the value used to evaluate the privilege is the date when the property-based privilege is created.
Keep this in mind when designing your property rules, and use the `SHOW PRIVILEGES AS COMMANDS` command to check the stored value.
This is essential when revoking property-based privileges containing evaluated function values like `date()`.
====
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ The default is `false`, to read the claim from the token.
| xref:configuration/configuration-settings.adoc#config_dbms.security.oidc.-provider-.claims.groups[dbms.security.oidc.<provider>.claims.groups]
|
| true
| The claim to use for the database roles. Neo4j expects to find a claim in the JWT or user_info response with this name. The claim may be a string claim representing a single role or a string array claim representing multiple roles. From Neo4j 5.4, the JWT claim may also contain a single group returned as a string as well as a list of groups as was previously required.
| The claim to use for the database roles. Neo4j expects to find a claim in the JWT or user_info response with this name. The claim may be a string claim representing a single role or a string array claim representing multiple roles. The JWT claim may also contain a single group returned as a string as well as a list of groups as was previously required.

| xref:configuration/configuration-settings.adoc#config_dbms.security.oidc.-provider-.authorization.group_to_role_mapping[dbms.security.oidc.<provider>.authorization.group_to_role_mapping]
|
Expand Down
5 changes: 2 additions & 3 deletions modules/ROOT/pages/backup-restore/aggregate.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -102,13 +102,13 @@ Consult Neo4j support before use.

[NOTE]
====
The `--from-path=<path>` option can also load backup artifacts from AWS S3 buckets (from Neo4j 5.19), Google Cloud storage buckets (from Neo4j 5.21), and Azure buckets (from Neo4j 5.24).
The `--from-path=<path>` option can also load backup artifacts from AWS S3 buckets, Google Cloud storage buckets, and Azure buckets.
For more information, see <<aggregate-backup-cloud-storage>>.
====

[NOTE]
====
Neo4j 5.24 introduces the `--temp-path` option to address potential issues related to disk space when performing backup-related commands, especially when cloud storage is involved.
The `--temp-path` option addresses potential issues related to disk space when performing backup-related commands, especially when cloud storage is involved.
If `--temp-path` is not set, a temporary directory is created inside the directory specified by the `--from-path` option.
Expand Down Expand Up @@ -142,7 +142,6 @@ bin/neo4j-admin database aggregate-backup --from-path=/mnt/backups/neo4j-2022-10
----
The command checks the `/mnt/backups/` directory for a backup chain including the file _neo4j-2022-10-18T13-00-07.backup_, for the database `neo4j`.
If found, it is then aggregated into a single backup artifact.
This option is only available in Neo4j 5.2 and later.

[[aggregate-backup-cloud-storage]]
=== Aggregating a backup chain located in a cloud storage
Expand Down
16 changes: 8 additions & 8 deletions modules/ROOT/pages/backup-restore/copy-database.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,13 @@ neo4j-admin database copy [-h] [--copy-schema] [--expand-commands] [--force] [--

=== Description

This command will create a copy of a database.
This command creates a copy of a database.
If your labels, properties, or relationships contain dots or commas, you can use backticks to quote them, e.g. ``My,label``, ``My.property``.
A file named _<database-name>-schema.cypher_, containing the schema commands needed to recreate indexes/constraints on the copy, will be created.

From Neo4j 5.20 onwards, you can use the `--copy-schema` option to automatically copy the schema.
You can use the `--copy-schema` option to automatically copy the schema.
Indexes will be built the first time the database is started.
This option can copy the schema from any 4.4 and 5.x version to 5.20 and later versions.
This option can copy the schema from any 4.4 and 5.x version to 5.26 LTS and later versions.

=== Parameters

Expand All @@ -65,7 +65,7 @@ This option can copy the schema from any 4.4 and 5.x version to 5.20 and later v
If the same as `<fromDatabase>`, it is copied to a temporary location, by default the current working directory or the path as defined by `--temp-path`, before being moved to replace the original.
|===

From Neo4j 5.5, you can use the same values for `<fromDatabase>` and `<toDatabase>` if you do not need an actual copy of the database.
You can use the same values for `<fromDatabase>` and `<toDatabase>` if you do not need an actual copy of the database.
The command will replace the original database with the newly created copy.

[[copy-database-command-options]]
Expand Down Expand Up @@ -231,9 +231,9 @@ STOP DATABASE neo4j
If you do not need an actual copy of the database, you can use the same values for `<fromDatabase>` and `<toDatabase>`.
The command replaces the original database with the newly created copy.
From Neo4j 5.20 onwards, you can use the `--copy-schema` option to automatically copy the schema.
You can use the `--copy-schema` option to automatically copy the schema.
Indexes will be built the first time the database is started.
This option copies the schema from any 4.4 and 5.x version to 5.20 and later versions.
This option copies the schema from any 4.4 and 5.x version to 5.26 LTS and later versions.
For previous versions, you need to manually recreate the schema using the Cyher statements saved in the file _<database-name>-schema.cypher_.
====
Expand Down Expand Up @@ -326,9 +326,9 @@ bin/neo4j-admin database copy neo4j neo4j --compact-node-store --temp-path=<my-p
`--temp-path` can be used to specify a different directory to use as a temporary staging area.
If omitted, the current working directory will be used.
From Neo4j 5.20 onwards, you can use the `--copy-schema` option to automatically copy the schema.
You can use the `--copy-schema` option to automatically copy the schema.
Indexes will be built the first time the database is started.
This option can copy the schema from any 4.4 and 5.x to 5.20 and later versions.
This option can copy the schema from any 4.4 and 5.x to 5.26 LTS and later versions.
For previous versions, you need to manually recreate the schema using the Cyher statements saved in the file _<database-name>-schema.cypher_.
====
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/backup-restore/inspect.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[[inspect-backup]]
= Inspect the metadata of a backup file
:description: This section describes how to inspect the metadata of backup files. Metadata are information like the database name, the backup compression, the transaction range that the backup contains etc..
:page-role: enterprise-edition new-5.25
:page-role: enterprise-edition

You can inspect the metadata of a database backup file using the `neo4j-admin backup inspect` command.

Expand Down Expand Up @@ -53,7 +53,7 @@ Command to read the backup metadata.

[NOTE]
====
The `<backup-path>` parameter can also inspect backups stored in AWS S3 buckets (from Neo4j 5.19), Google Cloud storage buckets (from Neo4j 5.21), and Azure buckets (from Neo4j 5.24).
The `<backup-path>` parameter can also inspect backups stored in AWS S3 buckets, Google Cloud storage buckets, and Azure buckets.
====

[[inspect-backup-command-options]]
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/backup-restore/offline-backup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ It is possible to dump databases into AWS S3 buckets, Google Cloud storage bucke

[NOTE]
====
The `--to-path=<path>` option can also dump databases into AWS S3 buckets (from Neo4j 5.19), Google Cloud storage buckets (from Neo4j 5.21), and Azure buckets (from Neo4j 5.24).
The `--to-path=<path>` option can also dump databases into AWS S3 buckets, Google Cloud storage buckets, and Azure buckets.
For more information, see <<offline-backup-cloud-storage>>.
====

Expand Down
6 changes: 3 additions & 3 deletions modules/ROOT/pages/backup-restore/online-backup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -190,13 +190,13 @@ If you want to force a full backup, use `FULL`.

[NOTE]
====
The `--to-path=<path>` option can also back up databases into AWS S3 buckets (from Neo4j 5.19), Google Cloud storage buckets (from Neo4j 5.21), and Azure buckets (from 5.24).
The `--to-path=<path>` option can also back up databases into AWS S3 buckets, Google Cloud storage buckets, and Azure buckets.
For more information, see <<online-backup-cloud-storage>>.
====

[NOTE]
====
Neo4j 5.24 introduces the `--temp-path` option to address potential issues related to disk space when performing backup-related commands, especially when cloud storage is involved.
The `--temp-path` option can address potential issues related to disk space when performing backup-related commands, especially when cloud storage is involved.
If `--temp-path` is not set, a temporary directory is created inside the directory specified by the `--path` option.
Expand Down Expand Up @@ -327,7 +327,7 @@ dbms.ssl.policy.backup.client_auth=REQUIRE

[TIP]
====
Neo4j 5.24 also supports TLSv1.3.
Neo4j also supports TLSv1.3.
To use both TLSv1.2 and TLSv1.3 versions, you must specify which ciphers to be enforced for each version.
Otherwise, Neo4j could use every possible cipher in the JVM for those versions, leading to a less secure configuration.
Expand Down
6 changes: 3 additions & 3 deletions modules/ROOT/pages/backup-restore/restore-backup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

A database backup artifact (full or differential) can be restored within the same or to a later Neo4j version using the `restore` command of `neo4j-admin`.

Starting with Neo4j 5.20, you can load a **full** database backup artifact using the xref:backup-restore/restore-dump.adoc#restore-dump-command[`neo4j-admin database load`] command.
You can also load a **full** database backup artifact using the xref:backup-restore/restore-dump.adoc#restore-dump-command[`neo4j-admin database load`] command.
This functionality is available in the Community Edition.

[NOTE]
Expand Down Expand Up @@ -125,13 +125,13 @@ Usage of this option is only allowed if the `--from-path` parameter points to ex

[NOTE]
====
The `--from-path=<path>` option can also load backups from AWS S3 buckets (from Neo4j 5.19), Google Cloud storage buckets (from Neo4j 5.21), and Azure buckets (from Neo4j 5.24).
The `--from-path=<path>` option can also load backups from AWS S3 buckets, Google Cloud storage buckets , and Azure buckets.
For more information, see <<restore-cloud-storage>>.
====

[NOTE]
====
Neo4j 5.24 introduces the `--temp-path` option to address potential issues related to disk space when performing backup-related commands, especially when cloud storage is involved.
The `--temp-path` option can address potential issues related to disk space when performing backup-related commands, especially when cloud storage is involved.
If `--temp-path` is not set, a temporary directory is created inside the directory specified by the `--from-path` option.
Expand Down
Loading

0 comments on commit 270f0ae

Please sign in to comment.