Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/linux-china/chdb-java-ffm
chdb with Java FFM(Foreign Function & Memory) binding
https://github.com/linux-china/chdb-java-ffm
chdb clickhouse ffi
Last synced: about 2 months ago
JSON representation
chdb with Java FFM(Foreign Function & Memory) binding
- Host: GitHub
- URL: https://github.com/linux-china/chdb-java-ffm
- Owner: linux-china
- License: apache-2.0
- Created: 2024-08-27T12:28:38.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-10-17T05:47:23.000Z (3 months ago)
- Last Synced: 2024-10-19T08:03:12.043Z (3 months ago)
- Topics: chdb, clickhouse, ffi
- Language: Java
- Homepage:
- Size: 107 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
chdb Java FFM binding
======================
chdb-java-ffm is Java 22+ [JEP 454: Foreign Function & Memory API](https://openjdk.org/jeps/454) bind for [chdb](https://github.com/chdb-io).
# Get started
- Please add the following dependency to `pom.xml`:
```xml
org.mvnsearch
chdb-java-ffm
0.2.0
```
- Download chdb dynamic library by executing `update_libchdb.sh` script, or download from https://github.com/chdb-io/chdb/releases.
- Write your first test:
```java
public class ChdbConnectionTest {
@AutoClose
private static Connection conn;
@BeforeAll
public static void setUp() throws Exception {
String url = "jdbc:chdb::memory:";
conn = DriverManager.getConnection(url);
}
@Test
public void testConnection() throws SQLException {
String sql = "select * from file('src/test/resources/logs.csv','CSV')";
Statement statement = conn.createStatement();
ResultSet resultSet = statement.executeQuery(sql);
while (resultSet.next()) {
System.out.println(resultSet.getString("level"));
}
}
}
```
# chdb JDBC
JDBC URLs:
- `jdbc:chdb::memory:`: in-memory database, path is **`:memory:`**
- `jdbc:chdb:/path/to/db`: database from file path, and both relative and absolute paths supported.
# Development setup
- Download and install [JDK 22](https://jdk.java.net/22/)
- Download and install [jextract](https://jdk.java.net/jextract/)
- Execute `update_libchdb.sh` to download dynamic library
# FAQ
### How to load dynamic library from other path?
Execute `ln -s /usr/local/lib/libchdb.so libchdb.dylib` to link the dynamic library to the current directory.
### Update operation support?
Now only query support, and update will be implemented in the future.
### PreparedStatement support?
Now PreparedStatement implement is not real, just fake implement friendly for libraries and frameworks.
### Spring Jdbc support?
Yes, you can use `JdbcTemplate` with chdb-java-ffm.
### How it works?
Java -> FFM -> chdb(embedded) -> JSON Output -> ResultSet.
**Attention**: chdb-java-ffm uses Jackson for JSON parsing.
# References
* [JEP 454](https://openjdk.org/jeps/454): Foreign Function & Memory API
* [jextract](https://jdk.java.net/jextract/): a tool which mechanically generates Java bindings from native library headers
* [chdb-java](https://github.com/chdb-io/chdb-java): chdb JNI version
* [clickhouse-java](https://github.com/ClickHouse/clickhouse-java): Java client and JDBC driver for ClickHouse