README
¶
Manager
Totally not an ORM for Go.
For use with the SQL toolkits Sol and Fields.
Manager adds convenience methods such as Get, auto-joins, and injected conditional clauses to SQL tables.
// Serial and Timestamp will be set by the database
type Item struct {
fields.Serial
Name string
IsFree bool
fields.Timestamp
}
func (item Item) Error(conn sol.Conn) *errors.Error {
return nil
}
func (item *Item) Save(conn sol.Conn) error {
return conn.Query(Items.Insert().Values(item).Returning(), item)
}
// Create a Table and immediately wrap it in a manager. Since the TableElem
// is embedded all its methods are available
var Items = postgres.Table("items",
fields.Serial{},
sol.Column("name", types.Varchar().Limit(32).NotNull()),
sol.Column("is_free", types.Boolean().NotNull()),
sol.PrimaryKey("id"),
fields.Timestamp{},
)
var ItemsManager = manager.New(Items)
func main() {
Items.Use(conn) // A connection must be set
item := NewItem("a")
Items.Save(&item) // Pass a pointer for database-level field assignments
log.Println(item.Exists())
Items.Get(&item, item.ID)
}
Extend the manager by embedding it in your own struct.
Happy Hacking!
aodin, 2016
Documentation
¶
Index ¶
- func All() string
- func Has(name string) bool
- func List() string
- func SQL(all bool, names ...string) string
- func String() string
- type Managed
- type Manager
- func (m Manager) AddTo(schema *Schema) error
- func (m *Manager) All(dest interface{}) error
- func (m *Manager) BulkCreate(obj interface{}) error
- func (m *Manager) Conn() sol.Conn
- func (m Manager) Filter(clauses ...sol.Clause) Manager
- func (m Manager) FilterDelete(clauses ...sol.Clause) Manager
- func (m Manager) FilterSelect(clauses ...sol.Clause) Manager
- func (m Manager) FilterUpdate(clauses ...sol.Clause) Manager
- func (m *Manager) Get(dest interface{}, keys ...interface{}) error
- func (m *Manager) GetBy(dest interface{}, k string, v interface{}) error
- func (m *Manager) Query(stmt sol.Executable, dest ...interface{}) error
- func (m *Manager) Save(obj Managed) error
- func (m *Manager) SetConn(conn sol.Conn)
- func (m *Manager) UpdateValues(obj Managed, values ...sol.Values) error
- func (m Manager) Use(conn sol.Conn) Manager
- func (m Manager) Using(conn sol.Conn) Manager
- type Schema
- type Schemas
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Managed ¶
type Managed interface {
Error(sol.Conn) *errors.Error
Exists() bool
Keys() []interface{} // Primary keys
Save(sol.Conn) error
}
Managed is an implementation target for database-backed struct types
type Manager ¶
Manager wraps a table and provides helper methods
func (*Manager) BulkCreate ¶
BulkCreate allow the creation of multiple objects
func (*Manager) Conn ¶
Conn returns the manager's connection TODO GetConn? What methods of the connection should be available?
func (Manager) Filter ¶
Filter injects a clause whenever a DELETE, UPDATE, or SELECT statement is queried
func (Manager) FilterDelete ¶
FilterDelete injects a clause whenever a DELETE statement is queried
func (Manager) FilterSelect ¶
FilterSelect injects a clause whenever a SELECT statement is queried
func (Manager) FilterUpdate ¶
FilterUpdate injects a clause whenever an UPDATE statement is queried
func (*Manager) Query ¶
func (m *Manager) Query(stmt sol.Executable, dest ...interface{}) error
Query allows clauses to be injected into various statements
func (*Manager) UpdateValues ¶
UpdateValues updates the given obj with the given values
Source Files