[FEAT]: table.fetch method - supported? about dynamodb-onetable HOT 13 CLOSED

Good stuff, thanks Michael, I'll have a look at this as soon as I can and ping you back if any issues

from dynamodb-onetable.

Good spelunking!

We're prototyping the fetch method and exploring different options.

The alternative is: to use queryItems and groupByType as described in the README. We are exploring a cleaner way to read item collections using fetch.

Can you share your final .d.ts type definition?

from dynamodb-onetable.

Thanks for introducing me to a new word!

I didn't do anything with the .d.ts file, I just did a horrid cast to any:

    items = await table.fetch(["User", "UserProfile"], {pk: `User:${id}`}) as any // error in types file

    const users: UserType[] = items.User
    const profiles: UserProfileType[] = items.UserProfile

from dynamodb-onetable.

We're still not quite ready to cement the API for fetch. All ideas are welcome.

I'll get the .d.ts type fixed so you can experiment without the cast.

from dynamodb-onetable.

Perfect, many thanks.

Re the groupByType you mentioned, the README has this:

items = db.groupByType(items)

... but doesn't mention what "db" is? (Perhaps I'm being a bit dense here!)

from dynamodb-onetable.

We use db sometimes for table. It is a Table instance.

I'll fix the doc for that.

from dynamodb-onetable.

Just pushed to the REPO:

Added a type for fetch() and groupByType to Table.d.ts.

export type EntityGroup = {
    [key: string]: AnyEntity
};

fetch(models: string[], properties: OneProperties, params?: OneParams): Promise<EntityGroup>;
groupByType(items: AnyEntity[]): EntityGroup;

And added a test/typescript-tennant.ts which does some basic exercise of the fetch API.

Though still not documented (fetch), here is the usage:

let collection = await table.fetch(['Account', 'User'], {pk: `account#${account.id}`})

You give a list of model types and the PK. Fetch has an implicit params.parse == true.
Returns similar to groupByType.

from dynamodb-onetable.

Fixed in 1.5.5.

Please give some feedback about the API. I'd like to settle on this and document it.

from dynamodb-onetable.

I'll keep this issue open until fetch is released fully.

from dynamodb-onetable.

Apologies Michael, I've been pulled onto something else briefly, I'll ping you back about this asap

from dynamodb-onetable.

Hey, so with the change to table.fetch... if you key into the EntityGroup the .d.ts says we get a single AnyEntity value, but in reality we get AnyEntity[] don't we?

As far as the fetch api itself goes it is useful, for sure. I can't help wondering whether we could get stronger typing. E.g. rather than keying into a collection by string (type name) could we key by model - i.e. Model<T> - with the value being T[]? May not be possible, I haven't delved into the code.

Cheers!

from dynamodb-onetable.

Understand. You would need to iterate the models first parameter.

Alternatively we could do something like:

let collection = await fetch<User, Account>(['User', 'Account'], {pk})

Otherwise, you would need to iterate the models array and construct type types from that. Not sure if TypeScript can enumerate arrays like we do when iterating the schema to create the model types.

from dynamodb-onetable.

We're going to document the current implementation for now.

from dynamodb-onetable.