database

Documentation

Overview

Package database handles connections to different types of databases

Index

• Constants
• Variables
• func GetDB() *gorm.DB
• func GetMongo() *qmgo.Client
• func GetRedis() *radix.Client
• func InitDB() *gorm.DB
• func InitMongo() (*qmgo.Client, error)
• func InitRedis() (*radix.Client, error)
• func InitTLSMySQL() (err error)
• func MongoCreateIndex(dbName, collectionName string, index options.IndexModel) error
• func MongoCreateIndexes(dbName, collectionName string, indexes []options.IndexModel) error
• func MongoDropAllIndexes(dbName, collectionName string) error
• func MongoDropIndex(dbName, collectionName string, indexes []string) error

Constants

const RecordNotFound string = "record not found"

RecordNotFound record not found error message

Variables

var RedisConnTTL int

RedisConnTTL - context deadline in second

Functions

func GetDB

func GetDB() *gorm.DB

GetDB - get a connection

func GetMongo

func GetMongo() *qmgo.Client

GetMongo - get a connection

func GetRedis

func GetRedis() *radix.Client

GetRedis - get a connection

func InitDB

func InitDB() *gorm.DB

InitDB - function to initialize db

func InitMongo

func InitMongo() (*qmgo.Client, error)

InitMongo - function to initialize mongo client

func InitRedis

func InitRedis() (*radix.Client, error)

InitRedis - function to initialize redis client

func InitTLSMySQL

func InitTLSMySQL() (err error)

InitTLSMySQL registers a custom tls.Config

Tutorial: How to configure MySQL instance and enable TLS support

1.0 generate CA's private key and certificate

to omit password: `-nodes -keyout`

`openssl req -x509 -sha512 -newkey rsa:4096 -days 10950 -keyout ca-key.pem -out ca.pem`

2.0 generate web server's private key and certificate signing request (CSR)

to omit password: `-nodes -keyout`

Common Name (e.g. server FQDN or YOUR name) must be different for CA and web server certificates

`openssl req -sha512 -newkey rsa:4096 -nodes -keyout server-key.pem -out server-req.pem`

2.1 config file

IP: server's public or local IPs of the interfaces

`echo "subjectAltName=DNS:localhost,IP:127.0.0.1,IP:172.17.0.1,IP:x.x.x.x,IP:y.y.y.y" > "server-ext.cnf"`

2.2 use CA's private key to sign web server's CSR and get back the signed certificate

`openssl x509 -sha512 -req -in server-req.pem -days 3650 -CA ca.pem -CAkey ca-key.pem -CAcreateserial -out server-cert.pem -extfile server-ext.cnf`

2.3 verify the certificate

`openssl verify -CAfile ca.pem server-cert.pem`

3.0 convert PKCS#8 format key into PKCS#1 format

`openssl rsa -in server-key.pem -out server-key.pem`

4.0 replace existing files located at /var/lib/mysql

5.0 set ownership and r/w permissions

```bash sudo chown -R mysql:mysql ca-key.pem ca.pem server-key.pem server-cert.pem sudo chmod -R 600 ca-key.pem server-key.pem sudo chmod -R 644 ca.pem server-cert.pem ```

6.0 restart mysql service

`sudo service mysql restart`

7.0 optional:

7.1 generate client's private key and certificate signing request (CSR)

`openssl req -sha512 -newkey rsa:4096 -nodes -keyout client-key.pem -out client-req.pem`

7.2 config file

IP: server's public or local IPs of the interfaces

`echo "subjectAltName=DNS:localhost,IP:127.0.0.1,IP:172.17.0.1,IP:x.x.x.x,IP:y.y.y.y" > "client-ext.cnf"`

7.3 use CA's private key to sign client's CSR and get back the signed certificate

`openssl x509 -sha512 -req -in client-req.pem -days 3650 -CA ca.pem -CAkey ca-key.pem -CAcreateserial -out client-cert.pem -extfile client-ext.cnf`

7.4 verify the certificate

`openssl verify -CAfile ca.pem client-cert.pem`

7.5 convert PKCS#8 format key into PKCS#1 format

`openssl rsa -in client-key.pem -out client-key.pem`

func MongoCreateIndex

func MongoCreateIndex(dbName, collectionName string, index options.IndexModel) error

MongoCreateIndex - create one index for a mongo collection

func MongoCreateIndexes

func MongoCreateIndexes(dbName, collectionName string, indexes []options.IndexModel) error

MongoCreateIndexes - create many indexes for a mongo collection

func MongoDropAllIndexes

func MongoDropAllIndexes(dbName, collectionName string) error

MongoDropAllIndexes - drop all indexes from a mongo collection except the index on the _id field

func MongoDropIndex

func MongoDropIndex(dbName, collectionName string, indexes []string) error

MongoDropIndex - drop one/multiple indexes from a mongo collection