故障排除
这是 GraphQL 库版本 7 的文档。对于长期支持 (LTS) 版本 5,请参考 GraphQL 库版本 5 LTS。 |
本章包含常见的故障排除步骤。此外,还有一个 常见问题 (Frequently Asked Questions) 部分,您可以在其中找到问题的答案。
调试日志
针对 @neo4j/graphql
@neo4j/graphql
使用 debug
库进行调试级别日志记录。您可以通过在运行时将环境变量 DEBUG
设置为 @neo4j/graphql:*
来打开所有调试日志记录。例如
命令行
DEBUG=@neo4j/graphql:* node src/index.js
或者,如果您正在调试特定功能,可以指定多个命名空间以隔离某些日志行
-
@neo4j/graphql:*
- 记录所有 -
@neo4j/graphql:auth
- 记录授权头和令牌提取的状态,以及 JWT 解码 -
@neo4j/graphql:graphql
- 记录 GraphQL 查询和变量 -
@neo4j/graphql:execution
- 记录执行前的 Cypher 和 Cypher 参数,以及执行摘要
构造函数
您还可以在构造函数中将 debug
参数设置为 true
来启用库中的所有调试日志记录。
const { Neo4jGraphQL } = require("@neo4j/graphql");
const neo4j = require("neo4j-driver");
const { ApolloServer } = require("apollo-server");
const typeDefs = `
type Movie @node {
title: String!
}
`;
const driver = neo4j.driver(
"bolt://localhost:7687",
neo4j.auth.basic("username", "password")
);
const neoSchema = new Neo4jGraphQL({
typeDefs,
driver,
debug: true,
});
针对 @neo4j/introspector
@neo4j/introspector
有其自己的调试日志记录命名空间,您可以通过以下方式为其开启日志记录
DEBUG=@neo4j/introspector node src/index.js
阅读更多关于内省器的信息。
查询优化
希望您不需要执行任何查询优化,但如果需要,Neo4j GraphQL 库允许您在请求上下文中设置完整的查询选项数组。
您可以从 Cypher 手册 → 查询选项 中阅读更多关于可用查询选项的信息。
请仅在您了解其作用的情况下设置这些选项。
例如,将“runtime”选项设置为“interpreted”
const { Neo4jGraphQL } = require("@neo4j/graphql");
const neo4j = require("neo4j-driver");
const { ApolloServer } = require("apollo-server");
const typeDefs = `
type Movie @node {
title: String!
}
`;
const driver = neo4j.driver(
"bolt://localhost:7687",
neo4j.auth.basic("username", "password")
);
const neoSchema = new Neo4jGraphQL({
typeDefs,
driver,
});
neoSchema.getSchema().then((schema) => {
const server = new ApolloServer({
schema,
context: ({ req }) => ({
req,
cypherQueryOptions: {
runtime: "interpreted",
},
}),
});
server.listen().then(({ url }) => {
console.log(`Server ready at ${url}`);
});
});
常见问题
本章包含常见问题及其解决方案。
我从 <1.1.0 版本升级后,我的 DateTime
字段排序不符合预期
由于 1.1.0 版本之前的错误,您的 DateTime
字段可能在数据库中存储为字符串而不是时间值。您应该使用 Cypher 查询在数据库中重写这些属性。例如,如果受影响的节点标签为“Movie”,受影响的属性为“timestamp”,您可以使用以下 Cypher 查询进行操作
MATCH (m:Movie)
WHERE apoc.meta.type(m.timestamp) = "STRING"
SET m.timestamp = datetime(m.timestamp)
RETURN m
我的更新和创建输入中的 _emptyInput
是什么?
如果您定义的类型只包含自动生成和/或关系属性,则 _emptyInput
将出现在您的更新和创建输入中。它是一个占位符属性,因此在更新或创建时给它赋值都不会在节点上赋予值。如果您添加用户提供的属性,_emptyInput
将被移除。
以下示例将创建带有 _emptyInput
的输入
type Cookie @node {
id: ID! @id
owner: Owner! @relationship(type: "HAS_OWNER", direction: OUT)
# f: String # If you don't want _emptyInput, uncomment this line.
}
我的图中没有强制执行关系的可空性
目前,根据以下 typeDefs,Neo4j GraphQL 在创建和更新一对一关系(例如以下电影导演字段)时将强制执行基数
type Movie @node {
title: String!
director: Person! @relationship(type: "DIRECTED", direction: IN)
actors: [Person!]! @relationship(type: "ACTED_IN", direction: IN)
}
type Person @node {
name: String!
}
然而,目前还没有支持验证演员关系的机制。此外,如果在一个变更中创建电影和导演,则存在一个已知限制
mutation {
createMovies(
input: [
{
title: "Forrest Gump"
director: { create: { node: { name: "Robert Zemeckis" } } }
}
]
) {
movies {
title
director {
name
}
}
}
}
然后删除导演节点
mutation {
deletePeople(where: { name: { eq: "Robert Zemeckis" } }) {
nodesDeleted
}
}
即使模式规定所有电影都必须有一个导演,从而在技术上使电影节点无效,也没有抛出错误。
最后,我们不对联合或接口关系强制执行关系基数。
安全
本节描述安全注意事项和已知问题。
空匹配未触发授权
如果查询没有结果,授权过程将不会被触发。这意味着结果将为空,而不是抛出身份验证错误。未经授权的用户可能会因此辨别数据库中是否存在某种类型,即使数据本身无法访问。