Classificação: Mongo::Auth::User::View

Herda:
Objeto
  • Objeto
mostrar tudo
Estendido por:
Encaminhável
Definido em:
lib/mongo/auth/user/view.rb

Visão geral

Define o comportamento para operações relacionadas ao usuário em bancos de dados.

Desde:

  • 2.0.0

Recolhimento do Resumo do atributo de instância

Recolhimento do Resumo do método de instância

Detalhes do construtor

#inicializar(banco de dados) ➤ Visualizar

Inicialize a nova visualização do usuário.

Exemplos:

Inicialize a visualização do usuário.

View::User.new(database)

Parâmetros:

  • database (Mongo::Database) —

    O banco de dados de dados para o qual a visualização é.

Desde:

  • 2.0.0



66
67
68
 
# Arquivo 'lib/mongo/auth/user/view.rb', linha 66

def inicializar(database)
  @database = database
end

Detalhes do atributo da instância

#database ⇒ Database (readonly)

Retorna banco de dados O banco de dados da visualização.

Retorna:

  • (Banco de dados) —

    banco de dados O banco de dados da visualização .

Desde:

  • 2.0.0



27
28
29
 
# Arquivo 'lib/mongo/auth/user/view.rb', linha 27

def database
  @database
end

Detalhes do método de instância

#create(user_or_name, options = {}) ➤ Resultado

Crie um novo usuário no banco de dados.

Exemplos:

Crie um novo usuário de leitura/escrita.

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

Parâmetros:

  • user_or_name (Auth::User, string) —

    O objeto de usuário ou nome de usuário.

  • opções (Hash) (padrão para: {}) —

    As opções do usuário.

Hash de opções (opções):

  • :session (Sessão) —

    A sessão a ser usada para a operação.

  • :write_concern (Hash) —

    As opções de preocupação de gravação .

Retorna:

  • (Resultado) —

    A resposta do comando.

Desde:

  • 2.0.0



46
47
48
49
50
51
52
53
54
55
56
 
# Arquivo 'lib/mongo/auth/user/view.rb', linha 46

def criar(user_or_name, opções = {})
  utilizador = Gerar(user_or_name, opções)
  execute_operation(opções) fazer |session|
    (operação)::createUser.Novo(
      utilizador: utilizador,
      db_name: database.name,
      sessão: session,
      write_concern: opções[:write_concern] && Escreva preocupação.obter(opções[:write_concern])
    )
  end
end

#web

Obtenha informações de um usuário específico no banco de dados.

Exemplos:

Obtenha as informações de um usuário específico.

view.info('emily')

Parâmetros:

  • name (string) —

    O nome de usuário.

  • opções (Hash) (padrão para: {}) —

    As opções para a operação de informações.

Hash de opções (opções):

  • :session (Sessão) —

    A sessão a ser usada para a operação.

Retorna:

  • (Array) —

    Um array encapsulando um documento contendo informações sobre um usuário específico.

Desde:

  • 2.1.0



134
135
136
 
# Arquivo 'lib/mongo/auth/user/view.rb', linha 134

def informações(name, opções = {})
  user_query(name, opções).documentos
end

#remove(name, options = {}) ➤ Resultado

Remove um usuário do banco de dados.

Exemplos:

Remove o usuário do banco de dados.

view.remove('user')

Parâmetros:

  • name (string) —

    O nome de usuário.

  • opções (Hash) (padrão para: {}) —

    As opções para a operação de remoção.

Hash de opções (opções):

  • :session (Sessão) —

    A sessão a ser usada para a operação.

  • :write_concern (Hash) —

    As opções de preocupação de gravação .

Retorna:

  • (Resultado) —

    A resposta do comando.

Desde:

  • 2.0.0



84
85
86
87
88
89
90
91
92
93
 
# Arquivo 'lib/mongo/auth/user/view.rb', linha 84

def remover(name, opções = {})
  execute_operation(opções) fazer |session|
    (operação)::RemoveUser.Novo(
      user_name: name,
      db_name: database.name,
      sessão: session,
      write_concern: opções[:write_concern] && Escreva preocupação.obter(opções[:write_concern])
    )
  end
end

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

Atualizar um usuário no banco de banco de dados.

Exemplos:

Atualize um usuário.

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

Parâmetros:

  • user_or_name (Auth::User, string) —

    O objeto de usuário ou nome de usuário.

  • opções (Hash) (padrão para: {}) —

    As opções do usuário.

Hash de opções (opções):

  • :session (Sessão) —

    A sessão a ser usada para a operação.

  • :write_concern (Hash) —

    As opções de preocupação de gravação .

Retorna:

  • (Resultado) —

    A resposta.

Desde:

  • 2.0.0



109
110
111
112
113
114
115
116
117
118
119
 
# Arquivo 'lib/mongo/auth/user/view.rb', linha 109

def update(user_or_name, opções = {})
  utilizador = Gerar(user_or_name, opções)
  execute_operation(opções) fazer |session|
    (operação)::updateUser.Novo(
      utilizador: utilizador,
      db_name: database.name,
      sessão: session,
      write_concern: opções[:write_concern] && Escreva preocupação.obter(opções[:write_concern])
    )
  end
end