README.md

Elephants never forget

Schema

The Elephant library will work only with structures which meet the following criteria:

• It has a parameter of type string which has the tag db:"key" and is unique (will be used as primary key)
• The structure can be marshalled to JSON
• The struct name meets the following regular expression: [0-9A-Za-z_]{1,40}
• All attributes to be saved must be public (first letter of the variable name must be uppercase)

This library will store every instance inside a table with the name of the structure. Each table will have two columns: the id (string) column and the value, which will be a JSON with, at most, 64 Kilobytes (defined by MaxStructLength)

Supported URIs, right now, follow this criteria:

• sqlite3:path/to/file.db (if the file doesn't exist, it will be created)
• mysql:user:password@tcp(hostname:port)/database

Compiling and testing

go get -u .
go test -cover
go mod tidy

sqlite3 /tmp/foo.db
.tables
select * from structCheck;

MySQL

To perform MySQL tests, create a docker container with the following configuration:

docker run -d -p33060:3306 --name elephant-testing \
-e MARIADB_ALLOW_EMPTY_ROOT_PASSWORD=true \
-e MARIADB_DATABASE=elephant \
mariadb:lts

Run it everytime the checks must be run:

docker start elephant-testing

You can check the access to the instance with:

mysql -u root -h 127.0.0.1 --port=33060 elephant

Example usage

err := Initialize("sqlite3:example.db")
if err != nil {
    t.Error("Initialization failed", err)
}
defer Close()