Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 1.7 KB

README.md

File metadata and controls

59 lines (39 loc) · 1.7 KB
Raw

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:

<dependency>
  <groupId>com.rockset</groupId>
  <artifactId>rockset-java</artifactId>
  <version>...</version>
</dependency>

You can see a few sample 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 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, 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 that shows how to use it.

License

The Rockset Java Client is licensed under the Apache 2.0 License