yesccx / laravel-db-query
Laravel db query
Installs: 4 311
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Requires
- php: ^8.1.0
- laravel/framework: ^9.0
Requires (Dev)
- ext-json: *
README
在 Laravel 中便捷的进行原生 MYSQL 语句查询
目录
安装
运行环境
通过Composer引入依赖包
通过终端进入项目根目录,执行以下命令引入依赖包:
> composer require yesccx/laravel-db-query:1.x
发布配置文件
如果需要额外配置,可选择 发布配置文件
> php artisan vendor:publish --tag=db-query-config
开始使用
DBQuery
查询
简单查询
将连接配置名传递给 connection
方法
连接配置通常来自
database.php
配置文件中的connections
use Yesccx\DBQuery\DBQuery; $data = DBQuery::connection('mysql') ->statement('select * from users where id = 1') ->get();
还可以直接传入连接配置( 目前仅支持 MYSQL
驱动 )
use Yesccx\DBQuery\DBQuery; $data = DBQuery::connection([ 'driver' => 'mysql', 'host' => '127.0.0.1' 'username' => 'example', 'password' => 'example', // ... ]) ->statement('select * from users where id = 1') ->get();
模板查询
在语句中定义占位符后,可以使用链式方法如 where
、select
、group by
、order by
等进行查询
use Yesccx\DBQuery\DBQuery; $data = DBQuery::connection('mysql') ->statement('select * from users where @WHERE@') ->where('id', 1) ->get(); $data = DBQuery::connection('mysql') ->statement('select @COLUMNS@ from users where (@WHERE@) and deleted_at is null') ->select('id', 'name') ->where('id', 1) ->get();
目前支持的占位符:
查询缓存
默认情况下关闭查询缓存,可以通过配置 db-query.cache.enabled
进行开启,开启后传递给 cache
方法一个有效时间(单位秒)对查询结果进行缓存
通常情况下可以直接配置
env
中的YDQ_CACHE_ENABLED
进行开启
use Yesccx\DBQuery\DBQuery; $data = DBQuery::connection('mysql') ->statement('select * from users where @WHERE@') ->where('id', 1) // 将查询结果缓存60秒 ->cache(60) ->get();
如果需要指定缓存驱动、前缀等,可以通过配置
db-query.cache.driver
更多查询方法
查询允许链式的使用 Laravel
Illuminate\Database\Query\Builder
类中支持的方法,此外可以通过其它方法获取查询结果,参考 API章节
注意:不能使用
Illuminate\Database\Query\Builder
中的get
、first
、find
、paginate
、count
等方法
查询服务类
继承 DBQueryService
,实现 connection
方法后在类中使用 statement
方法进行查询。这种方式能方便的组织和管理原生的查询语句
<?php namespace App\Services; use Yesccx\DBQuery\Supports\DBQueryService; class PatientQueryService extends DBQueryService { /** * Define connection config * * @return string|array connection name or connection config */ protected function connection(): string|array { return 'mysql'; } public function getList(): array { return $this->statement('select * from users where type = 1') ->get() ->toArray(); } public function getUserInfo(int $id): mixed { return $this->statement('select * from users where @WHERE@') ->where('id', $id) ->cache(60) ->first(); } public function getUserCount(): int { return $this->statement('select count(*) as count from users') ->cache(60) ->value('count', 0); } }
API
Queries
get(): \Illuminate\Support\Collection
获取列表,结果是一个二维数组集合类
find(mixed $default = null): mixed
获取单条数据,结果是一个一维数组,类似 Illuminate\Database\Eloquent\Builder
中的 find
方法
first(mixed $default = null): mixed
find
方法的别名
value(string $column, mixed $default = null): mixed
获取第一行某一列的值
pluck(string $column): \Illuminate\Support\Collection
获取某一列
exists(): bool
判断是否存在数据
ENV
YDQ_CACHE_ENABLED
是否开启查询缓存,默认关闭
YDQ_CACHE_DRIVER
缓存驱动,默认与 cache.default
保持一致
使用建议
- 建议将定义
查询服务类
统一存放在app/QueryServices
目录下
License
MIT