AsyncStorageAdapter | amplify-js

Hierarchy

StorageAdapterBase
- AsyncStorageAdapter

Implements

Adapter

Index

Properties

Methods

Properties

Protected db

db: AsyncStorageDatabase

Protected dbName

dbName: string = DB_NAME

Protected getModelConstructorByModelName

getModelConstructorByModelName: function

Type declaration

- (namsespaceName: NAMESPACES, modelName: string): PersistentModelConstructor<any>
- Parameters
  - namsespaceName: NAMESPACES
  - modelName: string
  Returns PersistentModelConstructor<any>

Protected initPromise

initPromise: Promise<void>

Protected modelInstanceCreator

modelInstanceCreator: ModelInstanceCreator

Protected namespaceResolver

namespaceResolver: NamespaceResolver

Protected reject

reject: function

Type declaration

- (value?: any): void
- Parameters
  - Optional value: any
  Returns void

Protected resolve

resolve: function

Type declaration

- (value?: any): void
- Parameters
  - Optional value: any
  Returns void

Protected schema

schema: InternalSchema

Methods

Protected _get

_get<T>(storeName: string, keyArr: string[]): Promise<T>

Overrides StorageAdapterBase._get
- Defined in packages/datastore/src/storage/adapter/AsyncStorageAdapter.ts:91
Type parameters
- T
Parameters
- storeName: string
- keyArr: string[]
Returns Promise<T>

batchSave

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

Implementation of Adapter.batchSave

Overrides StorageAdapterBase.batchSave
- Defined in packages/datastore/src/storage/adapter/AsyncStorageAdapter.ts:53
Type parameters
- T: PersistentModel
Parameters
- modelConstructor: PersistentModelConstructor<any>
- items: ModelInstanceMetadata[]
Returns Promise<[T, OpType][]>

clear

clear(): Promise<void>

Implementation of Adapter.clear

Overrides StorageAdapterBase.clear
- Defined in packages/datastore/src/storage/adapter/AsyncStorageAdapter.ts:46
Returns Promise<void>

delete

delete<T>(modelOrModelConstructor: T | PersistentModelConstructor<T>, condition?: ModelPredicate<T>): Promise<[T[], T[]]>

Inherited from StorageAdapterBase.delete
- Defined in packages/datastore/src/storage/adapter/StorageAdapterBase.ts:374
Delete record Cascades to related records (for Has One and Has Many relationships)

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

Protected deleteItem

deleteItem<T>(deleteQueue?: object[]): Promise<void>

Overrides StorageAdapterBase.deleteItem
- Defined in packages/datastore/src/storage/adapter/AsyncStorageAdapter.ts:218
Type parameters
- T: PersistentModel
Parameters
- Optional deleteQueue: object[]
Returns Promise<void>

Protected getIndexKeyValuesFromModel

getIndexKeyValuesFromModel<T>(model: T): string[]

Inherited from StorageAdapterBase.getIndexKeyValuesFromModel
- Defined in packages/datastore/src/storage/adapter/StorageAdapterBase.ts:153
Type parameters
- T: PersistentModel
Parameters
- model: T
  
  instantiated model record
Returns string[]

the record's primary key values

Protected getStorenameForModel

getStorenameForModel(modelConstructor: PersistentModelConstructor<any>): string

Inherited from StorageAdapterBase.getStorenameForModel
- Defined in packages/datastore/src/storage/adapter/StorageAdapterBase.ts:139
Parameters
- modelConstructor: PersistentModelConstructor<any>
Returns string

local DB table name

Protected initDb

initDb(): Promise<AsyncStorageDatabase>

Overrides StorageAdapterBase.initDb
- Defined in packages/datastore/src/storage/adapter/AsyncStorageAdapter.ts:40
Open AsyncStorage database Create new DB if one doesn't exist

Called by StorageAdapterBase.setUp()

Returns Promise<AsyncStorageDatabase>

AsyncStorageDatabase instance

Protected load

load<T>(namespaceName: NAMESPACES, srcModelName: string, records: T[]): Promise<T[]>

Inherited from StorageAdapterBase.load
- Defined in packages/datastore/src/storage/adapter/StorageAdapterBase.ts:253
Instantiate models from POJO records returned from the database

Type parameters
- T
Parameters
- namespaceName: NAMESPACES
  
  string model namespace
- srcModelName: string
  
  string model name
- records: T[]
  
  array of uninstantiated records
Returns Promise<T[]>

Protected preOpCheck

preOpCheck(): Promise<void>

Overrides StorageAdapterBase.preOpCheck
- Defined in packages/datastore/src/storage/adapter/AsyncStorageAdapter.ts:30
Returns Promise<void>

Protected preSetUpChecks

preSetUpChecks(): Promise<void>

Overrides StorageAdapterBase.preSetUpChecks
- Defined in packages/datastore/src/storage/adapter/AsyncStorageAdapter.ts:29
Returns Promise<void>

query

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

Implementation of Adapter.query

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

Protected queryMetadata

queryMetadata<T>(modelConstructor: PersistentModelConstructor<T>, predicate?: ModelPredicate<T>, pagination?: PaginationInput<T>): object

Inherited from StorageAdapterBase.queryMetadata
- Defined in packages/datastore/src/storage/adapter/StorageAdapterBase.ts:334
Common metadata for query operation used by individual storage adapters

Type parameters
- T: PersistentModel
Parameters
- modelConstructor: PersistentModelConstructor<T>
- Optional predicate: ModelPredicate<T>
- Optional pagination: PaginationInput<T>
Returns object
- hasPagination: number
- hasSort: object
- namespaceName: NAMESPACES
- predicates: object
  - predicates: (PredicatesGroup | object)[]
  - type: keyof PredicateGroups<T>
- queryByKey: string[]
- storeName: string

queryOne

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

Implementation of Adapter.queryOne

Overrides StorageAdapterBase.queryOne
- Defined in packages/datastore/src/storage/adapter/AsyncStorageAdapter.ts:208
Type parameters
- T: PersistentModel
Parameters
- modelConstructor: PersistentModelConstructor<T>
- Default value firstOrLast: QueryOne = QueryOne.FIRST
Returns Promise<T | undefined>

save

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

Implementation of Adapter.save

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

Protected saveMetadata

saveMetadata<T>(model: T): object

Inherited from StorageAdapterBase.saveMetadata
- Defined in packages/datastore/src/storage/adapter/StorageAdapterBase.ts:174
Common metadata for save operation used by individual storage adapters

Type parameters
- T: PersistentModel
Parameters
- model: T
Returns object
- connectionStoreNames: any
- modelKeyValues: string[]
- set: Set<string>
- storeName: string

setUp

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

Inherited from StorageAdapterBase.setUp
- Defined in packages/datastore/src/storage/adapter/StorageAdapterBase.ts:68
Initializes local DB

Parameters
- theSchema: InternalSchema
- namespaceResolver: NamespaceResolver
- modelInstanceCreator: ModelInstanceCreator
- getModelConstructorByModelName: function
  - - (namsespaceName: NAMESPACES, modelName: string): PersistentModelConstructor<any>
    - Parameters
      - namsespaceName: NAMESPACES
      - modelName: string
      Returns PersistentModelConstructor<any>
- Optional sessionId: string
Returns Promise<void>

Protected validateSaveCondition

validateSaveCondition<T>(condition?: ModelPredicate<T>, fromDB?: unknown): void

Inherited from StorageAdapterBase.validateSaveCondition
- Defined in packages/datastore/src/storage/adapter/StorageAdapterBase.ts:219
Enforces conditional save. Throws if condition is not met. used by individual storage adapters

Type parameters
- T: PersistentModel
Parameters
- Optional condition: ModelPredicate<T>
- Optional fromDB: unknown
Returns void

Hierarchy

Implements

Index

Properties

Methods

Properties

Protected db

Protected dbName

Protected getModelConstructorByModelName

Type declaration

Parameters

namsespaceName: NAMESPACES

modelName: string

Returns PersistentModelConstructor<any>

Protected initPromise

Protected modelInstanceCreator

Protected namespaceResolver

Protected reject

Type declaration

Parameters

Optional value: any

Returns void

Protected resolve

Type declaration

Parameters

Optional value: any

Returns void

Protected schema

Methods

Protected _get

Type parameters

T

Parameters

storeName: string

keyArr: string[]

Returns Promise<T>

batchSave

Type parameters

T: PersistentModel

Parameters

modelConstructor: PersistentModelConstructor<any>

items: ModelInstanceMetadata[]

Returns Promise<[T, OpType][]>

clear

Returns Promise<void>

delete

Type parameters

T: PersistentModel

Parameters

modelOrModelConstructor: T | PersistentModelConstructor<T>

Optional condition: ModelPredicate<T>

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

Protected deleteItem

Type parameters

T: PersistentModel

Parameters

Optional deleteQueue: object[]

Returns Promise<void>

Protected getIndexKeyValuesFromModel

Type parameters

T: PersistentModel

Parameters

model: T

Returns string[]

Protected getStorenameForModel

Parameters

modelConstructor: PersistentModelConstructor<any>

Returns string

Protected initDb

Returns Promise<AsyncStorageDatabase>

Protected load

Type parameters

T

Parameters

namespaceName: NAMESPACES

srcModelName: string

records: T[]

Returns Promise<T[]>

Protected preOpCheck

Returns Promise<void>