数据库映射

这是 GraphQL 库版本 7 的文档。对于长期支持 (LTS) 版本 5，请参阅 GraphQL 库版本 5 LTS。

本页介绍如何使用指令进行数据库映射。GraphQL 类型定义中的每种类型都可以映射到 Neo4j 数据库中的实体，例如节点、关系和关系属性。

@node

定义

"""Informs @neo4j/graphql of node metadata"""
directive @node(
  """The labels to map this GraphQL type to in the Neo4j database"""
  labels: [String!]
) on OBJECT

用法

将 @node 指令添加到您的 GraphQL 类型中，表明它代表一个 Neo4j 节点。例如，要表示一个带有标签“Movie”和单个字符串类型属性“title”的 Neo4j 节点

type Movie @node {
    title: String
}

如果未另行指定，则 GraphQL 类型名称将用作所表示的 Neo4j 节点的标签。可以使用参数 labels 显式定义 Neo4j 节点标签。

labels 参数

您可以将可选参数 labels 附加到带有 @node 指令的 GraphQL 对象。此参数列出了在 Neo4j 中使用的标签，而不是 GraphQL 类型名称。

示例 1. 使用 labels 参数查询字段

考虑以下类型定义

type Dog @node(labels: ["K9"]) {
    name: String!
}

这是针对 Dog 节点的查询

{
  dogs {
    name
  }
}

生成了以下 Cypher

MATCH (this: K9)
RETURN this { .name } as name

如果您想将 GraphQL 类型名称用作标签，请同时指定两者。

示例 2. 使用 labels 参数的两个条目查询字段

考虑以下类型定义

type Dog @node(labels: ["Dog", "K9"]) {
    name: String!
}

这是针对 Dog 节点的查询示例

{
  dogs {
    name
  }
}

生成了以下 Cypher

MATCH (this:Dog:K9)
RETURN this { .name } as this

定义 labels 意味着您控制了节点的数据库标签。Neo4j 中的索引和约束只支持单个标签，此时使用 labels 参数的第一个元素。

使用 $jwt 和 $context

在某些情况下，您可能希望根据请求用户生成动态标签。您可以使用变量 $jwt 在 JWT 中定义自定义标签。

示例 3. 在 labels 参数中使用 $jwt 变量查询字段

考虑以下类型定义

type User @node(labels: ["$jwt.username"]) {
    name: String!
}

以下查询会根据用户 JWT 生成不同的 Cypher 查询

{
  users {
    name
  }
}

假设 JWT 中存在一个 "username": "arthur" 的用户，Cypher 查询如下所示

MATCH (this:arthur)
RETURN this { .name } as this

同样，上下文值可以直接传递

type User @node(label: ["$context.appId"]) {
    name: String!
}

例如，如果您正在使用 Apollo 运行服务器

const server = new ApolloServer({
    schema: await neoSchema.getSchema(),
});

await startStandaloneServer(server, {
    context: async ({ req }) => ({ req, appId: "myApp" }),
});

@relationship

定义

"""
Instructs @neo4j/graphql to treat this field as a relationship. Opens up the ability to create and connect on this field.
"""
directive @relationship(
  type: String!
  """Valid and default directions for this relationship."""
  queryDirection: RelationshipQueryDirection = DEFAULT_DIRECTED
  direction: RelationshipDirection!
  """
  The name of the interface containing the properties for this relationship.
  """
  properties: String
  """
  Prevent all but these operations from being generated for this relationship
  """
  nestedOperations: [RelationshipNestedOperations!]! = [CREATE, UPDATE, DELETE, CONNECT, DISCONNECT, CONNECT_OR_CREATE]
  """Prevent aggregation for this relationship"""
  aggregate: Boolean = true
) on FIELD_DEFINITION

用法

关系通过使用指令（在本例中为 @relationship）标记特定字段来表示。它定义了数据库中的关系类型，以及该关系的方向。

添加两个节点类型“Movie”和“Actor”，并连接它们

type Movie @node {
    title: String
    actors: [Actor!]! @relationship(type: "ACTED_IN", direction: IN)
}

type Actor @node {
    name: String
    movies: [Movie!]! @relationship(type: "ACTED_IN", direction: OUT)
}

@relationship 指令使用两次，在关系的每一端各使用一次。这是使用 GraphQL 库建模关系的标准方式。然而，它并不是类型定义本身的要求，因为关系可以故意不完全指定，例如为了限制通过 API 层的访问。

另请参阅：@relationship 字段配置。

@relationshipProperties

定义

"""Required to differentiate between interfaces for relationship properties, and otherwise."""
directive @relationshipProperties on OBJECT

@relationshipProperties 只能用于接口。

用法

为了向关系添加属性，请在您的类型定义中添加一个用 @relationshipProperties 指令修饰的新类型。

例如，对于“ACTED_IN”关系，添加一个属性“roles”

type Movie @node {
    title: String
    actors: [Actor!]! @relationship(type: "ACTED_IN", direction: IN, properties: "ActedIn")
}

type Actor @node {
    name: String
    movies: [Movie!]! @relationship(type: "ACTED_IN", direction: OUT, properties: "ActedIn")
}

type ActedIn @relationshipProperties {
    roles: [String]
}

请注意，除了此类型外，现有 @relationship 指令中还添加了一个键 properties。有关更多信息，请参阅类型定义 → 关系。

@alias

定义

"""
Instructs @neo4j/graphql to map a GraphQL field to a Neo4j node or relationship property.
"""
directive @alias(
  """The name of the Neo4j property"""
  property: String!
) on FIELD_DEFINITION

用法

此指令将 GraphQL 字段映射到节点或关系上的 Neo4j 属性。它可用于所有非 @cypher 或 @relationship 字段。

例如

type User @node {
    id: ID! @id @alias(property: "dbId")
    username: String!
}
type User @node {
    id: ID! @id
    username: String! @alias(property: "dbUserName")
    livesIn: [City!]! @relationship(direction: OUT, type: "LIVES_IN", properties: "UserLivesInProperties")
}

type City @node {
    name: String
}

type UserLivesInProperties @relationshipProperties {
    since: DateTime @alias(property: "moveInDate")
}
别名中的属性会自动转义（用反引号 `` 包裹），因此无需在其周围添加转义字符。