https://github.com/edmunds/databricks-rest-client
https://github.com/edmunds/databricks-rest-client
databricks rest-client
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/edmunds/databricks-rest-client
- Owner: edmunds
- License: apache-2.0
- Created: 2018-08-17T00:49:37.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2026-01-09T17:34:10.000Z (4 months ago)
- Last Synced: 2026-01-11T19:49:37.663Z (4 months ago)
- Topics: databricks, rest-client
- Language: Java
- Size: 449 KB
- Stars: 28
- Watchers: 21
- Forks: 21
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Databricks Java Rest Client
> [!WARNING]
> **This project is deprecated and will be archived on March 2, 2026.**
>
> This repository is no longer actively maintained. We recommend users migrate to alternative solutions for accessing the Databricks REST API. No new features will be added.
_This is a simple java library that provides programmatic access to the [Databricks Rest Service](https://docs.databricks.com/api/latest/index.html)._
NOTE: that the project used to be under the groupId _com.edmunds.databricks_
It is now under _com.edmunds_.
At some point we will plan on deleting the old artifacts from maven-central.
## Build Status
[](https://travis-ci.org/edmunds/databricks-rest-client)
## API Overview
[](http://www.javadoc.io/doc/com.edmunds/databricks-rest-client)
This library only implements a percentage of all of the functionality that the Databricks Rest Interface provides.
The idea is to add functionality as users of this library need it.
Here are the current Endpoints that are supported:
- Cluster Service
- DBFS Service
- Groups Service
- Instance Profiles Service
- Job Servicev21
- Library Service
- Workspace Service
- Groups Service
- Instance Profiles Service
- SCIM (preview mode, subject to changes)
Please look at the javadocs for the specific service to get more detailed information on what
functionality is currently available.
If there is important functionality that is currently missing, please create a github issue.
## Examples
```java
public class MyClient {
public static void main(String[] args) throws DatabricksRestException, IOException {
// Construct a serviceFactory using token authentication
DatabricksServiceFactory serviceFactory =
DatabricksServiceFactory.Builder
.createServiceFactoryWithTokenAuthentication("myToken", "myHost")
.withMaxRetries(5)
.withRetryInterval(10000L)
.build();
// Lets get our databricks job "myJob" and edit maxRetries to 5
JobDTOv21 jobDTO = serviceFactory.getJobServiceV21().getJobByName("myJob");
JobSettingsDTOv21 jobSettingsDTO = jobDTO.getSettings();
jobSettingsDTO.setMaxRetries(5);
serviceFactory.getJobServiceV21().upsertJob(jobSettingsDTO, true);
// Lets install a jar to a specific cluster
LibraryDTO libraryDTO = new LibraryDTO();
libraryDTO.setJar("s3://myBucket/myJar.jar");
for (ClusterInfoDTO clusterInfoDTO : serviceFactory.getClusterService().list()) {
if (clusterInfoDTO.getClusterName().equals("myCluster")) {
serviceFactory.getLibraryService().install(clusterInfoDTO.getClusterId(), new LibraryDTO[]{libraryDTO});
}
}
}
}
```
For more examples, take a look at the service tests.
## Building, Installing and Running
### Getting Started and Prerequisites
- You will need Maven installed
- Not required! Because you can build and develop without it, but you will likely want Lombok configured with your IDEA:
https://projectlombok.org/setup/intellij
### Building
*How to build the project locally:*
```mvn clean install```
## Unit Tests
There are currently no unit tests for this project. Our thoughts are that the only testable
functionality is the integration between our client on an actual databricks instance.
As such we currently only have integration tests.
## Integration Tests
IMPORTANT: integration tests do not execute automatically as part of a build.
It is your responsibility (and Pull Request Reviewers) to make sure the integration tests
pass before merging in code.
### Setup
You need to set the following environment properties in your .bash_profile
```bash
export DB_URL=my-databricks-account.databricks.com
export DB_TOKEN=my-token
```
In order for the integration tests to run, you must
have a valid token for the user in question.
Here is how to set it up: [Set up Tokens](https://docs.databricks.com/api/latest/authentication.html)
Note: In order to run the SCIM integration tests your user should have admin rights
### Executing Integration Tests
mvn clean install org.apache.maven.plugins:maven-failsafe-plugin:integration-test
## Deployment
Please see the CONTRIBUTING.md about our release process.
As this is a library, there is no deployment operation needed.
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for the process for merging code into master.