msql

Documentation

Overview

Package msql implements connecting to a MySQL/MariaDB instance (and possibly others) and simplifies a number of interactions with it.

Index

• type SQL
  • func InstMySQL(cmp *mcmp.Component, defaultDB string) *SQL
  • func (sql *SQL) Context() context.Context

Types

type SQL

type SQL struct {
	*sqlx.DB
	// contains filtered or unexported fields
}

SQL is a wrapper around a sqlx client which provides more functionality.

func InstMySQL

func InstMySQL(cmp *mcmp.Component, defaultDB string) *SQL

InstMySQL returns a SQL instance which will be initialized when the Init event is triggered on the given Component. The SQL instance will have Close called on it when the Shutdown event is triggered on the given Component.

defaultDB indicates the name of the database in MySQL to use by default, though it will be overwritable in the config.

func (*SQL) Context

func (sql *SQL) Context() context.Context

Context returns the annotated Context from this instance's initialization.