MongoDB\Collection::rename()

Definición

MongoDB\Collection::rename()

Cambiar el nombre de la colección.

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

Parámetros

$toCollectionName : cadena

El nuevo nombre de la colección.

$toDatabaseName : cadena

El nuevo nombre de la base de datos de la colección. Si no se especifica un nuevo nombre de base de datos, se usará 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 a la nueva base de datos y elimina la colección de origen.

$options : matriz

Una matriz que especifica las opciones deseadas.

Nombre	Tipo	Descripción
objetivo de caída	booleano	Si es true, MongoDB eliminará el destino antes de renombrar la colección. El valor predeterminado es false.
comment	mixto	Permite a los usuarios especificar un comentario arbitrario para ayudar a rastrear la operación a través del generador de perfilesde base de datos, salidacurrentOpy registros. Esta opción está disponible desde MongoDB 4.4 y generará una excepción en el momento de ejecución si se especifica para una versión de servidor anterior. Novedades en la versión 1.13.
sesión	MongoDB\Controlador\Sesión	Sesión de cliente para asociar a la operación.
typeMap	arreglo	El mapa de tipos que se aplica a los cursores y que determina cómo se convierten los documentos BSON a valores PHP. El valor predeterminado es el mapa de tipos de la colección. Esto se utilizará para el documento de resultado del comando devuelto.
writeConcern	MongoDB\Driver\WriteConcern	Escriba la preocupación que se usará para la operación. El valor predeterminado es la preocupación de escritura de la colección. No es posible especificar una preocupación de escritura para operaciones individuales como parte de una transacción. En su lugar, configure la writeConcern opción al iniciar la transacción.

Errores/Excepciones

MongoDB\Exception\UnsupportedException si se utilizan opciones que no son compatibles con el servidor seleccionado (porcollation readConcernwriteConcernejemplo,,,).

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

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

Ejemplo

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

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

Ver también

• MongoDB\Database::renameCollection()

• Referencia del comando renameCollection en el manual de MongoDB