Skip to content

Commit 6a68669

Browse files
Fixes to Procedure tables (#1995)
1 parent df09816 commit 6a68669

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

modules/ROOT/pages/procedures.adoc

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -674,9 +674,9 @@ It will still run with the `Admin` privilege, but that should be considered depr
674674
| `address` | `STRING` | address :: STRING
675675
| `replicationSuccessful` | `BOOLEAN` | replicationSuccessful :: BOOLEAN
676676
| `memberStatus` | `STRING` | memberStatus :: STRING
677-
| `recognisedLeader` | `STRING` | recognisedLeaderTerm :: INTEGER
678-
| `recognisedLeaderTerm` | `STRING` | requester :: BOOLEAN
679-
| `requester` | `STRING` | requester :: BOOLEAN
677+
| `recognisedLeader` | `STRING` | recognisedLeader :: STRING
678+
| `recognisedLeaderTerm` | `INTEGER` | recognisedLeaderTerm :: INTEGER
679+
| `requester` | `BOOLEAN` | requester :: BOOLEAN
680680
| `error` | `STRING` | error :: STRING
681681
| *Mode* 3+| DBMS
682682
|===
@@ -932,7 +932,7 @@ For more information, see xref:monitoring/connection-management.adoc[].
932932
| *Description* 3+a| List all accepted network connections at this instance that are visible to the user.
933933
.8+| *Return arguments* | *Name* | *Type* | *Description*
934934
| `connectionId` | `STRING` | The id of the connection.
935-
| `connectTime` | `STRING` | The time the connection was established.
935+
| `connectTime` | `STRING` | The time the connection was established, formatted according to the ISO-8601 Standard.
936936
| `connector` | `STRING` | The protocol of the connector.
937937
| `username` | `STRING` | The username of the connected user.
938938
| `userAgent` | `STRING` | The active agent.
@@ -1013,7 +1013,7 @@ For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-ver
10131013
.4+| *Return arguments* | *Name* | *Type* | *Description*
10141014
| `id` | `STRING` | The id of the database.
10151015
| `name` | `STRING` | The name of the database.
1016-
| `creationDate` | `STRING` | The creation date of the database.
1016+
| `creationDate` | `STRING` | The creation date of the database, formatted according to the ISO-8601 Standard.
10171017
| *Mode* 3+| READ
10181018
|===
10191019

@@ -1321,7 +1321,7 @@ The similarity score is a value between [0, 1]; where 0 indicates least similar,
13211321
| `query` | `ANY` | The object to find approximate matches for.
13221322
.3+| *Return arguments* | *Name* | *Type* | *Description*
13231323
| `relationship` | `RELATIONSHIP` | A relationship which contains a vector property similar to the query object.
1324-
| `score` | `FLOAT` | The score measuring how similar the node property is to the query object.
1324+
| `score` | `FLOAT` | The score measuring how similar the relationship property is to the query object.
13251325
| *Mode* 3+| READ
13261326
|===
13271327

@@ -1344,7 +1344,7 @@ For each element in the given resource LIST this returns:
13441344
.4+| *Input arguments* | *Name* | *Type* | *Description*
13451345
| `resources` | `LIST<STRING>` | The object to transform into an embedding.
13461346
| `provider` | `STRING` | The GenAI provider to use.
1347-
| `configuration` | `MAP` | The provider specific settings.
1347+
| `configuration` | `ANY` | The provider specific settings.
13481348
.4+| *Return arguments* | *Name* | *Type* | *Description*
13491349
| `index` | `INTEGER` | The index of the corresponding element in the input list.
13501350
| `resource` | `STRING` | The name of the input resource.
@@ -1397,7 +1397,7 @@ For more information, see:
13971397
| *Description* 3+a| Wait for an index to come online (for example: CALL db.awaitIndex("MyIndex", 300)).
13981398
.3+| *Input arguments* | *Name* | *Type* | *Description*
13991399
| `indexName` | `STRING` | The name of the awaited index.
1400-
| `timeOutSeconds` | `INTEGER` | The maximum time to wait.
1400+
| `timeOutSeconds` | `INTEGER` | The maximum time to wait in seconds.
14011401
| *Mode* 3+| READ
14021402
|===
14031403

@@ -1417,7 +1417,7 @@ For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-ver
14171417
| *Syntax* 3+m| db.awaitIndexes([ timeOutSeconds ])
14181418
| *Description* 3+a| Wait for all indexes to come online (for example: CALL db.awaitIndexes(300)).
14191419
.2+| *Input arguments* | *Name* | *Type* | *Description*
1420-
| `timeOutSeconds` | `INTEGER` | The maximum time to wait.
1420+
| `timeOutSeconds` | `INTEGER` | The maximum time to wait in seconds.
14211421
| *Mode* 3+| READ
14221422
|===
14231423

@@ -1474,7 +1474,7 @@ The `options` map and any of the keys are optional.
14741474
An example of the `options` map: `{skip: 30, limit: 10, analyzer: 'whitespace'}`
14751475

14761476
.4+| *Input arguments* | *Name* | *Type* | *Description*
1477-
| `indexName` | `STRING` | The name of the fulltext index.
1477+
| `indexName` | `STRING` | The name of the full-text index.
14781478
| `queryString` | `STRING` | The string to find approximate matches for.
14791479
| `options` | `MAP` | {skip :: INTEGER, limit :: INTEGER, analyzer :: STRING}
14801480
.3+| *Return arguments* | *Name* | *Type* | *Description*
@@ -1501,12 +1501,12 @@ The `options` map and any of the keys are optional.
15011501
An example of the `options` map: `{skip: 30, limit: 10, analyzer: 'whitespace'}`
15021502

15031503
.4+| *Input arguments* | *Name* | *Type* | *Description*
1504-
| `indexName` | `STRING` | The name of the fulltext index.
1504+
| `indexName` | `STRING` | The name of the full-text index.
15051505
| `queryString` | `STRING` | The string to find approximate matches for.
15061506
| `options` | `MAP` | {skip :: INTEGER, limit :: INTEGER, analyzer :: STRING}
15071507
.3+| *Return arguments* | *Name* | *Type* | *Description*
15081508
| `relationship` | `RELATIONSHIP` | A relationship which contains a property similar to the query string.
1509-
| `score` | `FLOAT` | The score measuring how similar the node property is to the query string.
1509+
| `score` | `FLOAT` | The score measuring how similar the relationship property is to the query string.
15101510
| *Mode* 3+| READ
15111511
|===
15121512

@@ -1650,7 +1650,7 @@ For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-ver
16501650
| *Syntax* 3+m| db.createLabel(newLabel)
16511651
| *Description* 3+a| Create a label
16521652
.2+| *Input arguments* | *Name* | *Type* | *Description*
1653-
| `newLabel` | `STRING` | A new label.
1653+
| `newLabel` | `STRING` | Label name.
16541654
| *Mode* 3+| WRITE
16551655
|===
16561656

@@ -1663,7 +1663,7 @@ For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-ver
16631663
| *Syntax* 3+m| db.createProperty(newProperty)
16641664
| *Description* 3+a| Create a Property
16651665
.2+| *Input arguments* | *Name* | *Type* | *Description*
1666-
| `newProperty` | `STRING` | A new property.
1666+
| `newProperty` | `STRING` | Property name.
16671667
| *Mode* 3+| WRITE
16681668
|===
16691669

@@ -1676,7 +1676,7 @@ For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-ver
16761676
| *Syntax* 3+m| db.createRelationshipType(newRelationshipType)
16771677
| *Description* 3+a| Create a RelationshipType
16781678
.2+| *Input arguments* | *Name* | *Type* | *Description*
1679-
| `newRelationshipType` | `STRING` | A new relationship type.
1679+
| `newRelationshipType` | `STRING` | Relationship type name.
16801680
| *Mode* 3+| WRITE
16811681
|===
16821682

@@ -1748,7 +1748,7 @@ For more information, see xref:performance/statistics-execution-plans.adoc[]
17481748
| *Syntax* 3+m| db.clearQueryCaches() :: (value)
17491749
| *Description* 3+a| Clears all query caches.
17501750
.2+| *Return arguments* | *Name* | *Type* | *Description*
1751-
| `value` | `STRING` | The number of cleared query caches.
1751+
| `value` | `STRING` | Information about the number of cleared query caches.
17521752
| *Mode* 3+| DBMS
17531753
|===
17541754

@@ -1762,7 +1762,7 @@ For more information, see xref:performance/statistics-execution-plans.adoc[]
17621762
| *Syntax* 3+m| db.prepareForReplanning([ timeOutSeconds ])
17631763
| *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.
17641764
.2+| *Input arguments* | *Name* | *Type* | *Description*
1765-
| `timeOutSeconds` | `INTEGER` | The maximum time to wait.
1765+
| `timeOutSeconds` | `INTEGER` | The maximum time to wait in seconds.
17661766
| *Mode* 3+| READ
17671767
|===
17681768

@@ -1783,7 +1783,7 @@ For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-ver
17831783
| *Syntax* 3+m| db.stats.clear(section) :: (section, success, message)
17841784
| *Description* 3+a| Clear collected data of a given data section. Valid sections are 'QUERIES'
17851785
.2+| *Input arguments* | *Name* | *Type* | *Description*
1786-
| `section` | `STRING` | Specify 'QUERIES'.
1786+
| `section` | `STRING` | The section to clear. The only available section is: 'QUERIES'.
17871787
.4+| *Return arguments* | *Name* | *Type* | *Description*
17881788
| `section` | `STRING` | The section cleared.
17891789
| `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
18011801
| *Syntax* 3+m| db.stats.collect(section [, config ]) :: (section, success, message)
18021802
| *Description* 3+a| Start data collection of a given data section. Valid sections are 'QUERIES'
18031803
.3+| *Input arguments* | *Name* | *Type* | *Description*
1804-
| `section` | `STRING` | Specify 'QUERIES'.
1805-
| `config` | `MAP` | A map containing a single key `durationSeconds` (default value of -1).
1804+
| `section` | `STRING` | The section to collect. The only available section is: 'QUERIES'.
1805+
| `config` | `MAP` | {durationSeconds = -1 INTEGER}
18061806
.4+| *Return arguments* | *Name* | *Type* | *Description*
18071807
| `section` | `STRING` | The section collected.
18081808
| `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
18211821
| *Description* 3+a| Retrieve statistical data about the current database. Valid sections are 'GRAPH COUNTS', 'TOKENS', 'QUERIES', 'META'
18221822
.3+| *Input arguments* | *Name* | *Type* | *Description*
18231823
| `section` | `STRING` | A section of stats to retrieve: ('GRAPH COUNTS', 'TOKENS', 'QUERIES', 'META').
1824-
| `config` | `MAP` | A map containing a single key `maxInvocations` (default value of 100).
1824+
| `config` | `MAP` | {maxInvocations = 100 INTEGER}
18251825
.3+| *Return arguments* | *Name* | *Type* | *Description*
18261826
| `section` | `STRING` | The section retrieved.
18271827
| `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
18391839
| *Description* 3+a| Retrieve all available statistical data about the current database, in an anonymized form.
18401840
.3+| *Input arguments* | *Name* | *Type* | *Description*
18411841
| `graphToken` | `STRING` | The name of the graph token.
1842-
| `config` | `MAP` | A map containing a single key `maxInvocations` (default value of 100).
1842+
| `config` | `MAP` | {maxInvocations = 100 INTEGER}
18431843
.3+| *Return arguments* | *Name* | *Type* | *Description*
18441844
| `section` | `STRING` | The section retrieved.
18451845
| `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
18741874
| *Syntax* 3+m| db.stats.stop(section) :: (section, success, message)
18751875
| *Description* 3+a| Stop data collection of a given data section. Valid sections are 'QUERIES'
18761876
.2+| *Input arguments* | *Name* | *Type* | *Description*
1877-
| `section` | `STRING` | Specify 'QUERIES'.
1877+
| `section` | `STRING` | The section to stop. The only available section is: 'QUERIES'.
18781878
.4+| *Return arguments* | *Name* | *Type* | *Description*
18791879
| `section` | `STRING` | The stopped section.
18801880
| `success` | `BOOLEAN` | Whether the section was successfully stopped.

0 commit comments

Comments
 (0)