appbaseio/abc

ABC Docker镜像文档

镜像概述和主要用途

ABC是一个命令行工具，主要用于与appbase.io交互，同时也可作为数据导入工具，支持从多种流行数据源（如Postgres、SQL、Mongo等）导入数据到ElasticSearch。该工具配置简单、自动化程度高，部分数据源（如Postgres和Mongo）还支持实时同步功能，确保数据源的变更能实时同步到ElasticSearch集群。

ABC包含两个核心模块：

• Appbase模块：用于管理appbase.io账户及应用
• 导入模块（闭源）：处理数据导入和同步功能

核心功能和特性

主要优势

• 多数据源支持：可从Postgres、MongoDB、JSON文件、CSV、MySQL、SQLServer、Kafka及Elasticsearch本身导入数据到ElasticSearch
• 实时同步：支持Postgres和MongoDB与ElasticSearch集群的实时同步，数据源变更自动同步至目标
• 简单易用：通过abc import单命令即可完成数据导入，无需外部依赖，零代码配置，资源占用低
• 数据转换：支持用户自定义JavaScript转换逻辑，可在数据索引前进行数据类型映射、列转换或数据处理

使用场景和适用范围

• 数据迁移：将不同数据库（Postgres、Mongo等）或文件（CSV、JSON）中的数据迁移至ElasticSearch
• 实时数据同步：需要保持数据库与ElasticSearch集群数据一致性的场景（如实时搜索、数据分析）
• appbase.io管理：通过命令行管理appbase.io账户、应用的创建、删除、查看等操作

使用方法和配置说明

前提条件

• Docker环境
• 网络连接（用于拉取镜像和访问appbase.io服务）

Docker镜像获取

sh
docker pull appbaseio/abc

数据持久化

创建卷以在容器间持久化配置文件：

sh
docker volume create --name abc

基本使用

通过Docker运行ABC命令：

sh
docker run -i --rm -v abc:/root appbaseio/abc [命令]

设置别名（推荐）

为简化命令，可创建别名：

sh
alias abc='docker run -i --rm -v abc:/root appbaseio/abc'

常用命令示例

sh
# 查看所有支持的命令
abc --help

# 登录appbase.io（支持google等方式）
abc login google

# 获取用户信息
abc user

# 列出用户应用
abc apps

# 查看指定应用详情
abc app MyAppName

# 创建应用
abc create MyAppName

# 删除应用
abc delete MyAppName

# 导入数据（示例：从Postgres导入到ElasticSearch）
abc import postgres://user:pass@host:port/db elasticsearch://user:pass@host:port/index

开发设置

本地构建

需Go 1.8及以上环境：

sh
go get github.com/appbaseio/abc
cd $GOPATH/src/github.com/appbaseio/abc
go build -tags 'oss' ./cmd/abc/...
./abc --help

Docker构建

sh
git clone https://github.com/appbaseio/abc
cd abc
docker build --build-arg ABC_BUILD=oss -t abc .
docker volume create --name abc

构建变体

• 开源版（oss）：通过-tags 'oss'构建，版本信息显示(oss)
• 专有版（!oss）：包含abc import命令，版本信息显示(!oss)，beta阶段免费使用

可通过abc version查看构建变体。

资源和许可

文档资源

详细命令文档见https://github.com/appbaseio/abc/tree/master/docs%E3%80%82

贡献指南

贡献说明见https://github.com/appbaseio/abc/blob/master/CONTRIBUTING.md%E3%80%82

许可信息

• 开源版（oss）：采用Apache 2.0许可，详见https://github.com/appbaseio/abc/blob/master/LICENSE
• 专有版（!oss）：包含abc import命令，beta阶段免费使用