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

Class: Mongo::Auth::User::View

Inherits:

Object

• Object
• Mongo::Auth::User::View show all

Extended by:

Forwardable

Defined in:

lib/mongo/auth/user/view.rb

Overview

Defines behavior for user related operation on databases.

Instance Attribute Summary collapse

• #database ⇒ Database readonly
  Database The view’s database.

Instance Method Summarycollapse

• #create(user_or_name, options = {}) ⇒ Result
  Create a new user in the database.
• #info(name, options = {}) ⇒ Array
  Get info for a particular user in the database.
• #initialize(database) ⇒ View constructor
  Initialize the new user view.
• #remove(name, options = {}) ⇒ Result
  Remove a user from the database.
• #update(user_or_name, options = {}) ⇒ Result
  Update a user in the database.

Constructor Details

#initialize(database) ⇒ View

Initialize the new user view.

Instance Attribute Details

#database ⇒ Database

Returns database The view’s database.

Instance Method Details

#create(user_or_name, options = {}) ⇒ Result

Create a new user in the database.

| 48 49 50 51 52 53 54 55 56 57 58 | # File 'lib/mongo/auth/user/view.rb', line 48 def create(user_or_name, options = {}) user = generate(user_or_name, options) execute_operation(options) do |session| Operation::CreateUser.new( user: user, db_name: database.name, session: session, write_concern: options[:write_concern] && WriteConcern.get(options[:write_concern]), ) end end | | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#info(name, options = {}) ⇒ Array

Get info for a particular user in the database.

#remove(name, options = {}) ⇒ Result

Remove a user from the database.

| 86 87 88 89 90 91 92 93 94 95 | # File 'lib/mongo/auth/user/view.rb', line 86 def remove(name, options = {}) execute_operation(options) do |session| Operation::RemoveUser.new( user_name: name, db_name: database.name, session: session, write_concern: options[:write_concern] && WriteConcern.get(options[:write_concern]), ) end end | | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#update(user_or_name, options = {}) ⇒ Result

Update a user in the database.

| 111 112 113 114 115 116 117 118 119 120 121 | # File 'lib/mongo/auth/user/view.rb', line 111 def update(user_or_name, options = {}) user = generate(user_or_name, options) execute_operation(options) do |session| Operation::UpdateUser.new( user: user, db_name: database.name, session: session, write_concern: options[:write_concern] && WriteConcern.get(options[:write_concern]), ) end end | | ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |