Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@aws-amplify/graphql-index-transformer

aws-amplify309.9kApache-2.03.0.19TypeScript support: included

Amplify GraphQL index and key transformers

graphql, cloudformation, aws, amplify, transformer

readme

GraphQL @primaryKey Transformer

Reference Documentation

@primaryKey

The @primaryKey directive allows you to define the primary key for your relational data.

Definition

directive @primaryKey(sortKeyFields: [String]) on FIELD_DEFINITION

changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

3.0.19 (2025-06-09)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

3.0.18 (2025-04-17)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

3.0.17 (2025-04-09)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

3.0.16 (2025-03-06)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

3.0.15 (2025-02-26)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

3.0.14 (2025-02-07)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

3.0.13 (2025-01-30)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

3.0.12 (2025-01-16)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

3.0.11 (2024-12-23)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

3.0.10 (2024-12-17)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

3.0.9 (2024-11-14)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

3.0.8 (2024-11-08)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

3.0.7 (2024-10-28)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

3.0.6 (2024-10-17)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

3.0.5 (2024-10-10)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

3.0.4 (2024-10-01)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

3.0.3 (2024-09-16)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

3.0.2 (2024-09-06)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

3.0.1 (2024-08-28)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

3.0.0 (2024-08-20)

  • feat!: bump version for v2 transformer packages (7dac35c)

BREAKING CHANGES

  • distinguish from LTS version

2.4.9 (2024-08-12)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.4.8 (2024-07-25)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.4.7 (2024-07-15)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.4.6 (2024-07-02)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.4.5 (2024-07-01)

Bug Fixes

  • auth to use validateUsingSource in place of auth filter to show error message (#2523) (b7d83f9)

2.4.4 (2024-06-25)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.4.3 (2024-05-15)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.4.2 (2024-05-10)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.4.1 (2024-05-01)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.4.0 (2024-04-26)

Bug Fixes

  • auto generated id when timestamps: null (#2470) (936a4f9)
  • enum input type in filter input when list is disabled (#2446) (13c2716)

Features

  • iam access support for searchable, index and sql directives (#2398) (c2a3d92)

2.3.9 (2024-04-11)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.3.8 (2024-03-28)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.3.7 (2024-03-13)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.3.6 (2024-02-28)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.3.5 (2024-02-05)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.3.4 (2024-01-30)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.3.3 (2024-01-22)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.3.2 (2023-12-18)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.3.1 (2023-12-14)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.3.0 (2023-12-06)

Features

2.2.3 (2023-11-22)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.2.2 (2023-11-18)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.2.1 (2023-11-16)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.2.0 (2023-11-15)

Bug Fixes

  • Change 'rds' to 'sql' in public-facing symbols (#2069) (ff374dd)

Features

2.1.8 (2023-11-02)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.1.7 (2023-10-12)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.1.6 (2023-10-05)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.1.5 (2023-10-02)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.1.4 (2023-09-20)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.1.3 (2023-09-07)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.1.2 (2023-08-30)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.1.1 (2023-08-28)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

2.1.0 (2023-08-09)

Features

  • bump major version of transformer packages (2458c84)

1.2.9 (2023-07-21)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

1.2.8 (2023-07-17)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

1.2.7 (2023-07-07)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

1.2.6 (2023-07-07)

Bug Fixes

1.2.5 (2023-07-07)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

1.2.4 (2023-06-29)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

1.2.3 (2023-06-20)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

1.2.2 (2023-06-05)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

1.2.1 (2023-05-23)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

1.2.0 (2023-05-17)

Bug Fixes

  • graphql: import rds errors due to primary key and index (dbb8efe)
  • graphql: index rds query (73389da)
  • minor changes to resolver generation (dee51d5)
  • simplify the RDS VTL generation (55ab18a)

Features

  • add RDS primary key transformer (b6cd813)
  • graphql: add index directive support for rds (bb2fdb7)

1.1.3 (2023-04-25)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

1.1.2 (2023-03-30)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

1.1.1 (2023-03-15)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

1.1.0 (2023-03-01)

Bug Fixes

  • lock CDK v2 version (#923) (2afe40c)
  • throw error if invalid override or invalid custom stack error (#982) (6dfeeba)

Features

  • migrate index and model transformers to CDK v2 (#860) (886ab6c)

1.1.0-beta.6 (2023-02-21)

Bug Fixes

  • lock CDK v2 version (#923) (2afe40c)
  • throw error if invalid override or invalid custom stack error (#982) (6dfeeba)

Features

  • migrate index and model transformers to CDK v2 (#860) (886ab6c)

1.1.0-beta.5 (2023-02-15)

Bug Fixes

  • lock CDK v2 version (#923) (2afe40c)
  • throw error if invalid override or invalid custom stack error (#982) (6dfeeba)

Features

  • migrate index and model transformers to CDK v2 (#860) (886ab6c)

1.1.0-beta.4 (2023-02-03)

Bug Fixes

  • lock CDK v2 version (#923) (2afe40c)
  • throw error if invalid override or invalid custom stack error (#982) (6dfeeba)

Features

  • migrate index and model transformers to CDK v2 (#860) (886ab6c)

1.1.0-beta.3 (2022-12-27)

Bug Fixes

  • lock CDK v2 version (#923) (2afe40c)
  • throw error if invalid override or invalid custom stack error (#982) (6dfeeba)

Features

  • migrate index and model transformers to CDK v2 (#860) (886ab6c)

1.1.0-beta.2 (2022-12-12)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

1.1.0-beta.1 (2022-11-30)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

1.1.0-beta.0 (2022-11-18)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

1.1.0-cdkv2.3 (2022-11-15)

Bug Fixes

  • lock CDK v2 version (#923) (2afe40c)
  • throw error if invalid override or invalid custom stack error (#982) (6dfeeba)

Features

  • migrate index and model transformers to CDK v2 (#860) (886ab6c)

1.1.0-cdkv2.2 (2022-11-03)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

1.1.0-cdkv2.1 (2022-10-24)

Bug Fixes

1.1.0-cdkv2.0 (2022-10-24)

Features

  • migrate index and model transformers to CDK v2 (#860) (886ab6c)

0.14.10 (2023-02-27)

Bug Fixes

  • test: update cli dependencies to use the cli rc packages (#1294) (7b13884)

0.14.9 (2023-02-10)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.14.8 (2023-01-26)

Bug Fixes

  • graphql: add filter null check to index query resolver (#1182) (fff5402)

0.14.7 (2023-01-12)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.14.6 (2023-01-12)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.14.5 (2022-12-13)

Bug Fixes

  • resolvers generated from index respect StackMappings (ed0827a)

0.14.4 (2022-12-03)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.14.3 (2022-11-08)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.14.2 (2022-10-26)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.14.1 (2022-10-24)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.14.0 (2022-10-04)

Features

0.13.8 (2022-09-20)

Bug Fixes

  • amplify-graphql-index-transformer: set default lastSync correctly (c3fd699)

0.13.7 (2022-09-14)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.13.6 (2022-08-23)

Reverts

  • Revert "Undo change to directive merge that broke tests" (#756) (3da2ce6), closes #756

0.13.5 (2022-08-16)

Bug Fixes

  • amplify-graphql-index-transformer: avoid scan on base table when query expression is specified on index field (bbc5884)
  • amplify-graphql-index-transformer: read overrides during transformation (5e59d18)

0.13.4 (2022-08-04)

Bug Fixes

  • graphql: revert subscriptions server-side filtering (20cffc0)

0.13.3 (2022-07-26)

Bug Fixes

  • graphql: incorrect filter expression on model transformer (#697) (a6fc3be)

0.13.2 (2022-07-20)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.13.1 (2022-07-14)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.13.0 (2022-07-01)

Features

  • graphql: add runtime filtering support for subscriptions (#551) (0a24bb0)

0.12.1 (2022-06-23)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.12.0 (2022-06-13)

Features

  • add error when using an owner field as a sort key field (#517) (201032d)

0.11.11 (2022-06-10)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.11.10 (2022-06-07)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.11.9 (2022-05-31)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.11.8 (2022-05-02)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.11.7 (2022-04-29)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.11.6 (2022-04-27)

Bug Fixes

  • validate the presence of sortKeyFields when index is on the same field as the primary key (#9841) (754ae44), closes #4138

0.11.5 (2022-04-18)

Bug Fixes

  • graphql-model-transformer: fix create mutation when index field is null (#10073) (1e9d140)

0.11.4 (2022-04-07)

Bug Fixes

  • graphql: avoid duplicate function when overriding resolvers (#9980) (94398f8)

0.11.3 (2022-03-23)

Bug Fixes

  • graphql: avoid static datastructures in gql transform (#10006) (cd73fdd)

0.11.2 (2022-02-25)

Bug Fixes

0.11.1 (2022-02-15)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.11.0 (2022-01-31)

7.6.14 (2022-01-28)

Features

  • [@maps](https://github.com/maps)To directive to enable renaming models while retaining data (#9340) (aedf45d)

0.8.8 (2022-01-27)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.8.7 (2022-01-20)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.8.6 (2022-01-13)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.8.5 (2022-01-10)

7.6.7 (2022-01-10)

Bug Fixes

  • graphql: correct typo filterExpression on v2 resolvers (#9412) (71bf468)
  • graphql: make hash key as non null type for index transformer (#9411) (e0f7de6)
  • update @primaryKey get/list queries for lowercase models (#9409) (9c718ae)

0.8.3 (2021-12-21)

Bug Fixes

  • generate list types will nullable elements (#9310) (e972956)

0.8.2 (2021-12-17)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.8.1 (2021-12-03)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.8.0 (2021-11-23)

Features

0.7.4 (2021-11-21)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.7.3 (2021-11-19)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.7.2 (2021-11-17)

Bug Fixes

  • append apiKey if global auth is enabled and its not default auth (#8843) (3aadcde)

0.7.1 (2021-11-15)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.5.0 (2021-11-11)

Bug Fixes

Features

0.4.0 (2021-10-10)

Features

  • graphql-model-transformer: index/primarykey datastore selective sync capability (#8240) (e108783)

0.3.3 (2021-09-27)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.3.2 (2021-09-14)

Note: Version bump only for package @aws-amplify/graphql-index-transformer

0.3.1 (2021-09-02)

Bug Fixes

0.3.0 (2021-08-24)

Features

0.2.1 (2021-08-06)

Bug Fixes

0.2.0 (2021-07-30)

Features