StorageAdapterBase | amplify-js

Hierarchy

StorageAdapterBase
- IndexedDBAdapter
- AsyncStorageAdapter

Implements

Adapter

Index

Properties

Methods

Properties

Protected Abstract db

db: IDBPDatabase | 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 Abstract _get

_get<T>(storeOrStoreName: IDBPObjectStore | string, keyArr: string[]): Promise<T>

- Defined in packages/datastore/src/storage/adapter/StorageAdapterBase.ts:240
Type parameters
- T
Parameters
- storeOrStoreName: IDBPObjectStore | string
- keyArr: string[]
Returns Promise<T>

Abstract batchSave

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

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

Abstract clear

clear(): Promise<void>

Implementation of Adapter.clear
- Defined in packages/datastore/src/storage/adapter/StorageAdapterBase.ts:112
Returns Promise<void>

delete

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

- 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 Abstract deleteItem

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

- Defined in packages/datastore/src/storage/adapter/StorageAdapterBase.ts:481
Type parameters
- T: PersistentModel
Parameters
- Optional deleteQueue: object[]
Returns any

Protected getIndexKeyValuesFromModel

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

- 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

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

local DB table name

Protected Abstract initDb

initDb(): Promise<IDBPDatabase | AsyncStorageDatabase>

- Defined in packages/datastore/src/storage/adapter/StorageAdapterBase.ts:57
Returns Promise<IDBPDatabase | AsyncStorageDatabase>

Protected load

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

- 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 Abstract preOpCheck

preOpCheck(): Promise<void>

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

Protected Abstract preSetUpChecks

preSetUpChecks(): Promise<void>

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

Abstract query

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

Implementation of Adapter.query
- Defined in packages/datastore/src/storage/adapter/StorageAdapterBase.ts:119
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

- 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

Abstract queryOne

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

Implementation of Adapter.queryOne
- Defined in packages/datastore/src/storage/adapter/StorageAdapterBase.ts:125
Type parameters
- T: PersistentModel
Parameters
- modelConstructor: PersistentModelConstructor<T>
- firstOrLast: QueryOne
Returns Promise<T | undefined>

Abstract save

save<T>(model: T, condition?: ModelPredicate<T>): any

Implementation of Adapter.save
- Defined in packages/datastore/src/storage/adapter/StorageAdapterBase.ts:114
Type parameters
- T: PersistentModel
Parameters
- model: T
- Optional condition: ModelPredicate<T>
Returns any

Protected saveMetadata

saveMetadata<T>(model: T): object

- 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>

- 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

- 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 Abstract 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 Abstract _get

Type parameters

T

Parameters

storeOrStoreName: IDBPObjectStore | string

keyArr: string[]

Returns Promise<T>

Abstract batchSave

Type parameters

T: PersistentModel

Parameters

modelConstructor: PersistentModelConstructor<any>

items: ModelInstanceMetadata[]

Returns Promise<[T, OpType][]>

Abstract clear

Returns Promise<void>

delete

Type parameters

T: PersistentModel

Parameters

modelOrModelConstructor: T | PersistentModelConstructor<T>

Optional condition: ModelPredicate<T>

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

Protected Abstract deleteItem

Type parameters

T: PersistentModel

Parameters

Optional deleteQueue: object[]

Returns any

Protected getIndexKeyValuesFromModel

Type parameters

T: PersistentModel

Parameters

model: T

Returns string[]

Protected getStorenameForModel

Parameters

modelConstructor: PersistentModelConstructor<any>

Returns string

Protected Abstract initDb

Returns Promise<IDBPDatabase | AsyncStorageDatabase>

Protected load

Type parameters

T

Parameters

namespaceName: NAMESPACES

srcModelName: string

records: T[]

Returns Promise<T[]>

Protected Abstract preOpCheck

Returns Promise<void>