变更与弃用

2025.05

从 2025.05 版本开始，查询日志 JSON 模板中的 failureReason 已被弃用，并默认关闭。请改用 errorInfo 条目。

有关 errorInfo 的更多信息，请参阅操作手册 → 日志记录 → GQL 错误信息。

2025.04

以编程方式使用错误消息的做法已被弃用，并可能在未来版本中发生更改。因此，不建议解析错误消息或状态描述并将其合并到脚本中。如果您需要以编程方式处理错误，请使用 GQLSTATUS 错误代码，例如 22NC5。

2025.01

查询日志现提供一个新的 JSON 模板，该模板已在 server_logs.xml 中设置为默认值。
更多详细信息，请参阅操作手册 → 监控 → 日志记录。

术语表

$action: 操作的自由格式描述。
$alias: 别名名称，例如 mydb-alias。
$aliasList: 别名列表，例如 mydb-alias1, mydb-alias2。
$allocType: 分配类型（primary 或 secondary）。
$arg: 过程或函数参数，例如 database、pause、dryrun 等。
$argType: 参数类型，输入或输出。
$auth: 身份验证提供程序名称，例如 ldap、native。
$authRule: ABAC 授权规则名称。
$boltServerState: Bolt 服务器状态，例如 READY。
$boltMsgLenLimit: Bolt 消息长度限制，例如 1000。
$bytes: 字节数。
$cause: 导致错误原因的自由格式描述。
$cfgSetting: 配置设置键，例如 server.https.enabled。
$clause: Cypher 子句，例如 USE、MATCH。
$clause: Cypher 子句列表，例如 USE, MATCH。
$cmd: Cypher 命令，例如 DROP DATABASE、PROFILE、SHOW PROCEDURES。
$component: 事物的组成部分，例如时间中的时/分，整个输入中的子集输入，整个 CREATE/ALTER DB … SET TOPOLOGY 中的 TOPOLOGY 子句等。
$constr: 约束名称，例如 book_isbn。
$constrDescrOrName: 约束描述，(:Label {property0, property1, property2, property1, property3})。
$context: 上下文的自由格式描述，指明何处无效或不受支持，例如 OPTIONS、URL、username 等。
$coordinates: 坐标值，例如 [3.15, 4.012, 5.905]。
$count: 某物的数量，例如 3。
$countAllocs: 所需的服务器使用数量。
$countSeeders: 种子服务器的数量。
$crs: 坐标参考系，例如 WGS84。
$db: 数据库名称，例如 myDb。
$dbList: 数据库名称列表。
$dim: 表示索引或点维度的数字。
$edition: Neo4j 版本，例如 Community 或 Enterprise。
$endpointType: 关系的 start（起点）或 end（终点）之一。
$entityId: 节点或关系的 ID。
$entityType: 一个节点或一个关系。
$expr: Cypher 表达式，例如 1 + n.prop。
$exprType: 自由格式表达式类型，例如 EXISTS、COUNT、COLLECT。
$feat: 自由格式的功能描述。
$field: 输入字段，例如过程、函数或反序列化的字段。
$fun: 函数名称，例如 collect()。
$funClass: 用户自定义函数实现类名称，例如 MyFunctionClass。
$funType: 函数类型，例如非确定性或聚合。
$graph: 图名称，例如 myGraph。
$graphTypeDependence: 约束的图类型依赖性，为 UNDESIGNATED、INDEPENDENT 或 DEPENDENT 之一。
$graphTypeElement: 图类型的元素，例如 (:Node ⇒ { name :: STRING})，或 (:Source)-[:REL ⇒]→(:Target)。
$graphTypeReference: 图类型引用，例如 (:Node ⇒) 或 p。
$graphTypeOperation: 图类型操作，例如 SET、ADD、DROP 或 ALTER 之一。
$hint: 自由格式的提示描述，例如 USING INDEX n:N(prop)。
$hintList: 提示的自由格式描述列表，例如 USING INDEX n:N(prop)。
$ident: 通用标识符，例如 my_identifier。
$idx: 索引名称，my_index。
$idxDescr: 索引描述，例如 INDEX :Person(name)。
$idxDescrOrName: 索引描述符或名称。
$idxOrConstr: 索引或约束名称，例如 my_index 或 book_isbn。
$idxOrConstrPat: 索引或约束模式，例如 CREATE CONSTRAINT bar IF NOT EXISTS FOR (n:L) REQUIRE (n.p1) IS NODE KEY。
$idxType: 索引类型，例如文本、向量等。
$input: 用户输入片段。
$inputList: 用户输入列表。
$item: 项目的自由格式描述。
$keyword: Cypher 关键字，例如 MERGE。
$label: 标签名称，例如 Person。
$labelExpr: 标签表达式，例如 (n:Movie|Person)。
$labelList: 标签名称列表，例如 Person, Actor。
$lower: 范围允许的最小值。
$mapKey: 映射键。
$mapKeyList: 映射键列表，例如映射 {first: 1, second: 2} 中的 first and second。
$matchMode: GPM 匹配模式，例如 REPEATABLE ELEMENTS。
$msg: 自由格式的消息。
$msgTitle: 自由格式的消息标题。
$namespaceList: 过程命名空间列表，例如 apoc.math.。
$operation: 数学运算，例如 / by zero、>。
$option: 选项名称。
$optionList: 选项名称列表。
$param: 参数名称，例如 $pattern。
$paramList: 参数列表，例如 $pattern, $prop。
$pat: 模式，例如 (:Person)。
$pathMode: GPM 路径模式，例如 ACYCLIC。
$pathModeList: GPM 路径模式列表，例如 TRAIL, ACYCLIC。
$port: 端口名称，例如 6362。
$portList: 端口名称列表，例如 6362, 6000, 7000。
$pos: 位置，例如在序列中，例如 2。
$pred: 谓词，例如 x = 3。
$predList: 谓词列表，例如 'x = 3', 'y > 4'。
$preparserInput: 预解析器输入片段。
$proc: 过程名称，例如 db.labels()。
$procClass: 用户自定义过程实现类名称，例如 MyProcedureClass。
$procExeMode: 过程执行模式，为 READ、WRITE、SCHEMA 和 DBMS 之一。
$procField: 用户自定义过程实现类参数名称，例如 myArgument。
$procFieldType: 用户自定义过程实现类参数类型，为 input 或 output 之一。
$procFun: 过程或函数名称或 ID，例如 db.labels() 或 collect()。
$procMethod: 用户自定义过程实现类方法名称，例如 myProcedureMethod。
$procParam: 用户自定义过程实现参数名称。
$procParamFmt: 自由格式的用户自定义过程实现参数格式，例如 com.example.*。
$propKey: 属性键名称，例如 name。
$propKeyList: 属性键名称列表，例如 name, age, hometown。
$query: 检索或写入数据库信息的语句，例如 MATCH (n) WHERE n.prop。
$reasonList: 失败原因列表。
$relType: 关系类型名称，例如 KNOWS。
$replacement: 自由格式文本，弃用功能的替代方案，Cypher 命令等。
$role: RBAC 角色名称，例如 admin、public、receptionist。
$routingPolicy: 路由策略名称。
$runtime: Cypher 运行时名称。为 slotted、pipelined 和 parallel 之一。
$schemaDescr: 模式描述符，例如 (:Label1 {prop1})。
$schemaDescrType: 模式描述符的自由格式类型，例如 label property existence constraint。
$selector: GPM 路径选择器，例如 ALL PATHS、SHORTEST 2 等。
$selectorType: 选择器类型。
$server: 服务器名称或 ID，例如 25a7efc7-d063-44b8-bdee-f23357f89f01。
$serverList: 服务器名称或 ID 列表，例如 'server-1', 'server-2'。
$serverType: 服务器类型，PRIMARY (primaryConstrained)、SECONDARY (secondaryConstrained) 或 NONE。
$serverAddress: 服务器地址，例如 localhost:20025。
$sig: 过程或函数签名，例如 date(input = DEFAULT_TEMPORAL_ARGUMENT :: ANY) :: DATE。
$storeFormat: 存储格式名称。为 "aligned"、"block"、"standard"、"high_limit" 之一。
$syntax: Cypher 语法或关键字。
$temporal: 时间值，例如 2025-02-18。
$timeAmount: 时间单位的整数数量（一个数字）。
$timeUnit: 常见时间单位名称，例如 seconds、minutes、hours。
$token: 令牌名称，例如 MyLabel、MyRelationshipType、myPropertyKey。
$tokenId: 令牌 ID。
$tokenType: 标签、关系类型或属性键之一。
$transactionId: 正在运行查询的事务 ID。
$typeDescription: 类型的自由格式描述，例如 'a list'。
$upper: 范围允许的最大值。
$url: URL，例如 https://example.com。
$user: 用户名，例如 neo4j。
$value: 某个值。
$valueList: 值列表。
$valueType: Cypher 值类型，例如 STRING、BOOLEAN、INTEGER、LIST<STRING> 等。
$valueTypeList: Cypher 值类型列表。
$variable: 变量名称，例如 n。
$variableList: 变量名称列表，例如 a, b, c。
$version: 版本，例如 CYPHER 25 中的 25。