Guidance on using aws-sdk v3? New user

[ktwbc]

Is there updated documentation on setting up electrodb with aws-sdk v3? I've been unable to get anything to work:

Entity file:

import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
import { DynamoDBClient } from '@aws-sdk/client-dynamodb/dist-types/DynamoDBClient';

const ddbClient = new DynamoDBClient({});
const client = DynamoDBDocumentClient.from(ddbClient);
const table = 'my-ddb-table;
export const MyTable = new Entity(..., { table, client} );

Attempting to use this in a controller with

import { MyTable } from './entity/MyTable.ts'
let record = await MyTable.get({ keyname: 'test' }).go();

results in
No client defined on model

But I am passing the client, so not sure what's going on here.

[tywalch]

Hi @ktwbc 👋

Here is an example of how you you can use Electro with the v3 client:

import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
import { Entity } from 'electrodb';

const table = 'my-table';

const client = new DynamoDBClient({
    region: "us-east-1",
    endpoint: 'http://localhost:8000',
});

const thing = new Entity({
  model: {
    entity: 'thing',
    service: 'database',
    version: '01'
  },
  attributes: {
    id: {
      type: 'string',
    },
    name: {
      type: 'string',
    },
    description: {
      type: 'string',
    }
  },
  indexes: {
    record: {
      pk: {
        field: 'pk',
        composite: ['id'],
      },
      sk: {
        field: 'sk',
        composite: [],
      },
    }
  }
}, { table, client });

thing.get({ id: '123' }).go()
  .then(console.log)
  .catch(console.error);

[ktwbc]

I got it mostly working, after figuring out I needed to use templates to put this on an existing database (, but am still encountering something strange when trying to do a get() and it's not returning the record.

I can attach the logger to the Entity and I see that electrodb is querying the table and returns my record:

// logging output

{
    "type": "results",
    "method": "get",
    "config": {
        "includeKeys": false,
        "originalErr": false,
        "raw": false,
        "params": {},
        "page": {},
        "lastEvaluatedKeyRaw": false,
        "pager": "named",
        "unprocessed": "item",
        "response": "default",
        "cursor": null,
        "data": "attributes",
        "ignoreOwnership": false,
        "_isPagination": false,
        "_isCollectionQuery": false,
        "pages": 1,
        "listeners": [],
        "preserveBatchOrder": false,
        "attributes": [],
        "terminalOperation": "go",
        "formatCursor": {}
    },
    "success": true,
    "results": {
        "$metadata": {
            "httpStatusCode": 200,
            "requestId": "V15HVBEBORLMUQIOF29V8Q5LH3VV4KQNSO5AEMVJF66Q9ASUAAJG",
            "attempts": 1,
            "totalRetryDelay": 0
        },
        "Item": {
            "created_at": 1616171657.098,
            "status": "available",

So the "Item" is definitely the record I've queried in that output.

yet the result object in my actual code only returns { data: null } which is baffling since the logger clearly shows it retrieved the record.

    const record = await Tokens.get({ id: '296fb911-cc03-441e-9f00-a147eaadabc1' }).go();
    console.log(record); // logs as "{ data: null }"

Tokens.ts

export const Tokens = new Entity(
  {
    model: {
      entity: 'Tokens',
      service: 'database',
      version: '01'
    },
    attributes: {
      id: {
        type: 'string'
      },
      status: {
        type: 'string'
      }
    },
    indexes: {
      tokens: {
        pk: {
          field: 'id',
          composite: ['id'],
          template: '${id}'
        }
      }
    }
  },
  { client, table, logger }
);

[tywalch]

Are you querying data that wasn't added by with ElectroDB? If so, you'll want to use the execution option: { ignoreOwnership: true }, as in:

const record = await Tokens
  .get({ id: '296fb911-cc03-441e-9f00-a147eaadabc1' })
  .go({ ignoreOwnership: true });

[tywalch]

You can read more about the option here: https://electrodb.dev/en/queries/get/#execution-options

[ktwbc]

Thanks. I am coming from Dynamo-Types ORM and wrote a converter https://github.com/ktwbc/convert-to-electrodb for my model files based on this. Appreciate the help.