Class CreateQueryIndexOptions

couchbase/management/options.py:570–609

Available options to for a :class:`~couchbase.management.queries.QueryIndexManager`'s create index operation. .. note:: All management options should be imported from `couchbase.management.options`. Args: collection_name (str, optional): **DEPRECATED** - use :class:`~c

class CreateQueryIndexOptions(dict):
    """Available options to for a :class:`~couchbase.management.queries.QueryIndexManager`'s create
    index operation.

    .. note::
        All management options should be imported from `couchbase.management.options`.

    Args:
        collection_name (str, optional):  **DEPRECATED** - use :class:`~couchbase.management.queries.CollectionQueryIndexManager`.
            Specifies the collection of the index.
        condition (str, optional): Specifies the 'where' condition for partial index creation.
        deferred (bool, optional): Specifies whether this index creation should be deferred until
            a later point in time when they can be explicitly built together.
        ignore_if_exists (bool, optional): Whether or not the call should ignore the
            index already existing when determining whether the call was successful.
        num_replicas (int, optional): The number of replicas of this index that should be created.
        scope_name (str, optional):  **DEPRECATED** - use :class:`~couchbase.management.queries.CollectionQueryIndexManager`.
            Specifies the scope of the index.
        timeout (timedelta, optional): The timeout for this operation. Defaults to global
            management operation timeout.
        parent_span (:class:`~couchbase.observability.tracing.RequestTracer`, optional): The parent span for this operation.
    """  # noqa: E501
    @overload
    def __init__(self,
                 timeout: Optional[timedelta] = None,
                 ignore_if_exists: Optional[bool] = None,
                 num_replicas: Optional[int] = None,
                 deferred: Optional[bool] = None,
                 condition: Optional[str] = None,
                 scope_name: Optional[str] = None,
                 collection_name: Optional[str] = None,
                 parent_span: Optional[RequestSpan] = None
                 ) -> None:
        ...

    def __init__(self, **kwargs: Any) -> None:
        if 'ignore_if_exists' not in kwargs:
            kwargs['ignore_if_exists'] = False
        kwargs = {k: v for k, v in kwargs.items() if v is not None}
        super().__init__(**kwargs)


class CreatePrimaryQueryIndexOptions(dict):