更新到最新 Meilisearch 版本

目前，Meilisearch 数据库仅与用于创建它们的 Meilisearch 版本兼容。以下指南将引导您使用转储将现有数据库从旧版本的 Meilisearch 迁移到最新版本。

如果您在 DigitalOcean、AWS 或 GCP 等云平台上更新您的 Meilisearch 实例，请确保您可以通过 SSH 连接到您的云实例。根据您连接的用户（root、admin 等），您可能需要在某些命令前加上 sudo。

如果迁移到最新版本的 Meilisearch 将导致您跳过多个版本，这可能需要更改您的代码库。 请参阅我们的特定版本更新警告以了解更多详细信息。

登录您的 Meilisearch Cloud 帐户并导航到您要更新的项目。

单击您要更新的项目。 在页面顶部查找“常规设置”部分。

每当有新版本的 Meilisearch 可用时，您将在“Meilisearch 版本”字段旁边看到一个更新按钮。

要更新到最新的 Meilisearch 版本，请单击“更新到 v.X.Y.Z”按钮。

这将打开一个弹出窗口，其中包含有关更新过程的更多信息。 阅读后，单击“更新”。 您的项目的“状态”将从“正在运行”更改为“正在更新”。

项目成功更新后，您将收到一封确认更新的电子邮件，“状态”将变回“正在运行”。

首先，使用 get version 端点验证与您的数据库兼容的 Meilisearch 版本

curl \
  -X GET 'http://<your-domain-name>/version' \
  -H 'Authorization: Bearer API_KEY'

响应应如下所示

{
  "commitSha": "stringOfLettersAndNumbers",
  "commitDate": "YYYY-MM-DDTimestamp",
  "pkgVersion": "x.y.z"
}

curl \
  -X GET 'http://<your-domain-name>/version' \
  -H 'X-Meili-API-Key: API_KEY'

如果您的pkgVersion为 0.21 或更高版本，您可以跳到创建转储。如果不是，请继续执行下一步。

使用低于 v0.21 的 Meilisearch 版本创建转储时，所有字段都必须显示才能保存在转储中。

首先验证所有属性是否都包含在显示属性列表中

# whenever you see {index_uid}, replace it with your index's unique id
curl \
  -X GET 'http://<your-domain-name>/indexes/{index_uid}/settings/displayed-attributes' \
  -H 'X-Meili-API-Key: API_KEY'

如果所有索引的响应都是 {'displayedAttributes': '["*"]'}，您可以继续下一步。

如果响应是其他任何内容，请将当前显示的属性列表保存在文本文件中，然后将显示的属性列表重置为其默认值 (["*"])

curl \
  -X DELETE 'http://<your-domain-name>/indexes/{index_uid}/settings/displayed-attributes' \
  -H 'X-Meili-API-Key: API_KEY'

此命令返回一个 updateId。 使用 get update 端点来跟踪操作的状态

 # replace {indexUid} with the uid of your index and {updateId} with the updateId returned by the previous request
  curl \
    -X GET 'http://<your-domain-name>/indexes/{indexUid}/updates/{updateId}'
    -H 'X-Meili-API-Key: API_KEY'

一旦状态为 processed，您就可以继续了。 对所有索引重复此过程，然后继续创建转储。

在创建转储之前，请确保您的转储目录在可访问的位置。默认情况下，转储是在 Meilisearch 目录根目录中名为 dumps 的文件夹中创建的。

像 DigitalOcean、AWS 和 GCP 这样的云平台配置为将转储存储在 /var/opt/meilisearch/dumps 目录中。

如果您不确定 Meilisearch 目录的位置，请尝试以下操作

which meilisearch

/absolute/path/to/your/meilisearch/directory

然后您可以创建数据库的转储

curl \
  -X POST 'http://<your-domain-name>/dumps' \
  -H 'Authorization: Bearer API_KEY'
# -H 'X-Meili-API-Key: API_KEY' for v0.24 or below

服务器应返回如下所示的响应

{
  "taskUid": 1,
  "indexUid": null,
  "status": "enqueued",
  "type": "dumpCreation",
  "enqueuedAt": "2022-06-21T16:10:29.217688Z"
}

使用 taskUid 来跟踪转储的状态。 请记住，该过程可能需要一些时间才能完成。

  curl \
    -X GET 'http://<your-domain-name>/dumps/:dump_uid/status'
    -H 'Authorization: Bearer API_KEY' 
  # -H 'X-Meili-API-Key: API_KEY' for v0.24 or below

一旦 dumpCreation 任务显示 "status": "succeeded"，您就可以继续了。

停止您的 Meilisearch 实例。

我们建议您创建一个备份，以防出现问题，而不是删除 data.ms。 data.ms 应该位于 Meilisearch 二进制文件的根目录，除非您选择了其他位置。

在云平台上，您将在 /var/lib/meilisearch/data.ms 找到 data.ms 文件夹。

将当前 Meilisearch 安装和数据库的二进制文件移动到 /tmp 文件夹

mv /path/to/your/meilisearch/directory/meilisearch/data.ms /tmp/
mv /path/to/your/meilisearch/directory/meilisearch /tmp/

使用以下命令安装最新版本的 Meilisearch

curl -L https://install.meilisearch.com | sh

授予 Meilisearch 二进制文件执行权限

chmod +x meilisearch

对于云平台，请将新的 Meilisearch 二进制文件移动到 /usr/bin 目录

mv meilisearch /usr/bin/meilisearch

执行以下命令以在启动时导入转储

# replace {dump_uid.dump} with the name of your dump file
./meilisearch --import-dump dumps/{dump_uid.dump} --master-key="MASTER_KEY"
# Or, if you chose another location for data files and dumps before the update, also add the same parameters
./meilisearch --import-dump dumps/{dump_uid.dump} --master-key="MASTER_KEY" --db-path PATH_TO_DB_DIR/data.ms --dump-dir PATH_TO_DUMP_DIR/dumps

导入转储需要索引其中包含的所有文档。 根据数据集的大小，此过程可能需要很长时间，并导致内存使用量激增。

如果您正在运行云实例，请按 Ctrl+C 来停止 Meilisearch（一旦您的转储已正确导入）。 接下来，执行以下命令来运行脚本以配置 Meilisearch 并将其作为服务重启

meilisearch-setup

如果需要，使用 更新显示属性端点将 displayedAttributes 设置回其先前的值。

现在您的更新后的 Meilisearch 实例已启动并运行，请验证转储导入是否成功，并且没有数据丢失。

如果一切正常，那么恭喜您！ 您已成功将数据库迁移到最新版本的 Meilisearch。 请务必查看更新日志。

如果出现问题，您可以随时回滚到以前的版本。 如果问题仍然存在，请随时寻求帮助。 如果您已成功迁移数据库，但代码库出现问题，请务必查看我们的特定版本警告。

删除先前步骤创建的 Meilisearch 二进制文件和 data.ms 文件夹。 接下来，使用以下命令将备份文件移回其先前的位置

mv /tmp/meilisearch /path/to/your/meilisearch/directory/meilisearch
mv /tmp/data.ms /path/to/your/meilisearch/directory/meilisearch/data.ms

对于云平台，请在 Meilisearch 目录的根目录运行配置脚本

meilisearch-setup

如果一切顺利，您可以使用以下命令删除备份文件

rm -r /tmp/meilisearch
rm -r /tmp/data.ms

如果需要，您也可以删除转储文件

rm /path/to/your/meilisearch/directory/meilisearch/dumps/{dump_uid.dump}

迁移到最新版本的 Meilisearch 后，您的代码库可能需要进行一些更改。 此部分包含一些影响最大的特定版本更改的警告。 有关完整的更新日志，请参阅GitHub 上的发布标签。

• 如果您是从 v0.25 或更低版本更新，请注意
  • private 和 public 密钥已弃用，并替换为两个具有类似权限的默认 API 密钥：Default Admin API Key 和 Default Search API Key。
  • updates API 已替换为 tasks API。
• 如果您是从 v0.27 或更低版本更新，现有密钥将重新生成其 key 和 uid 字段。
• 如果您是从 v0.30 或更低版本更新到云平台上的 v1.0 或更高版本，请在以下文件中将 --dumps-dir 替换为 --dump-dir
  • /etc/systemd/system/meilisearch.service
  • /var/opt/meilisearch/scripts/first-login/001-setup-prod.sh