ssorm

README

SSORM

SSORM is a simple spanner orm for Golang

Overview

• Feature

  • Insert (Model)
  • Update (Model and Columns and Params)
  • Find (Model)
  • First (Model)
  • Count (Model)
  • Delete (Model and Where)
  • SubQuery (Model)
  • SoftDelete (Insert Update Find First Count Delete SubQuery)
  • SimpleQueryRead
  • SimpleQueryWrite
  • ToRefresh(reflect spanner values (include the generated column) when insert, update, softdelete)

• Supported data type

  • STRING
  • INT64
  • FLOAT64
  • ARRAY
  • BOOL
  • DATE
  • TIMESTAMP

• SSORM Tag

  • primary
  • create_time
  • update_time
  • delete_time
  • ignore_write
  • nullable_write

Test

• Configure spanner-emulator && create instance && create database && insert record

  . ./tests/ddl/create_datbase.sh
  

• Run test

  go test -v ./tests/...
  

Tracing

ssorm.UseTracing()

Additional Tracing Option

import (
  "go.opentelemetry.io/otel/trace"

  "github.com/iwa-inc/ssorm"
  "github.com/iwa-inc/ssorm/ssormotel"
)

func main() {
  ssorm.UseTrace(
    // add attribute 'db.statement'
    ssormotel.WithQueryStatement(),
    // set the created TraceProvider.
    ssormotel.WithTraceProvider(provider trace.TraceProvider),
    // add any attribute
    ssormotel.WithAttributes(
      semconv.DBConnectionStringKey.String("projects/.../instances/.../databases/..."),
      semconv.DBSystemKey.String("Google Cloud Spanner"),
    )
  )
}

License

Copyright (c) 2021 10ANTZ, Inc.

SSORM is released under the MIT License

Documentation

Index

• func LoggerConfig(opts ...logger.Option)
• func SimpleQueryRead(ctx context.Context, spannerTransaction interface{}, query string, ...) error
• func SimpleQueryReadWithOptions(ctx context.Context, spannerTransaction interface{}, query string, ...) error
• func SimpleQueryWrite(ctx context.Context, spannerTransaction *spanner.ReadWriteTransaction, ...) (int64, error)
• func SimpleQueryWriteWithOptions(ctx context.Context, spannerTransaction *spanner.ReadWriteTransaction, ...) (int64, error)
• func UseTrace(opts ...ssormotel.Option)
• type Builder
• type DB
  • func Model(model interface{}, opts ...Option) *DB
  • func SoftDeleteModel(model interface{}, opts ...Option) *DB
  • func (db *DB) AddSub(model interface{}, query interface{}, values ...interface{}) *DB
  • func (db *DB) Count(ctx context.Context, spannerTransaction interface{}, cnt interface{}) error
  • func (db *DB) DeleteModel(ctx context.Context, spannerTransaction *spanner.ReadWriteTransaction) (int64, error)
  • func (db *DB) DeleteWhere(ctx context.Context, spannerTransaction *spanner.ReadWriteTransaction) (int64, error)
  • func (db *DB) Find(ctx context.Context, spannerTransaction interface{}) error
  • func (db *DB) First(ctx context.Context, spannerTransaction interface{}) error
  • func (db *DB) Insert(ctx context.Context, spannerTransaction *spanner.ReadWriteTransaction) (int64, error)
  • func (db *DB) Limit(limit int64) *DB
  • func (db *DB) Offset(offset int64) *DB
  • func (db *DB) Order(order string) *DB
  • func (db *DB) QueryOptions(opt *spanner.QueryOptions) *DB
  • func (db *DB) Select(query []string) *DB
  • func (db *DB) TableName(tableName string) *DB
  • func (db *DB) ToRefresh() *DB
  • func (db *DB) Update(ctx context.Context, spannerTransaction *spanner.ReadWriteTransaction) (int64, error)
  • func (db *DB) UpdateColumns(ctx context.Context, spannerTransaction *spanner.ReadWriteTransaction, ...) (int64, error)
  • func (db *DB) UpdateOmit(ctx context.Context, spannerTransaction *spanner.ReadWriteTransaction, ...) (int64, error)
  • func (db *DB) UpdateParams(ctx context.Context, spannerTransaction *spanner.ReadWriteTransaction, ...) (int64, error)
  • func (db *DB) Where(query interface{}, values ...interface{}) *DB
• type Option
• type SubBuilder

Functions

func LoggerConfig

func LoggerConfig(opts ...logger.Option)

func SimpleQueryRead

func SimpleQueryRead(ctx context.Context, spannerTransaction interface{}, query string, params map[string]interface{}, result interface{}) error

func SimpleQueryReadWithOptions

func SimpleQueryReadWithOptions(ctx context.Context, spannerTransaction interface{}, query string, params map[string]interface{}, result interface{}, queryOpts *spanner.QueryOptions) error

func SimpleQueryWrite

func SimpleQueryWrite(ctx context.Context, spannerTransaction *spanner.ReadWriteTransaction, query string, params map[string]interface{}) (int64, error)

func SimpleQueryWriteWithOptions

func SimpleQueryWriteWithOptions(ctx context.Context, spannerTransaction *spanner.ReadWriteTransaction, query string, params map[string]interface{}, queryOpts *spanner.QueryOptions) (int64, error)

func UseTrace

func UseTrace(opts ...ssormotel.Option)

Types

type Builder

type Builder struct {
	// contains filtered or unexported fields
}

type DB

type DB struct {
	// contains filtered or unexported fields
}

func Model

func Model(model interface{}, opts ...Option) *DB

func SoftDeleteModel

func SoftDeleteModel(model interface{}, opts ...Option) *DB

func (*DB) AddSub

func (db *DB) AddSub(model interface{}, query interface{}, values ...interface{}) *DB

func (*DB) Count

func (db *DB) Count(ctx context.Context, spannerTransaction interface{}, cnt interface{}) error

func (*DB) DeleteModel

func (db *DB) DeleteModel(ctx context.Context, spannerTransaction *spanner.ReadWriteTransaction) (int64, error)

func (*DB) DeleteWhere

func (db *DB) DeleteWhere(ctx context.Context, spannerTransaction *spanner.ReadWriteTransaction) (int64, error)

func (*DB) Find

func (db *DB) Find(ctx context.Context, spannerTransaction interface{}) error

func (*DB) First

func (db *DB) First(ctx context.Context, spannerTransaction interface{}) error

func (*DB) Insert

func (db *DB) Insert(ctx context.Context, spannerTransaction *spanner.ReadWriteTransaction) (int64, error)

func (*DB) Limit

func (db *DB) Limit(limit int64) *DB

func (*DB) Offset

func (db *DB) Offset(offset int64) *DB

func (*DB) Order

func (db *DB) Order(order string) *DB

func (*DB) QueryOptions

func (db *DB) QueryOptions(opt *spanner.QueryOptions) *DB

func (*DB) Select

func (db *DB) Select(query []string) *DB

func (*DB) TableName

func (db *DB) TableName(tableName string) *DB

func (*DB) ToRefresh

func (db *DB) ToRefresh() *DB

func (*DB) Update

func (db *DB) Update(ctx context.Context, spannerTransaction *spanner.ReadWriteTransaction) (int64, error)

func (*DB) UpdateColumns

func (db *DB) UpdateColumns(ctx context.Context, spannerTransaction *spanner.ReadWriteTransaction, in []string) (int64, error)

func (*DB) UpdateOmit

func (db *DB) UpdateOmit(ctx context.Context, spannerTransaction *spanner.ReadWriteTransaction, in []string) (int64, error)

func (*DB) UpdateParams

func (db *DB) UpdateParams(ctx context.Context, spannerTransaction *spanner.ReadWriteTransaction, in map[string]interface{}) (int64, error)

func (*DB) Where

func (db *DB) Where(query interface{}, values ...interface{}) *DB

type Option

type Option func(*DB)

type SubBuilder

type SubBuilder struct {
	// contains filtered or unexported fields
}