DittoStore Class Reference
DittoStore
public class DittoStoreDittoStore provides access to DittoCollections and a write transaction API.
-
Returns a
DittoCollectionwith the provided name.Declaration
Swift
public subscript(collectionName: String) -> DittoCollection { get }Parameters
collectionNameThe name of the collection.
Return Value
-
Returns a
DittoCollectionwith the provided name.Declaration
Swift
public func collection(_ name: String) -> DittoCollectionParameters
nameThe name of the collection.
Return Value
-
Returns a list of the names of collections in the store.
Declaration
Swift
public func collectionNames() -> [String]Return Value
A list of collection names found in the store.
-
Returns an object that lets you fetch or observe the collections in the store.
Declaration
Swift
public func collections() -> DittoPendingCollectionsOperationReturn Value
An object that lets you fetch or observe the collections in the store.
-
Returns a hash representing the current version of the given queries. When a document matching such queries gets mutated, the hash will change as well.
Please note that the hash depends on how queries are constructed, so you should make sure to always compare hashes generated with the same set of queries.
Declaration
Swift
public func queriesHash(queries: [DittoLiveQuery]) -> UIntParameters
queriesA list of
DittoLiveQueryobjects that you want to get the hash for.Return Value
A hash representing the current version of the given queries.
-
Returns a sequence of English words representing the current version of the given queries. When a document matching such queries gets mutated, the words will change as well.
Please note that the resulting sequence of words depends on how queries are constructed, so you should make sure to always compare hashes generated with the same set of queries.
Declaration
Swift
public func queriesHashMnemonic(queries: [DittoLiveQuery]) -> StringParameters
queriesA list of
DittoLiveQueryobjects that you want to get the mnemonic hash for.Return Value
A string representing the current version of the given queries.
-
Allows you to group multiple operations together that affect multiple documents, potentially across multiple collections.
Declaration
Swift
@discardableResult public func write( _ block: @escaping (DittoWriteTransaction) -> Void ) -> [DittoWriteTransactionResult]Parameters
blockA closure that provides access to a write transaction object that can be used to perform operations on the store.
Return Value
A list of
DittoWriteTransactionResults. There is a result for each operation performed as part of the write transaction.