QueryCache — Documentation by YARD 0.9.37 (original) (raw)

Module: Mongo::QueryCache

Defined in:

lib/mongo/query_cache.rb

Defined Under Namespace

Classes: Middleware

Class Method Summarycollapse

• .cache ⇒ Object
  Execute the block while using the query cache.
• .clear ⇒ nil
  Clear the query cache.
• .clear_namespace(namespace) ⇒ nil private
  Clear the section of the query cache storing cursors with results from this namespace.
• .enabled=(value) ⇒ Object
  Set whether the cache is enabled.
• .enabled? ⇒ true, false
  Is the query cache enabled on the current thread?.
• .get(**opts) ⇒ Mongo::CachingCursor | nil private
  For the given query options, retrieve a cached cursor that can be used to obtain the correct query results, if one exists in the cache.
• .normalized_limit(limit) ⇒ Object
• .set(cursor, **opts) ⇒ true private
  Store a CachingCursor instance in the query cache associated with the specified query options.
• .uncached ⇒ Object
  Execute the block with the query cache disabled.

Class Method Details

.cache ⇒ Object

Execute the block while using the query cache.

.clear ⇒ nil

.clear_namespace(namespace) ⇒ nil

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.

Clear the section of the query cache storing cursors with results from this namespace.

.enabled=(value) ⇒ Object

Set whether the cache is enabled.

.enabled? ⇒ true, false

Is the query cache enabled on the current thread?

.get(**opts) ⇒ Mongo::CachingCursor | nil

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.

For the given query options, retrieve a cached cursor that can be used to obtain the correct query results, if one exists in the cache.

| 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 | # File 'lib/mongo/query_cache.rb', line 181 def get(**opts) limit = normalized_limit(opts[:limit]) _namespace_key = namespace_key(**opts) _cache_key = cache_key(**opts) namespace_hash = cache_table[_namespace_key] return nil unless namespace_hash caching_cursor = namespace_hash[_cache_key] return nil unless caching_cursor caching_cursor_limit = normalized_limit(caching_cursor.view.limit) if limit && (caching_cursor_limit.nil? || caching_cursor_limit >= limit) caching_cursor elsif limit.nil? && caching_cursor_limit.nil? caching_cursor else nil end end | | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

.normalized_limit(limit) ⇒ Object

.set(cursor, **opts) ⇒ true

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.

Store a CachingCursor instance in the query cache associated with the specified query options.

| 142 143 144 145 146 147 148 149 150 | # File 'lib/mongo/query_cache.rb', line 142 def set(cursor, **opts) _cache_key = cache_key(**opts) _namespace_key = namespace_key(**opts) cache_table[_namespace_key] ||= {} cache_table[_namespace_key][_cache_key] = cursor true end | | ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

.uncached ⇒ Object

Execute the block with the query cache disabled.