使用指南

快速开始

XLSQL 允许您像操作数据库一样操作 Excel 文件。只需几个简单的步骤即可集成到您的 Java 项目中。

依赖配置

XLSQL 5.1.1 已发布到 Maven Central,您可以直接通过 Maven 依赖使用。

在您的 pom.xml 中添加以下依赖:

<dependency>
    <groupId>io.github.daichangya</groupId>
    <artifactId>xlsql</artifactId>
    <version>5.1.1</version>
</dependency>

在 Maven Central 查看

JDBC 使用示例

XLSQL 完全遵循 JDBC 标准,以下是一个完整的查询示例:

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.Statement;

public class ExcelQuery {
    public static void main(String[] args) throws Exception {
        // 1. 注册驱动
        Class.forName("io.github.daichangya.xlsql.jdbc.xlDriver");

        // 2. 创建连接
        // URL 格式: jdbc:xlsql:excel:/path/to/directory
        String url = "jdbc:xlsql:excel:/data/excel_files";
        try (Connection conn = DriverManager.getConnection(url);
             Statement stmt = conn.createStatement()) {
            
            // 3. 执行查询
            // 表名格式: "文件名.工作表名" (注意引号)
            String sql = "SELECT * FROM sales_2024_Sheet1 WHERE amount > 1000";
            try (ResultSet rs = stmt.executeQuery(sql)) {
                while (rs.next()) {
                    System.out.println("Customer: " + rs.getString("Customer"));
                    System.out.println("Amount: " + rs.getDouble("Amount"));
                }
            }
        }
    }
}

配置说明

您可以通过环境变量或系统属性来配置 XLSQL。

环境变量

变量名 描述
XLSQL_CONFIG_PATH 配置文件路径
XLSQL_LOG_PATH 日志文件路径

配置文件 (xlsql_config.properties)

默认位置:~/.xlsql/xlsql_config.properties

# 数据库引擎 (hsqldb, h2 或 native)
engine=hsqldb

# HSQLDB 配置
hsqldb.url=jdbc:hsqldb:mem:xlsql
hsqldb.user=sa
hsqldb.password=

# H2 配置(可选)
h2.url=jdbc:h2:mem:xlsql
h2.user=sa
h2.password=

常见问题

解决: 确保 XLSQL JAR 包已正确添加到项目的 classpath 中。如果是 Maven 项目,请检查依赖是否下载成功。

解决: 检查 JDBC URL 中的路径是否正确。确保该路径在文件系统中存在,且应用程序有读取权限。

解决:
  • 确保 Excel 文件存在于连接的目录中。
  • 表名格式必须为 "文件名.工作表名",例如 "test_Sheet1"
  • 文件名不包含扩展名(.xls/.xlsx)。
  • 注意 SQL 中的引号和大小写敏感性。