Cherry-picked SHOW command PRs#3080
Conversation
Co-authored-by: Therese Magnusson <scout.therese@gmail.com> Co-authored-by: Reneta Popova <reneta.popova@neo4j.com>
Co-authored-by: Reneta Popova <reneta.popova@neo4j.com> Co-authored-by: Therese Magnusson <scout.therese@gmail.com>
See corresponding Cypher Manual PR: neo4j/docs-cypher#1531 --------- Co-authored-by: Reneta Popova <reneta.popova@neo4j.com> Co-authored-by: Therese Magnusson <scout.therese@gmail.com>
Hunterness
left a comment
There was a problem hiding this comment.
I have two files left to review but I'll post the comments I have so far
renetapopova
left a comment
There was a problem hiding this comment.
Added some comments. Thank you, @JPryce-Aklundh!
| :page-role: not-on-aura new-5.6 | ||
| = Show configuration settings | ||
|
|
||
| This page describes listing configuration settings using the `SHOW SETTINGS` command. |
There was a problem hiding this comment.
This link will go to the current Cypher 25 version.
| = Show configuration settings | ||
|
|
||
| This page describes listing configuration settings using the `SHOW SETTINGS` command. | ||
| For general information about the `SHOW` command, see the link:{neo4j-docs-base-uri}/cypher-manual/clauses/show/[Cypher Manual -> SHOW]. |
There was a problem hiding this comment.
| For general information about the `SHOW` command, see the link:{neo4j-docs-base-uri}/cypher-manual/clauses/show/[Cypher Manual -> SHOW]. | |
| For general information about the `SHOW` command, see the link:{neo4j-docs-base-uri}/cypher-manual/5/clauses/show/[Cypher Manual -> SHOW]. |
|
|
||
| | isDynamic | ||
| | Whether the value of the setting can be updated dynamically, without restarting the server. | ||
| For dynamically updating a setting value, see link:{neo4j-docs-base-uri}/operations-manual/current/configuration/dynamic-settings/[Update dynamic settings]. |
There was a problem hiding this comment.
| For dynamically updating a setting value, see link:{neo4j-docs-base-uri}/operations-manual/current/configuration/dynamic-settings/[Update dynamic settings]. | |
| For dynamically updating a setting value, see xref:configuration/dynamic-settings.adoc[Update dynamic settings]. |
| | | ||
|
|
||
| | isDeprecated | ||
| | Whether the setting is deprecated. |
There was a problem hiding this comment.
| | Whether the setting is deprecated. | |
| | label:new[Introduced in 5.9] Whether the setting is deprecated. |
|
|
||
| The transaction settings help you manage the transactions in your database, for example, the transaction timeout, the maximum number of concurrently running transactions, how much time to allow Neo4j to wait for running transactions to complete before allowing initiated database shutdown to continue, and so on. | ||
| For all available settings, see xref:/configuration/configuration-settings.adoc#_transaction_settings[Transaction settings]. | ||
| For more information on how to show and terminate transactions, see xref:/database-internals/show-and-terminate-transactions.adoc[Show and terminate transactions]. |
There was a problem hiding this comment.
| For more information on how to show and terminate transactions, see xref:/database-internals/show-and-terminate-transactions.adoc[Show and terminate transactions]. | |
| For more information on how to show and terminate transactions, see xref:database-internals/show-and-terminate-transactions.adoc[Show and terminate transactions]. |
| = Show procedures | ||
|
|
||
| You can use `SHOW PROCEDURES` to list all available procedures. | ||
| For general information about the `SHOW` command, see the link:{neo4j-docs-base-uri}/cypher-manual/clauses/show/[Cypher Manual -> SHOW]. |
There was a problem hiding this comment.
| For general information about the `SHOW` command, see the link:{neo4j-docs-base-uri}/cypher-manual/clauses/show/[Cypher Manual -> SHOW]. | |
| For general information about the `SHOW` command, see the link:{neo4j-docs-base-uri}/cypher-manual/5/clauses/show/[Cypher Manual -> SHOW]. |
|
|
||
| | rolesExecution | ||
| | List of roles permitted to execute this procedure. | ||
| Is `null` without the link:https://neo4j.com/docs/operations-manual/current/authentication-authorization/dbms-administration/dbms-role-management-privileges/#_grant_privilege_to_show_roles[`SHOW ROLE`] privilege. |
There was a problem hiding this comment.
| Is `null` without the link:https://neo4j.com/docs/operations-manual/current/authentication-authorization/dbms-administration/dbms-role-management-privileges/#_grant_privilege_to_show_roles[`SHOW ROLE`] privilege. | |
| Is `null` without the xref:authentication-authorization/dbms-administration/dbms-role-management-privileges.adoc#_grant_privilege_to_show_roles[`SHOW ROLE`] privilege. |
|
|
||
| | rolesBoostedExecution | ||
| | List of roles permitted to use boosted mode when executing this procedure. | ||
| Is `null` without the link:https://neo4j.com/docs/operations-manual/current/authentication-authorization/dbms-administration/dbms-role-management-privileges/#_grant_privilege_to_show_roles[`SHOW ROLE`] privilege. |
There was a problem hiding this comment.
| Is `null` without the link:https://neo4j.com/docs/operations-manual/current/authentication-authorization/dbms-administration/dbms-role-management-privileges/#_grant_privilege_to_show_roles[`SHOW ROLE`] privilege. | |
| Is `null` without the xref:authentication-authorization/dbms-administration/dbms-role-management-privileges.adoc#_grant_privilege_to_show_roles[`SHOW ROLE`] privilege. |
| . Reconfigure the database topology to a single primary by running the xref:procedures.adoc#procedure_dbms_cluster_recreateDatabase[`dbms.cluster.recreateDatabase()`] procedure. | ||
| . Then stop the database using xref:database-administration/standard-databases/create-databases.adoc#manage-databases-stop[STOP DATABASE]. | ||
| . Reconfigure the database topology to a single primary by running the xref:procedures/built-in-procedures.adoc#procedure_dbms_cluster_recreateDatabase[`dbms.recreateDatabase()`] procedure. | ||
| . Then stop the database using xref::database-administration/standard-databases/create-databases.adoc#manage-databases-stop[STOP DATABASE]. |
There was a problem hiding this comment.
| . Then stop the database using xref::database-administration/standard-databases/create-databases.adoc#manage-databases-stop[STOP DATABASE]. | |
| . Then stop the database using xref:database-administration/standard-databases/create-databases.adoc#manage-databases-stop[STOP DATABASE]. |
Hunterness
left a comment
There was a problem hiding this comment.
Last files reviewed, most comments are on the fact that some defaults and column types got updated in Cypher 25 so we should keep the old Cypher 5 values here (I think I caught all but might be good to double check)
renetapopova
left a comment
There was a problem hiding this comment.
A few more comments
|
|
||
| A server in the _cordoned_ state can be transitioned to _deallocating_ state or back to _enabled_. | ||
| To re-enable a server, run the `ENABLE SERVER` command. | ||
| You can also use the xref:procedures/built-in-procedures.adoc#procedure_dbms_cluster_uncordonServer[`dbms.cluster.uncordonServer()`] procedure. |
There was a problem hiding this comment.
| You can also use the xref:procedures/built-in-procedures.adoc#procedure_dbms_cluster_uncordonServer[`dbms.cluster.uncordonServer()`] procedure. |
There was a problem hiding this comment.
You want it removed completely?
The original page had this sentence following instead:
"However, note that the procedure is deprecated in Neo4j 5.23."
There was a problem hiding this comment.
Let's keep the original sentences:
You can also use the xref:procedures/built-in-procedures.adoc#procedure_dbms_cluster_uncordonServer[`dbms.cluster.uncordonServer()`] procedure.
However, note that the procedure is deprecated in Neo4j 5.23.
There was a problem hiding this comment.
Ah, this was a mistake on my part. Reneta only highlighted that line 125 was a duplication 🥴
| The `SHOW TRANSACTIONS` command displays currently running transactions across the instance. | ||
| To track transactions on remote database aliases, run `SHOW TRANSACTIONS` while connected to the remote database alias. | ||
|
|
||
| A user with the link:{neo4j-docs-base-uri}/operations-manual/current/authentication-authorization/database-administration/#access-control-database-administration-transaction[`SHOW TRANSACTION`] privilege can view currently executing transactions, but only to the extent allowed by their granted permissions. |
There was a problem hiding this comment.
| A user with the link:{neo4j-docs-base-uri}/operations-manual/current/authentication-authorization/database-administration/#access-control-database-administration-transaction[`SHOW TRANSACTION`] privilege can view currently executing transactions, but only to the extent allowed by their granted permissions. | |
| A user with the xref:authentication-authorization/database-administration.adoc#access-control-database-administration-transaction[`SHOW TRANSACTION`] privilege can view currently executing transactions, but only to the extent allowed by their granted permissions. |
|
|
||
| The `TERMINATE TRANSACTIONS` command is used to terminate running transactions by their IDs. | ||
|
|
||
| A user with the link:{neo4j-docs-base-uri}/operations-manual/current/authentication-authorization/database-administration/#access-control-database-administration-transaction[`TERMINATE TRANSACTION`] privilege can terminate transactions, subject to the scope of their granted permissions. |
There was a problem hiding this comment.
| A user with the link:{neo4j-docs-base-uri}/operations-manual/current/authentication-authorization/database-administration/#access-control-database-administration-transaction[`TERMINATE TRANSACTION`] privilege can terminate transactions, subject to the scope of their granted permissions. | |
| A user with the xref:authentication-authorization/database-administration.adoc#access-control-database-administration-transaction[`TERMINATE TRANSACTION`] privilege can terminate transactions, subject to the scope of their granted permissions. |
| @@ -29,6 +27,7 @@ This means that very large updates must be split into several transactions to av | |||
|
|
|||
| The transaction settings help you manage the transactions in your database, for example, the transaction timeout, the maximum number of concurrently running transactions, how much time to allow Neo4j to wait for running transactions to complete before allowing initiated database shutdown to continue, and so on. | |||
| For all available settings, see xref:/configuration/configuration-settings.adoc#_transaction_settings[Transaction settings]. | |||
There was a problem hiding this comment.
| For all available settings, see xref:/configuration/configuration-settings.adoc#_transaction_settings[Transaction settings]. | |
| For all available settings, see xref:configuration/configuration-settings.adoc#_transaction_settings[Transaction settings]. |
|
|
||
| For help on cypher please visit: | ||
| https://neo4j.com/docs/cypher-manual/current/ | ||
| https://neo4j.com/docs/cypher-manual/5/ |
There was a problem hiding this comment.
| https://neo4j.com/docs/cypher-manual/5/ | |
| link:{neo4j-docs-base-uri}/cypher-manual/5/ |
There was a problem hiding this comment.
This is part of a query-result?
There was a problem hiding this comment.
Let's keep the original line: https://neo4j.com/docs/cypher-manual/current/
See the source code: https://github.com/neo-technology/neo4j/blob/5.26/public/community/cypher-shell/cypher-shell/src/main/java/org/neo4j/shell/commands/Help.java#L34
| * `LOAD CSV` Cypher statement can be used to import small to medium-sized CSV files into an existing database. | ||
| `LOAD CSV` can be run as many times as needed and does not require an empty database. | ||
| For details, see link:https://neo4j.com/docs/cypher-manual/current/clauses/load-csv/[Cypher manual -> `LOAD CSV`]. | ||
| For details, see link:https://neo4j.com/docs/cypher-manual/5/clauses/load-csv/[Cypher manual -> `LOAD CSV`]. |
There was a problem hiding this comment.
| For details, see link:https://neo4j.com/docs/cypher-manual/5/clauses/load-csv/[Cypher manual -> `LOAD CSV`]. | |
| For details, see link:{neo4j-docs-base-uri}/cypher-manual/5/clauses/load-csv/[Cypher manual -> `LOAD CSV`]. |
…actions.adoc Co-authored-by: Therese Magnusson <scout.therese@gmail.com>
|
This PR includes documentation updates New pages: Updated pages: |
Cherry-picks:
All content added post-LTS and any mention of Cypher 25 in the original PR's has been removed.