类：Mongo::Auth::User::View

继承：
对象
  • 对象
显示全部
扩展方式：
可转发
定义于：
lib/ Mongo/auth/user/view.rb

Overview

定义数据库上与用户相关的操作的行为。

由于：

  • 2.0.0

实例属性摘要折叠

实例方法摘要折叠

构造函数详情

#初始化（数据库）→查看

初始化新用户视图。

例子：

初始化用户视图。

View::User.new(database)

参数：

由于：

  • 2.0.0

[查看源代码]

68
69
70
 
# File 'lib/ Mongo/auth/user/view.rb', line 68

def 初始化(database)
  @database = database
end

实例属性详细信息

#database ⇒ Database (readonly)

返回数据库 视图的数据库。

返回：

  • (数据库) —

    数据库视图的数据库。

由于：

  • 2.0.0


29
30
31
 
# File 'lib/ Mongo/auth/user/view.rb', line 29

def database
  @database
end

实例方法详细信息

# create (user_or_name, options = {}) ⇒结果

在数据库中创建一个新用户。

例子：

创建新的读/写用户。

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

参数：

  • user_or_name ( Auth::User , string ) —

    用户对象或用户名。

  • 选项 （哈希） （默认为： {} ） —

    用户选项。

选项哈希 ( options )：

  • :session （会话） —

    用于操作的会话。

  • :write_concern （哈希） —

    写关注（write concern）选项。

返回：

  • (结果) —

    命令响应。

由于：

  • 2.0.0

[查看源代码]

48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/ Mongo/auth/user/view.rb', line 48

def 创建(user_or_name, 选项 = {})
  user = 生成(user_or_name, 选项)
  execute_operation(选项) do |会话|
    操作::createUser.new(
      用户： user,
      db_name: database.名称,
      会话： 会话,
      write_concern: 选项[:write_concern] && writeConcern.获取(选项[:write_concern]),
    )
  end
end

# info (name, options = {}) ⇒数组

获取数据库中特定用户的信息。

例子：

获取特定用户的信息。

view.info('emily')

参数：

  • 名称 ( string ) —

    用户名。

  • 选项 （哈希） （默认为： {} ） —

    信息操作的选项。

选项哈希 ( options )：

  • :session （会话） —

    用于操作的会话。

返回：

  • ( Array ) —

    包装包含特定用户信息的文档的大量。

由于：

  • 2.1.0

[查看源代码]

136
137
138
 
# File 'lib/ Mongo/auth/user/view.rb', line 136

def 信息(名称, 选项 = {})
  user_query(名称, 选项).文档
end

# remove (name, options = {}) ⇒结果

从数据库中删除用户。

例子：

从数据库中删除用户。

view.remove('user')

参数：

  • 名称 ( string ) —

    用户名。

  • 选项 （哈希） （默认为： {} ） —

    删除操作的选项。

选项哈希 ( options )：

  • :session （会话） —

    用于操作的会话。

  • :write_concern （哈希） —

    写关注（write concern）选项。

返回：

  • (结果) —

    命令响应。

由于：

  • 2.0.0

[查看源代码]

86
87
88
89
90
91
92
93
94
95
 
# File 'lib/ Mongo/auth/user/view.rb', line 86

def 删除(名称, 选项 = {})
  execute_operation(选项) do |会话|
    操作::删除用户.new(
      user_name: 名称,
      db_name: database.名称,
      会话： 会话,
      write_concern: 选项[:write_concern] && writeConcern.获取(选项[:write_concern]),
    )
  end
end

# update (user_or_name, options = {}) ⇒结果

更新数据库中的用户。

例子：

更新用户。

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

参数：

  • user_or_name ( Auth::User , string ) —

    用户对象或用户名。

  • 选项 （哈希） （默认为： {} ） —

    用户选项。

选项哈希 ( options )：

  • :session （会话） —

    用于操作的会话。

  • :write_concern （哈希） —

    写关注（write concern）选项。

返回：

  • (结果) —

    响应。

由于：

  • 2.0.0

[查看源代码]

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, 选项 = {})
  user = 生成(user_or_name, 选项)
  execute_operation(选项) do |会话|
    操作::updateUser.new(
      用户： user,
      db_name: database.名称,
      会话： 会话,
      write_concern: 选项[:write_concern] && writeConcern.获取(选项[:write_concern]),
    )
  end
end