Top Level Namespace

Defined Under Namespace

Modules: Mongoid, Rails

Instance Method Summary collapse

Instance Method Details

#check_if_transactions_might_be_available!(client) ⇒ Object

This method raises an error if the cluster the client is connected to does not support transactions in any case. At the moment this is the case of the standalone topology.

Please note that if this method did not raise, it does not guarantee that transactions are available for the cluster.

Parameters:

  • client (Mongo::Client) —

    Client connected to a cluster to be tested.

Raises:



16
17
18
19
20
 
# File 'lib/mongoid/railties/console_sandbox.rb', line 16

def check_if_transactions_might_be_available!(client)
  if client.cluster.single?
    raise Mongoid::Errors::TransactionsNotSupported
  end
end

#start_sandbox ⇒ Object

Prepares console sandbox mode. This method should be called when a user starts rails console with ‘–sandbox’ flag.



36
37
38
39
40
41
 
# File 'lib/mongoid/railties/console_sandbox.rb', line 36

def start_sandbox
  Mongoid.persistence_context.client.tap do |client|
    check_if_transactions_might_be_available!(client)
    start_sandbox_transaction(client)
  end
end

#start_sandbox_transaction(client) ⇒ Object

Starts a transaction that should include all the operations inside the sandboxed console session. This transaction should not be ever committed. When a user end the console session, the client will disconnect, and the transaction will be automatically aborted therefore.

Parameters:

  • client (Mongo::Client) —

    Client to start the transaction.



28
29
30
31
32
 
# File 'lib/mongoid/railties/console_sandbox.rb', line 28

def start_sandbox_transaction(client)
  session = client.start_session
  ::Mongoid::Threaded.set_session(session, client: client)
  session.start_transaction
end