timestreamdriver

README

go-aws-timestream-driver

go get github.com/aereal/go-aws-timestream-driver

Usage

import (
  "database/sql"

  "github.com/aereal/go-aws-timestream-driver"
)

func main() {
  sql.Open(timestreamdriver.DriverName, "awstimestream:///")
}

See also Data Source Name format section.

Data Source Name format

In URI template normative definition:

awstimestream://{customEndpointHost}/{?region,accessKeyID,secretAccessKey,enableXray}

Example:

awstimestream://custom-endpoint.example/?region=us-east-1&accessKeyID=my-key&enableXray=true

License

See LICENSE file.

Documentation

Index

• Constants
• Variables
• func Array(x interface{}) customType
• type BareStringValue
  • func (BareStringValue) IsBareValue()
  • func (bsv BareStringValue) Value() (driver.Value, error)
• type BooleanArray
  • func (a *BooleanArray) Scan(src interface{}) error
• type Config
  • func ParseDSN(dsn string) (*Config, error)
• type Driver
  • func (d *Driver) Open(dsn string) (driver.Conn, error)
  • func (d *Driver) OpenConnector(dsn string) (driver.Connector, error)
• type FloatArray
  • func (a *FloatArray) Scan(src interface{}) error
• type IntegerArray
  • func (a *IntegerArray) Scan(src interface{}) error
• type StringArray
  • func (a *StringArray) Scan(src interface{}) error

Constants

const (
	// DriverName is name of the driver that this package provides
	DriverName = "awstimestream"
)

Variables

var (
	// ErrTooFewParameters is an error indicates number of passed parameters less than query's placeholders.
	// It may be returned by Rows.QueryContext().
	ErrTooFewParameters = errors.New("too few parameters passed")
)

Functions

func Array

func Array(x interface{}) customType

Array converts `x` into corresponding concrete scannable types.

Types

type BareStringValue

type BareStringValue struct {
	Bare string
}

BareStringValue is a string parameter but not quoted. You can wrap interval literal with this type and then embed interval literal into query.

func (BareStringValue) IsBareValue

func (BareStringValue) IsBareValue()

func (BareStringValue) Value

func (bsv BareStringValue) Value() (driver.Value, error)

type BooleanArray

type BooleanArray []bool

BooleanArray is a wrapper type of []bool that scannable by database/sql

func (*BooleanArray) Scan

func (a *BooleanArray) Scan(src interface{}) error

type Config

type Config struct {
	Endpoint           string
	Region             string
	CredentialProvider credentials.Provider
	EnableXray         bool
}

func ParseDSN

func ParseDSN(dsn string) (*Config, error)

type Driver

type Driver struct{}

func (*Driver) Open

func (d *Driver) Open(dsn string) (driver.Conn, error)

func (*Driver) OpenConnector

func (d *Driver) OpenConnector(dsn string) (driver.Connector, error)

type FloatArray

type FloatArray []float64

FloatArray is a wrapper type of []float64 that scannable by database/sql

func (*FloatArray) Scan

func (a *FloatArray) Scan(src interface{}) error

type IntegerArray

type IntegerArray []int

IntegerArray is a wrapper type of []int that scannable by database/sql

func (*IntegerArray) Scan

func (a *IntegerArray) Scan(src interface{}) error

type StringArray

type StringArray []string

StringArray is a wrapper type of []string that scannable by database/sql

func (*StringArray) Scan

func (a *StringArray) Scan(src interface{}) error