README
¶
SimpleMaria
An easy way to use a MariaDB/MySQL 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 mysql package.
- Modeled after simpleredis.
- 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.
- MariaDB/MySQL normally has issues with variable size UTF-8 strings, even for for some combinations of characters. This package avoids these problems by compressing and hex encoding the data before storing in the database. This may slow down or speed up the time it takes to access the data, depending on your setup, but it's a safe way to encode any string. This behavior is optional and can be disabled with
host.SetRawUTF8(true), (to just useutf8mb4).
Sample usage
package main
import (
"log"
"github.com/xyproto/simplemaria"
)
func main() {
// Check if the simplemaria service is up
if err := db.TestConnection(); err != nil {
log.Fatalln("Could not connect to local database. Is the service up and running?")
}
// Create a Host, connect to the local db server
host := db.New()
// Connecting to a different host/port
//host := db.NewHost("server:3306/db")
// Connect to a different db host/port, with a username and password
// host := db.NewHost("username:password@server:port/db")
// Close the connection when the function returns
defer host.Close()
// Create a list named "greetings"
list, err := db.NewList(host, "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
A MariaDB/MySQL Database must be up and running locally for go test to work.
Version, license and author
- Version: 3.2.0
- License: MIT
- Author: Alexander F. Rødseth <xyproto@archlinux.org>
Documentation
¶
Overview ¶
Package simplemaria offers a simple way to use a MySQL/MariaDB database. This database backend is interchangeable with xyproto/simpleredis and xyproto/simplebolt, since they all use xyproto/pinterface.
Index ¶
- Constants
- Variables
- func Decode(code *string) error
- func Encode(value *string) error
- func TestConnection() (err error)
- func TestConnectionHost(connectionString string) (err error)
- func TestConnectionHostWithDSN(connectionString string) (err error)
- 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 Host
- 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 MariaCreator
- type Set
Constants ¶
const (
// Version number. Stable API within major version numbers.
Version = 3.2
)
Variables ¶
var Verbose = false
Functions ¶
func Encode ¶
MariaDB/MySQL does not handle some characters well. Compressing and hex encoding the value is one of many possible ways to avoid this. Using BLOB fields and different datatypes is another.
func TestConnection ¶
func TestConnection() (err error)
Test if the local database server is up and running.
func TestConnectionHost ¶
Test if a given database server is up and running. connectionString may be on the form "username:password@host:port/database".
func TestConnectionHostWithDSN ¶
Test if a given database server is up and running.
Types ¶
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 Host ¶
type Host struct {
// contains filtered or unexported fields
}
Host represents a specific database at a database host
func NewHost ¶
Create a new database connection. connectionString may be on the form "username:password@host:port/database".
func NewHostWithDSN ¶
Create a new database connection with a valid DSN.
func (*Host) SelectDatabase ¶
Select a different database. Create the database if needed.
func (*Host) SetRawUTF8 ¶
Should the UTF-8 data be raw, and not hex encoded and compressed?
type KeyValue ¶
type KeyValue dbDatastructure
func NewKeyValue ¶
Create a new key/value
type List ¶
type List dbDatastructure
type MariaCreator ¶
type MariaCreator struct {
// contains filtered or unexported fields
}
func NewCreator ¶
func NewCreator(host *Host) *MariaCreator
func (*MariaCreator) NewHashMap ¶
func (m *MariaCreator) NewHashMap(id string) (pinterface.IHashMap, error)
func (*MariaCreator) NewKeyValue ¶
func (m *MariaCreator) NewKeyValue(id string) (pinterface.IKeyValue, error)
func (*MariaCreator) NewList ¶
func (m *MariaCreator) NewList(id string) (pinterface.IList, error)
func (*MariaCreator) NewSet ¶
func (m *MariaCreator) NewSet(id string) (pinterface.ISet, error)
Source Files
Directories