dataprovider

README

Dataprovider

dataprovider is a module that provides a uniform interface to interact behind the scene with many databases and configurations. On this design is used the jmoiron/sqlx package that provides a set of extensions on top of the excellent built-in database/sql package.

The dataprovider in memory and sqlite uses modernc.org/sqlite package that is a CGO free SQLite3 driver for Go.

Working on

• Database Migration
• Database Connection
• Database Transaction
• Database Query
• Database QueryRow
• Database QueryRowx

Supported databases

• Memory
• SQLite3
• MySQL
• PostgreSQL
• SQL Server
• Oracle
• CockroachDB
• ClickHouse
• Cassandra
• MongoDB
• Redis
• InfluxDB
• Elasticsearch
• BigQuery
• Google Cloud Firestore
• Google Cloud Spanner
• Google Cloud Datastore

How to use

go get github.com/inovacc/dataprovider

Need to build with the tag mysql, postgres, or oracle to use the specific database. Default driver is sqlite in memory mode all data is lost when the program ends.

go build -tags mysql

go build -tags postgres

go build -tags oracle

Example of initialization

package main

import "github.com/inovacc/dataprovider"

func main() {
	// Create a config with driver name to initialize the data provider
	var provider = dataprovider.Must(dataprovider.NewDataProvider(
		dataprovider.NewOptions(dataprovider.WithSqliteDB("test", ".")),
	))

	// Initialize the database
	query := "CREATE TABLE IF NOT EXISTS ...;"
	if err := provider.InitializeDatabase(query); err != nil {
		panic(err)
	}

	// Get the connection and use it as sqlx.DB or sql.DB
	conn := provider.GetConnection()

	query := provider.NewSQLBuilder(provider).
		Table("users").
		Select("id", "name", "email").
		Where("age > 18").
		OrderBy("name ASC").
		Limit(10).
		Offset(5).
		Build()
}

Example of usage

package main

import (
	"encoding/json"
	"github.com/inovacc/dataprovider"
	"os"
)

type User struct {
	Id        int64  `json:"id" db:"id"`
	FirstName string `json:"first_name" db:"first_name"`
	LastName  string `json:"last_name" db:"last_name"`
	Email     string `json:"email" db:"email"`
	Gender    string `json:"gender" db:"gender"`
	IpAddress string `json:"ip_address" db:"ip_address"`
	City      string `json:"city" db:"city"`
}

func main() {
	// Create a config with driver name to initialize the data provider
	opts := dataprovider.NewOptions(
		    dataprovider.WithDriver(dataprovider.MemoryDataProviderName),
		    dataprovider.WithConnectionString("file:test.sqlite3?cache=shared"),
		)

	var provider = dataprovider.Must(dataprovider.NewDataProvider(opts))

	// Initialize the database
	query := "CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY AUTOINCREMENT, first_name TEXT, last_name TEXT, email TEXT, gender TEXT, ip_address TEXT, city TEXT);"
	if err := provider.InitializeDatabase(query); err != nil {
		panic(err)
	}

	// Get the connection
	conn := provider.GetConnection()

	// Begin a transaction
	tx := conn.MustBegin()

	// Insert data
	tx.MustExec("insert into users (first_name, last_name, email, gender, ip_address, city) values ('Marcus', 'Bengefield', 'mbengefield0@vistaprint.com', 'Male', '83.121.11.105', 'Miura');")
	tx.MustExec("insert into users (first_name, last_name, email, gender, ip_address, city) values ('Brandise', 'Mateuszczyk', 'bmateuszczyk1@vistaprint.com', 'Female', '131.187.209.233', 'Dalududalu');")
	tx.MustExec("insert into users (first_name, last_name, email, gender, ip_address, city) values ('Ray', 'Ginnaly', 'rginnaly2@merriam-webster.com', 'Male', '76.71.94.89', 'Al Baqāliţah');")

	// Commit the transaction
	if err = tx.Commit(); err != nil {
		panic(err)
	}

	// Query the data
	var users []User

	query = "SELECT * FROM users"
	rows, err := conn.Queryx(query)
	if err != nil {
		panic(err)
	}

	// Scan the data
	for rows.Next() {
		var user User
		if err = rows.StructScan(&user); err != nil {
			panic(err)
		}
		users = append(users, user)
	}

	// Print the data
	if err = json.NewEncoder(os.Stdout).Encode(users); err != nil {
		panic(err)
	}
}

Documentation

Index

• Constants
• func GetQueryFromFile(filename string) (string, error)
• type OptionFunc
  • func WithConnectionString(connectionString string) OptionFunc
  • func WithContext(ctx context.Context) OptionFunc
  • func WithDriver(driver string) OptionFunc
  • func WithHost(host string) OptionFunc
  • func WithMemoryDB() OptionFunc
  • func WithName(name string) OptionFunc
  • func WithPassword(password string) OptionFunc
  • func WithPoolSize(poolSize int) OptionFunc
  • func WithPort(port int) OptionFunc
  • func WithSQLTablesPrefix(sqlTablesPrefix string) OptionFunc
  • func WithSqliteDB(name, path string) OptionFunc
  • func WithUsername(username string) OptionFunc
• type Options
  • func NewOptions(optsFn ...OptionFunc) *Options
• type Provider
  • func Must(provider Provider, err error) Provider
  • func NewDataProvider(options *Options) (Provider, error)
• type Status

Constants

const (
	// OracleDatabaseProviderName defines the name for Oracle database Provider
	OracleDatabaseProviderName = provider.OracleDatabaseProviderName

	// SQLiteDataProviderName defines the name for SQLite database Provider
	SQLiteDataProviderName = provider.SQLiteDataProviderName

	// MySQLDatabaseProviderName defines the name for MySQL database Provider
	MySQLDatabaseProviderName = provider.MySQLDatabaseProviderName

	// PostgresSQLDatabaseProviderName defines the name for PostgresSQL database Provider
	PostgresSQLDatabaseProviderName = provider.PostgresSQLDatabaseProviderName

	// MemoryDataProviderName defines the name for memory provider using SQLite in-memory database Provider
	MemoryDataProviderName = provider.MemoryDataProviderName
)

Functions

func GetQueryFromFile

func GetQueryFromFile(filename string) (string, error)

Types

type OptionFunc

type OptionFunc func(*Options)

func WithConnectionString

func WithConnectionString(connectionString string) OptionFunc

WithConnectionString sets db connection string

func WithContext

func WithContext(ctx context.Context) OptionFunc

WithContext sets db context

func WithDriver

func WithDriver(driver string) OptionFunc

WithDriver sets db driver

func WithHost

func WithHost(host string) OptionFunc

WithHost sets db host

func WithMemoryDB

func WithMemoryDB() OptionFunc

WithMemoryDB sets memory db

func WithName

func WithName(name string) OptionFunc

WithName sets db name

func WithPassword

func WithPassword(password string) OptionFunc

WithPassword sets db password

func WithPoolSize

func WithPoolSize(poolSize int) OptionFunc

func WithPort

func WithPort(port int) OptionFunc

WithPort sets db port

func WithSQLTablesPrefix

func WithSQLTablesPrefix(sqlTablesPrefix string) OptionFunc

WithSQLTablesPrefix sets db sql tables prefix

func WithSqliteDB

func WithSqliteDB(name, path string) OptionFunc

WithSqliteDB sets sqlite db path name

func WithUsername

func WithUsername(username string) OptionFunc

WithUsername sets db username

type Options

type Options = provider.Options

func NewOptions

func NewOptions(optsFn ...OptionFunc) *Options

NewOptions creates a new options instance

type Provider

type Provider interface {
	// Disconnect disconnects from the data provider
	Disconnect() error

	// GetConnection returns the connection to the data provider
	GetConnection() *sqlx.DB

	// CheckAvailability checks if the data provider is available
	CheckAvailability() error

	// ReconnectDatabase reconnects to the database
	ReconnectDatabase() error

	// InitializeDatabase initializes the database
	InitializeDatabase(schema string) error

	// MigrateDatabase migrates the database to the latest version
	MigrateDatabase() migration.Migration

	// RevertDatabase reverts the database to the specified version
	RevertDatabase(targetVersion int) error

	// ResetDatabase resets the database
	ResetDatabase() error

	// GetProviderStatus returns the status of the provider
	GetProviderStatus() Status

	SqlBuilder() *provider.SQLBuilder
}

func Must

func Must(provider Provider, err error) Provider

Must panics if the error is not nil

Otherwise, it returns the provider instance with the corresponding implementation

func NewDataProvider

func NewDataProvider(options *Options) (Provider, error)

NewDataProvider creates a new data provider instance

type Status

type Status = provider.Status