dalgo2sql

README

dalgo2sql

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

Status

Usage

go get github.com/dal-go/dalgo2sql

License

Free to use and open source under MIT License.

Documentation

Index

• Constants
• func NewDatabase(db *sql.DB, options Options) dal.DB
• type Field
  • func (v Field) String() string
• type Options
  • func (o Options) GetRecordsetByKey(key *dal.Key) *Recordset
  • func (o Options) PrimaryKeyFieldNames(key *dal.Key) (primaryKey []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, options Options) dal.DB

NewDatabase creates a new instance of DALgo adapter to SQL database

Types

type Field

type Field struct {
	Name string
}

Field defines field

func (Field) String

func (v Field) String() string

type Options

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

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

func (Options) GetRecordsetByKey

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

func (Options) PrimaryKeyFieldNames

func (o Options) PrimaryKeyFieldNames(key *dal.Key) (primaryKey []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
	// View identifies a view in a database
	View
	// StoredProcedure identifies a stored procedure in a database
	StoredProcedure
)