dyndb

Dynamodb SQL Driver

This library is compatible with Go 1.17+

Please refer to CHANGELOG.md if you encounter breaking changes.

Please refer to CHANGELOG.md if you encounter breaking changes.

• DSN
• Usage
• Benchmark
• Bugs
• License
• Credits and Acknowledgements

This library provides fast implementation of the DynamoDB as a database/sql driver. For most of the operation this driver uses PartiSQL with ability to define custom functions.

DSN Data Source Name

The Dynamodb driver accepts the following DSN

• 'dynamodb://aws|{dockerEndpoint}/{region}/[{options}]'

  Where queryString can optionally configure the following option:

  • key: access key id
  • secret: access key secret
  • credURL: (url encoded) local location or URL supported by Scy
  • credKey: optional (url encoded) Scy secret manager key or key location
  • credID: Scy resource secret ID
  • roleArn, session to use assumed role

Usage:

The following is a very simple example of query operation

package main

import (
  "context"
  "database/sql"
  "encoding/json"
  "fmt"
  "log"
  _ "github.com/viant/dyndb"
  "time"
)

type Publication struct {
  ISBN      string
  Name      string
  IsTravel  bool
  IsFinance bool
}

func main() {

  db, err := sql.Open("dynamodb", "dynamodb://localhost:8000/us-west-1?key=dummy&secret=dummy")
  if err != nil {
    log.Fatalln(err)
  }
  defer db.Close()
  SQL := `SELECT ISBN, Name,
		ARRAY_EXISTS(Categories, 'TRAVEL') AS IS_TRAVEL ,
		ARRAY_EXISTS(Categories, 'FINANCE') AS IS_FINANCE
	FROM Publication`

  ctx, cancel := context.WithTimeout(context.Background(), time.Second*10)
  defer cancel()
  stmt, err := db.PrepareContext(ctx, SQL)
  if err != nil {
    log.Fatalln(err)
  }
  rows, err := stmt.Query()
  if err != nil {
    log.Fatalln(err)
  }
  var records []*Publication
  for rows.Next() {
    record := &Publication{}
    err = rows.Scan(&record.ISBN, &record.Name, &record.IsFinance, &record.IsTravel)
    if err != nil {
      log.Fatalln(err)
    }
    records = append(records, record)
  }
  data, _ := json.Marshal(records)
  fmt.Printf("%s\n", data)

}

Benchmark

Benchmark runs times the following query:

• QueryAll: (fetches 1000 records)

   SELECT id, state,gender,year,name, number  FROM usa_names

BenchmarkDatabaseSQL_QueryAll
BenchmarkDatabaseSQL_QueryAll-16       	      80	  14983399 ns/op	 1080045 B/op	   18194 allocs/op
BenchmarkAwsSDK_QueryAll
BenchmarkAwsSDK_QueryAll-16            	      54	  19998584 ns/op	 3654102 B/op	   51359 allocs/op

• QuerySingle: (fetches 1 record)

   SELECT id, state,gender,year,name, number  FROM usa_names WHERE id = 1

  BenchmarkDatabaseSQL_QuerySingle
  BenchmarkDatabaseSQL_QuerySingle-16    	     726	   1651893 ns/op	   24465 B/op	     333 allocs/op
  BenchmarkAwsSDK_QuerySingle
  BenchmarkAwsSDK_QuerySingle-16         	     795	   1682389 ns/op	   29651 B/op	     374 allocs/op

In both case database/sql driver is faster and allocate way less memory than native AWS SDK client

Bugs

This package implement only basic SQL with limited functionality. It extends original PartiSQL with extra client side functionality. Contributors are welcome.

License

The source code is made available under the terms of the Apache License, Version 2, as stated in the file LICENSE.

Individual files may be made available under their own specific license, all compatible with Apache License, Version 2. Please see individual files for details.

Credits and Acknowledgements

Library Author:

Contributors: