MongoDB\Collection::rename()

Definição

MongoDB\Collection::rename()

Renomear a collection.

function rename(
    string $toCollectionName,
    ?string $toDatabaseName = null,
    array $options = []
): array|object

Parâmetros

$toCollectionName : string

O novo nome da coleção.

$toDatabaseName : string

O novo nome do reconhecimento de data center da collection. Se um novo nome de banco de dados não for especificado, o banco de dados da collection original será usado. Se o novo nome especificar um banco de dados diferente, o comando copiará a collection para o novo banco de dados e descartará a collection de origem.

$options : array

Uma array especificando as opções desejadas.

Nome	Tipo	Descrição
dropTarget	booleano	Se true, o MongoDB descartará o destino antes de renomear a collection. O valor padrão é false.
comment	misto	Permite que os usuários especifiquem um comentário arbitrário para ajudar a rastrear a operação por meio do profiler do banco de dados, saída currentOp e registros. Esta opção está disponível desde o MongoDB 4.4 e resultará em uma exceção no momento da execução se for especificada para uma versão mais antiga do servidor. Novidade na versão 1.13.
session	MongoDB\Driver\Session	Sessão do cliente a ser associada à operação.
typeMap	array	O mapa de tipos para aplicar aos cursores, que determina como os documentos BSON são convertidos para valores PHP. O padrão é o mapa de tipos da coleção. Isso será usado para o documento de resultado do comando retornado.
writeConcern	MongoDB\Driver\WriteConcern	Preocupação de gravação a ser usada na operação. O padrão é a preocupação de gravação da coleção. Não é possível especificar uma preocupação de gravação para operações individuais como parte de uma transação. Em vez disso, defina a opção writeConcern ao iniciar a transação.

Return Values

Uma array ou objeto com o documento de resultado do comando renameCollection . O tipo de retorno depende da opção typeMap .

Erros/exceções

MongoDB\Exception\UnsupportedException se as opções forem usadas e não aceitas pelo servidor selecionado (p. ex., collation, readConcern, writeConcern).

MongoDB\Exception\InvalidArgumentException para erros relacionados à análise de parâmetros ou opções.

MongoDB\Driver\Exception\RuntimeException para outros erros no nível da extensão (por exemplo erros de conexão).

Exemplo

A seguinte operação renomeia a collection restaurants no reconhecimento de data center test para places:

<?php
$collection = (new MongoDB\Client)->test->restaurants;
$result = $collection->rename('places');
var_dump($result);

A saída seria então semelhante a:

object(MongoDB\Model\BSONDocument)#9 (1) {
  ["storage":"ArrayObject":private]=>
  array(1) {
    ["ok"]=>
    float(1)
  }
}

Veja também

• MongoDB\Database::renameCollection()

• referência do comando renameCollection no manual do MongoDB