kurrentdbclient 1.3.0__tar.gz → 1.3.2__tar.gz

kurrentdbclient-1.3.0/README.md → kurrentdbclient-1.3.2/PKG-INFO

@@ -1,4 +1,38 @@
-<a href="https://kurrent.io">
+Metadata-Version: 2.4
+Name: kurrentdbclient
+Version: 1.3.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 :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+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
+Classifier: Topic :: Database
+Classifier: Topic :: Database :: Front-Ends
+Provides-Extra: opentelemetry
+Requires-Dist: googleapis-common-protos
+Requires-Dist: grpcio-status
+Requires-Dist: grpcio[protobuf] (>=1.80.0,<2.0)
+Requires-Dist: opentelemetry-api (>=1.28.0,<2.0) ; extra == "opentelemetry"
+Requires-Dist: opentelemetry-instrumentation (>=0.62b1) ; extra == "opentelemetry"
+Requires-Dist: opentelemetry-semantic-conventions (>=0.62b1) ; extra == "opentelemetry"
+Requires-Dist: typing_extensions
+Project-URL: Homepage, https://github.com/pyeventsourcing/kurrentdbclient
+Project-URL: Repository, https://github.com/pyeventsourcing/kurrentdbclient
+Project-URL: issues, https://github.com/pyeventsourcing/kurrentdbclient/issues
+Description-Content-Type: text/markdown
+
+from uuid import uuid4<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">
     <source media="(prefers-color-scheme: light)" srcset="https://github.com/pyeventsourcing/kurrentdbclient/raw/1.0/KurrentLogo-Black.png">
@@ -59,6 +93,7 @@ https://github.com/pyeventsourcing/eventsourcing-kurrentdb) package.
   * [Append events](#append-events)
   * [Idempotent append operations](#idempotent-append-operations)
   * [Multi-stream append](#multi-stream-append)
+  * [Append records](#append-records)
   * [Read stream events](#read-stream-events)
   * [Get current version](#get-current-version)
   * [How to implement snapshotting with KurrentDB](#how-to-implement-snapshotting-with-kurrentdb)
@@ -1097,6 +1132,50 @@ client.multi_append_to_stream(
 If the `multi_append_to_stream()` operation is successful, the method returns the commit position of
 the last event in the last sequence.
 
+### Append records<a id="append-records"></a>
+
+*requires leader*
+
+*supported by KurrentDB 26.1*
+
+The `append_records()` method can be used to record many events to a different streams
+in any order. The `append_records()` operation is atomic, so that
+either all or none of the new events will be recorded.
+
+The `append_records()` method has one required argument, `records`, which can be either a single
+instance of `NewRecord` or an iterable of `NewRecord` instances.
+
+The `append_records()` method has an optional `checks` argument, which is an iterable of
+`StreamStateCheck` objects.
+
+The `append_records()` method has an optional `timeout` argument, which is a Python `float`
+that sets a maximum duration, in seconds, for the completion of the gRPC operation.
+
+The `append_records()` method has an optional `credentials` argument, which can be used to
+override call credentials derived from the connection string URI.
+
+```python
+from kurrentdbclient import NewRecord, StreamStateCheck
+
+stream_name = str(uuid.uuid4())
+
+client.append_records(
+    records=[
+        NewRecord(
+            stream_name=stream_name,
+            type='EventType1',
+            data=b'{}'
+        ),
+    ],
+    checks=[
+        StreamStateCheck(
+            stream_name=stream_name,
+            expected_state=StreamState.NO_STREAM,
+        ),
+    ],
+)
+```
+
 
 ### Read stream events<a id="read-stream-events"></a>
 
@@ -3061,9 +3140,14 @@ This required `name` argument is a Python `str` that specifies the name of the p
 
 This required `query` argument is a Python `str` that defines what the projection will do.
 
-This method also has four optional arguments, `emit_enabled`,
+This method also has five optional arguments, `engine`, `emit_enabled`,
 `track_emitted_streams`, `timeout`, and `credentials`.
 
+The optional `engine` argument is a Python `str` which specifies whether a
+projection will use version 1 or version 2 of the projections engine. If the
+argument is `"v2"`, the version 2 projection engine will be used, which is more
+reliable than the version 1 projection engine. The default value of `engine` is `v1`.
+
 The optional `emit_enabled` argument is a Python `bool` which specifies whether a
 projection will be able to emit events. If a `True` value is specified, the projection
 will be able to emit events, otherwise the projection will not be able to emit events.
@@ -3926,3 +4010,4 @@ 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`.
+

kurrentdbclient-1.3.0/PKG-INFO → kurrentdbclient-1.3.2/README.md

@@ -1,34 +1,4 @@
-Metadata-Version: 2.4
-Name: kurrentdbclient
-Version: 1.3.0
-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 :: 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
-Provides-Extra: opentelemetry
-Requires-Dist: googleapis-common-protos
-Requires-Dist: grpcio-status
-Requires-Dist: grpcio[protobuf] (>=1.80.0,<2.0)
-Requires-Dist: opentelemetry-api (>=1.28.0,<2.0) ; extra == "opentelemetry"
-Requires-Dist: opentelemetry-instrumentation (>=0.62b1) ; extra == "opentelemetry"
-Requires-Dist: opentelemetry-semantic-conventions (>=0.62b1) ; 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">
+from uuid import uuid4<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">
     <source media="(prefers-color-scheme: light)" srcset="https://github.com/pyeventsourcing/kurrentdbclient/raw/1.0/KurrentLogo-Black.png">
@@ -89,6 +59,7 @@ https://github.com/pyeventsourcing/eventsourcing-kurrentdb) package.
   * [Append events](#append-events)
   * [Idempotent append operations](#idempotent-append-operations)
   * [Multi-stream append](#multi-stream-append)
+  * [Append records](#append-records)
   * [Read stream events](#read-stream-events)
   * [Get current version](#get-current-version)
   * [How to implement snapshotting with KurrentDB](#how-to-implement-snapshotting-with-kurrentdb)
@@ -1127,6 +1098,50 @@ client.multi_append_to_stream(
 If the `multi_append_to_stream()` operation is successful, the method returns the commit position of
 the last event in the last sequence.
 
+### Append records<a id="append-records"></a>
+
+*requires leader*
+
+*supported by KurrentDB 26.1*
+
+The `append_records()` method can be used to record many events to a different streams
+in any order. The `append_records()` operation is atomic, so that
+either all or none of the new events will be recorded.
+
+The `append_records()` method has one required argument, `records`, which can be either a single
+instance of `NewRecord` or an iterable of `NewRecord` instances.
+
+The `append_records()` method has an optional `checks` argument, which is an iterable of
+`StreamStateCheck` objects.
+
+The `append_records()` method has an optional `timeout` argument, which is a Python `float`
+that sets a maximum duration, in seconds, for the completion of the gRPC operation.
+
+The `append_records()` method has an optional `credentials` argument, which can be used to
+override call credentials derived from the connection string URI.
+
+```python
+from kurrentdbclient import NewRecord, StreamStateCheck
+
+stream_name = str(uuid.uuid4())
+
+client.append_records(
+    records=[
+        NewRecord(
+            stream_name=stream_name,
+            type='EventType1',
+            data=b'{}'
+        ),
+    ],
+    checks=[
+        StreamStateCheck(
+            stream_name=stream_name,
+            expected_state=StreamState.NO_STREAM,
+        ),
+    ],
+)
+```
+
 
 ### Read stream events<a id="read-stream-events"></a>
 
@@ -3091,9 +3106,14 @@ This required `name` argument is a Python `str` that specifies the name of the p
 
 This required `query` argument is a Python `str` that defines what the projection will do.
 
-This method also has four optional arguments, `emit_enabled`,
+This method also has five optional arguments, `engine`, `emit_enabled`,
 `track_emitted_streams`, `timeout`, and `credentials`.
 
+The optional `engine` argument is a Python `str` which specifies whether a
+projection will use version 1 or version 2 of the projections engine. If the
+argument is `"v2"`, the version 2 projection engine will be used, which is more
+reliable than the version 1 projection engine. The default value of `engine` is `v1`.
+
 The optional `emit_enabled` argument is a Python `bool` which specifies whether a
 projection will be able to emit events. If a `True` value is specified, the projection
 will be able to emit events, otherwise the projection will not be able to emit events.
@@ -3956,4 +3976,3 @@ 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`.
-

{kurrentdbclient-1.3.0 → kurrentdbclient-1.3.2}/kurrentdbclient/__init__.py

@@ -28,7 +28,7 @@ from kurrentdbclient.streams import (
     ReadResponse,
 )
 
-__version__ = "1.3.0"
+__version__ = "1.3.2"
 
 __all__ = [
     "DEFAULT_EXCLUDE_FILTER",

{kurrentdbclient-1.3.0 → kurrentdbclient-1.3.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [project]
 name = "kurrentdbclient"
-version = "1.3.0"
+version = "1.3.2"
 description = "Python gRPC Client for KurrentDB"
 license = { text = "BSD-3-Clause" }
 readme = "README.md"
@@ -17,6 +17,7 @@ classifiers = [
 #    "Development Status :: 4 - Beta",
     "Development Status :: 5 - Production/Stable",
     "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
@@ -24,7 +25,8 @@ classifiers = [
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3.14",
     "Programming Language :: Python",
-]
+    "Topic :: Database",
+    "Topic :: Database :: Front-Ends",]
 dependencies = [
     "grpcio[protobuf]>=1.80.0,<2.0",
     "typing_extensions",
@@ -42,6 +44,7 @@ opentelemetry = [
 [project.urls]
 homepage = "https://github.com/pyeventsourcing/kurrentdbclient"
 repository = "https://github.com/pyeventsourcing/kurrentdbclient"
+issues = "https://github.com/pyeventsourcing/kurrentdbclient/issues"
 
 [tool.poetry]
 include = ["kurrentdbclient/py.typed"]