superbase

package module
v0.0.0-...-4cd65b7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 5, 2019 License: MIT Imports: 5 Imported by: 1

README

ls-superbase

🏗️ convenience library for datastore configuration in go 🏗️

superbase provides a struct to hold a gorm.DB connection, and datastore config settings:

type DBConfig struct {
	Connection *gorm.DB
	Server     string
	Port       string
	Database   string
	User       string
	Password   string
	Driver     string
	Path       string
}

usage

	DBConfig := make(map[string]*superbase.DBConfig)
	DBConfig["myapp"].Server = "sqlite3"
	DBConfig["myapp"].Path = "myapp.db"
	DBConfig["myapp"].Init()

A short example to initialize an sqlite3 db and connection:

main.go
package main

import (
	"github.com/lakesite/ls-superbase
)

func main() {
	DBConfig := make(map[string]*superbase.DBConfig)
	DBConfig["myapp"].Server = "sqlite3"
	DBConfig["myapp"].Path = "myapp.db"
	DBConfig["myapp"].Init()
}

dependencies

  1. gorm
  2. gorm-mysql
  3. gorm-postgres
  4. gorm-sqlite
  5. gorm-mssql

license

MIT

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type DBConfig

type DBConfig struct {
	Connection *gorm.DB
	Server     string
	Port       string
	Database   string
	User       string
	Password   string
	Driver     string
	Path       string
	Meta       map[string]string
}

DBConfig holds a database configuration and gorm.DB connection. Meta is used for database related key values that apps might use.

func (*DBConfig) Init

func (db *DBConfig) Init()

Init initalizes our database connection based on the driver.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL