Rename CreateClient, fix doc

Bit-Quill · Mar 21, 2024 · 8126d7b · 8126d7b
1 parent 7aad421
commit 8126d7b
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 22 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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)