Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SqLiteCordovaAdapter

An SQLite adapter for the cordova-sqlite-storage plugin. Supports SQLite databases on Android, iOS and Windows.

This adapter supports SQL operations, transactions, and local store operations exposed by a local database context (of class DbLocalContext). The iquery operation is not supported.

This adapter provides an extension method deleteDatabase for deleting the local SQLite database file specified in the connection options.

This adapter accepts the following connection info: connectionString specifies the name of the database file. connectionOptions accepts a location option (defaults to default). To specify a different location, (affects iOS only) use the iosDatabaseLocation option with one of the following choices:

  • default: stored in Library/LocalDatabase subdirectory, not visible to iTunes and not backed up by iCloud
  • Library: stored in Library subdirectory, backed up by iCloud, not visible to iTunes
  • Documents: stored in Documents subdirectory, visible to iTunes and backed up by iCloud

Like with other Cordova plugins you must wait for the deviceready event in your app before instantiating a local database context with this adapter. Note that controllers and other service classes injected into Ionic/Angular UI components are created before the deviceready event is fired. Thus, you should never execute operations on a local database context on this adapter in the constructor of such a class.

As a prerequisite you need to install the cordova plugin as explained here: cordova-sqlite-storage

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected connectionInfo

connectionInfo: DbConnectionInfo

Methods

addCollection

  • addCollection(name: string): Promise<void>

  • Add a new collection with the given name if it doesn't exist.

    Returns a promise that is fulfilled if the operation succeeded. The promise is rejected if an error occurred.

    Parameters

    • name: string

    Returns Promise<void>

addStore

  • addStore(name: string): Promise<any>

aggregateObjects

  • Aggregates values of the given object property in the collection for objects which match the given filter. Depending on the aggregation operator specified either numeric or boolean values are yielded. The value type of the given object property must match the aggregation operator specified.

    If the filter is empty or not specified all objects are considered for aggregation. If the filter matches no objects at all the aggregated value returned is undefined. Returns a promise that if fulfilled yields the aggregated value of matching object properties. The promise is rejected if an error occurred.

    The object property to be applied for aggregation is specified either in dot notation or array notation. In dot notation, the name of the object property is specified as a string (e.g. "volume"). It may include dots (.) to access nested properties of subobjects (e.g. "message.size"). If a single property name contains dots itself, you obviously cannot use dot notation. Instead, specify the property or nested properties as an array of strings (e.g. ["property.with.dots", "subproperty.with.dots"]).

    Parameters

    Returns Promise<number | boolean>

Protected asIdent

  • asIdent(text: any): string

Protected asLiteral

  • asLiteral(text: any): string

callExtension

  • callExtension(name: string, ...params: any[]): Promise<any>

  • Invoke the extension method by the given name and returns the result as a promise. Returns a rejected promise if the extension method doesn't exist or throws an error.

    Parameters

    • name: string

      name of registered extension method

    • Rest ...params: any[]

      parameters to be applied to extension method

    Returns Promise<any>

clearCollection

  • clearCollection(name: string): Promise<void>

  • Clear all objects from the collection with the given name.

    Returns a promise that is fulfilled if the operation succeeded. The promise is rejected if an error occurred.

    Parameters

    • name: string

    Returns Promise<void>

clearValues

  • clearValues(store?: string): Promise<any>

close

  • close(): Promise<any>

  • Closes the local database. By closing, any file locks on the database file are removed. The database is reopened again when operations are invoked after the database has been closed.

    Returns a promise that is fulfilled if the close operation succeeded. The promise is rejected if an error occurred.

    Returns Promise<any>

countObjects

  • countObjects(collectionName: string, filter?: DbObjectFilter): Promise<number>

  • Counts objects in the collection which match the given filter. If the filter is empty or not specified counts the total number of objects in the collection. Returns a promise that if fulfilled yields the number of matching objects. The promise is rejected if an error occurred.

    Parameters

    Returns Promise<number>

deleteDatabase

  • deleteDatabase(): Promise<void>

deleteObjects

  • deleteObjects(collectionName: string, filter?: DbObjectFilter): Promise<number>

  • Deletes objects from the collection which match the given filter. If the filter is empty or not specified all objects in the collection are deleted. Returns a promise that if fulfilled yields the number of objects deleted. The promise is rejected if an error occurred. In this case it is guaranteed that none of the requested objects has been deleted.

    Parameters

    Returns Promise<number>

deleteObjectsById

  • deleteObjectsById(collectionName: string, objectIds: string | string[]): Promise<string[]>

  • Deletes an object or multiple objects with the given object IDs from the collection. Objects which are not contained in the collection are ignored. Returns a promise that if fulfilled yields an array of object IDs of deleted objects. The promise is rejected if an error occurred. In this case it is guaranteed that none of the requested objects has been deleted.

    Parameters

    • collectionName: string
    • objectIds: string | string[]

    Returns Promise<string[]>

deleteValue

  • deleteValue(key: string, store?: string): Promise<any>

findObjectById

  • findObjectById<T>(collectionName: string, id: string, isExternalId?: boolean): Promise<T>

  • Finds the first object with the given object ID or external ID in the collection. Returns a promise that if fulfilled yields the first found object or undefined if no object with the given ID is contained in the collection. The promise is rejected if an error occurred.

    If the isExternalId parameter is not specified, the given id is interpreted as object ID.

    Type parameters

    Parameters

    • collectionName: string
    • id: string
    • isExternalId: boolean = false

    Returns Promise<T>

findObjects

  • Finds objects in the collection which match the given object filter. If the filter is empty or not specified all objects in the collection are retrieved.

    Optional join conditions can be specified to augment result objects by resolving object references to related objects and storing them as extra properties.

    The result can be iterated one by one or in batches to avoid memory overrun when the result contains a large number of objects.

    Returns a promise that if fulfilled yields an iterator for iterating the resulting objects. The promise is rejected if an error occurred.

    Type parameters

    Parameters

    Returns Promise<IQueryIterator<T>>

Protected getKvQuery

  • getKvQuery(op: "GET" | "GETV" | "SET" | "DELETE" | "CLEAR", store: string, key?: string, value?: any): SqlQueryBuilder

Protected getSqlQuery

Protected getStoreQuery

getValue

  • getValue(key: string, store?: string): Promise<any>

  • Gets the value for the given key in the default store or the store specified.

    Returns a promise that if fulfilled yields the value for the key. If the given key doesn't exist, the promise yields undefined. The promise is rejected if an error occurred.

    Parameters

    • key: string
    • Optional store: string

    Returns Promise<any>

getValues

  • getValues(store?: string): Promise<any>

insertObjects

  • insertObjects(collectionName: string, objects: CoatyObject | CoatyObject[], shouldReplaceExisting?: boolean): Promise<string[]>

  • Inserts a single object or multiple objects into the specified collection. If an object with the same object ID is already contained in the collection, the object to be inserted can be skipped or can replace the existing one, depending on the shouldReplaceExisting option (defaults to true).

    If no error occurs a fullfilled promise is returned that yields an array of object IDs of inserted or replaced objects. Otherwise, a rejected promise is returned. In this case, it is guaranteed that none of the specified objects has been inserted into the collection.

    Parameters

    Returns Promise<string[]>

iquery

  • Execute an SQL query defined by the given query builder and retrieve the results iteratively.

    Use the predefined query builder functions SQL or RAW to formulate your parameterized SQL query.

    The result can be iterated one by one or in batches to avoid memory overrun when the result contains a large number of rows. Usually, this is implemented by using a cursor. The fetch size of the cursor can be adjusted in the specified query options.

    Returns a promise that if fulfilled yields an iterator for iterating the resulting row data. The promise is rejected if an error occurs.

    If you know that a query only returns a very limited number of rows, it might be more convenient to use the query operation to retrieve all rows at once.

    Note that the iquery operation might not be supported by a specific database adapter. In this case, the returned promise yields an "operation not supported" error.

    Parameters

    Returns Promise<IQueryIterator<any>>

query

  • Execute an SQL query defined by the given query builder and retrieve the results as one set of row data.

    Use the predefined query builder functions SQL or RAW to formulate your parameterized SQL query.

    Returns a promise that if fulfilled yields all the query results as one set of row data. The promise is rejected if the query yields an error.

    Note that the query first retrieves all result rows and stores them in memory. For queries that have potentially large result sets, consider to use the iquery operation instead of this one.

    Parameters

    Returns Promise<SqlQueryResultSet>

Protected registerExtension

  • registerExtension(extensionName: string): void

Protected rejectNotSupported

  • rejectNotSupported(operationName: string): Promise<any>

removeCollection

  • removeCollection(name: string): Promise<void>

  • Remove the collection with the given name if it exists.

    Returns a promise that is fulfilled if the operation succeeded. The promise is rejected if an error occurred.

    Parameters

    • name: string

    Returns Promise<void>

removeStore

  • removeStore(name: string): Promise<any>

setValue

  • setValue(key: string, value: any, store?: string): Promise<any>

  • Sets the value for the given key in the default store or the store specified.

    You can pass in any JavaScript object that can be represented in JSON format.

    Returns a promise that is fulfilled if the set operation succeeded. The promise is rejected if an error occurred.

    Parameters

    • key: string
    • value: any
    • Optional store: string

    Returns Promise<any>

transaction

  • transaction(action: (transactionContext: DbLocalContext) => Promise<any>): Promise<any>

  • Execute async operations in the given action callback inside a database transaction block. The action callback must return a promise that is fulfilled if all operations have executed without errors, and that is rejected if any of the operations fail. All transactional operations must be invoked on the transaction context passed in the action callback.

    Returns a promise that if fulfilled signals that the transaction has been committed. In this case, the promise resolves to the value of the resolved action callback. The promise is rejected if the transaction is rolled back because the action callback's returned promise has been rejected.

    Parameters

    Returns Promise<any>

updateObjectProperty

  • updateObjectProperty(collectionName: string, objectIds: string | string[], property: string, value: any, shouldCreateMissing?: boolean): Promise<any>

  • Updates or deletes the property value of a single object or multiple objects with the given object IDs in the specified collection. Objects which are not contained in the collection are ignored. The shouldCreateMissing parameter controls whether the property value pair is added to an object if the property does not exist (defaults to true). Specify an undefined value to delete the property value pair from the object(s).

    Returns a promise that is resolved if the update is successful. The promise is rejected if an error occurred. In this case it is guaranteed that none of the objects has been updated.

    Parameters

    • collectionName: string
    • objectIds: string | string[]
    • property: string
    • value: any
    • Optional shouldCreateMissing: boolean

    Returns Promise<any>

updateObjects

  • Updates a single object or multiple objects on the specified collection. If an object with the same object ID is not contained in the collection, this object is ignored.

    Returns a promise that if fulfilled yields an array of object IDs of updated objects. The promise is rejected if an error occurred. In this case it is guaranteed that none of the objects has been updated.

    Parameters

    Returns Promise<string[]>

Generated using TypeDoc