Adapter | amplify-js

Hierarchy

object
- Adapter

Implemented by

Index

Properties

delete

Methods

Properties

delete

delete: function

Type declaration

- <T>(modelOrModelConstructor: T | PersistentModelConstructor<T>, condition?: ModelPredicate<T>): Promise<[T[], T[]]>
- Type parameters
  - T: PersistentModel
  Parameters
  - modelOrModelConstructor: T | PersistentModelConstructor<T>
  - Optional condition: ModelPredicate<T>
  Returns Promise<[T[], T[]]>

Methods

batchSave

batchSave<T>(modelConstructor: PersistentModelConstructor<T>, items: ModelInstanceMetadata[]): Promise<[T, OpType][]>

- Defined in packages/datastore/src/storage/adapter/index.ts:33
Type parameters
- T: PersistentModel
Parameters
- modelConstructor: PersistentModelConstructor<T>
- items: ModelInstanceMetadata[]
Returns Promise<[T, OpType][]>

clear

clear(): Promise<void>

- Defined in packages/datastore/src/storage/adapter/index.ts:15
Returns Promise<void>

query

query<T>(modelConstructor: PersistentModelConstructor<T>, predicate?: ModelPredicate<T>, pagination?: PaginationInput<T>): Promise<T[]>

- Defined in packages/datastore/src/storage/adapter/index.ts:24
Type parameters
- T: PersistentModel
Parameters
- modelConstructor: PersistentModelConstructor<T>
- Optional predicate: ModelPredicate<T>
- Optional pagination: PaginationInput<T>
Returns Promise<T[]>

queryOne

queryOne<T>(modelConstructor: PersistentModelConstructor<T>, firstOrLast: QueryOne): Promise<T | undefined>

- Defined in packages/datastore/src/storage/adapter/index.ts:29
Type parameters
- T: PersistentModel
Parameters
- modelConstructor: PersistentModelConstructor<T>
- firstOrLast: QueryOne
Returns Promise<T | undefined>

save

save<T>(model: T, condition?: ModelPredicate<T>): Promise<[T, INSERT | UPDATE][]>

- Defined in packages/datastore/src/storage/adapter/index.ts:16
Type parameters
- T: PersistentModel
Parameters
- model: T
- Optional condition: ModelPredicate<T>
Returns Promise<[T, INSERT | UPDATE][]>

setUp

setUp(schema: InternalSchema, namespaceResolver: NamespaceResolver, modelInstanceCreator: ModelInstanceCreator, getModelConstructorByModelName: function, appId?: string): Promise<void>

Inherited from __type.setUp
- Defined in packages/datastore/src/types.ts:871
Parameters
- schema: InternalSchema
- namespaceResolver: NamespaceResolver
- modelInstanceCreator: ModelInstanceCreator
- getModelConstructorByModelName: function
  - - (namsespaceName: NAMESPACES, modelName: string): PersistentModelConstructor<any>
    - Parameters
      - namsespaceName: NAMESPACES
      - modelName: string
      Returns PersistentModelConstructor<any>
- Optional appId: string
Returns Promise<void>

Hierarchy

Implemented by

Index

Properties

Methods

Properties

delete

Type declaration

Type parameters

T: PersistentModel

Parameters

modelOrModelConstructor: T | PersistentModelConstructor<T>

Optional condition: ModelPredicate<T>

Returns Promise<[T[], T[]]>

Methods

batchSave

Type parameters

T: PersistentModel

Parameters

modelConstructor: PersistentModelConstructor<T>

items: ModelInstanceMetadata[]

Returns Promise<[T, OpType][]>

clear

Returns Promise<void>

query

Type parameters

T: PersistentModel

Parameters

modelConstructor: PersistentModelConstructor<T>

Optional predicate: ModelPredicate<T>

Optional pagination: PaginationInput<T>

Returns Promise<T[]>

queryOne

Type parameters

T: PersistentModel

Parameters

modelConstructor: PersistentModelConstructor<T>

firstOrLast: QueryOne

Returns Promise<T | undefined>

save

Type parameters

T: PersistentModel

Parameters

model: T

Optional condition: ModelPredicate<T>

Returns Promise<[T, INSERT | UPDATE][]>

setUp

Parameters

schema: InternalSchema

namespaceResolver: NamespaceResolver

modelInstanceCreator: ModelInstanceCreator

getModelConstructorByModelName: function

Parameters

namsespaceName: NAMESPACES

modelName: string

Returns PersistentModelConstructor<any>

Optional appId: string

Returns Promise<void>