MongoDB\Database::modifyCollection()

Definição

MongoDB\Database::modifyCollection()

Modifica uma collection ou visualização de acordo com o $collectionOptions especificado.

function modifyCollection(
    string $collectionName,
    array $collectionOptions,
    array $options = []
): array|object

Parâmetros

$collectionName : string

O nome da collection ou visualização a ser modificada.

$collectionOptions : array

Opções de collection ou visualização a serem atribuídas.

$options : array

Uma array especificando as opções desejadas.

Nome	Tipo	Descrição
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 tipo a aplicar aos cursores, que determina como os documentos BSON são convertidos em valores PHP. O padrão é o mapa de tipos do banco de dados. Isso será usado para o documento de resultado do comando retornado.
writeConcern	MongoDB\Driver\WriteConcern	Write concern a ser usada para a operação. O padrão é a preocupação de gravação do banco de dados.

Return Values

Uma array ou objeto com o documento de resultado do comando collMod .

Erros/exceções

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

O exemplo a seguir altera o tempo de expiração de uma collection TTL no reconhecimento de data center test :

<?php
$db = (new MongoDB\Client)->test;
$result = $db->modifyCollection('users', [
    'keyPattern' => ['lastAccess' => 1],
    'expireAfterSeconds' => 1000
]);
var_dump($result);

A saída seria então semelhante a:

object(stdClass)#2779 {
  ["expireAfterSeconds_old"]=>
  int(3)
  ["expireAfterSeconds_new"]=>
  int(1000)
  ["ok"]=>
  float(1)
}

Veja também

• referência do comando collMod no manual do MongoDB