Clase: Mongo::Auth::User::View

Hereda:
Objeto
  • Objeto
Mostrar todo
Ampliado por:
Reenviable
Definido en:
lib/mongo/auth/user/view.rb

Overview

Define el comportamiento para operaciones relacionadas con el usuario en bases de datos.

Desde:

  • 2.0.0

Resumen de atributos de la instancia colapsar

Resumen del método de instancia colapsar

Detalles del constructor

#inicializar(base de datos) ⇒ Vista

Inicializar la vista del nuevo usuario.

Ejemplos:

Inicializar la vista del usuario.

View::User.new(database)

Parámetros:

  • database (Mongo::Database)

    La base de datos para la cual es la vista.

Desde:

  • 2.0.0



68
69
70
# Archivo 'lib/mongo/auth/user/view.rb', línea 68

def inicializar(database)
  @database = database
end

Detalles de los atributos de instancia

#databaseDatabase (readonly)

Devuelve la base de datos Base de datos de la vista.

Devuelve:

  • (Database)

    base de datos La base de datos de la vista.

Desde:

  • 2.0.0



29
30
31
# Archivo 'lib/mongo/auth/user/view.rb', línea 29

def database
  @database
end

Detalles del método de instancia

#create(usuario_o_nombre, opciones = {}) ⇒ Result

Crear un nuevo usuario en la base de datos.

Ejemplos:

Crea un nuevo usuario de lectura/guardado.

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

Parámetros:

  • usuario_o_nombre (Auth::User, String)

    El objeto de usuario o nombre de usuario.

  • opciones (Hash) (por defecto: {})

    Las opciones de usuario.

Opciones Hash (options):

  • :: sesión (Sesión)

    La sesión a utilizar para la operación.

  • :escribir_preocupación (Hash)

    Las opciones de nivel de confirmación de escritura (write concern).

Devuelve:

  • (Result)

    La respuesta del comando.

Desde:

  • 2.0.0



48
49
50
51
52
53
54
55
56
57
58
# Archivo 'lib/mongo/auth/user/view.rb', línea 48

def Cree(usuario_o_nombre, opciones = {})
  usuario = generate(usuario_o_nombre, opciones)
  execute_operation(opciones) hacer |sesión|
    Operación::Crear usuario.Nuevo(
      usuario: usuario,
      nombre_base_datos: database.Nombre,
      sesión: sesión,
      write_concern: opciones[:escribir_preocupación] && Nivel de confirmación de escritura (write concern).Obtener(opciones[:escribir_preocupación]),
    )
  end
end

#info(nombre, opciones = {}) ⇒ Arreglo

Obtén información de un usuario específico en la base de datos.

Ejemplos:

Obtén la información de un usuario en particular.

view.info('emily')

Parámetros:

  • Nombre (string)

    El nombre de usuario.

  • opciones (Hash) (por defecto: {})

    Las opciones para la operación de información.

Opciones Hash (options):

  • :: sesión (Sesión)

    La sesión a utilizar para la operación.

Devuelve:

  • (arreglo)

    Un arreglo que envuelve un documento que contiene información sobre un usuario específico.

Desde:

  • 2.1.0



136
137
138
# Archivo 'lib/mongo/auth/user/view.rb', línea 136

def información(Nombre, opciones = {})
  consulta_de_usuario(Nombre, opciones).Documentos
end

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

Remover a un usuario de la base de datos.

Ejemplos:

Remover al usuario de la base de datos.

view.remove('user')

Parámetros:

  • Nombre (string)

    El nombre de usuario.

  • opciones (Hash) (por defecto: {})

    Las opciones para la operación de eliminación.

Opciones Hash (options):

  • :: sesión (Sesión)

    La sesión a utilizar para la operación.

  • :escribir_preocupación (Hash)

    Las opciones de nivel de confirmación de escritura (write concern).

Devuelve:

  • (Result)

    La respuesta del comando.

Desde:

  • 2.0.0



86
87
88
89
90
91
92
93
94
95
# Archivo 'lib/mongo/auth/user/view.rb', línea 86

def Remover(Nombre, opciones = {})
  execute_operation(opciones) hacer |sesión|
    Operación::RemoveUser.Nuevo(
      nombre de usuario: Nombre,
      nombre_base_datos: database.Nombre,
      sesión: sesión,
      write_concern: opciones[:escribir_preocupación] && Nivel de confirmación de escritura (write concern).Obtener(opciones[:escribir_preocupación]),
    )
  end
end

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

Actualizar un usuario en la base de datos.

Ejemplos:

Actualiza un usuario.

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

Parámetros:

  • usuario_o_nombre (Auth::User, String)

    El objeto de usuario o nombre de usuario.

  • opciones (Hash) (por defecto: {})

    Las opciones de usuario.

Opciones Hash (options):

  • :: sesión (Sesión)

    La sesión a utilizar para la operación.

  • :escribir_preocupación (Hash)

    Las opciones de nivel de confirmación de escritura (write concern).

Devuelve:

  • (Result)

    La respuesta.

Desde:

  • 2.0.0



111
112
113
114
115
116
117
118
119
120
121
# Archivo 'lib/mongo/auth/user/view.rb', línea 111

def update(usuario_o_nombre, opciones = {})
  usuario = generate(usuario_o_nombre, opciones)
  execute_operation(opciones) hacer |sesión|
    Operación::UpdateUser.Nuevo(
      usuario: usuario,
      nombre_base_datos: database.Nombre,
      sesión: sesión,
      write_concern: opciones[:escribir_preocupación] && Nivel de confirmación de escritura (write concern).Obtener(opciones[:escribir_preocupación]),
    )
  end
end