过程

本页面提供了 Neo4j 内置过程的完整参考。

有关已弃用和已移除过程的列表，请参阅页面 Neo4j 2025.x 中的变更、弃用和移除。

服务器上可用过程取决于几个因素

Neo4j 企业版提供比 Neo4j 社区版更丰富的过程集。
Neo4j 的 APOC Core 库和 GenAI 插件默认安装在 Aura 实例上，但需要单独安装在本地服务器上。
集群成员拥有在独立模式下不可用的过程。

要检查 Neo4j DBMS 中可用的过程，请使用 Cypher 命令 SHOW PROCEDURES

列出具有默认输出列的可用过程

SHOW PROCEDURES

列出具有完整输出列的可用过程

SHOW PROCEDURES YIELD *

某些过程只能由具有 Admin 权限的用户运行。具体来说，需要 EXECUTE ADMIN PROCEDURES 权限，或同时具有 EXECUTE PROCEDURES 和 EXECUTE BOOSTED PROCEDURES 权限。这些过程标有仅限管理员。

更多信息，请参阅 EXECUTE 权限部分。

认证与授权

更多信息，请参阅认证与授权。

dbms.security.clearAuthCache()

详情
语法	`dbms.security.clearAuthCache()`
描述	清除认证和授权缓存。
模式	DBMS

dbms.security.reloadTLS()

详情
语法	`dbms.security.reloadTLS()`
描述	触发所有 TLS 证书和配置的动态重新加载。
模式	DBMS

dbms.showCurrentUser()

详情
语法	`dbms.showCurrentUser() :: (username, roles, flags)`
描述	显示当前用户。
返回参数	名称	类型	描述
	`username`	`字符串`	当前用户的名称。
	`roles`	`字符串列表`	分配给当前用户的角色。
	`flags`	`字符串列表`	当前用户设置的标志。
模式	DBMS

后台作业管理

更多信息，请参阅管理后台作业。

dbms.scheduler.failedJobs()

详情
语法	`dbms.scheduler.failedJobs() :: (jobId, group, database, submitter, description, type, submitted, executionStart, failureTime, failureDescription)`
描述	列出失败的作业运行。历史数据量有限制。
返回参数	名称	类型	描述
	`jobId`	`字符串`	失败作业的 ID。
	`group`	`字符串`	失败作业的类别。
	`database`	`字符串`	作业失败所在数据库的名称。
	`submitter`	`字符串`	失败作业的创建者。
	`description`	`字符串`	失败作业的信息。
	`type`	`字符串`	失败作业的间隔。
	`submitted`	`字符串`	失败作业的提交时间。
	`executionStart`	`字符串`	失败作业的开始时间。
	`failureTime`	`字符串`	失败作业的失败时间。
	`failureDescription`	`字符串`	作业失败的信息。
模式	DBMS

此过程不被视为多线程安全运行。因此，并行运行时不支持它。更多信息，请参阅 Cypher 手册 → 并行运行时。

dbms.scheduler.groups()

详情
语法	`dbms.scheduler.groups() :: (group, threads)`
描述	列出数据库内部作业调度器中活跃的作业组。
返回参数	名称	类型	描述
	`group`	`字符串`	作业组的名称。
	`threads`	`整型`	该作业组中活跃线程的数量。
模式	DBMS

此过程不被视为多线程安全运行。因此，并行运行时不支持它。更多信息，请参阅 Cypher 手册 → 并行运行时。

dbms.scheduler.jobs()

详情
语法	`dbms.scheduler.jobs() :: (jobId, group, submitted, database, submitter, description, type, scheduledAt, period, state, currentStateDescription)`
描述	列出数据库内部作业调度器中所有活跃的作业。
返回参数	名称	类型	描述
	`jobId`	`字符串`	作业的 ID。
	`group`	`字符串`	作业的类别。
	`submitted`	`字符串`	作业的提交时间。
	`database`	`字符串`	作业所在数据库的名称。
	`submitter`	`字符串`	作业的创建者。
	`description`	`字符串`	作业的信息。
	`type`	`字符串`	作业的间隔。
	`scheduledAt`	`字符串`	作业的开始时间。
	`period`	`字符串`	定期运行作业的间隔。
	`state`	`字符串`	作业状态：（'执行中'，'已调度'）。
	`currentStateDescription`	`字符串`	作业状态的描述。
模式	DBMS

此过程不被视为多线程安全运行。因此，并行运行时不支持它。更多信息，请参阅 Cypher 手册 → 并行运行时。

变更数据捕获 (CDC)

更多信息，请参阅 CDC 文档。

cdc.current()

详情
语法	`cdc.current() :: (id)`
描述	返回可用于流式传输变更的当前变更标识符。
返回参数	名称	类型	描述
	`id`	`字符串`	变更标识符。
模式	读取
替换为	`db.cdc.current()`

cdc.earliest()

详情
语法	`cdc.earliest() :: (id)`
描述	返回可用于流式传输变更的最早变更标识符。
返回参数	名称	类型	描述
	`id`	`字符串`	变更标识符。
模式	读取
替换为	`db.cdc.earliest()`

cdc.query()

详情
语法	`cdc.query([ from selectors ]) :: (id, txId, seq, metadata, event)`
描述	从提供的变更标识符查询发生的变更。
输入参数	名称	类型	描述
	`from`	`字符串`	查询变更的变更标识符。
	`selectors`	`映射列表`	可选的选择器列表，用于筛选变更。
返回参数	名称	类型	描述
	`id`	`字符串`	此变更事件的变更标识符。用于从此变更事件继续查询。
	`txId`	`整型`	标识变更发生所在事务的数字，与 seq 结合使用时是唯一的。
	`seq`	`整型`	用于对同一事务中发生的变更进行排序的数字。
	`metadata`	`映射`	导致此变更事件的事务元数据。
	`event`	`映射`	受影响实体上检索到的变更。
模式	读取
替换为	`db.cdc.query()`

db.cdc.current()

详情
语法	`db.cdc.current() :: (id)`
描述	返回可用于流式传输变更的当前变更标识符。
返回参数	名称	类型	描述
	`id`	`字符串`	变更标识符。
模式	读取

db.cdc.earliest()

详情
语法	`db.cdc.earliest() :: (id)`
描述	返回可用于流式传输变更的最早变更标识符。
返回参数	名称	类型	描述
	`id`	`字符串`	变更标识符。
模式	读取

db.cdc.query()

详情
语法	`db.cdc.query([ from selectors ]) :: (id, txId, seq, metadata, event)`
描述	从提供的变更标识符查询发生的变更。
输入参数	名称	类型	描述
	`from`	`字符串`	查询变更的变更标识符。
	`selectors`	`映射列表`	可选的选择器列表，用于筛选变更。
返回参数	名称	类型	描述
	`id`	`字符串`	此变更事件的变更标识符。用于从此变更事件继续查询。
	`txId`	`整型`	标识变更发生所在事务的数字，与 seq 结合使用时是唯一的。
	`seq`	`整型`	用于对同一事务中发生的变更进行排序的数字。
	`metadata`	`映射`	导致此变更事件的事务元数据。
	`event`	`映射`	受影响实体上检索到的变更。
模式	读取

db.cdc.translateId()

详情
语法	`db.cdc.translateId(from :: STRING) :: (id :: STRING)`
描述	翻译任何提供的变更标识符以匹配查询的数据库。
输入参数	名称	类型	描述
输入参数	`from`	`字符串`	要翻译的变更标识符。
返回参数	名称	类型	描述
返回参数	`id`	`字符串`	变更标识符。
模式	读取

集群管理

更多信息，请参阅集群。

dbms.cluster.checkConnectivity()

详情
语法	`dbms.cluster.checkConnectivity([ port-name server ]) :: (serverId, name, address, mode-constraint, port-name, port-address, result)`
描述	检查此实例与其他集群成员的连接。并非所有端口都与所有成员相关。'port-name' 的有效值为：[CLUSTER, INTRA_BOLT, RAFT]
输入参数	名称	类型	描述
	`端口名称`	`字符串`	端口名称：（'CLUSTER'，'RAFT'）。
	`server`	`字符串`	要检查连接的服务器 ID。
返回参数	名称	类型	描述
	`serverId`	`字符串`	已检查服务器的 ID。
	`name`	`字符串`	name :: 字符串
	`address`	`字符串`	address :: 字符串
	`模式约束`	`字符串`	服务器的实例模式约束。
	`端口名称`	`字符串`	已检查端口的名称。
	`端口地址`	`字符串`	已检查端口的地址。
	`结果`	`字符串`	检查是否成功。
模式	DBMS

dbms.cluster.cordonServer()

详情
语法	`dbms.cluster.cordonServer(server)`
描述	将拓扑中的服务器标记为不适合新的分配。它不会强制将当前分配从服务器上移除。这在有多个不可用服务器时解除数据库分配很有用。
输入参数	名称	类型	描述
	`server`	`字符串`	要隔离服务器的名称或 ID。
模式	写入
所需权限	`服务器管理`

使用管理员权限运行此过程已被弃用。

dbms.cluster.deallocateDatabaseFromServer()

详情
语法	`dbms.cluster.deallocateDatabaseFromServer(server, database [, dryrun ]) :: (database, fromServerName, fromServerId, toServerName, toServerId, mode)`
描述	从特定服务器解除特定用户数据库的分配。
输入参数	名称	类型	描述
	`server`	`字符串`	要解除分配的服务器 ID。
	`database`	`字符串`	要解除分配的数据库名称。
	`dryrun`	`布尔值`	设置为 `true` 以进行过程空运行。
返回参数	名称	类型	描述
	`database`	`字符串`	数据库名称。
	`fromServerName`	`字符串`	服务器名称。
	`fromServerId`	`字符串`	服务器 ID。
	`toServerName`	`字符串`	服务器名称。
	`toServerId`	`字符串`	服务器 ID。
	`mode`	`字符串`	数据库托管模式。
模式	写入
所需权限	`服务器管理`

dbms.cluster.deallocateDatabaseFromServers()

详情
语法	`dbms.cluster.deallocateDatabaseFromServers(servers, database [, dryrun ]) :: (database, fromServerName, fromServerId, toServerName, toServerId, mode)`
描述	从服务器列表解除特定用户数据库的分配。
输入参数	名称	类型	描述
	`servers`	`字符串列表`	要解除分配的服务器 ID。
	`database`	`字符串`	要解除分配的数据库 ID。
	`dryrun`	`布尔值`	设置为 `true` 以进行过程空运行。
返回参数	名称	类型	描述
	`database`	`字符串`	数据库名称。
	`fromServerName`	`字符串`	服务器名称。
	`fromServerId`	`字符串`	服务器 ID。
	`toServerName`	`字符串`	服务器名称。
	`toServerId`	`字符串`	服务器 ID。
	`mode`	`字符串`	数据库托管模式。
模式	写入
所需权限	`服务器管理`

dbms.cluster.deallocateNumberOfDatabases()

详情
语法	`dbms.cluster.deallocateNumberOfDatabases(server, number [, dryrun ]) :: (database, fromServerName, fromServerId, toServerName, toServerId, mode)`
描述	从特定服务器解除多个用户数据库的分配。
输入参数	名称	类型	描述
	`server`	`字符串`	要解除分配的服务器 ID。
	`number`	`整型`	要解除分配的数据库数量。
	`dryrun`	`布尔值`	设置为 `true` 以进行过程空运行。
返回参数	名称	类型	描述
	`database`	`字符串`	数据库名称。
	`fromServerName`	`字符串`	服务器名称。
	`fromServerId`	`字符串`	服务器 ID。
	`toServerName`	`字符串`	服务器名称。
	`toServerId`	`字符串`	服务器 ID。
	`mode`	`字符串`	数据库托管模式。
模式	写入
所需权限	`服务器管理`

dbms.cluster.protocols()

详情
语法	`dbms.cluster.protocols() :: (orientation, remoteAddress, applicationProtocol, applicationProtocolVersion, modifierProtocols)`
描述	已安装协议概述
返回参数	名称	类型	描述
	`方向`	`字符串`	协议方向（入站或出站）。
	`远程地址`	`字符串`	此协议可用的套接字地址。
	`应用程序协议`	`字符串`	协议名称。
	`应用程序协议版本`	`整型`	协议版本。
	`修改器协议`	`字符串`	已安装的修改器协议，例如压缩。
模式	DBMS

dbms.cluster.readReplicaToggle()

详情
语法	`dbms.cluster.readReplicaToggle(databaseName, pause) :: (state)`
描述	此开关可以暂停或恢复只读副本（已弃用，请使用 dbms.cluster.secondaryReplicationDisable）
输入参数	名称	类型	描述
	`databaseName`	`字符串`	要切换辅助复制进程的数据库名称。
	`pause`	`布尔值`	是否启用/禁用辅助复制进程。
返回参数	名称	类型	描述
返回参数	`state`	`字符串`	辅助复制进程的当前状态。
模式	DBMS

有何用途？

您可以执行时间点备份，因为备份将仅包含直到事务拉取暂停时的事务。请按照以下步骤操作：

直接连接到以辅助模式托管数据库的服务器。（Neo4j 驱动程序使用 bolt:// 或使用 HTTP API）。
暂停指定数据库的事务拉取。
备份数据库，请参阅备份在线数据库。

如果直接连接到以辅助模式托管数据库的服务器，数据科学家可以在暂停的特定数据库上执行分析，在执行分析时数据不会意外更改。

此过程只能在连接服务器上以辅助角色运行的数据库上执行。

暂停数据库 neo4j 的事务拉取

CALL dbms.cluster.readReplicaToggle("neo4j", true)

恢复数据库 neo4j 的事务拉取

CALL dbms.cluster.readReplicaToggle("neo4j", false)

dbms.cluster.reallocateDatabase()

详情
语法	`dbms.cluster.reallocateDatabase(database [, dryrun ]) :: (database, fromServerName, fromServerId, toServerName, toServerId, mode)`
描述	重新分配特定数据库。
输入参数	名称	类型	描述
	`database`	`字符串`	要重新分配的数据库名称。
	`dryrun`	`布尔值`	设置为 `true` 以进行过程空运行。
返回参数	名称	类型	描述
	`database`	`字符串`	数据库名称。
	`fromServerName`	`字符串`	服务器名称。
	`fromServerId`	`字符串`	服务器 ID。
	`toServerName`	`字符串`	服务器名称。
	`toServerId`	`字符串`	服务器 ID。
	`mode`	`字符串`	数据库托管模式。
模式	写入
所需权限	`服务器管理`

dbms.cluster.reallocateNumberOfDatabases()

详情
语法	`dbms.cluster.reallocateNumberOfDatabases(number [, dryrun ]) :: (database, fromServerName, fromServerId, toServerName, toServerId, mode)`
描述	重新分配指定数量的用户数据库。
输入参数	名称	类型	描述
	`number`	`整型`	要重新分配的数据库数量。
	`dryrun`	`布尔值`	设置为 `true` 以进行过程空运行。
返回参数	名称	类型	描述
	`database`	`字符串`	数据库名称。
	`fromServerName`	`字符串`	服务器名称。
	`fromServerId`	`字符串`	服务器 ID。
	`toServerName`	`字符串`	服务器名称。
	`toServerId`	`字符串`	服务器 ID。
	`mode`	`字符串`	数据库托管模式。
模式	写入
所需权限	`服务器管理`

dbms.cluster.recreateDatabase()

详情
语法	`dbms.cluster.recreateDatabase(database :: STRING, options = {} :: MAP)`
描述	在保留所有 RBAC 设置的同时重新创建数据库。此过程启动一个进程，完成后，将同步并启动集群中的所有数据库实例。
输入参数	名称	类型	描述
	`database`	`字符串`	要重新创建的数据库名称。
	`options`	`映射`	用于重新创建数据库的种子和拓扑选项。
模式	写入

必须在 options 字段中指定 seedURI 或 seedingServers 作为种子选项。

如果未定义拓扑选项，数据库将使用先前的拓扑重新创建。

关于如何使用 dbms.recreateDatabase() 过程的更多详细信息，请参阅数据库管理 → 重新创建数据库部分。

dbms.cluster.routing.getRoutingTable()

详情
语法	`dbms.cluster.routing.getRoutingTable(context [, database ]) :: (ttl, servers)`
描述	返回给定数据库的已公布的 Bolt 可用端点，按每个端点的功能划分。例如，一个端点可能提供读取查询、写入查询和/或未来的 `getRoutingTable` 请求。
输入参数	名称	类型	描述
	`context`	`映射`	路由上下文，例如路由策略。
	`database`	`字符串`	要获取路由表的数据库。
返回参数	名称	类型	描述
	`ttl`	`整型`	路由表的存活时间（秒）。
	`servers`	`映射列表`	按服务器是读取器、写入器还是路由器进行分组。
模式	DBMS

dbms.cluster.secondaryReplicationDisable()

详情
语法	`dbms.cluster.secondaryReplicationDisable(databaseName, pause) :: (state)`
描述	此开关可以暂停或恢复辅助复制进程。
输入参数	名称	类型	描述
	`databaseName`	`字符串`	要切换辅助复制进程的数据库名称。
	`pause`	`布尔值`	是否启用/禁用辅助复制进程。
返回参数	名称	类型	描述
返回参数	`state`	`字符串`	辅助复制进程的当前状态。
模式	DBMS

有何用途？

您可以执行时间点备份，因为备份将仅包含直到事务拉取暂停时的事务。请按照以下步骤操作：

直接连接到以辅助模式托管数据库的服务器。（Neo4j 驱动程序使用 bolt:// 或使用 HTTP API）。
暂停指定数据库的事务拉取。
备份数据库，请参阅备份在线数据库。

如果直接连接到以辅助模式托管数据库的服务器，数据科学家可以在暂停的特定数据库上执行分析，在执行分析时数据不会意外更改。

此过程只能在连接服务器上以辅助角色运行的数据库上执行。

暂停数据库 neo4j 的事务拉取

CALL dbms.cluster.secondaryReplicationDisable("neo4j", true)

恢复数据库 neo4j 的事务拉取

CALL dbms.cluster.secondaryReplicationDisable("neo4j", false)

dbms.cluster.setAutomaticallyEnableFreeServers()

详情
语法	`dbms.cluster.setAutomaticallyEnableFreeServers(autoEnable)`
描述	使用此方法可以设置是否自动启用空闲服务器。
输入参数	名称	类型	描述
	`autoEnable`	`布尔值`	是否自动启用空闲服务器。
模式	写入
所需权限	`服务器管理`

使用管理员权限运行此过程已被弃用。

dbms.cluster.statusCheck()

详情
语法	`dbms.cluster.statusCheck(databases, timeoutMilliseconds) :: (database, serverId, serverName, address, replicationSuccessful, memberStatus, recognisedLeader, recognisedLeaderTerm, requester, error)`
描述	执行 Raft 状态检查。
输入参数	名称	类型	描述
	`databases`	`字符串列表`	应该运行状态检查的数据库。提供空列表将对该服务器上的所有集群数据库运行状态检查，即它不会在单实例或辅助数据库上运行。
	`timeoutMilliseconds`	`整型`	指定复制的最大等待时间，超过此时间则标记为不成功。默认值为 1000 毫秒。
返回参数	名称	类型	描述
	`database`	`字符串`	复制了状态检查条目的数据库。
	`serverId`	`字符串`	服务器的 UUID，该服务器是否参与了状态检查条目的成功复制。
	`serverName`	`字符串`	服务器的友好名称，如果未设置名称则为其 UUID。
	`address`	`字符串`	服务器 Bolt 端口的地址。
	`replicationSuccessful`	`布尔值`	指示服务器（运行过程的服务器）是否可以复制事务。
	`memberStatus`	`字符串`	每个主成员的状态。
	`recognisedLeader`	`字符串`	每个主成员感知到的领导者的服务器 ID。
	`recognisedLeaderTerm`	`整型`	每个主成员感知到的领导者的任期。如果成员报告不同的领导者，应信任任期最高的那一个。
	`requester`	`布尔值`	服务器是否为请求者。
	`error`	`字符串`	如果存在，包含任何错误消息。错误的示例是请求者上不存在一个或多个请求的数据库。
模式	DBMS

dbms.cluster.uncordonServer()

详情
语法	`dbms.cluster.uncordonServer(server)`
描述	移除服务器上的隔离，使其返回“已启用”状态。
输入参数	名称	类型	描述
	`server`	`字符串`	要解除隔离服务器的名称或 ID。
模式	写入
替换为	`启用服务器`
所需权限	`服务器管理`

使用管理员权限运行此过程已被弃用。

dbms.recreateDatabase()

详情
语法	`dbms.recreateDatabase(database :: STRING, options = {} :: MAP)`
描述	在保留所有 RBAC 设置的同时重新创建数据库。此过程启动一个进程，完成后，将同步并启动集群中的所有数据库实例。
输入参数	名称	类型	描述
	`database`	`字符串`	要重新创建的数据库名称。
	`options`	`映射`	用于重新创建数据库的种子和拓扑选项。
模式	写入

必须在 options 字段中指定 seedURI、seedingServers 或 clearData 来定义重新创建应基于哪些存储。关于如何使用 dbms.recreateDatabase() 过程的更多详细信息，请参阅相关部分数据库管理 → 重新创建数据库。如果未定义拓扑选项，数据库将使用先前的拓扑重新创建。

dbms.setDefaultAllocationNumbers()

详情
语法	`dbms.setDefaultAllocationNumbers(primaries, secondaries)`
描述	使用此方法可以设置主副本和辅助副本的默认数量。
输入参数	名称	类型	描述
	`primaries`	`整型`	主副本的默认数量。
	`secondaries`	`整型`	辅助副本的默认数量。
模式	写入

dbms.showTopologyGraphConfig()

详情
语法	`dbms.showTopologyGraphConfig() :: (allocator, defaultPrimariesCount, defaultSecondariesCount, defaultDatabase, autoEnableFreeServers)`
描述	使用此方法可以显示拓扑图的配置。
返回参数	名称	类型	描述
	`分配器`	`字符串`	分配器名称。
	`defaultPrimariesCount`	`整型`	主副本的默认数量。
	`defaultSecondariesCount`	`整型`	辅助副本的默认数量。
	`defaultDatabase`	`字符串`	默认数据库的名称。
	`autoEnableFreeServers`	`布尔值`	是否自动启用空闲服务器。
模式	读取

从 Neo4j 2025.04 开始，默认数据库也可以设置为本地或远程数据库别名。

配置和 DBMS 信息

更多信息，请参阅配置。

dbms.checkConfigValue()

详情
语法	`dbms.checkConfigValue(setting, value) :: (valid, message)`
描述	检查潜在配置设置值是否有效。
输入参数	名称	类型	描述
	`setting`	`字符串`	设置名称。
	`value`	`字符串`	要验证的设置值。
返回参数	名称	类型	描述
	`valid`	`布尔值`	设置值是否有效。
	`message`	`字符串`	过程结果的详细信息。
模式	DBMS

此过程不被视为多线程安全运行。因此，并行运行时不支持它。更多信息，请参阅 Cypher 手册 → 并行运行时。

dbms.components()

详情
语法	`dbms.components() :: (name, versions, edition)`
描述	列出 DBMS 组件及其版本。
返回参数	名称	类型	描述
	`name`	`字符串`	组件名称。
	`versions`	`字符串列表`	组件的已安装版本。
	`edition`	`字符串`	DBMS 的 Neo4j 版本。
模式	DBMS

dbms.info()

详情
语法	`dbms.info() :: (id, name, creationDate)`
描述	提供关于 DBMS 的信息。
返回参数	名称	类型	描述
	`id`	`字符串`	DBMS 的 ID。
	`name`	`字符串`	DBMS 的名称。
	`creationDate`	`字符串`	DBMS 的创建日期。
模式	DBMS

dbms.listCapabilities()

详情
语法	`dbms.listCapabilities() :: (name, description, value)`
描述	列出功能。
返回参数	名称	类型	描述
	`name`	`字符串`	功能的完整名称（例如 "dbms.instance.version"）。
	`description`	`字符串`	功能描述（例如 "此实例正在运行的 Neo4j 版本"）。
	`value`	`任意`	如果系统中存在该功能对象（例如 "5.20.0"）。
模式	DBMS

dbms.listConfig()

详情
语法	`dbms.listConfig([ searchString ]) :: (name, description, value, dynamic, defaultValue, startupValue, explicitlySet, validValues)`
描述	列出 Neo4j 当前活跃的配置设置。
输入参数	名称	类型	描述
输入参数	`searchString`	`字符串`	用于按配置设置名称筛选的字符串。
返回参数	名称	类型	描述
	`name`	`字符串`	设置名称。
	`description`	`字符串`	设置的描述。
	`value`	`字符串`	设置的已设定值。
	`dynamic`	`布尔值`	设置是否可以动态设置。
	`defaultValue`	`字符串`	设置的默认值。
	`startupValue`	`字符串`	数据库启动时设置的值。
	`explicitlySet`	`布尔值`	设置是否已明确设置。
	`validValues`	`字符串`	有效值的描述。
模式	DBMS

dbms.setConfigValue()

详情
语法	`dbms.setConfigValue(setting, value)`
描述	更新给定设置值。传入空值将移除配置值并回退到默认值。更改不持久，如果服务器重新启动将丢失。在集群环境中，`dbms.setConfigValue` 只影响其运行所在的集群成员。
输入参数	名称	类型	描述
	`setting`	`字符串`	设置名称。
	`value`	`字符串`	要设置的值。
模式	DBMS

dbms.listPools()

详情
语法	`dbms.listPools() :: (pool, databaseName, heapMemoryUsed, heapMemoryUsedBytes, nativeMemoryUsed, nativeMemoryUsedBytes, freeMemory, freeMemoryBytes, totalPoolMemory, totalPoolMemoryBytes)`
描述	列出此实例中当前注册的、用户可见的所有内存池，包括子池。
返回参数	名称	类型	描述
	`pool`	`字符串`	内存池的名称。
	`databaseName`	`字符串`	数据库名称。
	`heapMemoryUsed`	`字符串`	已使用的堆内存量。
	`heapMemoryUsedBytes`	`字符串`	已使用的堆内存量（字节）。
	`nativeMemoryUsed`	`字符串`	已使用的本地内存量。
	`nativeMemoryUsedBytes`	`字符串`	已使用的本地内存量（字节）。
	`freeMemory`	`字符串`	可用内存量。
	`freeMemoryBytes`	`字符串`	可用内存量（字节）。
	`totalPoolMemory`	`字符串`	总池内存。
	`totalPoolMemoryBytes`	`字符串`	总池内存（字节）。
模式	DBMS

此过程不被视为多线程安全运行。因此，并行运行时不支持它。更多信息，请参阅 Cypher 手册 → 并行运行时。

连接管理

更多信息，请参阅管理连接。

dbms.listConnections()

详情
语法	`dbms.listConnections() :: (connectionId, connectTime, connector, username, userAgent, serverAddress, clientAddress)`
描述	列出此实例中所有已接受的、用户可见的网络连接。
返回参数	名称	类型	描述
	`connectionId`	`字符串`	连接 ID。
	`connectTime`	`字符串`	连接建立时间，按照 ISO-8601 标准格式化。
	`connector`	`字符串`	连接器协议。
	`username`	`字符串`	username
	`已连接用户的用户名。`	`字符串`	userAgent
	`活跃代理。`	`字符串`	serverAddress
	`已连接服务器的地址。`	`字符串`	clientAddress
模式	DBMS

已连接客户端的地址。

详情
语法	`dbms.killConnection()`
描述	dbms.killConnection(id) :: (connectionId, username, message)
输入参数	名称	类型	描述
输入参数	`id`	`字符串`	终止具有给定连接 ID 的网络连接。
返回参数	名称	类型	描述
	`connectionId`	`字符串`	要终止的连接 ID。
	`username`	`字符串`	已终止连接的 ID。
	`message`	`字符串`	过程结果的详细信息。
模式	DBMS

已终止连接用户的用户名。

详情
语法	`dbms.killConnections()`
描述	dbms.killConnections(ids) :: (connectionId, username, message)
输入参数	名称	类型	描述
输入参数	`终止所有具有给定连接 ID 的网络连接。`	`字符串列表`	ids
返回参数	名称	类型	描述
	`connectionId`	`字符串`	要终止的连接 ID。
	`username`	`字符串`	已终止连接的 ID。
	`message`	`字符串`	过程结果的详细信息。
模式	DBMS

要终止的连接 ID。

数据库管理

检查点是否已成功完成。

详情
语法	`db.info()`
描述	db.info() :: (id, name, creationDate)
返回参数	名称	类型	描述
	`id`	`字符串`	提供关于数据库的信息。
	`name`	`字符串`	数据库名称。
	`creationDate`	`字符串`	数据库 ID。
模式	读取

数据库创建日期，按照 ISO-8601 标准格式化。

详情
语法	`dbms.listActiveLocks()`
描述	dbms.listActiveLocks(queryId) :: (mode, resourceType, resourceId)
输入参数	名称	类型	描述
输入参数	`列出为执行给定查询 ID 的事务授予的活跃锁请求。`	`字符串`	queryId
返回参数	名称	类型	描述
	`mode`	`字符串`	要检查活跃锁的查询 ID。
	`锁类型：（'共享'，'排他'）。`	`字符串`	resourceType
	`被锁定资源。`	`整型`	resourceId
模式	DBMS

此过程不被视为多线程安全运行。因此，并行运行时不支持它。更多信息，请参阅 Cypher 手册 → 并行运行时。

被锁定资源的 ID。

详情
语法	`db.listLocks()`
描述	db.listLocks() :: (mode, resourceType, resourceId, transactionId)
返回参数	名称	类型	描述
	`mode`	`字符串`	列出此数据库中的所有锁。
	`锁类型：（'共享'，'排他'）。`	`字符串`	此锁使用的锁定模式，可以是“SHARED”或“EXCLUSIVE”。
	`被锁定资源。`	`整型`	此锁保护的资源类型（例如节点、关系、标签）。
	`此锁保护的资源 ID。`	`字符串`	transactionId
模式	DBMS

拥有此锁的事务 ID。

详情
语法	`db.ping()`
描述	db.ping() :: (success)
返回参数	名称	类型	描述
	`启动并等待新的检查点，或等待任何已在进行的检查点完成。请注意，这会暂时禁用 db.checkpoint.iops.limit 设置，以便检查点更快完成。这可能会导致事务吞吐量略有下降，因为 IO 负载增加。`	`布尔值`	客户端工具可以使用此过程来测试它们是否正确连接到数据库。此过程在所有数据库中都可用，并且始终返回 true。无法调用此过程时可以检测到连接故障。
模式	读取

连接到数据库的调用是否成功。

详情
语法	`dbms.routing.getRoutingTable()`
描述	返回给定数据库的已公布的 Bolt 可用端点，按每个端点的功能划分。例如，一个端点可能提供读取查询、写入查询和/或未来的 `getRoutingTable` 请求。
输入参数	名称	类型	描述
	`context`	`映射`	路由上下文，例如路由策略。
	`database`	`字符串`	要获取路由表的数据库。
返回参数	名称	类型	描述
	`ttl`	`整型`	路由表的存活时间（秒）。
	`servers`	`映射列表`	按服务器是读取器、写入器还是路由器进行分组。
模式	DBMS

dbms.routing.getRoutingTable(context [, database ]) :: (ttl, servers)

详情
语法	`dbms.setDefaultDatabase()`
描述	dbms.setDefaultDatabase(databaseName) :: (result)
输入参数	名称	类型	描述
输入参数	`databaseName`	`字符串`	数据库名称。
返回参数	名称	类型	描述
返回参数	`结果`	`字符串`	将默认数据库更改为提供的值。数据库必须存在，并且旧的默认数据库必须已停止。
模式	写入

从 Neo4j 2025.04 开始，默认数据库也可以设置为本地或远程数据库别名。

关于默认数据库的信息。

详情
语法	`dbms.quarantineDatabase()`
描述	dbms.quarantineDatabase(databaseName, setStatus [, reason ]) :: (databaseName, quarantined, result)
输入参数	名称	类型	描述
	`databaseName`	`字符串`	将数据库隔离或解除隔离。
	`要设置隔离状态的数据库名称。`	`布尔值`	setStatus
	`是否隔离数据库。`	`字符串`	reason
返回参数	名称	类型	描述
	`databaseName`	`字符串`	数据库名称。
	`隔离数据库的原因。`	`布尔值`	quarantined
	`结果`	`字符串`	过程结果的详细信息。
模式	DBMS
替换为	`数据库是否已隔离。`

dbms.unquarantineDatabase()

建议使用 `dbms.unquarantineDatabase()` 而非 `dbms.quarantineDatabase()`，因为它有改进和新功能（请参阅 `operation` 选项）。

详情
语法	`dbms.unquarantineDatabase()`
描述	dbms.unquarantineDatabase(server, databaseName, operation) :: ()
输入参数	名称	类型	描述
	`server`	`字符串`	解除给定服务器上数据库的隔离。
	`database`	`字符串`	将解除数据库隔离的服务器标识符。
	`将解除隔离的数据库名称。`	`字符串`	operation
模式	DBMS

解除隔离时要应用的可选操作。

可选操作的可能值为
keepStateKeepStore — 不做任何操作；保持存储和集群状态不变。
replaceStateKeepStore — 作为新成员加入，清除当前集群状态但保留存储。

replaceStateReplaceStore — 作为新成员加入，清除当前集群状态和存储。

如果选择清除当前集群状态，服务器将尝试作为新成员加入，但只有在大多数旧成员“允许”新成员加入的情况下，此加入才能成功。假设我们的集群拓扑中有三个主节点。如果只有一个服务器处于 `QUARANTINED` 模式，则选择 `replaceStateKeepStore` 或 `replaceStateReplaceStore` 是安全的。如果有两个服务器处于 `QUARANTINED` 模式，则不应同时对两个服务器使用 `replaceStateKeepStore` 或 `replaceStateReplaceStore`，因为这样就没有多数来允许它们加入。

详情
语法	`dbms.upgrade()`
描述	dbms.upgrade() :: (status, upgradeResult)
返回参数	名称	类型	描述
	`如果系统数据库模式不是当前模式，则升级它。`	`字符串`	status
	`系统数据库的升级状态。`	`字符串`	upgradeResult
模式	写入

此过程不被视为多线程安全运行。因此，并行运行时不支持它。更多信息，请参阅 Cypher 手册 → 并行运行时。

升级结果的信息。

详情
语法	`dbms.upgradeStatus()`
描述	dbms.upgradeStatus() :: (status, description, resolution)
返回参数	名称	类型	描述
	`如果系统数据库模式不是当前模式，则升级它。`	`字符串`	status
	`description`	`字符串`	报告系统数据库子图模式的当前状态。
	`描述升级状态的信息。`	`字符串`	resolution
模式	读取

此过程不被视为多线程安全运行。因此，并行运行时不支持它。更多信息，请参阅 Cypher 手册 → 并行运行时。

升级所需步骤的信息。

生成式 AI 和向量

生成式 AI 文档 → 嵌入和向量索引教程

详情
语法	`db.create.setNodeVectorProperty`
描述	db.create.setNodeVectorProperty(node, key, vector)
输入参数	名称	类型	描述
	`以比 Cypher 的 SET 更节省空间的方式在给定节点上设置向量属性。`	`node`	节点
	`将存储新属性的节点。`	`字符串`	key
	`新属性的名称。`	`任意`	vector
模式	写入

包含嵌入的对象。

已知问题

`SHOW PROCEDURES` 的过程签名将向量参数呈现为 `ANY` 类型，而不是语义上正确的 `LIST<INTEGER | FLOAT>` 类型。这些类型仍然强制执行为 `LIST<INTEGER | FLOAT>`。

详情
语法	`db.create.setRelationshipVectorProperty()`
描述	db.create.setRelationshipVectorProperty(relationship, key, vector)
输入参数	名称	类型	描述
	`以比 Cypher 的 SET 更节省空间的方式在给定关系上设置向量属性。`	`relationship`	关系
	`将存储新属性的节点。`	`字符串`	key
	`新属性的名称。`	`任意`	vector
模式	写入

包含嵌入的对象。

已知问题

将存储新属性的关系。

详情
语法	`db.create.setVectorProperty()`
描述	db.create.setVectorProperty(node, key, vector) :: (node)
输入参数	名称	类型	描述
	`以比 Cypher 的 SET 更节省空间的方式在给定节点上设置向量属性。`	`node`	节点
	`将存储新属性的节点。`	`字符串`	key
	`新属性的名称。`	`任意`	vector
返回参数	名称	类型	描述
返回参数	`以比 Cypher 的 SET 更节省空间的方式在给定节点上设置向量属性。`	`node`	以比 Cypher 的 SET 更节省空间的方式在给定节点上设置向量属性。
模式	写入
替换为	设置向量属性的节点。

包含嵌入的对象。

已知问题

`db.create.setNodeVectorProperty()` 和 `db.create.setRelationshipVectorProperty()`

详情
语法	`db.index.vector.createNodeIndex()`
描述	db.index.vector.createNodeIndex(indexName, label, propertyKey, vectorDimension, vectorSimilarityFunction)
输入参数	名称	类型	描述
	`为指定标签和属性创建命名节点向量索引，使用给定的向量维度和 EUCLIDEAN 或 COSINE 相似性函数。两种相似性函数均不区分大小写。使用 db.index.vector.queryNodes 过程查询命名索引。`	`字符串`	indexName
	`indexName :: 字符串`	`字符串`	label
	`label :: 字符串`	`字符串`	propertyKey
	`propertyKey :: 字符串`	`整型`	vectorDimension
	`vectorDimension :: 整型`	`字符串`	vectorSimilarityFunction
模式	vectorSimilarityFunction :: 字符串
替换为	模式

Cypher 命令 `CREATE VECTOR INDEX`。更多信息，请参阅 Cypher 手册 → 创建向量索引。

详情
语法	`db.index.vector.queryNodes()`
描述	db.index.vector.queryNodes(indexName, numberOfNearestNeighbours, query) :: (node, score)
输入参数	名称	类型	描述
	`为指定标签和属性创建命名节点向量索引，使用给定的向量维度和 EUCLIDEAN 或 COSINE 相似性函数。两种相似性函数均不区分大小写。使用 db.index.vector.queryNodes 过程查询命名索引。`	`字符串`	查询给定的节点向量索引。返回提供的查询向量的最近邻居数量及其与该查询向量的相似度得分，基于索引配置的相似度函数。相似度得分介于 [0, 1] 之间；其中 0 表示最不相似，1 表示最相似。
	`向量索引的名称。`	`整型`	numberOfNearestNeighbours
	`向量邻域的大小。`	`任意`	query
返回参数	名称	类型	描述
	`以比 Cypher 的 SET 更节省空间的方式在给定节点上设置向量属性。`	`node`	要查找近似匹配的对象。
	`包含与查询对象相似的向量属性的节点。`	`score`	浮点数
模式	读取

衡量节点属性与查询对象相似度的得分。

详情
语法	`db.index.vector.queryRelationships()`
描述	db.index.vector.queryRelationships(indexName, numberOfNearestNeighbours, query) :: (relationship, score)
输入参数	名称	类型	描述
	`为指定标签和属性创建命名节点向量索引，使用给定的向量维度和 EUCLIDEAN 或 COSINE 相似性函数。两种相似性函数均不区分大小写。使用 db.index.vector.queryNodes 过程查询命名索引。`	`字符串`	查询给定的节点向量索引。返回提供的查询向量的最近邻居数量及其与该查询向量的相似度得分，基于索引配置的相似度函数。相似度得分介于 [0, 1] 之间；其中 0 表示最不相似，1 表示最相似。
	`向量索引的名称。`	`整型`	numberOfNearestNeighbours
	`向量邻域的大小。`	`任意`	query
返回参数	名称	类型	描述
	`以比 Cypher 的 SET 更节省空间的方式在给定关系上设置向量属性。`	`relationship`	查询给定的关系向量索引。返回提供的查询向量的最近邻居数量及其与该查询向量的相似度得分，基于索引配置的相似度函数。相似度得分介于 [0, 1] 之间；其中 0 表示最不相似，1 表示最相似。
	`包含与查询对象相似的向量属性的节点。`	`score`	包含与查询对象相似的向量属性的关系。
模式	读取

衡量关系属性与查询对象相似度的得分。

详情
语法	`genai.vector.encodeBatch()`
描述	genai.vector.encodeBatch(resources, provider, configuration) :: (index, resource, vector) 使用指定提供程序将给定批次的资源编码为向量。对于给定资源列表中的每个元素，它返回该列表中对应的“索引”，原始“资源”元素本身，
输入参数	名称	类型	描述
	`和编码的“向量”。`	`字符串列表`	resources
	`要转换为嵌入的对象。`	`字符串`	provider
	`要使用的生成式 AI 提供程序。`	`任意`	configuration
返回参数	名称	类型	描述
	`提供程序特定设置。`	`整型`	index
	`输入列表中对应元素的索引。`	`字符串`	resource
	`新属性的名称。`	`任意`	输入资源的名称。
模式	资源的生成向量嵌入。

默认

包含嵌入的对象。

已知问题

生成式 AI 提供程序的默认值。

生成式 AI 和向量

Cypher 手册 → 全文索引

详情
语法	`db.awaitIndex()`
描述	db.awaitIndex(indexName [, timeOutSeconds ])
输入参数	名称	类型	描述
	`为指定标签和属性创建命名节点向量索引，使用给定的向量维度和 EUCLIDEAN 或 COSINE 相似性函数。两种相似性函数均不区分大小写。使用 db.index.vector.queryNodes 过程查询命名索引。`	`字符串`	等待索引上线（例如：CALL db.awaitIndex("MyIndex", 300)）。
	`等待的索引名称。`	`整型`	timeOutSeconds
模式	读取

此过程不被视为多线程安全运行。因此，并行运行时不支持它。更多信息，请参阅 Cypher 手册 → 并行运行时。

最大等待时间（秒）。

详情
语法	`db.awaitIndexes()`
描述	db.awaitIndexes([ timeOutSeconds ])
输入参数	名称	类型	描述
	`等待的索引名称。`	`整型`	timeOutSeconds
模式	读取

此过程不被视为多线程安全运行。因此，并行运行时不支持它。更多信息，请参阅 Cypher 手册 → 并行运行时。

等待所有索引上线（例如：CALL db.awaitIndexes(300)）。

详情
语法	`db.index.fulltext.awaitEventuallyConsistentIndexRefresh()`
描述	db.index.fulltext.awaitEventuallyConsistentIndexRefresh()
模式	读取

等待最近提交的事务的更新应用于任何最终一致的全文索引。

详情
语法	`db.index.fulltext.listAvailableAnalyzers()`
描述	db.index.fulltext.listAvailableAnalyzers() :: (analyzer, description, stopwords)
返回参数	名称	类型	描述
	`列出可用于配置全文索引的可用分析器。`	`字符串`	analyzer
	`description`	`字符串`	分析器名称。
	`分析器的描述。`	`字符串列表`	stopwords
模式	读取

分析器用于分词字符串的停用词。

详情
语法	`db.index.fulltext.queryNodes()`
描述	db.index.fulltext.queryNodes(indexName, queryString [, options ]) :: (node, score) 查询给定的全文索引。返回匹配的节点及其 Lucene 查询得分，按得分排序。`options` 映射的有效 key: value 对是 'skip' — 跳过前 N 个结果。 'limit' — 限制返回结果的数量。 'analyzer' — 使用指定的分析器作为此查询的搜索分析器。
输入参数	名称	类型	描述
	`为指定标签和属性创建命名节点向量索引，使用给定的向量维度和 EUCLIDEAN 或 COSINE 相似性函数。两种相似性函数均不区分大小写。使用 db.index.vector.queryNodes 过程查询命名索引。`	`字符串`	`options` 映射和其中的任何键都是可选的。`options` 映射的示例：`{skip: 30, limit: 10, analyzer: 'whitespace'}`
	`全文索引的名称。`	`字符串`	queryString
	`options`	`映射`	要查找近似匹配的字符串。
返回参数	名称	类型	描述
	`以比 Cypher 的 SET 更节省空间的方式在给定节点上设置向量属性。`	`node`	{skip :: 整型, limit :: 整型, analyzer :: 字符串}
	`包含与查询对象相似的向量属性的节点。`	`score`	包含与查询字符串相似属性的节点。
模式	读取

衡量节点属性与查询字符串相似度的得分。

详情
语法	`db.index.fulltext.queryRelationships()`
描述	db.index.fulltext.queryRelationships(indexName, queryString [, options ]) :: (relationship, score) 查询给定的全文索引。返回匹配的节点及其 Lucene 查询得分，按得分排序。`options` 映射的有效 key: value 对是 'skip' — 跳过前 N 个结果。 'limit' — 限制返回结果的数量。 'analyzer' — 使用指定的分析器作为此查询的搜索分析器。
输入参数	名称	类型	描述
	`为指定标签和属性创建命名节点向量索引，使用给定的向量维度和 EUCLIDEAN 或 COSINE 相似性函数。两种相似性函数均不区分大小写。使用 db.index.vector.queryNodes 过程查询命名索引。`	`字符串`	`options` 映射和其中的任何键都是可选的。`options` 映射的示例：`{skip: 30, limit: 10, analyzer: 'whitespace'}`
	`全文索引的名称。`	`字符串`	queryString
	`options`	`映射`	要查找近似匹配的字符串。
返回参数	名称	类型	描述
	`以比 Cypher 的 SET 更节省空间的方式在给定关系上设置向量属性。`	`relationship`	查询给定的全文索引。返回匹配的关系及其 Lucene 查询得分，按得分排序。`options` 映射的有效 key: value 对是
	`包含与查询对象相似的向量属性的节点。`	`score`	包含与查询字符串相似属性的关系。
模式	读取

衡量关系属性与查询字符串相似度的得分。

详情
语法	`db.resampleIndex()`
描述	db.resampleIndex(indexName)
输入参数	名称	类型	描述
	`为指定标签和属性创建命名节点向量索引，使用给定的向量维度和 EUCLIDEAN 或 COSINE 相似性函数。两种相似性函数均不区分大小写。使用 db.index.vector.queryNodes 过程查询命名索引。`	`字符串`	调度索引的重新采样（例如：CALL db.resampleIndex("MyIndex")）。
模式	读取

此过程不被视为多线程安全运行。因此，并行运行时不支持它。更多信息，请参阅 Cypher 手册 → 并行运行时。

索引名称。

详情
语法	`db.resampleOutdatedIndexes()`
描述	db.resampleOutdatedIndexes()
模式	读取

此过程不被视为多线程安全运行。因此，并行运行时不支持它。更多信息，请参阅 Cypher 手册 → 并行运行时。

调度所有过期索引的重新采样。

指标

详情
语法	`dbms.queryJmx()`
描述	dbms.queryJmx(query) :: (name, description, attributes)
输入参数	名称	类型	描述
输入参数	`向量邻域的大小。`	`字符串`	按域和名称查询 JMX 管理数据。例如，使用 `:` 查找所有 JMX bean。
返回参数	名称	类型	描述
	`name`	`字符串`	此 MBeanServer 上的 MBean 查询（例如 `':,name=neo4j*'` 用于 neo4j 数据库中的所有指标）。
	`description`	`字符串`	指标名称。
	`指标的描述。`	`映射`	attributes
模式	DBMS

包含该指标属性（值）的集合。

模式和元数据

详情
语法	`db.schema.nodeTypeProperties()`
描述	db.schema.nodeTypeProperties() :: (nodeType, nodeLabels, propertyName, propertyTypes, mandatory)
返回参数	名称	类型	描述
	`以表格形式显示节点的派生属性模式。`	`字符串`	nodeType
	`从节点标签生成的名称。`	`字符串列表`	nodeLabels
	`包含节点类别标签的列表。`	`字符串`	propertyName
	`节点类别上的属性键。`	`字符串列表`	propertyTypes
	`属于节点类别的属性的所有类型。`	`布尔值`	mandatory
模式	读取

此过程不被视为多线程安全运行。因此，并行运行时不支持它。更多信息，请参阅 Cypher 手册 → 并行运行时。

属性是否在属于节点类别的所有节点上都存在。

详情
语法	`db.schema.relTypeProperties()`
描述	db.schema.relTypeProperties() :: (relType, propertyName, propertyTypes, mandatory)
返回参数	名称	类型	描述
	`以表格形式显示关系的派生属性模式。`	`字符串`	relType
	`包含节点类别标签的列表。`	`字符串`	从关系类型生成的名称。
	`节点类别上的属性键。`	`字符串列表`	关系类别上的属性键。
	`属于节点类别的属性的所有类型。`	`布尔值`	属于关系类别的属性的所有类型。
模式	读取

此过程不被视为多线程安全运行。因此，并行运行时不支持它。更多信息，请参阅 Cypher 手册 → 并行运行时。

属性是否在属于关系类别的所有关系上都存在。

详情
语法	`db.schema.visualization()`
描述	db.schema.visualization() :: (nodes, relationships)
返回参数	名称	类型	描述
	`根据可用统计信息可视化数据模式。为每个标签返回一个新节点。节点上表示的属性包括：name（标签名称）、indexes（索引列表）和 constraints（约束列表）。对于起始节点和结束节点的所有可能组合，都会返回给定类型的关系。关系上表示的属性包括：name（类型名称）。请注意，这可能包括由于计数存储中可用信息而导致数据中不存在的额外关系。`	`nodes`	节点列表
	`表示数据库中每个标签的虚拟节点列表。`	`relationships`	关系列表
模式	读取

此过程不被视为多线程安全运行。因此，并行运行时不支持它。更多信息，请参阅 Cypher 手册 → 并行运行时。

表示数据库中起始节点和结束节点之间所有组合的虚拟关系列表。

详情
语法	`db.createLabel()`
描述	db.createLabel(newLabel)
输入参数	名称	类型	描述
	`创建标签`	`字符串`	newLabel
模式	写入

标签名称。

详情
语法	`db.createProperty()`
描述	db.createProperty(newProperty)
输入参数	名称	类型	描述
	`创建属性`	`字符串`	newProperty
模式	写入

属性名称。

详情
语法	`db.createRelationshipType`
描述	db.createRelationshipType(newRelationshipType)
输入参数	名称	类型	描述
	`创建关系类型`	`字符串`	newRelationshipType
模式	写入

关系类型名称。

详情
语法	`db.labels()`
描述	db.labels() :: (label)
返回参数	名称	类型	描述
	`indexName :: 字符串`	`字符串`	根据用户的访问权限，列出数据库中附加到节点的所有标签。如果用户无权查看这些标签，则过程返回空结果。
模式	读取

数据库中的一个标签。

详情
语法	`db.propertyKeys()`
描述	db.propertyKeys() :: (propertyKey)
返回参数	名称	类型	描述
	`label :: 字符串`	`字符串`	列出数据库中的所有属性键。
模式	读取

此过程不被视为多线程安全运行。因此，并行运行时不支持它。更多信息，请参阅 Cypher 手册 → 并行运行时。

数据库中的一个属性键。

详情
语法	`db.relationshipTypes()`
描述	db.relationshipTypes() :: (relationshipType)
返回参数	名称	类型	描述
	`根据用户的访问权限，列出数据库中附加到关系的所有类型。如果用户无权查看这些关系类型，则过程返回空结果。`	`字符串`	relationshipType
模式	读取

此过程不被视为多线程安全运行。因此，并行运行时不支持它。更多信息，请参阅 Cypher 手册 → 并行运行时。

数据库中的一个关系类型。

统计信息和查询计划

已清除查询缓存数量的信息。

详情
语法	`db.prepareForReplanning()`
描述	db.prepareForReplanning([ timeOutSeconds ])
输入参数	名称	类型	描述
	`等待的索引名称。`	`整型`	timeOutSeconds
模式	读取

此过程不被视为多线程安全运行。因此，并行运行时不支持它。更多信息，请参阅 Cypher 手册 → 并行运行时。

触发索引重新采样并等待其完成，之后清除查询缓存。此过程完成后，查询将使用最新的数据库统计信息进行规划。

详情
语法	`db.stats.clear`
描述	db.stats.clear(section) :: (section, success, message)
输入参数	名称	类型	描述
输入参数	`清除给定数据部分的收集数据。有效部分为“QUERIES”`	`字符串`	section
返回参数	名称	类型	描述
	`清除给定数据部分的收集数据。有效部分为“QUERIES”`	`字符串`	要清除的部分。唯一可用的部分是：“QUERIES”。
	`启动并等待新的检查点，或等待任何已在进行的检查点完成。请注意，这会暂时禁用 db.checkpoint.iops.limit 设置，以便检查点更快完成。这可能会导致事务吞吐量略有下降，因为 IO 负载增加。`	`布尔值`	已清除的部分。
	`message`	`字符串`	过程结果的详细信息。
模式	读取

部分是否已成功清除。

详情
语法	`db.stats.collect()`
描述	db.stats.collect(section [, config ]) :: (section, success, message)
输入参数	名称	类型	描述
	`清除给定数据部分的收集数据。有效部分为“QUERIES”`	`字符串`	启动给定数据部分的收集。有效部分为“QUERIES”
	`section`	`映射`	要收集的部分。唯一可用的部分是：“QUERIES”。
返回参数	名称	类型	描述
	`清除给定数据部分的收集数据。有效部分为“QUERIES”`	`字符串`	config
	`启动并等待新的检查点，或等待任何已在进行的检查点完成。请注意，这会暂时禁用 db.checkpoint.iops.limit 设置，以便检查点更快完成。这可能会导致事务吞吐量略有下降，因为 IO 负载增加。`	`布尔值`	{durationSeconds = -1 整型}
	`message`	`字符串`	过程结果的详细信息。
模式	读取

已收集的部分。

详情
语法	`部分是否已成功收集。`
描述	db.stats.retrieve()
输入参数	名称	类型	描述
	`清除给定数据部分的收集数据。有效部分为“QUERIES”`	`字符串`	db.stats.retrieve(section [, config ]) :: (section, data)
	`section`	`映射`	检索有关当前数据库的统计数据。有效部分为“GRAPH COUNTS”、“TOKENS”、“QUERIES”、“META”
返回参数	名称	类型	描述
	`清除给定数据部分的收集数据。有效部分为“QUERIES”`	`字符串`	要检索的统计信息部分：（'GRAPH COUNTS'，'TOKENS'，'QUERIES'，'META'）。
	`{maxInvocations = 100 整型}`	`映射`	已检索的部分。
模式	读取

data

详情
语法	`与检索到的统计信息相关的数据。`
描述	db.stats.retrieveAllAnonymized()
输入参数	名称	类型	描述
	`db.stats.retrieveAllAnonymized(graphToken [, config ]) :: (section, data)`	`字符串`	以匿名形式检索有关当前数据库的所有可用统计数据。
	`section`	`映射`	检索有关当前数据库的统计数据。有效部分为“GRAPH COUNTS”、“TOKENS”、“QUERIES”、“META”
返回参数	名称	类型	描述
	`清除给定数据部分的收集数据。有效部分为“QUERIES”`	`字符串`	要检索的统计信息部分：（'GRAPH COUNTS'，'TOKENS'，'QUERIES'，'META'）。
	`{maxInvocations = 100 整型}`	`映射`	已检索的部分。
模式	读取

graphToken

详情
语法	`图令牌的名称。`
描述	db.stats.status()
返回参数	名称	类型	描述
	`清除给定数据部分的收集数据。有效部分为“QUERIES”`	`字符串`	db.stats.status() :: (section, status, data)
	`如果系统数据库模式不是当前模式，则升级它。`	`字符串`	检索此数据库所有可用收集器守护进程的状态。
	`{maxInvocations = 100 整型}`	`映射`	包含消息“QUERIES”的字符串。
模式	读取

QueryCollector 的状态：“idle”或“collecting”。

详情
语法	`data :: 映射`
描述	db.stats.stop()
输入参数	名称	类型	描述
输入参数	`清除给定数据部分的收集数据。有效部分为“QUERIES”`	`字符串`	db.stats.stop(section) :: (section, success, message)
返回参数	名称	类型	描述
	`清除给定数据部分的收集数据。有效部分为“QUERIES”`	`字符串`	停止给定数据部分的收集。有效部分为“QUERIES”
	`启动并等待新的检查点，或等待任何已在进行的检查点完成。请注意，这会暂时禁用 db.checkpoint.iops.limit 设置，以便检查点更快完成。这可能会导致事务吞吐量略有下降，因为 IO 负载增加。`	`布尔值`	section
	`message`	`字符串`	过程结果的详细信息。
模式	读取

要停止的部分。唯一可用的部分是：“QUERIES”。

已停止的部分。

详情
语法	`部分是否已成功停止。`
描述	事务管理
返回参数	名称	类型	描述
	`metadata`	`映射`	tx.getMetaData()
模式	DBMS

tx.getMetaData() :: (metadata)

详情
语法	`提供附加的事务元数据。`
描述	关于事务的元数据。
输入参数	名称	类型	描述
	`{maxInvocations = 100 整型}`	`映射`	tx.setMetaData()
模式	DBMS

语法	`db.checkpoint()`
描述	db.checkpoint() :: (success, message)
返回参数	名称	类型	描述
	`启动并等待新的检查点，或等待任何已在进行的检查点完成。请注意，这会暂时禁用 db.checkpoint.iops.limit 设置，以便检查点更快完成。这可能会导致事务吞吐量略有下降，因为 IO 负载增加。`	`布尔值`	success
	`message`	`字符串`	过程结果的详细信息。
模式	DBMS

语法	`genai.vector.listEncodingProviders()`
描述	genai.vector.listEncodingProviders() :: (name, requiredConfigType, otionalConfigType, defaultConfig)
返回参数	名称	类型	描述
	`name`	`字符串`	列出可用的向量嵌入提供程序。
	`生成式 AI 提供程序的名称。`	`字符串`	requiredConfigType
	`所需配置映射的签名。`	`字符串`	optionalConfigType
	`可选配置映射的签名。`	`映射`	defaultConfig
模式	资源的生成向量嵌入。

语法	`db.clearQueryCaches()`
描述	db.clearQueryCaches() :: (value)
返回参数	名称	类型	描述
	`value`	`字符串`	清除所有查询缓存。
模式	DBMS

过程

认证与授权

dbms.security.clearAuthCache()

dbms.security.reloadTLS()

dbms.showCurrentUser()

后台作业管理

dbms.scheduler.failedJobs()

dbms.scheduler.groups()

dbms.scheduler.jobs()

变更数据捕获 (CDC)

cdc.current()

cdc.earliest()

cdc.query()

db.cdc.current()

db.cdc.earliest()

db.cdc.query()

db.cdc.translateId()

集群管理

dbms.cluster.checkConnectivity()

dbms.cluster.cordonServer()

dbms.cluster.deallocateDatabaseFromServer()

dbms.cluster.deallocateDatabaseFromServers()

dbms.cluster.deallocateNumberOfDatabases()

dbms.cluster.protocols()

dbms.cluster.readReplicaToggle()

dbms.cluster.reallocateDatabase()

dbms.cluster.reallocateNumberOfDatabases()

dbms.cluster.recreateDatabase()

dbms.cluster.routing.getRoutingTable()

dbms.cluster.secondaryReplicationDisable()

dbms.cluster.setAutomaticallyEnableFreeServers()

dbms.cluster.statusCheck()

dbms.cluster.uncordonServer()

dbms.recreateDatabase()

dbms.setDefaultAllocationNumbers()

dbms.showTopologyGraphConfig()

配置和 DBMS 信息

dbms.checkConfigValue()

dbms.components()

dbms.info()

dbms.listCapabilities()

dbms.listConfig()

dbms.setConfigValue()

dbms.listPools()

连接管理

dbms.listConnections()

已连接客户端的地址。

已终止连接用户的用户名。

要终止的连接 ID。

更多信息，请参阅 数据库管理 和 数据库内部和事务行为。

检查点是否已成功完成。

数据库创建日期，按照 ISO-8601 标准格式化。

被锁定资源的 ID。

拥有此锁的事务 ID。

连接到数据库的调用是否成功。

dbms.routing.getRoutingTable(context [, database ]) :: (ttl, servers)

关于默认数据库的信息。

建议使用 dbms.unquarantineDatabase() 而非 dbms.quarantineDatabase()，因为它有改进和新功能（请参阅 operation 选项）。

升级结果的信息。

升级所需步骤的信息。

生成式 AI 文档 → 嵌入和向量索引教程

SHOW PROCEDURES 的过程签名将向量参数呈现为 ANY 类型，而不是语义上正确的 LIST<INTEGER | FLOAT> 类型。这些类型仍然强制执行为 LIST<INTEGER | FLOAT>。

将存储新属性的关系。

db.create.setNodeVectorProperty() 和 db.create.setRelationshipVectorProperty()

Cypher 命令 CREATE VECTOR INDEX。更多信息，请参阅 Cypher 手册 → 创建向量索引。

衡量节点属性与查询对象相似度的得分。

衡量关系属性与查询对象相似度的得分。

更多信息，请参阅 Cypher 手册 → 生成批次嵌入。

生成式 AI 提供程序的默认值。

Cypher 手册 → 全文索引

最大等待时间（秒）。

等待所有索引上线（例如：CALL db.awaitIndexes(300)）。

等待最近提交的事务的更新应用于任何最终一致的全文索引。

分析器用于分词字符串的停用词。

衡量节点属性与查询字符串相似度的得分。

衡量关系属性与查询字符串相似度的得分。

索引名称。

调度所有过期索引的重新采样。

指标

包含该指标属性（值）的集合。

更多信息，请参阅数据库管理和数据库内部和事务行为。

建议使用 `dbms.unquarantineDatabase()` 而非 `dbms.quarantineDatabase()`，因为它有改进和新功能（请参阅 `operation` 选项）。

`SHOW PROCEDURES` 的过程签名将向量参数呈现为 `ANY` 类型，而不是语义上正确的 `LIST<INTEGER | FLOAT>` 类型。这些类型仍然强制执行为 `LIST<INTEGER | FLOAT>`。

`db.create.setNodeVectorProperty()` 和 `db.create.setRelationshipVectorProperty()`

Cypher 命令 `CREATE VECTOR INDEX`。更多信息，请参阅 Cypher 手册 → 创建向量索引。

更多信息，请参阅统计信息和执行计划