DittoScopedWriteTransaction Class Reference


                    
                    
                    collectionName

The name of the collection that the scoped write transaction is scoped to.

Declaration

Swift

public var collectionName: DittoCollectionName { get }


                    
                    
                    upsert(_:writeStrategy:)

Inserts a new document into the collection and returns its ID. If the document already exists, the behavior is determined by the given writeStrategy.

Throws

DittoSwiftError.

Declaration

Swift

@discardableResult
public func upsert(
    _ content: [String: Any?],
    writeStrategy: DittoWriteStrategy = .merge
) throws -> DittoDocumentID

Parameters

`document`	The document to insert.
`writeStrategy`	Specifies the desired strategy for inserting a document. Defaults to `.merge`.

Return Value

The ID of the inserted document.


                    
                    
                    upsert(_:writeStrategy:)

Inserts a new document into the collection and returns its ID. If the document already exists, the behavior is determined by the given writeStrategy.

Throws

DittoSwiftError.

Declaration

Swift

@discardableResult
public func upsert<T: Codable>(
    _ content: T,
    writeStrategy: DittoWriteStrategy = .merge
) throws -> DittoDocumentID

Parameters

`document`	The document to insert.
`writeStrategy`	Specifies the desired strategy for inserting a document. The default value is `.merge`.

Return Value

The ID of the inserted document.


                    
                    
                    insert(_:withID:isDefault:)

Insert a document into the scoped collection.

Throws

DittoSwiftError.

Declaration

Swift

@available(*, deprecated, message: "use `upsert(﹚` instead")
@discardableResult
public func insert(
    _ content: [String: Any?],
    withID id: DittoDocumentID? = nil,
    isDefault: Bool = false
) throws -> DittoDocumentID

Parameters

`document`	The document to insert.
`id`	The ID to use for the document. If null then Ditto will automatically assign an ID.
`isDefault`	Represents whether or not the data being inserted should be treated as default data or not. Set this to `true` if you want to set a default value that you expect to be overwritten by other devices in the network. The default value is `false`.

Return Value

The ID of the inserted document.


                    
                    
                    insertWithStrategy(_:id:writeStrategy:)

Insert a document into the scoped collection.

Throws

DittoSwiftError.

Declaration

Swift

@available(*, deprecated, message: "use `upsert(﹚` instead")
@discardableResult
public func insertWithStrategy(
    _ content: [String: Any?],
    id: DittoDocumentID? = nil,
    writeStrategy: DittoWriteStrategy = .overwrite
) throws -> DittoDocumentID

Parameters

`document`	The document to insert.
`id`	The ID to use for the document. If null then Ditto will automatically assign an ID.
`writeStrategy`	Specifies the desired strategy for inserting a document. The default value is `.overwrite`.

Return Value

The ID of the inserted document.


                    
                    
                    insert(_:withID:isDefault:)

Insert a document into the scoped collection.

Throws

DittoSwiftError.

Declaration

Swift

@available(*, deprecated, message: "use `upsert(﹚` instead")
@discardableResult
public func insert<T: Codable>(
    _ content: T,
    withID id: DittoDocumentID? = nil,
    isDefault: Bool = false
) throws -> DittoDocumentID

Parameters

`document`	The document to insert.
`id`	The ID to use for the document. If null then Ditto will automatically assign an ID.
`isDefault`	Represents whether or not the data being inserted should be treated as default data or not. Set this to `true` if you want to set a default value that you expect to be overwritten by other devices in the network. The default value is `false`.

Return Value

The ID of the inserted document.


                    
                    
                    insertWithStrategy(_:id:writeStrategy:)

Insert a document into the scoped collection.

Throws

DittoSwiftError.

Declaration

Swift

@available(*, deprecated, message: "use `upsert(﹚` instead")
@discardableResult
public func insertWithStrategy<T: Codable>(
    _ content: T,
    id: DittoDocumentID? = nil,
    writeStrategy: DittoWriteStrategy = .overwrite
) throws -> DittoDocumentID

Parameters

`document`	The document to insert.
`id`	The ID to use for the document. If null then Ditto will automatically assign an ID.
`writeStrategy`	Specifies the desired strategy for inserting a document. The default value is `.overwrite`.

Return Value

The ID of the inserted document.


                    
                    
                    findByID(_:)

Generates a DittoWriteTransactionPendingIDSpecificOperation with the provided document ID that can be used to update, remove, or evict the document.

Throws

DittoSwiftError.

Declaration

Swift

public func findByID(_ id: DittoDocumentID) -> DittoWriteTransactionPendingIDSpecificOperation

Parameters

`id`	The ID of the document.

Return Value

A DittoWriteTransactionPendingIDSpecificOperation that you can chain function calls to update, remove, or evict the document.


                    
                    
                    findByID(_:)

Generates a DittoWriteTransactionPendingIDSpecificOperation with the provided document ID that can be used to update, remove, or evict the document.

Throws

DittoSwiftError.

Declaration

Swift

public func findByID(_ id: Any) -> DittoWriteTransactionPendingIDSpecificOperation

Parameters

`id`	The ID of the document.

Return Value

A DittoWriteTransactionPendingIDSpecificOperation that you can chain function calls to update, remove, or evict the document.


                    
                    
                    find(query:)

Generates a DittoWriteTransactionPendingCursorOperation with the provided query that can be used to update, remove, or evict documents.

Declaration

Swift

@available(*, deprecated, message: "use the version of `find` that doesn't require an argument label instead")
public func find(query: String) -> DittoWriteTransactionPendingCursorOperation

Parameters


                                query

The query to run against the collection.

Return Value

A DittoWriteTransactionPendingCursorOperation that you can use to chain further query-related function calls to update, remove, or evict the documents.


                    
                    
                    find(_:)

Generates a DittoWriteTransactionPendingCursorOperation with the provided query that can be used to update, remove, or evict documents.

Declaration

Swift

public func find(_ query: String) -> DittoWriteTransactionPendingCursorOperation

Parameters


                                query

The query to run against the collection.

Return Value

A DittoWriteTransactionPendingCursorOperation that you can use to chain further query-related function calls to update, remove, or evict the documents.


                    
                    
                    find(_:args:)

Generates a DittoWriteTransactionPendingCursorOperation with the provided query and query arguments that can be used to update, remove, or evict documents.

This is the recommended function to use when performing queries on a collection if you have any dynamic data included in the query string. It allows you to provide a query string with placeholders, in the form of $args.my_arg_name, along with an accompanying dictionary of arguments, in the form of { "my_arg_name": "some value" }, and the placeholders will be appropriately replaced by the matching provided arguments from the dictionary. This includes handling things like wrapping strings in quotation marks and arrays in square brackets, for example.

Declaration

Swift

public func find(_ query: String, args queryArgs: Dictionary<String, Any?>) -> DittoWriteTransactionPendingCursorOperation

Parameters

`query`	The query to run against the collection.
`queryArgs`	The arguments to use to replace placeholders in the provided query.

Return Value

A DittoWriteTransactionPendingCursorOperation that you can use to chain further query-related function calls to update, remove, or evict the documents.


                    
                    
                    findAll()

Generates a DittoWriteTransactionPendingCursorOperation that can be used to update, remove or evict documents.

Declaration

Swift

public func findAll() -> DittoWriteTransactionPendingCursorOperation

Return Value

A DittoWriteTransactionPendingCursorOperation that you can use to chain further query-related function calls to update, remove, or evict the documents.