Класс Collection

Представляет коллекцию схемы базы данных

Используется для доступа к информации о таблицах и других данных в базе данных.

Прямые подклассы

Cake\Database\Schema\CachedCollection

Пространство имен: Cake\Database\Schema
Расположение: Database/Schema/Collection.php

Краткое описание свойств

$_connection protected

Cake\Database\Connection
Объект соединения
$_dialect protected

Cake\Database\Schema\BaseSchema
Экземпляр диалекта схемы.

Краткое описание методов

__construct() public
Конструктор.
_reflect() protected
Вспомогательный метод для выполнения каждого этапа процесса рефлексии.
describe() public
Получить метаданные столбцов для таблицы.
listTables() public
Получить список таблиц, доступных в текущем соединении.

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

__construct()source public

__construct( Cake\Database\Connection $connection )

Конструктор.

Параметры

Cake\Database\Connection $connection: Экземпляр соединения.

_reflect()source protected

_reflect( string $stage , string $name , array $config , Cake\Database\Schema\TableSchema $schema )

Вспомогательный метод для выполнения каждого этапа процесса рефлексии.

Параметры

строка $stage: Имя этапа.
строка $name: Имя таблицы.
массив $config: Данные конфигурации.
Cake\Database\Schema\TableSchema $schema: Экземпляр таблицы

Исключения

Cake\Database\Exception
при ошибке запроса.

describe()source public

describe( string $name , array $options = [] )

Получить метаданные столбцов для таблицы.

Кэширование будет применено, если ключ cacheMetadata присутствует в параметрах конфигурации соединения. По умолчанию cake_model, если значение true.

Параметры

forceRefresh - Установите значение true, чтобы принудительно перестроить кэшированные метаданные. По умолчанию false.

Параметры

строка $name: Имя таблицы для описания.
массив $options необязательно []: Параметры для использования, см. выше.

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

Cake\Database\Schema\TableSchema
Объект с метаданными столбцов.

Исключения

Cake\Database\Exception
если таблицу нельзя описать.

listTables()source public

listTables( )

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

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

массив
Список таблиц в подключенной базе данных/схеме.

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

$_connectionsource

protected Cake\Database\Connection

Объект соединения

$_dialectsource

protected Cake\Database\Schema\BaseSchema

Экземпляр диалекта схемы.

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.6/class-Cake.Database.Schema.Collection.html