databricks

README

databricks-sdk-golang

This is a Golang SDK for DataBricks REST API 2.0 and Azure DataBricks REST API 2.0.

WARNING: The SDK is unstable and under development. More testing needed!

Usage

import (
  databricks "github.com/polar-rams/databricks-sdk-golang"
  dbAzure "github.com/polar-rams/databricks-sdk-golang/azure"
  // dbAws "github.com/polar-rams/databricks-sdk-golang/aws"
)

opt := databricks.NewDBClientOption("", "", os.Getenv("DATABRICKS_HOST"), os.Getenv("DATABRICKS_TOKEN"))
c := dbAzure.NewDBClient(opt)

jobs, err := c.Jobs().List()

Implementation Progress

API	AWS	Azure
Account API	✗	N/A
Clusters API	✔ (Outdated)	✔
Cluster Policies API	✗	✗
DBFS API	✔ (Outdated)	✔
Global Init Scripts API	✗	✗
Groups API	✔ (Outdated)	✔
Instance Pools API	✗	✔
Instance Profiles API	✔ (Outdated)	N/A
IP Access List API	✗	✗
Jobs API	✔ (Outdated)	✔
Libraries API	✔ (Outdated)	✔
MLflow** API	✗	✗
Permissions API	✗	✗
SCIM** API	✗	✗
Secrets API	✔ (Outdated)	✔
Token API	✔ (Outdated)	✔
Token Management API	✗	✗
Workspace API	✔ (Outdated)	✔

** SCIM and MLflow are separate systems that are planned differently.

Documentation

Index

• Constants
• func PerformQuery(option DBClientOption, method, path string, data interface{}, ...) ([]byte, error)
• type DBClientOption
  • func NewDBClientOption(user, password, host, token string, defaultHeaders map[string]string, ...) *DBClientOption

Constants

const (
	// APIVersion is the version of the RESTful API of DataBricks
	APIVersion = "2.0"
	// SdkVersion is the version of this library
	SdkVersion = "0.1.3"
)

Functions

func PerformQuery

func PerformQuery(option DBClientOption, method, path string, data interface{}, headers map[string]string) ([]byte, error)

PerformQuery can be used in a client or directly

Types

type DBClientOption

type DBClientOption struct {
	User               string
	Password           string
	Host               string
	Token              string
	DefaultHeaders     map[string]string
	InsecureSkipVerify bool
	TimeoutSeconds     int
	// contains filtered or unexported fields
}

DBClientOption is used to configure the DataBricks Client

func NewDBClientOption

func NewDBClientOption(user, password, host, token string, defaultHeaders map[string]string, insecureSkipVerify bool, timeoutSeconds int) *DBClientOption

NewDBClientOption retruns the new DBClientOption