Class CollectionManager

couchbase/management/collections.py:51–245

class CollectionManager:

    def __init__(self,
                 client_adapter: ClientAdapter,
                 bucket_name: str,
                 observability_instruments: ObservabilityInstruments) -> None:
        self._bucket_name = bucket_name
        self._impl = CollectionMgmtImpl(client_adapter, observability_instruments)

    def create_scope(self,
                     scope_name: str,
                     *options: CreateScopeOptions,
                     **kwargs: Any
                     ) -> None:
        """Creates a new scope.

        Args:
            scope_name (str): The name of the scope.
            options (:class:`~couchbase.management.options.CreateScopeOptions`): Optional parameters for this operation.
            **kwargs (Dict[str, Any]): keyword arguments that can be used as optional parameters for this operation.

        Raises:
            :class:`~couchbase.exceptions.ScopeAlreadyExistsException`: If the scope already exists.
        """  # noqa: E501
        op_type = CollectionMgmtOperationType.ScopeCreate
        with ObservableRequestHandler(op_type, self._impl.observability_instruments) as obs_handler:
            req = self._impl.request_builder.build_create_scope_request(self._bucket_name,
                                                                        scope_name,
                                                                        obs_handler,
                                                                        *options,
                                                                        **kwargs)
            self._impl.create_scope(req, obs_handler)

    def drop_scope(self,
                   scope_name: str,
                   *options: DropScopeOptions,
                   **kwargs: Any
                   ) -> None:
        """Drops an existing scope.

        Args:
            scope_name (str): The name of the scope.
            options (:class:`~couchbase.management.options.DropScopeOptions`): Optional parameters for this operation.
            **kwargs (Dict[str, Any]): keyword arguments that can be used as optional parameters for this operation.

        Raises:
            :class:`~couchbase.exceptions.ScopeNotFoundException`: If the scope does not exist.
        """  # noqa: E501
        op_type = CollectionMgmtOperationType.ScopeDrop
        with ObservableRequestHandler(op_type, self._impl.observability_instruments) as obs_handler:
            req = self._impl.request_builder.build_drop_scope_request(self._bucket_name,
                                                                      scope_name,
                                                                      obs_handler,
                                                                      *options,
                                                                      **kwargs)
            self._impl.drop_scope(req, obs_handler)

    def get_all_scopes(self,