Procedures

This page provides a complete reference to the Neo4j procedures. Available procedures depend on the type of installation you have:

  • Neo4j Enterprise Edition provides a larger set of procedures than Neo4j Community Edition.

  • Cluster members have procedures that are not available in standalone mode.

To check which procedures are available in your Neo4j DBMS, use the Cypher command SHOW PROCEDURES:

Example 1. List available procedures
SHOW PROCEDURES

Some procedures can only be run by users with Admin privileges. These are labeled with Admin Only.

For more information, see Cypher Manual → Manage Privileges.

List of procedures

Table 1. Neo4j procedures
Name Community Edition Enterprise Edition Comment

db.awaitIndex()

Yes

Yes

db.awaitIndexes()

Yes

Yes

db.checkpoint()

No

Yes

db.clearQueryCaches()

Yes

Yes

Admin Only

db.createLabel()

Yes

Yes

db.createProperty()

Yes

Yes

db.createRelationshipType()

Yes

Yes

db.index.fulltext.awaitEventuallyConsistentIndexRefresh()

Yes

Yes

db.index.fulltext.listAvailableAnalyzers()

Yes

Yes

db.index.fulltext.queryNodes()

Yes

Yes

In 4.1, signature changed to db.index.fulltext.queryNodes(indexName :: STRING?, queryString :: STRING?, options = {} :: MAP?) :: (node :: NODE?, score :: FLOAT?).

db.index.fulltext.queryRelationships()

Yes

Yes

In 4.1, signature changed to db.index.fulltext.queryRelationships(indexName :: STRING?, queryString :: STRING?, options = {} :: MAP?) :: (relationship :: RELATIONSHIP?, score :: FLOAT?).

db.info()

Yes

Yes

db.labels()

Yes

Yes

db.listLocks()

No

Yes

Admin Only
In 4.2, signature changed to db.listLocks() :: (mode :: STRING?, resourceType :: STRING?, resourceId :: INTEGER?, transactionId :: STRING?).

db.ping()

Yes

Yes

db.prepareForReplanning()

Yes

Yes

Admin Only

db.propertyKeys()

Yes

Yes

db.relationshipTypes()

Yes

Yes

db.resampleIndex()

Yes

Yes

db.resampleOutdatedIndexes()

Yes

Yes

db.schema.nodeTypeProperties()

Yes

Yes

db.schema.relTypeProperties()

Yes

Yes

db.schema.visualization()

Yes

Yes

db.stats.clear()

Yes

Yes

Admin Only

db.stats.collect()

Yes

Yes

Admin Only

db.stats.retrieve()

Yes

Yes

Admin Only

db.stats.retrieveAllAnonymized()

Yes

Yes

Admin Only

db.stats.status()

Yes

Yes

Admin Only

db.stats.stop()

Yes

Yes

Admin Only

dbms.checkConfigValue()

No

Yes

New in 5.0.

dbms.cluster.checkConnectivity()

No

Yes

Admin Only

dbms.cluster.cordonServer()

No

Yes

Admin Only

dbms.cluster.protocols()

No

Yes

dbms.cluster.readReplicaToggle()

No

Yes

Admin Only Deprecated Deprecated in 5.6 and replaced by dbms.cluster.secondaryReplicationDisable().

dbms.cluster.secondaryReplicationDisable()

No

Yes

Admin Only

dbms.cluster.routing.getRoutingTable()

Yes

Yes

dbms.cluster.uncordonServer()

No

Yes

Admin Only

dbms.components()

Yes

Yes

dbms.info()

Yes

Yes

dbms.killConnection()

Yes

Yes

dbms.killConnections()

Yes

Yes

dbms.listActiveLocks()

Yes

Yes

dbms.listCapabilities()

Yes

Yes

dbms.listConfig()

Yes

Yes

Admin Only

dbms.listConnections()

Yes

Yes

dbms.listPools()

No

Yes

dbms.quarantineDatabase()

No

Yes

Admin Only

dbms.queryJmx()

Yes

Yes

dbms.routing.getRoutingTable()

Yes

Yes

dbms.scheduler.failedJobs()

No

Yes

Admin Only

dbms.scheduler.groups()

No

Yes

Admin Only

dbms.scheduler.jobs()

No

Yes

Admin Only

dbms.security.clearAuthCache()

No

Yes

Admin Only

dbms.setConfigValue()

No

Yes

Admin Only

dbms.setDatabaseAllocator()

No

Yes

Admin Only

dbms.setDefaultAllocationNumbers()

No

Yes

Admin Only

dbms.setDefaultDatabase()

No

Yes

Admin Only

dbms.showCurrentUser()

Yes

Yes

dbms.showTopologyGraphConfig()

No

Yes

Admin Only

dbms.upgrade()

Yes

Yes

Admin Only

dbms.upgradeStatus()

Yes

Yes

Admin Only

tx.getMetaData()

Yes

Yes

tx.setMetaData()

Yes

Yes

List of removed procedures

Table 2. Removed Neo4j procedures
Name Community Edition Enterprise Edition Comment

db.constraints()

Yes

Yes

Removed
Replaced by: SHOW CONSTRAINTS.

db.createIndex()

Yes

Yes

Removed
Replaced by: CREATE INDEX.

db.createNodeKey()

No

Yes

Removed
Replaced by: CREATE CONSTRAINT …​ IS NODE KEY.

db.createUniquePropertyConstraint()

Yes

Yes

Removed
Replaced by: CREATE CONSTRAINT …​ IS UNIQUE.

db.indexes()

Yes

Yes

Removed
Replaced by: SHOW INDEXES.

db.indexDetails()

Yes

Yes

Removed
Replaced by: SHOW INDEXES YIELD*.

db.index.fulltext.createNodeIndex()

Yes

Yes

Removed
Replaced by: CREATE FULLTEXT INDEX …​.

db.index.fulltext.createRelationshipIndex()

Yes

Yes

Removed
Replaced by: CREATE FULLTEXT INDEX …​.

db.index.fulltext.drop()

Yes

Yes

Removed
Replaced by: DROP INDEX …​.

db.schema.statements()

Yes

Yes

Removed
Replaced by: SHOW INDEXES YIELD * and SHOW CONSTRAINTS YIELD *.

dbms.cluster.overview()

No

Yes

Removed
Replaced by: SHOW SERVERS.

dbms.cluster.quarantineDatabase()

No

Yes

Removed
Replaced by: dbms.quarantineDatabase().

dbms.cluster.role()

No

Yes

Removed
Replaced by: SHOW DATABASES.

dbms.cluster.setDefaultDatabase()

No

Yes

Removed
Replaced by: dbms.setDefaultDatabase.

dbms.database.state()

Yes

Yes

Removed
Replaced by: SHOW DATABASES.

dbms.functions()

Yes

Yes

Removed
Replaced by: SHOW FUNCTIONS.

dbms.killQueries()

Yes

Yes

Removed
Replaced by: TERMINATE TRANSACTIONS.

dbms.killQuery()

Yes

Yes

Removed
Replaced by: TERMINATE TRANSACTIONS.

dbms.killTransaction()

Yes

Yes

Removed
Replaced by: TERMINATE TRANSACTIONS.

dbms.killTransactions()

Yes

Yes

Removed
Replaced by: TERMINATE TRANSACTIONS.

dbms.listQueries()

Yes

Yes

Removed
Replaced by: SHOW TRANSACTIONS.

dbms.listTransactions()

Yes

Yes

Removed
Replaced by: SHOW TRANSACTIONS.

dbms.procedures()

No

Yes

Removed
Replaced by: SHOW PROCEDURES.

dbms.security.activateUser()

No

Yes

Removed Admin Only
In 4.1, mode changed to write.
Replaced by: ALTER USER.

dbms.security.addRoleToUser()

No

Yes

Removed Admin Only
In 4.1, mode changed to write.
Replaced by: GRANT ROLE TO USER.

dbms.security.changePassword()

Yes

Yes

Removed Admin Only
In 4.1, mode changed to write.
Replaced by: ALTER CURRENT USER SET PASSWORD.

dbms.security.changeUserPassword()

No

Yes

Removed Admin Only
In 4.1, mode changed to write.
Replaced by: ALTER USER.

dbms.security.createRole()

No

Yes

Removed Admin Only
In 4.1, mode changed to write.
Replaced by: CREATE ROLE.

dbms.security.createUser()

Yes

Yes

Removed Admin Only
In 4.1, mode changed to write.
Replaced by: CREATE USER.

dbms.security.deleteRole()

No

Yes

Removed Admin Only
In 4.1, mode changed to write.
Replaced by: DROP ROLE.

dbms.security.deleteUser()

Yes

Yes

Removed Admin Only
In 4.1, mode changed to write.
Replaced by: DROP USER.

dbms.security.listRoles()

Yes

Yes

Removed Admin Only
In 4.1, mode changed to read.
Replaced by: SHOW ROLES.

dbms.security.listRolesForUser()

No

Yes

Removed
In 4.1, mode changed to read.
Replaced by: SHOW USERS.

dbms.security.listUsers()

Yes

Yes

Removed Admin Only
In 4.1, mode changed to read.
Replaced by: SHOW USERS.

dbms.security.listUsersForRole()

No

Yes

Removed Admin Only
In 4.1, mode changed to read.
Replaced by: SHOW ROLES WITH USERS.

dbms.security.removeRoleFromUser()

No

Yes

Removed Admin Only
In 4.1, mode changed to write.
Replaced by: REVOKE ROLE FROM USER.

dbms.security.suspendUser()

No

Yes

Removed Admin Only
In 4.1, mode changed to write.
Replaced by: ALTER USER.

Procedure descriptions

Table 3. db.awaitIndex()

Description

Wait for an index to come online.

Example: CALL db.awaitIndex("MyIndex", 300)

Signature

db.awaitIndex(indexName :: STRING?, timeOutSeconds = 300 :: INTEGER?) :: VOID

Mode

READ
Table 4. db.awaitIndexes()

Description

Wait for all indexes to come online.

Example: CALL db.awaitIndexes(300)

Signature

db.awaitIndexes(timeOutSeconds = 300 :: INTEGER?) :: VOID

Mode

READ
Table 5. db.checkpoint() Enterprise Edition

Description

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.

Signature

db.checkpoint() :: (success :: BOOLEAN?, message :: STRING?)

Mode

DBMS
Table 6. db.clearQueryCaches() Admin Only

Description

Clears all query caches.

Signature

db.clearQueryCaches() :: (value :: STRING?)

Mode

DBMS
Table 7. db.createLabel()

Description

Create a label

Signature

db.createLabel(newLabel :: STRING?) :: VOID

Mode

WRITE
Table 8. db.createNodeKey() Enterprise Edition Deprecated in 4.2

Description

Create a named node key constraint. Backing index will use specified index provider and configuration (optional).

Yield: name, labels, properties, providerName, status

Signature

db.createNodeKey(constraintName :: STRING?, labels :: LIST? OF STRING?, properties :: LIST? OF STRING?, providerName :: STRING?, config = {} :: MAP?) :: (name :: STRING?, labels :: LIST? OF STRING?, properties :: LIST? OF STRING?, providerName :: STRING?, status :: STRING?)

Mode

SCHEMA

Replaced by

CREATE CONSTRAINT …​ IS NODE KEY. For more information, see Database administration.
Table 9. db.createProperty()

Description

Create a Property

Signature

db.createProperty(newProperty :: STRING?) :: VOID

Mode

WRITE
Table 10. db.createRelationshipType()

Description

Create a RelationshipType

Signature

db.createRelationshipType(newRelationshipType :: STRING?) :: VOID

Mode

WRITE
Table 11. db.index.fulltext.awaitEventuallyConsistentIndexRefresh()

Description

Wait for the updates from recently committed transactions to be applied to any eventually-consistent full-text indexes.

Signature

db.index.fulltext.awaitEventuallyConsistentIndexRefresh() :: VOID

Mode

READ
Table 12. db.index.fulltext.listAvailableAnalyzers()

Description

List the available analyzers that the full-text indexes can be configured with.

Signature

db.index.fulltext.listAvailableAnalyzers() :: (analyzer :: STRING?, description :: STRING?, stopwords :: LIST? OF STRING?)

Mode

READ
Table 13. db.index.fulltext.queryNodes()

Description

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: <number> — skip the top N results.

  • limit: <number> — limit the number of results returned.

  • analyzer: <string> — 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'}

Signature

db.index.fulltext.queryNodes(indexName :: STRING?, queryString :: STRING?, options = {} :: MAP?) :: (node :: NODE?, score :: FLOAT?)

Mode

READ
Table 14. db.index.fulltext.queryRelationships()

Description

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: <number> — skip the top N results.

  • limit: <number> — limit the number of results returned.

  • analyzer: <string> — 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'}

Signature

db.index.fulltext.queryRelationships(indexName :: STRING?, queryString :: STRING?, options = {} :: MAP?) :: (relationship :: RELATIONSHIP?, score :: FLOAT?)

Mode

READ
Table 15. db.info()

Description

Provides information regarding the database.

Signature

db.info() :: (id :: STRING?, name :: STRING?, creationDate :: STRING?)

Mode

READ
Table 16. db.labels()

Description

List all available labels in the database.

Signature

db.labels() :: (label :: STRING?)

Mode

READ
Table 17. db.listLocks() Enterprise Edition Admin Only

Description

List all locks at this database.

Signature

db.listLocks() :: (mode :: STRING?, resourceType :: STRING?, resourceId :: INTEGER?, transactionId :: STRING?)

Mode

DBMS
Table 18. db.ping()

Description

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.

Signature

db.ping() :: (success :: BOOLEAN?)

Mode

READ
Table 19. db.prepareForReplanning() Admin Only

Description

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.

Signature

db.prepareForReplanning(timeOutSeconds = 300 :: INTEGER?) :: VOID

Mode

READ
Table 20. db.propertyKeys()

Description

List all property keys in the database.

Signature

db.propertyKeys() :: (propertyKey :: STRING?)

Mode

READ
Table 21. db.relationshipTypes()

Description

List all available relationship types in the database.

Signature

db.relationshipTypes() :: (relationshipType :: STRING?)

Mode

READ
Table 22. db.resampleIndex()

Description

Schedule resampling of an index.

Example: CALL db.resampleIndex("MyIndex")

Signature

db.resampleIndex(indexName :: STRING?) :: VOID

Mode

READ
Table 23. db.resampleOutdatedIndexes()

Description

Schedule resampling of all outdated indexes.

Signature

db.resampleOutdatedIndexes() :: VOID

Mode

READ
Table 24. db.schema.nodeTypeProperties()

Description

Show the derived property schema of the nodes in tabular form.

Signature

db.schema.nodeTypeProperties() :: (nodeType :: STRING?, nodeLabels :: LIST? OF STRING?, propertyName :: STRING?, propertyTypes :: LIST? OF STRING?, mandatory :: BOOLEAN?)

Mode

READ
Table 25. db.schema.relTypeProperties()

Description

Show the derived property schema of the relationships in tabular form.

Signature

db.schema.relTypeProperties() :: (relType :: STRING?, propertyName :: STRING?, propertyTypes :: LIST? OF STRING?, mandatory :: BOOLEAN?)

Mode

READ
Table 26. db.schema.visualization()

Description

Visualize the schema of the data.

Signature

db.schema.visualization() :: (nodes :: LIST? OF NODE?, relationships :: LIST? OF RELATIONSHIP?)

Mode

READ
Table 27. db.stats.clear() Admin Only

Description

Clear collected data of a given data section.

Valid sections are 'QUERIES'

Signature

db.stats.clear(section :: STRING?) :: (section :: STRING?, success :: BOOLEAN?, message :: STRING?)

Mode

READ
Table 28. db.stats.collect() Admin Only

Description

Start data collection of a given data section.

Valid sections are 'QUERIES'

Signature

db.stats.collect(section :: STRING?, config = {} :: MAP?) :: (section :: STRING?, success :: BOOLEAN?, message :: STRING?)

Mode

READ
Table 29. db.stats.retrieve() Admin Only

Description

Retrieve statistical data about the current database.

Valid sections are 'GRAPH COUNTS', 'TOKENS', 'QUERIES', 'META'

Signature

db.stats.retrieve(section :: STRING?, config = {} :: MAP?) :: (section :: STRING?, data :: MAP?)

Mode

READ
Table 30. db.stats.retrieveAllAnonymized() Admin Only

Description

Retrieve all available statistical data about the current database, in an anonymized form.

Signature

db.stats.retrieveAllAnonymized(graphToken :: STRING?, config = {} :: MAP?) :: (section :: STRING?, data :: MAP?)

Mode

READ
Table 31. db.stats.status() Admin Only

Description

Retrieve the status of all available collector daemons, for this database.

Signature

db.stats.status() :: (section :: STRING?, status :: STRING?, data :: MAP?)

Mode

READ
Table 32. db.stats.stop() Admin Only

Description

Stop data collection of a given data section.

Valid sections are 'QUERIES'

Signature

db.stats.stop(section :: STRING?) :: (section :: STRING?, success :: BOOLEAN?, message :: STRING?)

Mode

READ
Table 33. dbms.checkConfigValue() Enterprise Edition

Description

This procedure provides feedback about the validity of a setting value. It does not change the setting.

The procedure returns:

  • valid: if the value is valid. A valid value for a non-dynamic setting requires a restart.

  • message: a message describing the reason for the invalidity. The message is empty if the value is valid and the setting is dynamic.

Signature

dbms.checkConfigValue(setting :: STRING?, value :: STRING?) :: (valid :: BOOLEAN?, message :: STRING?)

Mode

DBMS
Table 34. dbms.cluster.checkConnectivity() Enterprise Edition Admin Only

Description

Checks 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].

Signature

dbms.cluster.checkConnectivity

Mode

DBMS
Table 35. dbms.cluster.cordonServer() Enterprise Edition Admin Only

Description

Marks 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.

Signature

dbms.cluster.cordonServer(server :: STRING?)

Mode

WRITE
Table 36. dbms.cluster.routing.getRoutingTable()

Description

Returns endpoints of this instance. Used in disaster recovery.

Signature

dbms.cluster.routing.getRoutingTable(context :: MAP?, database = null :: STRING?) :: (ttl :: INTEGER?, servers :: LIST? OF MAP?)

Mode

DBMS
Table 37. dbms.cluster.protocols() Enterprise Edition

Description

Overview of installed protocols.

Note that this can only be executed on a cluster core member.

Signature

dbms.cluster.protocols() :: (orientation :: STRING?, remoteAddress :: STRING?, applicationProtocol :: STRING?, applicationProtocolVersion :: INTEGER?, modifierProtocols :: STRING?)

Mode

READ
Table 38. dbms.cluster.readReplicaToggle() Enterprise Edition Admin Only Deprecated

Description

The toggle can pause or resume the pulling of new transactions for a specific database. If paused, the database secondary does not pull new transactions from the other cluster members for the specific database. The database secondary is still available for reads, you can perform a backup, etc. Deprecated in 5.6 and replaced by dbms.cluster.secondaryReplicationDisable().

What is it for?

You can perform a point in time backup, as the backup will contain only the transactions up to the point where the transaction pulling was paused. Follow these steps to do so:

  1. Connect directly to the server hosting the database in secondary mode. (Neo4j Driver use bolt:// or use the HTTP API).

  2. Pause transaction pulling for the specified database.

  3. Back up the database, see Back up an online database.

If connected directly to a server hosting a database in secondary mode, Data Scientists can execute analysis on a specific database that is paused, the data will not unexpectedly change while performing the analysis.

This procedure can only be executed on a database which runs in a secondary role on the connected server.
Pause transaction pulling for database neo4j
CALL dbms.cluster.readReplicaToggle("neo4j", true)
Resume transaction pulling for database neo4j
CALL dbms.cluster.readReplicaToggle("neo4j", false)

Signature

dbms.cluster.readReplicaToggle(databaseName :: STRING?, pause :: BOOLEAN?) :: (state :: STRING?)

Mode

READ

New in 5.6

Table 39. dbms.cluster.secondaryReplicationDisable() Enterprise Edition Admin Only

Description

The toggle can pause or resume the pulling of new transactions for a specific database. If paused, the database secondary does not pull new transactions from the other cluster members for the specific database. The database secondary is still available for reads, you can perform a backup, etc.

What is it for?

You can perform a point-in-time backup, as the backup will contain only the transactions up to the point where the transaction pulling was paused. Follow these steps to do so:

  1. Connect directly to the server hosting the database in secondary mode. (Neo4j Driver use bolt:// or use the HTTP API).

  2. Pause transaction pulling for the specified database.

  3. Back up the database, see Back up an online database.

If connected directly to a server hosting a database in secondary mode, Data Scientists can execute analysis on a specific database that is paused, the data will not unexpectedly change while performing the analysis.

This procedure can only be executed on a database which runs in a secondary role on the connected server.
Pause transaction pulling for database neo4j
CALL dbms.cluster.secondaryReplicationDisable("neo4j", true)
Resume transaction pulling for database neo4j
CALL dbms.cluster.secondaryReplicationDisable("neo4j", false)

Signature

dbms.cluster.secondaryReplicationDisable(databaseName :: STRING?, pause :: BOOLEAN?) :: (state :: STRING?)

Mode

READ
Table 40. dbms.cluster.uncordonServer() Enterprise Edition Admin Only

Description

Removes the cordon on a server, returning it to 'enabled'.

Signature

dbms.cluster.uncordonServer(server :: STRING?)

Mode

WRITE
Table 41. dbms.components()

Description

List DBMS components and their versions.

Signature

dbms.components() :: (name :: STRING?, versions :: LIST? OF STRING?, edition :: STRING?)

Mode

DBMS
Table 42. dbms.info()

Description

Provides information regarding the DBMS.

Signature

dbms.info() :: (id :: STRING?, name :: STRING?, creationDate :: STRING?)

Mode

DBMS
Table 43. dbms.killConnection()

Description

Kill network connection with the given connection id.

Signature

dbms.killConnection(id :: STRING?) :: (connectionId :: STRING?, username :: STRING?, message :: STRING?)

Mode

DBMS
Table 44. dbms.killConnections()

Description

Kill all network connections with the given connection ids.

Signature

dbms.killConnections(ids :: LIST? OF STRING?) :: (connectionId :: STRING?, username :: STRING?, message :: STRING?)

Mode

DBMS
Table 45. dbms.listActiveLocks() Enterprise Edition

Description

List the active lock requests granted for the transaction executing the query with the given query id.

Signature

dbms.listActiveLocks(queryId :: STRING?) :: (mode :: STRING?, resourceType :: STRING?, resourceId :: INTEGER?)

Mode

DBMS
Table 46. dbms.listCapabilities()

Description

List capabilities.

Signature

dbms.listCapabilities() :: (name :: STRING?, description :: STRING?, value :: ANY?)

Mode

DBMS
Table 47. dbms.listConfig() Admin Only

Description

List all configuration settings whose names include the searchString, or all configuration settings if searchString is omitted.

Use this procedure to check a setting’s values, investigate when a value was set, or find information on valid values.

Results include:

  • value: the current value of the setting.

  • dynamic: true if the value can be changed at runtime, or false if it requires a restart.

  • defaultValue: the default value of the setting.

  • startupValue: the value when the server was started, after neo4j.conf and command line arguments have been applied.

  • explicitlySet: true if the value was set explicitly, or false if it was set by default.

  • validValues: contains information on data types and possible values for the settings.

Signature

dbms.listConfig(searchString = :: STRING?) :: (name :: STRING?, description :: STRING?, value :: STRING?, dynamic :: BOOLEAN?, defaultValue :: STRING?, startupValue :: STRING?, explicitlySet :: BOOLEAN?, validValues :: STRING?)

Mode

DBMS
Table 48. dbms.listConnections()

Description

List all accepted network connections at this instance that are visible to the user.

Signature

dbms.listConnections() :: (connectionId :: STRING?, connectTime :: STRING?, connector :: STRING?, username :: STRING?, userAgent :: STRING?, serverAddress :: STRING?, clientAddress :: STRING?)

Mode

DBMS
Table 49. dbms.listPools() Enterprise Edition

Description

List all memory pools, including sub pools, currently registered at this instance that are visible to the user.

Signature

dbms.listPools() :: (pool :: STRING?, databaseName :: STRING?, heapMemoryUsed :: STRING?, heapMemoryUsedBytes :: STRING?, nativeMemoryUsed :: STRING?, nativeMemoryUsedBytes :: STRING?, freeMemory :: STRING?, freeMemoryBytes :: STRING?, totalPoolMemory :: STRING?, totalPoolMemoryBytes :: STRING?)

Mode

DBMS
Table 50. dbms.quarantineDatabase() Enterprise Edition Admin Only

Description

Place a database in quarantine or remove thereof. It must be executed over bolt://.

Signature

dbms.quarantineDatabase(databaseName :: STRING?, setStatus :: BOOLEAN?, reason = No reason given :: STRING?) :: (databaseName :: STRING?, quarantined :: BOOLEAN?, result :: STRING?)

Mode

DBMS
Table 51. dbms.queryJmx()

Description

Query JMX management data by domain and name.

Valid queries should use the syntax outlined in the javax.management.ObjectName API documentation.
For instance, use "*:*" to find all JMX beans.

Signature

dbms.queryJmx(query :: STRING?) :: (name :: STRING?, description :: STRING?, attributes :: MAP?)

Mode

DBMS
Table 52. dbms.routing.getRoutingTable()

Description

Returns endpoints of this instance.

Signature

dbms.routing.getRoutingTable(context :: MAP?, database = null :: STRING?) :: (ttl :: INTEGER?, servers :: LIST? OF MAP?)

Mode

DBMS
Table 53. dbms.setDatabaseAllocator() Enterprise Edition Admin Only

Description

With this method you can set the allocator, which is responsible to select servers for hosting databases. The only current option is EQUAL_NUMBERS.

Signature

dbms.setDatabaseAllocator(allocator :: STRING?)

Mode

WRITE
Table 54. dbms.setDefaultAllocationNumbers() Enterprise Edition Admin Only

Description

With this method you can set the default number of primaries and secondaries.

Signature

dbms.setDefaultAllocationNumbers(primaries :: INTEGER?, secondaries :: INTEGER?)

Mode

WRITE
Table 55. dbms.setDefaultDatabase() Enterprise Edition Admin Only

Description

Changes the default database to the provided value. The database must exist and the old default database must be stopped.

Signature

dbms.setDefaultDatabase(databaseName :: STRING?) :: (result :: STRING?)

Mode

WRITE
Table 56. dbms.scheduler.failedJobs() Enterprise Edition Admin Only

Description

List failed job runs. There is a limit for amount of historical data.

Signature

dbms.scheduler.failedJobs() :: (jobId :: STRING?, group :: STRING?, database :: STRING?, submitter :: STRING?, description :: STRING?, type :: STRING?, submitted :: STRING?, executionStart :: STRING?, failureTime :: STRING?, failureDescription :: STRING?)

Mode

DBMS
Table 57. dbms.scheduler.groups() Enterprise Edition Admin Only

Description

List the job groups that are active in the database internal job scheduler.

Signature

dbms.scheduler.groups() :: (group :: STRING?, threads :: INTEGER?)

Mode

DBMS
Table 58. dbms.scheduler.jobs() Enterprise Edition Admin Only

Description

List all jobs that are active in the database internal job scheduler.

Signature

dbms.scheduler.jobs() :: (jobId :: STRING?, group :: STRING?, submitted :: STRING?, database :: STRING?, submitter :: STRING?, description :: STRING?, type :: STRING?, scheduledAt :: STRING?, period :: STRING?, state :: STRING?, currentStateDescription :: STRING?)

Mode

DBMS
Table 59. dbms.security.clearAuthCache() Enterprise Edition Admin Only

Description

Clears authentication and authorization cache.

Signature

dbms.security.clearAuthCache() :: VOID

Mode

DBMS
Table 60. dbms.setConfigValue() Enterprise Edition Admin Only

Description

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.

Signature

dbms.setConfigValue(setting :: STRING?, value :: STRING?) :: VOID

Mode

DBMS
Table 61. dbms.showCurrentUser()

Description

Show the current user.

Signature

dbms.showCurrentUser() :: (username :: STRING?, roles :: LIST? OF STRING?, flags :: LIST? OF STRING?)

Mode

DBMS
Table 62. dbms.showTopologyGraphConfig() Enterprise Only Admin Only

Description

With this method the configuration of the Topology Graph can be displayed.

Signature

dbms.showTopologyGraphConfig() :: (allocator :: STRING?, defaultPrimariesCount :: INTEGER?, defaultSecondariesCount :: INTEGER?, defaultDatabase :: STRING?)

Mode

READ
Table 63. dbms.upgrade() Admin Only

Description

Upgrade the system database schema if it is not the current schema.

Signature

dbms.upgrade() :: (status :: STRING?, upgradeResult :: STRING?)

Mode

WRITE
Table 64. dbms.upgradeStatus() Admin Only

Description

Report the current status of the system database sub-graph schema.

Signature

dbms.upgradeStatus() :: (status :: STRING?, description :: STRING?, resolution :: STRING?)

Mode

READ
Table 65. tx.getMetaData()

Description

Provides attached transaction metadata.

Signature

tx.getMetaData() :: (metadata :: MAP?)

Mode

DBMS
Table 66. tx.setMetaData()

Description

Attaches a map of data to the transaction. The data will be printed when listing queries, and inserted into the query log.

Signature

tx.setMetaData(data :: MAP?) :: VOID

Mode

DBMS