Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: typo #2986

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,16 +169,16 @@ By default, go-redis automatically sends the client library name and version dur

#### Disabling Identity Verification

When connection identity verification is not required or needs to be explicitly disabled, a `DisableIndentity` configuration option exists. In V10 of this library, `DisableIndentity` will become `DisableIdentity` in order to fix the associated typo.
When connection identity verification is not required or needs to be explicitly disabled, a `DisableIdentity` configuration option exists. In V10 of this library, `DisableIdentity` will become `DisableIdentity` in order to fix the associated typo.

To disable verification, set the `DisableIndentity` option to `true` in the Redis client options:
To disable verification, set the `DisableIdentity` option to `true` in the Redis client options:

```go
rdb := redis.NewClient(&redis.Options{
Addr: "localhost:6379",
Password: "",
DB: 0,
DisableIndentity: true, // Disable set-info on connect
DisableIdentity: true, // Disable set-info on connect
})
```

Expand Down
4 changes: 2 additions & 2 deletions bench_decode_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ func NewClientStub(resp []byte) *ClientStub {
Dialer: func(ctx context.Context, network, addr string) (net.Conn, error) {
return stub.stubConn(initHello), nil
},
DisableIndentity: true,
DisableIdentity: true,
})
return stub
}
Expand All @@ -46,7 +46,7 @@ func NewClusterClientStub(resp []byte) *ClientStub {
Dialer: func(ctx context.Context, network, addr string) (net.Conn, error) {
return stub.stubConn(initHello), nil
},
DisableIndentity: true,
DisableIdentity: true,

ClusterSlots: func(_ context.Context) ([]ClusterSlot, error) {
return []ClusterSlot{
Expand Down
2 changes: 1 addition & 1 deletion options.go
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ type Options struct {
readOnly bool

// Disable set-lib on connect. Default is false.
DisableIndentity bool
DisableIdentity bool

// Add suffix to client name. Default is empty.
IdentitySuffix string
Expand Down
26 changes: 13 additions & 13 deletions osscluster.go
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ type ClusterOptions struct {
ConnMaxIdleTime time.Duration
ConnMaxLifetime time.Duration

TLSConfig *tls.Config
DisableIndentity bool // Disable set-lib on connect. Default is false.
TLSConfig *tls.Config
DisableIdentity bool // Disable set-lib on connect. Default is false.

IdentitySuffix string // Add suffix to client name. Default is empty.
}
Expand Down Expand Up @@ -286,17 +286,17 @@ func (opt *ClusterOptions) clientOptions() *Options {
WriteTimeout: opt.WriteTimeout,
ContextTimeoutEnabled: opt.ContextTimeoutEnabled,

PoolFIFO: opt.PoolFIFO,
PoolSize: opt.PoolSize,
PoolTimeout: opt.PoolTimeout,
MinIdleConns: opt.MinIdleConns,
MaxIdleConns: opt.MaxIdleConns,
MaxActiveConns: opt.MaxActiveConns,
ConnMaxIdleTime: opt.ConnMaxIdleTime,
ConnMaxLifetime: opt.ConnMaxLifetime,
DisableIndentity: opt.DisableIndentity,
IdentitySuffix: opt.IdentitySuffix,
TLSConfig: opt.TLSConfig,
PoolFIFO: opt.PoolFIFO,
PoolSize: opt.PoolSize,
PoolTimeout: opt.PoolTimeout,
MinIdleConns: opt.MinIdleConns,
MaxIdleConns: opt.MaxIdleConns,
MaxActiveConns: opt.MaxActiveConns,
ConnMaxIdleTime: opt.ConnMaxIdleTime,
ConnMaxLifetime: opt.ConnMaxLifetime,
DisableIdentity: opt.DisableIdentity,
IdentitySuffix: opt.IdentitySuffix,
TLSConfig: opt.TLSConfig,
// If ClusterSlots is populated, then we probably have an artificial
// cluster whose nodes are not in clustering mode (otherwise there isn't
// much use for ClusterSlots config). This means we cannot execute the
Expand Down
2 changes: 1 addition & 1 deletion redis.go
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ func (c *baseClient) initConn(ctx context.Context, cn *pool.Conn) error {
return err
}

if !c.opt.DisableIndentity {
if !c.opt.DisableIdentity {
libName := ""
libVer := Version()
if c.opt.IdentitySuffix != "" {
Expand Down
8 changes: 4 additions & 4 deletions ring.go
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,8 @@ type RingOptions struct {
TLSConfig *tls.Config
Limiter Limiter

DisableIndentity bool
IdentitySuffix string
DisableIdentity bool
IdentitySuffix string
}

func (opt *RingOptions) init() {
Expand Down Expand Up @@ -166,8 +166,8 @@ func (opt *RingOptions) clientOptions() *Options {
TLSConfig: opt.TLSConfig,
Limiter: opt.Limiter,

DisableIndentity: opt.DisableIndentity,
IdentitySuffix: opt.IdentitySuffix,
DisableIdentity: opt.DisableIdentity,
IdentitySuffix: opt.IdentitySuffix,
}
}

Expand Down
16 changes: 8 additions & 8 deletions sentinel.go
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ type FailoverOptions struct {

TLSConfig *tls.Config

DisableIndentity bool
IdentitySuffix string
DisableIdentity bool
IdentitySuffix string
}

func (opt *FailoverOptions) clientOptions() *Options {
Expand Down Expand Up @@ -117,8 +117,8 @@ func (opt *FailoverOptions) clientOptions() *Options {

TLSConfig: opt.TLSConfig,

DisableIndentity: opt.DisableIndentity,
IdentitySuffix: opt.IdentitySuffix,
DisableIdentity: opt.DisableIdentity,
IdentitySuffix: opt.IdentitySuffix,
}
}

Expand Down Expand Up @@ -154,8 +154,8 @@ func (opt *FailoverOptions) sentinelOptions(addr string) *Options {

TLSConfig: opt.TLSConfig,

DisableIndentity: opt.DisableIndentity,
IdentitySuffix: opt.IdentitySuffix,
DisableIdentity: opt.DisableIdentity,
IdentitySuffix: opt.IdentitySuffix,
}
}

Expand Down Expand Up @@ -194,8 +194,8 @@ func (opt *FailoverOptions) clusterOptions() *ClusterOptions {

TLSConfig: opt.TLSConfig,

DisableIndentity: opt.DisableIndentity,
IdentitySuffix: opt.IdentitySuffix,
DisableIdentity: opt.DisableIdentity,
IdentitySuffix: opt.IdentitySuffix,
}
}

Expand Down
16 changes: 8 additions & 8 deletions universal.go
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ type UniversalOptions struct {

MasterName string

DisableIndentity bool
IdentitySuffix string
DisableIdentity bool
IdentitySuffix string
}

// Cluster returns cluster options created from the universal options.
Expand Down Expand Up @@ -112,8 +112,8 @@ func (o *UniversalOptions) Cluster() *ClusterOptions {

TLSConfig: o.TLSConfig,

DisableIndentity: o.DisableIndentity,
IdentitySuffix: o.IdentitySuffix,
DisableIdentity: o.DisableIdentity,
IdentitySuffix: o.IdentitySuffix,
}
}

Expand Down Expand Up @@ -158,8 +158,8 @@ func (o *UniversalOptions) Failover() *FailoverOptions {

TLSConfig: o.TLSConfig,

DisableIndentity: o.DisableIndentity,
IdentitySuffix: o.IdentitySuffix,
DisableIdentity: o.DisableIdentity,
IdentitySuffix: o.IdentitySuffix,
}
}

Expand Down Expand Up @@ -201,8 +201,8 @@ func (o *UniversalOptions) Simple() *Options {

TLSConfig: o.TLSConfig,

DisableIndentity: o.DisableIndentity,
IdentitySuffix: o.IdentitySuffix,
DisableIdentity: o.DisableIdentity,
IdentitySuffix: o.IdentitySuffix,
}
}

Expand Down
Loading