diff --git a/docs/storage/rueidis/README.md b/docs/storage/rueidis/README.md index 1134c12d15a..06fb4a43d9b 100644 --- a/docs/storage/rueidis/README.md +++ b/docs/storage/rueidis/README.md @@ -61,6 +61,11 @@ store := rueidis.New(rueidis.Config{ TLSConfig: nil, }) +// Initialize using Rueidis URL +store := rueidis.New(rueidis.Config{ + URL: "redis://localhost:6379", +}) + // Initialize Rueidis Cluster Client store := rueidis.New(rueidis.Config{ InitAddress: []string{":6379", ":6380"}, @@ -105,6 +110,12 @@ type Config struct { // Optional. Default is "" ClientName string + // URL standard format Redis URL. If this is set all other config options, InitAddress, Username, Password, ClientName, and SelectDB have no effect. + // + // Example: redis://:@localhost:6379/ + // Optional. Default is "" + URL string + // SelectDB to be selected after connecting to the server. // // Optional. Default is 0