Skip to content

Commit 50aa1cf

Browse files
committed
fix(azure): correct Manged typo in SQL client factory functions
Four exported functions misspelled "Managed" as "Manged" in modules/azure/client_factory.go: CreateSQLMangedInstanceClient CreateSQLMangedInstanceClientContext CreateSQLMangedDatabasesClient CreateSQLMangedDatabasesClientContext Add the correctly-spelled CreateSQLManaged* functions as the canonical names and convert the typo'd names to // Deprecated: aliases that delegate to them. Update internal call sites in sql_managedinstance.go to use the new spellings. Tagging v1.0 with the typo would lock it into the stable API until a major version bump; the alias approach keeps backwards compatibility while steering new code to the correct names. OSS-3452.
1 parent bc047d0 commit 50aa1cf

2 files changed

Lines changed: 42 additions & 14 deletions

File tree

modules/azure/client_factory.go

Lines changed: 40 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -489,9 +489,9 @@ func CreateSQLServerClient(subscriptionID string) (*armsql.ServersClient, error)
489489
return CreateSQLServerClientContext(context.Background(), subscriptionID)
490490
}
491491

492-
// CreateSQLMangedInstanceClientContext is a helper function that will create and setup a sql managed instance client.
492+
// CreateSQLManagedInstanceClientContext is a helper function that will create and setup a sql managed instance client.
493493
// The ctx parameter supports cancellation and timeouts.
494-
func CreateSQLMangedInstanceClientContext(_ context.Context, subscriptionID string) (*armsql.ManagedInstancesClient, error) {
494+
func CreateSQLManagedInstanceClientContext(_ context.Context, subscriptionID string) (*armsql.ManagedInstancesClient, error) {
495495
clientFactory, err := getArmSQLClientFactory(subscriptionID)
496496
if err != nil {
497497
return nil, err
@@ -500,16 +500,30 @@ func CreateSQLMangedInstanceClientContext(_ context.Context, subscriptionID stri
500500
return clientFactory.NewManagedInstancesClient(), nil
501501
}
502502

503-
// CreateSQLMangedInstanceClient is a helper function that will create and setup a sql managed instance client.
503+
// CreateSQLManagedInstanceClient is a helper function that will create and setup a sql managed instance client.
504504
//
505-
// Deprecated: Use [CreateSQLMangedInstanceClientContext] instead.
506-
func CreateSQLMangedInstanceClient(subscriptionID string) (*armsql.ManagedInstancesClient, error) {
507-
return CreateSQLMangedInstanceClientContext(context.Background(), subscriptionID)
505+
// Deprecated: Use [CreateSQLManagedInstanceClientContext] instead.
506+
func CreateSQLManagedInstanceClient(subscriptionID string) (*armsql.ManagedInstancesClient, error) {
507+
return CreateSQLManagedInstanceClientContext(context.Background(), subscriptionID)
508508
}
509509

510-
// CreateSQLMangedDatabasesClientContext is a helper function that will create and setup a sql managed databases client.
510+
// CreateSQLMangedInstanceClientContext is a backwards-compatible alias for [CreateSQLManagedInstanceClientContext].
511+
//
512+
// Deprecated: Use [CreateSQLManagedInstanceClientContext] instead.
513+
func CreateSQLMangedInstanceClientContext(ctx context.Context, subscriptionID string) (*armsql.ManagedInstancesClient, error) { //nolint:revive,staticcheck // preserving deprecated function name
514+
return CreateSQLManagedInstanceClientContext(ctx, subscriptionID)
515+
}
516+
517+
// CreateSQLMangedInstanceClient is a backwards-compatible alias for [CreateSQLManagedInstanceClient].
518+
//
519+
// Deprecated: Use [CreateSQLManagedInstanceClient] instead.
520+
func CreateSQLMangedInstanceClient(subscriptionID string) (*armsql.ManagedInstancesClient, error) { //nolint:revive,staticcheck // preserving deprecated function name
521+
return CreateSQLManagedInstanceClient(subscriptionID)
522+
}
523+
524+
// CreateSQLManagedDatabasesClientContext is a helper function that will create and setup a sql managed databases client.
511525
// The ctx parameter supports cancellation and timeouts.
512-
func CreateSQLMangedDatabasesClientContext(_ context.Context, subscriptionID string) (*armsql.ManagedDatabasesClient, error) {
526+
func CreateSQLManagedDatabasesClientContext(_ context.Context, subscriptionID string) (*armsql.ManagedDatabasesClient, error) {
513527
clientFactory, err := getArmSQLClientFactory(subscriptionID)
514528
if err != nil {
515529
return nil, err
@@ -518,11 +532,25 @@ func CreateSQLMangedDatabasesClientContext(_ context.Context, subscriptionID str
518532
return clientFactory.NewManagedDatabasesClient(), nil
519533
}
520534

521-
// CreateSQLMangedDatabasesClient is a helper function that will create and setup a sql managed databases client.
535+
// CreateSQLManagedDatabasesClient is a helper function that will create and setup a sql managed databases client.
536+
//
537+
// Deprecated: Use [CreateSQLManagedDatabasesClientContext] instead.
538+
func CreateSQLManagedDatabasesClient(subscriptionID string) (*armsql.ManagedDatabasesClient, error) {
539+
return CreateSQLManagedDatabasesClientContext(context.Background(), subscriptionID)
540+
}
541+
542+
// CreateSQLMangedDatabasesClientContext is a backwards-compatible alias for [CreateSQLManagedDatabasesClientContext].
543+
//
544+
// Deprecated: Use [CreateSQLManagedDatabasesClientContext] instead.
545+
func CreateSQLMangedDatabasesClientContext(ctx context.Context, subscriptionID string) (*armsql.ManagedDatabasesClient, error) { //nolint:revive,staticcheck // preserving deprecated function name
546+
return CreateSQLManagedDatabasesClientContext(ctx, subscriptionID)
547+
}
548+
549+
// CreateSQLMangedDatabasesClient is a backwards-compatible alias for [CreateSQLManagedDatabasesClient].
522550
//
523-
// Deprecated: Use [CreateSQLMangedDatabasesClientContext] instead.
524-
func CreateSQLMangedDatabasesClient(subscriptionID string) (*armsql.ManagedDatabasesClient, error) {
525-
return CreateSQLMangedDatabasesClientContext(context.Background(), subscriptionID)
551+
// Deprecated: Use [CreateSQLManagedDatabasesClient] instead.
552+
func CreateSQLMangedDatabasesClient(subscriptionID string) (*armsql.ManagedDatabasesClient, error) { //nolint:revive,staticcheck // preserving deprecated function name
553+
return CreateSQLManagedDatabasesClient(subscriptionID)
526554
}
527555

528556
// getArmSQLClientFactory gets an arm sql client factory

modules/azure/sql_managedinstance.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ func GetManagedInstanceContext(t testing.TestingT, ctx context.Context, resGroup
6767
// GetManagedInstanceContextE retrieves the SQL managed instance object for the given subscription.
6868
// The ctx parameter supports cancellation and timeouts.
6969
func GetManagedInstanceContextE(ctx context.Context, subscriptionID string, resGroupName string, managedInstanceName string) (*armsql.ManagedInstance, error) {
70-
sqlmiClient, err := CreateSQLMangedInstanceClientContext(ctx, subscriptionID)
70+
sqlmiClient, err := CreateSQLManagedInstanceClientContext(ctx, subscriptionID)
7171
if err != nil {
7272
return nil, err
7373
}
@@ -117,7 +117,7 @@ func GetManagedInstanceDatabaseContext(t testing.TestingT, ctx context.Context,
117117
// GetManagedInstanceDatabaseContextE retrieves the SQL managed database object for the given subscription.
118118
// The ctx parameter supports cancellation and timeouts.
119119
func GetManagedInstanceDatabaseContextE(ctx context.Context, subscriptionID string, resGroupName string, managedInstanceName string, databaseName string) (*armsql.ManagedDatabase, error) {
120-
sqlmiDBClient, err := CreateSQLMangedDatabasesClientContext(ctx, subscriptionID)
120+
sqlmiDBClient, err := CreateSQLManagedDatabasesClientContext(ctx, subscriptionID)
121121
if err != nil {
122122
return nil, err
123123
}

0 commit comments

Comments
 (0)