类集合
代表数据库模式集合
用于访问数据库中表格和其他数据的相关信息。
命名空间: Cake\Database\Schema
属性汇总
-
$_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\TableSchemaInterface $schema): void反射过程每个步骤的辅助方法。
参数
-
string$stage 阶段名称。
-
string$name 表格名称。
-
array<string, mixed>$config 配置数据。
-
Cake\Database\Schema\TableSchemaInterface$schema 表格模式实例。
返回值
void抛出
Cake\Database\Exception\DatabaseException查询失败时。
describe() ¶ public
describe(string $name, array<string, mixed> $options = []): Cake\Database\Schema\TableSchemaInterface获取表格的列元数据。
名称可以包含以 'schema.table' 形式的数据库模式名称。
如果 Connection 配置选项中存在 cacheMetadata 键，将应用缓存。如果为 true，默认为 _cakemodel。
选项
forceRefresh- 设置为 true 强制重建缓存的元数据。默认为 false。
参数
-
string$name 要描述的表格名称。
-
array<string, mixed>$options optional 要使用的选项，见上文。
返回值
Cake\Database\Schema\TableSchemaInterface抛出
Cake\Database\Exception\DatabaseException当表格无法描述时。
listTablesWithoutViews() ¶ public
listTablesWithoutViews(): list<string>获取当前连接中可用表格的列表，不包括任何视图。
返回值
list<string>