mongo

README

ginny-mongo

mongo provider for ginny.

Documentation

Overview

Package mongo provide mongo utils

Index

• Variables
• type Config
  • func NewConfig(v *viper.Viper) (*Config, error)
  • func (c *Config) String() string
• type Mongo
  • func NewMongo(ctx context.Context, config *Config) (*Mongo, error)
  • func (m *Mongo) Close(ctx context.Context) error
  • func (m *Mongo) Collection(colName string) *mongo.Collection
  • func (m *Mongo) DefaultDatabase() *mongo.Database
  • func (m *Mongo) TransformDocument(val interface{}) bsonx.Doc

Variables

var Provider = wire.NewSet(NewConfig, NewMongo)

Provider

Types

type Config

type Config struct {
	//该连接池可操作的数据库（可选配置）
	DBNames []string `json:"dbnames" mapstructure:"dbnames"`
	//初始化mongodb连接管理器时 给定默认数据库名（必须配置，否则业务方需注意不调用Manager.DB()函数）
	DefaultDBName string `json:"default_dbname" mapstructure:"default_dbname"`

	//副本集的各个实例地址，此处配置多个 仅为防止初始化时单点失败
	//连接后由driver监控副本集状态 做自动故障转移，读写分离可由连接池配置ReadPreference决定
	Hosts []string `json:"hosts" mapstructure:"hosts"`
	//副本集名字：指定该名字 必须和mongodb部署时相应节点配置的名字一致，client会将相同名字的节点视为在同一副本集内 而忽略其他节点，默认配置空
	ReplicaSet string `json:"replica_set" mapstructure:"replica_set"`
	//读首选项配置：决定mongodb driver如何将读操作 路由到副本集的成员，需要读写分离可在此配置
	//若配置文件不指定下述配置，则解析配置时 按照client driver给定的默认值primary模式进行配置
	ReadPreference struct {
		//PrimaryMode 1, PrimaryPreferredMode 2, SecondaryMode 3, SecondaryPreferredMode 4, NearestMode 5
		Mode int `json:"mode" mapstructure:"mode"`
		//在1个副本集中，从次节点读的 允许的最大复制延迟(单位s)
		MaxStaleness int `json:"max_staleness" mapstructure:"max_staleness"`
		//Name-Value 标签
		Tags map[string]string `json:"tags" mapstructure:"tags"`
	} `json:"read_preference" mapstructure:"read_preference"`

	//认证：支持用户名密码、AWS、GSSAPI/SSPI、LDAP、SCRAM。X509还需tls配置
	//详见 mongo/options/clientoptions.go Credential注释
	Auth struct {
		Mechanism           string            `json:"mechanism" mapstructure:"mechanism"`
		MechanismProperties map[string]string `json:"mechanism_properties" mapstructure:"mechanism_properties"`
		Source              string            `json:"source" mapstructure:"source"`
		Username            string            `json:"username" mapstructure:"username"`
		Password            string            `json:"password" mapstructure:"password"`
		PasswordSet         bool              `json:"password_set" mapstructure:"password_set"`
	} `json:"auth" mapstructure:"auth"`

	//创建连接时的连接超时时间(单位s)，0值表示没有timeout。不调用设值时 driver默认30s
	ConnectTimeout int `json:"connect_timeout" mapstructure:"connect_timeout"`
	//1个连接在1个连接池中 保持空闲状态的最长时长(单位s)。超过该时长 该连接会被移出连接池并关闭。driver默认0值 连接可保持无限期空闲。
	MaxConnIdleTime int `json:"max_conn_idle_time" mapstructure:"max_conn_idle_time"`
	//到每1个server的允许的最大连接数，到达后新请求会阻塞。0值会被driver设置为math.MaxInt64，driver默认100
	MaxPoolSize int `json:"max_pool_size" mapstructure:"max_pool_size"`
	//到每1个server的允许的最小连接数。非0时 若连接均长时空闲 driver会在后台维持最小连接数，driver默认0
	MinPoolSize int `json:"min_pool_size" mapstructure:"min_pool_size"`
}

Config mongodb deployment 连接基础配置：mongodb单实例、副本集(可有读写分离)、分片集群

func NewConfig

func NewConfig(v *viper.Viper) (*Config, error)

NewConfig

func (*Config) String

func (c *Config) String() string

String 打印可输出的配置

type Mongo

type Mongo struct {
	*mongo.Client
	// contains filtered or unexported fields
}

Mongo the mongo client

func NewMongo

func NewMongo(ctx context.Context, config *Config) (*Mongo, error)

New new client

func (*Mongo) Close

func (m *Mongo) Close(ctx context.Context) error

Close 关闭

func (*Mongo) Collection

func (m *Mongo) Collection(colName string) *mongo.Collection

Collection 获取 Collection

func (*Mongo) DefaultDatabase

func (m *Mongo) DefaultDatabase() *mongo.Database

DefaultDatabase 获取默认数据库

func (*Mongo) TransformDocument

func (m *Mongo) TransformDocument(val interface{}) bsonx.Doc

TransformDocument transform any object to bson documents