Sha256: b471b9eda043f01761bdf84a75eeea108e413cfe2eff3ca81d4b0e9efa89cfe6
Contents?: true
Size: 1.33 KB
Versions: 14
Compression:
Stored size: 1.33 KB
Contents
# Copyright (C) 2014-2015 MongoDB, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
module Mongo
class Collection
class View
# Defines explain related behaviour for collection view.
#
# @since 2.0.0
module Explainable
# Get the explain plan for the query.
#
# @example Get the explain plan for the query.
# view.explain
#
# @return [ Hash ] A single document with the explain plan.
#
# @since 2.0.0
def explain
self.class.new(collection, selector, options.merge(explain_options)).first
end
private
def explained?
!!options[:explain]
end
def explain_options
explain_limit = limit || 0
{ :limit => -explain_limit.abs, :explain => true }
end
end
end
end
end
Version data entries
14 entries across 14 versions & 1 rubygems