Класс Collection
Представляет коллекцию схемы базы данных
Используется для доступа к информации о таблицах и других данных в базе данных.
Краткое описание свойств
- $_connection protected
Cake\Database\ConnectionОбъект подключения
- $_dialect protected
Cake\Database\Schema\SchemaDialectЭкземпляр диалекта схемы.
Краткое описание методов
-
__construct() public
Конструктор.
-
_reflect() protected
Вспомогательный метод для выполнения каждого шага процесса рефлексии.
-
describe() public
Получить метаданные столбца для таблицы.
-
listTables() public
Получить список таблиц и представлений, доступных в текущем подключении.
-
listTablesWithoutViews() public
Получить список таблиц, исключая представления, доступных в текущем подключении.
Подробное описание методов
__construct() public
__construct(Cake\Database\Connection $connection)
Конструктор.
Параметры
-
Cake\Database\Connection$connection Экземпляр подключения.
_reflect() protected
_reflect(string $stage, string $name, array<string, mixed> $config, Cake\Database\Schema\TableSchema $schema): void
Вспомогательный метод для выполнения каждого шага процесса рефлексии.
Параметры
-
string$stage Имя стадии.
-
string$name Имя таблицы.
-
array<string, mixed>$config Данные конфигурации.
-
Cake\Database\Schema\TableSchema$schema Экземпляр схемы таблицы.
Возвращает
voidИсключения
Cake\Database\Exception\DatabaseExceptionпри сбое запроса.
describe() public
describe(string $name, array<string, mixed> $options = []): Cake\Database\Schema\TableSchema
Получить метаданные столбца для таблицы.
Имя может включать имя схемы базы данных в формате 'схема.таблица'.
Кеширование будет применено, если cacheMetadata ключ присутствует в параметрах конфигурации подключения. По умолчанию _cake_model_, если true.
Параметры
-
forceRefresh- Установите в true, чтобы принудительно перестроить кэшированные метаданные. По умолчанию false.
Параметры
-
string$name Имя таблицы для описания.
-
array<string, mixed>$options optional Параметры для использования, см. выше.
Возвращает
Cake\Database\Schema\TableSchemaИсключения
Cake\Database\Exception\DatabaseExceptionпри невозможности описания таблицы.
listTables() public
listTables(): array<string>
Получить список таблиц и представлений, доступных в текущем подключении.
Возвращает
array<string>listTablesWithoutViews() public
listTablesWithoutViews(): array<string>
Получить список таблиц, исключая представления, доступных в текущем подключении.
Возвращает
array<string>Подробное описание свойств
$_connection protected
Объект подключения
Тип
Cake\Database\Connection$_dialect protected
Экземпляр диалекта схемы.
Тип
Cake\Database\Schema\SchemaDialect
© 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/4.3/class-Cake.Database.Schema.Collection.html
