Query

public class Query<E: EntityInspectable & __EntityRelatable>: CustomDebugStringConvertible
where E == E.EntityBindingType.EntityType

Undocumented

  • The entity type this query is going to target.

    Declaration

    Swift

    public typealias EntityType = E
  • Find all objects matching the query between the given offset and limit.

    Declaration

    Swift

    public func find(offset: UInt64 = 0, limit: UInt64 = 0) throws -> [EntityType]

    Parameters

    offset

    How many results to skip. (Useful when paginating results.)

    limit

    Maximum number of objects that may be returned (may give fewer).

    Return Value

    Collection of objects matching the query conditions.

  • Undocumented

    Declaration

    Swift

    public func findContiguous(offset: UInt64 = 0, limit: UInt64 = 0) throws -> ContiguousArray<EntityType>
  • Find all object IDs matching the query between the given offset and limit.

    Declaration

    Swift

    public func findIds(offset: UInt64 = 0, limit: UInt64 = 0) throws -> [EntityId<EntityType>]

    Parameters

    offset

    How many results to skip. (Useful when paginating results.)

    limit

    Maximum number of results that may be returned (may give fewer).

    Return Value

    Collection of object IDs matching the query conditions.

  • Delete all objects matching the query.

    Declaration

    Swift

    @discardableResult
    public func remove() throws -> UInt64

    Return Value

    Number of objects deleted.

  • Find the first Object matching the query.

    Declaration

    Swift

    public func findFirst() throws -> EntityType?
  • Find the single object matching the query (the result must be unique).

    Throws

    ObjectBoxError.nonUniqueResult when there is more than one match

    Declaration

    Swift

    public func findUnique() throws -> EntityType?

    Return Value

    The one and only object matching the query conditions, or nil if the query did not match anything.

  • The number of objects matching the query.

    Declaration

    Swift

    public func count() throws -> Int
  • Accessor to get a PropertyQuery object based on the query conditions.

    You use Query to get objects, PropertyQuery to get aggregate results for entity properties. For example, for an Int property, you can get the average, sum, min, and max, among other things.

    Declaration

    Swift

    public func property<T>(_ property: Property<EntityType, T, Void>) -> PropertyQuery<EntityType, T>
        where T: EntityPropertyTypeConvertible

    Parameters

    property

    Object property to modify the query for.

    Return Value

    New PropertyQuery to configure.

  • Undocumented

    Declaration

    Swift

    public func property<T>(_ property: Property<EntityType, T?, Void>) -> PropertyQuery<EntityType, T>
            where T: EntityPropertyTypeConvertible
  • Allows having a PropertyQuery for Date properties via their Int64 unix timestamps

    Declaration

    Swift

    public func propertyInt64(_ property: Property<EntityType, Date, Void>) -> PropertyQuery<EntityType, Int64>
  • Allows having a PropertyQuery for Date properties via their Int64 unix timestamps

    Declaration

    Swift

    public func propertyInt64(_ property: Property<EntityType, Date?, Void>) -> PropertyQuery<EntityType, Int64>
  • Sets a parameter previously specified using a ParameterAlias to a new value.

    This is the binary operator variant. See setParameters(alias:to:_:) for operators with 2 values.

    Declaration

    Swift

    public func setParameter(_ alias: String, to string: String)

    Parameters

    alias

    Condition’s alias.

    string

    New value.

  • Sets a parameter previously specified during query construction to a new collection value.

    This is used to change the value of e.g. isContained(in:) and similar operations.

    Declaration

    Swift

    public func setParameters(_ alias: String, to collection: [String])

    Parameters

    alias

    Condition’s alias.

    collection

    New collection of values for the condition.

  • Return a Combine publisher for this query that you can subscribe to.

    Declaration

    Swift

    public var publisher: QueryPublisher<EntityType> { get }
  • Receive a callback whenever an entity in this query is added/removed or modified. This method takes no parameters and is intended for the case where you do not want to display the objects, but want to for example run a property query or count the entities in the query without retrieving their data.

    Important

    There may be spurious calls to your callback when your query results haven’t actually changed, but something else in this box has.

    See also

    Query.subscribe(dispatchQueue:,resultHandler:)

    Declaration

    Swift

    public func subscribe(dispatchQueue: DispatchQueue = DispatchQueue.main,
                          flags: Observer.Flags = [.sendInitial],
                          changeHandler: @escaping () -> Void) -> Observer

    Parameters

    dispatchQueue

    The dispatch queue on which you want your callback to be called.

    flags

    Flags to control behavior of the subscription

    changeHandler

    A closure to be called when a change occurs.

    Return Value

    An object representing your observer connection. As long as the Observer object exists, your callback will be called. If you no longer want to receive callbacks, let go of your reference to this object so it is deinited.

  • Receive a callback whenever an entity in this query is added/removed or modified. The callback receives the query result as a parameter, allowing you to e.g. feed it to Combine or an Rx subscriber.

    Important

    There may be spurious calls to your callback when your query results haven’t actually changed, but something else in this box has.

    See also

    Query.subscribe(dispatchQueue:,changeHandler:)

    Declaration

    Swift

    public func subscribe(dispatchQueue: DispatchQueue = DispatchQueue.main,
                          flags: Observer.Flags = [.sendInitial],
                          resultHandler: @escaping ([EntityType], ObjectBoxError?) -> Void) -> Observer

    Parameters

    dispatchQueue

    The dispatch queue on which you want your callback to be called.

    flags

    Flags to control behavior of the subscription

    resultHandler

    A closure that will be passed an array of the objects in this query whenever the query contents change.

    Return Value

    An object representing your observer connection. As long as the Observer object exists, your callback will be called. If you no longer want to receive callbacks, let go of your reference to this object so it is deinited.

  • Variant of subscribe() that is faster due to using ContiguousArray.

    Declaration

    Swift

    public func subscribeContiguous(dispatchQueue: DispatchQueue = DispatchQueue.main,
                                    flags: Observer.Flags = [.sendInitial],
                                    resultHandler:
        @escaping (ContiguousArray<EntityType>, ObjectBoxError?) -> Void) -> Observer
  • Sets a parameter of a condition previously specified during query construction to a new value.

    This is the variant for conditions taking single parameter e.g. isEqual/== or isGreaterThan/>.

    See setParameters(_:to:_:) for operators with 2 values.

    If you have multiple conditions on the same property, specify a PropertyAlias so you can choose which condition’s value to change.

    Declaration

    Swift

    public func setParameter<T>(_ property: Property<EntityType, T, Void>, to value: T) where T : EntityPropertyTypeConvertible, T : FixedWidthInteger

    Parameters

    property

    Entity property specification.

    value

    New value for the condition.

  • Sets a parameter previously specified using a ParameterAlias to a new value.

    This is the binary operator variant. See setParameters(_:to:_:) for operators with 2 values.

    Declaration

    Swift

    public func setParameter<T>(_ alias: String, to value: T) where T : FixedWidthInteger

    Parameters

    alias

    Condition’s alias.

    value

    New value.

  • Sets a parameter of a condition previously specified during query construction to new values.

    This is the variant with 2 values, e.g. for isBetween(_:and:) comparison.

    See setParameter(_:to:) for operators with 1 value.

    If you have multiple conditions on the same property, specify a PropertyAlias so you can choose which condition’s value to change.

    Declaration

    Swift

    public func setParameters<T>(_ property: Property<EntityType, T, Void>, to value1: T, _ value2: T)
            where T: FixedWidthInteger

    Parameters

    property

    Entity property specification.

    value1

    New first value for the condition.

    value2

    New second value for the condition.

  • Sets a parameter previously specified using a ParameterAlias to new values.

    This is the variant with 2 values, e.g. for isBetween(_:and:) comparison. See setParameter(_:to:) for operators with 1 value.

    Declaration

    Swift

    public func setParameters<T>(_ alias: String, to value1: T, _ value2: T) where T : FixedWidthInteger

    Parameters

    alias

    Condition’s alias.

    value1

    New first value for the condition.

    value2

    New second value for the condition.

  • Sets a parameter previously specified using a ParameterAlias to a new collection value.

    This is used to change the value of e.g. isContained(in:) and similar operations.

    If you have multiple conditions on the same property, specify a PropertyAlias so you can choose which condition’s value to change.

    Declaration

    Swift

    public func setParameters<T>(_ property: Property<EntityType, T, Void>, to collection: [T])
            where T: FixedWidthInteger

    Parameters

    property

    Entity property specification.

    collection

    New collection of values for the condition.

  • Sets a parameter previously specified during query construction to a new collection value.

    This is used to change the value of e.g. isContained(in:) and similar operations.

    Declaration

    Swift

    public func setParameters<T>(_ alias: String, to collection: [T]) where T : FixedWidthInteger

    Parameters

    alias

    Condition’s alias.

    collection

    New collection of values for the condition.

  • Sets a parameter of a condition previously specified during query construction to a new value.

    This is the variant for conditions taking single parameter e.g. isEqual/==.

    If you have multiple conditions on the same property, specify a PropertyAlias so you can choose which condition’s value to change.

    Declaration

    Swift

    public func setParameter(_ property: Property<EntityType, Bool, Void>, to value: Bool)

    Parameters

    property

    Entity property specification.

    value

    New value for the condition.

  • Sets a parameter previously specified using a ParameterAlias to a new value.

    Declaration

    Swift

    public func setParameter(_ alias: String, to value: Bool)

    Parameters

    alias

    Condition’s alias.

    value

    New value.

  • Sets a parameter of a condition previously specified during query construction to a new value.

    This is the variant for conditions taking single parameter e.g. isEqual/== or isGreaterThan/>

    See setParameters(_:to:_:) for operators with 2 values.

    If you have multiple conditions on the same property, specify a PropertyAlias so you can choose which condition’s value to change.

    Declaration

    Swift

    public func setParameter<T>(_ property: Property<EntityType, T, Void>, to value: T) where T : EntityPropertyTypeConvertible, T : BinaryFloatingPoint

    Parameters

    property

    Entity property specification.

    value

    New value for the condition.

  • Convenience for setParameters(property:to:_:) that offers the same API as a floating point equality condition with a tolerance.

    If you have multiple conditions on the same property, specify a PropertyAlias so you can choose which condition’s value to change and use `setParameter(_:toEqual:tolerance:).

    Declaration

    Swift

    public func setParameter<T>(_ property: Property<EntityType, T, Void>, toEqual value: T, tolerance: T)
            where T: BinaryFloatingPoint

    Parameters

    property

    Entity property specification.

    value

    Value to compare, ± tolerance.

    tolerance

    Tolerance around value.

  • Convenience for setParameters(_:to:_:) that offers the same API as a floating point equality condition with a tolerance.

    Declaration

    Swift

    public func setParameters<T>(_ alias: String, toEqual value: T, tolerance: T) where T : BinaryFloatingPoint

    Parameters

    alias

    Condition’s alias.

    value

    Value to compare, ± tolerance.

    tolerance

    Tolerance around value.

  • Sets a parameter of a condition previously specified during query construction to new values.

    This is the variant with 2 values, e.g. for isBetween(_:and:) comparison.

    See setParameter(_:to:) for operators with 1 value.

    If you have multiple conditions on the same property, specify a PropertyAlias so you can choose which condition’s value to change.

    Declaration

    Swift

    public func setParameters<T>(_ property: Property<EntityType, T, Void>, to value1: T, _ value2: T)
            where T: BinaryFloatingPoint

    Parameters

    property

    Entity property specification.

    value1

    New first value for the condition.

    value2

    New second value for the condition.

  • Sets a parameter of a condition previously specified during query construction to a new value.

    This is the variant for conditions taking single parameter e.g. isEqual/== or isGreaterThan/>

    See setParameters(_:to:_:) for operators with 2 values.

    If you have multiple conditions on the same property, specify a PropertyAlias so you can choose which condition’s value to change.

    Declaration

    Swift

    public func setParameter(_ property: Property<EntityType, String, Void>, to string: String)

    Parameters

    property

    Entity property specification.

    value

    New value for the condition.

  • Sets a parameter previously specified using a ParameterAlias to a new collection value.

    This is used to change the value of e.g. isContained(in:) and similar operations.

    If you have multiple conditions on the same property, specify a PropertyAlias so you can choose which condition’s value to change.

    Declaration

    Swift

    public func setParameters(_ property: Property<EntityType, String, Void>, to collection: [String])

    Parameters

    property

    Entity property specification.

    collection

    New collection of values for the condition.

  • Sets a parameter of a condition previously specified during query construction to a new value.

    This is the variant for conditions taking single parameter e.g. isEqual/== or isGreaterThan/>

    See setParameters(_:to:_:) for operators with 2 values.

    If you have multiple conditions on the same property, specify a PropertyAlias so you can choose which condition’s value to change.

    Declaration

    Swift

    public func setParameter(_ property: Property<EntityType, Date, Void>, to value: Date)

    Parameters

    property

    Entity property specification.

    value

    New value for the condition.

  • Sets a parameter of a condition previously specified during query construction to a new value.

    This is the variant for conditions taking single parameter e.g. isEqual/== or isGreaterThan/>

    See setParameters(_:to:_:) for operators with 2 values.

    If you have multiple conditions on the same property, specify a PropertyAlias so you can choose which condition’s value to change.

    Declaration

    Swift

    public func setParameter(_ alias: String, to value: Date)

    Parameters

    alias

    Condition’s alias.

    value

    New value for the condition.

  • Sets a parameter previously specified using a ParameterAlias to a new collection value.

    This is used to change the value of e.g. isContained(in:) and similar operations.

    If you have multiple conditions on the same property, specify a PropertyAlias so you can choose which condition’s value to change.

    Declaration

    Swift

    public func setParameters(_ property: Property<EntityType, Date, Void>, to collection: [Date])

    Parameters

    property

    Entity property specification.

    collection

    New collection of values for the condition.

  • Sets a parameter of a condition previously specified during query construction to new values.

    This is the variant with 2 values, e.g. for isBetween(_:and:) comparison.

    See setParameter(_:to:) for operators with 1 value.

    If you have multiple conditions on the same property, specify a PropertyAlias so you can choose which condition’s value to change.

    Declaration

    Swift

    public func setParameters(_ property: Property<EntityType, Date, Void>, to value1: Date, _ value2: Date)

    Parameters

    property

    Entity property specification.

    value1

    New first value for the condition.

    value2

    New second value for the condition.

  • Sets a parameter of a condition previously specified during query construction to a new value.

    If you have multiple conditions on the same property, specify a PropertyAlias so you can choose which condition’s value to change.

    Declaration

    Swift

    public func setParameter(_ property: Property<EntityType, Data, Void>, to value: Data)

    Parameters

    property

    Entity property specification.

    value

    New value for the condition.

  • Sets a parameter of a condition previously specified during query construction to a new value.

    If you have multiple conditions on the same property, specify a PropertyAlias so you can choose which condition’s value to change.

    Declaration

    Swift

    public func setParameter(_ alias: String, to value: Data)

    Parameters

    alias

    Condition’s alias.

    value

    New value for the condition.