约束

概述

约束对进入图集中的数据施加限制规则。如果数据修改操作与约束有冲突，将引发报错。

支持以下约束：

• EDGE KEY
• NOT NULL

显示约束

获取当前图集为点属性创建的所有约束：

SHOW NODE CONSTRAINT

获取当前图集为边属性创建的所有约束：

SHOW EDGE CONSTRAINT

约束信息展示在表_nodeConstraint和表 _edgeConstraint中，包含以下字段：

创建约束

使用语句ALTER NODE或ALTER EDGE创建约束。约束创建以作业形式执行，稍后可使用SHOW JOB <id?>来验证是否创建成功。

创建约束需要一些时间，因为系统需扫描全部现有数据，以确保其符合约束要求。如果现有数据与约束不符，则约束创建失败。此外，为确保数据一致性，创建约束时，会暂停其他数据修改操作。

EDGE KEY

EDGE KEY约束指定一个或多个边属性作为图中所有边的唯一标识符。当指定多个属性时，也称为复合EDGE KEY约束。

EDGE KEY中的每个属性都必须存在于所有边Schema中，并使用一致的值类型。对于单属性EDGE KEY，该属性的值在所有边中不重复且非null。对于复合EDGE KEY，每个属性的值非null，并且它们的值的组合在所有边中不重复。

详情

• 每个图只能创建一个单属性或复合EDGE KEY。
• list类型的属性无法在EDGE KEY中使用。
• EDGE KEY中的属性会自动缓存，以加速查询。
• 创建EDGE KEY约束时，要求每个Shard中的属性值唯一，但允许不同分片中存在重复值。但EDGE KEY创建完成后，所有的数据修改必须遵守全局唯一性。

为边属性createdOn创建名为eUID的EDGE KEY约束：

ALTER EDGE * ADD CONSTRAINT eUID EDGE KEY (createdOn)
OPTIONS { 
  type: {createdOn: "datetime"}
}

若想成功创建该约束，必须满足以下条件：

1. 所有边schema均有名为createdOn的属性，其类型必须为datetime。
2. 各分片中，createdOn属性值必须唯一且不存在null值。

默认属性值类型

未指定属性值类型时，默认使用string：

ALTER EDGE * ADD CONSTRAINT eUID EDGE KEY (createdOn)

本例中，所有边schema必须包含string类型的createdOn边属性。

复合EDGE KEY约束

复合EDGE KEY约束涉及多个边属性。其创建要求与单属性EDGE KEY约束相同，但唯一性是基于指定属性的组合值强制执行的。

为边属性createdOn和weight创建名为eUIDs的复合EDGE KEY约束：

ALTER EDGE * ADD CONSTRAINT eUIDs EDGE KEY (createdOn, weight)
OPTIONS { 
  type: {createdOn: "datetime", weight: "float"}
}

NOT NULL

NOT NULL约束强制要求一条属性不可拥有null值，确保属性永远存在非空值。

详情

• NOT NULL约束必须针对单个指定schema创建。
• 每个NOT NULL约束仅能指定一个属性。

为点user的name属性创建名为nn_1的NOT NULL约束：

ALTER NODE user ADD CONSTRAINT nn_1 NOT NULL (name)

为边link的weight属性创建名为nn_2的NOT NULL约束：

ALTER EDGE link ADD CONSTRAINT nn_2 NOT NULL (weight)

当指定属性不存在null值时，约束才能创建成功。

使用IF NOT EXISTS

IF NOT EXISTS子句用于防止在尝试创建已存在的约束时出错，它允许安全地执行语句。

ALTER NODE user ADD CONSTRAINT IF NOT EXISTS nn_1 NOT NULL (age)

仅当不存在该名称的约束时，才会创建约束nn_1。如果nn_1已存在，则忽略该语句，不会引发报错。

删除约束

使用语句ALTER NODE或ALTER EDGE删除约束。

为所有边schema删除名为eUID的EDGE KEY约束：

ALTER EDGE * DROP CONSTRAINT eUID

从点schema user中删除名为nn_1的NOT NULL约束：

ALTER NODE user DROP CONSTRAINT nn_1

使用IF EXISTS标志

如果指定的约束名称不存在，约束将删除失败，并返回错误信息。

使用IF EXISTS标志后，如果指定的约束名称不存在，不会返回错误信息，也不会删除约束。

从点schema user中删除名为nn的约束。若约束名称不存在，跳过删除过程，无需返回错误信息：

ALTER NODE user DROP CONSTRAINT nn IF EXISTS

对带有约束的属性限制

重命名属性

应用了NOT NULL约束的属性可以重命名。但应用了EDGE KEY约束的属性不可重命名。

删除属性

应用了约束的属性无法删除，除非所有相关约束均已删除。