SHOW PROCEDURES
name | description | mode | worksOnSystem | |
---|---|---|---|---|
1 | "cdc.current" | "Returns the current change identifier that can be used to stream changes from." | "READ" | false |
2 | "cdc.earliest" | "Returns the earliest change identifier that can be used to stream changes from." | "READ" | false |
3 | "cdc.query" | "Query changes happened from the provided change identifier." | "READ" | false |
4 | "db.awaitIndex" | "Wait for an index to come online (for example: CALL db.awaitIndex("MyIndex", 300))." | "READ" | true |
5 | "db.awaitIndexes" | "Wait for all indexes to come online (for example: CALL db.awaitIndexes(300))." | "READ" | true |
6 | "db.cdc.current" | "Returns the current change identifier that can be used to stream changes from." | "READ" | false |
7 | "db.cdc.earliest" | "Returns the earliest change identifier that can be used to stream changes from." | "READ" | false |
8 | "db.cdc.query" | "Query changes happened from the provided change identifier." | "READ" | false |
9 | "db.checkpoint" | "Initiate and wait for a new check point, or wait any already on-going check point to complete. Note that this temporarily disables the `db.checkpoint.iops.limit` setting in order to make the check point complete faster. This might cause transaction throughput to degrade slightly, due to increased IO load." | "DBMS" | true |
10 | "db.clearQueryCaches" | "Clears all query caches." | "DBMS" | true |
11 | "db.create.setNodeVectorProperty" | "Set a vector property on a given node in a more space efficient representation than Cypher's SET." | "WRITE" | false |
12 | "db.create.setRelationshipVectorProperty" | "Set a vector property on a given relationship in a more space efficient representation than Cypher's SET." | "WRITE" | false |
13 | "db.create.setVectorProperty" | "Set a vector property on a given node in a more space efficient representation than Cypher's SET." | "WRITE" | false |
14 | "db.createLabel" | "Create a label" | "WRITE" | false |
15 | "db.createProperty" | "Create a Property" | "WRITE" | false |
16 | "db.createRelationshipType" | "Create a RelationshipType" | "WRITE" | false |
17 | "db.index.fulltext.awaitEventuallyConsistentIndexRefresh" | "Wait for the updates from recently committed transactions to be applied to any eventually-consistent full-text indexes." | "READ" | true |
18 | "db.index.fulltext.listAvailableAnalyzers" | "List the available analyzers that the full-text indexes can be configured with." | "READ" | true |
19 | "db.index.fulltext.queryNodes" | "Query the given full-text index. Returns the matching nodes and their Lucene query score, ordered by score. Valid _key: value_ pairs for the `options` map are: * 'skip' -- to skip the top N results. * 'limit' -- to limit the number of results returned. * 'analyzer' -- to use the specified analyzer as a search analyzer for this query. The `options` map and any of the keys are optional. An example of the `options` map: `{skip: 30, limit: 10, analyzer: 'whitespace'}` " | "READ" | true |
20 | "db.index.fulltext.queryRelationships" | "Query the given full-text index. Returns the matching relationships and their Lucene query score, ordered by score. Valid _key: value_ pairs for the `options` map are: * 'skip' -- to skip the top N results. * 'limit' -- to limit the number of results returned. * 'analyzer' -- to use the specified analyzer as a search analyzer for this query. The `options` map and any of the keys are optional. An example of the `options` map: `{skip: 30, limit: 10, analyzer: 'whitespace'}` " | "READ" | true |
21 | "db.index.vector.createNodeIndex" | "Create a named node vector index for the specified label and property with the given vector dimensionality using either the EUCLIDEAN or COSINE similarity function. Both similarity functions are case-insensitive. Use the `db.index.vector.queryNodes` procedure to query the named index. " | "SCHEMA" | false |
22 | "db.index.vector.queryNodes" | "Query the given node vector index. Returns requested number of nearest neighbors to the provided query vector, and their similarity score to that query vector, based on the configured similarity function for the index. The similarity score is a value between [0, 1]; where 0 indicates least similar, 1 most similar. " | "READ" | false |
23 | "db.index.vector.queryRelationships" | "Query the given relationship vector index. Returns requested number of nearest neighbors to the provided query vector, and their similarity score to that query vector, based on the configured similarity function for the index. The similarity score is a value between [0, 1]; where 0 indicates least similar, 1 most similar. " | "READ" | false |
24 | "db.info" | "Provides information regarding the database." | "READ" | true |
25 | "db.labels" | "List all labels attached to nodes within a database according to the user's access rights. The procedure returns empty results if the user is not authorized to view those labels." | "READ" | true |
26 | "db.listLocks" | "List all locks at this database." | "DBMS" | true |
27 | "db.ping" | "This procedure can be used by client side tooling to test whether they are correctly connected to a database. The procedure is available in all databases and always returns true. A faulty connection can be detected by not being able to call this procedure." | "READ" | true |
28 | "db.prepareForReplanning" | "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." | "READ" | true |
29 | "db.propertyKeys" | "List all property keys in the database." | "READ" | true |
30 | "db.relationshipTypes" | "List all types attached to relationships within a database according to the user's access rights. The procedure returns empty results if the user is not authorized to view those relationship types." | "READ" | true |
31 | "db.resampleIndex" | "Schedule resampling of an index (for example: CALL db.resampleIndex("MyIndex"))." | "READ" | true |
32 | "db.resampleOutdatedIndexes" | "Schedule resampling of all outdated indexes." | "READ" | true |
33 | "db.schema.nodeTypeProperties" | "Show the derived property schema of the nodes in tabular form." | "READ" | true |
34 | "db.schema.relTypeProperties" | "Show the derived property schema of the relationships in tabular form." | "READ" | true |
35 | "db.schema.visualization" | "Visualizes the schema of the data based on available statistics. A new node is returned for each label. The properties represented on the node include: `name` (label name), `indexes` (list of indexes), and `constraints` (list of constraints). A relationship of a given type is returned for all possible combinations of start and end nodes. The properties represented on the relationship include: `name` (type name). Note that this may include additional relationships that do not exist in the data due to the information available in the count store. " | "READ" | true |
36 | "db.stats.clear" | "Clear collected data of a given data section. Valid sections are 'QUERIES'" | "READ" | true |
37 | "db.stats.collect" | "Start data collection of a given data section. Valid sections are 'QUERIES'" | "READ" | true |
38 | "db.stats.retrieve" | "Retrieve statistical data about the current database. Valid sections are 'GRAPH COUNTS', 'TOKENS', 'QUERIES', 'META'" | "READ" | true |
39 | "db.stats.retrieveAllAnonymized" | "Retrieve all available statistical data about the current database, in an anonymized form." | "READ" | true |
40 | "db.stats.status" | "Retrieve the status of all available collector daemons, for this database." | "READ" | true |
41 | "db.stats.stop" | "Stop data collection of a given data section. Valid sections are 'QUERIES'" | "READ" | true |
42 | "dbms.checkConfigValue" | "Check if a potential config setting value is valid." | "DBMS" | true |
43 | "dbms.cluster.checkConnectivity" | "Check the connectivity of this instance to other cluster members. Not all ports are relevant to all members. Valid values for 'port-name' are: [CLUSTER, RAFT]" | "DBMS" | true |
44 | "dbms.cluster.cordonServer" | "Mark a server in the topology as not suitable for new allocations. It will not force current allocations off the server. This is useful when deallocating databases when you have multiple unavailable servers." | "WRITE" | true |
45 | "dbms.cluster.protocols" | "Overview of installed protocols" | "DBMS" | true |
46 | "dbms.cluster.readReplicaToggle" | "The toggle can pause or resume read replica (deprecated in favor of dbms.cluster.secondaryReplicationDisable)" | "DBMS" | true |
47 | "dbms.cluster.routing.getRoutingTable" | "Returns the advertised bolt capable endpoints for a given database, divided by each endpoint's capabilities. For example, an endpoint may serve read queries, write queries, and/or future `getRoutingTable` requests." | "DBMS" | true |
48 | "dbms.cluster.secondaryReplicationDisable" | "The toggle can pause or resume the secondary replication process." | "DBMS" | true |
49 | "dbms.cluster.setAutomaticallyEnableFreeServers" | "With this method you can set whether free servers are automatically enabled." | "WRITE" | true |
50 | "dbms.cluster.uncordonServer" | "Remove the cordon on a server, returning it to 'enabled'." | "WRITE" | true |
51 | "dbms.components" | "List DBMS components and their versions." | "DBMS" | true |
52 | "dbms.info" | "Provides information regarding the DBMS." | "DBMS" | true |
53 | "dbms.killConnection" | "Kill network connection with the given connection id." | "DBMS" | true |
54 | "dbms.killConnections" | "Kill all network connections with the given connection ids." | "DBMS" | true |
55 | "dbms.listActiveLocks" | "List the active lock requests granted for the transaction executing the query with the given query id." | "DBMS" | true |
56 | "dbms.listCapabilities" | "List capabilities." | "DBMS" | true |
57 | "dbms.listConfig" | "List the currently active configuration settings of Neo4j." | "DBMS" | true |
58 | "dbms.listConnections" | "List all accepted network connections at this instance that are visible to the user." | "DBMS" | true |
59 | "dbms.listPools" | "List all memory pools, including sub pools, currently registered at this instance that are visible to the user." | "DBMS" | true |
60 | "dbms.quarantineDatabase" | "Place a database into quarantine or remove it from it." | "DBMS" | true |
61 | "dbms.queryJmx" | "Query JMX management data by domain and name. For instance, use `*:*` to find all JMX beans." | "DBMS" | true |
62 | "dbms.routing.getRoutingTable" | "Returns the advertised bolt capable endpoints for a given database, divided by each endpoint's capabilities. For example, an endpoint may serve read queries, write queries, and/or future `getRoutingTable` requests." | "DBMS" | true |
63 | "dbms.scheduler.failedJobs" | "List failed job runs. There is a limit for amount of historical data." | "DBMS" | true |
64 | "dbms.scheduler.groups" | "List the job groups that are active in the database internal job scheduler." | "DBMS" | true |
65 | "dbms.scheduler.jobs" | "List all jobs that are active in the database internal job scheduler." | "DBMS" | true |
66 | "dbms.security.clearAuthCache" | "Clears authentication and authorization cache." | "DBMS" | true |
67 | "dbms.setConfigValue" | "Update a given setting value. Passing an empty value results in removing the configured value and falling back to the default value. Changes do not persist and are lost if the server is restarted. In a clustered environment, `dbms.setConfigValue` affects only the cluster member it is run against." | "DBMS" | true |
68 | "dbms.setDatabaseAllocator" | "With this method you can set the allocator that is responsible for selecting servers for hosting databases." | "WRITE" | true |
69 | "dbms.setDefaultAllocationNumbers" | "With this method you can set the default number of primaries and secondaries." | "WRITE" | true |
70 | "dbms.setDefaultDatabase" | "Change the default database to the provided value. The database must exist and the old default database must be stopped." | "WRITE" | true |
71 | "dbms.showCurrentUser" | "Show the current user." | "DBMS" | true |
72 | "dbms.showTopologyGraphConfig" | "With this method the configuration of the Topology Graph can be displayed." | "READ" | true |
73 | "dbms.upgrade" | "Upgrade the system database schema if it is not the current schema." | "WRITE" | true |
74 | "dbms.upgradeStatus" | "Report the current status of the system database sub-graph schema." | "READ" | true |
75 | "jwt.security.requestAccess" | "" | "DBMS" | false |
76 | "tx.getMetaData" | "Provides attached transaction metadata." | "DBMS" | true |
77 | "tx.setMetaData" | "Attaches a map of data to the transaction. The data will be printed when listing queries, and inserted into the query log." |