README
¶
Minetest database repositories for the golang ecosystem
Docs: https://pkg.go.dev/github.com/minetest-go/mtdb
Features
- Read and write users/privs from and to the
authdatabase - Read and write player-data and metadata from and to the
playerdatabase - Read and write from and to the
map(blocks) database - Read and write from the
mod_storagedatabase
Supported databases:
- Sqlite3 (auth,player,blocks,mod_storage)
- Postgres (auth,player,blocks)
License
Code: MIT
Documentation
¶
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewBlockDB ¶ added in v1.1.30
func NewBlockDB(world_dir string) (block.BlockRepository, error)
creates just the connection to the block-repository
Example ¶
package main
import (
"fmt"
"github.com/minetest-go/mtdb"
)
func main() {
// create a new block-repository with the backend-connection specified in the world.mt file in the given directory
blocks, err := mtdb.NewBlockDB("/my-world-dir")
if err != nil {
panic(err)
}
// fetch the mapblock at position 0,0,0
block, err := blocks.GetByPos(0, 0, 0)
if err != nil {
panic(err)
}
// dump the raw and unparsed binary data
// use the github.com/minetest-go/mapparser project to parse the actual content
fmt.Printf("Mapblock content: %s\n", block.Data)
}
Output:
Types ¶
type Context ¶ added in v1.1.20
type Context struct {
Auth *auth.AuthRepository
Privs *auth.PrivRepository
Player *player.PlayerRepository
PlayerMetadata *player.PlayerMetadataRepository
Blocks block.BlockRepository
ModStorage mod_storage.ModStorageRepository
// contains filtered or unexported fields
}
Database connection context
Example ¶
package main
import (
"fmt"
"github.com/minetest-go/mtdb"
)
func main() {
// create a new context (an object with all repositories) from a minetest world-directory
ctx, err := mtdb.New("/xy")
if err != nil {
panic(err)
}
// retrieve an auth entry of the "admin" user
entry, err := ctx.Auth.GetByUsername("admin")
if err != nil {
panic(err)
}
fmt.Printf("Admin password-entry: %s\n", entry.Password)
// retrieve admin's privileges
privs, err := ctx.Privs.GetByID(*entry.ID)
for _, priv := range privs {
fmt.Printf(" + %s\n", priv.Privilege)
}
// get a mapblock from the database
block, err := ctx.Blocks.GetByPos(0, 0, 0)
if err != nil {
panic(err)
}
// dump the raw and unparsed binary data
// use the github.com/minetest-go/mapparser project to parse the actual content
fmt.Printf("Mapblock content: %s\n", block.Data)
}
Output:
func NewWithConfig ¶ added in v1.1.52
creates the database context with the given config in map form
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.