ormx

package module

Go to main page

Versions in this module

v1

v1.5.0

Jul 30, 2026

v1.4.1

Jul 30, 2026

v1.4.0

Jul 30, 2026

v1.3.0

Jul 24, 2026

Changes in this version

+ var ErrDSNUnsupported = errors.New("ormx: dsn settings not supported")

type Client

+ func (c *Client) Transaction(ctx context.Context, fn func(tx *gorm.DB) error, txOpts ...TxOption) error

type MySQLConfig

+ Charset string

type Option

+ func WithCharset(charset string) Option

+ func WithDSN(dsn string) Option

+ func WithZapLogger(zlog *zap.Logger, opts ...zlogger.Option) Option

v1.2.0

Jul 23, 2026

Changes in this version

+ var ErrAddressRequired = errors.New("ormx: mysql address is required")

+ var ErrNilSQLDB = errors.New("ormx: nil *sql.DB")

+ var ErrNilTxFunc = errors.New("ormx: nil transaction function")

+ var ErrSystemVariableNameRequired = errors.New("ormx: system variable name must not be empty")

type MySQLConfig

+ SystemVariables map[string]string

+ func (c MySQLConfig) GoString() string

+ func (c MySQLConfig) String() string

type Option

+ func WithSystemVariable(key, value string) Option

+ func WithSystemVariables(params map[string]string) Option

v1.1.3

Jul 21, 2026

Changes in this version

type Option

+ func WithZlogger(opts ...zlogger.Option) Option

v1.1.2

Jul 21, 2026

v1.1.1

Jul 6, 2026

Changes in this version

+ const HealthStatusDegraded

+ const HealthStatusDown

+ const HealthStatusUp

+ const NodeStateDown

+ const NodeStateDraining

+ const NodeStateReady

+ const RolePrimary

+ const RoleReplica

+ const RoleStandalone

+ const Version

+ var ErrClusterClosed = errors.New("ormx: cluster is closed")

+ var ErrNoReadableNode = errors.New("ormx: no readable node available")

+ var ErrPrimaryUnavailable = errors.New("ormx: primary unavailable")

+ func ContextClearWriteFlag(ctx context.Context) context.Context

+ func ContextWithWriteFlag(ctx context.Context) context.Context

+ func ContextWithWriteWindow(ctx context.Context, ttl time.Duration) context.Context

+ func HasWriteFlag(ctx context.Context) bool

+ type Client struct

+ func MustOpen(ctx context.Context, opts ...Option) *Client

+ func Open(ctx context.Context, opts ...Option) (*Client, error)

+ func OpenWithDB(ctx context.Context, sqlDB *sql.DB, opts ...Option) (*Client, error)

+ func (c *Client) Close() error

+ func (c *Client) Config() Config

+ func (c *Client) DB() *gorm.DB

+ func (c *Client) HealthCheck(ctx context.Context) HealthReport

+ func (c *Client) Metrics() []MetricSample

+ func (c *Client) Name() string

+ func (c *Client) PingContext(ctx context.Context) error

+ func (c *Client) SQLDB() *sql.DB

+ func (c *Client) Stats() sql.DBStats

+ func (c *Client) StatsSnapshot() DBStatsSnapshot

+ func (c *Client) WithReadTx(ctx context.Context, fn func(tx *gorm.DB) error) error

+ func (c *Client) WithTx(ctx context.Context, opts *sql.TxOptions, fn func(tx *gorm.DB) error, ...) error

+ type Cluster struct

+ func NewCluster(primary *Client, replicas ...*Client) (*Cluster, error)

+ func NewClusterWithOptions(primary *Client, replicas []*Client, opts ...ClusterOption) (*Cluster, error)

+ func OpenCluster(ctx context.Context, primary Config, replicas ...Config) (*Cluster, error)

+ func OpenClusterWithOptions(ctx context.Context, primary Config, replicas []Config, opts ...ClusterOption) (_ *Cluster, err error)

+ func (c *Cluster) Close() error

+ func (c *Cluster) DrainReplica(name string, cause error) error

+ func (c *Cluster) HealthCheck(ctx context.Context) ClusterHealthReport

+ func (c *Cluster) MarkPrimaryDown(cause error) error

+ func (c *Cluster) Metrics() []MetricSample

+ func (c *Cluster) MustReadDB() *gorm.DB

+ func (c *Cluster) MustWriteDB() *gorm.DB

+ func (c *Cluster) Nodes() []Node

+ func (c *Cluster) Primary() *Client

+ func (c *Cluster) PrimaryNode() Node

+ func (c *Cluster) ReadDB() *gorm.DB

+ func (c *Cluster) ReadDBCtx(ctx context.Context) *gorm.DB

+ func (c *Cluster) Reader() *Client

+ func (c *Cluster) ReaderClient() (*Client, error)

+ func (c *Cluster) ReaderClientCtx(ctx context.Context) (*Client, error)

+ func (c *Cluster) RecoverReplica(ctx context.Context, name string) error

+ func (c *Cluster) Refresh(ctx context.Context) ClusterHealthReport

+ func (c *Cluster) ReplicaNodes() []Node

+ func (c *Cluster) RunHealthLoop(ctx context.Context, interval time.Duration) error

+ func (c *Cluster) SwitchPrimary(ctx context.Context, name string) (Node, error)

+ func (c *Cluster) WithReadTx(ctx context.Context, fn func(tx *gorm.DB) error) error

+ func (c *Cluster) WithTx(ctx context.Context, fn func(tx *gorm.DB) error, txOpts ...TxOption) error

+ func (c *Cluster) WriteClient() (*Client, error)

+ func (c *Cluster) WriteDB() *gorm.DB

+ type ClusterHealthReport struct

+ CheckedAt time.Time

+ Nodes []HealthReport

+ Status HealthStatus

+ func (r ClusterHealthReport) Healthy() bool

+ type ClusterOption func(*clusterOptions)

+ func WithAutoRecoverReplicas(enabled bool) ClusterOption

+ func WithHealthCheckTimeout(timeout time.Duration) ClusterOption

+ func WithReadFallbackToPrimary(enabled bool) ClusterOption

+ type Config struct

+ Dialect MySQLDialectConfig

+ GORM GORMConfig

+ HealthProbe HealthProbeFunc

+ MySQL MySQLConfig

+ Name string

+ Pool PoolConfig

+ StartupPing bool

+ StartupPingMaxRetries int

+ StartupPingRetryBaseWait time.Duration

+ StartupPingRetryMaxWait time.Duration

+ TxRetryObserver TxRetryObserver

+ func DefaultConfig() Config

+ func NewConfig(opts ...Option) Config

+ func (c Config) Clone() Config

+ func (c Config) DriverConfig() (*mysqldriver.Config, error)

+ func (c Config) GoString() string

+ func (c Config) MustOpen(ctx context.Context) *Client

+ func (c Config) Open(ctx context.Context) (*Client, error)

+ func (c Config) OpenWithDB(ctx context.Context, sqlDB *sql.DB) (*Client, error)

+ func (c Config) RedactedDSN() (string, error)

+ func (c Config) String() string

+ func (c Config) With(opts ...Option) Config

+ type DBStatsSnapshot struct

+ Idle int

+ InUse int

+ MaxIdleClosed int64

+ MaxIdleTimeClosed int64

+ MaxLifetimeClosed int64

+ MaxOpenConnections int

+ OpenConnections int

+ Utilization float64

+ WaitCount int64

+ WaitDuration time.Duration

+ type GORMConfig struct

+ AllowGlobalUpdate bool

+ CreateBatchSize int

+ DefaultContextTimeout time.Duration

+ DefaultTransactionTimeout time.Duration

+ DisableForeignKeyConstraintWhenMigrating bool

+ DisableNestedTransaction bool

+ DryRun bool

+ IgnoreRelationshipsWhenMigrating bool

+ Logger gormlogger.Interface

+ NamingStrategy schema.NamingStrategy

+ NowFunc func() time.Time

+ PrepareStmt bool

+ PrepareStmtMaxSize int

+ PrepareStmtTTL time.Duration

+ PropagateUnscoped bool

+ QueryFields bool

+ SkipDefaultTransaction bool

+ TranslateError bool

+ type HealthProbeFunc func(ctx context.Context, client *Client, role NodeRole) error

+ type HealthReport struct

+ CheckedAt time.Time

+ Duration time.Duration

+ Error error

+ Name string

+ Role NodeRole

+ State NodeState

+ Stats DBStatsSnapshot

+ Status HealthStatus

+ func (r HealthReport) Healthy() bool

+ type HealthStatus string

+ type MetricSample struct

+ Labels map[string]string

+ Name string

+ Value float64

+ type MySQLConfig struct

+ Addr string

+ Collation string

+ ConnectionAttributes string

+ Database string

+ Host string

+ Loc *time.Location

+ Net string

+ Params map[string]string

+ ParseTime bool

+ Password string

+ Port string

+ ReadTimeout time.Duration

+ TLSConfig string

+ Timeout time.Duration

+ User string

+ WriteTimeout time.Duration

+ type MySQLDialectConfig struct

+ DefaultDatetimePrecision *int

+ DefaultStringSize uint

+ DisableDatetimePrecision bool

+ DisableWithReturning bool

+ DontSupportDropConstraint bool

+ DontSupportForShareClause bool

+ DontSupportNullAsDefaultValue bool

+ DontSupportRenameColumn bool

+ DontSupportRenameColumnUnique bool

+ DontSupportRenameIndex bool

+ DriverName string

+ ServerVersion string

+ SkipInitializeWithVersion bool

+ type Node struct

+ func (n Node) Client() *Client

+ func (n Node) HealthCheck(ctx context.Context) HealthReport

+ func (n Node) Healthy() bool

+ func (n Node) LastError() error

+ func (n Node) Metrics() []MetricSample

+ func (n Node) Name() string

+ func (n Node) Role() NodeRole

+ func (n Node) State() NodeState

+ func (n Node) UpdatedAt() time.Time

+ type NodeRole string

+ type NodeState string

+ type Option func(*Config)

+ func WithAddress(addr string) Option

+ func WithCollation(collation string) Option

+ func WithConnMaxIdleTime(duration time.Duration) Option

+ func WithConnMaxLifetime(duration time.Duration) Option

+ func WithConnectionAttributes(attrs string) Option

+ func WithCreateBatchSize(size int) Option

+ func WithDSNParam(key, value string) Option

+ func WithDSNParams(params map[string]string) Option

+ func WithDatabase(name string) Option

+ func WithDefaultContextTimeout(timeout time.Duration) Option

+ func WithDefaultStringSize(size uint) Option

+ func WithDefaultTransactionTimeout(timeout time.Duration) Option

+ func WithDisableDatetimePrecision(disable bool) Option

+ func WithDisableWithReturning(disable bool) Option

+ func WithDriverName(name string) Option

+ func WithDryRun(enabled bool) Option

+ func WithGormLogger(log gormlogger.Interface) Option

+ func WithHealthProbe(probe HealthProbeFunc) Option

+ func WithHost(host string) Option

+ func WithLocation(loc *time.Location) Option

+ func WithMaxIdleConns(size int) Option

+ func WithMaxOpenConns(size int) Option

+ func WithName(name string) Option

+ func WithNamingStrategy(strategy schema.NamingStrategy) Option

+ func WithNetwork(network string) Option

+ func WithNowFunc(now func() time.Time) Option

+ func WithParseTime(enabled bool) Option

+ func WithPassword(password string) Option

+ func WithPort(port string) Option

+ func WithPrepareStmt(enabled bool) Option

+ func WithPrepareStmtCache(maxSize int, ttl time.Duration) Option

+ func WithQueryFields(enabled bool) Option

+ func WithReadTimeout(timeout time.Duration) Option

+ func WithServerVersion(version string) Option

+ func WithSingularTable(enabled bool) Option

+ func WithSkipDefaultTransaction(skip bool) Option

+ func WithSkipInitializeWithVersion(skip bool) Option

+ func WithStartupPing(enabled bool) Option

+ func WithStartupPingRetry(maxRetries int, baseWait, maxWait time.Duration) Option

+ func WithTLSConfig(name string) Option

+ func WithTablePrefix(prefix string) Option

+ func WithTimeout(timeout time.Duration) Option

+ func WithTranslateError(enabled bool) Option

+ func WithTxRetryObserver(observer TxRetryObserver) Option

+ func WithUser(user string) Option

+ func WithWriteTimeout(timeout time.Duration) Option

+ type PoolConfig struct

+ ConnMaxIdleTime time.Duration

+ ConnMaxLifetime time.Duration

+ MaxIdleConns int

+ MaxOpenConns int

+ type TxOption func(*txOptions)

+ func WithMaxRetries(n int) TxOption

+ func WithRetryBaseWait(d time.Duration) TxOption

+ func WithRetryMaxWait(d time.Duration) TxOption

+ type TxRetryEvent struct

+ Attempt int

+ ClientName string

+ Err error

+ MaxRetries int

+ Wait time.Duration

+ type TxRetryObserver func(ctx context.Context, event TxRetryEvent)

v1.1.0

Jun 16, 2026

v1.0.4

Jun 12, 2026

v1.0.3

Jun 12, 2026

v1.0.2

Jun 12, 2026

v1.0.1

Jun 11, 2026

v1.0.0

Jun 10, 2026

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL