其他查询机制

隐式(或自动提交)事务

隐式事务是唯一可用于 CALL { …​ } IN TRANSACTIONS 查询的事务类型。

隐式事务是事务最基本且受限的形式。驱动程序不会自动重试隐式事务,这与通过 Driver.executeQuery()托管事务 运行的查询不同。只有当其他查询接口不适用或进行快速原型设计时,才应使用隐式事务。

您可以使用 Session.run() 方法运行隐式事务,该方法会返回一个 Result 对象。

let session = driver.session({database: '<database-name>'})
try {
  const result = await session.run(
    'MERGE (a:Person {name: $name})',
    { name: 'Alice'}
  )
} finally {
  await session.close()
}

由于驱动程序无法判断 session.run() 调用中的查询是需要数据库的读会话还是写会话,因此它默认使用写模式。如果您的隐式事务仅包含读查询,可以通过在创建会话时将参数 defaultAccessMode 设置为 neo4j.session.READ让驱动程序获知,从而获得性能提升。

您也可以使用响应式会话来运行隐式事务。

导入 CSV 文件

使用 Session.run() 最常见的用例是结合 Cypher 的 LOAD CSV 子句将大型 CSV 文件导入数据库,并防止因事务过大而导致的超时错误。

将 CSV 数据导入 Neo4j 数据库
let session = driver.session({database: '<database-name>'})
try {
  let result = await session.run(`
    LOAD CSV FROM 'https://data.neo4j.com/bands/artists.csv' AS line
    CALL {
        WITH line
        MERGE (:Artist {name: line[1], age: toInteger(line[2])})
    } IN TRANSACTIONS OF 2 ROWS
  `)
  console.log(result.summary.counters.updates())
} finally {
  await session.close()
}
虽然 LOAD CSV 很方便,但将 CSV 文件的解析推迟到 JavaScript 应用程序中并避免使用 LOAD CSV 并没有什么不妥。事实上,将解析逻辑移至应用程序可以使您更好地控制导入过程。有关高效批量数据插入的信息,请参阅 性能 → 批量数据创建

更多信息,请参阅 Cypher → 子句 → Load CSV

事务配置

通过向 session.run() 提供类型为 TransactionConfig 的可选第三个参数,您可以对隐式事务进行进一步控制。该配置允许指定查询超时时间并为事务附加元数据。更多信息,请参阅 事务 — 事务配置

let session = driver.session({database: '<database-name>'})
let result = await session.run(
  'MATCH (a:Person) RETURN count(a) AS people',
  {},  // query parameters
  { timeout: 5000, metadata: {'appName': 'peopleTracker'} }  // transactionConfig
)

属性键、关系类型和标签中的动态值

通常,你不应该直接将参数拼接到查询字符串中,而应该使用 查询参数。然而,在某些情况下,查询结构可能导致无法在所有地方使用参数。实际上,尽管参数适用于字面量、表达式以及 节点标签和关系类型,但它们不能用于属性键,因此 MATCH (n) WHERE n.$param = 'something' 是无效的。

使用字符串拼接时,请将动态值用反引号括起来,并自行进行转义以防止 Cypher 注入。请注意,Cypher 处理 Unicode,因此也要留意 Unicode 字面量 \u0060

在拼接前手动转义动态属性键
let dangerousKey = 'name\\u0060'
// convert \u0060 to literal backtick, then escape backticks
let escapedKey = dangerousKey.replace(/\\u0060/g, '`').replace(/`/g, '``')

let result = await driver.executeQuery(
  'MATCH (p:Person {`' + escapedKey + '`: $name}) RETURN p.name',
  { name: 'Alice' },
  {database: '<database-name>'}
)
console.log(`Executed query: ${result.summary.query.text}`)
// MATCH (p:Person {`name```: $name}) RETURN p.name

避免字符串拼接的另一种变通方法是使用 APOC 过程,例如 apoc.merge.node,它支持动态标签和属性键。

使用 apoc.merge.node 创建带有动态标签/属性键的节点
let propertyKey = 'name'
let label = 'Person'
let result = await driver.executeQuery(
  'CALL apoc.merge.node($labels, $properties)',
  {labels: [label], properties: {property_key: 'Alice'}},
  {database: '<database-name>'}
)
如果你在 Docker 中运行 Neo4j,则在启动容器时需要启用 APOC。请参阅 APOC → 安装 → Docker

日志记录

在创建 Driver 实例时,您可以选择指定其日志配置。

日志记录默认处于关闭状态。要开启它,请在初始化驱动程序时指定 logging 选项。作为值,使用 neo4j.logging.console() 函数,它会将日志记录到控制台并接受一个可选参数 level。日志级别可以是 errorwarninfodebug。启用某一级别会自动启用所有优先级更高的级别,默认值为 info

创建驱动程序,并将 debug 级别的日志记录到控制台
neo4j.driver(
  URI,
  neo4j.auth.basic(USER, PASSWORD),
  {  // driver config
    logging: neo4j.logging.console('debug')
  }
)
驱动程序连接时的日志输出示例
1681215847749 INFO Routing driver 0 created for server address localhost:7687
1681215847765 INFO Routing table is stale for database: "neo4j" and access mode: "WRITE": RoutingTable[database=neo4j, expirationTime=0, currentTime=1681215847765, routers=[], readers=[], writers=[]]
1681215847773 DEBUG Connection [0][] created towards localhost:7687(127.0.0.1)
1681215847773 DEBUG Connection [0][] C: HELLO {user_agent: 'neo4j-javascript/5.3.0', ...}
1681215847778 DEBUG Connection [0][] S: SUCCESS {"signature":112,"fields":[{"server":"Neo4j/5.8.0","connection_id":"bolt-1782","hints":{"connection.recv_timeout_seconds":{"low":120,"high":0}}}]}
1681215847778 DEBUG Connection [0][bolt-1782] created for the pool localhost:7687
1681215847778 DEBUG Connection [0][bolt-1782] acquired from the pool localhost:7687
1681215847779 DEBUG Connection [0][bolt-1782] C: ROUTE {"address":"localhost:7687"} [] {"db":"neo4j"}
1681215847781 DEBUG Connection [0][bolt-1782] S: SUCCESS {"signature":112,"fields":[{"rt":{"servers":[{"addresses":["localhost:7687"],"role":"WRITE"},{"addresses":["localhost:7687"],"role":"READ"},{"addresses":["localhost:7687"],"role":"ROUTE"}],"ttl":{"low":300,"high":0},"db":"neo4j"}}]}

您还可以指定一个自定义日志记录函数,例如将其记录到文件。在这种情况下,logging 选项需要两个属性

  • level:可以是 errorwarninfodebug。启用某一级别会自动启用所有优先级更高的级别。默认值为 info

  • logger:一个在需要记录消息时调用的函数。接收 level, message 作为输入。

创建驱动程序,并将 error 级别的日志记录到控制台
neo4j.driver(
  URI,
  neo4j.auth.basic(USER, PASSWORD),
  {  // driver config
    logging: {
      level: 'error',
      logger: (level, message) => console.log(level + ' ' + message)
    }
  }
)

您可以在 API 文档中找到有关日志记录的更多信息。

术语表

LTS (长期支持版)

长期支持 (Long Term Support) 版本是保证在若干年内得到支持的版本。Neo4j 4.4 和 5.26 是 LTS 版本。

Aura

Aura 是 Neo4j 的全托管云服务。它提供免费和付费计划。

Cypher

Cypher 是 Neo4j 的图查询语言,允许您从数据库中检索数据。它就像 SQL,但专用于图数据库。

APOC

Awesome Procedures On Cypher (APOC) 是一个包含(许多)函数的库,这些函数在 Cypher 本身中难以轻松实现。

Bolt

Bolt 是用于 Neo4j 实例和驱动程序之间交互的协议。默认监听 7687 端口。

ACID

原子性 (Atomicity)、一致性 (Consistency)、隔离性 (Isolation)、持久性 (Durability) (ACID) 是保证数据库事务可靠处理的属性。符合 ACID 的 DBMS 确保即使发生故障,数据库中的数据也能保持准确和一致。

最终一致性

如果一个数据库能保证所有集群成员在某个时间点都存储了数据的最新版本,则该数据库具有最终一致性。

因果一致性

如果读写查询被集群中的每个成员以相同的顺序看到,则数据库具有因果一致性。这比最终一致性更强。

NULL

空标记不是一种类型,而是缺失值的占位符。更多信息,请参阅 Cypher → 使用 null

事务

事务是一个工作单元,要么被提交,要么在失败时被回滚。例如银行转账:它涉及多个步骤,但它们必须全部成功或全部撤销,以避免钱从一个账户扣除却未存入另一个账户的情况。

背压

背压是对数据流的抵抗力。它确保客户端不会被过快发送的数据压垮,从而超出其处理能力。

书签

书签是代表数据库某种状态的标记。通过将一个或多个书签与查询一起传递,服务器将确保在所表示的状态建立之前,该查询不会被执行。