Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/databricks/databricks-sql-go
Golang database/sql driver for Databricks SQL.
https://github.com/databricks/databricks-sql-go
databricks dwh golang golang-library sql
Last synced: 4 days ago
JSON representation
Golang database/sql driver for Databricks SQL.
- Host: GitHub
- URL: https://github.com/databricks/databricks-sql-go
- Owner: databricks
- License: apache-2.0
- Created: 2022-05-18T17:36:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-25T16:02:37.000Z (3 months ago)
- Last Synced: 2025-01-03T20:32:59.387Z (5 days ago)
- Topics: databricks, dwh, golang, golang-library, sql
- Language: Go
- Homepage:
- Size: 2.52 MB
- Stars: 36
- Watchers: 19
- Forks: 40
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Databricks SQL Driver for Go
## Description
This repo contains a Databricks SQL Driver for Go's [database/sql](https://golang.org/pkg/database/sql) package. It can be used to connect and query Databricks clusters and SQL Warehouses.
## Documentation
See `doc.go` for full documentation or the Databrick's documentation for [SQL Driver for Go](https://docs.databricks.com/dev-tools/go-sql-driver.html).
## Usage
```go
import (
"context"
"database/sql"
_ "github.com/databricks/databricks-sql-go"
)
db, err := sql.Open("databricks", "token:********@********.databricks.com:443/sql/1.0/endpoints/********")
if err != nil {
panic(err)
}
defer db.Close()
rows, err := db.QueryContext(context.Background(), "SELECT 1")
defer rows.Close()
```
Additional usage examples are available [here](https://github.com/databricks/databricks-sql-go/tree/main/examples).
### Connecting with DSN (Data Source Name)
The DSN format is:
```
token:[your token]@[Workspace hostname]:[Port number][Endpoint HTTP Path]?param=value
```
You can set query timeout value by appending a `timeout` query parameter (in seconds) and you can set max rows to retrieve per network request by setting the `maxRows` query parameter:
```
token:[your token]@[Workspace hostname]:[Port number][Endpoint HTTP Path]?timeout=1000&maxRows=1000
```
You can turn on Cloud Fetch to increase the performance of extracting large query results by fetching data in parallel via cloud storage (more info [here](https://www.databricks.com/blog/2021/08/11/how-we-achieved-high-bandwidth-connectivity-with-bi-tools.html)). To turn on Cloud Fetch, append `useCloudFetch=true`. You can also set the number of concurrently fetching goroutines by setting the `maxDownloadThreads` query parameter (default is 10):
```
token:[your token]@[Workspace hostname]:[Port number][Endpoint HTTP Path]?useCloudFetch=true&maxDownloadThreads=3
```
### Connecting with a new Connector
You can also connect with a new connector object. For example:
```go
import (
"database/sql"
_ "github.com/databricks/databricks-sql-go"
)
connector, err := dbsql.NewConnector(
dbsql.WithServerHostname(),
dbsql.WithPort(),
dbsql.WithHTTPPath(),
dbsql.WithAccessToken()
)
if err != nil {
log.Fatal(err)
}
db := sql.OpenDB(connector)
defer db.Close()
```
View `doc.go` or `connector.go` to understand all the functional options available when creating a new connector object.
## Develop
### Lint
We use `golangci-lint` as the lint tool. If you use vs code, just add the following settings:
``` json
{
"go.lintTool": "golangci-lint",
"go.lintFlags": [
"--fast"
]
}
```
### Unit Tests
```bash
go test
```
## Issues
If you find any issues, feel free to create an issue or send a pull request directly.
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md)
## License
[Apache 2.0](https://github.com/databricks/databricks-sql-go/blob/main/LICENSE)