Conversion options for keys

[zirkelc]

Hi,

for testing purposes I need to query items created by ElectroDB via the AWS SDK. That means I have to convert an item to the respective keys of a primary or secondary index. Currently, this conversions.byAccessPattern.records.fromComposite.toKeys(item) returns all index fields of the table index pk/sk and the secondary index gs1pk/gs1sk.

import { Entity, createConversions } from "electrodb";

const thing = new Entity(
  {
    model: {
      entity: "thing",
      version: "1",
      service: "thingstore",
    },
    attributes: {
      organizationId: {
        type: "string",
      },
      accountId: {
        type: "string",
      },
      name: {
        type: "string",
      },
      description: {
        type: "string",
      },
    },
    indexes: {
      records: {
        pk: {
          field: "pk",
          composite: ["organizationId"],
        },
        sk: {
          field: "sk",
          composite: ["accountId"],
        },
      },
      byAccount: {
        index: 'gsi1pk-gsi1sk-index',
        pk: {
          field: "gsi1pk",
          composite: ["accountId"],
        },
        sk: {
          field: "gsi1sk",
          composite: ["organizationId"],
        },
      },
    },
  },
  { table: "my_table" },
);

const composite = {
  accountId: "be0c1696-50e5-47b2-8e7b-ec14d842a3f0",
  organizationId: "a13417bc-0105-4ca1-98ed-dc83204d9c08",
};

const conversions = createConversions(thing);

const keys = conversions.byAccessPattern.byAccount.fromComposite.toKeys(composite);

console.log(keys);

Output:

{
  gsi1pk: '$thingstore#accountid_be0c1696-50e5-47b2-8e7b-ec14d842a3f0',
  gsi1sk: '$thing_1#organizationid_a13417bc-0105-4ca1-98ed-dc83204d9c08',
  pk: '$thingstore#organizationid_a13417bc-0105-4ca1-98ed-dc83204d9c08',
  sk: '$thing_1#accountid_be0c1696-50e5-47b2-8e7b-ec14d842a3f0'
}

I would like to suggest an option to only return the secondary index fields gs1pk/gs1sk, maybe something like:
conversions.byAccessPattern.records.fromComposite.toKeys(item, { fields: 'all' | 'index' | 'pk' | 'sk' }) where

• fields: 'all' returns the all fields like it is now

const keys = conversions.byAccessPattern.byAccount.fromComposite.toKeys(composite, { fields: 'all' });
{
  gsi1pk: '$thingstore#accountid_be0c1696-50e5-47b2-8e7b-ec14d842a3f0',
  gsi1sk: '$thing_1#organizationid_a13417bc-0105-4ca1-98ed-dc83204d9c08',
  pk: '$thingstore#organizationid_a13417bc-0105-4ca1-98ed-dc83204d9c08',
  sk: '$thing_1#accountid_be0c1696-50e5-47b2-8e7b-ec14d842a3f0'
}

• fields: 'index' returns only the fields from the selected index byAccessPattern.records like gsi1pk/gsi1sk

const keys = conversions.byAccessPattern.byAccount.fromComposite.toKeys(composite, { fields: 'index' });
{
  gsi1pk: '$thingstore#accountid_be0c1696-50e5-47b2-8e7b-ec14d842a3f0',
  gsi1sk: '$thing_1#organizationid_a13417bc-0105-4ca1-98ed-dc83204d9c08',
}

• fields: 'pk' | 'sk' only returns the actual gsi1pk/gsi1sk as object or even as string

const keys = conversions.byAccessPattern.byAccount.fromComposite.toKeys(composite, { fields: 'pk' });
{
 gsi1pk: '$thingstore#accountid_be0c1696-50e5-47b2-8e7b-ec14d842a3f0',
}
// or string
'$thingstore#accountid_be0c1696-50e5-47b2-8e7b-ec14d842a3f0'

[tywalch]

Thanks @zirkelc!

The fields option sounds good; I'm feeling more partial to the options being something like 'all' | 'index' | 'table', what do you think?

[zirkelc]

That's good with me!