Spec-Zone.ru › Yii 2.0

Класс yii\mongodb\Database

Все классы | Свойства | Методы
Наследование yii\mongodb\Database » yii\base\Object
Реализует yii\base\Configurable
Доступно с версии 2.0
Исходный код https://github.com/yiisoft/yii2-mongodb/blob/master/Database.php

Database представляет информацию о базе данных Mongo.

Открытые свойства

Свойство Тип Описание Определено в
$connection yii\mongodb\Connection Подключение к MongoDB. yii\mongodb\Database
$fileCollection yii\mongodb\file\Collection Коллекция Mongo GridFS. yii\mongodb\Database
$name string Имя этой базы данных. yii\mongodb\Database

Открытые методы

Метод Описание Определено в
__call() Вызывает метод с заданным именем, который не является методом класса. yii\base\Object
__construct() Конструктор. yii\base\Object
__get() Возвращает значение свойства объекта. yii\base\Object
__isset() Проверяет, установлено ли свойство, т.е. определено и не равно null. yii\base\Object
__set() Устанавливает значение свойства объекта. yii\base\Object
__unset() Устанавливает свойство объекта в null. yii\base\Object
canGetProperty() Возвращает значение, указывающее, можно ли считать свойство. yii\base\Object
canSetProperty() Возвращает значение, указывающее, можно ли установить свойство. yii\base\Object
className() Возвращает полное имя этого класса. yii\base\Object
clearCollections() Очищает внутренние списки коллекций. yii\mongodb\Database
createCollection() Создаёт новую коллекцию. yii\mongodb\Database
createCommand() Создаёт команду MongoDB, связанную с этой базой данных. yii\mongodb\Database
dropCollection() Удаляет указанную коллекцию. yii\mongodb\Database
getCollection() Возвращает коллекцию Mongo с заданным именем. yii\mongodb\Database
getFileCollection() Возвращает коллекцию Mongo GridFS с заданным префиксом. yii\mongodb\Database
hasMethod() Возвращает значение, указывающее, определён ли метод. yii\base\Object
hasProperty() Возвращает значение, указывающее, определено ли свойство. yii\base\Object
init() Инициализирует объект. yii\base\Object
listCollections() Возвращает список доступных коллекций в этой базе данных. yii\mongodb\Database

Защищённые методы

Метод Описание Определено в
selectCollection() Выбирает коллекцию с заданным именем. yii\mongodb\Database
selectFileCollection() Выбирает коллекцию GridFS с заданным префиксом. yii\mongodb\Database

Подробное описание свойств

$connection открытое свойство

Подключение к MongoDB.

public yii\mongodb\Connection $connection = null

$fileCollection открытое только для чтения свойство

Коллекция Mongo GridFS.

public yii\mongodb\file\Collection getFileCollection ( $prefix = 'fs', $refresh = false )

$name открытое свойство

Имя этой базы данных.

public string $name = null

Подробное описание методов

clearCollections() public method

Очищает внутренние списки коллекций.

Этот метод можно использовать для разрыва циклических ссылок между объектами yii\mongodb\Database и yii\mongodb\Collection.

public void clearCollections ( )

createCollection() public method

Создаёт новую коллекцию.

Примечание: Mongo автоматически создаёт новые коллекции по первому требованию, этот метод имеет смысл только для скриптов миграций или в случае, если вам нужно создать коллекцию со специфическими опциями.

public boolean createCollection ( $name, $options = [] )
$name string

Имя коллекции

$options array

Параметры коллекции в формате: "имя" => "значение"

return boolean

Успешно ли выполнена операция.

throws yii\mongodb\Exception

в случае неудачи.

createCommand() public method (доступен с версии 2.1)

Создаёт MongoDB команду, связанную с этой базой данных.

public yii\mongodb\Command createCommand ( $document = [] )
$document array

Содержимое документа команды.

return yii\mongodb\Command

Экземпляр команды.

dropCollection() public method (доступен с версии 2.1)

Удаляет указанную коллекцию.

public boolean dropCollection ( $name )
$name string

Имя коллекции

return boolean

Успешно ли выполнена операция.

getCollection() public method

Возвращает Mongo коллекцию с заданным именем.

public yii\mongodb\Collection getCollection ( $name, $refresh = false )
$name string

Имя коллекции

$refresh boolean

Перезагрузить ли экземпляр коллекции, даже если он найден в кэше.

return yii\mongodb\Collection

Экземпляр Mongo коллекции.

getFileCollection() public method

Возвращает Mongo GridFS коллекцию с заданным префиксом.

public yii\mongodb\file\Collection getFileCollection ( $prefix = 'fs', $refresh = false )
$prefix string

Префикс коллекции.

$refresh boolean

Перезагрузить ли экземпляр коллекции, даже если он найден в кэше.

return yii\mongodb\file\Collection

Mongo GridFS коллекция.

listCollections() public method (доступен с версии 2.1.1)

Возвращает список доступных коллекций в этой базе данных.

public array listCollections ( $condition = [], $options = [] )
$condition array

Условие фильтра.

$options array

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

return array

Информация о коллекциях.

selectCollection() protected method

Выбирает коллекцию с заданным именем.

protected yii\mongodb\Collection selectCollection ( $name )
$name string

Имя коллекции.

return yii\mongodb\Collection

Экземпляр коллекции.

selectFileCollection() protected method

Выбирает GridFS коллекцию с заданным префиксом.

protected yii\mongodb\file\Collection selectFileCollection ( $prefix )
$prefix string

Префикс файла коллекции.

return yii\mongodb\file\Collection

Экземпляр коллекции файла.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-mongodb-database.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API