README
¶
SimpleSqlite (no C)
An easy way to use a SQLite database from Go.
Online API Documentation
Features and limitations
- Supports simple use of lists, hashmaps, sets and key/values.
- Deals mainly with strings.
- Uses the pure-Go modernc.org/sqlite driver, so CGO is not required.
- Modeled after simplemaria.
- The hash maps behaves like hash maps, but are not backed by actual hashmaps, unlike with simpleredis. This is for keeping compatibility with simpleredis. If performance when scaling up is a concern, simpleredis backed by redis might be a better choice.
Sample usage
package main
import (
"log"
"github.com/xyproto/simplesqlite_noc"
)
func main() {
// Check if the simplesqlite is working
if err := db.TestConnection(); err != nil {
log.Fatalln("Could not open database file.")
}
// Create a new File
file := db.New()
// Use another filename
//file := db.NewFile("sqlite.db")
// Close the connection when the function returns
defer file.Close()
// Create a list named "greetings"
list, err := db.NewList(file, "greetings")
if err != nil {
log.Fatalln("Could not create list!")
}
// Add "hello" to the list, check if there are errors
if list.Add("hello") != nil {
log.Fatalln("Could not add an item to list!")
}
// Get the last item of the list
if item, err := list.GetLast(); err != nil {
log.Fatalln("Could not fetch the last item from the list!")
} else {
log.Println("The value of the stored item is:", item)
}
// Remove the list
if list.Remove() != nil {
log.Fatalln("Could not remove the list!")
}
}
Testing
The tests will create a file (sqlite.db) for go test to work.
Version, license and author
- Version: 1.1.0
- License: BSD-3
- Author: Alexander F. Rødseth <xyproto@archlinux.org>
- Author: Björn Kalkbrenner <terminar@cyberphoria.org>
Documentation
¶
Index ¶
- Constants
- Variables
- func TestConnection() (err error)
- func TestConnectionFile(connectionString string) (err error)
- type File
- type HashMap
- func (h *HashMap) All() ([]string, error)
- func (h *HashMap) Clear() error
- func (h *HashMap) Del(owner string) error
- func (h *HashMap) DelKey(owner, key string) error
- func (h *HashMap) Exists(owner string) (bool, error)
- func (h *HashMap) Get(owner, key string) (string, error)
- func (h *HashMap) GetAll() ([]string, error)
- func (h *HashMap) Has(owner, key string) (bool, error)
- func (h *HashMap) Keys(owner string) ([]string, error)
- func (h *HashMap) Remove() error
- func (h *HashMap) Set(owner, key, value string) error
- type KeyValue
- type List
- func (l *List) Add(value string) error
- func (l *List) All() ([]string, error)
- func (l *List) Clear() error
- func (l *List) GetAll() ([]string, error)
- func (l *List) GetLast() (string, error)
- func (l *List) GetLastN(n int) ([]string, error)
- func (l *List) Last() (string, error)
- func (l *List) LastN(n int) ([]string, error)
- func (l *List) Remove() error
- type SQLiteCreator
- type Set
Constants ¶
View Source
const (
// Version number. Stable API within major version numbers.
Version = 3.2
)
Variables ¶
View Source
var Verbose = false
Functions ¶
func TestConnection ¶
func TestConnection() (err error)
Test if the local database server is up and running.
func TestConnectionFile ¶
Test if a given database server is up and running. connectionString may be on the form "sqlite.db&cache=shared&mode=memory".
Types ¶
type File ¶
type File struct {
// contains filtered or unexported fields
}
File represents a specific database
type HashMap ¶
type HashMap dbDatastructure
func (*HashMap) DelKey ¶
Remove a key for an entry in a hashmap (for instance the email field for a user)
func (*HashMap) Get ¶
Get a value from a hashmap given the element id (for instance a user id) and the key (for instance "password").
type KeyValue ¶
type KeyValue dbDatastructure
func NewKeyValue ¶
Create a new key/value
type List ¶
type List dbDatastructure
type SQLiteCreator ¶
type SQLiteCreator struct {
// contains filtered or unexported fields
}
func NewCreator ¶
func NewCreator(file *File) *SQLiteCreator
func (*SQLiteCreator) NewHashMap ¶
func (m *SQLiteCreator) NewHashMap(id string) (pinterface.IHashMap, error)
func (*SQLiteCreator) NewKeyValue ¶
func (m *SQLiteCreator) NewKeyValue(id string) (pinterface.IKeyValue, error)
func (*SQLiteCreator) NewList ¶
func (m *SQLiteCreator) NewList(id string) (pinterface.IList, error)
func (*SQLiteCreator) NewSet ¶
func (m *SQLiteCreator) NewSet(id string) (pinterface.ISet, error)
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.