MongoDB\Driver\ClientEncryption::addKeyAltName
(mongodb >=1.15.0)
MongoDB\Driver\ClientEncryption::addKeyAltName — Adiciona um nome alternativo a um documento de chave
Descrição
final public MongoDB\Driver\ClientEncryption::addKeyAltName(MongoDB\BSON\Binary
$keyId, string $keyAltName): ?object
Adiciona keyAltName ao conjunto de nomes alternativos para o
documento da chave com o UUID keyId fornecido.
Parâmetros
keyId-
Uma instância MongoDB\BSON\Binary com subtipo 4 (UUID) identificando o documento da chave.
keyAltName-
Nome alternativo a ser adicionado ao documento da chave.
Valor Retornado
Retorna a versão anterior do documento da chave ou null se nenhum documento
corresponder.
Erros/Exceções
- Lança uma exceção MongoDB\Driver\Exception\InvalidArgumentException em caso de erro ao analisar argumentos.
- Lança uma exceção MongoDB\Driver\Exception\ConnectionException se a conexão com o servidor falhar (por outros motivos além da autenticação).
- Lança uma exceção MongoDB\Driver\Exception\AuthenticationException se a autenticação for necessária e falhar.
- Lança uma MongoDB\Driver\Exception\RuntimeException em outros erros.
Veja Também
- MongoDB\Driver\ClientEncryption::getKeyByAltName() - Obtém um de documento chave com um nome alternativo
- MongoDB\Driver\ClientEncryption::removeKeyAltName() - Remove um nome alternativo de um documento de chave