Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

polardbx

package module

Go to main page

Versions in this module

v1

v1.0.4-21-alpha

Feb 26, 2026

v1.0.4-21

Feb 26, 2026

v1.0.4-18

Feb 26, 2026

v1.0.4-15

Feb 26, 2026

v1.0.3-21

Jan 15, 2026

v1.0.3-18

Jan 15, 2026

v1.0.3-15

Jan 15, 2026

v1.0.2-18-beta

Jan 15, 2026

v1.0.2-18-alpha

Jan 12, 2026

v1.0.2-18

Jan 15, 2026

v1.0.1

Dec 25, 2025

Changes in this version

+ const ILLEGAL_CHARS

+ const LevelDebug

+ const LevelError

+ const LevelInfo

+ const LevelSilent

+ const LevelWarn

+ var ErrClusterMismatch = errors.New("cluster id mismatch")

+ var ErrInvalidDSNAddr = errors.New("invalid DSN: network address not terminated (missing closing brace)")

+ var ErrInvalidDSNNoSlash = errors.New("invalid DSN: missing the slash separating the database name")

+ var ErrInvalidDSNUnescaped = errors.New("invalid DSN: did you forget to escape a param value?")

+ var ErrInvalidPort = errors.New("invalid port number")

+ var ErrNoNodeFound = errors.New("communications link failure: no available nodes meet the conditions")

+ var Version = "v1.0.1"

+ func IsEnabledFor(l int) bool

+ func NewConnector(pCfg *PolarDBXConfig) (driver.Connector, error)

+ func ParseLevel(levelStr string) int

+ func SetLevel(l int)

+ type Address struct

+ Hostname string

+ Port int32

+ type BasicInFoQuery struct

+ ClusterID int64

+ Port int32

+ Version string

+ type HaManager struct

+ func GetManager(pCfg *PolarDBXConfig) (*HaManager, error)

+ func (hm *HaManager) CnHaChecker()

+ func (hm *HaManager) DnHaChecker()

+ type LeaderTransferInfo struct

+ type Logger struct

+ func (logger *Logger) Debug(msg string, enableLog bool)

+ func (logger *Logger) Error(msg string, enableLog bool)

+ func (logger *Logger) ErrorWithStack(err error, enableLog bool)

+ func (logger *Logger) Info(msg string, enableLog bool)

+ func (logger *Logger) Warn(msg string, enableLog bool)

+ type MppInfo struct

+ InstanceName string

+ IsLeader string

+ LoadWeight int64

+ Role string

+ Tag string

+ ZoneList []string

+ type NodeWithLoadWeight struct

+ LoadWeight int64

+ Tag string

+ type PolarDBXConfig struct

+ Addr string

+ ApplyDelayThreshold int32

+ BackupCnGroup string

+ BackupZoneName string

+ CheckLeaderTransferringIntervalMillis int32

+ ClusterID int64

+ CnGroup string

+ Dbname string

+ DirectMode bool

+ EnableFollowerRead int32

+ EnableLog bool

+ EnableProbeLog bool

+ HaCheckConnectTimeoutMillis int32

+ HaCheckIntervalMillis int32

+ HaCheckSocketTimeoutMillis int32

+ HaTimeoutMillis int32

+ IgnoreVip bool

+ InstanceName string

+ JsonFile string

+ LeaderTransferringWaitTimeoutMillis int32

+ LoadBalanceAlgorithm string

+ MinZoneNodes int32

+ MppRole string

+ MysqlParams map[string]string

+ Net string

+ Passwd string

+ PropertiesSet mapset.Set

+ RecordJdbcUrl bool

+ SlaveOnly bool

+ SlaveWeightThreshold int32

+ SmoothSwitchover bool

+ User string

+ ZoneName string

+ func NewPolarDBXConfig() *PolarDBXConfig

+ func ParsePolarDBXDSN(dsn string) (pCfg *PolarDBXConfig, err error)

+ func (pCfg *PolarDBXConfig) Clone() *PolarDBXConfig

+ func (pCfg *PolarDBXConfig) FormatMYSQLDSN(addr string) (string, bool)

+ func (pCfg *PolarDBXConfig) FormatPolarDBXDSN(addr string) string

+ type PolarDBXDriver struct

+ func (d PolarDBXDriver) Open(dsn string) (driver.Conn, error)

+ func (d PolarDBXDriver) OpenConnector(dsn string) (driver.Connector, error)

+ type XClusterInfo struct

+ GlobalPortGap int32

+ LeaderInfo *XClusterNodeBasic

+ LeaderTransferInfo *LeaderTransferInfo

+ LongConnection *sql.Conn

+ type XClusterNodeBasic struct

+ ClusterID int64

+ Connectable bool

+ Host string

+ PaxosPort int32

+ Peers []*XClusterNodeBasic

+ Port int32

+ Role string

+ Tag string

+ UpdateTime string

+ Version string

+ func (n *XClusterNodeBasic) Equals(other *XClusterNodeBasic) bool

+ func (x *XClusterNodeBasic) String() string

v1.0.1-21

Jan 12, 2026

v1.0.1-18

Jan 12, 2026

v1.0.0

Aug 15, 2025