Edit Report a Bug

    MongoDB::getCollectionInfo

    (PECL mongo >=1.6.0)

    MongoDB::getCollectionInfo — Возвращает информацию о коллекциях в базе данных

    Описание

    public MongoDB::getCollectionInfo ([ array $options = array() ] ) : array

    Получает список всех коллекций в базе данных и возвращает их в виде массива документов, которые содержат их имена и параметры.

    Замечание: Этот метод использует комманду » listCollections когда общается с MongoDB 2.8+. Для более старых баз данных, этот метод запрашивает специальную коллекцию system.namespaces.

    Список параметров

    options

    Массив опций для перечисления коллекций. В настоящее время доступны следующие варианты:

    • "filter"

      Опциональный критерий запроса. Если задан, то будет использован для фильтрации коллекций, включенных в результирующий набор.

      Подходящие поля для запроса включают "name" (строка с именем коллекции, без префикса в виде имени базы данных) и "options" (объект, включающий опции, использованные при создании этой коллекции)..

      Замечание: MongoDB 2.6 и более ранние версии, требуют, чтобы критерий "name" был строго строкового типа. Потому, что драйвер должен добавть к этому значению префикс в виде имени базы данныхдля запроса коллекции system.namespaces. Более поздние версии MongoDB не имеют этого ограничения, так как драйвер использует комманду listCollections.

    • "includeSystemCollections"

      Логическое значение, по умолчанию FALSE. Определяет, должны ли системные коллекции входить в результирующий набор.

    Следующая опция может использоваться с MongoDB 2.8+:

    • "maxTimeMS"

      Указывает суммарный лимит времени в миллисекундах на обработку операции (не включая время простоя) на сервере. Если операция на стороне сервера не завершилась за это время, то вызывается исключение MongoExecutionTimeoutException.

    Возвращаемые значения

    Эта функция возвращает массив, где каждый элемент представляет собой массив, описывающий коллекцию. Элементы будут содержать ключ name, обозначающий имя коллекции, и, необязательно, ключ options, обозначающий массив объектов, используемых для создания коллекции. Например, закрытые коллекции будут содержать capped и size параметры.

    Ошибки

    Для MongoDB 2.6 и более ранних версий MongoException будет выброшено, если для критерия "name" опции "filter" было указано не строковое значение.

    Примеры

    Пример #1 Пример использования MongoDB::getCollectionInfo()

    <?php
    $m     = new MongoClient();
    $db = $m->selectDB("demo");
    var_dump($db->getCollectionInfo());
    ?>

    Результатом выполнения данного примера будет что-то подобное:

    array(2) {
  [0]=>
  array(2) {
    ["name"]=>
    string(4) "logs"
    ["options"]=>
    array(2) {
      ["capped"]=>
      bool(true)
      ["size"]=>
      int(10240)
    }
  }
  [1]=>
  array(2) {
    ["name"]=>
    string(5) "users"
    ["options"]=>
    array(1) {
      ["flags"]=>
      int(1)
    }
  }
}

    Смотрите также

    • MongoDB::getCollectionNames() - Получает массив имен для всех коллекций в базе данных
    • MongoDB::listCollections() - Получает массив объектов MongoCollection для всех коллекций в базе данных

    add a note add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top