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

Class: Mongo::Auth::CRDeprecated Private

Inherits:

Base

• Object
• Base
• Mongo::Auth::CR show all

Defined in:

lib/mongo/auth/cr.rb,
lib/mongo/auth/cr/conversation.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Deprecated.

MONGODB-CR authentication mechanism is deprecated as of MongoDB 3.6. Support for it in the Ruby driver will be removed in driver version 3.0. Please use SCRAM instead.

Defines behavior for MongoDB-CR authentication.

Defined Under Namespace

Classes: Conversation

Constant Summarycollapse

MECHANISM =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

The authentication mechanism string.

'MONGODB-CR'.freeze

Instance Attribute Summary

Attributes inherited from Base

#connection, #user

Instance Method Summarycollapse

• #login ⇒ BSON::Document private
  Log the user in on the current connection.

Methods inherited from Base

#conversation, #initialize

Instance Method Details

#login ⇒ 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.

Log the user in on the current connection.