Module: Mongoid::Threaded

Extended by:
Threaded
Included in:
Threaded
Defined in:
lib/mongoid/threaded.rb,
lib/mongoid/threaded/lifecycle.rb

Overview

This module contains logic for easy access to objects that have a lifecycle on the current thread.

Defined Under Namespace

Modules: Lifecycle

Instance Method Summary collapse

Instance Method Details

#autosaved?(document) ⇒ true, false

Is the document autosaved on the current thread?

Examples:

Is the document autosaved?

Threaded.autosaved?(doc)

Parameters:

  • document (Document) —

    The document to check.

Returns:

  • (true, false) —

    If the document is autosaved.

Since:

  • 2.1.9



409
410
411
 
# File 'lib/mongoid/threaded.rb', line 409

def autosaved?(document)
  autosaves_for(document.class).include?(document.id)
end

#autosaves ⇒ Hash

Get all autosaves on the current thread.

Examples:

Get all autosaves.

Threaded.autosaves

Returns:

  • (Hash) —

    The current autosaves.

Since:

  • 3.0.0



435
436
437
 
# File 'lib/mongoid/threaded.rb', line 435

def autosaves
  Thread.current["[mongoid]:autosaves"] ||= {}
end

#autosaves_for(klass) ⇒ Array

Get all autosaves on the current thread for the class.

Examples:

Get all autosaves.

Threaded.autosaves_for(Person)

Parameters:

  • The (Class) —

    class to check.

Returns:

  • (Array) —

    The current autosaves.

Since:

  • 3.0.0



461
462
463
 
# File 'lib/mongoid/threaded.rb', line 461

def autosaves_for(klass)
  autosaves[klass] ||= []
end

#begin(name) ⇒ true

Begin entry into a named thread local stack.

Examples:

Begin entry into the stack.

Threaded.begin(:create)

Parameters:

  • name (String) —

    The name of the stack

Returns:

  • (true) —

    True.

Since:

  • 2.4.0



21
22
23
 
# File 'lib/mongoid/threaded.rb', line 21

def begin(name)
  stack(name).push(true)
end

#begin_autosave(document) ⇒ Object

Begin autosaving a document on the current thread.

Examples:

Begin autosave.

Threaded.begin_autosave(doc)

Parameters:

  • document (Document) —

    The document to autosave.

Since:

  • 3.0.0



113
114
115
 
# File 'lib/mongoid/threaded.rb', line 113

def begin_autosave(document)
  autosaves_for(document.class).push(document.id)
end

#begin_validate(document) ⇒ Object

Begin validating a document on the current thread.

Examples:

Begin validation.

Threaded.begin_validate(doc)

Parameters:

  • document (Document) —

    The document to validate.

Since:

  • 2.1.9



125
126
127
 
# File 'lib/mongoid/threaded.rb', line 125

def begin_validate(document)
  validations_for(document.class).push(document.id)
end

#clear_options! ⇒ Object

Clear out all options set on a one-time basis.

Examples:

Clear out the options.

Threaded.clear_options!

Since:

  • 2.3.0



150
151
152
 
# File 'lib/mongoid/threaded.rb', line 150

def clear_options!
  self.timeless = false
end

#clear_persistence_options(klass) ⇒ true

Clear out all the persistence options.

Examples:

Clear out the persistence options.

Threaded.clear_persistence_options(Band)

Parameters:

  • klass (Class) —

    The model class.

Returns:

  • (true) —

    true.

Since:

  • 2.0.0



139
140
141
142
 
# File 'lib/mongoid/threaded.rb', line 139

def clear_persistence_options(klass)
  Thread.current["[mongoid][#{klass}]:persistence-options"] = nil
  true
end

#database_override ⇒ String, Symbol

Get the global database override.

Examples:

Get the global database override.

Threaded.database_override

Returns:

  • (String, Symbol) —

    The override.

Since:

  • 3.0.0



33
34
35
 
# File 'lib/mongoid/threaded.rb', line 33

def database_override
  Thread.current["[mongoid]:db-override"]
end

#database_override=(name) ⇒ String, Symbol

Set the global database override.

Examples:

Set the global database override.

Threaded.database_override = :testing

Parameters:

  • The (String, Symbol) —

    global override name.

Returns:

  • (String, Symbol) —

    The override.

Since:

  • 3.0.0



47
48
49
 
# File 'lib/mongoid/threaded.rb', line 47

def database_override=(name)
  Thread.current["[mongoid]:db-override"] = name
end

#disable_identity_map(option) ⇒ Object

Disable the identity map on either the current thread or all threads.

Examples:

Disable the identity map on all threads.

Threaded.disable_identity_map(:all)

Disable the identity map on the current thread.

Threaded.disable_identity_map(:current)

Parameters:

  • option (Symbol) —

    The disabling option.

Since:

  • 3.0.0



213
214
215
216
217
218
219
220
221
 
# File 'lib/mongoid/threaded.rb', line 213

def disable_identity_map(option)
  if option == :all
    Thread.list.each do |thread|
      thread["[mongoid]:identity-map-enabled"] = false
    end
  else
    Thread.current["[mongoid]:identity-map-enabled"] = false
  end
end

#enable_identity_map(option) ⇒ Object

Enable the identity map on either the current thread or all threads.

Examples:

Enable the identity map on all threads.

Threaded.enable_identity_map(:all)

Enable the identity map on the current thread.

Threaded.enable_identity_map(:current)

Parameters:

  • option (Symbol) —

    The disabling option.

Since:

  • 3.0.0



234
235
236
237
238
239
240
241
242
 
# File 'lib/mongoid/threaded.rb', line 234

def enable_identity_map(option)
  if option == :all
    Thread.list.each do |thread|
      thread["[mongoid]:identity-map-enabled"] = true
    end
  else
    Thread.current["[mongoid]:identity-map-enabled"] = true
  end
end

#executing?(name) ⇒ true

Are in the middle of executing the named stack

Examples:

Are we in the stack execution?

Threaded.executing?(:create)

Parameters:

  • name (Symbol) —

    The name of the stack

Returns:

  • (true) —

    If the stack is being executed.

Since:

  • 2.4.0



73
74
75
 
# File 'lib/mongoid/threaded.rb', line 73

def executing?(name)
  !stack(name).empty?
end

#exit(name) ⇒ true

Exit from a named thread local stack.

Examples:

Exit from the stack.

Threaded.exit(:create)

Parameters:

  • name (Symbol) —

    The name of the stack

Returns:

  • (true) —

    True.

Since:

  • 2.4.0



87
88
89
 
# File 'lib/mongoid/threaded.rb', line 87

def exit(name)
  stack(name).pop
end

#exit_autosave(document) ⇒ Object

Exit autosaving a document on the current thread.

Examples:

Exit autosave.

Threaded.exit_autosave(doc)

Parameters:

  • document (Document) —

    The document to autosave.

Since:

  • 3.0.0



162
163
164
 
# File 'lib/mongoid/threaded.rb', line 162

def exit_autosave(document)
  autosaves_for(document.class).delete_one(document.id)
end

#exit_validate(document) ⇒ Object

Exit validating a document on the current thread.

Examples:

Exit validation.

Threaded.exit_validate(doc)

Parameters:

  • document (Document) —

    The document to validate.

Since:

  • 2.1.9



174
175
176
 
# File 'lib/mongoid/threaded.rb', line 174

def exit_validate(document)
  validations_for(document.class).delete_one(document.id)
end

#identity_map ⇒ IdentityMap

Get the identity map off the current thread.

Examples:

Get the identity map.

Threaded.identity_map

Returns:

Since:

  • 2.1.0



186
187
188
 
# File 'lib/mongoid/threaded.rb', line 186

def identity_map
  Thread.current["[mongoid]:identity-map"] ||= IdentityMap.new
end

#identity_map_enabled? ⇒ true, false

Is the identity map enabled on the current thread?

Examples:

Is the identity map enabled?

Threaded.identity_map_enabled?

Returns:

  • (true, false) —

    If the identity map is enabled.

Since:

  • 3.0.0



198
199
200
 
# File 'lib/mongoid/threaded.rb', line 198

def identity_map_enabled?
  Thread.current["[mongoid]:identity-map-enabled"] != false
end

#insert(name) ⇒ Object

Get the insert consumer from the current thread.

Examples:

Get the insert consumer.

Threaded.insert

Returns:

  • (Object) —

    The batch insert consumer.

Since:

  • 2.1.0



252
253
254
 
# File 'lib/mongoid/threaded.rb', line 252

def insert(name)
  Thread.current["[mongoid][#{name}]:insert-consumer"]
end

#persistence_options(klass) ⇒ Hash

Get the persistence options for the current thread.

Examples:

Get the persistence options.

Threaded.persistence_options(Band)

Parameters:

  • klass (Class) —

    The model class.

Returns:

  • (Hash) —

    The current persistence options.

Since:

  • 2.1.0



280
281
282
 
# File 'lib/mongoid/threaded.rb', line 280

def persistence_options(klass)
  Thread.current["[mongoid][#{klass}]:persistence-options"]
end

#scope_stack ⇒ Hash

Get the mongoid scope stack for chained criteria.

Examples:

Get the scope stack.

Threaded.scope_stack

Returns:

  • (Hash) —

    The scope stack.

Since:

  • 2.1.0



359
360
361
 
# File 'lib/mongoid/threaded.rb', line 359

def scope_stack
  Thread.current["[mongoid]:scope-stack"] ||= {}
end

#selection ⇒ Hash

Get the field selection options from the current thread.

Examples:

Get the field selection options.

Threaded.selection

Returns:

  • (Hash) —

    The field selection.

Since:

  • 2.4.4



307
308
309
 
# File 'lib/mongoid/threaded.rb', line 307

def selection
  Thread.current["[mongoid]:selection"]
end

#selection=(value) ⇒ Hash

Set the field selection on the current thread.

Examples:

Set the field selection.

Threaded.selection = { field: 1 }

Parameters:

  • value (Hash) —

    The current field selection.

Returns:

  • (Hash) —

    The field selection.

Since:

  • 2.4.4



321
322
323
 
# File 'lib/mongoid/threaded.rb', line 321

def selection=(value)
  Thread.current["[mongoid]:selection"] = value
end

#session_override ⇒ String, Symbol

Get the global session override.

Examples:

Get the global session override.

Threaded.session_override

Returns:

  • (String, Symbol) —

    The override.

Since:

  • 3.0.0



333
334
335
 
# File 'lib/mongoid/threaded.rb', line 333

def session_override
  Thread.current["[mongoid]:session-override"]
end

#session_override=(name) ⇒ String, Symbol

Set the global session override.

Examples:

Set the global session override.

Threaded.session_override = :testing

Parameters:

  • The (String, Symbol) —

    global override name.

Returns:

  • (String, Symbol) —

    The override.

Since:

  • 3.0.0



347
348
349
 
# File 'lib/mongoid/threaded.rb', line 347

def session_override=(name)
  Thread.current["[mongoid]:session-override"] = name
end

#sessions ⇒ Hash

Get the database sessions from the current thread.

Examples:

Get the database sessions.

Threaded.sessions

Returns:

  • (Hash) —

    The sessions.

Since:

  • 3.0.0



59
60
61
 
# File 'lib/mongoid/threaded.rb', line 59

def sessions
  Thread.current["[mongoid]:sessions"] ||= {}
end

#set_insert(name, consumer) ⇒ Object

Set the insert consumer on the current thread.

Examples:

Set the insert consumer.

Threaded.insert = consumer

Parameters:

  • consumer (Object) —

    The insert consumer.

Returns:

  • (Object) —

    The insert consumer.

Since:

  • 2.1.0



266
267
268
 
# File 'lib/mongoid/threaded.rb', line 266

def set_insert(name, consumer)
  Thread.current["[mongoid][#{name}]:insert-consumer"] = consumer
end

#set_persistence_options(klass, options) ⇒ Hash

Set the persistence options on the current thread.

Examples:

Set the persistence options.

Threaded.set_persistence_options(Band, { safe: { fsync: true }})

Parameters:

  • klass (Class) —

    The model class.

  • options (Hash) —

    The persistence options.

Returns:

  • (Hash) —

    The persistence options.

Since:

  • 2.1.0



295
296
297
 
# File 'lib/mongoid/threaded.rb', line 295

def set_persistence_options(klass, options)
  Thread.current["[mongoid][#{klass}]:persistence-options"] = options
end

#stack(name) ⇒ Array

Get the named stack.

Examples:

Get a stack by name

Threaded.stack(:create)

Parameters:

  • name (Symbol) —

    The name of the stack

Returns:

  • (Array) —

    The stack.

Since:

  • 2.4.0



101
102
103
 
# File 'lib/mongoid/threaded.rb', line 101

def stack(name)
  Thread.current["[mongoid]:#{name}-stack"] ||= []
end

#timeless ⇒ true, false

Get the value of the one-off timeless call.

Examples:

Get the timeless value.

Threaded.timeless

Returns:

  • (true, false) —

    The timeless setting.

Since:

  • 2.3.0



371
372
373
 
# File 'lib/mongoid/threaded.rb', line 371

def timeless
  !!Thread.current["[mongoid]:timeless"]
end

#timeless=(value) ⇒ Object

Set the value of the one-off timeless call.

Examples:

Set the timeless value.

Threaded.timeless = true

Parameters:

  • value (true, false) —

    The value.

Since:

  • 2.3.0



383
384
385
 
# File 'lib/mongoid/threaded.rb', line 383

def timeless=(value)
  Thread.current["[mongoid]:timeless"] = value
end

#timestamping? ⇒ true, false

Is the current thread setting timestamps?

Examples:

Is the current thread timestamping?

Threaded.timestamping?

Returns:

  • (true, false) —

    If timestamps can be applied.

Since:

  • 2.3.0



395
396
397
 
# File 'lib/mongoid/threaded.rb', line 395

def timestamping?
  !timeless
end

#validated?(document) ⇒ true, false

Is the document validated on the current thread?

Examples:

Is the document validated?

Threaded.validated?(doc)

Parameters:

  • document (Document) —

    The document to check.

Returns:

  • (true, false) —

    If the document is validated.

Since:

  • 2.1.9



423
424
425
 
# File 'lib/mongoid/threaded.rb', line 423

def validated?(document)
  validations_for(document.class).include?(document.id)
end

#validations ⇒ Hash

Get all validations on the current thread.

Examples:

Get all validations.

Threaded.validations

Returns:

  • (Hash) —

    The current validations.

Since:

  • 2.1.9



447
448
449
 
# File 'lib/mongoid/threaded.rb', line 447

def validations
  Thread.current["[mongoid]:validations"] ||= {}
end

#validations_for(klass) ⇒ Array

Get all validations on the current thread for the class.

Examples:

Get all validations.

Threaded.validations_for(Person)

Parameters:

  • The (Class) —

    class to check.

Returns:

  • (Array) —

    The current validations.

Since:

  • 2.1.9



474
475
476
 
# File 'lib/mongoid/threaded.rb', line 474

def validations_for(klass)
  validations[klass] ||= []
end