Schema 定义

前提条件

• 已开通 Lindorm 图引擎，并配置白名单。

• 使用向量能力需要开通向量引擎。

首次初始化图 Schema

接口路径：/schema/mgmt/apply?db=${DB_NAME}。该接口用于首次定义子图的完整 Schema，包括顶点类型、边类型及其连接关系。系统默认创建一个名为 default 的子图，未使用多图功能时所有操作均作用在该子图上。

为已有类型扩展属性

接口路径：POST /schema/mgmt/addProperty?db=${dbName}。/schema/mgmt/apply 仅用于首次初始化，需要为已有顶点或边类型新增属性时请使用本接口。下文按属性类型给出四种典型用法：普通属性、set 多值属性、向量属性、为已有边扩展属性。

• 添加普通属性

  • 请求格式：

    curl -X POST 'http://${host}:${port}/schema/mgmt/addProperty?db=default' \
      -H 'Content-Type: application/json' \
      -u '${user}:${password}' \
      -d '{
        "label": "person",
        "labelType": "vertex",
        "properties": [
          {"name": "email", "dataType": "STRING"},
          {"name": "score", "dataType": "DOUBLE"}
        ]
      }'

  • 响应示例：

    {
      "status": "200 OK",
      "payload": {
        "label": "person",
        "labelType": "vertex",
        "propertiesAdded": ["email", "score"]
      }
    }

• 添加 set 属性（多值属性）

  set 属性支持一个字段存储多个值（如标签列表）。set 属性仅支持顶点，labelType 须为 vertex。

  curl -X POST 'http://${host}:${port}/schema/mgmt/addProperty?db=default' \
    -H 'Content-Type: application/json' \
    -u '${user}:${password}' \
    -d '{
      "label": "person",
      "labelType": "vertex",
      "properties": [
        {"name": "tags", "dataType": "STRING", "cardinality": "set"}
      ]
    }'

• 添加向量属性

  向量属性需要额外提供 vectorMeta 字段，系统会自动创建对应的向量索引表。向量属性仅支持顶点，labelType 须为 vertex。

  curl -X POST 'http://${host}:${port}/schema/mgmt/addProperty?db=default' \
    -H 'Content-Type: application/json' \
    -u '${user}:${password}' \
    -d '{
      "label": "person",
      "labelType": "vertex",
      "properties": [
        {
          "name": "embedding",
          "dataType": "VECTOR_FLOAT",
          "vectorMeta": {
            "dimension": 128,
            "distanceMethod": "EUCLIDEAN",
            "indexType": "HNSW",
            "indexParams": {
              "M": "16",
              "EF_CONSTRUCT": "200"
            }
          }
        }
      ]
    }'

• 为已有边类型扩展属性

  将 labelType 设为 edge 即可对边类型进行属性扩展。边不支持 set 属性和向量属性。

  • 请求格式：

    curl -X POST 'http://${host}:${port}/schema/mgmt/addProperty?db=default' \
      -H 'Content-Type: application/json' \
      -u '${user}:${password}' \
      -d '{
        "label": "knows",
        "labelType": "edge",
        "properties": [
          {"name": "since", "dataType": "LONG"}
        ]
      }'

  • 响应示例：

    {
      "status": "200 OK",
      "payload": {
        "label": "knows",
        "labelType": "edge",
        "propertiesAdded": ["since"]
      }
    }

添加新顶点类型

接口路径：POST /schema/mgmt/addVertexLabel?db=${dbName}。该接口在已有子图中创建一个新的顶点类型并定义其属性，系统会自动创建对应的底层物理表。

• 请求格式：

  curl -X POST 'http://${host}:${port}/schema/mgmt/addVertexLabel?db=default' \
    -H 'Content-Type: application/json' \
    -u '${user}:${password}' \
    -d '{
      "label": "product",
      "properties": [
        {"name": "productName", "dataType": "STRING"},
        {"name": "price",       "dataType": "DOUBLE"},
        {"name": "category",    "dataType": "STRING"}
      ]
    }'

• 响应示例：

  {
    "status": "200 OK",
    "payload": {
      "vertexLabelCreated": "product",
      "propertiesCount": 3
    }
  }

添加新边类型

接口路径：POST /schema/mgmt/addEdgeLabel?db=${dbName}。该接口在已有子图中创建一个新的边类型，并通过 connection 字段指定其起点和终点的顶点类型。引用的顶点类型必须已经存在，否则接口会返回错误。

• 请求格式：

  curl -X POST 'http://${host}:${port}/schema/mgmt/addEdgeLabel?db=default' \
    -H 'Content-Type: application/json' \
    -u '${user}:${password}' \
    -d '{
      "label": "purchased",
      "properties": [
        {"name": "purchaseDate", "dataType": "STRING"},
        {"name": "quantity",     "dataType": "INT"}
      ],
      "connection": {
        "outVertex": "person",
        "inVertex": "product"
      }
    }'

• 响应示例：

  {
    "status": "200 OK",
    "payload": {
      "edgeLabelCreated": "purchased",
      "propertiesCount": 2,
      "connectionRegistered": "person-purchased->product"
    }
  }

  响应中的 connectionRegistered 字段格式为 ${outVertex}-${edgeLabel}->${inVertex}，表示已成功注册的边方向。

查询当前 Schema

接口路径：GET /schema/mgmt/list?db=${dbName}。该接口用于获取指定子图的完整 Schema 定义，包括所有顶点类型、边类型及其连接关系。所需权限，READDATA。

• 请求格式：

  curl -X GET 'http://${host}:${port}/schema/mgmt/list?db=default' \
    -u '${user}:${password}'

• 响应示例：

  {
    "payload": {
      "edgeConnections": {
        "created": [
          "person",
          "software"
        ],
        "knows": [
          "person",
          "person"
        ]
      },
      "edgeLabels": {
        "created": [
          {
            "dataType": "STRING",
            "name": "date"
          },
          {
            "dataType": "DOUBLE",
            "name": "weight"
          }
        ],
        "knows": [
          {
            "dataType": "STRING",
            "name": "date"
          },
          {
            "dataType": "DOUBLE",
            "name": "weight"
          }
        ]
      },
      "schemaVersion": 0,
      "vertexLabels": {
        "software": [
          {
            "dataType": "STRING",
            "name": "name"
          },
          {
            "dataType": "STRING",
            "name": "lang"
          },
          {
            "dataType": "INT",
            "name": "price"
          }
        ],
        "person": [
          {
            "dataType": "STRING",
            "name": "name"
          },
          {
            "dataType": "INT",
            "name": "age"
          },
          {
            "dataType": "STRING",
            "name": "city"
          }
        ]
      }
    },
    "status": "200 OK"
  }

清空子图数据

接口路径：/db/del 。该接口用于快速清理子图，调用时需使用 root 账号。当传入的是系统默认子图 default 时，仅清空数据并删除其中的 Schema 定义，但 default 子图本身会保留；当传入的是其他子图时，整个子图会被一并删除。

curl -X GET 'http://${host}:${port}/db/del?db=default' \
  -u '${root_user}:${root_password}'