Skip to content

Commit

Permalink
database: Rename CosmosDBClient to cosmosDBClient
Browse files Browse the repository at this point in the history 
This type should not be accessible outside the database package.
  • Loading branch information
Matthew Barnes committed Feb 3, 2025
1 parent 8ef1220 commit 267fb2c
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions internal/database/database.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,10 +89,10 @@ type DBClient interface {
ListAllSubscriptionDocs() DBClientIterator[SubscriptionDocument]
}

var _ DBClient = &CosmosDBClient{}
var _ DBClient = &cosmosDBClient{}

// CosmosDBClient defines the needed values to perform CRUD operations against the async DB
type CosmosDBClient struct {
// cosmosDBClient defines the needed values to perform CRUD operations against the async DB
type cosmosDBClient struct {
database *azcosmos.DatabaseClient
resources *azcosmos.ContainerClient
operations *azcosmos.ContainerClient
Expand All @@ -117,7 +117,7 @@ func NewDBClient(ctx context.Context, database *azcosmos.DatabaseClient) (DBClie
return nil, err
}

return &CosmosDBClient{
return &cosmosDBClient{
database: database,
resources: resources,
operations: operations,
Expand All @@ -128,20 +128,20 @@ func NewDBClient(ctx context.Context, database *azcosmos.DatabaseClient) (DBClie
}

// DBConnectionTest checks the async database is accessible on startup
func (d *CosmosDBClient) DBConnectionTest(ctx context.Context) error {
func (d *cosmosDBClient) DBConnectionTest(ctx context.Context) error {
if _, err := d.database.Read(ctx, nil); err != nil {
return fmt.Errorf("failed to read Cosmos database information during healthcheck: %v", err)
}

return nil
}

func (d *CosmosDBClient) GetLockClient() *LockClient {
func (d *cosmosDBClient) GetLockClient() *LockClient {
return d.lockClient
}

// GetResourceDoc retrieves a resource document from the "resources" DB using resource ID
func (d *CosmosDBClient) GetResourceDoc(ctx context.Context, resourceID *azcorearm.ResourceID) (*ResourceDocument, error) {
func (d *cosmosDBClient) GetResourceDoc(ctx context.Context, resourceID *azcorearm.ResourceID) (*ResourceDocument, error) {
// Make sure partition key is lowercase.
pk := azcosmos.NewPartitionKeyString(strings.ToLower(resourceID.SubscriptionID))

Expand Down Expand Up @@ -189,7 +189,7 @@ func (d *CosmosDBClient) GetResourceDoc(ctx context.Context, resourceID *azcorea
}

// CreateResourceDoc creates a resource document in the "resources" DB during resource creation
func (d *CosmosDBClient) CreateResourceDoc(ctx context.Context, doc *ResourceDocument) error {
func (d *cosmosDBClient) CreateResourceDoc(ctx context.Context, doc *ResourceDocument) error {
// Make sure partition key is lowercase.
doc.PartitionKey = strings.ToLower(doc.PartitionKey)

Expand All @@ -214,7 +214,7 @@ func (d *CosmosDBClient) CreateResourceDoc(ctx context.Context, doc *ResourceDoc
// The callback function should return true if modifications were applied, signaling to proceed
// with the document replacement. The boolean return value reflects this: returning true if the
// document was sucessfully replaced, or false with or without an error to indicate no change.
func (d *CosmosDBClient) UpdateResourceDoc(ctx context.Context, resourceID *azcorearm.ResourceID, callback func(*ResourceDocument) bool) (bool, error) {
func (d *cosmosDBClient) UpdateResourceDoc(ctx context.Context, resourceID *azcorearm.ResourceID, callback func(*ResourceDocument) bool) (bool, error) {
var err error

// Make sure partition key is lowercase.
Expand Down Expand Up @@ -257,7 +257,7 @@ func (d *CosmosDBClient) UpdateResourceDoc(ctx context.Context, resourceID *azco
}

// DeleteResourceDoc removes a resource document from the "resources" DB using resource ID
func (d *CosmosDBClient) DeleteResourceDoc(ctx context.Context, resourceID *azcorearm.ResourceID) error {
func (d *cosmosDBClient) DeleteResourceDoc(ctx context.Context, resourceID *azcorearm.ResourceID) error {
// Make sure partition key is lowercase.
pk := azcosmos.NewPartitionKeyString(strings.ToLower(resourceID.SubscriptionID))

Expand All @@ -280,7 +280,7 @@ func (d *CosmosDBClient) DeleteResourceDoc(ctx context.Context, resourceID *azco
// maxItems can limit the number of items returned at once. A negative value will cause the
// returned iterator to yield all matching items. A positive value will cause the returned
// iterator to include a continuation token if additional items are available.
func (d *CosmosDBClient) ListResourceDocs(prefix *azcorearm.ResourceID, maxItems int32, continuationToken *string) DBClientIterator[ResourceDocument] {
func (d *cosmosDBClient) ListResourceDocs(prefix *azcorearm.ResourceID, maxItems int32, continuationToken *string) DBClientIterator[ResourceDocument] {
// Make sure partition key is lowercase.
pk := azcosmos.NewPartitionKeyString(strings.ToLower(prefix.SubscriptionID))

Expand Down Expand Up @@ -313,7 +313,7 @@ func (d *CosmosDBClient) ListResourceDocs(prefix *azcorearm.ResourceID, maxItems

// GetOperationDoc retrieves the asynchronous operation document for the given
// operation ID from the "operations" container
func (d *CosmosDBClient) GetOperationDoc(ctx context.Context, operationID string) (*OperationDocument, error) {
func (d *cosmosDBClient) GetOperationDoc(ctx context.Context, operationID string) (*OperationDocument, error) {
// Make sure lookup keys are lowercase.
operationID = strings.ToLower(operationID)

Expand All @@ -338,7 +338,7 @@ func (d *CosmosDBClient) GetOperationDoc(ctx context.Context, operationID string

// CreateOperationDoc writes an asynchronous operation document to the "operations"
// container
func (d *CosmosDBClient) CreateOperationDoc(ctx context.Context, doc *OperationDocument) (string, error) {
func (d *cosmosDBClient) CreateOperationDoc(ctx context.Context, doc *OperationDocument) (string, error) {
pk := azcosmos.NewPartitionKeyString(operationsPartitionKey)

data, err := json.Marshal(doc)
Expand All @@ -362,7 +362,7 @@ func (d *CosmosDBClient) CreateOperationDoc(ctx context.Context, doc *OperationD
// The callback function should return true if modifications were applied, signaling to proceed
// with the document replacement. The boolean return value reflects this: returning true if the
// document was successfully replaced, or false with or without an error to indicate no change.
func (d *CosmosDBClient) UpdateOperationDoc(ctx context.Context, operationID string, callback func(*OperationDocument) bool) (bool, error) {
func (d *cosmosDBClient) UpdateOperationDoc(ctx context.Context, operationID string, callback func(*OperationDocument) bool) (bool, error) {
var err error

pk := azcosmos.NewPartitionKeyString(operationsPartitionKey)
Expand Down Expand Up @@ -403,7 +403,7 @@ func (d *CosmosDBClient) UpdateOperationDoc(ctx context.Context, operationID str
return false, err
}

func (d *CosmosDBClient) ListOperationDocs(subscriptionID string) DBClientIterator[OperationDocument] {
func (d *cosmosDBClient) ListOperationDocs(subscriptionID string) DBClientIterator[OperationDocument] {
pk := azcosmos.NewPartitionKeyString(operationsPartitionKey)

query := "SELECT * FROM c WHERE STARTSWITH(c.externalId, @prefix, true)"
Expand All @@ -422,7 +422,7 @@ func (d *CosmosDBClient) ListOperationDocs(subscriptionID string) DBClientIterat
}

// GetSubscriptionDoc retreives a subscription document from async DB using the subscription ID
func (d *CosmosDBClient) GetSubscriptionDoc(ctx context.Context, subscriptionID string) (*SubscriptionDocument, error) {
func (d *cosmosDBClient) GetSubscriptionDoc(ctx context.Context, subscriptionID string) (*SubscriptionDocument, error) {
// Make sure lookup keys are lowercase.
subscriptionID = strings.ToLower(subscriptionID)

Expand All @@ -446,7 +446,7 @@ func (d *CosmosDBClient) GetSubscriptionDoc(ctx context.Context, subscriptionID
}

// CreateSubscriptionDoc creates/updates a subscription document in the async DB during cluster creation/patching
func (d *CosmosDBClient) CreateSubscriptionDoc(ctx context.Context, subscriptionID string, doc *SubscriptionDocument) error {
func (d *cosmosDBClient) CreateSubscriptionDoc(ctx context.Context, subscriptionID string, doc *SubscriptionDocument) error {
// Make sure lookup keys are lowercase.
doc.ID = strings.ToLower(subscriptionID)

Expand Down Expand Up @@ -480,7 +480,7 @@ func (d *CosmosDBClient) CreateSubscriptionDoc(ctx context.Context, subscription
// The callback function should return true if modifications were applied, signaling to proceed
// with the document replacement. The boolean return value reflects this: returning true if the
// document was successfully replaced, or false with or without an error to indicate no change.
func (d *CosmosDBClient) UpdateSubscriptionDoc(ctx context.Context, subscriptionID string, callback func(*SubscriptionDocument) bool) (bool, error) {
func (d *cosmosDBClient) UpdateSubscriptionDoc(ctx context.Context, subscriptionID string, callback func(*SubscriptionDocument) bool) (bool, error) {
var err error

// Make sure partition key is lowercase.
Expand Down Expand Up @@ -522,7 +522,7 @@ func (d *CosmosDBClient) UpdateSubscriptionDoc(ctx context.Context, subscription
return false, err
}

func (d *CosmosDBClient) ListAllSubscriptionDocs() DBClientIterator[SubscriptionDocument] {
func (d *cosmosDBClient) ListAllSubscriptionDocs() DBClientIterator[SubscriptionDocument] {
return listPartitionKeys(d.partitionKeys, d)
}

Expand Down

0 comments on commit 267fb2c

Please sign in to comment.