dalgo2sql

package module

v0.0.30 Latest Latest Go to latest Published: Apr 8, 2024 License: MIT Imports: 10 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/dal-go/dalgo2sql

Links

Open Source Insights

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, 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
type RecordsetType

Constants ¶

View Source

const Version = "0.0.8"

Version indicates package version

Variables ¶

This section is empty.

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 ¶ added in v0.0.9

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 ¶ added in v0.0.9

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

func (Options) PrimaryKeyFieldNames ¶ added in v0.0.9

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 ¶ added in v0.0.9

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 ¶ added in v0.0.9

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
)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
end2end module

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL