Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cherry-picks for 5.17 #1436

Merged
merged 10 commits into from
Feb 23, 2024
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.16'
neo4j-version-exact: '5.16.0'
neo4j-buildnumber: '5.16'
neo4j-debian-package-version: '1:5.14.0@'
neo4j-version-minor: '5.17'
neo4j-version-exact: '5.17.0'
neo4j-buildnumber: '5.17'
neo4j-debian-package-version: '1:5.17.0@'
16 changes: 16 additions & 0 deletions modules/ROOT/pages/configuration/configuration-settings.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -375,6 +375,22 @@ a|An integer that is minimum `2`.
m|+++3+++
|===

[[config_dbms.cluster.network.connect_timeout]]
=== `dbms.cluster.network.connect_timeout`

label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] label:new[Introduced in 5.17]

.dbms.cluster.network.connect_timeout
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
|===
|Description
a|The maximum amount of time to wait for a network connection to be established.
|Valid values
a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`).
|Default value
m|+++30s+++
|===

[[config_dbms.cluster.network.handshake_timeout]]
=== `dbms.cluster.network.handshake_timeout`

Expand Down
3 changes: 2 additions & 1 deletion modules/ROOT/pages/configuration/dynamic-settings.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ RETURN name
| "db.tx_log.preallocate" |
| "db.tx_log.rotation.retention_policy" |
| "db.tx_log.rotation.size" |
| "dbms.cluster.network.connect_timeout" |
| "dbms.cypher.render_plan_description" |
| "dbms.memory.transaction.total.max" |
| "dbms.routing.client_side.enforce_for_domains" |
Expand Down Expand Up @@ -87,7 +88,7 @@ RETURN name
| "server.memory.query_cache.shared_cache_num_entries" |
+----------------------------------------------------------------+

50 rows
51 rows
----
====

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/configuration/file-locations.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ File permissions:: Read only.
[[neo4j-products]]
=== Products

Description:: The JAR files of the Neo4j products: link:https://neo4j.com/docs/graph-data-science/current/[Graph Data Science Library] and link:https://neo4j.com/docs/bloom-user-guide/current/[Neo4j Bloom].
Description:: The JAR files of the Neo4j products: link:https://neo4j.com/docs/graph-data-science/current/[Graph Data Science Library], link:https://neo4j.com/docs/bloom-user-guide/current/[Neo4j Bloom], and link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/genai-integrations/[GenAI plugin].
The folder also contains a _README.txt_ file with information on enabling them.

File permissions:: Read only.
Expand Down
5 changes: 5 additions & 0 deletions modules/ROOT/pages/configuration/plugins.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ The following plugins are supported:
| {check-mark}
| link:{neo4j-docs-base-uri}/bloom-user-guide[Neo4j Bloom]

| GenAI
| `genai`
| {cross-mark}
| link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/genai-integrations/[Cypher Manual -> GenAI integrations].

| GraphQL
| `graphql`
| {cross-mark}
Expand Down
14 changes: 7 additions & 7 deletions modules/ROOT/pages/docker/introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ ____

=== Base operating system

The Neo4j image is available with either `debian:bullseye-slim` or `redhat/ubi8-minimal:latest` as the base image.
The Neo4j image is available with either `debian:bullseye-slim` or `redhat/ubi9-minimal:latest` as the base image.
The default is `debian:bullseye-slim`.

[TIP]
Expand All @@ -44,16 +44,16 @@ If you are unsure which base image to use or have no preference, just use the de
====


To specify which base image to use, the image tags optionally have a `-bullseye` or `-ubi8` suffix.
To specify which base image to use, the image tags optionally have a `-bullseye` or `-ubi9` suffix.

For example:

[source, subs="attributes"]
----
neo4j:{neo4j-version-exact}-bullseye # debian 11 community
neo4j:{neo4j-version-exact}-enterprise-bullseye # debian 11 enterprise
neo4j:{neo4j-version-exact}-ubi8 # redhat UBI8 community
neo4j:{neo4j-version-exact}-enterprise-ubi8 # redhat UBI8 enterprise
neo4j:{neo4j-version-exact}-ubi9 # redhat UBI9 community
neo4j:{neo4j-version-exact}-enterprise-ubi9 # redhat UBI9 enterprise
neo4j:{neo4j-version-exact} # debian 11 community
neo4j:{neo4j-version-exact}-enterprise # debian 11 enterprise
----
Expand All @@ -68,8 +68,8 @@ neo4j:{neo4j-version-exact}-enterprise # debian 11 enterprise
| `-bullseye`
| `debian:bullseye-slim`

| `-ubi8`
| `redhat/ubi8-minimal:latest`
| `-ubi9`
| `redhat/ubi9-minimal:latest`

| _unspecified_
| `debian:bullseye-slim`
Expand All @@ -78,7 +78,7 @@ neo4j:{neo4j-version-exact}-enterprise # debian 11 enterprise

[NOTE]
====
The Red Hat variant images are only available from 5.10.0 and onwards.
The Red Hat UBI9 variant images are only available from 5.17.0 and onwards.
For earlier Neo4j versions, do not specify a base image.
====

Expand Down
2 changes: 2 additions & 0 deletions modules/ROOT/pages/monitoring/metrics/reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,8 @@ By default, database metrics include:
|<prefix>.page_cache.pins|The total number of page pins executed by the page cache. (counter)
|<prefix>.page_cache.evictions|The total number of page evictions executed by the page cache. (counter)
|<prefix>.page_cache.evictions.cooperative|The total number of cooperative page evictions executed by the page cache due to low available pages. (counter)
|<prefix>.page_cache.eviction.flushes|label:new[Introduced in 5.17]The total number of pages flushed by page eviction. (counter)
|<prefix>.page_cache.eviction.cooperative.flushes|label:new[Introduced in 5.17]The total number of pages flushed by cooperative page eviction. (counter)
|<prefix>.page_cache.page_faults|The total number of page faults in the page cache. If this count keeps increasing over time, it may indicate that more page cache is required. However, note that when Neo4j Enterprise starts up, all page cache warmup activities result in page faults. Therefore, it is normal to observe a significant page fault count immediately after startup. (counter)
|<prefix>.page_cache.page_fault_failures|The total number of failed page faults happened in the page cache. (counter)
|<prefix>.page_cache.page_cancelled_faults|The total number of cancelled page faults happened in the page cache. (counter)
Expand Down
146 changes: 118 additions & 28 deletions modules/ROOT/pages/reference/procedures.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,20 +42,21 @@ For more information, see xref:authentication-authorization/dbms-administration.
| Enterprise Edition
| Comment

| xref:reference/procedures.adoc#procedure_cdc_current[`cdc.current()`]
| xref:reference/procedures.adoc#procedure_db_cdc_current[`db.cdc.current()`]
| label:no[]
| label:yes[]
| label:new[Introduced in 5.13] label:beta[]
| label:new[Introduced in 5.17] label:beta[]

| xref:reference/procedures.adoc#procedure_cdc_earliest[`cdc.earliest()`]
| xref:reference/procedures.adoc#procedure_db_cdc_earliest[`db.cdc.earliest()`]
| label:no[]
| label:yes[]
| label:new[Introduced in 5.13] label:beta[]
| label:new[Introduced in 5.17] label:beta[]

| xref:reference/procedures.adoc#procedure_cdc_query[`cdc.query()`]
| xref:reference/procedures.adoc#procedure_db_cdc_query[`db.cdc.query()`]
| label:no[]
| label:yes[]
| label:new[Introduced in 5.13] label:beta[] label:admin-only[]
| label:new[Introduced in 5.17] label:beta[] label:admin-only[]


| xref:reference/procedures.adoc#procedure_db_awaitindex[`db.awaitIndex()`]
| label:yes[]
Expand Down Expand Up @@ -83,11 +84,6 @@ For more information, see xref:authentication-authorization/dbms-administration.
| label:yes[]
| label:new[Introduced in 5.13] label:beta[]

| xref:reference/procedures.adoc#procedure_db_create_setVectorProperty[`db.create.setVectorProperty()`]
| label:yes[]
| label:yes[]
| label:new[Introduced in 5.11] label:beta[] label:deprecated[Deprecated in 5.13] Replaced by: xref:reference/procedures.adoc#procedure_db_create_setNodeVectorProperty[`db.create.setNodeVectorProperty()`]

| xref:reference/procedures.adoc#procedure_db_createlabel[`db.createLabel()`]
| label:yes[]
| label:yes[]
Expand Down Expand Up @@ -271,15 +267,6 @@ In 4.2, signature changed to `db.listLocks() :: (mode :: STRING, resourceType ::
| label:yes[]
|

// New in 4.2
// com.neo4j.causaulclustering.discovery.procedures.ReadReplicaToggleProcedure
label:deprecated[Deprecated in 5.6]
| xref:reference/procedures.adoc#procedure_dbms_cluster_readreplicatoggle[`dbms.cluster.readReplicaToggle()`]
| label:no[]
| label:yes[]
| label:admin-only[] label:deprecated[Deprecated in 5.6]. +
Replaced by: xref:reference/procedures.adoc#procedure_dbms_cluster_secondaryreplicationdisable[`dbms.cluster.secondaryReplicationDisable()`].

| xref:reference/procedures.adoc#procedure_dbms_cluster_secondaryreplicationdisable[`dbms.cluster.secondaryReplicationDisable()`]
| label:no[]
| label:yes[]
Expand Down Expand Up @@ -426,11 +413,11 @@ Replaced by: xref:reference/procedures.adoc#procedure_dbms_cluster_secondaryrepl
| label:yes[]
| label:admin-only[] label:deprecated[Deprecated in 5.9]

// New in 5.16 but only on Aura
// New in 5.16 on Aura, from Neo4j 5.17 also on-prem
| xref:reference/procedures.adoc#procedure_genai_vector_encodeBatch[`genai.vector.encodeBatch()`]
| label:no[]
| label:no[]
| label:aura-only[Available only on Aura]
| label:yes[]
| label:yes[]
| label:new[Available in Aura] label:new[Introduced in 5.17]

| xref:reference/procedures.adoc#procedure_tx_getmetadata[`tx.getMetaData()`]
| label:yes[]
Expand All @@ -445,6 +432,63 @@ Replaced by: xref:reference/procedures.adoc#procedure_dbms_cluster_secondaryrepl
|===


== List of deprecated procedures

.Deprecated Neo4j procedures
[options=header, cols="3m,1,1,3"]
|===
| Name
| Community Edition
| Enterprise Edition
| Comment

| xref:reference/procedures.adoc#procedure_cdc_current[`cdc.current()`]
| label:no[]
| label:yes[]
| label:new[Introduced in 5.13] label:beta[] label:deprecated[Deprecated in 5.17]
Replaced by: xref:reference/procedures.adoc#procedure_db_cdc_current[`db.cdc.current()`]

| xref:reference/procedures.adoc#procedure_cdc_earliest[`cdc.earliest()`]
| label:no[]
| label:yes[]
| label:new[Introduced in 5.13] label:beta[] label:deprecated[Deprecated in 5.17]
Replaced by: xref:reference/procedures.adoc#procedure_db_cdc_earliest[`db.cdc.earliest()`]

| xref:reference/procedures.adoc#procedure_cdc_query[`cdc.query()`]
| label:no[]
| label:yes[]
| label:new[Introduced in 5.13] label:beta[] label:deprecated[Deprecated in 5.17] label:admin-only[]
Replaced by: xref:reference/procedures.adoc#procedure_db_cdc_query[`db.cdc.query()`]

| xref:reference/procedures.adoc#procedure_db_create_setVectorProperty[`db.create.setVectorProperty()`]
| label:yes[]
| label:yes[]
| label:new[Introduced in 5.11] label:beta[] label:deprecated[Deprecated in 5.13] Replaced by: xref:reference/procedures.adoc#procedure_db_create_setNodeVectorProperty[`db.create.setNodeVectorProperty()`]

// New in 4.2
// com.neo4j.causaulclustering.discovery.procedures.ReadReplicaToggleProcedure
| xref:reference/procedures.adoc#procedure_dbms_cluster_readreplicatoggle[`dbms.cluster.readReplicaToggle()`]
| label:no[]
| label:yes[]
| label:admin-only[] label:deprecated[Deprecated in 5.6]. +
Replaced by: xref:reference/procedures.adoc#procedure_dbms_cluster_secondaryreplicationdisable[`dbms.cluster.secondaryReplicationDisable()`].

// New in 4.1
| xref:reference/procedures.adoc#procedure_dbms_upgrade[`dbms.upgrade()`]
| label:yes[]
| label:yes[]
| label:admin-only[] label:deprecated[Deprecated in 5.9]

// New in 4.1
| xref:reference/procedures.adoc#procedure_dbms_upgradestatus[`dbms.upgradeStatus()`]
| label:yes[]
| label:yes[]
| label:admin-only[] label:deprecated[Deprecated in 5.9]

|===



== List of removed procedures


Expand All @@ -455,6 +499,7 @@ Replaced by: xref:reference/procedures.adoc#procedure_dbms_cluster_secondaryrepl
| Community Edition
| Enterprise Edition
| Comment

| link:{neo4j-docs-base-uri}/operations-manual/4.4/reference/procedures/#procedure_db_constraints[`db.constraints()`]
| label:yes[]
| label:yes[]
Expand Down Expand Up @@ -725,7 +770,7 @@ Replaced by: `ALTER USER`.
== Procedure descriptions

[[procedure_cdc_current]]
.cdc.current() label:new[Introduced in 5.13] label:beta[]
.cdc.current() label:new[Introduced in 5.13] label:beta[] label:deprecated[Deprecated in 5.17]
[cols="<15s,<85"]
|===
| Description
Expand All @@ -735,10 +780,12 @@ Returns the current change identifier that can be used to stream changes from.
m|cdc.current() :: (id :: STRING)
| Mode
m|READ
| Replaced by
a|xref:reference/procedures.adoc#procedure_db_cdc_current[`db.cdc.current()`]
|===

[[procedure_cdc_earliest]]
.cdc.earliest() label:new[Introduced in 5.13] label:beta[]
.cdc.earliest() label:new[Introduced in 5.13] label:beta[] label:deprecated[Deprecated in 5.17]
[cols="<15s,<85"]
|===
| Description
Expand All @@ -748,10 +795,12 @@ Returns the earliest change identifier that can be used to stream changes from.
m|cdc.earliest() :: (id :: STRING)
| Mode
m|READ
| Replaced by
a|xref:reference/procedures.adoc#procedure_db_cdc_earliest[`db.cdc.earliest()`]
|===

[[procedure_cdc_query]]
.cdc.query() label:new[Introduced in 5.13] label:beta[] label:admin-only[]
.cdc.query() label:new[Introduced in 5.13] label:beta[] label:deprecated[Deprecated in 5.17] label:admin-only[]
[cols="<15s,<85"]
|===
| Description
Expand All @@ -761,9 +810,49 @@ Query changes happened from the provided change identifier.
m|cdc.query(from = :: STRING, selectors = [] :: LIST<MAP>) :: (id :: STRING, txId :: INTEGER, seq :: INTEGER, metadata :: MAP, event :: MAP)
| Mode
m|READ
| Replaced by
a|xref:reference/procedures.adoc#procedure_db_cdc_query[`db.cdc.query()`]
|===

[[procedure_db_cdc_current]]
.db.cdc.current() label:new[Introduced in 5.17] label:beta[]
[cols="<15s,<85"]
|===
| Description
a|
Returns the current change identifier that can be used to stream changes from.
| Signature
m|cdc.current() :: (id :: STRING)
| Mode
m|READ
|===

[[procedure_db_cdc_earliest]]
.db.cdc.earliest() label:new[Introduced in 5.17] label:beta[]
[cols="<15s,<85"]
|===
| Description
a|
Returns the earliest change identifier that can be used to stream changes from.
| Signature
m|cdc.earliest() :: (id :: STRING)
| Mode
m|READ
|===

[[procedure_db_cdc_query]]
.db.cdc.query() label:new[Introduced in 5.17] label:beta[] label:admin-only[]
[cols="<15s,<85"]
|===
| Description
a|
Query changes happened from the provided change identifier.
| Signature
m|cdc.query(from = :: STRING, selectors = [] :: LIST<MAP>) :: (id :: STRING, txId :: INTEGER, seq :: INTEGER, metadata :: MAP, event :: MAP)
| Mode
m|READ

|===

[[procedure_db_awaitindex]]
.db.awaitIndex()
Expand Down Expand Up @@ -2041,7 +2130,8 @@ For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-ver
====

[[procedure_genai_vector_encodeBatch]]
.genai.vector.encodeBatch() label:aura-only[Available only on Aura]
.genai.vector.encodeBatch() label:new[Available in Aura] label:new[Introduced in 5.17]

[cols="<15s,<85"]
|===
| Description
Expand Down
14 changes: 13 additions & 1 deletion modules/ROOT/pages/tools/cypher-shell.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ The Cypher Shell CLI is located in the `bin` directory if installed as part of t
[-P PARAM] [--non-interactive] [--sample-rows SAMPLE-ROWS]
[--wrap {true,false}] [-v] [--driver-version]
[-f FILE] [--change-password] [--log [LOG-FILE]]
[--fail-fast | --fail-at-end] [cypher]
[--history HISTORY-BEHAVIOUR]
[--notifications] [--fail-fast | --fail-at-end]
[cypher]
----

== Options
Expand Down Expand Up @@ -99,6 +101,16 @@ Displays the results in tabular format if you use the shell interactively and wi
|--log [LOG-FILE]
|Enable logging to the specified file, or standard error if the file is omitted.
|

|--history [HISTORY-BEHAVIOUR]
|File path of query and command history file or `in-memory` for in memory history.
Defaults to `<user home>/.neo4j/.cypher_shell_history`.
It can also be set using the environmental variable `NEO4J_CYPHER_SHELL_HISTORY`.
|

|--notifications
|Enable query notifications in interactive mode.
|off
|===

.Connection arguments
Expand Down
Loading
Loading