mirror of
https://github.com/tursodatabase/limbo.git
synced 2025-08-03 17:48:17 +00:00
40 lines
1.2 KiB
Markdown
40 lines
1.2 KiB
Markdown
# Limbo JDBC Driver
|
|
|
|
The Limbo JDBC driver is a library for accessing and creating Limbo database files using Java.
|
|
|
|
## Project Status
|
|
|
|
The project is actively developed. Feel free to open issues and contribute.
|
|
|
|
To view related works, visit this [issue](https://github.com/tursodatabase/limbo/issues/615).
|
|
|
|
## How to use
|
|
|
|
Currently, we have not published to the maven central. Instead, you can locally build the jar and deploy it to
|
|
maven local to use it.
|
|
|
|
### Build jar and publish to maven local
|
|
|
|
```shell
|
|
$ cd bindings/java
|
|
|
|
# Please select the appropriate target platform, currently supports `macos_x86`, `macos_arm64`, `windows` and `linux_x86`
|
|
$ make macos_x86
|
|
|
|
# deploy to maven local
|
|
$ make publish_local
|
|
```
|
|
|
|
Now you can use the dependency as follows:
|
|
|
|
```kotlin
|
|
dependencies {
|
|
implementation("tech.turso:limbo:0.0.1-SNAPSHOT")
|
|
}
|
|
```
|
|
|
|
## Code style
|
|
|
|
- Favor composition over inheritance. For example, `JDBC4Connection` doesn't implement `LimboConnection`. Instead,
|
|
it includes `LimboConnection` as a field. This approach allows us to preserve the characteristics of Limbo using
|
|
`LimboConnection` easily while maintaining interoperability with the Java world using `JDBC4Connection`.
|