クラス: Mongo::Auth::User::View

継承:
オブジェクト
  • オブジェクト
すべて表示
次による拡張機能。
転送可能
定義:
lib/mongo/auth/user/view.rb

Overview

データベースに対するユーザー関連操作の動作を定義します。

以来

  • 2.0.0

インスタンス属性の概要を折りたたむ

インスタンス メソッドの概要を折りたたむ

コンストラクターの詳細

#初期化（データベース） =ビュー

新しいユーザー ビューを初期化します。

例:

ユーザー ビューを初期化します。

View::User.new(database)

パラメーター:

  • database （ Mongo::Database ） —

    ビューが使用されるデータベース。

以来

  • 2.0.0



66
67
68
 
# ファイル 'lib/mongo/auth/user/view.rb', 行 66

デフォルト 初期化(database)
  @database = database
end

インスタンス属性の詳細

#database ⇒ Database (readonly)

データベースビューのデータベースを返します。

次の値を返します。

  • (Database) —

    データベースビューのデータベース。

以来

  • 2.0.0



27
28
29
 
# ファイル 'lib/mongo/auth/user/view.rb', 行 27

デフォルト database
  @database
end

インスタンス メソッドの詳細

# create （user_or_name、オプション = {}） =結果

データベースに新しいユーザーを作成します。

例:

新しい読み取り/書込みユーザーを作成します。

view.create('user', password: 'password', roles: [ 'readWrite' ])

パラメーター:

  • user_or_name ( Auth::User , string ) —

    ユーザー オブジェクトまたはユーザー名。

  • options （ハッシュ） （デフォルトは{}です） —

    ユーザー オプション。

オプション ハッシュ（ options ）:

  • :session （セッション） —

    操作に使用するセッション。

  • :write_concern （ハッシュ） —

    書込み保証（write concern） オプション。

次の値を返します。

  • （結果） —

    コマンドの応答。

以来

  • 2.0.0



46
47
48
49
50
51
52
53
54
55
56
 
# ファイル 'lib/mongo/auth/user/view.rb', 行 46

デフォルト create(user_or_name, options = {})
  user = 生成(user_or_name, options)
  execution_operation(options) 行う |セッション|
    操作::CreateUser.新着情報(
      user: user,
      db_name: database.name,
      セッション: セッション,
      write_concern: options[:write_concern] & & WriteConcern.得る(options[:write_concern])
    )
  end
end

# info （名前、オプション = {}） =配列

データベース内の特定のユーザーの情報を取得します。

例:

特定のユーザーの情報を取得します。

view.info('emily')

パラメーター:

  • name ( string ) —

    ユーザー名。

  • options （ハッシュ） （デフォルトは{}です） —

    情報操作のオプション。

オプション ハッシュ（ options ）:

  • :session （セッション） —

    操作に使用するセッション。

次の値を返します。

  • （配列） —

    特定のユーザーに関する情報を含むドキュメントをラップする配列。

以来

  • 2.1.0



134
135
136
 
# ファイル 'lib/mongo/auth/user/view.rb', 行 134

デフォルト info(name, options = {})
  user_query(name, options).ドキュメント
end

delete (name, options = {{}) = {}} =結果

データベースからユーザーを削除します。

例:

データベースからユーザーを削除します。

view.remove('user')

パラメーター:

  • name ( string ) —

    ユーザー名。

  • options （ハッシュ） （デフォルトは{}です） —

    削除操作のオプション。

オプション ハッシュ（ options ）:

  • :session （セッション） —

    操作に使用するセッション。

  • :write_concern （ハッシュ） —

    書込み保証（write concern） オプション。

次の値を返します。

  • （結果） —

    コマンドの応答。

以来

  • 2.0.0



84
85
86
87
88
89
90
91
92
93
 
# ファイル 'lib/mongo/auth/user/view.rb', 行 84

デフォルト delete(name, options = {})
  execution_operation(options) 行う |セッション|
    操作::RemoveUser.新着情報(
      user_name: name,
      db_name: database.name,
      セッション: セッション,
      write_concern: options[:write_concern] & & WriteConcern.得る(options[:write_concern])
    )
  end
end

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

データベース内のユーザーを更新します。

例:

ユーザーを更新します。

view.update('name', password: 'testpwd')

パラメーター:

  • user_or_name ( Auth::User , string ) —

    ユーザー オブジェクトまたはユーザー名。

  • options （ハッシュ） （デフォルトは{}です） —

    ユーザー オプション。

オプション ハッシュ（ options ）:

  • :session （セッション） —

    操作に使用するセッション。

  • :write_concern （ハッシュ） —

    書込み保証（write concern） オプション。

次の値を返します。

  • （結果） —

    応答。

以来

  • 2.0.0



109
110
111
112
113
114
115
116
117
118
119
 
# ファイル 'lib/mongo/auth/user/view.rb', 行 109

デフォルト update(user_or_name, options = {})
  user = 生成(user_or_name, options)
  execution_operation(options) 行う |セッション|
    操作::UpdateUser.新着情報(
      user: user,
      db_name: database.name,
      セッション: セッション,
      write_concern: options[:write_concern] & & WriteConcern.得る(options[:write_concern])
    )
  end
end