database

Documentation

Index

• func ConnectMongoDB(ctx context.Context, dsn string, opts ...*options.ClientOptions) *mongo.Database
• func ConnectRedis(dsn string, opts ...RedisPoolOption) *redis.Pool
• func ConnectSQLDatabase(dsn string, opts ...SQLDatabaseOption) *sql.DB
• func ParseSQLDSN(source string) (driverName string, dsn string)
• type MongoInstance
  • func InitMongoDB(ctx context.Context, opts ...*options.ClientOptions) *MongoInstance
  • func (m *MongoInstance) Close() (err error)
  • func (m *MongoInstance) Disconnect(ctx context.Context) (err error)
  • func (m *MongoInstance) Health() map[string]error
  • func (m *MongoInstance) ReadDB() *mongo.Database
  • func (m *MongoInstance) WriteDB() *mongo.Database
• type RedisInstance
  • func InitRedis(opts ...RedisPoolOption) *RedisInstance
  • func (m *RedisInstance) Cache() interfaces.Cache
  • func (m *RedisInstance) Disconnect(ctx context.Context) (err error)
  • func (m *RedisInstance) Health() map[string]error
  • func (m *RedisInstance) ReadPool() *redis.Pool
  • func (m *RedisInstance) WritePool() *redis.Pool
• type RedisPoolOption
  • func RedisPoolOptionSetIdleTimeout(dur time.Duration) RedisPoolOption
  • func RedisPoolOptionSetMaxActive(count int) RedisPoolOption
  • func RedisPoolOptionSetMaxConnLifetime(dur time.Duration) RedisPoolOption
  • func RedisPoolOptionSetMaxIdle(count int) RedisPoolOption
• type SQLDatabaseOption
• type SQLInstance
  • func InitSQLDatabase(opts ...SQLDatabaseOption) *SQLInstance
  • func (s *SQLInstance) Close() (err error)
  • func (s *SQLInstance) Disconnect(ctx context.Context) (err error)
  • func (s *SQLInstance) Health() map[string]error
  • func (s *SQLInstance) ReadDB() *sql.DB
  • func (s *SQLInstance) WriteDB() *sql.DB

Functions

func ConnectMongoDB

func ConnectMongoDB(ctx context.Context, dsn string, opts ...*options.ClientOptions) *mongo.Database

ConnectMongoDB connect to mongodb with dsn

func ConnectRedis

func ConnectRedis(dsn string, opts ...RedisPoolOption) *redis.Pool

ConnectRedis connect to redis with dsn

func ConnectSQLDatabase

func ConnectSQLDatabase(dsn string, opts ...SQLDatabaseOption) *sql.DB

ConnectSQLDatabase connect to sql database with dsn

func ParseSQLDSN

func ParseSQLDSN(source string) (driverName string, dsn string)

ParseSQLDSN parse sql dsn

Types

type MongoInstance

type MongoInstance struct {
	DBRead, DBWrite *mongo.Database
}

func InitMongoDB

func InitMongoDB(ctx context.Context, opts ...*options.ClientOptions) *MongoInstance

InitMongoDB return mongo db read & write instance from environment: MONGODB_HOST_WRITE, MONGODB_HOST_READ if want to create single connection, use MONGODB_HOST_WRITE and set empty for MONGODB_HOST_READ

func (*MongoInstance) Close

func (m *MongoInstance) Close() (err error)

func (*MongoInstance) Disconnect

func (m *MongoInstance) Disconnect(ctx context.Context) (err error)

func (*MongoInstance) Health

func (m *MongoInstance) Health() map[string]error

func (*MongoInstance) ReadDB

func (m *MongoInstance) ReadDB() *mongo.Database

func (*MongoInstance) WriteDB

func (m *MongoInstance) WriteDB() *mongo.Database

type RedisInstance

type RedisInstance struct {
	DBRead, DBWrite *redis.Pool
	ICache          interfaces.Cache
}

func InitRedis

func InitRedis(opts ...RedisPoolOption) *RedisInstance

InitRedis connection from environment: REDIS_READ_DSN, REDIS_WRITE_DSN if want to create single connection, use REDIS_WRITE_DSN and set empty for REDIS_READ_DSN

func (*RedisInstance) Cache

func (m *RedisInstance) Cache() interfaces.Cache

func (*RedisInstance) Disconnect

func (m *RedisInstance) Disconnect(ctx context.Context) (err error)

func (*RedisInstance) Health

func (m *RedisInstance) Health() map[string]error

func (*RedisInstance) ReadPool

func (m *RedisInstance) ReadPool() *redis.Pool

func (*RedisInstance) WritePool

func (m *RedisInstance) WritePool() *redis.Pool

type RedisPoolOption

type RedisPoolOption func(pool *redis.Pool)

func RedisPoolOptionSetIdleTimeout

func RedisPoolOptionSetIdleTimeout(dur time.Duration) RedisPoolOption

func RedisPoolOptionSetMaxActive

func RedisPoolOptionSetMaxActive(count int) RedisPoolOption

func RedisPoolOptionSetMaxConnLifetime

func RedisPoolOptionSetMaxConnLifetime(dur time.Duration) RedisPoolOption

func RedisPoolOptionSetMaxIdle

func RedisPoolOptionSetMaxIdle(count int) RedisPoolOption

type SQLDatabaseOption

type SQLDatabaseOption func(db *sql.DB)

type SQLInstance

type SQLInstance struct {
	DBRead, DBWrite *sql.DB
}

func InitSQLDatabase

func InitSQLDatabase(opts ...SQLDatabaseOption) *SQLInstance

InitSQLDatabase return sql db read & write instance from environment: SQL_DB_READ_DSN, SQL_DB_WRITE_DSN if want to create single connection, use SQL_DB_WRITE_DSN and set empty for SQL_DB_READ_DSN

func (*SQLInstance) Close

func (s *SQLInstance) Close() (err error)

func (*SQLInstance) Disconnect

func (s *SQLInstance) Disconnect(ctx context.Context) (err error)

func (*SQLInstance) Health

func (s *SQLInstance) Health() map[string]error

func (*SQLInstance) ReadDB

func (s *SQLInstance) ReadDB() *sql.DB

func (*SQLInstance) WriteDB

func (s *SQLInstance) WriteDB() *sql.DB