Class: Cuprum::Collections::Basic::Commands::FindMatching
- Inherits:
-
Cuprum::Collections::Basic::Command
- Object
- Cuprum::Command
- Command
- Cuprum::Collections::Basic::Command
- Cuprum::Collections::Basic::Commands::FindMatching
- Includes:
- Commands::AbstractFindMatching
- Defined in:
- lib/cuprum/collections/basic/commands/find_matching.rb
Overview
Command for querying filtered, ordered data from a basic collection.
Instance Attribute Summary
Attributes inherited from Cuprum::Collections::Basic::Command
#collection_name, #data, #default_contract, #member_name, #options, #primary_key_name, #primary_key_type
Instance Method Summary collapse
-
#call(envelope: false, limit: nil, offset: nil, order: nil, scope: nil, where: nil) { ... } ⇒ Object
Queries the collection for items matching the given conditions.
Methods inherited from Cuprum::Collections::Basic::Command
Constructor Details
This class inherits a constructor from Cuprum::Collections::Basic::Command
Instance Method Details
#call(limit: nil, offset: nil, order: nil, &block) ⇒ Cuprum::Result<Enumerator> #call(limit: nil, offset: nil, order: nil, &block) ⇒ Cuprum::Result<Hash{String, Array<Hash{String, Object}>}>
Queries the collection for items matching the given conditions.
105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/cuprum/collections/basic/commands/find_matching.rb', line 105 validate_parameters :call do keyword :envelope, Stannum::Constraints::Boolean.new, default: true keyword :limit, Integer, optional: true keyword :offset, Integer, optional: true keyword :order, Cuprum::Collections::Constraints::Ordering.new, optional: true keyword :scope, Cuprum::Collections::Basic::Query, optional: true keyword :where, Object, optional: true end |