Procedures - Operations Manual

Procedures, editions and modes

Available procedures depends 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 instance, use dbms.procedures().

Example 1. List available procedures

To list the procedures available on your particular installation, run the following Cypher query:

CALL dbms.procedures()

List of procedures

Table 1. Neo4j procedures
Name
`db.awaitIndex()`
`db.awaitIndexes()`
`db.checkpoint()`
`db.clearQueryCaches()`
`db.constraints()`
`db.createIndex()`
`db.createLabel()`
`db.createNodeKey()`
`db.createProperty()`
`db.createRelationshipType()`
`db.createUniquePropertyConstraint()`
`db.index.fulltext.awaitEventuallyConsistentIndexRefresh()`
`db.index.fulltext.createNodeIndex()`
`db.index.fulltext.createRelationshipIndex()`
`db.index.fulltext.drop()`
`db.index.fulltext.listAvailableAnalyzers()`
`db.index.fulltext.queryNodes()`
`db.index.fulltext.queryRelationships()`
`db.indexDetails()`
`db.indexes()`
`db.info()`
`db.labels()`
`db.listLocks()`
`db.ping()`
`db.prepareForReplanning()`
`db.propertyKeys()`
`db.relationshipTypes()`
`db.resampleIndex()`
`db.resampleOutdatedIndexes()`
`db.schema.nodeTypeProperties()`
`db.schema.relTypeProperties()`
`db.schema.visualization()`
`db.schemaStatements()`
`db.stats.clear()`
`db.stats.collect()`
`db.stats.retrieve()`
`db.stats.retrieveAllAnonymized()`
`db.stats.status()`
`db.stats.stop()`
`dbms.cluster.routing.getRoutingTable()`
`dbms.cluster.overview()`
`dbms.cluster.protocols()`
`dbms.cluster.role()`
`dbms.cluster.setDefaultDatabase()`
`dbms.components()`
`dbms.database.state()`
`dbms.functions()`
`dbms.info()`
`dbms.killConnection()`
`dbms.killConnections()`
`dbms.killQueries()`
`dbms.killQuery()`
`dbms.killTransaction()`
`dbms.killTransactions()`
`dbms.listActiveLocks()`
`dbms.listConfig()`
`dbms.listConnections()`
`dbms.listPools()`
`dbms.listQueries()`
`dbms.listTransactions()`
`dbms.procedures()`
`dbms.queryJmx()`
`dbms.routing.getRoutingTable()`
`dbms.scheduler.groups()`
`dbms.scheduler.profile()`
`dbms.security.activateUser()`
`dbms.security.addRoleToUser()`
`dbms.security.changePassword()`
`dbms.security.changeUserPassword()`
`dbms.security.clearAuthCache()`
`dbms.security.createRole()`
`dbms.security.createUser()`
`dbms.security.deleteRole()`
`dbms.security.deleteUser()`
`dbms.security.listRoles()`
`dbms.security.listRolesForUser()`
`dbms.security.listUsers()`
`dbms.security.listUsersForRole()`
`dbms.security.removeRoleFromUser()`
`dbms.security.suspendUser()`
`dbms.setConfigValue()`
`dbms.showCurrentUser()`
`dbms.upgrade()`
`dbms.upgradeStatus()`
`tx.getMetaData()`
`tx.setMetaData()`

Procedure descriptions

The role-based access control is an Enterprise Edition feature.

Each procedure lists the default roles that can access the procedure.

Table 2. 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`
Default roles	`reader, editor, publisher, architect, admin`

Table 3. db.awaitIndexes()
Description	Wait for all indexes to come online. Example: `CALL db.awaitIndexes(300))`
Signature	`db.awaitIndexes(timeOutSeconds = 300 :: INTEGER?) :: VOID`
Mode	`READ`
Default roles	`reader, editor, publisher, architect, admin`

Table 4. db.checkpoint()
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 `dbms.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`
Default roles	`reader, editor, publisher, architect, admin`

Table 5. db.clearQueryCaches()
Description	Clears all query caches.
Signature	`db.clearQueryCaches() :: (value :: STRING?)`
Mode	`DBMS`
Default roles	`admin`

Table 6. db.constraints()
Description	List all constraints in the database.
Signature	`db.constraints() :: (name :: STRING?, description :: STRING?, details :: STRING?)`
Mode	`READ`
Default roles	`reader, editor, publisher, architect, admin`

Table 7. db.createIndex()
Description	Create a named schema index with specified index provider and configuration (optional). Yield: name, labels, properties, providerName, status
Signature	`db.createIndex(indexName :: 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`
Default roles	`architect, admin`

Table 8. db.createLabel()
Description	Create a label
Signature	`db.createLabel(newLabel :: STRING?) :: VOID`
Mode	`WRITE`
Default roles	`publisher, architect, admin`

Table 9. db.createNodeKey()
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`
Default roles	`architect, admin`

Table 10. db.createProperty()
Description	Create a Property
Signature	`db.createProperty(newProperty :: STRING?) :: VOID`
Mode	`WRITE`
Default roles	`publisher, architect, admin`

Table 11. db.createRelationshipType()
Description	Create a RelationshipType
Signature	`db.createRelationshipType(newRelationshipType :: STRING?) :: VOID`
Mode	`WRITE`
Default roles	`publisher, architect, admin`

Table 12. db.createUniquePropertyConstraint()
Description	Create a named unique property constraint. Backing index will use specified index provider and configuration (optional). Yield: name, labels, properties, providerName, status
Signature	`db.createUniquePropertyConstraint(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`
Default roles	`architect, admin`

Table 13. 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`
Default roles	`reader, editor, publisher, architect, admin`

Table 14. db.index.fulltext.createNodeIndex()
Description	Create a node full-text index for the given labels and properties. The optional 'config' map parameter can be used to supply settings to the index. Supported settings are 'analyzer', for specifying what analyzer to use when indexing and querying. Use the `db.index.fulltext.listAvailableAnalyzers` procedure to see what options are available. And 'eventually_consistent' which can be set to 'true' to make this index eventually consistent, such that updates from committing transactions are applied in a background thread.
Signature	`db.index.fulltext.createNodeIndex(indexName :: STRING?, labels :: LIST? OF STRING?, properties :: LIST? OF STRING?, config = {} :: MAP?) :: VOID`
Mode	`SCHEMA`
Default roles	`architect, admin`

Table 15. db.index.fulltext.createRelationshipIndex()
Description	Create a relationship full-text index for the given relationship types and properties. The optional 'config' map parameter can be used to supply settings to the index. Supported settings are 'analyzer', for specifying what analyzer to use when indexing and querying. Use the `db.index.fulltext.listAvailableAnalyzers` procedure to see what options are available. And 'eventually_consistent' which can be set to 'true' to make this index eventually consistent, such that updates from committing transactions are applied in a background thread.
Signature	`db.index.fulltext.createRelationshipIndex(indexName :: STRING?, relationshipTypes :: LIST? OF STRING?, properties :: LIST? OF STRING?, config = {} :: MAP?) :: VOID`
Mode	`SCHEMA`
Default roles	`architect, admin`

Table 16. db.index.fulltext.drop()
Description	Drop the specified index.
Signature	`db.index.fulltext.drop(indexName :: STRING?) :: VOID`
Mode	`SCHEMA`
Default roles	`architect, admin`

Table 17. 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`
Default roles	`reader, editor, publisher, architect, admin`

Table 18. db.index.fulltext.queryNodes()
Description	Query the given full-text index. Returns the matching nodes, and their Lucene query score, ordered by score. Valid keys for the options map are: 'skip' to skip the top N results; 'limit' to limit the number of results returned.
Signature	`db.index.fulltext.queryNodes(indexName :: STRING?, queryString :: STRING?, options = {} :: MAP?) :: (node :: NODE?, score :: FLOAT?)`
Mode	`READ`
Default roles	`reader, editor, publisher, architect, admin`

Table 19. db.index.fulltext.queryRelationships()
Description	Query the given full-text index. Returns the matching relationships, and their Lucene query score, ordered by score. Valid keys for the options map are: 'skip' to skip the top N results; 'limit' to limit the number of results returned.
Signature	`db.index.fulltext.queryRelationships(indexName :: STRING?, queryString :: STRING?, options = {} :: MAP?) :: (relationship :: RELATIONSHIP?, score :: FLOAT?)`
Mode	`READ`
Default roles	`reader, editor, publisher, architect, admin`

Table 20. db.indexDetails()
Description	Detailed description of specific index.
Signature	`db.indexDetails(indexName :: STRING?) :: (id :: INTEGER?, name :: STRING?, state :: STRING?, populationPercent :: FLOAT?, uniqueness :: STRING?, type :: STRING?, entityType :: STRING?, labelsOrTypes :: LIST? OF STRING?, properties :: LIST? OF STRING?, provider :: STRING?, indexConfig :: MAP?, failureMessage :: STRING?)`
Mode	`READ`
Default roles	`reader, editor, publisher, architect, admin`

Table 21. db.indexes()
Description	List all indexes in the database.
Signature	`db.indexes() :: (id :: INTEGER?, name :: STRING?, state :: STRING?, populationPercent :: FLOAT?, uniqueness :: STRING?, type :: STRING?, entityType :: STRING?, labelsOrTypes :: LIST? OF STRING?, properties :: LIST? OF STRING?, provider :: STRING?)`
Mode	`READ`
Default roles	`reader, editor, publisher, architect, admin`

Table 22. db.info()
Description	Provides information regarding the database.
Signature	`db.info() :: (id :: STRING?, name :: STRING?, creationDate :: STRING?)`
Mode	`READ`
Default roles	`reader, editor, publisher, architect, admin`

Table 23. db.labels()
Description	List all available labels in the database.
Signature	`db.labels() :: (label :: STRING?)`
Mode	`READ`
Default roles	`reader, editor, publisher, architect, admin`

Table 24. db.listLocks()
Description	List all locks at this database.
Signature	`db.listLocks() :: (resourceType :: STRING?, resourceId :: INTEGER?, description :: STRING?)`
Mode	`DBMS`
Default roles	`admin`

Table 25. 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`
Default roles	`reader, editor, publisher, architect, admin`

Table 26. db.prepareForReplanning()
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`
Default roles	`admin`

Table 27. db.propertyKeys()
Description	List all property keys in the database.
Signature	`db.propertyKeys() :: (propertyKey :: STRING?)`
Mode	`READ`
Default roles	`reader, editor, publisher, architect, admin`

Table 28. db.relationshipTypes()
Description	List all available relationship types in the database.
Signature	`db.relationshipTypes() :: (relationshipType :: STRING?)`
Mode	`READ`
Default roles	`reader, editor, publisher, architect, admin`

Table 29. db.resampleIndex()
Description	Schedule resampling of an index. Example: `CALL db.resampleIndex("MyIndex"))`
Signature	`db.resampleIndex(indexName :: STRING?) :: VOID`
Mode	`READ`
Default roles	`reader, editor, publisher, architect, admin`

Table 30. db.resampleOutdatedIndexes()
Description	Schedule resampling of all outdated indexes.
Signature	`db.resampleOutdatedIndexes() :: VOID`
Mode	`READ`
Default roles	`reader, editor, publisher, architect, admin`

Table 31. 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`
Default roles	`reader, editor, publisher, architect, admin`

Table 32. 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`
Default roles	`reader, editor, publisher, architect, admin`

Table 33. db.schema.visualization()
Description	Visualize the schema of the data.
Signature	`db.schema.visualization() :: (nodes :: LIST? OF NODE?, relationships :: LIST? OF RELATIONSHIP?)`
Mode	`READ`
Default roles	`reader, editor, publisher, architect, admin`

Table 34. db.schemaStatements()
Description	List all statements for creating and dropping existing indexes and constraints.
Signature	`db.schemaStatements() :: (name :: STRING?, type :: STRING?, createStatement :: STRING?, dropStatement :: STRING?)`
Mode	`READ`
Default roles	`reader, editor, publisher, architect, admin`

Table 35. db.stats.clear()
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`
Default roles	`admin`

Table 36. db.stats.collect()
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`
Default roles	`admin`

Table 37. db.stats.retrieve()
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`
Default roles	`admin`

Table 38. db.stats.retrieveAllAnonymized()
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`
Default roles	`admin`

Table 39. db.stats.status()
Description	Retrieve the status of all available collector daemons, for this database.
Signature	`db.stats.status() :: (section :: STRING?, status :: STRING?, data :: MAP?)`
Mode	`READ`
Default roles	`admin`

Table 40. db.stats.stop()
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`
Default roles	`admin`

Table 41. dbms.cluster.routing.getRoutingTable()
Description	Returns endpoints of this instance.
Signature	`dbms.cluster.routing.getRoutingTable(context :: MAP?, database = null :: STRING?) :: (ttl :: INTEGER?, servers :: LIST? OF MAP?)`
Mode	`DBMS`
Default roles	`reader, editor, publisher, architect, admin`

Table 42. dbms.cluster.overview()
Description	Overview of all currently accessible cluster members, their databases and roles.
Signature	`dbms.cluster.overview() :: (id :: STRING?, addresses :: LIST? OF STRING?, databases :: MAP?, groups :: LIST? OF STRING?)`
Mode	`READ`
Default roles	`reader, editor, publisher, architect, admin`

Table 43. dbms.cluster.protocols()
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`
Default roles	`reader, editor, publisher, architect, admin`

Table 44. dbms.cluster.role()
Description	The role of this instance in the cluster for the specified database.
Signature	`dbms.cluster.role(database :: STRING?) :: (role :: STRING?)`
Mode	`READ`
Default roles	`reader, editor, publisher, architect, admin`

Table 45. dbms.cluster.setDefaultDatabase()
Description	Change the default database to the provided value. The database must exist and the old default database must be stopped. For more information see Change the default database. Note that this can only be executed on a cluster core member.
Signature	`dbms.cluster.setDefaultDatabase(databaseName :: STRING?) :: (result :: STRING?)`
Mode	`WRITE`
Default roles	`admin`

Table 46. dbms.components()
Description	List DBMS components and their versions.
Signature	`dbms.components() :: (name :: STRING?, versions :: LIST? OF STRING?, edition :: STRING?)`
Mode	`DBMS`
Default roles	`reader, editor, publisher, architect, admin`

Table 47. dbms.database.state()
Description	The actual status of the database with the provided name on this neo4j instance.
Signature	`dbms.database.state(databaseName :: STRING?) :: (role :: STRING?, address :: STRING?, status :: STRING?, error :: STRING?)`
Mode	`DBMS`
Default roles	`reader, editor, publisher, architect, admin`

Table 48. dbms.functions()
Description	List all functions in the DBMS.
Signature	`dbms.functions() :: (name :: STRING?, signature :: STRING?, description :: STRING?, aggregating :: BOOLEAN?, defaultBuiltInRoles :: LIST? OF STRING?)`
Mode	`DBMS`
Default roles	`reader, editor, publisher, architect, admin`

Table 49. dbms.info()
Description	Provides information regarding the DBMS.
Signature	`dbms.info() :: (id :: STRING?, name :: STRING?, creationDate :: STRING?)`
Mode	`DBMS`
Default roles	`reader, editor, publisher, architect, admin`

Table 50. dbms.killConnection()
Description	Kill network connection with the given connection id.
Signature	`dbms.killConnection(id :: STRING?) :: (connectionId :: STRING?, username :: STRING?, message :: STRING?)`
Mode	`DBMS`
Default roles	`reader, editor, publisher, architect, admin`

Table 51. 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`
Default roles	`reader, editor, publisher, architect, admin`

Table 52. dbms.killQueries()
Description	Kill all transactions executing a query with any of the given query ids.
Signature	`dbms.killQueries(ids :: LIST? OF STRING?) :: (queryId :: STRING?, username :: STRING?, message :: STRING?)`
Mode	`DBMS`
Default roles	`reader, editor, publisher, architect, admin`

Table 53. dbms.killQuery()
Description	Kill all transactions executing the query with the given query id.
Signature	`dbms.killQuery(id :: STRING?) :: (queryId :: STRING?, username :: STRING?, message :: STRING?)`
Mode	`DBMS`
Default roles	`reader, editor, publisher, architect, admin`

Table 54. dbms.killTransaction()
Description	Kill transaction with provided id.
Signature	`dbms.killTransaction(id :: STRING?) :: (transactionId :: STRING?, username :: STRING?, message :: STRING?)`
Mode	`DBMS`
Default roles	`reader, editor, publisher, architect, admin`

Table 55. dbms.killTransactions()
Description	Kill transactions with provided ids.
Signature	`dbms.killTransactions(ids :: LIST? OF STRING?) :: (transactionId :: STRING?, username :: STRING?, message :: STRING?)`
Mode	`DBMS`
Default roles	`reader, editor, publisher, architect, admin`

Table 56. dbms.listActiveLocks()
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`
Default roles	`reader, editor, publisher, architect, admin`

Table 57. dbms.listConfig()
Description	List the currently active config of Neo4j.
Signature	`dbms.listConfig(searchString = :: STRING?) :: (name :: STRING?, description :: STRING?, value :: STRING?, dynamic :: BOOLEAN?)`
Mode	`DBMS`
Default roles	`admin`

Table 58. 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`
Default roles	`reader, editor, publisher, architect, admin`

Table 59. dbms.listPools()
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`
Default roles	`reader, editor, publisher, architect, admin`

Table 60. dbms.listQueries()
Description	List all queries currently executing at this instance that are visible to the user.
Signature	dbms.listQueries() :: (queryId :: STRING?, username :: STRING?, metaData :: MAP?, query :: STRING?, parameters :: MAP?, planner :: STRING?, runtime :: STRING?, indexes :: LIST? OF MAP?, startTime :: STRING?, protocol :: STRING?, clientAddress :: STRING?, requestUri :: STRING?, status :: STRING?, resourceInformation :: MAP?, activeLockCount :: INTEGER?, elapsedTimeMillis :: INTEGER?, cpuTimeMillis :: INTEGER?, waitTimeMillis :: INTEGER?, idleTimeMillis :: INTEGER?, allocatedBytes :: INTEGER?, pageHits :: INTEGER?, pageFaults :: INTEGER?, connectionId :: STRING?, database :: STRING?)
Mode	`DBMS`
Default roles	`reader, editor, publisher, architect, admin`

Table 61. dbms.listTransactions()
Description	List all transactions currently executing at this instance that are visible to the user.
Signature	dbms.listTransactions() :: (transactionId :: STRING?, username :: STRING?, metaData :: MAP?, startTime :: STRING?, protocol :: STRING?, clientAddress :: STRING?, requestUri :: STRING?, currentQueryId :: STRING?, currentQuery :: STRING?, activeLockCount :: INTEGER?, status :: STRING?, resourceInformation :: MAP?, elapsedTimeMillis :: INTEGER?, cpuTimeMillis :: INTEGER?, waitTimeMillis :: INTEGER?, idleTimeMillis :: INTEGER?, allocatedBytes :: INTEGER?, allocatedDirectBytes :: INTEGER?, pageHits :: INTEGER?, pageFaults :: INTEGER?, connectionId :: STRING?, initializationStackTrace :: STRING?, database :: STRING?, estimatedUsedHeapMemory :: INTEGER?)
Mode	`DBMS`
Default roles	`reader, editor, publisher, architect, admin`

Table 62. dbms.procedures()
Description	List all procedures in the DBMS.
Signature	`dbms.procedures() :: (name :: STRING?, signature :: STRING?, description :: STRING?, mode :: STRING?, defaultBuiltInRoles :: LIST? OF STRING?, worksOnSystem :: BOOLEAN?)`
Mode	`DBMS`
Default roles	`reader, editor, publisher, architect, admin`

Table 63. 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`
Default roles	`reader, editor, publisher, architect, admin`

Table 64. 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`
Default roles	`reader, editor, publisher, architect, admin`

Table 65. dbms.scheduler.groups()
Description	List the job groups that are active in the database internal job scheduler.
Signature	`dbms.scheduler.groups() :: (group :: STRING?, threads :: INTEGER?)`
Mode	`DBMS`
Default roles	`admin`

Table 66. dbms.scheduler.profile()
Description	Begin profiling all threads within the given job group, for the specified duration. Note that profiling incurs overhead to a system, and will slow it down.
Signature	`dbms.scheduler.profile(method :: STRING?, group :: STRING?, duration :: STRING?) :: (profile :: STRING?)`
Mode	`DBMS`
Default roles	`admin`

Table 67. dbms.security.activateUser()
Description	Activate a suspended user.
Signature	`dbms.security.activateUser(username :: STRING?, requirePasswordChange = true :: BOOLEAN?) :: VOID`
Mode	`WRITE`
Default roles	`admin`

Table 68. dbms.security.addRoleToUser()
Description	Assign a role to the user.
Signature	`dbms.security.addRoleToUser(roleName :: STRING?, username :: STRING?) :: VOID`
Mode	`WRITE`
Default roles	`admin`

Table 69. dbms.security.changePassword()
Description	Change the current user’s password.
Signature	`dbms.security.changePassword(password :: STRING?, requirePasswordChange = false :: BOOLEAN?) :: VOID`
Mode	`WRITE`
Default roles	`reader, editor, publisher, architect, admin`

Table 70. dbms.security.changeUserPassword()
Description	Change the given user’s password.
Signature	`dbms.security.changeUserPassword(username :: STRING?, newPassword :: STRING?, requirePasswordChange = true :: BOOLEAN?) :: VOID`
Mode	`WRITE`
Default roles	`admin`

Table 71. dbms.security.clearAuthCache()
Description	Clears authentication and authorization cache.
Signature	`dbms.security.clearAuthCache() :: VOID`
Mode	`DBMS`
Default roles	`admin`

Table 72. dbms.security.createRole()
Description	Create a new role.
Signature	`dbms.security.createRole(roleName :: STRING?) :: VOID`
Mode	`WRITE`
Default roles	`admin`

Table 73. dbms.security.createUser()
Description	Create a new user.
Signature	`dbms.security.createUser(username :: STRING?, password :: STRING?, requirePasswordChange = true :: BOOLEAN?) :: VOID`
Mode	`WRITE`
Default roles	`admin`

Table 74. dbms.security.deleteRole()
Description	Delete the specified role. Any role assignments will be removed.
Signature	`dbms.security.deleteRole(roleName :: STRING?) :: VOID`
Mode	`WRITE`
Default roles	`admin`

Table 75. dbms.security.deleteUser()
Description	Delete the specified user.
Signature	`dbms.security.deleteUser(username :: STRING?) :: VOID`
Mode	`WRITE`
Default roles	`admin`

Table 76. dbms.security.listRoles()
Description	List all available roles.
Signature	`dbms.security.listRoles() :: (role :: STRING?, users :: LIST? OF STRING?)`
Mode	`READ`
Default roles	`admin`

Table 77. dbms.security.listRolesForUser()
Description	List all roles assigned to the specified user.
Signature	`dbms.security.listRolesForUser(username :: STRING?) :: (value :: STRING?)`
Mode	`READ`
Default roles	`admin`

Table 78. dbms.security.listUsers()
Description	List all native users.
Signature	`dbms.security.listUsers() :: (username :: STRING?, roles :: LIST? OF STRING?, flags :: LIST? OF STRING?)`
Mode	`READ`
Default roles	`admin`

Table 79. dbms.security.listUsersForRole()
Description	List all users currently assigned the specified role.
Signature	`dbms.security.listUsersForRole(roleName :: STRING?) :: (value :: STRING?)`
Mode	`READ`
Default roles	`admin`

Table 80. dbms.security.removeRoleFromUser()
Description	Unassign a role from the user.
Signature	`dbms.security.removeRoleFromUser(roleName :: STRING?, username :: STRING?) :: VOID`
Mode	`WRITE`
Default roles	`admin`

Table 81. dbms.security.suspendUser()
Description	Suspend the specified user.
Signature	`dbms.security.suspendUser(username :: STRING?) :: VOID`
Mode	`WRITE`
Default roles	`admin`

Table 82. dbms.setConfigValue()
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`
Default roles	`admin`

Table 83. dbms.showCurrentUser()
Description	Show the current user.
Signature	`dbms.showCurrentUser() :: (username :: STRING?, roles :: LIST? OF STRING?, flags :: LIST? OF STRING?)`
Mode	`DBMS`
Default roles	`reader, editor, publisher, architect, admin`

Table 84. dbms.upgrade()
Description	Upgrade the system database schema if it is not the current schema.
Signature	`dbms.upgrade() :: (status :: STRING?, upgradeResult :: STRING?)`
Mode	`WRITE`
Default roles	`admin`

Table 85. dbms.upgradeStatus()
Description	Report the current status of the system database sub-graph schema.
Signature	`dbms.upgradeStatus() :: (status :: STRING?, description :: STRING?, resolution :: STRING?)`
Mode	`READ`
Default roles	`admin`

Table 86. tx.getMetaData()
Description	Provides attached transaction metadata.
Signature	`tx.getMetaData() :: (metadata :: MAP?)`
Mode	`DBMS`
Default roles	`reader, editor, publisher, architect, admin`

Table 87. 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`
Default roles	`reader, editor, publisher, architect, admin`