go-hdb

module

v0.111.0 Latest Latest Go to latest Published: Nov 22, 2022 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

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. To connect successfully you would need a valid root certificate in pem format (please see SAP Help).

The certificate (DigiCertGlobalRootCA.crt.pem) can be downloaded in 'pem-format' from digicert.

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&TLSRootCAFile=<PATH TO CERTIFICATE>/DigiCertGlobalRootCA.crt.pem"

or

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

with:

TLSServerName same as 'host'
TLSRootCAFile needs to point to the location in your filesystem where the file DigiCertGlobalRootCA.crt.pem is stored

When omitting the TLSRootCAFile, TLS uses the host's root CA set (for more information please see Config RootCAs.

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.

Dependencies

Please see go.mod.

Licensing

Copyright 2014-2022 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/errors Package errors defines errors used in different driver packages.	Package errors defines errors used in different driver packages.
internal/logflag Package logflag provides a boolean flag to use with log enablement.	Package logflag provides a boolean flag to use with log enablement.
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/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/scanner Package scanner implements a HANA SQL query scanner.	Package scanner implements a HANA SQL query scanner.
internal/protocol/x509 Package x509 provides X509 certificate methods.	Package x509 provides X509 certificate methods.
spatial Package spatial implements geo spatial types and functions.	Package spatial implements geo spatial types and functions.
sqltrace Package sqltrace implements driver sql trace functions.	Package sqltrace implements driver sql trace 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
collectors Package collectors provides prometheus collectors for driver and extended database statistics.	Package collectors provides prometheus collectors for driver and extended database statistics.