go-hdb

module

v1.12.1 Latest Latest Go to latest Published: Sep 6, 2024 License: Apache-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/SAP/go-hdb

Links

Open Source Insights

README ¶

go-hdb

Go-hdb is a native Go (golang) HANA database driver for Go's sql package. It implements the SAP HANA SQL command network protocol.

For the official SAP HANA client Go support (not this database driver) please see SAP Help Portal.

Installation

go get -u github.com/SAP/go-hdb/driver

Building

To build go-hdb you need to have a working Go environment of the latest or second latest Go version.

Documentation

API documentation and documented examples can be found at https://pkg.go.dev/github.com/SAP/go-hdb/driver.

HANA cloud connection

HANA cloud connection proxy is using SNI which does require a TLS connection. As default one can rely on the root certificate set provided by the host, which already comes with the nessecary DigiCert certificates (CA, G5). For more information on Go tls certificate handling, please see https://pkg.go.dev/crypto/tls#Config.

Assuming the HANA cloud 'endpoint' is "something.hanacloud.ondemand.com:443". Then the dsn should look as follows:

"hdb://<USER>:<PASSWORD>@something.hanacloud.ondemand.com:443?TLSServerName=something.hanacloud.ondemand.com"

with:

TLSServerName same as 'host'

Specific root certificate

In case a specific root certificate (e.g. self-signed) would be needed, the TLSRootCAFile DSN parameter needs to point to the location in the filesystem where a root certificate file in 'pem-format' is stored.

Tests

To run the driver integration tests a HANA Database server is required. The test user must have privileges to create database schemas.

Set environment variable GOHDBDSN:

#linux example
export GOHDBDSN="hdb://user:password@host:port"
go test

Using the Go build tag 'unit' only the driver unit tests will be executed (no HANA Database server required):

go test --tags unit

Features

Native Go implementation (no C libraries, CGO).
Go http://golang.org/pkg/database/sql package compliant.
Support of database/sql/driver Execer and Queryer interface for parameter free statements and queries.
Support of 'bulk' query execution.
Support of UTF-8 to / from CESU-8 encodings for HANA Unicode types.
Built-in support of HANA decimals as Go rational numbers http://golang.org/pkg/math/big.
Support of Large Object streaming.
Support of Stored Procedures with table output parameters.
Support of TLS TCP connections.
Support of little-endian (e.g. amd64) and big-endian architectures (e.g. s390x).
Support of driver connector.
Support of PBKDF2 authentication as default and standard user / password as fallback.
Support of client certificate (X509) and JWT (JSON Web Token) authentication.
Prometheus collectors for driver and extended database statistics.
Support of scanning database rows into go structs.

Dependencies

Please see go.mod.

Licensing

SAP SE or an SAP affiliate company and go-hdb contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
cmd
bulkbench
sniffer
driver Package driver is a native Go SAP HANA driver implementation for the database/sql package.	Package driver is a native Go SAP HANA driver implementation for the database/sql package.
dial Package dial provides types to implement go-hdb custom dialers.	Package dial provides types to implement go-hdb custom dialers.
internal/protocol Package protocol implements the hdb command network protocol.	Package protocol implements the hdb command network protocol.
internal/protocol/auth Package auth provides authentication methods.	Package auth provides authentication methods.
internal/protocol/cache Package cache provides generic cache types.	Package cache provides generic cache types.
internal/protocol/encoding Package encoding implements hdb field type en,- and decodings.	Package encoding implements hdb field type en,- and decodings.
internal/protocol/julian Package julian provided julian time conversion functions.	Package julian provided julian time conversion functions.
internal/protocol/levenshtein Package levenshtein includes the levenshtein distance algorithm plus additional helper functions.	Package levenshtein includes the levenshtein distance algorithm plus additional helper functions.
internal/rand/alphanum Package alphanum implements functions for randomized alphanum content.	Package alphanum implements functions for randomized alphanum content.
internal/types Package types provides database types.	Package types provides database types.
internal/unsafe Package unsafe provides wrapper functions for 'unsafe' type conversions.	Package unsafe provides wrapper functions for 'unsafe' type conversions.
spatial Package spatial implements geo spatial types and functions.	Package spatial implements geo spatial types and functions.
unicode/cesu8 Package cesu8 implements functions and constants to support text encoded in CESU-8.	Package cesu8 implements functions and constants to support text encoded in CESU-8.
prometheus module
sqlscript Package sqlscript provides functions to scan HDBSQL scripts with the help of bufio.Scanner.	Package sqlscript provides functions to scan HDBSQL scripts with the help of bufio.Scanner.