接口 CollectionInterface
代表数据库模式集合
用于访问有关数据库中表和其他数据的資訊。
命名空间: Cake\Database\Schema
方法摘要
-
describe() public
获取表的列元数据。
-
listTables() public
获取当前连接中可用的表列表。
-
listTablesWithoutViews() public @method
获取当前连接中可用的表列表。这将排除模式中的任何视图。
方法详细说明
describe() ¶ public
describe(string $name, array<string, mixed> $options = []): Cake\Database\Schema\TableSchemaInterface
获取表的列元数据。
如果 Connection 配置选项中存在 cacheMetadata
键,将应用缓存。默认为 _cakemodel,如果为 true。
选项
forceRefresh
- 设置为 true 强制重建缓存的元数据。默认为 false。
参数
-
string
$name 要描述的表的名称。
-
array<string, mixed>
$options 可选 要使用的选项,见上文。
返回值
Cake\Database\Schema\TableSchemaInterface
抛出异常
Cake\Database\Exception\DatabaseException
当无法描述表时。
listTablesWithoutViews() ¶ public @method
listTablesWithoutViews(): list<string>
获取当前连接中可用的表列表。这将排除模式中的任何视图。
返回值
list<string>