https://github.com/rockset/rockset-java-client
Official Java client library and JDBC driver for Rockset
https://github.com/rockset/rockset-java-client
client java realtime-database rockset
Last synced: 5 months ago
JSON representation
Official Java client library and JDBC driver for Rockset
- Host: GitHub
- URL: https://github.com/rockset/rockset-java-client
- Owner: rockset
- License: apache-2.0
- Created: 2018-10-03T02:34:00.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-11T20:25:30.000Z (about 2 years ago)
- Last Synced: 2025-08-01T22:29:07.823Z (11 months ago)
- Topics: client, java, realtime-database, rockset
- Language: Java
- Homepage:
- Size: 29.2 MB
- Stars: 10
- Watchers: 36
- Forks: 5
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# rockset-java-client
Official Java client library and JDBC driver for Rockset.
## Requirements
Building the API client library requires:
1. Java 1.8
2. Maven
## Installation
Set ROCKSET_APIKEY to run tests along with installation:
```
mvn package
```
To skip the tests:
```
mvn package -DskipTests
```
This will create a jar file rockset-java-${version}.jar
### Usage
Add this dependency to your project's POM:
```xml
com.rockset
rockset-java
...
```
You can see a few [sample examples](https://github.com/rockset/rockset-java-client/blob/master/src/main/java/com/rockset/examples) of how to create a collection, how to put documents in a collection and how to use SQL to query your collections. There are also a set of [javadocs](https://rockset.com/docs/client/java/) that you can look to build your application.
## Testing
Set ROCKSET_APIKEY with the API key in the environment variables. To run test:
```
mvn test
```
## Scala Considerations
If using [Scala](https://www.scala-lang.org/), we recommend converting scala map and object types to java maps and collections (e.g. `java.util.LinkedHashMap`) rather than using the native Scala types with this java client.
## Support
Feel free to log issues against this client through GitHub.
## JDBC
The Rockset JDBC driver is packaged as part of this java client. Here is an [one example](https://github.com/rockset/rockset-java-client/blob/master/src/test/java/com/rockset/jdbc/FirstExample.java) that shows how to use it.
## License
The Rockset Java Client is licensed under the [Apache 2.0 License](https://github.com/rockset/rockset-java-client/blob/master/LICENSE)