machbase/machbase-neo

Machbase Neo

https://hub.docker.com/r/machbase/machbase 是全球最快的IoT时序数据库，采用C++实现。machbase-neo是一款IoT数据库服务器，嵌入了Machbase引擎，提供MQTT和HTTP API等必要且便捷的功能，用于构建IoT平台。它可安装在从树莓派到高性能服务器的各类设备上。

快速参考

• 如何通过Docker快速开始使用machbase-neo：
  ([***]
• 支持的操作系统/架构：
  linux/amd64、linux/arm64
• Machbase-neo文档
  ([***]
• 联系Machbase
  ([***]

快速开始

通过Docker运行Machbase Neo非常简单，按以下步骤操作。

在后台运行machbase-neo

sh
$ docker run -d                     \
             -p 5652:5652/tcp       \
             -p 5654:5654/tcp       \
             --name machbase-neo    \
             machbase/machbase-neo

也可以在前台运行，但这种情况下需要准备另一个终端。

sh
$ docker run -it                    \
             -p 5652:5652/tcp       \
             -p 5654:5654/tcp       \
             --name machbase-neo    \             
             machbase/machbase-neo

两种方式都会自动启动machbase-neo。

进入Machbase Neo Shell

直接访问Machbase Neo Shell：

sh
$ docker exec -it machbase-neo /opt/machbase-neo shell

也可通过SSH访问：

• 默认用户：SYS
• 默认密码：manager

sh
$ ssh -p 5652 sys@127.0.0.1
sys@127.0.0.1's password: manager

出现machbase-neo»提示符后，用户可使用SQL语句进行查询：

sh
machbase-neo» create tag table example (name varchar(20) primary key, time datetime basetime, value double summarized);
executed.
machbase-neo» show tables;
┌────────────────────────────────┐
│ ROWNUM │ DB         │ USER │ NAME    │ TYPE      │
├──────────────────────────────
│      1 │ MACHBASEDB │ SYS  │ EXAMPLE │ Tag Table │
└────────────────────────────────┘

使用SSH密钥远程访问machbase-neo shell

连接machbase-neo shell前，需生成SSH密钥：

sh
$ ssh-keygen -t rsa

创建SSH密钥后，在不同环境中运行machbase-neo：

sh
$ docker pull machbase/machbase-neo
$ docker run -d \
             -p 5652-5656:5652-5656/tcp \
             --name machbase-neo \
             machbase/machbase-neo

默认情况下，每次通过SSH连接都需要输入密码。但通过在machbase-neo shell中注册密钥，可设置为只需输入一次密码：

sh
$ ssh -l sys -p 5652 192.168.0.116 ssh-key add `cat ~/.ssh/id_rsa.pub`
sys@192.168.0.116's password? manager
Add sshkey success

之后无需每次输入密码即可访问。

示例

sh
$ ssh -l sys -p 5652 192.168.0.116 'create table example (v1 int)';
executed.

$ ssh -l sys -p 5652 192.168.0.116 'show tables';
┌────────────────────────────────┐
│ ROWNUM │ DB         │ USER │ NAME    │ TYPE      │
├────────────────────────────────┤
│      1 │ MACHBASEDB │ SYS  │ EXAMPLE │ Log Table │
└────────────────────────────────┘

访问内部网站并发送查询

如果映射了容器的5654端口，可访问以下网站：

• [***]

该网站提供多种功能，详情点击此处。

此外，可使用HTTP直接向数据库发送查询：

sh
$ curl -o - http://127.0.0.1:5654/db/query \
            --data-urlencode               \
            "q=drop table example"

如需使用更多API或SQL，点击此处。

配置

卷挂载

可将Docker中machbase-neo的主路径与主机目录绑定：

sh
docker run -d \
           -v /path/to/host/data:/data \
           -v /path/to/host/file:/file \
           machbase/machbase-neo

• /data：Docker中machbase-neo的主路径
• /file：Docker中machbase-neo的tql路径
• -v/--volume：绑定挂载卷

即使Docker停止，挂载卷的主机目录仍会保留。

暴露端口

Machbase-neo在Docker中暴露多个端口：

运行machbase-neo容器时，可按如下方式将主机端口映射到容器端口：

sh
$ docker run -d                       \
             -p 5652:5652             \
             -p 5653:5653             \
             -p 5654:5654             \
             -p 5655:5655             \
             -p 5656:5656             \
             --name machbase-neo      \
             machbase/machbase-neo

此配置下，所有发送到主机端口的请求都会转发到容器端口。

通过Docker Compose

将以下内容保存为docker-compose.yml并放在项目根目录：

yml
# docker-compose.yml
version: '3'
services:
  machbase-neo:
    image: machbase/machbase-neo
    container_name: machbase-neo
    hostname: machbase
    volumes:
      - /data:/data
      - /file:/file
    ports:
      - "5652:5652" # sshd
      - "5653:5653" # mqtt
      - "5654:5654" # http
      - "5655:5655" # grpc
      - "5656:5656" # database engine

在项目根目录执行：

sh
$ docker compose up -d

或：

sh
$ docker compose -f docker-compose.yml up -d

如需关闭Docker Compose：

sh
$ docker compose down

所有服务将优雅关闭。