diff --git a/rueidis/README.md b/rueidis/README.md index 8859874a..d0d68ebc 100644 --- a/rueidis/README.md +++ b/rueidis/README.md @@ -98,8 +98,8 @@ store = rueidis.New(rueidis.Config{ ### Config ```go type Config struct { - // Server username - // + // Server username + // // Optional. Default is "" Username string @@ -167,22 +167,22 @@ type Config struct { // DisableRetry disables retrying read-only commands under network errors // // Optional. The default is False - DisableRetry bool + DisableRetry bool - // DisableCache falls back Client.DoCache/Client.DoMultiCache to Client.Do/Client.DoMulti - // - // Optional. The default is false - DisableCache bool + // DisableCache falls back Client.DoCache/Client.DoMultiCache to Client.Do/Client.DoMulti + // + // Optional. The default is false + DisableCache bool - // AlwaysPipelining makes rueidis.Client always pipeline redis commands even if they are not issued concurrently. - // - // Optional. The default is true - AlwaysPipelining bool + // AlwaysPipelining makes rueidis.Client always pipeline redis commands even if they are not issued concurrently. + // + // Optional. The default is true + AlwaysPipelining bool - // Reset clears any existing keys in existing Collection - // + // Reset clears any existing keys in existing Collection + // // Optional. Default is false - Reset bool + Reset bool // DisableStartupCheck skips the initial connection validation during New. // When true and client creation fails, New returns a Storage whose @@ -191,33 +191,33 @@ type Config struct { // Optional. Default is false DisableStartupCheck bool - // CacheTTL TTL - // - // Optional. Default is time.Minute - CacheTTL time.Duration + // CacheTTL TTL + // + // Optional. Default is time.Minute + CacheTTL time.Duration } ``` ### Default Config ```go var ConfigDefault = Config{ - Username: "", - Password: "", - ClientName: "", - SelectDB: 0, - InitAddress: []string{"127.0.0.1:6379"}, - TLSConfig: nil, - CacheSizeEachConn: rueidis.DefaultCacheBytes, - RingScaleEachConn: rueidis.DefaultRingScale, - ReadBufferEachConn: rueidis.DefaultReadBuffer, - WriteBufferEachConn: rueidis.DefaultWriteBuffer, - BlockingPoolSize: rueidis.DefaultPoolSize, - PipelineMultiplex: 2, - DisableRetry: false, - DisableCache: false, - AlwaysPipelining: true, - Reset: false, + Username: "", + Password: "", + ClientName: "", + SelectDB: 0, + InitAddress: []string{"127.0.0.1:6379"}, + TLSConfig: nil, + CacheSizeEachConn: rueidis.DefaultCacheBytes, + RingScaleEachConn: rueidis.DefaultRingScale, + ReadBufferEachConn: rueidis.DefaultReadBuffer, + WriteBufferEachConn: rueidis.DefaultWriteBuffer, + BlockingPoolSize: rueidis.DefaultPoolSize, + PipelineMultiplex: 2, + DisableRetry: false, + DisableCache: false, + AlwaysPipelining: true, + Reset: false, DisableStartupCheck: false, - CacheTTL: time.Minute, + CacheTTL: time.Minute, } ```