RLMFindOptions

Objective-C

@interface RLMFindOptions : NSObject

Swift

@_nonSendable(_assumed) class RLMFindOptions : NSObject

Options to use when executing a find command on a RLMMongoCollection.

Show on GitHub

  • The maximum number of documents to return. Specifying 0 will return all documents.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger limit;

    Swift

    var limit: Int { get set }
    Show on GitHub

  • Limits the fields to return for all matching documents.

    Declaration

    Objective-C

    @property (nonatomic, nullable) id<RLMBSON> projection;
    Show on GitHub

  • Deprecated

    Use sorting instead, which correctly sort more than one sort attribute

    The order in which to return matching documents.

    Declaration

    Objective-C

    @property (nonatomic, nullable) id<RLMBSON> sort;
    Show on GitHub

  • The order in which to return matching documents.

    Declaration

    Objective-C

    @property (nonatomic) NS_REFINED_FOR_SWIFT NSArray<id<RLMBSON>> *sorting;
    Show on GitHub

  • Deprecated

    Please use initWithLimit:projection:sorting:

    Options to use when executing a find command on a RLMMongoCollection.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithLimit:(NSInteger)limit
                           projection:(id<RLMBSON> _Nullable)projection
                                 sort:(id<RLMBSON> _Nullable)sort;

    Parameters

    limit

    The maximum number of documents to return. Specifying 0 will return all documents.
    projection

    Limits the fields to return for all matching documents.
    sort

    The order in which to return matching documents.
    Show on GitHub

  • Deprecated

    Please use initWithProjection:sorting:

    Options to use when executing a find command on a RLMMongoCollection.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithProjection:(id<RLMBSON> _Nullable)projection
                                      sort:(id<RLMBSON> _Nullable)sort;

    Parameters

    projection

    Limits the fields to return for all matching documents.
    sort

    The order in which to return matching documents.
    Show on GitHub

  • Options to use when executing a find command on a RLMMongoCollection.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithLimit:(NSInteger)limit
                           projection:(id<RLMBSON> _Nullable)projection
                              sorting:(nonnull NSArray<id<RLMBSON>> *)sorting;

    Swift

    init(limit: Int, projection: (any RLMBSON)?, sorting: [any RLMBSON])

    Parameters

    limit

    The maximum number of documents to return. Specifying 0 will return all documents.
    projection

    Limits the fields to return for all matching documents.
    sorting

    The order in which to return matching documents.
    Show on GitHub

  • Options to use when executing a find command on a RLMMongoCollection.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithProjection:(id<RLMBSON> _Nullable)projection
                                   sorting:
                                       (nonnull NSArray<id<RLMBSON>> *)sorting;

    Swift

    init(projection: (any RLMBSON)?, sorting: [any RLMBSON])

    Parameters

    projection

    Limits the fields to return for all matching documents.
    sorting

    The order in which to return matching documents.
    Show on GitHub