diff --git a/antora.yml b/antora.yml index 8d7d8656b..40bcfe6fa 100644 --- a/antora.yml +++ b/antora.yml @@ -1,14 +1,14 @@ name: operations-manual title: Operations Manual -version: '2025.06' +version: '2025.07' current: true start_page: ROOT:index.adoc nav: - modules/ROOT/content-nav.adoc asciidoc: attributes: - neo4j-version: '2025.06' - neo4j-version-minor: '2025.06' - neo4j-version-exact: '2025.06.2' - neo4j-buildnumber: '2025.06' - neo4j-debian-package-version: '1:2025.06.2@' + neo4j-version: '2025.07' + neo4j-version-minor: '2025.07' + neo4j-version-exact: '2025.07.0' + neo4j-buildnumber: '2025.07' + neo4j-debian-package-version: '1:2025.07.0@' diff --git a/modules/ROOT/pages/backup-restore/inspect.adoc b/modules/ROOT/pages/backup-restore/inspect.adoc index 6e2998a69..59450dd17 100644 --- a/modules/ROOT/pages/backup-restore/inspect.adoc +++ b/modules/ROOT/pages/backup-restore/inspect.adoc @@ -29,12 +29,17 @@ The metadata contains the following information: [source,role=noheader] ---- -neo4j-admin backup inspect [-h] [--empty] [--expand-commands] [--latest-backup] - [--latest-chain] [--show-metadata] [--verbose] - [--additional-config=] [--database=] - [--format=] +neo4j-admin backup inspect [-h] [--empty] [--expand-commands] [--latest-backup] [--latest-chain] + [--verbose] [--additional-config=] [--database=] [--format=] + ---- +[NOTE] +==== +Starting with Neo4j 2025.07, the backup metadata is always shown by default when using the `neo4j-admin backup inspect` command. +If you are on a previous version of Neo4j, you must specify the `--show-metadata` option to see the backup metadata. +==== + === Description Command to read the backup metadata. @@ -87,10 +92,6 @@ The `` parameter can also inspect backups stored in AWS S3 buckets, | List the full backup chain ending with the latest downloaded backup. | false -| --show-metadata -| Show the backup metadata. -| false - | --database= | Name of the database to inspect. | @@ -113,6 +114,12 @@ The `` parameter can also inspect backups stored in AWS S3 buckets, The `--latest-backup` and `--latest-chain` options cannot be used together. ==== +[NOTE] +==== +Starting with Neo4j 2025.07, the `--show-metadata` option is deprecated and ignored. +The backup metadata is always shown by default when using the `neo4j-admin backup inspect` command. +However, if you are on a previous version of Neo4j, you must specify the `--show-metadata` option to see the backup metadata. +==== [[aggregate-backup-example]] == Examples @@ -140,7 +147,7 @@ The following command lists the backup files' names along with their respective [source,shell] ---- -bin/neo4j-admin backup inspect /backups --show-metadata --empty +bin/neo4j-admin backup inspect /backups --empty ---- The `--empty` option is used to include the empty backups. @@ -163,13 +170,19 @@ Empty backups are used to record the backup history. | file:///backups/london-2024-10-07T16-03-51.backup | london | d4dae73c-dfef-4d28-88cd-fe6cc88ddca1 | 2024-10-07T16:03:51 | true | true | 1 | 5 | true | ---- +[NOTE] +==== +Starting with Neo4j 2025.07, the backup metadata is always shown by default when using the `neo4j-admin backup inspect` command. +If you are on a previous version of Neo4j, you must specify the `--show-metadata` option to see the backup metadata. +==== + === Listing the latest backups To list only the most recent backups performed for each database, use the `--latest-backup` option. [source,shell] ---- -bin/neo4j-admin backup inspect /backups --show-metadata --latest-backup +bin/neo4j-admin backup inspect /backups --latest-backup ---- .Example output @@ -181,6 +194,12 @@ bin/neo4j-admin backup inspect /backups --show-metadata --latest-backup | file:///backups/london-2024-10-07T16-04-05.backup | london | d4dae73c-dfef-4d28-88cd-fe6cc88ddca1 | 2024-10-07T16:04:05 | false | true | 6 | 6 | false | ---- +[NOTE] +==== +Starting with Neo4j 2025.07, the backup metadata is always shown by default when using the `neo4j-admin backup inspect` command. +If you are on a previous version of Neo4j, you must specify the `--show-metadata` option to see the backup metadata. +==== + === Inspecting backup chains A backup chain corresponds to a sequence of one or more backup(s) logically connected by their transaction IDs. @@ -188,7 +207,7 @@ To inspect the backup chains of a given database, use the `--latest-chain` optio [source,shell] ---- -bin/neo4j-admin backup inspect /backups --show-metadata --latest-chain --database=london +bin/neo4j-admin backup inspect /backups --latest-chain --database=london ---- .Example output @@ -206,6 +225,11 @@ The result returns a chain of size two: Those modifications are materialised by a sequence of transactions to apply. Its range is [6,6]. +[NOTE] +==== +Starting with Neo4j 2025.07, the backup metadata is always shown by default when using the `neo4j-admin backup inspect` command. +If you are on a previous version of Neo4j, you must specify the `--show-metadata` option to see the backup metadata. +==== === Inspecting a backup chain ending with a specific backup @@ -213,7 +237,7 @@ To inspect a backup chain ending with a specific backup, use the `--latest-chain [source,shell] ---- -bin/neo4j-admin backup inspect /backups/london-2024-10-07T16-04-05.backup --show-metadata --latest-chain +bin/neo4j-admin backup inspect /backups/london-2024-10-07T16-04-05.backup --latest-chain ---- .Example output @@ -229,6 +253,12 @@ bin/neo4j-admin backup inspect /backups/london-2024-10-07T16-04-05.backup --sho In this case, the `--database` option is unnecessary because the database identifier is part of the metadata stored in the header of the backup file _london-2024-10-07T16-04-05.backup_. ==== +[NOTE] +==== +Starting with Neo4j 2025.07, the backup metadata is always shown by default when using the `neo4j-admin backup inspect` command. +If you are on a previous version of Neo4j, you must specify the `--show-metadata` option to see the backup metadata. +==== + diff --git a/modules/ROOT/pages/configuration/configuration-settings.adoc b/modules/ROOT/pages/configuration/configuration-settings.adoc index 760651b71..035d5254b 100644 --- a/modules/ROOT/pages/configuration/configuration-settings.adoc +++ b/modules/ROOT/pages/configuration/configuration-settings.adoc @@ -184,6 +184,22 @@ a|An integer. m|+++600+++ |=== + +[role=label--new-2025.07 label--dynamic] +[[config_db.checkpoint.throughput.limit]] +=== `db.checkpoint.throughput.limit` + +.db.checkpoint.throughput.limit +[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"] +|=== +|Description +a|Limit the write throughput per second of the background checkpoint process. This setting is advisory. It is ignored in Neo4j Community Edition and is followed to best effort in Enterprise Edition. Limiting the write IO in this way leaves more bandwidth in the IO subsystem to service random-read IOs, which is important for the response time of queries when the database cannot fit entirely in memory. The only drawback of this setting is that longer checkpoint times may lead to slightly longer recovery times in case of a database or system crash. A lower number means lower IO pressure and, consequently, longer checkpoint times. Set this to null to disable the throughput limit and fallback to IOPS limit. +|Valid values +a|A byte size (valid multipliers are B, KiB, KB, K, kB, kb, k, MiB, MB, M, mB, mb, m, GiB, GB, G, gB, gb, g, TiB, TB, PiB, PB, EiB, EB) that is minimum 8.00KiB. +|Default value +m|++++++ +|=== + == Cloud storage integration settings Cloud integration settings allow you to specify custom Azure blob storage endpoints and host authorities, set the project ID for Google Cloud Storage buckets, and define the desired throughput for transfer operations in Amazon S3. @@ -1825,7 +1841,7 @@ For more information, see xref:/performance/statistics-execution-plans.adoc[Stat |Description a|The default language of a database determines which language is used to evaluate queries that do not explicitly select a language. This setting determines the default language used for new (and initial) databases where not specified as part of `CREATE` or `ALTER` database. |Valid values -a|One of [CYPHER_5, CYPHER_25] that the [] values acceptance depend on 'internal.dbms.cypher.enable_experimental_versions'. +a|One of [CYPHER_5, CYPHER_25]. label:changed[Changed in 2025.07] |Default value m|+++CYPHER_5+++ |=== diff --git a/modules/ROOT/pages/configuration/dynamic-settings.adoc b/modules/ROOT/pages/configuration/dynamic-settings.adoc index 5404ed39e..5828f1bcb 100644 --- a/modules/ROOT/pages/configuration/dynamic-settings.adoc +++ b/modules/ROOT/pages/configuration/dynamic-settings.adoc @@ -36,6 +36,7 @@ RETURN name | name | +----------------------------------------------------------------+ | "db.checkpoint.iops.limit" | +| "db.checkpoint.throughput.limit" | | "db.format" | | "db.lock.acquisition.timeout" | | "db.logs.query.annotation_data_format" | diff --git a/modules/ROOT/pages/import.adoc b/modules/ROOT/pages/import.adoc index bdedd2756..abcbc78bf 100644 --- a/modules/ROOT/pages/import.adoc +++ b/modules/ROOT/pages/import.adoc @@ -1463,8 +1463,9 @@ Now use the previously defined ID spaces when connecting the actors to movies. [[import-tool-multiple-ids]] == Using multiple node IDs -A node header can also contain multiple `ID` columns, where the relationship data references the composite value of all those columns. -This also implies using `string` as `id-type`. +A node header can contain multiple `ID` columns. +The relationship data must then use a matching number of `START_ID` / `END_ID` columns as references to the composite value of those ID columns. +This implies using `string` as `id-type`. For each `ID` column, you can specify to store its values as different node properties. However, the composite value cannot be stored as a node property. @@ -1499,13 +1500,13 @@ Now use both IDs when defining the relationship: .relationships_header.csv [source, csv] ---- -:START_ID,:TYPE,:END_ID +:START_ID,:START_ID,:TYPE,:END_ID,:END_ID ---- .relationships.csv [source, csv] ---- -aa11,WORKS_WITH,bb22 +aa,11,WORKS_WITH,bb,22 ---- ==== @@ -1533,13 +1534,13 @@ Now use the defined ID space when connecting John with Paul, and use both IDs in .relationships_header.csv [source, csv] ---- -:START_ID(MyGroup),:TYPE,:END_ID(MyGroup) +:START_ID(MyGroup),:START_ID(MyGroup),:TYPE,:END_ID(MyGroup),:END_ID(MyGroup) ---- .relationships.csv [source, csv] ---- -aa11,WORKS_WITH,bb22 +aa,11,WORKS_WITH,bb,22 ---- ==== diff --git a/modules/ROOT/pages/monitoring/metrics/reference.adoc b/modules/ROOT/pages/monitoring/metrics/reference.adoc index 12e003d8a..80d5ad3c9 100644 --- a/modules/ROOT/pages/monitoring/metrics/reference.adoc +++ b/modules/ROOT/pages/monitoring/metrics/reference.adoc @@ -464,6 +464,7 @@ This is not an indication of an error of any kind. |.cluster.raft.raft_log_entry_prefetch_buffer.sync_put|Raft Log Entry Prefetch buffer sync puts. (gauge) |.cluster.raft.message_processing_delay|Delay between receiving a Raft message and starting its processing. (gauge) +|.cluster.raft.message_processing_delay_timer|label:new[Introduced in 2025.07] Metrics Timer for Raft message processing delays. The Timer provides different types of statistics, for example, `min`, `max`, `p999`, and `mean_rate`. (counter, histogram) |.cluster.raft.message_processing_timer|Metrics Timer for Raft message processing, independent of the message type. The Timer provides different types of statistics, for example, `min`, `max`, `p999`, and `mean_rate`. (counter, histogram) |.cluster.raft.replication_new|The total number of Raft replication requests. It increases with write transactions (possibly internal) activity. (counter) |.cluster.raft.replication_attempt|The total number of Raft replication requests attempts. It is bigger or equal to the replication requests. (counter)