Skip to content

Commit

Permalink
5.x merge dev (#1740)
Browse files Browse the repository at this point in the history
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: NataliaIvakina <82437520+NataliaIvakina@users.noreply.github.com>
Co-authored-by: Nick Giles <100630647+nick-giles-neo@users.noreply.github.com>
Co-authored-by: Lidia Zuin <102308961+lidiazuin@users.noreply.github.com>
Co-authored-by: Michael Blum <mikeblum@users.noreply.github.com>
Co-authored-by: Valdemar Roxling <valdemar.roxling@neo4j.com>
Co-authored-by: David Pond <davidpond@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Neil Dewhurst <neil.dewhurst@neo4j.com>
Co-authored-by: Matthew Parnell <matthew.parnell@neo4j.com>
Co-authored-by: Jessica Wright <49636617+AlexicaWright@users.noreply.github.com>
Co-authored-by: Matthew Parnell <matt@parnmatt.co.uk>
Co-authored-by: Bruno Caricchio Buss <bruno.buss@neo4j.com>
Co-authored-by: Mark Dixon <1756429+mnd999@users.noreply.github.com>
Co-authored-by: Phil Wright <95368282+phil198@users.noreply.github.com>
Co-authored-by: Balazs Lendvai <56266523+gfx54b@users.noreply.github.com>
Co-authored-by: Stefano Ottolenghi <stefano.ottolenghi@neo4j.com>
Co-authored-by: Christophe Willemsen <willemsen.christophe@gmail.com>
Co-authored-by: Fi Quick <47183728+fiquick@users.noreply.github.com>
Co-authored-by: Jenny Owen <jennyowen@users.noreply.github.com>
Co-authored-by: Love Kristofer Leifland <love.leifland@neotechnology.com>
Co-authored-by: Florent Biville <445792+fbiville@users.noreply.github.com>
Co-authored-by: Hannes Sandberg <hannes.sandberg@neotechnology.com>
Co-authored-by: Therese Magnusson <therese.magnusson@neotechnology.com>
Co-authored-by: Richard Sill <156673635+rsill-neo4j@users.noreply.github.com>
Co-authored-by: Therese Magnusson <therese.magnusson@neo4j.com>
Co-authored-by: davidlrosenblum <davidlrosenblum@users.noreply.github.com>
Co-authored-by: Jack Waudby <33488812+jackwaudby@users.noreply.github.com>
Co-authored-by: gjmwoods <42248895+gjmwoods@users.noreply.github.com>
Co-authored-by: Satia Herfert <satiaherfert@gmx.de>
Co-authored-by: Alexander Bouriakov <alexander.bouriakov@neo4j.com>
Co-authored-by: Jack Waudby <jack.waudby@neo4j.com>
Co-authored-by: Arne Fischereit <79841228+arnefischereit@users.noreply.github.com>
Co-authored-by: Bastien Louërat <b.louerat@gmail.com>
Co-authored-by: Aleksey Karasavov <alekseitk@gmail.com>
Co-authored-by: Lasse Heemann <lasse.heemann@neo4j.com>
Co-authored-by: Nathan Smith <nsmith_piano@hotmail.com>
  • Loading branch information
Show file tree
Hide file tree
Showing 24 changed files with 204 additions and 59 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
./.github/ @recrwplay
16 changes: 16 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates

version: 2
updates:
- package-ecosystem: "npm" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
interval: "weekly"
groups:
prod-dependencies:
dependency-type: "production"
dev-dependencies:
dependency-type: "development"
2 changes: 1 addition & 1 deletion .github/workflows/docs-branch-checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ jobs:
if: ${{ inputs.lint || github.event_name == 'push' }}
name: Lint docs
uses: neo4j/docs-tools/.github/workflows/reusable-docs-lint.yml@v1.0.3

11 changes: 5 additions & 6 deletions .github/workflows/docs-deploy-surge.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ jobs:
var artifacts = await github.rest.actions.listWorkflowRunArtifacts({
owner: context.repo.owner,
repo: context.repo.repo,
run_id: ${{ github.event.workflow_run.id }},
run_id: ${{ env.RUN_ID }},
});
var matchArtifactDocs = artifacts.data.artifacts.filter((artifact) => {
Expand Down Expand Up @@ -71,13 +71,13 @@ jobs:
- id: unzip-changelog
if: ${{ hashFiles('changelog.zip') != '' }}
run: unzip changelog.zip

- id: get-deploy-id
run: |
deployid=$(<deployid)
case "$deployid" in ''|*[!0-9]*) echo "Provided PR number is not an integer"; exit 1 ;; esac
echo "deploy-id=$deployid" >> "$GITHUB_OUTPUT"
- id: get-deploy-url
env:
ORG: ${{ github.event.repository.owner.login }}
Expand All @@ -86,11 +86,11 @@ jobs:
run: |
deployurl=$ORG-$REPO-$DEPLOYID.surge.sh
echo "deploy-url=$deployurl" >> $GITHUB_OUTPUT
- uses: actions/setup-node@v4
with:
node-version: lts/*

- name: Deploy docs to surge
shell: bash
env:
Expand Down Expand Up @@ -124,6 +124,5 @@ jobs:
header: docs-pr-changes
message: |
Looks like you've updated the documentation!
Check out your changes at https://${{ env.DEPLOY_URL }}
GITHUB_TOKEN: ${{ secrets.DOCS_PR_COMMENT_TOKEN }}
2 changes: 1 addition & 1 deletion .github/workflows/docs-pr-checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ jobs:
uses: neo4j/docs-tools/.github/workflows/reusable-docs-pr-changes.yml@v1.1.2
with:
pages-modified: ${{ needs.docs-changes-pr.outputs.pages-modified }}
pages-added: ${{ needs.docs-changes-pr.outputs.pages-added }}
pages-added: ${{ needs.docs-changes-pr.outputs.pages-added }}
3 changes: 1 addition & 2 deletions .github/workflows/docs-teardown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ jobs:
run: |
deployurl=$ORG-$REPO-$DEPLOYID.surge.sh
echo "deploy-url=$deployurl" >> $GITHUB_OUTPUT
- name: Teardown documentation
shell: bash
env:
Expand All @@ -43,4 +42,4 @@ jobs:
The preview documentation has now been torn down - reopening this PR will republish it.
GITHUB_TOKEN: ${{ secrets.DOCS_PR_COMMENT_TOKEN }}

8 changes: 4 additions & 4 deletions antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ nav:
asciidoc:
attributes:
neo4j-version: '5'
neo4j-version-minor: '5.21'
neo4j-version-exact: '5.21.0'
neo4j-buildnumber: '5.21'
neo4j-debian-package-version: '1:5.21.0@'
neo4j-version-minor: '5.22'
neo4j-version-exact: '5.22.0'
neo4j-buildnumber: '5.22'
neo4j-debian-package-version: '1:5.22.0@'
7 changes: 4 additions & 3 deletions modules/ROOT/pages/backup-restore/copy-database.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -203,9 +203,10 @@ If you go from `high_limit` to `standard` or `aligned`, there is no validation t
|
|===

[role=label--enterprise-edition]
[NOTE]
====
The block format is introduced in Neo4j 5.14 and is only available in Neo4j Enterprise Edition.
The block format is introduced in Neo4j 5.14 and from Neo4j 5.22, is the default format for all newly-created databases as long as they do not have the xref:configuration/configuration-settings.adoc#config_db.format[`db.format`] setting specified.
For more information on the block format, see xref:database-internals/store-formats.adoc[Store formats].
====

Expand Down Expand Up @@ -303,7 +304,7 @@ For more information, see xref:clustering/databases.adoc#cluster-seed[Designated

[NOTE]
====
Note that even though it is only one database copy in the end, you still need double the space during the operation.
Note that even though there is only one database copy in the end, you still need double the space during the operation.
====

. Stop the database named `neo4j`:
Expand All @@ -327,7 +328,7 @@ 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.
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 to 5.20 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
1 change: 0 additions & 1 deletion modules/ROOT/pages/backup-restore/online-backup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,6 @@ The `--to-path=<path>` option can also back up databases into AWS S3 buckets (fr
For more information, see <<online-backup-cloud-storage>>.
====


[[backup-command-exit-codes]]
=== Exit codes

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/clustering/disaster-recovery.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ Note that this may take a few minutes.
Once the `system` database is verified available, and all servers are online, the databases can be managed.
The steps here aim to make the unavailable databases available.

. If you have previously dropped databases as part of this guide, re-create each one from backup.
. If you have previously dropped databases as part of this guide, re-create each one from a backup.
See the xref:database-administration/standard-databases/create-databases.adoc[Create databases] section for more information on how to create a database.
. Run `SHOW DATABASES`.
If all databases are in desired states on all servers (`requestedStatus`=`currentStatus`), disaster recovery is complete.
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/clustering/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ This chapter describes the following:
** xref:clustering/monitoring/endpoints.adoc[Monitor cluster endpoints for status information] -- The endpoints and semantics of endpoints used to monitor the health of the cluster.
* xref:clustering/disaster-recovery.adoc[Disaster recovery] -- How to recover a cluster in the event of a disaster.
* xref:clustering/settings.adoc[Settings reference] -- A summary of the most important cluster settings.
// * xref:clustering/clustering-advanced/index.adoc[Advanced clustering] -- Some more advanced features of Neo4j clusters.
// ** xref:clustering/clustering-advanced/multi-data-center-routing.adoc[Multi-data center routing] -- Clusters on mutli-data centers.
* xref:clustering/clustering-advanced/index.adoc[Advanced clustering] -- Some more advanced features of Neo4j clusters.
** xref:clustering/clustering-advanced/multi-data-center-routing.adoc[Multi-data center routing] -- Clusters on mutli-data centers.
* xref:clustering/glossary.adoc[Clustering glossary] -- A glossary of terms used in the clustering documentation.
//* <<clustering-internals, Internals>> -- A few internals regarding the operation of the cluster.
Further information:
Expand Down
70 changes: 66 additions & 4 deletions modules/ROOT/pages/configuration/configuration-settings.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -360,13 +360,59 @@ m|+++10m+++
|===
|Description
a|A comma-separated list of endpoints that a server should contact in order to discover other cluster members.
Typically, all members of the cluster, including the current server, should be specified in this list.
Typically, all cluster members, including the current server, must be specified in this list.
The setting configures the endpoints for Discovery service V1.
|Valid values
a|A comma-separated list where each element is a socket address in the format of `hostname:port`, `hostname`, or `:port`.
|Default value
m|
|===

[role=label--enterprise-edition label--new-5.22]
[[config_dbms.cluster.discovery.v2.endpoints]]
=== `dbms.cluster.discovery.v2.endpoints`

// label:enterprise-edition[Enterprise Edition]

.dbms.cluster.discovery.v2.endpoints
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
|===
|Description
a|A comma-separated list of endpoints that a server should contact in order to discover other cluster members.
Typically, all cluster members, including the current server, must be specified in this list.
The setting configures the endpoints for Discovery service V2.
|Valid values
a|A comma-separated list where each element is a socket address in the format of `hostname:port`, `hostname`, or `:port`.
|Default value
m|
|===

[role=label--enterprise-edition label--new-5.22]
[[config_dbms.cluster.discovery.version]]
=== `dbms.cluster.discovery.version`

// label:enterprise-edition[Enterprise Edition]

.dbms.cluster.discovery.version
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
|===
|Description
a|This setting allows you to select which discovery service should be started.
Possible values are:

* `V1_ONLY` -- it runs only discovery service v1.

* `V1_OVER_V2` -- it runs both Discovery Service V1 and Discovery Service V2, where V1 is the main service and V2 runs in the background.

* `V2_OVER_V1` -- it runs both Discovery Service V1 and Discovery Service V2, where V2 is the main service and V1 runs in the background.

* `V2_ONLY` -- it runs only discovery service v2.
|Valid values
a|One of [V1_ONLY, V1_OVER_V2, V2_OVER_V1, V2_ONLY].
|Default value
m|+++V1_ONLY+++
|===


[role=label--enterprise-edition]
[[config_dbms.cluster.discovery.log_level]]
Expand Down Expand Up @@ -2136,7 +2182,7 @@ Either `high_limit` or `block` is required if you have a graph that is larger th
|Valid values
a|A string.
|Default value
m|+++aligned+++
m|+++block+++
|===


Expand Down Expand Up @@ -3358,7 +3404,7 @@ a|Specifies which metrics should be enabled by using a comma separated list of g
|Valid values
a|A comma-separated list where each element is A simple globbing pattern that can use `*` and `?`..
|Default value
m|+++*bolt.connections*,*bolt.messages_received*,*bolt.messages_started*,*dbms.pool.bolt.free,*dbms.pool.bolt.total_size,*dbms.pool.bolt.total_used,*dbms.pool.bolt.used_heap,*cluster.raft.is_leader,*cluster.raft.last_leader_message,*cluster.raft.replication_attempt,*cluster.raft.replication_fail,*cluster.raft.last_applied,*cluster.raft.last_appended,*cluster.raft.append_index,*cluster.raft.commit_index,*cluster.raft.applied_index,*check_point.*,*cypher.replan_events,*ids_in_use*,*pool.transaction.*.total_used,*pool.transaction.*.used_heap,*pool.transaction.*.used_native,*store.size*,*transaction.active_read,*transaction.active_write,*transaction.committed*,*transaction.last_committed_tx_id,*transaction.peak_concurrent,*transaction.rollbacks*,*page_cache.hit*,*page_cache.page_faults,*page_cache.usage_ratio,*vm.file.descriptors.count,*vm.gc.time.*,*vm.heap.used,*vm.memory.buffer.direct.used,*vm.memory.pool.g1_eden_space,*vm.memory.pool.g1_old_gen,*vm.pause_time,*vm.thread*,*db.query.execution*+++
m|+++*bolt.connections*,*bolt.messages_received*,*bolt.messages_started*,*dbms.pool.bolt.free,*dbms.pool.bolt.total_size,*dbms.pool.bolt.total_used,*dbms.pool.bolt.used_heap,*cluster.raft.is_leader,*cluster.raft.last_leader_message,*cluster.raft.replication_attempt,*cluster.raft.replication_fail,*cluster.raft.last_applied,*cluster.raft.last_appended,*cluster.raft.append_index,*cluster.raft.commit_index,*cluster.raft.applied_index,*cluster.internal.discovery.memberset.left,*cluster.internal.discovery.crdt.gossip_id_data.size,*cluster.internal.discovery.crdt.server_data.size,*cluster.internal.discovery.crdt.database_data.size,*cluster.internal.discovery.crdt.leader_data.size,*cluster.internal.discovery.crdt.total_merge_operations,*cluster.internal.discovery.crdt.total_update_operations,*cluster.internal.discovery.gossip.incoming_queue_size,*cluster.internal.discovery.gossip.total_received_data,*cluster.internal.discovery.gossip.total_sent_data,*cluster.internal.discovery.gossip.uncontactable_members_exist,*check_point.*,*cypher.replan_events,*ids_in_use*,*pool.transaction.*.total_used,*pool.transaction.*.used_heap,*pool.transaction.*.used_native,*store.size*,*transaction.active_read,*transaction.active_write,*transaction.committed*,*transaction.last_committed_tx_id,*transaction.peak_concurrent,*transaction.rollbacks*,*page_cache.hit*,*page_cache.page_faults,*page_cache.usage_ratio,*vm.file.descriptors.count,*vm.gc.time.*,*vm.heap.used,*vm.memory.buffer.direct.used,*vm.memory.pool.g1_eden_space,*vm.memory.pool.g1_old_gen,*vm.pause_time,*vm.thread*,*db.query.execution*+++
|===


Expand Down Expand Up @@ -3725,6 +3771,22 @@ a|A string.
m|
|===

[role=label--enterprise-edition label--new-5.22]
[[config_dbms.kubernetes.discovery.v2.service_port_name]]
=== `dbms.kubernetes.discovery.v2.service_port_name`

// label:enterprise-edition[Enterprise Edition]

.dbms.kubernetes.discovery.v2.service_port_name
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
|===
|Description
a|Service port name for Discovery v2 for Kubernetes API.
|Valid values
a|A string.
|Default value
m|+++transaction+++
|===

[role=label--enterprise-edition]
[[config_dbms.kubernetes.token]]
Expand Down Expand Up @@ -3994,7 +4056,7 @@ a|Defines the Content-Security-Policy header to return to content returned on st
|Valid values
a|A string.
|Default value
m|+++default-src 'self'; script-src 'self' cdn.segment.com canny.io; img-src 'self' data:; style-src 'self' fonts.googleapis.com 'unsafe-inline'; font-src 'self' fonts.gstatic.com; base-uri 'none'; object-src 'none'; frame-ancestors 'none'; connect-src 'self' api.canny.io api.segment.io ws: wss: http: https:+++
m|+++default-src 'self'; script-src 'self' cdn.segment.com canny.io; img-src 'self' guides.neo4j.com data:; style-src 'self' fonts.googleapis.com 'unsafe-inline'; font-src 'self' fonts.gstatic.com; base-uri 'none'; object-src 'none'; frame-ancestors 'none'; connect-src 'self' api.canny.io api.segment.io ws: wss: http: https:+++
|===


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ CREATE DATABASE `perennial-flowers`;
== List database aliases in composite databases

Available database aliases in composite databases can be seen using `SHOW ALIASES FOR DATABASE`.
The name of the composite database a particular database alias is part of appears in the returned `composite` column.
The name of the composite database a particular database alias appears in the returned `composite` column.

The required privileges are described in the xref:authentication-authorization/dbms-administration.adoc#access-control-dbms-administration-alias-management[The DBMS ALIAS MANAGEMENT privileges].

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,10 @@ Having dots (`.`) in the database names is not recommended.
This is due to the difficulty of determining if a dot is part of the database name or a delimiter for a database alias in a composite database.
====

In Neo4j, the default store format for all new databases is `aligned`.
In versions previous to Neo4j 5.22, the default store format for all new databases is `aligned`.
From Neo4j 5.22, `block` is the default format for all newly-created databases as long as they do not have the xref:configuration/configuration-settings.adoc#config_db.format[`db.format`] setting specified. +
If you want to change it, you can set a new value for the xref:configuration/configuration-settings.adoc#config_db.format[`db.format`] configuration in the _neo4j.conf_ file. +
Alternatively, you can set the store format of new databases using the `CREATE DATABASE databasename OPTIONS {storeFormat: 'the-new-format'}` command.
Alternatively, you can set the store format of new databases using the `CREATE DATABASE databasename OPTIONS {storeFormat: 'the-new-format'}` command.
However, if the store is seeded with `seedURI` or `existingDataSeedInstance`, or if the command is being used to mount pre-existing store files already present on the disk, they will use their current store format without any alterations.

See xref:database-internals/store-formats.adoc[Store formats], for more details about available database store formats in Neo4j.
Expand Down Expand Up @@ -153,7 +154,7 @@ SHOW DATABASES YIELD name

==== Create a database with xref:database-administration/standard-databases/wait-options.adoc[`WAIT`]

Sub-clause `WAIT` allows you to specify a time limit in which the command must complete and return.
Sub-clause `WAIT` allows you to specify a time limit in which the command must complete and return.

[source, cypher]
----
Expand Down Expand Up @@ -262,7 +263,7 @@ SHOW DATABASE customers YIELD name, requestedStatus, currentStatus

==== Start a database with xref:database-administration/standard-databases/wait-options.adoc[`WAIT`]

You can start your database using `WAIT` sub-clause to ensure that the command waits for a specified amount of time until the database is started.
You can start your database using `WAIT` sub-clause to ensure that the command waits for a specified amount of time until the database is started.

[source, cypher]
----
Expand Down
Loading

0 comments on commit 5d3903f

Please sign in to comment.