Upgrade

从 v0.4 开始，我们提供了一个内置的工具来帮助您将以前的 GreptimeDB 部署升级到最新版本。 如果不同版本之间有 Breaking Change，我们都建议使用此方法在不同版本的 GreptimeDB 之间进行迁移升级。

此工具可以将 v0.3.0 以上的版本升级到最新版本。

CLI

该工具在 greptime 二进制文件中。在开始之前，您需要准备目标版本的二进制文件。

  1. greptime cli export --help

帮助文档如下：

  1. greptime-cli-export 
  3. USAGE:
  4.     greptime cli export [OPTIONS] --addr <ADDR> --output-dir <OUTPUT_DIR> --target <TARGET>
  6. OPTIONS:
  7.         --addr <ADDR>                  Server address to connect
  8.         --database <DATABASE>          The name of the catalog to export. Default to "greptime-*""
  9.                                        [default: ]
  10.     -h, --help                         Print help information
  11.     -j, --export-jobs <EXPORT_JOBS>    Parallelism of the export [default: 1]
  12.         --max-retry <MAX_RETRY>        Max retry times for each job [default: 3]
  13.         --output-dir <OUTPUT_DIR>      Directory to put the exported data. E.g.:
  14.                                        /tmp/greptimedb-export
  15.     -t, --target <TARGET>              Things to export [possible values: create-table, table-data]

这里解释一些重要选项的含义：

  • -addr：Frontend 节点或者 Standalone 进程的 gRPC 地址。
  • -output-dir：要放置导出数据的目录。需要是当前机器上的路径。导出的 SQL 文件将放在该目录中。
  • -target：要导出的内容。create-table 可以导出每个表的 CREATE TABLE 语句。table-data 可以导出每个表的数据以及对应的 COPY FROM 语句。

对于完整的升级，您需要使用每个目标选项两次执行此工具。

示例

这一节将演示如何从 v0.3.0 升级到 v0.4.0。

在下面的文本中，我们假设您的 Frontend 的 gRPC 端口为 127.0.0.1:4001。输出目录是 /tmp/greptimedb-export。

导出 CREATE TABLE

  1. greptime cli export --addr '127.0.0.1:4001' --output-dir /tmp/greptimedb-export --target create-table

如果成功，您将看到类似于以下内容的输出

  1. 2023-10-20T09:41:06.500390Z  INFO cmd::cli::export: finished exporting greptime.public with 434 tables
  2. 2023-10-20T09:41:06.500482Z  INFO cmd::cli::export: success 1/1 jobs

此时输出目录的结构如下

  1. /tmp/greptimedb-export
  2. └── greptime-public.sql

导出表数据

  1. greptime cli export --addr '127.0.0.1:4001' --database greptime-public --output-dir /tmp/greptimedb-export --target table-data

日志输出与上面类似。输出目录的结构如下

  1. /tmp/greptimedb-export
  2. ├── greptime-public
  3. │   ├── up.parquet
  4. │   └── other-tables.parquet
  5. ├── greptime-public_copy_from.sql
  6. └── greptime-public.sql

新的内容是 greptime-public_copy_from.sql 和 greptime-public。前者包含每个表的 COPY FROM 语句。后者包含每个表的数据。

导入表结构和数据

然后您需要执行上一步生成的 SQL 文件。首先是 greptime-public.sql。在之前的步骤中导出的 SQL 语句使用的是 PostgreSQL 方言，接下来的操作都将通过 PG 协议来进行。本文档假设客户端为 psql。

Upgrade - 图1NOTICE

从这一步开始，所有的操作都是在新版本的 GreptimeDB 中完成的。

PostgreSQL 协议的默认端口是 4003。

在执行以下命令之前，您需要在新部署中首先创建相应的数据库（但在本例中，数据库 greptime-public 是默认的）。

此命令将在新版本的 GreptimeDB 中创建所有表。

  1. psql -h 127.0.0.1 -p 4003 -d public -f /tmp/greptime-public.sql

接下来导入数据

  1. psql -h 127.0.0.1 -p 4003 -d public -f /tmp/greptime-public_copy_from.sql

清理

到这一步，所有的数据都已经迁移完毕。您可以在新集群中检查数据。

在确认数据正确后，您可以清理旧集群和临时的 --output-dir。在本例中是 /tmp/greptimedb-export。

推荐流程

该部分给出了一个推荐的整体流程，以便平滑升级 GreptimeDB。如果您的环境可以在升级过程中离线，可以跳过此部分。

  1. 创建一个全新的 v0.4 集群
  2. 导出并导入 create-table
  3. 将工作负载切换到新集群
  4. 导出并导入 table-data

注意

  • 在步骤 2 和 3 之间对表结构的更改将丢失
  • 在第四部完成之前，老数据在新集群上是不可见的。