dropRole
Definição
dropRole
Deletes a user-defined role from the database on which you run the command.
Dica
Em
mongosh
, esse comando também pode ser executado por meio do método auxiliardb.dropRole()
.Os métodos auxiliares são práticos para os usuários
mongosh
, mas podem não retornar o mesmo nível de informações que os comandos do banco de dados. Nos casos em que a praticidade não for necessária ou os campos de retorno adicionais forem necessários, use o comando de banco de dados.
Compatibilidade
Esse comando está disponível em implantações hospedadas nos seguintes ambientes:
MongoDB Atlas: o serviço totalmente gerenciado para implantações do MongoDB na nuvem
Importante
Esse comando não é suportado nos clusters M,0 M, M,2 5M10+ e Flex. Para obter mais informações, consulte Comandos não suportados.
MongoDB Enterprise: a versão autogerenciada e baseada em assinatura do MongoDB
MongoDB Community: uma versão com código disponível, de uso gratuito e autogerenciada do MongoDB
Sintaxe
O comando tem a seguinte sintaxe:
db.runCommand( { dropRole: "<role>", writeConcern: { <write concern> }, comment: <any> } )
Campos de comando
O comando tem os seguintes campos:
Campo | Tipo | Descrição |
---|---|---|
| string | The name of the user-defined role to remove from the database. |
| documento | Opcional. O nível da write concern para a operação. Consulte Especificação de write concern. |
| any | Opcional. Um comentário fornecido pelo usuário para anexar a este comando. Depois de definido, esse comentário aparece junto com os registros desse comando nos seguintes locais:
Um comentário pode ser qualquer tipo BSON válido (string, inteiro, objeto, array etc). |
Comportamento
Autenticação
When a role is dropped on a mongod
, previously authenticated users
remain logged in to the database but immediately lose the role's privileges.
When a role is dropped on a mongos
, previously authenticated users
remain logged in to the database but lose the role's privileges when the cache
refreshes. The cache refreshes automatically after the time specified with the
userCacheInvalidationIntervalSecs
parameter or manually when
you run the invalidateUserCache
command.
Acesso necessário
You must have the dropRole
ação on a database to drop a role from that database.
Exemplo
The following operations remove the readPrices
role from the
products
database:
use products db.runCommand( { dropRole: "readPrices", writeConcern: { w: "majority" } } )