diff --git a/modules/ROOT/pages/procedures.adoc b/modules/ROOT/pages/procedures.adoc index 2a5541df5..4736e11fa 100644 --- a/modules/ROOT/pages/procedures.adoc +++ b/modules/ROOT/pages/procedures.adoc @@ -674,9 +674,9 @@ It will still run with the `Admin` privilege, but that should be considered depr | `address` | `STRING` | address :: STRING | `replicationSuccessful` | `BOOLEAN` | replicationSuccessful :: BOOLEAN | `memberStatus` | `STRING` | memberStatus :: STRING -| `recognisedLeader` | `STRING` | recognisedLeaderTerm :: INTEGER -| `recognisedLeaderTerm` | `STRING` | requester :: BOOLEAN -| `requester` | `STRING` | requester :: BOOLEAN +| `recognisedLeader` | `STRING` | recognisedLeader :: STRING +| `recognisedLeaderTerm` | `INTEGER` | recognisedLeaderTerm :: INTEGER +| `requester` | `BOOLEAN` | requester :: BOOLEAN | `error` | `STRING` | error :: STRING | *Mode* 3+| DBMS |=== @@ -932,7 +932,7 @@ For more information, see xref:monitoring/connection-management.adoc[]. | *Description* 3+a| List all accepted network connections at this instance that are visible to the user. .8+| *Return arguments* | *Name* | *Type* | *Description* | `connectionId` | `STRING` | The id of the connection. -| `connectTime` | `STRING` | The time the connection was established. +| `connectTime` | `STRING` | The time the connection was established, formatted according to the ISO-8601 Standard. | `connector` | `STRING` | The protocol of the connector. | `username` | `STRING` | The username of the connected user. | `userAgent` | `STRING` | The active agent. @@ -1013,7 +1013,7 @@ For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-ver .4+| *Return arguments* | *Name* | *Type* | *Description* | `id` | `STRING` | The id of the database. | `name` | `STRING` | The name of the database. -| `creationDate` | `STRING` | The creation date of the database. +| `creationDate` | `STRING` | The creation date of the database, formatted according to the ISO-8601 Standard. | *Mode* 3+| READ |=== @@ -1321,7 +1321,7 @@ The similarity score is a value between [0, 1]; where 0 indicates least similar, | `query` | `ANY` | The object to find approximate matches for. .3+| *Return arguments* | *Name* | *Type* | *Description* | `relationship` | `RELATIONSHIP` | A relationship which contains a vector property similar to the query object. -| `score` | `FLOAT` | The score measuring how similar the node property is to the query object. +| `score` | `FLOAT` | The score measuring how similar the relationship property is to the query object. | *Mode* 3+| READ |=== @@ -1344,7 +1344,7 @@ For each element in the given resource LIST this returns: .4+| *Input arguments* | *Name* | *Type* | *Description* | `resources` | `LIST` | The object to transform into an embedding. | `provider` | `STRING` | The GenAI provider to use. -| `configuration` | `MAP` | The provider specific settings. +| `configuration` | `ANY` | The provider specific settings. .4+| *Return arguments* | *Name* | *Type* | *Description* | `index` | `INTEGER` | The index of the corresponding element in the input list. | `resource` | `STRING` | The name of the input resource. @@ -1397,7 +1397,7 @@ For more information, see: | *Description* 3+a| Wait for an index to come online (for example: CALL db.awaitIndex("MyIndex", 300)). .3+| *Input arguments* | *Name* | *Type* | *Description* | `indexName` | `STRING` | The name of the awaited index. -| `timeOutSeconds` | `INTEGER` | The maximum time to wait. +| `timeOutSeconds` | `INTEGER` | The maximum time to wait in seconds. | *Mode* 3+| READ |=== @@ -1417,7 +1417,7 @@ For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-ver | *Syntax* 3+m| db.awaitIndexes([ timeOutSeconds ]) | *Description* 3+a| Wait for all indexes to come online (for example: CALL db.awaitIndexes(300)). .2+| *Input arguments* | *Name* | *Type* | *Description* -| `timeOutSeconds` | `INTEGER` | The maximum time to wait. +| `timeOutSeconds` | `INTEGER` | The maximum time to wait in seconds. | *Mode* 3+| READ |=== @@ -1474,7 +1474,7 @@ The `options` map and any of the keys are optional. An example of the `options` map: `{skip: 30, limit: 10, analyzer: 'whitespace'}` .4+| *Input arguments* | *Name* | *Type* | *Description* -| `indexName` | `STRING` | The name of the fulltext index. +| `indexName` | `STRING` | The name of the full-text index. | `queryString` | `STRING` | The string to find approximate matches for. | `options` | `MAP` | {skip :: INTEGER, limit :: INTEGER, analyzer :: STRING} .3+| *Return arguments* | *Name* | *Type* | *Description* @@ -1501,12 +1501,12 @@ The `options` map and any of the keys are optional. An example of the `options` map: `{skip: 30, limit: 10, analyzer: 'whitespace'}` .4+| *Input arguments* | *Name* | *Type* | *Description* -| `indexName` | `STRING` | The name of the fulltext index. +| `indexName` | `STRING` | The name of the full-text index. | `queryString` | `STRING` | The string to find approximate matches for. | `options` | `MAP` | {skip :: INTEGER, limit :: INTEGER, analyzer :: STRING} .3+| *Return arguments* | *Name* | *Type* | *Description* | `relationship` | `RELATIONSHIP` | A relationship which contains a property similar to the query string. -| `score` | `FLOAT` | The score measuring how similar the node property is to the query string. +| `score` | `FLOAT` | The score measuring how similar the relationship property is to the query string. | *Mode* 3+| READ |=== @@ -1650,7 +1650,7 @@ For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-ver | *Syntax* 3+m| db.createLabel(newLabel) | *Description* 3+a| Create a label .2+| *Input arguments* | *Name* | *Type* | *Description* -| `newLabel` | `STRING` | A new label. +| `newLabel` | `STRING` | Label name. | *Mode* 3+| WRITE |=== @@ -1663,7 +1663,7 @@ For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-ver | *Syntax* 3+m| db.createProperty(newProperty) | *Description* 3+a| Create a Property .2+| *Input arguments* | *Name* | *Type* | *Description* -| `newProperty` | `STRING` | A new property. +| `newProperty` | `STRING` | Property name. | *Mode* 3+| WRITE |=== @@ -1676,7 +1676,7 @@ For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-ver | *Syntax* 3+m| db.createRelationshipType(newRelationshipType) | *Description* 3+a| Create a RelationshipType .2+| *Input arguments* | *Name* | *Type* | *Description* -| `newRelationshipType` | `STRING` | A new relationship type. +| `newRelationshipType` | `STRING` | Relationship type name. | *Mode* 3+| WRITE |=== @@ -1748,7 +1748,7 @@ For more information, see xref:performance/statistics-execution-plans.adoc[] | *Syntax* 3+m| db.clearQueryCaches() :: (value) | *Description* 3+a| Clears all query caches. .2+| *Return arguments* | *Name* | *Type* | *Description* -| `value` | `STRING` | The number of cleared query caches. +| `value` | `STRING` | Information about the number of cleared query caches. | *Mode* 3+| DBMS |=== @@ -1762,7 +1762,7 @@ For more information, see xref:performance/statistics-execution-plans.adoc[] | *Syntax* 3+m| db.prepareForReplanning([ timeOutSeconds ]) | *Description* 3+a| Triggers an index resample and waits for it to complete, and after that clears query caches. After this procedure has finished queries will be planned using the latest database statistics. .2+| *Input arguments* | *Name* | *Type* | *Description* -| `timeOutSeconds` | `INTEGER` | The maximum time to wait. +| `timeOutSeconds` | `INTEGER` | The maximum time to wait in seconds. | *Mode* 3+| READ |=== @@ -1783,7 +1783,7 @@ For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-ver | *Syntax* 3+m| db.stats.clear(section) :: (section, success, message) | *Description* 3+a| Clear collected data of a given data section. Valid sections are 'QUERIES' .2+| *Input arguments* | *Name* | *Type* | *Description* -| `section` | `STRING` | Specify 'QUERIES'. +| `section` | `STRING` | The section to clear. The only available section is: 'QUERIES'. .4+| *Return arguments* | *Name* | *Type* | *Description* | `section` | `STRING` | The section cleared. | `success` | `BOOLEAN` | Whether the section was successfully cleared. @@ -1801,8 +1801,8 @@ For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-ver | *Syntax* 3+m| db.stats.collect(section [, config ]) :: (section, success, message) | *Description* 3+a| Start data collection of a given data section. Valid sections are 'QUERIES' .3+| *Input arguments* | *Name* | *Type* | *Description* -| `section` | `STRING` | Specify 'QUERIES'. -| `config` | `MAP` | A map containing a single key `durationSeconds` (default value of -1). +| `section` | `STRING` | The section to collect. The only available section is: 'QUERIES'. +| `config` | `MAP` | {durationSeconds = -1 INTEGER} .4+| *Return arguments* | *Name* | *Type* | *Description* | `section` | `STRING` | The section collected. | `success` | `BOOLEAN` | Whether the section was successfully collected. @@ -1821,7 +1821,7 @@ For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-ver | *Description* 3+a| Retrieve statistical data about the current database. Valid sections are 'GRAPH COUNTS', 'TOKENS', 'QUERIES', 'META' .3+| *Input arguments* | *Name* | *Type* | *Description* | `section` | `STRING` | A section of stats to retrieve: ('GRAPH COUNTS', 'TOKENS', 'QUERIES', 'META'). -| `config` | `MAP` | A map containing a single key `maxInvocations` (default value of 100). +| `config` | `MAP` | {maxInvocations = 100 INTEGER} .3+| *Return arguments* | *Name* | *Type* | *Description* | `section` | `STRING` | The section retrieved. | `data` | `MAP` | Data pertaining to the retrieved statistics. @@ -1839,7 +1839,7 @@ For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-ver | *Description* 3+a| Retrieve all available statistical data about the current database, in an anonymized form. .3+| *Input arguments* | *Name* | *Type* | *Description* | `graphToken` | `STRING` | The name of the graph token. -| `config` | `MAP` | A map containing a single key `maxInvocations` (default value of 100). +| `config` | `MAP` | {maxInvocations = 100 INTEGER} .3+| *Return arguments* | *Name* | *Type* | *Description* | `section` | `STRING` | The section retrieved. | `data` | `MAP` | Data pertaining to the retrieved statistics. @@ -1874,7 +1874,7 @@ For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-ver | *Syntax* 3+m| db.stats.stop(section) :: (section, success, message) | *Description* 3+a| Stop data collection of a given data section. Valid sections are 'QUERIES' .2+| *Input arguments* | *Name* | *Type* | *Description* -| `section` | `STRING` | Specify 'QUERIES'. +| `section` | `STRING` | The section to stop. The only available section is: 'QUERIES'. .4+| *Return arguments* | *Name* | *Type* | *Description* | `section` | `STRING` | The stopped section. | `success` | `BOOLEAN` | Whether the section was successfully stopped.