AWS Amplify JS 中使用 PostgreSQL 自动生成类型时 list() 命令返回空数组问题解析

问题背景

在使用 AWS Amplify JS 的 Gen 2 版本时，开发者可能会遇到一个特殊的数据查询问题：当通过 npx ampx generate schema-from-database 命令从 PostgreSQL 数据库自动生成数据模型后，对于使用字符串类型作为标识符（identifier）的模型，list() 方法会返回空数组，而使用整数类型作为标识符的模型则能正常返回数据。

技术细节分析

自动生成的模型结构差异

从 PostgreSQL 数据库自动生成的模型有两种典型结构：

1. 字符串类型标识符模型

"auth": a.model({
    user_id: a.string().required(),
    username: a.string().required(),
    password: a.string().required(),
    access: a.boolean(),
    created: a.datetime(),
    updated: a.datetime()
}).identifier(["user_id"])

2. 整数类型标识符模型

"one_off": a.model({
    id: a.integer().required(),
    token: a.string(),
    amount: a.integer(),
    used: a.integer(),
    expiry_date: a.datetime(),
    created: a.datetime(),
    updated: a.datetime()
}).identifier(["id"])

GraphQL 查询差异

这两种模型生成的 GraphQL 查询语句存在关键差异：

字符串标识符模型查询

query ($user_id: String, $sortDirection: ModelSortDirection, $filter: ModelAuthFilterInput, $limit: Int, $nextToken: String) {
  listAuths(
    user_id: $user_id
    sortDirection: $sortDirection
    filter: $filter
    limit: $limit
    nextToken: $nextToken
  ) {
    items {
      user_id
      username
      password
      access
      created
      updated
    }
    nextToken
    __typename
  }
}

整数标识符模型查询

query ($filter: ModelOne_offFilterInput, $limit: Int, $nextToken: String) {
  listOne_offs(filter: $filter, limit: $limit, nextToken: $nextToken) {
    items {
      id
      token
      amount
      used
      expiry_date
      created
      updated
    }
    nextToken
    __typename
  }
}

关键区别在于字符串标识符模型会将标识符字段（如 user_id）作为查询参数，而整数标识符模型则不会。当 user_id 参数未提供时，查询可能无法返回预期结果。

解决方案

经过 AWS Amplify 团队的验证，最新版本的 @aws-amplify/backend 和 @aws-amplify/backend-cli 已经解决了这个问题。开发者可以采取以下步骤：

1. 更新相关依赖包：

npm i @aws-amplify/backend @aws-amplify/backend-cli

2. 更新数据模式包：

npm update @aws-amplify/data-schema

验证结果

在最新版本中，即使是使用字符串类型作为标识符的模型，list() 方法也能正常返回数据。例如：

const { data } = await client.models.posts.list();
console.log(data); // 正常返回所有帖子数据

对应的 GraphQL 查询也不再包含标识符字段作为查询参数，确保了查询的完整性和一致性。

总结

这个问题主要出现在特定版本的 AWS Amplify JS 中，特别是在处理 PostgreSQL 数据库自动生成的模型时。通过更新到最新版本，开发者可以避免这种不一致的行为，确保无论使用何种类型的标识符，list() 方法都能按预期工作。

对于使用 AWS Amplify JS 连接现有数据库的开发人员，建议定期检查并更新相关依赖包，以获得最佳兼容性和稳定性。同时，在定义数据库模型时，了解不同类型标识符的处理方式也有助于更好地设计数据结构和查询逻辑。