Интерфейс CollectionInterface
Представляет коллекцию схемы базы данных
Используется для доступа к информации о таблицах и других данных в базе данных.
Краткое описание методов
-
describe() public
Получить метаданные столбцов для таблицы.
-
listTables() public
Получить список таблиц, доступных в текущем подключении.
-
listTablesWithoutViews() public @method
Получить список таблиц, доступных в текущем подключении. Это исключит любые представления в схеме.
Подробное описание методов
describe() public
describe(string $name, array<string, mixed> $options = []): Cake\Database\Schema\TableSchemaInterface
Получить метаданные столбцов для таблицы.
Кэширование будет применено, если cacheMetadata ключ присутствует в параметрах конфигурации подключения. По умолчанию — _cakemodel, если true.
Параметры
-
forceRefresh- Установите в значение true, чтобы принудительно перестроить кэшированные метаданные. По умолчанию false.
Параметры
-
string$name Имя таблицы, которую нужно описать.
-
array<string, mixed>$options optional Параметры для использования, см. выше.
Возвращает
Cake\Database\Schema\TableSchemaInterfaceВыбрасывает
Cake\Database\Exception\DatabaseExceptionпри невозможности описания таблицы.
listTables() public
listTables(): array<string>
Получить список таблиц, доступных в текущем подключении.
Возвращает
array<string>listTablesWithoutViews() public @method
listTablesWithoutViews(): array<string>
Получить список таблиц, доступных в текущем подключении. Это исключит любые представления в схеме.
Возвращает
array<string>
© 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.4/interface-Cake.Database.Schema.CollectionInterface.html
