元数据导出和导入
Snapshot 命令用于保存、恢复和查看 GreptimeDB 元数据快照。
导出工具
命令语法
greptime cli meta snapshot save [OPTIONS]
选项
存储后端选项
| 选项 | 是否必需 | 默认值 | 描述 |
|---|---|---|---|
| --store-addrs | 是（使用持久化后端时） | - | 元数据存储地址。持久化后端需要设置，格式取决于所选后端 |
| --backend | 否 | etcd-store | 元数据存储后端：etcd-store、memory-store、postgres-store、mysql-store 或 raft-engine-store |
| --store-key-prefix | 否 | "" | 元数据存储前缀，参考 Metasrv 配置 |
| --meta-table-name | 否 | greptime_metakv | 当后端为 postgres-store 或 mysql-store 时，元数据存储的表名 |
| --meta-schema-name | 否 | - | 元数据表所在的 PostgreSQL schema，必须与 Metasrv 的 meta_schema_name 配置一致。未设置时使用连接的 search_path。仅在后端为 postgres-store 时使用 |
| --backend-tls-mode | 否 | disable | 连接元数据存储（etcd、PostgreSQL 或 MySQL）的 TLS 模式，需与元数据存储的 TLS 要求一致，可选 disable、prefer、require、verify-ca 或 verify-full |
| --backend-tls-cert-path | 否 | "" | 连接元数据存储时使用的客户端证书文件路径 |
| --backend-tls-key-path | 否 | "" | 连接元数据存储时使用的客户端私钥文件路径 |
| --backend-tls-ca-cert-path | 否 | "" | 连接元数据存储时使用的 CA 证书文件路径 |
| --max-txn-ops | 否 | 128 | 最大事务操作数 |
文件选项
| 选项 | 是否必需 | 默认值 | 描述 |
|---|---|---|---|
| --file-path | 否 | metadata_snapshot.metadata.fb | 快照文件路径 |
| --dir | 否 | / | 文件或对象存储 I/O 使用的根目录 |
对象存储选项
要使用对象存储来存储导出的元数据，请启用以下任一提供商并配置其连接参数：
S3
| 选项 | 是否必需 | 默认值 | 描述 |
|---|---|---|---|
| --s3 | 否 | false | 是否使用 S3 作为导出数据的存储介质 |
| --s3-bucket | 否 | - | S3 桶名 |
| --s3-root | 否 | - | S3 桶中的根路径 |
| --s3-access-key-id | 否 | - | S3 访问密钥 ID |
| --s3-secret-access-key | 否 | - | S3 访问密钥 |
| --s3-region | 否 | - | S3 区域名称 |
| --s3-endpoint | 否 | - | S3 端点 URL（可选，默认根据桶区域确定） |
| --s3-enable-virtual-host-style | 否 | false | 为 S3 API 请求启用虚拟主机样式 |
OSS（阿里云）
| 选项 | 是否必需 | 默认值 | 描述 |
|---|---|---|---|
| --oss | 否 | false | 是否使用 OSS 作为导出数据的存储介质 |
| --oss-bucket | 否 | - | OSS 桶名 |
| --oss-root | 否 | - | OSS 桶中的根路径 |
| --oss-access-key-id | 否 | - | OSS 访问密钥 ID |
| --oss-access-key-secret | 否 | - | OSS 访问密钥 |
| --oss-endpoint | 否 | - | OSS 端点 URL |
GCS（谷歌云存储）
| 选项 | 是否必需 | 默认值 | 描述 |
|---|---|---|---|
| --gcs | 否 | false | 是否使用 GCS 作为导出数据的存储介质 |
| --gcs-bucket | 否 | - | GCS 桶名 |
| --gcs-root | 否 | - | GCS 桶中的根路径 |
| --gcs-scope | 否 | - | GCS 服务范围 |
| --gcs-credential | 否 | - | GCS 凭证内容 |
| --gcs-endpoint | 否 | - | GCS 端点 URL |
Azure Blob 存储
| 选项 | 是否必需 | 默认值 | 描述 |
|---|---|---|---|
| --azblob | 否 | false | 是否使用 Azure Blob 作为导出数据的存储介质 |
| --azblob-container | 否 | - | Azure Blob 容器名称 |
| --azblob-root | 否 | - | 容器中的根路径 |
| --azblob-account-name | 否 | - | Azure Blob 账户名称 |
| --azblob-account-key | 否 | - | Azure Blob 账户密钥 |
| --azblob-endpoint | 否 | - | Azure Blob 端点 URL |
| --azblob-sas-token | 否 | - | Azure Blob SAS 令牌 |
导入工具
命令语法
greptime cli meta snapshot restore [OPTIONS]
选项
存储后端选项
| 选项 | 是否必需 | 默认值 | 描述 |
|---|---|---|---|
| --store-addrs | 是（使用持久化后端时） | - | 元数据存储地址。持久化后端需要设置，格式取决于所选后端 |
| --backend | 否 | etcd-store | 元数据存储后端：etcd-store、memory-store、postgres-store、mysql-store 或 raft-engine-store |
| --store-key-prefix | 否 | "" | 元数据存储的 key 前缀，参考 Metasrv 配置 |
| --meta-table-name | 否 | greptime_metakv | 当后端为 postgres-store 或 mysql-store 时，元数据存储的表名 |
| --meta-schema-name | 否 | - | 元数据表所在的 PostgreSQL schema，必须与 Metasrv 的 meta_schema_name 配置一致。未设置时使用连接的 search_path。仅在后端为 postgres-store 时使用 |
| --backend-tls-mode | 否 | disable | 连接元数据存储（etcd、PostgreSQL 或 MySQL）的 TLS 模式，需与元数据存储的 TLS 要求一致，可选 disable、prefer、require、verify-ca 或 verify-full |
| --backend-tls-cert-path | 否 | "" | 连接元数据存储时使用的客户端证书文件路径 |
| --backend-tls-key-path | 否 | "" | 连接元数据存储时使用的客户端私钥文件路径 |
| --backend-tls-ca-cert-path | 否 | "" | 连接元数据存储时使用的 CA 证书文件路径 |
| --max-txn-ops | 否 | 128 | 最大事务操作数 |
文件选项
| 选项 | 是否必需 | 默认值 | 描述 |
|---|---|---|---|
| --file-path | 否 | metadata_snapshot.metadata.fb | 要恢复的快照文件路径 |
| --dir | 否 | / | 文件或对象存储 I/O 使用的根目录 |
| --force | 否 | false | 是否强制导入，当目标后端检测包含旧数据时，默认无法导入数据，若想强制导入则可开启此标志 |
对象存储选项
要使用对象存储来导入元数据，请启用以下任一提供商并配置其连接参数：
S3
| 选项 | 是否必需 | 默认值 | 描述 |
|---|---|---|---|
| --s3 | 否 | false | 是否使用 S3 作为导出数据的存储介质 |
| --s3-bucket | 否 | - | S3 桶名 |
| --s3-root | 否 | - | S3 桶中的根路径 |
| --s3-access-key-id | 否 | - | S3 访问密钥 ID |
| --s3-secret-access-key | 否 | - | S3 访问密钥 |
| --s3-region | 否 | - | S3 区域名称 |
| --s3-endpoint | 否 | - | S3 端点 URL（可选，默认根据桶区域确定） |
| --s3-enable-virtual-host-style | 否 | false | 为 S3 API 请求启用虚拟主机样式 |
OSS（阿里云）
| 选项 | 是否必需 | 默认值 | 描述 |
|---|---|---|---|
| --oss | 否 | false | 是否使用 OSS 作为导出数据的存储介质 |
| --oss-bucket | 否 | - | OSS 桶名 |
| --oss-root | 否 | - | OSS 桶中的根路径 |
| --oss-access-key-id | 否 | - | OSS 访问密钥 ID |
| --oss-access-key-secret | 否 | - | OSS 访问密钥 |
| --oss-endpoint | 否 | - | OSS 端点 URL |
GCS（谷歌云存储）
| 选项 | 是否必需 | 默认值 | 描述 |
|---|---|---|---|
| --gcs | 否 | false | 是否使用 GCS 作为导出数据的存储介质 |
| --gcs-bucket | 否 | - | GCS 桶名 |
| --gcs-root | 否 | - | GCS 桶中的根路径 |
| --gcs-scope | 否 | - | GCS 服务范围 |
| --gcs-credential | 否 | - | GCS 凭证内容 |
| --gcs-endpoint | 否 | - | GCS 端点 URL |
Azure Blob 存储
| 选项 | 是否必需 | 默认值 | 描述 |
|---|---|---|---|
| --azblob | 否 | false | 是否使用 Azure Blob 作为导出数据的存储介质 |
| --azblob-container | 否 | - | Azure Blob 容器名称 |
| --azblob-root | 否 | - | 容器中的根路径 |
| --azblob-account-name | 否 | - | Azure Blob 账户名称 |
| --azblob-account-key | 否 | - | Azure Blob 账户密钥 |
| --azblob-endpoint | 否 | - | Azure Blob 端点 URL |
| --azblob-sas-token | 否 | - | Azure Blob SAS 令牌 |
信息工具
信息工具允许您查看元数据快照的内容而无需恢复它。
命令语法
greptime cli meta snapshot info [OPTIONS]
选项
文件选项
| 选项 | 是否必需 | 默认值 | 描述 |
|---|---|---|---|
| --file-path | 否 | metadata_snapshot.metadata.fb | 要查看的快照文件路径 |
| --dir | 否 | / | 文件或对象存储 I/O 使用的根目录 |
| --inspect-key | 否 | "*" | 过滤元数据键的查询模式 |
| --limit | 否 | - | 显示的最大条目数 |
对象存储选项
要检查存储在对象存储中的快照，请启用以下任一提供商 并配置其连接参数：
S3
| 选项 | 是否必需 | 默认值 | 描述 |
|---|---|---|---|
| --s3 | 否 | false | 是否使用 S3 作为快照的存储介质 |
| --s3-bucket | 否 | - | S3 桶名 |
| --s3-root | 否 | - | S3 桶中的根路径 |
| --s3-access-key-id | 否 | - | S3 访问密钥 ID |
| --s3-secret-access-key | 否 | - | S3 访问密钥 |
| --s3-region | 否 | - | S3 区域名称 |
| --s3-endpoint | 否 | - | S3 端点 URL（可选，默认根据桶区域确定） |
| --s3-enable-virtual-host-style | 否 | false | 为 S3 API 请求启用虚拟主机样式 |
OSS（阿里云）
| 选项 | 是否必需 | 默认值 | 描述 |
|---|---|---|---|
| --oss | 否 | false | 是否使用 OSS 作为快照的存储介质 |
| --oss-bucket | 否 | - | OSS 桶名 |
| --oss-root | 否 | - | OSS 桶中的根路径 |
| --oss-access-key-id | 否 | - | OSS 访问密钥 ID |
| --oss-access-key-secret | 否 | - | OSS 访问密钥 |
| --oss-endpoint | 否 | - | OSS 端点 URL |
GCS（谷歌云存储）
| 选项 | 是否必需 | 默认值 | 描述 |
|---|---|---|---|
| --gcs | 否 | false | 是否使用 GCS 作为快照的存储介质 |
| --gcs-bucket | 否 | - | GCS 桶名 |
| --gcs-root | 否 | - | GCS 桶中的根路径 |
| --gcs-scope | 否 | - | GCS 服务范围 |
| --gcs-credential | 否 | - | GCS 凭证内容 |
| --gcs-endpoint | 否 | - | GCS 端点 URL |
Azure Blob 存储
| 选项 | 是否必需 | 默认值 | 描述 |
|---|---|---|---|
| --azblob | 否 | false | 是否使用 Azure Blob 作为快照的存储介质 |
| --azblob-container | 否 | - | Azure Blob 容器名称 |
| --azblob-root | 否 | - | 容器中的根路径 |
| --azblob-account-name | 否 | - | Azure Blob 账户名称 |
| --azblob-account-key | 否 | - | Azure Blob 账户密钥 |
| --azblob-endpoint | 否 | - | Azure Blob 端点 URL |
| --azblob-sas-token | 否 | - | Azure Blob SAS 令牌 |