dbs

package
v1.3.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 20, 2021 License: GPL-3.0 Imports: 16 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DoMySQLDeploy 

func DoMySQLDeploy(Db *MySQLDB, deploy *MySQLDeploy) error

DoMySQLDeploy doc @Summary deploy mysql db @Method DoMySQLDeploy @Param (*MySQLDB) mysql object @Param (*MySQLDeploy) mysql config informat @Return (error) register mysql success/fail

func DoMySQLGormDeploy 

func DoMySQLGormDeploy(Db *MySQLGORM, deploy *MySQLGormDeploy) error

DoMySQLGormDeploy doc @Summary deploy mysql db @Method DoMySQLDeploy @Param (*MySQLDB) mysql object @Param (*MySQLDeploy) mysql config informat @Return (error) register mysql success/fail

func DoRedisDeploy 

func DoRedisDeploy(Db *RedisDB, deploy *RedisDeploy) error

DoRedisDeploy doc @Summary deploy mysql db @Method DoRedisDeploy @Param (*MySQLDB) mysql object @Param (*MySQLDeployArray) mysql config informat @Return (error) register mysql success/fail

Types

type MongoDB 

type MongoDB struct {
	// contains filtered or unexported fields
}

MongoDB doc @Summary Mongo DB Object @Struct MongoDB @Member *mongo.Client mongo client @Member *mongo.Database mongo database object @Member int connection/operation/close time out unit/second

func (*MongoDB) Close 

func (slf *MongoDB) Close()

Close doc @Summary close mongo db @Method Close

func (*MongoDB) CountDocuments 

func (slf *MongoDB) CountDocuments(name string, filter interface{}) (int64, error)

CountDocuments @Summary @Summary Return the total number of documents @Method CountDocuments @Param (string) set/table name @Param (interface{}) filter @Return (int64) a number @Return (error)

func (*MongoDB) DeleteMany 

func (slf *MongoDB) DeleteMany(name string, filter interface{}) (int64, error)

DeleteMany doc @Summary Delete multiple pieces of data @Method DeleteMany @Param (string) set/table name @Param (interface{}) filter @Return (int64) delete of number @Return (error)

func (*MongoDB) DeleteOne 

func (slf *MongoDB) DeleteOne(name string, filter interface{}) (int64, error)

DeleteOne doc @Summary delete a piece of data @Method DeleteOne @Param (string) set/table name @Param (interface{}) filter @Return (int64) delete of number @Return (error)

func (*MongoDB) Distinct 

func (slf *MongoDB) Distinct(name string, fieldName string, filter interface{}) ([]interface{}, error)

Distinct doc @Summary Find in the specified field @Method Distinct @Param (string) set/table name @Param (string) field name @Param (interface{}) filter @Return ([]interface{}) Return result @Return (error)

func (*MongoDB) Drop 

func (slf *MongoDB) Drop(name string) error

Drop @Summary @Summary Delete set/table @Method Drop @Param (string) set/table name @Return (error)

func (*MongoDB) Find 

func (slf *MongoDB) Find(name string, filter interface{}, decode interface{}) ([]interface{}, error)

Find doc @Summary Query multiple data @Method Find @Param (string) set/table name @Param (interface{}) filter @Param (interface{}) @Return ([]interface{}) Return result @Return (error) Return error

func (*MongoDB) FindOne 

func (slf *MongoDB) FindOne(name string, filter interface{}, out interface{}) error

FindOne doc @Summary Query a piece of data @Method FindOne @Param (string) set/table name @Param (interface{}) filter @Param (interface{}) out result @Return (error) Return error

func (*MongoDB) FindOneAndDelete 

func (slf *MongoDB) FindOneAndDelete(name string, filter interface{}, out interface{}) error

FindOneAndDelete doc @Summary find a piece of data and delete @Method FindOneAndDelete @Param (string) set/table name @Param (interface{}) filter @Param (out interface{}) One piece of data found @Return (error)

func (*MongoDB) FindOneAndReplace 

func (slf *MongoDB) FindOneAndReplace(name string, filter interface{}, replacement interface{}, out interface{}) error

FindOneAndReplace doc @Summary find a piece of data and replace @Method FindOneAndReplace @Param (string) set/table name @Param (interface{}) filter @Param (interface{}) data to be replace @Param (out interface{}) One piece of data found @Return (error)

func (*MongoDB) FindOneAndUpdate 

func (slf *MongoDB) FindOneAndUpdate(name string, filter interface{}, update interface{}, out interface{}) error

FindOneAndUpdate doc @Summary find a piece of data and update @Method FindOneAndUpdate @Param (string) set/table name @Param (interface{}) filter @Param (interface{}) data to be updated @Param (out interface{}) One piece of data found @Return (error)

func (*MongoDB) Initial 

func (slf *MongoDB) Initial(url string,
	user string,
	password string,
	dbname string,
	max int,
	min int,
	timeout int) error

Initial doc @Summary initialization mongo db @Method Initial @Param string uri @Param string user @Param string password @Param string db name @Param int max pool @Param int min pool @Param int connection/operation/close time out unit/millsecond @Param int connection heart reate unit/second @Param int connection time out unit/second @Param int connection idle time unit/second @Return (error) initialization fail return error

func (*MongoDB) InsertMany 

func (slf *MongoDB) InsertMany(name string, document []interface{}) ([]interface{}, error)

InsertMany doc @Summary Insert multiple pieces of data @Method InsertMany @Param (string) set/table name @Param ([]interface{}) more data @Return (interface{}) insert result @Return (error) insert fail

func (*MongoDB) InsertOne 

func (slf *MongoDB) InsertOne(name string, document interface{}) (interface{}, error)

InsertOne doc @Method InsertOne @Summary Insert a piece of data @Param (string) set/table name @Param (interface{}) data @Return (interface{}) insert result @Return (error) insert fail

func (*MongoDB) ReplaceOne 

func (slf *MongoDB) ReplaceOne(name string, filter interface{}, replacement interface{}) (int64, int64, int64, interface{}, error)

ReplaceOne doc @Summary replace a piece of data @Method ReplaceOne @Param (string) set/table name @Param (interface{}) filter @Param (interface{}) update informat @Return (int64) match of number @Return (int64) modify of number @Return (int64) update of number @Return (interface{}) update id @Return (error)

func (*MongoDB) SpawnIndex added in v1.1.0 

func (slf *MongoDB) SpawnIndex(name string, idx mongo.IndexModel) error

func (*MongoDB) UpdateMany 

func (slf *MongoDB) UpdateMany(name string, filter interface{}, update interface{}) (int64, int64, int64, interface{}, error)

UpdateMany doc @Summary update multiple data @Method UpdateMany @Param (string) set/table name @Param (interface{}) filter @Param (interface{}) update informat @Return (int64) match of number @Return (int64) modify of number @Return (int64) update of number @Return (interface{}) update id @Return (error)

func (*MongoDB) UpdateOne 

func (slf *MongoDB) UpdateOne(name string, filter interface{}, update interface{}) (int64, int64, int64, interface{}, error)

UpdateOne doc @Summary update a piece of data @Method UpdateOne @Param (string) set/table name @Param (interface{}) filter @Param (interface{}) update informat @Return (int64) match of number @Return (int64) modify of number @Return (int64) update of number @Return (interface{}) update id @Return (error)

func (*MongoDB) UpdateOrInsert added in v1.1.0 

func (slf *MongoDB) UpdateOrInsert(name string, filter interface{}, update interface{}) (int64, int64, int64, interface{}, error)

type MongoDeplay 

type MongoDeplay struct {
	Hosts          []string `xml:"hosts" yaml:"hosts" json:"hosts"`
	URI            string   `xml:"uri" yaml:"uri" json:"uri"`
	DBName         string   `xml:"name" yaml:"name" json:"name"`
	MaxPoolSize    int      `xml:"maxpool" yaml:"maxpool" json:"maxpool"`
	MinPoolSize    int      `xml:"minpool" yaml:"minpool" json:"minpool"`
	HeartRate      int      `xml:"heartrate" yaml:"heartrate" json:"heartrate"`
	IdleTime       int      `xml:"idletime" yaml:"idletime" json:"idletime"`
	TimeOut        int      `xml:"timeout" yaml:"timeout" json:"timeout"`
	ConnectTimeout int      `xml:"conntimeout" yaml:"conntimeout" json:"conntimeout"`
}

MongoDeplay doc @Summary mongo config informat @Struct MongoDeplay @Member ([]string) Mongo DB Host Address array @Member (string) Mongo DB URI @Member (int) Mongo DB Max connection Pool of number @Member (int) Mongo DB Min connection Pool of number @Member (int) Mongo DB connection heart beat interval [Unit second] @Member (int) Mongo DB connection idle time [Unit second] @Member (int) Mongo DB Background time out [Unit millisecond] @Member (int) Mongo DB connectiosn socket time out [Unit second]

type MySQLDB 

type MySQLDB struct {
	// contains filtered or unexported fields
}

MySQLDB doc @Summary mysql operation object @Struct MySQLDB @Member (string) mysql connection dsn @Member (*sql.DB) mysql connection object

func (*MySQLDB) Close 

func (slf *MySQLDB) Close()

Close doc @Summary close mysql connection @Method CLose

func (*MySQLDB) Initial 

func (slf *MySQLDB) Initial(dsn string, maxConn, maxIdleConn, lifeSec int) error

Initial doc @Summary initialization mysql DB @Method Initial @Param (string) mysql connection dsn @Param (int) mysql connection max of number @Param (int) mysql connection idle of number @Param (int) mysql connection life time[util/sec] @Return (error) fail:return error, success: return nil

func (*MySQLDB) Insert 

func (slf *MySQLDB) Insert(strSQL string, args ...interface{}) (int64, error)

Insert doc @Summary execute sql Insert @Method Insert @Param (string) Insert sql @Param (...interface{}) sql params @Return (int54) insert of number @Return (error) fail: return error, success: return nil

func (*MySQLDB) Query 

func (slf *MySQLDB) Query(strSQL string, args ...interface{}) (*MySQLReader, error)

Query doc @Summary execute sql query @Method Query @Param (string) query sql @Param (...interface{}) sql params @Return (map[string]interface{}) query result @Return (error) fail: return error, success: return nil

func (*MySQLDB) QueryPage 

func (slf *MySQLDB) QueryPage(fileds, tables, where, order string, page, pageSize int, args ...interface{}) (pageCount int, record *MySQLReader, err error)

QueryPage doc @Summary Query page data @Method Query @Param (string) table files (xxx,xxx) @Param (string) table names (xxx,xxx) @Param (string) query condition @Param (string) query order mode @Param (int) page @Param (int) pageSize @Param (...interface{}) where args @Return (int) pageCount @Return (*dbs.MySQLReader) reader @Return (error) ree

func (*MySQLDB) Update 

func (slf *MySQLDB) Update(strSQL string, args ...interface{}) (int64, error)

Update doc @Summary execute sql Update @Method Update @Param (string) Update sql @Param (...interface{}) sql params @Return (int54) Update of number

type MySQLDeploy 

type MySQLDeploy struct {
	DSN  string `xml:"dsn" yaml:"dsn" json:"dsn"`
	Max  int    `xml:"max" yaml:"max conn" json:"max"`
	Idle int    `xml:"idle" yaml:"idle" json:"idle"`
	Life int    `xml:"life" yaml:"life" json:"life"`
}

MySQLDeploy doc @Summary mysql connection deploy @Struct MySQLDeploy @Member (string) mysql dsn config informat @Member (int) mysql connection max of number @Member (int) mysql connection idle of number @Member (int) mysql connection life time (sec)

type MySQLGORM 

type MySQLGORM struct {
	// contains filtered or unexported fields
}

MySQLGORM mysql gorm

func (*MySQLGORM) Close 

func (slf *MySQLGORM) Close()

Close close gorm db

func (*MySQLGORM) DB 

func (slf *MySQLGORM) DB() *gorm.DB

DB Returns Gorm db

func (*MySQLGORM) Initial 

func (slf *MySQLGORM) Initial(dsn string, maxConn, maxIdleConn, lifeSec int) error

Initial initial mysql gorm

type MySQLGormDeploy 

type MySQLGormDeploy struct {
	DSN  string `xml:"dsn" yaml:"dsn" json:"dsn"`
	Max  int    `xml:"max" yaml:"max" json:"max"`
	Idle int    `xml:"idle" yaml:"idle" json:"idle"`
	Life int    `xml:"life" yaml:"life" json:"life"`
}

MySQLGormDeploy doc @Summary mysql connection deploy @Member (string) mysql dsn config informat @Member (int) mysql connection max of number @Member (int) mysql connection idle of number @Member (int) mysql connection life time (sec)

type MySQLReader 

type MySQLReader struct {
	// contains filtered or unexported fields
}

MySQLReader doc @Summary mysql reader @Struct MySQLReader @Member (int) count row of number @Member (int) read current row in index @Member ([]string) columns name @Member ([]MySQLValue) a mysql value

func (*MySQLReader) Close 

func (slf *MySQLReader) Close()

Close doc @Summary clear data @Method Close

func (*MySQLReader) GetAsNameValue 

func (slf *MySQLReader) GetAsNameValue(name string) (*MySQLValue, error)

GetAsNameValue doc @Summary Return column name to value @Method GetAsNameValue @Return (*MySQLValue) mysql value @Return (error) error informat

func (*MySQLReader) GetColumn 

func (slf *MySQLReader) GetColumn() int

GetColumn doc @Summary Return Column of number @Method GetColumn @Return (int) a number

func (*MySQLReader) GetRow 

func (slf *MySQLReader) GetRow() int

GetRow doc @Summary Return row of number @Method GetRow @Return (int) a number

func (*MySQLReader) GetTryValue 

func (slf *MySQLReader) GetTryValue(idx int) *MySQLValue

GetTryValue doc @Summary Return column index to value @Method GetTryValue @Return (*MySQLValue) mysql value @Return (error) error informat

func (*MySQLReader) GetValue 

func (slf *MySQLReader) GetValue(idx int) (*MySQLValue, error)

GetValue doc @Summary Return column index to value @Method GetValue @Return (*MySQLValue) mysql value @Return (error) error informat

func (*MySQLReader) Next 

func (slf *MySQLReader) Next() bool

Next doc @Summary Return Next row is success @Method Next @Return (bool) Next Success: true Next Fail:false

func (*MySQLReader) Rest 

func (slf *MySQLReader) Rest()

Rest doc @Summary go to first row @Method Rest

type MySQLValue 

type MySQLValue struct {
	// contains filtered or unexported fields
}

MySQLValue doc @Summary mysql result value @Struct MySQLValue @Member interface{} value @Member reflect.Type value type

func (*MySQLValue) IsEmpty 

func (slf *MySQLValue) IsEmpty() bool

IsEmpty doc @Summary Return Is Empty @Method IsEmpty @Return (bool) emtpy: true no empty:false

func (*MySQLValue) Print 

func (slf *MySQLValue) Print()

Print doc @Summary Print value informat @Method Print

func (*MySQLValue) ToByte 

func (slf *MySQLValue) ToByte() []byte

ToByte doc @Summary Return []byte value @Method ToByte @Return ([]byte) a value

func (*MySQLValue) ToDate 

func (slf *MySQLValue) ToDate() *time.Time

ToDate doc @Summary Return time date value @Method ToDate @Return (*time.Time) a value

func (*MySQLValue) ToDateTime 

func (slf *MySQLValue) ToDateTime() *time.Time

ToDateTime doc @Summary Return time date value @Method ToDateTime @Return (*time.Time) a value

func (*MySQLValue) ToDouble 

func (slf *MySQLValue) ToDouble() float64

ToDouble doc @Summary Return float64 value @Method ToDouble @Return (float64) a value

func (*MySQLValue) ToFloat 

func (slf *MySQLValue) ToFloat() float32

ToFloat doc @Summary Return float32 value @Method ToFloat @Return (float32) a value

func (*MySQLValue) ToInt 

func (slf *MySQLValue) ToInt() int

ToInt doc @Summary Return int value @Method ToInt @Return (int) a value

func (*MySQLValue) ToInt32 

func (slf *MySQLValue) ToInt32() int32

ToInt32 doc @Summary Return int32 value @Method ToInt32 @Return (int32) a value

func (*MySQLValue) ToInt64 

func (slf *MySQLValue) ToInt64() int64

ToInt64 doc @Summary Return int64 value @Method ToInt64 @Return (int64) a value

func (*MySQLValue) ToString 

func (slf *MySQLValue) ToString() string

ToString doc @Summary Return string value @Method ToString @Return (string) a string

func (*MySQLValue) ToTimeStamp 

func (slf *MySQLValue) ToTimeStamp() int64

ToTimeStamp doc @Summary Return time int64 value @Method ToTimeStamp @Return (int64) a value

func (*MySQLValue) ToUint 

func (slf *MySQLValue) ToUint() uint

ToUint doc @Summary Return uint value @Method ToUint @Return (uint) a value

func (*MySQLValue) ToUint32 

func (slf *MySQLValue) ToUint32() uint32

ToUint32 doc @Summary Return uint32 value @Method ToUint32 @Return (uint32) a value

func (*MySQLValue) ToUint64 

func (slf *MySQLValue) ToUint64() uint64

ToUint64 doc @Summary Return uint64 value @Method ToUint64 @Return (uint64) a value

type RedisDB 

type RedisDB struct {
	// contains filtered or unexported fields
}

RedisDB doc @Summary redis db opertioner @Struct RedisDB @Member (*redis.Pool) a redis connection pool @Member (string) redis address @Member (int) redis db code

func (*RedisDB) BLPop added in v1.1.0 

func (slf *RedisDB) BLPop(key string, timeout int) (interface{}, error)

BLPop 它是 LPOP 命令的阻塞版本，当给定列表内没有任何元素可供弹出的时候，连接将被 BLPOP 命令阻塞，直到等待超时或发现可弹出元素为止。 超时参数 timeout 接受一个以秒为单位的数字作为值。超时参数设为 0 表示阻塞时间可以无限期延长(block indefinitely) 。

func (*RedisDB) BLPopBool added in v1.1.0 

func (slf *RedisDB) BLPopBool(key string, timeout int) (bool, error)

BLPopBool BLPop的工具方法，元素类型为bool时

func (*RedisDB) BLPopInt added in v1.1.0 

func (slf *RedisDB) BLPopInt(key string, timeout int) (int, error)

BLPopInt BLPop的工具方法，元素类型为int时

func (*RedisDB) BLPopInt64 added in v1.1.0 

func (slf *RedisDB) BLPopInt64(key string, timeout int) (int64, error)

BLPopInt64 BLPop的工具方法，元素类型为int64时

func (*RedisDB) BLPopObject added in v1.1.0 

func (slf *RedisDB) BLPopObject(key string, timeout int, val interface{}) error

BLPopObject BLPop的工具方法，元素类型为object时

func (*RedisDB) BLPopString added in v1.1.0 

func (slf *RedisDB) BLPopString(key string, timeout int) (string, error)

BLPopString BLPop的工具方法，元素类型为string时

func (*RedisDB) BRPop added in v1.1.0 

func (slf *RedisDB) BRPop(key string, timeout int) (interface{}, error)

BRPop 它是 RPOP 命令的阻塞版本，当给定列表内没有任何元素可供弹出的时候，连接将被 BRPOP 命令阻塞，直到等待超时或发现可弹出元素为止。 超时参数 timeout 接受一个以秒为单位的数字作为值。超时参数设为 0 表示阻塞时间可以无限期延长(block indefinitely) 。

func (*RedisDB) BRPopBool added in v1.1.0 

func (slf *RedisDB) BRPopBool(key string, timeout int) (bool, error)

BRPopBool BRPop的工具方法，元素类型为bool时

func (*RedisDB) BRPopInt added in v1.1.0 

func (slf *RedisDB) BRPopInt(key string, timeout int) (int, error)

BRPopInt BRPop的工具方法，元素类型为int时

func (*RedisDB) BRPopInt64 added in v1.1.0 

func (slf *RedisDB) BRPopInt64(key string, timeout int) (int64, error)

BRPopInt64 BRPop的工具方法，元素类型为int64时

func (*RedisDB) BRPopObject added in v1.1.0 

func (slf *RedisDB) BRPopObject(key string, timeout int, val interface{}) error

BRPopObject BRPop的工具方法，元素类型为object时

func (*RedisDB) BRPopString added in v1.1.0 

func (slf *RedisDB) BRPopString(key string, timeout int) (string, error)

BRPopString BRPop的工具方法，元素类型为string时

func (*RedisDB) Close 

func (slf *RedisDB) Close()

Close doc @Summary close redis db operation @Method Close

func (*RedisDB) Decr added in v1.1.0 

func (slf *RedisDB) Decr(key string) (val int64, err error)

Decr 将 key 中储存的数字值减一。

func (*RedisDB) DecrBy added in v1.1.0 

func (slf *RedisDB) DecrBy(key string, amount int64) (val int64, err error)

DecrBy key 所储存的值减去给定的减量值（decrement）。

func (*RedisDB) Del added in v1.1.0 

func (slf *RedisDB) Del(key string) error

Del 删除键

func (*RedisDB) Do 

func (slf *RedisDB) Do(commandName string, args ...interface{}) (interface{}, error)

Do doc @Summary execute redis command @Method Do @Param (string) command name @Param (...interface{}) command params @Return (interface{}) execute result @Return (error) if execute fail return error, execute success return nil

func (*RedisDB) Exists added in v1.1.0 

func (slf *RedisDB) Exists(key string) (bool, error)

Exists 检查键是否存在

func (*RedisDB) Expire added in v1.1.0 

func (slf *RedisDB) Expire(key string, expire int64) error

Expire 设置键过期时间，expire的单位为秒

func (*RedisDB) Flush added in v1.1.0 

func (slf *RedisDB) Flush() error

Flush 清空当前数据库中的所有 key，慎用！

func (*RedisDB) Get added in v1.1.0 

func (slf *RedisDB) Get(key string) (interface{}, error)

Get 获取键值。

func (*RedisDB) GetBool added in v1.1.0 

func (slf *RedisDB) GetBool(key string) (bool, error)

GetBool 获取bool类型的键值

func (*RedisDB) GetInt added in v1.1.0 

func (slf *RedisDB) GetInt(key string) (int, error)

GetInt 获取int类型的键值

func (*RedisDB) GetInt64 added in v1.1.0 

func (slf *RedisDB) GetInt64(key string) (int64, error)

GetInt64 获取int64类型的键值

func (*RedisDB) GetKeys added in v1.1.0 

func (slf *RedisDB) GetKeys(key string) ([]string, error)

func (*RedisDB) GetObject added in v1.1.0 

func (slf *RedisDB) GetObject(key string, val interface{}) error

GetObject 获取非基本类型stuct的键值。在实现上，使用json的Marshal和Unmarshal做序列化存取。

func (*RedisDB) GetString added in v1.1.0 

func (slf *RedisDB) GetString(key string) (string, error)

GetString 获取string类型的键值

func (*RedisDB) HGet added in v1.1.0 

func (slf *RedisDB) HGet(key, field string) (reply interface{}, err error)

HGet 获取存储在哈希表中指定字段的值 Example:

```golang val, err := slf.HGet("user", "age") ```

func (*RedisDB) HGetAll added in v1.1.0 

func (slf *RedisDB) HGetAll(key string, val interface{}) error

HGetAll HGetAll("key", &val)

func (*RedisDB) HGetBool added in v1.1.0 

func (slf *RedisDB) HGetBool(key, field string) (reply bool, err error)

HGetBool HGet的工具方法，当字段值为bool类型时使用

func (*RedisDB) HGetInt added in v1.1.0 

func (slf *RedisDB) HGetInt(key, field string) (reply int, err error)

HGetInt HGet的工具方法，当字段值为int类型时使用

func (*RedisDB) HGetInt64 added in v1.1.0 

func (slf *RedisDB) HGetInt64(key, field string) (reply int64, err error)

HGetInt64 HGet的工具方法，当字段值为int64类型时使用

func (*RedisDB) HGetObject added in v1.1.0 

func (slf *RedisDB) HGetObject(key, field string, val interface{}) error

HGetObject HGet的工具方法，当字段值为非基本类型的stuct时使用

func (*RedisDB) HGetString added in v1.1.0 

func (slf *RedisDB) HGetString(key, field string) (reply string, err error)

HGetString HGet的工具方法，当字段值为字符串类型时使用

func (*RedisDB) HMSet added in v1.1.0 

func (slf *RedisDB) HMSet(key string, val interface{}, expire int) (err error)

HMSet 将一个map存到Redis hash，同时设置有效期，单位：秒 Example:

```golang m := make(map[string]interface{}) m["name"] = "corel" m["age"] = 23 err := slf.HMSet("user", m, 10) ```

func (*RedisDB) HSet added in v1.1.0 

func (slf *RedisDB) HSet(key, field string, val interface{}) (interface{}, error)

HSet 将哈希表 key 中的字段 field 的值设为 val Example:

```golang _, err := slf.HSet("user", "age", 23) ```

func (*RedisDB) Incr added in v1.1.0 

func (slf *RedisDB) Incr(key string) (val int64, err error)

Incr 将 key 中储存的数字值增一

func (*RedisDB) IncrBy added in v1.1.0 

func (slf *RedisDB) IncrBy(key string, amount int64) (val int64, err error)

IncrBy 将 key 所储存的值加上给定的增量值（increment）。

func (*RedisDB) Initial 

func (slf *RedisDB) Initial(host, pwd string, db int, maxIdle int, maxActive int, idleSec int) error

Initial doc @Summary initialization Redis DB @Method Initial @Param (string) redis host address @Param (string) redis password @Param (int) redis db code @Param (int) redis connection max idle of number @Param (int) redis connection max active of number @Param (int) redis connection idle time (unit/sec) @Return (error) if connecting fail return error ,success return nil

func (*RedisDB) Initial2 added in v1.1.0 

func (slf *RedisDB) Initial2(options interface{}) error

Initial2 doc @Summary initialization Redis DB @Method Initial @Return (error) if connecting fail return error ,success return nil

func (*RedisDB) LLen added in v1.1.0 

func (slf *RedisDB) LLen(key string) (int64, error)

LLen 获取列表的长度

func (*RedisDB) LPop added in v1.1.0 

func (slf *RedisDB) LPop(key string) (interface{}, error)

LPop 移出并获取列表中的第一个元素（表头，左边）

func (*RedisDB) LPopBool added in v1.1.0 

func (slf *RedisDB) LPopBool(key string) (bool, error)

LPopBool 移出并获取列表中的第一个元素（表头，左边），元素类型为bool

func (*RedisDB) LPopInt added in v1.1.0 

func (slf *RedisDB) LPopInt(key string) (int, error)

LPopInt 移出并获取列表中的第一个元素（表头，左边），元素类型为int

func (*RedisDB) LPopInt64 added in v1.1.0 

func (slf *RedisDB) LPopInt64(key string) (int64, error)

LPopInt64 移出并获取列表中的第一个元素（表头，左边），元素类型为int64

func (*RedisDB) LPopObject added in v1.1.0 

func (slf *RedisDB) LPopObject(key string, val interface{}) error

LPopObject 移出并获取列表中的第一个元素（表头，左边），元素类型为非基本类型的struct

func (*RedisDB) LPopString added in v1.1.0 

func (slf *RedisDB) LPopString(key string) (string, error)

LPopString 移出并获取列表中的第一个元素（表头，左边），元素类型为string

func (*RedisDB) LPush added in v1.1.0 

func (slf *RedisDB) LPush(key string, member interface{}) error

LPush 将一个值插入到列表头部

func (*RedisDB) LREM added in v1.1.0 

func (slf *RedisDB) LREM(key string, count int, member interface{}) (int, error)

LREM 根据参数 count 的值，移除列表中与参数 member 相等的元素。 count 的值可以是以下几种： count > 0 : 从表头开始向表尾搜索，移除与 member 相等的元素，数量为 count 。 count < 0 : 从表尾开始向表头搜索，移除与 member 相等的元素，数量为 count 的绝对值。 count = 0 : 移除表中所有与 member 相等的值。 返回值：被移除元素的数量。

func (*RedisDB) LRange added in v1.1.0 

func (slf *RedisDB) LRange(key string, start, end int) (interface{}, error)

LRange 返回列表 key 中指定区间内的元素，区间以偏移量 start 和 stop 指定。 下标(index)参数 start 和 stop 都以 0 为底，也就是说，以 0 表示列表的第一个元素，以 1 表示列表的第二个元素，以此类推。 你也可以使用负数下标，以 -1 表示列表的最后一个元素， -2 表示列表的倒数第二个元素，以此类推。 和编程语言区间函数的区别：end 下标也在 LRANGE 命令的取值范围之内(闭区间)。

func (*RedisDB) RPop added in v1.1.0 

func (slf *RedisDB) RPop(key string) (interface{}, error)

RPop 移出并获取列表中的最后一个元素（表尾，右边）

func (*RedisDB) RPopBool added in v1.1.0 

func (slf *RedisDB) RPopBool(key string) (bool, error)

RPopBool 移出并获取列表中的最后一个元素（表尾，右边），元素类型为bool

func (*RedisDB) RPopInt added in v1.1.0 

func (slf *RedisDB) RPopInt(key string) (int, error)

RPopInt 移出并获取列表中的最后一个元素（表尾，右边），元素类型为int

func (*RedisDB) RPopInt64 added in v1.1.0 

func (slf *RedisDB) RPopInt64(key string) (int64, error)

RPopInt64 移出并获取列表中的最后一个元素（表尾，右边），元素类型为int64

func (*RedisDB) RPopObject added in v1.1.0 

func (slf *RedisDB) RPopObject(key string, val interface{}) error

RPopObject 移出并获取列表中的最后一个元素（表尾，右边），元素类型为非基本类型的struct

func (*RedisDB) RPopString added in v1.1.0 

func (slf *RedisDB) RPopString(key string) (string, error)

RPopString 移出并获取列表中的最后一个元素（表尾，右边），元素类型为string

func (*RedisDB) RPush added in v1.1.0 

func (slf *RedisDB) RPush(key string, member interface{}) error

RPush 将一个值插入到列表尾部

func (*RedisDB) Set added in v1.1.0 

func (slf *RedisDB) Set(key string, val interface{}, expire int64) error

Set doc @Summary set value @param key @param value @param expire

func (*RedisDB) TTL added in v1.1.0 

func (slf *RedisDB) TTL(key string) (ttl int64, err error)

TTL 以秒为单位。当 key 不存在时，返回 -2 。 当 key 存在但没有设置剩余生存时间时，返回 -1

func (*RedisDB) ZAdd added in v1.1.0 

func (slf *RedisDB) ZAdd(key string, score int64, member string) (reply interface{}, err error)

ZAdd 将一个 member 元素及其 score 值加入到有序集 key 当中。

func (*RedisDB) ZRange added in v1.1.0 

func (slf *RedisDB) ZRange(key string, from, to int64) (map[string]int64, error)

ZRange 返回有序集中，指定区间内的成员。其中成员的位置按分数值递增(从小到大)来排序。具有相同分数值的成员按字典序(lexicographical order )来排列。 以 0 表示有序集第一个成员，以 1 表示有序集第二个成员，以此类推。或 以 -1 表示最后一个成员， -2 表示倒数第二个成员，以此类推。

func (*RedisDB) ZRangeByScore added in v1.1.0 

func (slf *RedisDB) ZRangeByScore(key string, from, to, offset int64, count int) (map[string]int64, error)

ZRangeByScore 返回有序集合中指定分数区间的成员列表。有序集成员按分数值递增(从小到大)次序排列。 具有相同分数值的成员按字典序来排列

func (*RedisDB) ZRank added in v1.1.0 

func (slf *RedisDB) ZRank(key, member string) (int64, error)

ZRank 返回有序集中指定成员的排名。其中有序集成员按分数值递增(从小到大)顺序排列。score 值最小的成员排名为 0

func (*RedisDB) ZRem added in v1.1.0 

func (slf *RedisDB) ZRem(key string, member string) (reply interface{}, err error)

ZRem 移除有序集 key 中的一个成员，不存在的成员将被忽略。

func (*RedisDB) ZRevrange added in v1.1.0 

func (slf *RedisDB) ZRevrange(key string, from, to int64) (map[string]int64, error)

ZRevrange 返回有序集中，指定区间内的成员。其中成员的位置按分数值递减(从大到小)来排列。具有相同分数值的成员按字典序(lexicographical order )来排列。 以 0 表示有序集第一个成员，以 1 表示有序集第二个成员，以此类推。或 以 -1 表示最后一个成员， -2 表示倒数第二个成员，以此类推。

func (*RedisDB) ZRevrangeByScore added in v1.1.0 

func (slf *RedisDB) ZRevrangeByScore(key string, from, to, offset int64, count int) (map[string]int64, error)

ZRevrangeByScore 返回有序集中指定分数区间内的所有的成员。有序集成员按分数值递减(从大到小)的次序排列。 具有相同分数值的成员按字典序来排列

func (*RedisDB) ZRevrank added in v1.1.0 

func (slf *RedisDB) ZRevrank(key, member string) (int64, error)

ZRevrank 返回有序集中成员的排名。其中有序集成员按分数值递减(从大到小)排序。分数值最大的成员排名为 0 。

func (*RedisDB) ZScore added in v1.1.0 

func (slf *RedisDB) ZScore(key string, member string) (int64, error)

ZScore 返回有序集 key 中，成员 member 的 score 值。 如果 member 元素不是有序集 key 的成员，或 key 不存在，返回 nil 。

type RedisDeploy 

type RedisDeploy struct {
	Host      string `xml:"host" yaml:"host" json:"host"`
	Pwd       string `xml:"password"  yaml:"password" json:"password"`
	DB        int    `xml:"db" yaml:"db" json:"db"`
	MaxIdle   int    `xml:"idle" yaml:"idle" json:"idle"`
	MaxActive int    `xml:"active" yaml:"active" json:"active"`
	IdleTime  int    `xml:"idletime" yaml:"idletime" json:"idletime"`
}

RedisDeploy doc @Summary redis configureation json @Struct RedisDeploy @Member (string) Redis Host from json "host" @Member (int) Redis DB select from json "db" @Member (int) Redis Connection max idle of number from json "idle" @Member (int) Redis Connection max active of number from json "active" @Member (int) Redis Connection idle time from json "idle-time" util/sec

type RedisDeployArray 

type RedisDeployArray struct {
	Deploys []RedisDeploy `xml:"redis" yaml:"redis" json:"redis"`
}

RedisDeployArray doc @Summary redis group configureation json @Struct RedisDeployArray @Member ([]RedisDeploy) a redis configureation

type RedisOptions added in v1.1.0 

type RedisOptions struct {
	Network     string                                 // 通讯协议，默认为 tcp
	Addr        string                                 // redis服务的地址，默认为 127.0.0.1:6379
	Password    string                                 // redis鉴权密码
	Db          int                                    // 数据库
	MaxActive   int                                    // 最大活动连接数，值为0时表示不限制
	MaxIdle     int                                    // 最大空闲连接数
	IdleTimeout int                                    // 空闲连接的超时时间，超过该时间则关闭连接。单位为秒。默认值是5分钟。值为0时表示不关闭空闲连接。此值应该总是大于redis服务的超时时间。
	Prefix      string                                 // 键名前缀
	Marshal     func(v interface{}) ([]byte, error)    // 数据序列化方法，默认使用json.Marshal序列化
	Unmarshal   func(data []byte, v interface{}) error // 数据反序列化方法，默认使用json.Unmarshal序列化
}

RedisOptions redis配置参数

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.