From 8126d7b7f081e1160e511fbb6e16788bf7c27a18 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Wed, 20 Mar 2024 14:09:06 -0700 Subject: [PATCH] Rename CreateClient, fix doc --- go/api/cluster_client.go | 4 ++-- go/api/config.go | 3 +-- go/api/standalone_client.go | 4 ++-- go/examples/main.go | 24 ++++++++++++------------ go/integTest/connection_test.go | 8 ++++---- 5 files changed, 21 insertions(+), 22 deletions(-) diff --git a/go/api/cluster_client.go b/go/api/cluster_client.go index 5cd6abad97..44510b1be6 100644 --- a/go/api/cluster_client.go +++ b/go/api/cluster_client.go @@ -7,8 +7,8 @@ type RedisClusterClient struct { *baseClient } -// CreateClusterClient creates a Redis client in cluster mode using the given [RedisClusterClientConfiguration]. -func CreateClusterClient(config *RedisClusterClientConfiguration) (*RedisClusterClient, error) { +// NewRedisClusterClient creates a Redis client in cluster mode using the given [RedisClusterClientConfiguration]. +func NewRedisClusterClient(config *RedisClusterClientConfiguration) (*RedisClusterClient, error) { client, err := createClient(config) if err != nil { return nil, err diff --git a/go/api/config.go b/go/api/config.go index 9d2417b429..66f3533ca3 100644 --- a/go/api/config.go +++ b/go/api/config.go @@ -140,8 +140,7 @@ func (strategy *BackoffStrategy) toProtobuf() *protobuf.ConnectionRetryStrategy } } -// RedisClientConfiguration represents the configuration settings for a Standalone Redis client. baseClientConfiguration is an -// embedded struct that contains shared settings for standalone and cluster clients. +// RedisClientConfiguration represents the configuration settings for a Standalone Redis client. type RedisClientConfiguration struct { baseClientConfiguration reconnectStrategy *BackoffStrategy diff --git a/go/api/standalone_client.go b/go/api/standalone_client.go index 23d6afccb1..8ee4dde336 100644 --- a/go/api/standalone_client.go +++ b/go/api/standalone_client.go @@ -11,8 +11,8 @@ type RedisClient struct { *baseClient } -// CreateClient creates a Redis client in standalone mode using the given [RedisClientConfiguration]. -func CreateClient(config *RedisClientConfiguration) (*RedisClient, error) { +// NewRedisClient creates a Redis client in standalone mode using the given [RedisClientConfiguration]. +func NewRedisClient(config *RedisClientConfiguration) (*RedisClient, error) { client, err := createClient(config) if err != nil { return nil, err diff --git a/go/examples/main.go b/go/examples/main.go index c8cd16435c..3b5c25dd83 100644 --- a/go/examples/main.go +++ b/go/examples/main.go @@ -3,24 +3,24 @@ package main import ( - "log" + "log" - "github.com/aws/glide-for-redis/go/glide/api" + "github.com/aws/glide-for-redis/go/glide/api" ) func main() { - host := "localhost" - port := 6379 + host := "localhost" + port := 6379 - config := api.NewRedisClientConfiguration(). - WithAddress(&api.NodeAddress{Host: host, Port: port}) + config := api.NewRedisClientConfiguration(). + WithAddress(&api.NodeAddress{Host: host, Port: port}) - client, err := api.CreateClient(config) - if err != nil { - log.Fatal("error connecting to database: ", err) - } + client, err := api.NewRedisClient(config) + if err != nil { + log.Fatal("error connecting to database: ", err) + } - // TODO: Add example commands as they are implemented + // TODO: Add example commands as they are implemented - client.Close() + client.Close() } diff --git a/go/integTest/connection_test.go b/go/integTest/connection_test.go index 2d718085ec..d3612de784 100644 --- a/go/integTest/connection_test.go +++ b/go/integTest/connection_test.go @@ -10,7 +10,7 @@ import ( func (suite *GlideTestSuite) TestStandaloneConnect() { config := api.NewRedisClientConfiguration(). WithAddress(&api.NodeAddress{Port: suite.standalonePorts[0]}) - client, err := api.CreateClient(config) + client, err := api.NewRedisClient(config) assert.Nil(suite.T(), err) assert.NotNil(suite.T(), client) @@ -24,7 +24,7 @@ func (suite *GlideTestSuite) TestClusterConnect() { config.WithAddress(&api.NodeAddress{Port: port}) } - client, err := api.CreateClusterClient(config) + client, err := api.NewRedisClusterClient(config) assert.Nil(suite.T(), err) assert.NotNil(suite.T(), client) @@ -36,7 +36,7 @@ func (suite *GlideTestSuite) TestClusterConnect_singlePort() { config := api.NewRedisClusterClientConfiguration(). WithAddress(&api.NodeAddress{Port: suite.clusterPorts[0]}) - client, err := api.CreateClusterClient(config) + client, err := api.NewRedisClusterClient(config) assert.Nil(suite.T(), err) assert.NotNil(suite.T(), client) @@ -47,7 +47,7 @@ func (suite *GlideTestSuite) TestClusterConnect_singlePort() { func (suite *GlideTestSuite) TestConnectWithInvalidAddress() { config := api.NewRedisClientConfiguration(). WithAddress(&api.NodeAddress{Host: "invalid-host"}) - client, err := api.CreateClient(config) + client, err := api.NewRedisClient(config) assert.Nil(suite.T(), client) assert.NotNil(suite.T(), err)