MongoDB\Collection::rename()

Definición

MongoDB\Collection::rename()

Renombra la colección.

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

Parámetros

$toCollectionName : string

El nuevo nombre de la colección.

$toDatabaseName : string

El nuevo nombre de base de datos de la colección. Si no se especifica un nuevo nombre de base de datos, se utilizará la base de datos de la colección original. Si el nuevo nombre especifica una base de datos diferente, el comando copia la colección en la nueva base de datos y descarta la colección de origen.

$options : arreglo

Un arreglo que especifica las opciones deseadas.

Nombre	Tipo	Descripción
dropTarget	booleano	Si true, MongoDB descartar el destino antes de cambiar el nombre de la colección. El valor por defecto es false.
comment	mixto	Permite a los usuarios especificar un comentario arbitrario para ayudar a rastrear la operación a través de perfilador de base de datos, output de currentOp y registros. Esta opción está disponible desde MongoDB 4.4 y, si se especifica para una versión de servidor anterior, dará lugar a una excepción en tiempo de ejecución. Novedades en la versión 1.13.
sesión	MongoDB\Driver\Session	Sesión de cliente para asociar con la operación.
typeMap	arreglo	El mapa de tipos para aplicar a cursores, que determina cómo se convierten los documentos BSON en valores PHP. Por defecto, se utiliza el mapa de tipos de la colección. Esto se utilizará para el documento de resultado del comando retornado.
writeConcern	MongoDB\Driver\WriteConcern	nivel de confirmación de escritura (write concern) a usar en la operación. Por defecto, se aplica el nivel de confirmación de escritura (write concern) de la colección. No es posible especificar un nivel de confirmación de escritura (write concern) para operaciones individuales como parte de una transacción. En su lugar, configura la opción writeConcern al iniciar la transacción.

Return Values

Un arreglo u objeto con el documento de resultado del comando renameCollection. El tipo de retorno dependerá de la opción typeMap.

Errores/Excepciones

MongoDB\Exception\UnsupportedException si se usan opciones que no sean compatibles con el servidor seleccionado (p. ej. collation, readConcern, writeConcern).

MongoDB\Exception\InvalidArgumentException por errores relacionados con el análisis de parámetros u opciones.

MongoDB\Driver\Exception\RuntimeException para otros errores a nivel de extensión (por ejemplo, " errores de conexión).

Ejemplo

La siguiente operación renombra la colección restaurants en la base de datos test a places:

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

La vista de salida se ilustraría como sigue:

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

Ver también

• MongoDB\Database::renameCollection()

• Referencia del comando renameCollection en el manual de MongoDB