Combineable — Documentation by YARD 0.9.37 (original) (raw)
Module: Mongo::BulkWrite::CombineablePrivate
Overview
This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.
Defines behavior around combiners
Instance Attribute Summary collapse
- #requests ⇒ Array<Hash, BSON::Document> readonly private
Requests The provided requests.
Instance Method Summarycollapse
- #has_array_filters? ⇒ Boolean private
Whether one or more operation specifies the array_filters option. - #has_collation? ⇒ Boolean private
Whether one or more operation specifies the collation option. - #has_hint? ⇒ Boolean private
Whether one or more operation specifies the hint option. - #initialize(requests) ⇒ Object private
Create the ordered combiner.
Instance Attribute Details
#requests ⇒ Array<Hash, BSON::Document>
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns requests The provided requests.
| 29 30 31 | # File 'lib/mongo/bulk_write/combineable.rb', line 29 def requests @requests end |
|---|
Instance Method Details
#has_array_filters? ⇒ Boolean
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns Whether one or more operation specifies the array_filters option.
| 56 57 58 | # File 'lib/mongo/bulk_write/combineable.rb', line 56 def has_array_filters? @has_array_filters end |
|---|
#has_collation? ⇒ Boolean
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns Whether one or more operation specifies the collation option.
| 50 51 52 | # File 'lib/mongo/bulk_write/combineable.rb', line 50 def has_collation? @has_collation end |
|---|
#has_hint? ⇒ Boolean
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns Whether one or more operation specifies the hint option.
| 62 63 64 | # File 'lib/mongo/bulk_write/combineable.rb', line 62 def has_hint? @has_hint end |
|---|
#initialize(requests) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Create the ordered combiner.
| 41 42 43 44 45 46 | # File 'lib/mongo/bulk_write/combineable.rb', line 41 def initialize(requests) @requests = requests @has_collation = false @has_array_filters = false @has_hint = false end |
|---|