kurrentdbclient 1.1.2__tar.gz → 1.2__tar.gz

kurrentdbclient-1.1.2/README.md → kurrentdbclient-1.2/PKG-INFO

@@ -1,3 +1,33 @@
+Metadata-Version: 2.4
+Name: kurrentdbclient
+Version: 1.2
+Summary: Python gRPC Client for KurrentDB
+License: BSD-3-Clause
+License-File: LICENSE
+Author: John Bywater
+Author-email: john.bywater@appropriatesoftware.net
+Requires-Python: >=3.10
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python
+Provides-Extra: opentelemetry
+Requires-Dist: googleapis-common-protos
+Requires-Dist: grpcio-status
+Requires-Dist: grpcio[protobuf] (>=1.75.1,<2.0)
+Requires-Dist: opentelemetry-api (>=1.28.0,<2.0) ; extra == "opentelemetry"
+Requires-Dist: opentelemetry-instrumentation (>=0.49b0) ; extra == "opentelemetry"
+Requires-Dist: opentelemetry-semantic-conventions (>=0.49b0) ; extra == "opentelemetry"
+Requires-Dist: typing_extensions
+Project-URL: Homepage, https://github.com/pyeventsourcing/kurrentdbclient
+Project-URL: Repository, https://github.com/pyeventsourcing/kurrentdbclient
+Description-Content-Type: text/markdown
+
 <a href="https://kurrent.io">
   <picture>
     <source media="(prefers-color-scheme: dark)" srcset="https://github.com/pyeventsourcing/kurrentdbclient/raw/1.0/KurrentLogo-White.png.png">
@@ -24,7 +54,7 @@ features are presented in an easy-to-use interface.
 
 These clients have been tested to work with KurrentDB version 25.1 and 25.0, EventStoreDB
 versions 24.10 and EventStoreDB 23.10, both with and without SSL/TLS, in both single-server and
-cluster modes, across Python versions 3.9, 3.10, 3.11, 3.12, 3.13, and 3.14.
+cluster modes, across Python versions 3.10, 3.11, 3.12, 3.13, and 3.14.
 
 The test suite has 100% line and branch coverage. The code has typing annotations
 checked strictly with mypy. The code is formatted with black and isort, and checked
@@ -67,9 +97,11 @@ https://github.com/pyeventsourcing/eventsourcing-kurrentdb) package.
   * [Set stream metadata](#set-stream-metadata)
   * [Delete stream](#delete-stream)
   * [Tombstone stream](#tombstone-stream)
+  * [Read using secondary index](#read-index)
 * [Catch-up subscriptions](#catch-up-subscriptions)
   * [Subscribe to all events](#subscribe-to-all-events)
   * [Subscribe to stream events](#subscribe-to-stream-events)
+  * [Subscribe using secondary index](#subscribe-to-index)
   * [How to implement exactly-once event processing](#how-to-implement-exactly-once-event-processing)
 * [Persistent subscriptions](#persistent-subscriptions)
   * [Create subscription to all](#create-subscription-to-all)
@@ -1929,6 +1961,40 @@ commit_position = client.tombstone_stream(stream_name=stream_name1, current_vers
 
 After tombstoning a stream, it's not possible to append new events.
 
+### Read using secondary index<a id="read-index"></a>
+
+The method `read_index()` can be used to read from all events using a secondary index.
+
+This method has one required argument, `index_name`.
+
+The required `index_name` argument is a Python `str` that uniquely identifies
+an index from which to read, for example `"et-EventType"`. The KurrentDB convention
+for index names to start with `"idx-"` is supported by making it optional. That is
+to say, both `"et-EventType"` and `"$idx-et-EventType"` will return the same results.
+
+This method has four optional arguments, `commit_position`, `limit`, `timeout`,
+and `credentials`.
+
+The optional `commit_position` argument is a Python `int` that can be used to
+specify a commit position from which to start reading. The default value of
+`commit_position` is `None`. Please note, if a commit position is specified,
+it must be an actually existing commit position in the database. If this position
+corresponds to an event in the index, it will be returned. That is, reading is with
+this method is inclusive.
+
+The optional `limit` argument is an integer which restricts the number of events that
+will be returned. The default value is `sys.maxint`.
+
+The optional `timeout` argument is a Python `float` which sets a
+maximum duration, in seconds, for the completion of the gRPC operation.
+
+The optional `credentials` argument can be used to
+override call credentials derived from the connection string URI.
+
+The filtering of events is done on the KurrentDB server. The
+`limit` argument is applied on the server after filtering.
+
+...
 
 ## Catch-up subscriptions<a id="catch-up-subscriptions"></a>
 
@@ -2211,6 +2277,40 @@ subscription = client.subscribe_to_stream(
 )
 ```
 
+### Subscribe using secondary index<a id="subscribe-to-index"></a>
+
+The`subscribe_to_index()` method can be used to start a catch-up subscription
+that uses a secondary index from which events recorded in the database can
+be obtained in the order they were recorded. This method returns a "catch-up
+subscription" iterator.
+
+This method has one required argument, `index_name`.
+
+The required `index_name` argument is a Python `str` that uniquely identifies
+an index from which to read, for example `"et-EventType"`. The KurrentDB convention
+for index names to start with `"idx-"` is supported by making it optional. That is
+to say, both `"et-EventType"` and `"$idx-et-EventType"` will return the same results.
+
+This method has three optional arguments, `commit_position`, `timeout`,
+and `credentials`.
+
+The optional `commit_position` argument is a Python `int` that can be used to
+specify a commit position from which to start reading. The default value of
+`commit_position` is `None`. Please note, if a commit position is specified,
+it must be an actually existing commit position in the database. If this position
+corresponds to an event in the index, it will not be returned. That is, subscribing
+with this method is not inclusive. This is designed to help event-processing
+components checkpoint their progress with the commit positions of received events,
+and then resume from the last recorded commit position without receiving duplicate
+events.
+
+The optional `timeout` argument is a Python `float` which sets a
+maximum duration, in seconds, for the completion of the gRPC operation.
+
+The optional `credentials` argument can be used to
+override call credentials derived from the connection string URI.
+
+
 ### How to implement exactly-once event processing<a id="how-to-implement-exactly-once-event-processing"></a>
 
 The commit positions of recorded events that are received and processed by a
@@ -3838,4 +3938,5 @@ the project's virtual environment, with the following command.
 
     $ make update
 
-Before pushing changes to the repo or a PR, please run `make lint test`.
+Before pushing changes to the repo or a PR, please run `make lint test`.
+

kurrentdbclient-1.1.2/PKG-INFO → kurrentdbclient-1.2/README.md

@@ -1,34 +1,3 @@
-Metadata-Version: 2.4
-Name: kurrentdbclient
-Version: 1.1.2
-Summary: Python gRPC Client for KurrentDB
-License: BSD-3-Clause
-License-File: LICENSE
-Author: John Bywater
-Author-email: john.bywater@appropriatesoftware.net
-Requires-Python: >=3.9
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python
-Provides-Extra: opentelemetry
-Requires-Dist: googleapis-common-protos
-Requires-Dist: grpcio-status
-Requires-Dist: grpcio[protobuf] (>=1.75.1,<2.0)
-Requires-Dist: opentelemetry-api (>=1.28.0,<2.0) ; extra == "opentelemetry"
-Requires-Dist: opentelemetry-instrumentation (>=0.49b0) ; extra == "opentelemetry"
-Requires-Dist: opentelemetry-semantic-conventions (>=0.49b0) ; extra == "opentelemetry"
-Requires-Dist: typing_extensions
-Project-URL: Homepage, https://github.com/pyeventsourcing/kurrentdbclient
-Project-URL: Repository, https://github.com/pyeventsourcing/kurrentdbclient
-Description-Content-Type: text/markdown
-
 <a href="https://kurrent.io">
   <picture>
     <source media="(prefers-color-scheme: dark)" srcset="https://github.com/pyeventsourcing/kurrentdbclient/raw/1.0/KurrentLogo-White.png.png">
@@ -55,7 +24,7 @@ features are presented in an easy-to-use interface.
 
 These clients have been tested to work with KurrentDB version 25.1 and 25.0, EventStoreDB
 versions 24.10 and EventStoreDB 23.10, both with and without SSL/TLS, in both single-server and
-cluster modes, across Python versions 3.9, 3.10, 3.11, 3.12, 3.13, and 3.14.
+cluster modes, across Python versions 3.10, 3.11, 3.12, 3.13, and 3.14.
 
 The test suite has 100% line and branch coverage. The code has typing annotations
 checked strictly with mypy. The code is formatted with black and isort, and checked
@@ -98,9 +67,11 @@ https://github.com/pyeventsourcing/eventsourcing-kurrentdb) package.
   * [Set stream metadata](#set-stream-metadata)
   * [Delete stream](#delete-stream)
   * [Tombstone stream](#tombstone-stream)
+  * [Read using secondary index](#read-index)
 * [Catch-up subscriptions](#catch-up-subscriptions)
   * [Subscribe to all events](#subscribe-to-all-events)
   * [Subscribe to stream events](#subscribe-to-stream-events)
+  * [Subscribe using secondary index](#subscribe-to-index)
   * [How to implement exactly-once event processing](#how-to-implement-exactly-once-event-processing)
 * [Persistent subscriptions](#persistent-subscriptions)
   * [Create subscription to all](#create-subscription-to-all)
@@ -1960,6 +1931,40 @@ commit_position = client.tombstone_stream(stream_name=stream_name1, current_vers
 
 After tombstoning a stream, it's not possible to append new events.
 
+### Read using secondary index<a id="read-index"></a>
+
+The method `read_index()` can be used to read from all events using a secondary index.
+
+This method has one required argument, `index_name`.
+
+The required `index_name` argument is a Python `str` that uniquely identifies
+an index from which to read, for example `"et-EventType"`. The KurrentDB convention
+for index names to start with `"idx-"` is supported by making it optional. That is
+to say, both `"et-EventType"` and `"$idx-et-EventType"` will return the same results.
+
+This method has four optional arguments, `commit_position`, `limit`, `timeout`,
+and `credentials`.
+
+The optional `commit_position` argument is a Python `int` that can be used to
+specify a commit position from which to start reading. The default value of
+`commit_position` is `None`. Please note, if a commit position is specified,
+it must be an actually existing commit position in the database. If this position
+corresponds to an event in the index, it will be returned. That is, reading is with
+this method is inclusive.
+
+The optional `limit` argument is an integer which restricts the number of events that
+will be returned. The default value is `sys.maxint`.
+
+The optional `timeout` argument is a Python `float` which sets a
+maximum duration, in seconds, for the completion of the gRPC operation.
+
+The optional `credentials` argument can be used to
+override call credentials derived from the connection string URI.
+
+The filtering of events is done on the KurrentDB server. The
+`limit` argument is applied on the server after filtering.
+
+...
 
 ## Catch-up subscriptions<a id="catch-up-subscriptions"></a>
 
@@ -2242,6 +2247,40 @@ subscription = client.subscribe_to_stream(
 )
 ```
 
+### Subscribe using secondary index<a id="subscribe-to-index"></a>
+
+The`subscribe_to_index()` method can be used to start a catch-up subscription
+that uses a secondary index from which events recorded in the database can
+be obtained in the order they were recorded. This method returns a "catch-up
+subscription" iterator.
+
+This method has one required argument, `index_name`.
+
+The required `index_name` argument is a Python `str` that uniquely identifies
+an index from which to read, for example `"et-EventType"`. The KurrentDB convention
+for index names to start with `"idx-"` is supported by making it optional. That is
+to say, both `"et-EventType"` and `"$idx-et-EventType"` will return the same results.
+
+This method has three optional arguments, `commit_position`, `timeout`,
+and `credentials`.
+
+The optional `commit_position` argument is a Python `int` that can be used to
+specify a commit position from which to start reading. The default value of
+`commit_position` is `None`. Please note, if a commit position is specified,
+it must be an actually existing commit position in the database. If this position
+corresponds to an event in the index, it will not be returned. That is, subscribing
+with this method is not inclusive. This is designed to help event-processing
+components checkpoint their progress with the commit positions of received events,
+and then resume from the last recorded commit position without receiving duplicate
+events.
+
+The optional `timeout` argument is a Python `float` which sets a
+maximum duration, in seconds, for the completion of the gRPC operation.
+
+The optional `credentials` argument can be used to
+override call credentials derived from the connection string URI.
+
+
 ### How to implement exactly-once event processing<a id="how-to-implement-exactly-once-event-processing"></a>
 
 The commit positions of recorded events that are received and processed by a

{kurrentdbclient-1.1.2 → kurrentdbclient-1.2}/kurrentdbclient/__init__.py

@@ -26,7 +26,7 @@ from kurrentdbclient.streams import (
     ReadResponse,
 )
 
-__version__ = "1.1.2"
+__version__ = "1.2"
 
 __all__ = [
     "DEFAULT_EXCLUDE_FILTER",

{kurrentdbclient-1.1.2 → kurrentdbclient-1.2}/kurrentdbclient/asyncio_client.py

@@ -4,18 +4,19 @@ import asyncio
 import json
 import sys
 from asyncio import Event, Lock
+from collections.abc import Callable
 from functools import wraps
 from typing import (
     TYPE_CHECKING,
     Any,
-    Callable,
+    Literal,
     TypeVar,
     cast,
     overload,
 )
 
 import grpc.aio
-from typing_extensions import Literal, Self
+from typing_extensions import Self
 
 from kurrentdbclient.client import DEFAULT_EXCLUDE_FILTER, BaseKurrentDBClient
 from kurrentdbclient.common import (
@@ -37,12 +38,12 @@ from kurrentdbclient.common import (
     AbstractAsyncCatchupSubscription,
     AbstractAsyncPersistentSubscription,
     GrpcOptions,
-    grpc_target,
 )
 from kurrentdbclient.connection import AsyncKurrentDBConnection
 from kurrentdbclient.connection_spec import (
     NODE_PREFERENCE_LEADER,
     URI_SCHEMES_NON_DISCOVER,
+    grpc_target,
 )
 from kurrentdbclient.events import NewEvent, NewEvents, RecordedEvent, StreamState
 from kurrentdbclient.exceptions import (
@@ -300,7 +301,7 @@ class AsyncKurrentDBClient(BaseKurrentDBClient):
         *,
         timeout: float | None = None,
         credentials: grpc.CallCredentials | None = None,
-    ) -> int:  # pragma: no v2cover
+    ) -> int:  # pragma: <25.1 no cover
         """
         Appends new events to one or many streams.
         """
@@ -325,6 +326,7 @@ class AsyncKurrentDBClient(BaseKurrentDBClient):
         filter_exclude: Sequence[str] = DEFAULT_EXCLUDE_FILTER,
         filter_include: Sequence[str] = (),
         filter_by_stream_name: bool = False,
+        filter_by_prefix: bool = False,
         limit: int = sys.maxsize,
         timeout: float | None = None,
         credentials: grpc.CallCredentials | None = None,
@@ -339,12 +341,36 @@ class AsyncKurrentDBClient(BaseKurrentDBClient):
             filter_exclude=filter_exclude,
             filter_include=filter_include,
             filter_by_stream_name=filter_by_stream_name,
+            filter_by_prefix=filter_by_prefix,
             limit=limit,
             timeout=timeout,
             metadata=self._call_metadata,
             credentials=credentials or self._call_credentials,
         )
 
+    async def read_index(
+        self,
+        index_name: str,
+        *,
+        commit_position: int | None = None,
+        limit: int = sys.maxsize,
+        timeout: float | None = None,
+        credentials: grpc.CallCredentials | None = None,
+    ) -> AsyncReadResponse:  # pragma: <25.1 no cover
+
+        if not index_name.startswith("$idx-"):
+            index_name = f"$idx-{index_name}"
+
+        return await self.read_all(
+            commit_position=commit_position,
+            filter_include=(index_name,),
+            filter_by_stream_name=True,
+            filter_by_prefix=True,
+            limit=limit,
+            timeout=timeout,
+            credentials=credentials,
+        )
+
     @retrygrpc
     @autoreconnect
     async def get_commit_position(
@@ -492,6 +518,7 @@ class AsyncKurrentDBClient(BaseKurrentDBClient):
         filter_exclude: Sequence[str] = DEFAULT_EXCLUDE_FILTER,
         filter_include: Sequence[str] = (),
         filter_by_stream_name: bool = False,
+        filter_by_prefix: bool = False,
         include_checkpoints: bool = False,
         window_size: int = DEFAULT_WINDOW_SIZE,
         checkpoint_interval_multiplier: int = DEFAULT_CHECKPOINT_INTERVAL_MULTIPLIER,
@@ -511,6 +538,7 @@ class AsyncKurrentDBClient(BaseKurrentDBClient):
             filter_exclude=filter_exclude,
             filter_include=filter_include,
             filter_by_stream_name=filter_by_stream_name,
+            filter_by_prefix=filter_by_prefix,
             subscribe=True,
             include_checkpoints=include_checkpoints,
             window_size=window_size,
@@ -522,6 +550,27 @@ class AsyncKurrentDBClient(BaseKurrentDBClient):
             credentials=credentials or self._call_credentials,
         )
 
+    async def subscribe_to_index(
+        self,
+        index_name: str,
+        *,
+        commit_position: int | None = None,
+        timeout: float | None = None,
+        credentials: grpc.CallCredentials | None = None,
+    ) -> AbstractAsyncCatchupSubscription:  # pragma: <25.1 no cover
+
+        if not index_name.startswith("$idx-"):
+            index_name = f"$idx-{index_name}"
+
+        return await self.subscribe_to_all(
+            commit_position=commit_position,
+            filter_include=(index_name,),
+            filter_by_stream_name=True,
+            filter_by_prefix=True,
+            timeout=timeout,
+            credentials=credentials,
+        )
+
     #
     # @overload
     # async def subscribe_to_stream(

{kurrentdbclient-1.1.2 → kurrentdbclient-1.2}/kurrentdbclient/client.py

@@ -4,20 +4,21 @@ import json
 import random
 import sys
 from abc import ABC, abstractmethod
+from collections.abc import Callable
 from functools import wraps
 from threading import Event, Lock
 from time import sleep
 from typing import (
     TYPE_CHECKING,
     Any,
-    Callable,
+    Literal,
     TypeVar,
     cast,
     overload,
 )
 
 import grpc
-from typing_extensions import Literal, Self
+from typing_extensions import Self
 
 from kurrentdbclient.common import (
     DEFAULT_CHECKPOINT_INTERVAL_MULTIPLIER,
@@ -40,7 +41,6 @@ from kurrentdbclient.common import (
     AbstractReadResponse,
     BasicAuthCallCredentials,
     GrpcOptions,
-    grpc_target,
 )
 from kurrentdbclient.connection import KurrentDBConnection
 from kurrentdbclient.connection_spec import (
@@ -50,6 +50,7 @@ from kurrentdbclient.connection_spec import (
     NODE_PREFERENCE_REPLICA,
     URI_SCHEMES_NON_DISCOVER,
     ConnectionSpec,
+    grpc_target,
 )
 from kurrentdbclient.events import NewEvent, NewEvents, RecordedEvent, StreamState
 from kurrentdbclient.exceptions import (
@@ -70,10 +71,6 @@ from kurrentdbclient.gossip import (
     GossipService,
 )
 
-if TYPE_CHECKING:
-    from kurrentdbclient.streams import StreamsService
-    from kurrentdbclient.v2streams import V2StreamsService
-
 if TYPE_CHECKING:
     from collections.abc import Iterable, Sequence
 
@@ -87,6 +84,8 @@ if TYPE_CHECKING:
         ProjectionState,
         ProjectionStatistics,
     )
+    from kurrentdbclient.streams import StreamsService
+    from kurrentdbclient.v2streams import V2StreamsService
 
 # Matches the 'type' of "system" events.
 KDB_SYSTEM_EVENTS_REGEX = r"\$.+"
@@ -310,7 +309,7 @@ class KurrentDBClient(BaseKurrentDBClient):
         return self._connection.streams
 
     @property
-    def v2streams(self) -> V2StreamsService:  # pragma: no v2cover
+    def v2streams(self) -> V2StreamsService:  # pragma: <25.1 no cover
         return self._connection.v2streams
 
     @property
@@ -565,7 +564,7 @@ class KurrentDBClient(BaseKurrentDBClient):
         *,
         timeout: float | None = None,
         credentials: grpc.CallCredentials | None = None,
-    ) -> int:  # pragma: no v2cover
+    ) -> int:  # pragma: <25.1 no cover
         """
         Appends new events to one or many streams.
         """
@@ -679,6 +678,7 @@ class KurrentDBClient(BaseKurrentDBClient):
         filter_exclude: Sequence[str] = DEFAULT_EXCLUDE_FILTER,
         filter_include: Sequence[str] = (),
         filter_by_stream_name: bool = False,
+        filter_by_prefix: bool = False,
         limit: int = sys.maxsize,
         timeout: float | None = None,
         credentials: grpc.CallCredentials | None = None,
@@ -693,12 +693,36 @@ class KurrentDBClient(BaseKurrentDBClient):
             filter_exclude=filter_exclude,
             filter_include=filter_include,
             filter_by_stream_name=filter_by_stream_name,
+            filter_by_prefix=filter_by_prefix,
             limit=limit,
             timeout=timeout,
             metadata=self._call_metadata,
             credentials=credentials or self._call_credentials,
         )
 
+    def read_index(
+        self,
+        index_name: str,
+        *,
+        commit_position: int | None = None,
+        limit: int = sys.maxsize,
+        timeout: float | None = None,
+        credentials: grpc.CallCredentials | None = None,
+    ) -> AbstractReadResponse:  # pragma: <25.1 no cover
+
+        if not index_name.startswith("$idx-"):
+            index_name = f"$idx-{index_name}"
+
+        return self.read_all(
+            commit_position=commit_position,
+            filter_include=(index_name,),
+            filter_by_stream_name=True,
+            filter_by_prefix=True,
+            limit=limit,
+            timeout=timeout,
+            credentials=credentials,
+        )
+
     @retrygrpc
     @autoreconnect
     def get_current_version(
@@ -827,6 +851,7 @@ class KurrentDBClient(BaseKurrentDBClient):
         filter_exclude: Sequence[str] = DEFAULT_EXCLUDE_FILTER,
         filter_include: Sequence[str] = (),
         filter_by_stream_name: bool = False,
+        filter_by_prefix: bool = False,
         include_checkpoints: bool = False,
         window_size: int = DEFAULT_WINDOW_SIZE,
         checkpoint_interval_multiplier: int = DEFAULT_CHECKPOINT_INTERVAL_MULTIPLIER,
@@ -846,6 +871,7 @@ class KurrentDBClient(BaseKurrentDBClient):
             filter_exclude=filter_exclude,
             filter_include=filter_include,
             filter_by_stream_name=filter_by_stream_name,
+            filter_by_prefix=filter_by_prefix,
             subscribe=True,
             include_checkpoints=include_checkpoints,
             window_size=window_size,
@@ -857,6 +883,27 @@ class KurrentDBClient(BaseKurrentDBClient):
             credentials=credentials or self._call_credentials,
         )
 
+    def subscribe_to_index(
+        self,
+        index_name: str,
+        *,
+        commit_position: int | None = None,
+        timeout: float | None = None,
+        credentials: grpc.CallCredentials | None = None,
+    ) -> AbstractCatchupSubscription:  # pragma: <25.1 no cover
+
+        if not index_name.startswith("$idx-"):
+            index_name = f"$idx-{index_name}"
+
+        return self.subscribe_to_all(
+            commit_position=commit_position,
+            filter_include=(index_name,),
+            filter_by_stream_name=True,
+            filter_by_prefix=True,
+            timeout=timeout,
+            credentials=credentials,
+        )
+
     # @overload
     # def subscribe_to_stream(
     #     self,
@@ -1079,6 +1126,62 @@ class KurrentDBClient(BaseKurrentDBClient):
             credentials=credentials or self._call_credentials,
         )
 
+    # @retrygrpc
+    # @autoreconnect
+    # def create_subscription_to_index(
+    #     self,
+    #     group_name: str,
+    #     *,
+    #     index_name: str,
+    #     from_end: bool = False,
+    #     commit_position: int | None = None,
+    #     window_size: int = DEFAULT_WINDOW_SIZE,
+    #     checkpoint_interval_multiplier: int = DEFAULT_CHECKPOINT_INTERVAL_MULTIPLIER,
+    #     consumer_strategy: ConsumerStrategy = "DispatchToSingle",
+    #     message_timeout: float = DEFAULT_PERSISTENT_SUB_MESSAGE_TIMEOUT,
+    #     max_retry_count: int = DEFAULT_PERSISTENT_SUB_MAX_RETRY_COUNT,
+    #     min_checkpoint_count: int = DEFAULT_PERSISTENT_SUB_MIN_CHECKPOINT_COUNT,
+    #     max_checkpoint_count: int = DEFAULT_PERSISTENT_SUB_MAX_CHECKPOINT_COUNT,
+    #     checkpoint_after: float = DEFAULT_PERSISTENT_SUB_CHECKPOINT_AFTER,
+    #     max_subscriber_count: int = DEFAULT_PERSISTENT_SUB_MAX_SUBSCRIBER_COUNT,
+    #     live_buffer_size: int = DEFAULT_PERSISTENT_SUB_LIVE_BUFFER_SIZE,
+    #     read_batch_size: int = DEFAULT_PERSISTENT_SUB_READ_BATCH_SIZE,
+    #     history_buffer_size: int = DEFAULT_PERSISTENT_SUB_HISTORY_BUFFER_SIZE,
+    #     extra_statistics: bool = False,
+    #     timeout: float | None = None,
+    #     credentials: grpc.CallCredentials | None = None,
+    # ) -> None:
+    #     if not index_name.startswith("$idx-"):
+    #         index_name = f"$idx-{index_name}"
+    #
+    #     timeout = timeout if timeout is not None else self._default_deadline
+    #
+    #     return self.persistent_subscriptions.create(
+    #         group_name=group_name,
+    #         from_end=from_end,
+    #         commit_position=commit_position,
+    #         resolve_links=False,
+    #         consumer_strategy=consumer_strategy,
+    #         filter_include=(index_name,),
+    #         filter_by_stream_name=True,
+    #         filter_by_prefix=True,
+    #         window_size=window_size,
+    #         checkpoint_interval_multiplier=checkpoint_interval_multiplier,
+    #         message_timeout=message_timeout,
+    #         max_retry_count=max_retry_count,
+    #         min_checkpoint_count=min_checkpoint_count,
+    #         max_checkpoint_count=max_checkpoint_count,
+    #         checkpoint_after=checkpoint_after,
+    #         max_subscriber_count=max_subscriber_count,
+    #         live_buffer_size=live_buffer_size,
+    #         read_batch_size=read_batch_size,
+    #         history_buffer_size=history_buffer_size,
+    #         extra_statistics=extra_statistics,
+    #         timeout=timeout,
+    #         metadata=self._call_metadata,
+    #         credentials=credentials or self._call_credentials,
+    #     )
+
     @overload
     def create_subscription_to_stream(
         self,