Class ScopeSearchIndexManager

couchbase/management/search.py:413–793

Allows to manage scope-level search indexes in a Couchbase cluster.

class ScopeSearchIndexManager:
    """
    Allows to manage scope-level search indexes in a Couchbase cluster.
    """

    def __init__(self, client_adapter: ClientAdapter, bucket_name: str, scope_name: str, observability_instruments: ObservabilityInstruments) -> None:  # noqa: E501
        self._impl = SearchIndexMgmtImpl(client_adapter, observability_instruments)
        self._scope_context = bucket_name, scope_name

    def upsert_index(self,
                     index,     # type: SearchIndex
                     *options,  # type: UpsertSearchIndexOptions
                     **kwargs   # type: Any
                     ) -> None:
        """Creates or updates an index.

        Args:
            index (:class:`.SearchIndex`): The index definition.
            options (:class:`~couchbase.management.options.UpsertSearchIndexOptions`): 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.InvalidArgumentException`: If the index definition is invalid.
        """
        op_type = SearchIndexMgmtOperationType.SearchIndexUpsert
        with ObservableRequestHandler(op_type, self._impl.observability_instruments) as obs_handler:
            req = self._impl.request_builder.build_upsert_index_request(index,
                                                                        self._scope_context,
                                                                        obs_handler,
                                                                        *options,
                                                                        **kwargs)
            self._impl.upsert_index(req, obs_handler)

    def drop_index(self,
                   index_name,  # type: str
                   *options,   # type: DropSearchIndexOptions
                   **kwargs    # type: Any
                   ) -> None:
        """Drops an index.

        Args:
            index_name (str): The name of the index.
            options (:class:`~couchbase.management.options.DropSearchIndexOptions`): 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.SearchIndexNotFoundException`: If the index does not exist.
        """
        op_type = SearchIndexMgmtOperationType.SearchIndexDrop
        with ObservableRequestHandler(op_type, self._impl.observability_instruments) as obs_handler:
            req = self._impl.request_builder.build_drop_index_request(index_name,
                                                                      self._scope_context,
                                                                      obs_handler,
                                                                      *options,
                                                                      **kwargs)
            self._impl.drop_index(req, obs_handler)