Class QueryIndexManager

couchbase/management/queries.py:41–256

Performs management operations on query indexes. For managing query indexes at the collection level, :class:`.CollectionQueryIndexManager` should be used.

class QueryIndexManager:
    """
    Performs management operations on query indexes.

    For managing query indexes at the collection level, :class:`.CollectionQueryIndexManager` should be used.
    """

    def __init__(self, client_adapter: ClientAdapter, observability_instruments: ObservabilityInstruments) -> None:
        self._impl = QueryIndexMgmtImpl(client_adapter, observability_instruments)
        self._collection_ctx = None

    def create_index(self,
                     bucket_name,   # type: str
                     index_name,    # type: str
                     keys,          # type: Iterable[str]
                     *options,      # type: CreateQueryIndexOptions
                     **kwargs       # type: Dict[str, Any]
                     ) -> None:
        """Creates a new query index.

        Args:
            bucket_name (str): The name of the bucket this index is for.
            index_name (str): The name of the index.
            keys (Iterable[str]): The keys which this index should cover.
            options (:class:`~couchbase.management.options.CreateQueryIndexOptions`): 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 bucket_name, index_name or keys
                are invalid types.
            :class:`~couchbase.exceptions.QueryIndexAlreadyExistsException`: If the index already exists.
        """
        op_type = QueryIndexMgmtOperationType.QueryIndexCreate
        with ObservableRequestHandler(op_type, self._impl.observability_instruments) as obs_handler:
            req = self._impl.request_builder.build_create_index_request(bucket_name,
                                                                        index_name,
                                                                        keys,
                                                                        obs_handler,
                                                                        self._collection_ctx,
                                                                        *options,
                                                                        **kwargs)
            self._impl.create_index(req, obs_handler)

    def create_primary_index(self,
                             bucket_name,   # type: str
                             *options,      # type: CreatePrimaryQueryIndexOptions
                             **kwargs       # type: Dict[str, Any]
                             ) -> None:
        """Creates a new primary query index.

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