dalgo2sql

README

dalgo2sql

SQL adapter for DALgo - a Database Abstraction Layer in Go.

Status

Usage

go get github.com/dal-go/dalgo2sql

End2end - is a separate module

For end-to-end testing a SQLite driver is used. To avoid bringing a dependency to SQLite into the consumers of dalgo2sql, the end2end tests are in a separate module.

This is an unusual approach, as usually you would want to bring dependency to underlying driver with a dalgo adapter. But this is not a case for this adapter as database/sql that is referenced by dalgo2sql is an abstraction layer and consumer is free to choose the underlying driver.

License

Free to use and open source under MIT License.

Documentation

Index

• Constants
• func NewDatabase(db *sql.DB, schema dal.Schema, options DbOptions) dal.DB
• func NewSimpleSchema(idFieldName string) dal.Schema
• type DbOptions
  • func (o DbOptions) GetRecordsetByKey(key *dal.Key) *Recordset
  • func (o DbOptions) PrimaryKeyFieldNames(key *dal.Key) (primaryKey []string)
• type Field
  • func (v Field) String() string
• type Recordset
  • func NewRecordset(name string, t RecordsetType, primaryKey []dal.FieldRef) *Recordset
  • func (v *Recordset) Name() string
  • func (v *Recordset) PrimaryKey() []dal.FieldRef
  • func (v *Recordset) PrimaryKeyFieldNames() []string
  • func (v *Recordset) Type() RecordsetType
• type RecordsetType

Constants

const Version = "0.0.8"

Version indicates package version

Functions

func NewDatabase

func NewDatabase(db *sql.DB, schema dal.Schema, options DbOptions) dal.DB

NewDatabase creates a new instance of DALgo adapter to SQL database

func NewSimpleSchema

func NewSimpleSchema(idFieldName string) dal.Schema

Types

type DbOptions

type DbOptions struct {
	ID         string
	PrimaryKey []string
	Recordsets map[string]*Recordset
}

DbOptions provides database sqlOptions for DALgo - // TODO: document why & how to use

func (DbOptions) GetRecordsetByKey

func (o DbOptions) GetRecordsetByKey(key *dal.Key) *Recordset

func (DbOptions) PrimaryKeyFieldNames

func (o DbOptions) PrimaryKeyFieldNames(key *dal.Key) (primaryKey []string)

type Field

type Field struct {
	Name string
}

Field defines field

func (Field) String

func (v Field) String() string

type Recordset

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

Recordset hold recordset settings

func NewRecordset

func NewRecordset(name string, t RecordsetType, primaryKey []dal.FieldRef) *Recordset

func (*Recordset) Name

func (v *Recordset) Name() string

func (*Recordset) PrimaryKey

func (v *Recordset) PrimaryKey() []dal.FieldRef

func (*Recordset) PrimaryKeyFieldNames

func (v *Recordset) PrimaryKeyFieldNames() []string

func (*Recordset) Type

func (v *Recordset) Type() RecordsetType

type RecordsetType

type RecordsetType = int

RecordsetType defines type of a database recordset

const (
	// Table identifies a table in a database
	Table RecordsetType = iota
)