README
¶
Summary
SQLiter provides a simplified interface for reading/writing flat structs to disk. That's about it.
The utility is in lean prototyping where getting 'something' working is all you need. This is something.
Usage
Init
Example usage to create an in-memory store. Use a filename to write to disk.
type MyStruct struct {
ID int64 `db:"id" attr:"PRIMARY KEY"`
Value string `db:"value"`
}
db, _ := sqliter.Open(sqliter.InMemory)
db.CreateTable(MyStruct{})
Insert
Insert an instance of an object. CreateTable must first be called.
db.Insert(MyStruct{Value:"foo"})
Read
Pass a pointer to an instance, a where clause and its parameter(s).
myStruct := MyStruct{}
db.ReadOne(&myStruct, "id = ?", 1)
ReadMany
Pass a pointer to an instance, a where clause and its parameter(s).
Abusing the where clause is a convienient way of working around the limited interface.
myList := []*Mystruct{}
db.ReadMany(&mylist, "value > ?", 42)
db.ReadMany(&mylist, "value > ? ORDER BY created_at LIMIT ?", 42, 10)
db.ReadMany(&mylist, "true ORDER BY created_at LIMIT ?", 42, 10)
db.ReadMany(&mylist, "")
Update
myStruct.Value = "bar"
db.Update(myStruct, "id = ?", 1)
Delete
db.Delete(MyStruct{}, "id = ?", 1)
Documentation
¶
Index ¶
- Constants
- type Sqliter
- func (s *Sqliter) Close()
- func (s *Sqliter) CreateTable(sample interface{}) error
- func (s *Sqliter) Delete(sample interface{}, where string, args ...interface{}) error
- func (s *Sqliter) DeleteFrom(table, where string, args ...interface{}) error
- func (s *Sqliter) Exec(q string, args ...any) (sql.Result, error)
- func (s *Sqliter) Insert(obj interface{}) (int64, error)
- func (s *Sqliter) ReadMany(outPtr interface{}, where string, args ...interface{}) error
- func (s *Sqliter) ReadOne(outPtr interface{}, where string, args ...interface{}) error
- func (s *Sqliter) Select(outPtr interface{}, q string, args ...interface{}) error
- func (s *Sqliter) TableName(sample interface{}) (string, error)
- func (s *Sqliter) Update(obj interface{}, where string, args ...interface{}) error
- func (s *Sqliter) Upsert(obj interface{}, where string, args ...interface{}) (int64, error)
- type StructField
Constants ¶
const InMemory = ":memory:"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Sqliter ¶
type Sqliter struct {
// contains filtered or unexported fields
}
func (*Sqliter) CreateTable ¶
CreateTable takes an example object (or nill pointer to its type) and runs CREATE TABLE IF NOT EXISTS with columns read from typej.
func (*Sqliter) DeleteFrom ¶
Delete from the specified table all records matching the where clause
func (*Sqliter) ReadMany ¶
Read several records. Use where clause to specify which ones and also to inject OFFSET and LIMIT clauses.
Source Files