Класс Collection
Представляет коллекцию схемы базы данных
Используется для доступа к информации о таблицах и других данных в базе данных.
Непосредственные подклассы
Краткое описание свойств
- Объект подключения
$_connectionprotected - Экземпляр диалекта схемы.
$_dialectprotected
Краткое описание методов
- __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( )
Получить список таблиц, доступных в текущем подключении.
Возвращаемое значение
массивСписок таблиц в подключенной базе данных/схеме.
Подробное описание свойств
© 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.8/class-Cake.Database.Schema.Collection.html