# Meilisearch
## Data storage path
DATA_PATH=./data
## Environment variable, values: production or development
MEILI_ENV=development
## Log level, values: ERROR,WARN,INFO,DEBUG,TRACE
MEILI_LOG_LEVEL=INFO
## MEILI_MASTER_KEY must be set when MEILI_ENV is production, and MEILI_MASTER_KEY is optional when MEILI_ENV is development.
MEILI_MASTER_KEY=
## Sets the maximum size of the task database. Value must be given in bytes or explicitly stating a base unit.
MEILI_MAX_TASK_DB_SIZE=1Gb
目前 Meilisearch 还没有实现删除 Task 的 API 最好事先设置好 Task 的最大占用空间，否则在频繁更新数据的情况下，可能导致磁盘被大量 Task 占用！
services:
  meilisearch:
    image: getmeili/meilisearch:v0.26.1
    restart: always
    hostname: meilisearch
    container_name: meilisearch
    ports:
      - 7700:7700
    environment:
      - MEILI_ENV=${MEILI_ENV}
      - MEILI_LOG_LEVEL=${MEILI_LOG_LEVEL}
      - MEILI_MASTER_KEY=${MEILI_MASTER_KEY}
      - MEILI_MAX_TASK_DB_SIZE=${MEILI_MAX_TASK_DB_SIZE}
    volumes:
      - ${DATA_PATH}/meilisearch.ms:/data.ms
需要说明的是，当 MEILI_ENV 为 production 时，MEILI_MASTER_KEY 必须设置。虽然如此，但是建议在任何环境都设置上 MEILI_MASTER_KEY。
    
docker compose up -d
这里用的是基于 Go 开发的 Docker Compose，而非老版本基于 Python 的 docker-compose，升级请参考《升级 Linux 上的 Docker Compose 到 V2》
获取 API Keys⌗ 
    
curl -X GET 'http://localhost:7700/keys' \
    -H 'Authorization: Bearer masterKey' | python -m json.tool
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                Dload  Upload   Total   Spent    Left  Speed
100   655  100   655    0     0  87356      0 --:--:-- --:--:-- --:--:-- 93571
    "results": [
            "actions": [
                "search"
            "createdAt": "2022-04-15T09:01:04.670596731Z",
            "description": "Default Search API Key (Use it to search from the frontend)",
            "expiresAt": null,
            "indexes": [
            "key": "WC9L6J8q1601585056da2c18f1cec7a820fc69a507e2e159750d2e5ddef84d9bff1373d9",
            "updatedAt": "2022-04-15T09:01:04.670596731Z"
            "actions": [
            "createdAt": "2022-04-15T09:01:04.668292104Z",
            "description": "Default Admin API Key (Use it for all other operations. Caution! Do not use it on a public frontend)",
            "expiresAt": null,
            "indexes": [
            "key": "9vGXfIKt601249b756efa25064922701b72979425bbddecab722dc1ded429eda37991f94",
            "updatedAt": "2022-04-15T09:01:04.668292104Z"
这里的 masterKey 就是在 .env 文件中设置的 MEILI_MASTER_KEY。
可以看到 Meilisearch 会根据设置的 Master Key 自动生成两个 Keys，一个是用于"前端"应用直接请求 Meilisearch 的 API Key，这个 Key 只有 search 权限。
而另一个 Key 是 Admin API Key 可以用于后端导入数据或者其他管理用途，这个 Key 的权限很高，可以操作所有的索引。所以不要轻易暴露。
导入数据⌗ 
Meilisearch 支持 RESTful API，也有对应的 SDK，这里我们使用 PHP 的 SDK 和 Laravel Scout 实现索引的创建和数据的导入。
    
composer require laravel/scout
php artisan vendor:publish --provider="Laravel\Scout\ScoutServiceProvider"
composer require meilisearch/meilisearch-php:^0.23.1
composer require http-interop/http-factory-guzzle
    public function searchableAs()
        // 这里如果不想用模型的 table 或者 collectio 名称作为 index 的话，可以自己自定义名称
        return 'district'
     * Get the key name used to index the model.
     * Date: 2022/2/8
     * @return string
     * @author George <[email protected]>
    public function getScoutKeyName(): string
        return '_id'; // 因为我这里使用的是 MongoDB，所以使用 _id 关联模型
     * Get the indexable data array for the model.
     * Date: 2022/2/8
     * @return array
     * @author George <[email protected]>
    public function toSearchableArray(): array
        // 设置需要被添加到 Meilisearch 的文档字段
        return [
            'code' => $this->code, // 行政区域编码
            'fullname' => $this->fullname, // 行政区域名称
            'spelling' => $this->spelling, // 行政区域英文拼写
     * Determine if the model should be searchable.
     * Date: 2022/4/18
     * @return bool
     * @author George
    public function shouldBeSearchable(): bool
        // 当行政区域的级别是一级和二级才导入到 Meilisearch 中，因为业务中只需要一级和二级城市支持搜索。街道等忽略。
        return $this->level < 3;