使用限制
数据库用户功能为 Beta 功能,如需使用数据库用户连接,请联系提交工单或联系 ByteHouse 团队获取白名单权限。
环境准备
推荐版本
- Jaspersoft Studio 版本: 6.21.3
- Jasper Server 版本: bitnami/jasperreports:8.1.0
安装 JasperReports
执行下面的命令安装后。在浏览器中打开 http://localhost:8080/ 以访问 JasperServer UI。
docker network create jasperreports-network
docker run -d --name mariadb \
--env ALLOW_EMPTY_PASSWORD=yes \
--env MARIADB_USER=bn_jasperreports \
--env MARIADB_PASSWORD=bitnami \
--env MARIADB_DATABASE=bitnami_jasperreports \
--network jasperreports-network \
--volume /YOUR_MARIADB_DATA_PATH:/bitnami/mariadb \
bitnami/mariadb:latest
docker run -d --name jasperreports \
-p 8080:8080 -p 8443:8443 \
--env JASPERREPORTS_DATABASE_USER=bn_jasperreports \
--env JASPERREPORTS_DATABASE_PASSWORD=bitnami \
--env JASPERREPORTS_DATABASE_NAME=bitnami_jasperreports \
--network jasperreports-network \
--volume /YOUR_JASPERREPORT_DATA_PATH:/bitnami/jasperreports \
bitnami/jasperreports:8.1.0
相关问题可参考官方文档:https://hub.docker.com/r/bitnami/jasperreports
安装 Jaspersoft Studio
下载安装包并执行安装操作,详情请参考官方文档:https://community.jaspersoft.com/download-jaspersoft/community-edition/jaspersoft-studio_6.21.3
Jaspersoft Studio build report
通过 ClickHouse Data Adapter 连接 ByteHouse
填写连接信息:

参数 | 使用 IAM 用户连接 | 使用数据库用户连接 |
---|
Name | 可自定义。 |
JDBC Driver | com.clickhouse.jdbc.ClickHouseDriver
|
JDBC Url | jdbc:clickhouse://<HOST>:8123/<数据库名> 。
- Host:配置为 ByteHouse 的网络域名。您可以在 ByteHouse 控制台的 租户管理>基本信息>网络信息 中查看对应信息。详情请参见 步骤二:配置网络信息。
- 数据库名:您可登录 ByteHouse 控制台,单击顶部数据库,查看并复制数据库名称。
|
Username&Password | - Username 默认为
bytehouse 。 - Password 为 <API_Key>,可以在 ByteHouse 控制台>租户管理>连接信息中获取的 API Key。详情请参见获取 API Key。
| - Username 由 {accountID_or_accountName}::{username}[::{envID}] 构成,详情请参见步骤三:获取 ByteHouse 连接串信息:
- accountID_or_accountName:指火山引擎用户账号 ID 或名称,可登录 ByteHouse 控制台,单击右上角个人中心查看并复制账号ID 或名称。
- username:登录 ByteHouse 数据库账号用户名。可在 ByteHouse 控制台>权限管理>用户>查看数据库用户名。
- envID:可选配置,数据库所在的环境名称。如果使用 default 环境,可不配置,如需使用其他环境,需指定环境名称。您可登录 ByteHouse 控制台,在租户管理>基本信息>**当前环境 **中获取。
- Password:数据库账号的密码由管理员创建数据库账号时自定义配置,您可联系管理员获取密码。如果密码丢失或遗忘,可通联系管理员重置密码,详情请参考重置密码。
|
填写连接属性:
compress:0
server_version:54021
ssl:true

填写驱动文件路径。
请通过链接地址下载到本地,并从本地加载。
测试连接。界面提示 Succeed 表示连接成功。
通过 MySQL Data Adapter 连接 ByteHouse
填写连接信息。
参数 | 使用 IAM 用户连接 | 使用数据库用户连接 |
---|
Name | 可自定义。 |
JDBC Driver | com.mysql.jdbc.Driver
|
JDBC Url | jdbc:clickhouse://<HOST>:3306/<数据库名> 。
- Host:配置为 ByteHouse 的公网连接域名。您可以在 ByteHouse 控制台的 租户管理>基本信息>网络信息 中查看对应信息。详情请参见 步骤二:配置网络信息。
- 数据库名:您可登录 ByteHouse 控制台,单击顶部数据库,查看并复制数据库名称。
|
Username&Password | - Username 默认为
bytehouse 。 - Password 为 <API_Key>,可以在 ByteHouse 控制台>租户管理>连接信息中获取的 API Key。详情请参见获取 API Key。
| - Username 由 {accountID_or_accountName}::{username}[::{envID}] 构成,详情请参见步骤三:获取 ByteHouse 连接串信息:
- accountID_or_accountName:指火山引擎用户账号或名称,可登录 ByteHouse 控制台,单击右上角个人中心查看并复制账号ID 或名称。
- username:登录 ByteHouse 数据库账号用户名。可在 ByteHouse 控制台>权限管理>用户>查看数据库用户名。
- envID:数据库所在的环境名称。可在 ByteHouse 控制台>租户管理>基本信息>当前环境中获取。
- Password:数据库账号的密码由管理员创建数据库账号时自定义配置,您可联系管理员获取密码。如果密码丢失或遗忘,可通联系管理员重置密码,详情请参考重置密码。
|
导入驱动文件。请通过链接地址下载到本地,并从本地加载。
测试连接。界面提示 Succeed 表示连接成功。
Jaspersoft server
准备工作
创建 JasperReport Server
填写连接信息。

参数 | 描述 |
---|
Name | 可自定义。 |
URL | http://<ip>:8080/jasperserver/ ,请填写 Jasper server 的域名或 IP 地址。
|
User | jasperadmin
|
Password | jasperserver password
|
测试连接。界面提示 Succeed 表示连接成功。
创建 ClickHouse 数据源
上传 Clickhouse jdbc 驱动。JDBC 驱动包名: com.clickhouse.jdbc.ClickHouseDriver
驱动下载地址: https://github.com/ClickHouse/clickhouse-java/releases/download/v0.6.3/clickhouse-jdbc-0.6.3-http.jar
填写连接信息。
参数 | 使用 IAM 用户连接 | 使用数据库用户连接 |
---|
Url | jdbc:clickhouse://<HOST>:8123/<数据库名>ssl=true&compress=0&server_version=54021
- Host:配置为 ByteHouse 的公网连接域名。您可以在 ByteHouse 控制台的 租户管理>基本信息>网络信息 中查看对应信息。详情请参见 步骤二:配置网络信息。
- 数据库名:您可登录 ByteHouse 控制台,单击顶部数据库,查看并复制数据库名称。
|
Username&Password | - Username 默认为
bytehouse 。 - Password 为 <API_Key>,可以在 ByteHouse 控制台>租户管理>连接信息中获取的 API Key。详情请参见获取 API Key。
| - Username 由 {accountID_or_accountName}::{username}[::{envID}] 构成,详情请参见步骤三:获取 ByteHouse 连接串信息:
- accountID_or_accountName:指火山引擎用户账号或名称,可登录 ByteHouse 控制台,单击右上角个人中心查看并复制账号ID 或名称。
- username:登录 ByteHouse 数据库账号用户名。可在 ByteHouse 控制台>权限管理>用户>查看数据库用户名。
- envID:数据库所在的环境名称。可在 ByteHouse 控制台>租户管理>基本信息>当前环境中获取。
- Password:数据库账号的密码由管理员创建数据库账号时自定义配置,您可联系管理员获取密码。如果密码丢失或遗忘,可通联系管理员重置密码,详情请参考重置密码。
|
测试连接。界面提示 Succeed 表示连接成功。
保存数据源。
创建 MySQL 数据源
上传驱动。驱动包名: com.mysql.jdbc.Driver
。
驱动下载地址: https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.28/mysql-connector-java-8.0.28.jar
填写连接信息。
参数 | 使用 IAM 用户连接 | 使用数据库用户连接 |
---|
Host | 填写服务器HOST 地址,可参考步骤二:配置网络信息。 |
Port | 3306 |
Database | 您创建的 ByteHouse 数据库名。 |
Url | jdbc:clickhouse://<HOST>:8123/<数据库名>
- Host:配置为 ByteHouse 的公网连接域名。您可以在 ByteHouse 控制台的 租户管理>基本信息>网络信息 中查看对应信息。详情请参见 步骤二:配置网络信息。
- 数据库名:您可登录 ByteHouse 控制台,单击顶部数据库,查看并复制数据库名称。
|
Username&Password | - Username 默认为
bytehouse 。 - Password 为 <API_Key>,可以在 ByteHouse 控制台>租户管理>连接信息中获取的 API Key。详情请参见获取 API Key。
| - Username 由 {accountID_or_accountName}::{username}[::{envID}] 构成,详情请参见步骤三:获取 ByteHouse 连接串信息:
- accountID_or_accountName:指火山引擎用户账号或名称,可登录 ByteHouse 控制台,单击右上角个人中心查看并复制账号ID 或名称。
- username:登录 ByteHouse 数据库账号用户名。可在 ByteHouse 控制台>权限管理>用户>查看数据库用户名。
- envID:数据库所在的环境名称。可在 ByteHouse 控制台>租户管理>基本信息>当前环境中获取。
- Password:数据库账号的密码由管理员创建数据库账号时自定义配置,您可联系管理员获取密码。如果密码丢失或遗忘,可通联系管理员重置密码,详情请参考重置密码。
|
连接测试。界面提示 Succeed 表示连接成功。
保存数据源。
执行查询
自定义查询名称。
选择数据源。
写入 SQL query 语句。
发布 Report
选择 执行查询 章节步骤 2 中创建的数据源。
选择 执行查询 章节步骤 3 中创建的查询。
单击 Finish,即可发布。
您可在 Reports 目录中查看对应的 Report。