bucket_collectionsmgrv2.go

package gocb

import "time"

// CollectionManagerV2 provides methods for performing collections management.
type CollectionManagerV2 struct {
	controller *providerController[collectionsManagementProvider]
}

// GetAllScopes gets all scopes from the bucket.
func (cm *CollectionManagerV2) GetAllScopes(opts *GetAllScopesOptions) ([]ScopeSpec, error) {
	return autoOpControl(cm.controller, "manager_collections_get_all_scopes", func(provider collectionsManagementProvider) ([]ScopeSpec, error) {
		if opts == nil {
			opts = &GetAllScopesOptions{}
		}

		return provider.GetAllScopes(opts)
	})
}

// CreateCollectionSettings specifies settings for a collection to be created
type CreateCollectionSettings struct {
	// MaxExpiry is the maximum expiry all documents in the collection can have.
	// Defaults to the bucket-level setting.
	// Value of -1 seconds (time.Duration(-1) * time.Second)  denotes 'no expiry'.
	MaxExpiry time.Duration
	History   *CollectionHistorySettings
}

// CreateCollection creates a new collection on the bucket.
func (cm *CollectionManagerV2) CreateCollection(scopeName string, collectionName string, settings *CreateCollectionSettings, opts *CreateCollectionOptions) error {
	return autoOpControlErrorOnly(cm.controller, "manager_collections_create_collection", func(provider collectionsManagementProvider) error {
		if scopeName == "" {
			return makeInvalidArgumentsError("collection name cannot be empty")
		}

		if collectionName == "" {
			return makeInvalidArgumentsError("scope name cannot be empty")
		}

		if settings == nil {
			settings = &CreateCollectionSettings{}
		}

		if opts == nil {
			opts = &CreateCollectionOptions{}
		}

		return provider.CreateCollection(scopeName, collectionName, settings, opts)
	})
}

// UpdateCollectionSettings specifies the settings for a collection that should be updated.
type UpdateCollectionSettings struct {
	// MaxExpiry is the maximum expiry all documents in the collection can have.
	// Defaults to the bucket-level setting.
	// Value of -1 seconds (time.Duration(-1) * time.Second)  denotes 'no expiry'.
	MaxExpiry time.Duration
	History   *CollectionHistorySettings
}

// UpdateCollection updates the settings of an existing collection.
func (cm *CollectionManagerV2) UpdateCollection(scopeName string, collectionName string, settings UpdateCollectionSettings, opts *UpdateCollectionOptions) error {
	return autoOpControlErrorOnly(cm.controller, "manager_collections_update_collection", func(provider collectionsManagementProvider) error {
		if scopeName == "" {
			return makeInvalidArgumentsError("collection name cannot be empty")
		}

		if collectionName == "" {
			return makeInvalidArgumentsError("scope name cannot be empty")
		}

		if opts == nil {
			opts = &UpdateCollectionOptions{}
		}

		return provider.UpdateCollection(scopeName, collectionName, settings, opts)
	})
}

// DropCollection removes a collection.
func (cm *CollectionManagerV2) DropCollection(scopeName string, collectionName string, opts *DropCollectionOptions) error {
	return autoOpControlErrorOnly(cm.controller, "manager_collections_drop_collection", func(provider collectionsManagementProvider) error {
		if scopeName == "" {
			return makeInvalidArgumentsError("collection name cannot be empty")
		}

		if collectionName == "" {
			return makeInvalidArgumentsError("scope name cannot be empty")
		}

		if opts == nil {
			opts = &DropCollectionOptions{}
		}

		return provider.DropCollection(scopeName, collectionName, opts)
	})
}

// CreateScope creates a new scope on the bucket.
func (cm *CollectionManagerV2) CreateScope(scopeName string, opts *CreateScopeOptions) error {
	return autoOpControlErrorOnly(cm.controller, "manager_collections_create_scope", func(provider collectionsManagementProvider) error {
		if scopeName == "" {
			return makeInvalidArgumentsError("scope name cannot be empty")
		}

		if opts == nil {
			opts = &CreateScopeOptions{}
		}

		return provider.CreateScope(scopeName, opts)
	})
}

// DropScope removes a scope.
func (cm *CollectionManagerV2) DropScope(scopeName string, opts *DropScopeOptions) error {
	return autoOpControlErrorOnly(cm.controller, "manager_collections_drop_scope", func(provider collectionsManagementProvider) error {
		if scopeName == "" {
			return makeInvalidArgumentsError("scope name cannot be empty")
		}

		if opts == nil {
			opts = &DropScopeOptions{}
		}

		return provider.DropScope(scopeName, opts)
	})
}