This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch gh-pages
in repository https://gitbox.apache.org/repos/asf/burr.git
The following commit(s) were added to refs/heads/gh-pages by this push:
new 1401c970 deploy: a28b15287ca7d2cfe413805204bd4ae3bc080c5e
1401c970 is described below
commit 1401c970ce6787ea572e48fb28f2bb68be960fde
Author: elijahbenizzy <[email protected]>
AuthorDate: Wed Nov 26 04:52:33 2025 +0000
deploy: a28b15287ca7d2cfe413805204bd4ae3bc080c5e
---
pull/595/.doctrees/environment.pickle | Bin 442825 -> 442330 bytes
pull/595/.doctrees/reference/actions.doctree | Bin 296196 -> 300214 bytes
pull/595/.doctrees/reference/application.doctree | Bin 589930 -> 593653 bytes
pull/595/.doctrees/reference/conditions.doctree | Bin 59410 -> 60107 bytes
.../reference/integrations/hamilton.doctree | Bin 30636 -> 31046 bytes
.../reference/integrations/haystack.doctree | Bin 27646 -> 27810 bytes
.../reference/integrations/opentelemetry.doctree | Bin 46587 -> 46915 bytes
.../.doctrees/reference/integrations/ray.doctree | Bin 16117 -> 16363 bytes
.../reference/integrations/streamlit.doctree | Bin 38162 -> 38736 bytes
pull/595/.doctrees/reference/lifecycle.doctree | Bin 111646 -> 113491 bytes
pull/595/.doctrees/reference/parallelism.doctree | Bin 321098 -> 323640 bytes
pull/595/.doctrees/reference/persister.doctree | Bin 632776 -> 625377 bytes
pull/595/.doctrees/reference/serde.doctree | Bin 105651 -> 107086 bytes
pull/595/.doctrees/reference/state.doctree | Bin 83184 -> 82631 bytes
pull/595/.doctrees/reference/tracking.doctree | Bin 91315 -> 92135 bytes
pull/595/.doctrees/reference/typing.doctree | Bin 64807 -> 65923 bytes
pull/595/.doctrees/reference/visibility.doctree | Bin 55085 -> 55659 bytes
pull/595/genindex/index.html | 24 +----
pull/595/objects.inv | Bin 4477 -> 4458 bytes
pull/595/reference/application/index.html | 2 +-
pull/595/reference/parallelism/index.html | 4 +-
pull/595/reference/persister/index.html | 113 ++++++---------------
pull/595/reference/state/index.html | 11 --
pull/595/searchindex.js | 2 +-
24 files changed, 41 insertions(+), 115 deletions(-)
diff --git a/pull/595/.doctrees/environment.pickle
b/pull/595/.doctrees/environment.pickle
index 8b47b6ea..8148ab6a 100644
Binary files a/pull/595/.doctrees/environment.pickle and
b/pull/595/.doctrees/environment.pickle differ
diff --git a/pull/595/.doctrees/reference/actions.doctree
b/pull/595/.doctrees/reference/actions.doctree
index fbfa17d4..325eb57b 100644
Binary files a/pull/595/.doctrees/reference/actions.doctree and
b/pull/595/.doctrees/reference/actions.doctree differ
diff --git a/pull/595/.doctrees/reference/application.doctree
b/pull/595/.doctrees/reference/application.doctree
index c60e812d..67b1facd 100644
Binary files a/pull/595/.doctrees/reference/application.doctree and
b/pull/595/.doctrees/reference/application.doctree differ
diff --git a/pull/595/.doctrees/reference/conditions.doctree
b/pull/595/.doctrees/reference/conditions.doctree
index 409ca9e4..f058cd17 100644
Binary files a/pull/595/.doctrees/reference/conditions.doctree and
b/pull/595/.doctrees/reference/conditions.doctree differ
diff --git a/pull/595/.doctrees/reference/integrations/hamilton.doctree
b/pull/595/.doctrees/reference/integrations/hamilton.doctree
index de14f4fe..b0b2e059 100644
Binary files a/pull/595/.doctrees/reference/integrations/hamilton.doctree and
b/pull/595/.doctrees/reference/integrations/hamilton.doctree differ
diff --git a/pull/595/.doctrees/reference/integrations/haystack.doctree
b/pull/595/.doctrees/reference/integrations/haystack.doctree
index 63a21b00..95a5ee95 100644
Binary files a/pull/595/.doctrees/reference/integrations/haystack.doctree and
b/pull/595/.doctrees/reference/integrations/haystack.doctree differ
diff --git a/pull/595/.doctrees/reference/integrations/opentelemetry.doctree
b/pull/595/.doctrees/reference/integrations/opentelemetry.doctree
index 7ea72feb..f7a01e1c 100644
Binary files a/pull/595/.doctrees/reference/integrations/opentelemetry.doctree
and b/pull/595/.doctrees/reference/integrations/opentelemetry.doctree differ
diff --git a/pull/595/.doctrees/reference/integrations/ray.doctree
b/pull/595/.doctrees/reference/integrations/ray.doctree
index 9c10e332..2f2de71e 100644
Binary files a/pull/595/.doctrees/reference/integrations/ray.doctree and
b/pull/595/.doctrees/reference/integrations/ray.doctree differ
diff --git a/pull/595/.doctrees/reference/integrations/streamlit.doctree
b/pull/595/.doctrees/reference/integrations/streamlit.doctree
index 6a08ec73..2d281e77 100644
Binary files a/pull/595/.doctrees/reference/integrations/streamlit.doctree and
b/pull/595/.doctrees/reference/integrations/streamlit.doctree differ
diff --git a/pull/595/.doctrees/reference/lifecycle.doctree
b/pull/595/.doctrees/reference/lifecycle.doctree
index 939a54a2..c659ef57 100644
Binary files a/pull/595/.doctrees/reference/lifecycle.doctree and
b/pull/595/.doctrees/reference/lifecycle.doctree differ
diff --git a/pull/595/.doctrees/reference/parallelism.doctree
b/pull/595/.doctrees/reference/parallelism.doctree
index 38cb1914..44ee339e 100644
Binary files a/pull/595/.doctrees/reference/parallelism.doctree and
b/pull/595/.doctrees/reference/parallelism.doctree differ
diff --git a/pull/595/.doctrees/reference/persister.doctree
b/pull/595/.doctrees/reference/persister.doctree
index 1f14bd4a..ec1def3e 100644
Binary files a/pull/595/.doctrees/reference/persister.doctree and
b/pull/595/.doctrees/reference/persister.doctree differ
diff --git a/pull/595/.doctrees/reference/serde.doctree
b/pull/595/.doctrees/reference/serde.doctree
index 85cfd40f..f3f1a07a 100644
Binary files a/pull/595/.doctrees/reference/serde.doctree and
b/pull/595/.doctrees/reference/serde.doctree differ
diff --git a/pull/595/.doctrees/reference/state.doctree
b/pull/595/.doctrees/reference/state.doctree
index 68beb3ab..6ec0df62 100644
Binary files a/pull/595/.doctrees/reference/state.doctree and
b/pull/595/.doctrees/reference/state.doctree differ
diff --git a/pull/595/.doctrees/reference/tracking.doctree
b/pull/595/.doctrees/reference/tracking.doctree
index d74b952a..76f73874 100644
Binary files a/pull/595/.doctrees/reference/tracking.doctree and
b/pull/595/.doctrees/reference/tracking.doctree differ
diff --git a/pull/595/.doctrees/reference/typing.doctree
b/pull/595/.doctrees/reference/typing.doctree
index 96bcb39e..a85cebb8 100644
Binary files a/pull/595/.doctrees/reference/typing.doctree and
b/pull/595/.doctrees/reference/typing.doctree differ
diff --git a/pull/595/.doctrees/reference/visibility.doctree
b/pull/595/.doctrees/reference/visibility.doctree
index 48ec94ad..8bf3d4d8 100644
Binary files a/pull/595/.doctrees/reference/visibility.doctree and
b/pull/595/.doctrees/reference/visibility.doctree differ
diff --git a/pull/595/genindex/index.html b/pull/595/genindex/index.html
index b93119fe..bfa7a59b 100644
--- a/pull/595/genindex/index.html
+++ b/pull/595/genindex/index.html
@@ -361,7 +361,7 @@
<section class="genindex-section">
<h1 id="index">Index</h1>
- <div class="genindex-jumpbox"><a href="#_"><strong>_</strong></a> | <a
href="#A"><strong>A</strong></a> | <a href="#B"><strong>B</strong></a> | <a
href="#C"><strong>C</strong></a> | <a href="#D"><strong>D</strong></a> | <a
href="#E"><strong>E</strong></a> | <a href="#F"><strong>F</strong></a> | <a
href="#G"><strong>G</strong></a> | <a href="#H"><strong>H</strong></a> | <a
href="#I"><strong>I</strong></a> | <a href="#K"><strong>K</strong></a> | <a
href="#L"><strong>L</strong></a> | <a h [...]
+ <div class="genindex-jumpbox"><a href="#_"><strong>_</strong></a> | <a
href="#A"><strong>A</strong></a> | <a href="#B"><strong>B</strong></a> | <a
href="#C"><strong>C</strong></a> | <a href="#D"><strong>D</strong></a> | <a
href="#E"><strong>E</strong></a> | <a href="#F"><strong>F</strong></a> | <a
href="#G"><strong>G</strong></a> | <a href="#H"><strong>H</strong></a> | <a
href="#I"><strong>I</strong></a> | <a href="#L"><strong>L</strong></a> | <a
href="#M"><strong>M</strong></a> | <a h [...]
</section>
<section id="_" class="genindex-section">
<h2>_</h2>
@@ -594,22 +594,18 @@
<li><a
href="../reference/typing/#burr.integrations.pydantic.PydanticTypingSystem.construct_data">(burr.integrations.pydantic.PydanticTypingSystem
method)</a>
</li>
</ul></li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="../reference/typing/#burr.core.typing.TypingSystem.construct_state">construct_state()
(burr.core.typing.TypingSystem method)</a>
<ul>
<li><a
href="../reference/typing/#burr.integrations.pydantic.PydanticTypingSystem.construct_state">(burr.integrations.pydantic.PydanticTypingSystem
method)</a>
</li>
</ul></li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="../reference/application/#burr.core.application.Application.context">context
(burr.core.application.Application property)</a>
</li>
- <li><a
href="../reference/persister/#burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister.copy">copy()
(burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister method)</a>
-
- <ul>
- <li><a
href="../reference/tracking/#burr.tracking.LocalTrackingClient.copy">(burr.tracking.LocalTrackingClient
method)</a>
+ <li><a
href="../reference/tracking/#burr.tracking.LocalTrackingClient.copy">copy()
(burr.tracking.LocalTrackingClient method)</a>
</li>
- </ul></li>
<li><a
href="../reference/parallelism/#burr.core.parallelism.RunnableGraph.create">create()
(burr.core.parallelism.RunnableGraph static method)</a>
</li>
<li><a
href="../reference/visibility/#burr.visibility.tracing.ActionSpan.create_initial">create_initial()
(burr.visibility.tracing.ActionSpan class method)</a>
@@ -620,8 +616,6 @@
<li><a
href="../reference/persister/#burr.integrations.persisters.b_redis.RedisBasePersister.create_key">(burr.integrations.persisters.b_redis.RedisBasePersister
method)</a>
</li>
</ul></li>
- <li><a
href="../reference/persister/#burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister.create_pool">create_pool()
(burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister class
method)</a>
-</li>
<li><a
href="../reference/persister/#burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister.create_table">create_table()
(burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister method)</a>
<ul>
@@ -856,16 +850,6 @@
</tr></table>
</section>
-<section id="K" class="genindex-section">
- <h2>K</h2>
- <table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="../reference/state/#burr.core.state.State.keys">keys()
(burr.core.state.State method)</a>
-</li>
- </ul></td>
- </tr></table>
-</section>
-
<section id="L" class="genindex-section">
<h2>L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
diff --git a/pull/595/objects.inv b/pull/595/objects.inv
index c2aaf559..6cecb96d 100644
Binary files a/pull/595/objects.inv and b/pull/595/objects.inv differ
diff --git a/pull/595/reference/application/index.html
b/pull/595/reference/application/index.html
index f9dfdb90..94f1b332 100644
--- a/pull/595/reference/application/index.html
+++ b/pull/595/reference/application/index.html
@@ -946,7 +946,7 @@ allowed to have a return value.</p>
<dd><em class="sig-param"><span class="n"><span
class="pre">inputs</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span
class="pre">str</span><span class="p"><span class="pre">,</span></span><span
class="w"> </span><span class="pre">Any</span><span class="p"><span
class="pre">]</span></span><span class="w"> </span><span class="p"><span
class="pre">|</span>< [...]
</dl>
-<span class="sig-paren">)</span> <span class="sig-return"><span
class="sig-return-icon">→</span> <span class="sig-return-typehint"><span
class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><a
class="reference internal" href="../actions/#burr.core.action.Action"
title="burr.core.action.Action"><span class="pre">Action</span></a><span
class="p"><span class="pre">,</span></span><span class="w"> </span><span
class="pre">dict</span><span class="w"> </span><span cla [...]
+<span class="sig-paren">)</span> <span class="sig-return"><span
class="sig-return-icon">→</span> <span class="sig-return-typehint"><span
class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><a
class="reference internal" href="../actions/#burr.core.action.Action"
title="burr.core.action.Action"><span class="pre">Action</span></a><span
class="p"><span class="pre">,</span></span><span class="w"> </span><span
class="pre">dict</span><span class="w"> </span><span cla [...]
<dd><p>Runs your application through until completion, using async. Does
not give access to the state along the way – if you want that, use
iterate().</p>
<p>Note that tags must be specified by the form “@tag:<tag_name>” to
differentiate them from actions.</p>
diff --git a/pull/595/reference/parallelism/index.html
b/pull/595/reference/parallelism/index.html
index d0ab1fc3..344a5102 100644
--- a/pull/595/reference/parallelism/index.html
+++ b/pull/595/reference/parallelism/index.html
@@ -879,7 +879,7 @@ action objects, or subdags implemented as <a
class="reference internal" href="#b
<span class="k">class</span><span class="w"> </span><span
class="nc">TestMultipleModels</span><span class="p">(</span><span
class="n">MapActions</span><span class="p">):</span>
- <span class="k">def</span><span class="w"> </span><span
class="nf">actions</span><span class="p">(</span><span
class="bp">self</span><span class="p">,</span> <span
class="n">state</span><span class="p">:</span> <span
class="n">State</span><span class="p">,</span> <span
class="n">context</span><span class="p">:</span> <span
class="n">ApplicationContext</span><span class="p">,</span> <span
class="n">inputs</span><span class="p">:</span> <span
class="n">Dict</span><span class="p">[</spa [...]
+ <span class="k">def</span><span class="w"> </span><span
class="nf">actions</span><span class="p">(</span><span
class="bp">self</span><span class="p">,</span> <span
class="n">state</span><span class="p">:</span> <span
class="n">State</span><span class="p">,</span> <span
class="n">inputs</span><span class="p">:</span> <span
class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span
class="p">,</span> <span class="n">Any</span><span class="p">],</span> <span
class="n" [...]
<span class="c1"># Make sure to add a name to the action if you use
bind() with a function,</span>
<span class="c1"># note that these can be different actions,
functions, etc...</span>
<span class="c1"># in this case we're using `.bind()` to create
multiple actions, but we can use some mix of</span>
@@ -915,8 +915,8 @@ action objects, or subdags implemented as <a
class="reference internal" href="#b
<dl>
<dd><em class="sig-param"><span class="n"><span
class="pre">state</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><a
class="reference internal" href="../state/#burr.core.state.State"
title="burr.core.state.State"><span
class="pre">State</span></a></span></em>,</dd>
-<dd><em class="sig-param"><span class="n"><span
class="pre">context</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><a
class="reference internal"
href="../application/#burr.core.application.ApplicationContext"
title="burr.core.application.ApplicationContext"><span
class="pre">ApplicationContext</span></a></span></em>,</dd>
<dd><em class="sig-param"><span class="n"><span
class="pre">inputs</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span
class="pre">str</span><span class="p"><span class="pre">,</span></span><span
class="w"> </span><span class="pre">Any</span><span class="p"><span
class="pre">]</span></span></span></em>,</dd>
+<dd><em class="sig-param"><span class="n"><span
class="pre">context</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><a
class="reference internal"
href="../application/#burr.core.application.ApplicationContext"
title="burr.core.application.ApplicationContext"><span
class="pre">ApplicationContext</span></a></span></em>,</dd>
</dl>
<span class="sig-paren">)</span> <span class="sig-return"><span
class="sig-return-icon">→</span> <span class="sig-return-typehint"><span
class="pre">Generator</span><span class="p"><span class="pre">[</span></span><a
class="reference internal" href="../actions/#burr.core.action.Action"
title="burr.core.action.Action"><span class="pre">Action</span></a><span
class="w"> </span><span class="p"><span class="pre">|</span></span><span
class="w"> </span><span class="pre">Callable</span>< [...]
diff --git a/pull/595/reference/persister/index.html
b/pull/595/reference/persister/index.html
index ff41edcb..fc51b2f3 100644
--- a/pull/595/reference/persister/index.html
+++ b/pull/595/reference/persister/index.html
@@ -1458,17 +1458,18 @@ so this is an attempt to fix that in a backwards
compatible way.</p>
If a sequence ID is provided, it will attempt to fetch the specific state at
that sequence.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>partition_key</strong> – The partition key. Defaults to
<cite>None</cite>.
-<strong>Note:</strong> The partition key defaults to <cite>None</cite>. If a
partition key was used during saving,
-it must be provided consistently during retrieval, or no results will be
returned.</p></li>
-<li><p><strong>app_id</strong> – Application UID to read from.</p></li>
-<li><p><strong>sequence_id</strong> – (Optional) The sequence ID to retrieve a
specific state. If not provided,
-the latest state is returned.</p></li>
-</ul>
+<dd class="field-odd"><p><strong>partition_key</strong> – The partition key.
Defaults to <cite>None</cite>. <strong>Note:</strong> The partition key
defaults to <cite>None</cite>. If a partition key was used during saving, it
must be provided</p>
</dd>
-<dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p>The state data if found, otherwise None.</p>
+</dl>
+<p>consistently during retrieval, or no results will be returned.
+:param app_id: Application UID to read from.
+:param sequence_id: (Optional) The sequence ID to retrieve a specific state.
If not provided,</p>
+<blockquote>
+<div><p>the latest state is returned.</p>
+</div></blockquote>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>The state data if found, otherwise None.</p>
</dd>
</dl>
</dd></dl>
@@ -1491,21 +1492,22 @@ the latest state is returned.</p></li>
<dd><p>Save the state data to the MongoDB database.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>partition_key</strong> – the partition key. Note this could be
None, but it’s up to the persistor
-to whether that is a valid value it can handle. If a partition key was used
-during saving, it must be provided consistently during retrieval, or no
-results will be returned.</p></li>
-<li><p><strong>app_id</strong> – Application UID to write with.</p></li>
-<li><p><strong>sequence_id</strong> – Sequence ID of the last executed
step.</p></li>
-<li><p><strong>position</strong> – The action name that was
implemented.</p></li>
-<li><p><strong>state</strong> – The current state of the application.</p></li>
-<li><p><strong>status</strong> – The status of this state, either “completed”
or “failed”. If “failed”, the state
-is what it was before the action was applied.</p></li>
-</ul>
+<dd class="field-odd"><p><strong>partition_key</strong> – the partition key.
Note this could be None, but it’s up to the persistor to whether</p>
</dd>
-<dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p></p>
+</dl>
+<p>that is a valid value it can handle. If a partition key was used during
saving, it must be provided
+consistently during retrieval, or no results will be returned.
+:param app_id: Application UID to write with.
+:param sequence_id: Sequence ID of the last executed step.
+:param position: The action name that was implemented.
+:param state: The current state of the application.
+:param status: The status of this state, either “completed” or “failed”. If
“failed”, the state is what it was</p>
+<blockquote>
+<div><p>before the action was applied.</p>
+</div></blockquote>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p></p>
</dd>
</dl>
</dd></dl>
@@ -1722,16 +1724,7 @@ before the action was applied.</p></li>
<dl class="py class" id="asyncpostgresref">
<dt class="sig sig-object py"
id="burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister">
-<em class="property"><span class="k"><span
class="pre">class</span></span><span class="w"> </span></em><span
class="sig-prename descclassname"><span
class="pre">burr.integrations.persisters.b_asyncpg.</span></span><span
class="sig-name descname"><span
class="pre">AsyncPostgreSQLPersister</span></span><span
class="sig-paren">(</span>
-
-<dl>
-<dd><em class="sig-param"><span class="n"><span
class="pre">connection</span></span><span class="o"><span
class="pre">=</span></span><span class="default_value"><span
class="pre">None</span></span></em>,</dd>
-<dd><em class="sig-param"><span class="n"><span
class="pre">pool</span></span><span class="o"><span
class="pre">=</span></span><span class="default_value"><span
class="pre">None</span></span></em>,</dd>
-<dd><em class="sig-param"><span class="n"><span
class="pre">table_name</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">str</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">'burr_state'</span></span></em>,</dd>
-<dd><em class="sig-param"><span class="n"><span
class="pre">serde_kwargs</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">dict</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">None</span></span></em>,</dd>
-</dl>
-
-<span class="sig-paren">)</span><a class="headerlink"
href="#burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister"
title="Link to this definition">¶</a></dt>
+<em class="property"><span class="k"><span
class="pre">class</span></span><span class="w"> </span></em><span
class="sig-prename descclassname"><span
class="pre">burr.integrations.persisters.b_asyncpg.</span></span><span
class="sig-name descname"><span
class="pre">AsyncPostgreSQLPersister</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">connection</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">table_name</spa [...]
<dd><p>Class for async PostgreSQL persistence of state.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -1741,12 +1734,6 @@ gets invoked). Therefore, you are responsible for
closing the connection yoursel
We suggest to use the persister either as a context manager through the <code
class="docutils literal notranslate"><span class="pre">async</span> <span
class="pre">with</span></code> clause or
using the method <code class="docutils literal notranslate"><span
class="pre">.cleanup()</span></code>.</p>
</div>
-<div class="admonition warning">
-<p class="admonition-title">Warning</p>
-<p>If you intend to use parallelism features or need to share this persister
across multiple tasks,
-you should initialize it with a connection pool (set <code class="docutils
literal notranslate"><span class="pre">use_pool=True</span></code> in <code
class="docutils literal notranslate"><span
class="pre">from_values</span></code>).
-Direct connections cannot be shared across different tasks and may cause
errors in concurrent scenarios.</p>
-</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The implementation relies on the popular asyncpg library: <a
class="reference external"
href="https://github.com/MagicStack/asyncpg";>https://github.com/MagicStack/asyncpg</a></p>
@@ -1754,10 +1741,10 @@ Direct connections cannot be shared across different
tasks and may cause errors
explaining why a new implementation, performance review and comparison to
aiopg (async interface of psycopg2).</p>
</div>
<p>To try it out locally with docker – here’s a command – change the values as
appropriate.</p>
-<div class="highlight-bash notranslate"><div
class="highlight"><pre><span></span>docker<span class="w"> </span>run<span
class="w"> </span>--name<span class="w"> </span>local-psql<span class="w">
</span><span class="se">\\</span><span class="w"> </span><span class="c1">#
container name</span>
-<span class="w"> </span>-v<span class="w">
</span>local_psql_data:/SOME/FILE_PATH/<span class="w"> </span><span
class="se">\\</span><span class="w"> </span><span class="c1"># mounting a
volume for data persistence</span>
-<span class="w"> </span>-p<span class="w"> </span><span
class="m">54320</span>:5432<span class="w"> </span><span
class="se">\\</span><span class="w"> </span><span class="c1"># port
mapping</span>
-<span class="w"> </span>-e<span class="w"> </span><span
class="nv">POSTGRES_PASSWORD</span><span class="o">=</span>my_password<span
class="w"> </span><span class="se">\\</span><span class="w"> </span><span
class="c1"># superuser password</span>
+<div class="highlight-bash notranslate"><div
class="highlight"><pre><span></span>docker<span class="w"> </span>run<span
class="w"> </span>--name<span class="w"> </span>local-psql<span class="w">
</span><span class="se">\ </span><span class="w"> </span><span class="c1">#
container name</span>
+<span class="w"> </span>-v<span class="w">
</span>local_psql_data:/SOME/FILE_PATH/<span class="w"> </span><span
class="se">\ </span><span class="w"> </span><span class="c1"># mounting a
volume for data persistence</span>
+<span class="w"> </span>-p<span class="w"> </span><span
class="m">54320</span>:5432<span class="w"> </span><span class="se">\
</span><span class="w"> </span><span class="c1"># port mapping</span>
+<span class="w"> </span>-e<span class="w"> </span><span
class="nv">POSTGRES_PASSWORD</span><span class="o">=</span>my_password<span
class="w"> </span><span class="se">\ </span><span class="w"> </span><span
class="c1"># superuser password</span>
<span class="w"> </span>-d<span class="w"> </span>postgres<span
class="w"> </span><span class="c1"># database name</span>
</pre></div>
</div>
@@ -1771,8 +1758,7 @@ explaining why a new implementation, performance review
and comparison to aiopg
<span class="sig-name descname"><span class="pre">__init__</span></span><span
class="sig-paren">(</span>
<dl>
-<dd><em class="sig-param"><span class="n"><span
class="pre">connection</span></span><span class="o"><span
class="pre">=</span></span><span class="default_value"><span
class="pre">None</span></span></em>,</dd>
-<dd><em class="sig-param"><span class="n"><span
class="pre">pool</span></span><span class="o"><span
class="pre">=</span></span><span class="default_value"><span
class="pre">None</span></span></em>,</dd>
+<dd><em class="sig-param"><span class="n"><span
class="pre">connection</span></span></em>,</dd>
<dd><em class="sig-param"><span class="n"><span
class="pre">table_name</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">str</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">'burr_state'</span></span></em>,</dd>
<dd><em class="sig-param"><span class="n"><span
class="pre">serde_kwargs</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">dict</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">None</span></span></em>,</dd>
</dl>
@@ -1782,10 +1768,8 @@ explaining why a new implementation, performance review
and comparison to aiopg
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
-<li><p><strong>connection</strong> – the connection to the PostgreSQL database
(optional if pool is provided)</p></li>
-<li><p><strong>pool</strong> – a connection pool to use instead of a direct
connection (optional if connection is provided)</p></li>
+<li><p><strong>connection</strong> – the connection to the PostgreSQL
database.</p></li>
<li><p><strong>table_name</strong> – the table name to store things
under.</p></li>
-<li><p><strong>serde_kwargs</strong> – kwargs for state
serialization/deserialization</p></li>
</ul>
</dd>
</dl>
@@ -1797,31 +1781,6 @@ explaining why a new implementation, performance review
and comparison to aiopg
<dd><p>Closes the connection to the database.</p>
</dd></dl>
-<dl class="py method">
-<dt class="sig sig-object py"
id="burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister.copy">
-<span class="sig-name descname"><span class="pre">copy</span></span><span
class="sig-paren">(</span><span class="sig-paren">)</span> <span
class="sig-return"><span class="sig-return-icon">→</span> <span
class="sig-return-typehint"><span class="pre">Self</span></span></span><a
class="headerlink"
href="#burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister.copy"
title="Link to this definition">¶</a></dt>
-<dd><p>Creates a copy of this persister.</p>
-<p>If using a pool, returns a new persister that will acquire its own
connection from the pool.
-If using a direct connection, just returns a new persister with the same
connection (won’t work for async parallelism)</p>
-</dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py"
id="burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister.create_pool">
-<em class="property"><span class="k"><span
class="pre">async</span></span><span class="w"> </span><span class="k"><span
class="pre">classmethod</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">create_pool</span></span><span
class="sig-paren">(</span>
-
-<dl>
-<dd><em class="sig-param"><span class="n"><span
class="pre">user</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">str</span></span></em>,</dd>
-<dd><em class="sig-param"><span class="n"><span
class="pre">password</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">str</span></span></em>,</dd>
-<dd><em class="sig-param"><span class="n"><span
class="pre">database</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">str</span></span></em>,</dd>
-<dd><em class="sig-param"><span class="n"><span
class="pre">host</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">str</span></span></em>,</dd>
-<dd><em class="sig-param"><span class="n"><span
class="pre">port</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">int</span></span></em>,</dd>
-<dd><em class="sig-param"><span class="o"><span
class="pre">**</span></span><span class="n"><span
class="pre">pool_kwargs</span></span></em>,</dd>
-</dl>
-
-<span class="sig-paren">)</span> <span class="sig-return"><span
class="sig-return-icon">→</span> <span class="sig-return-typehint"><span
class="pre">Pool</span></span></span><a class="headerlink"
href="#burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister.create_pool"
title="Link to this definition">¶</a></dt>
-<dd><p>Creates a connection pool that can be shared across persisters.</p>
-</dd></dl>
-
<dl class="py method">
<dt class="sig sig-object py"
id="burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister.create_table">
<em class="property"><span class="k"><span
class="pre">async</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">create_table</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">table_name</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">str</span></span></em><span class="sig-paren">)</span><a
class="headerlink" href="#burr.integr [...]
@@ -1851,8 +1810,6 @@ If using a direct connection, just returns a new
persister with the same connect
<dd><em class="sig-param"><span class="n"><span
class="pre">host</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">str</span></span></em>,</dd>
<dd><em class="sig-param"><span class="n"><span
class="pre">port</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">int</span></span></em>,</dd>
<dd><em class="sig-param"><span class="n"><span
class="pre">table_name</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">str</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">'burr_state'</span></span></em>,</dd>
-<dd><em class="sig-param"><span class="n"><span
class="pre">use_pool</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">False</span></span></em>,</dd>
-<dd><em class="sig-param"><span class="o"><span
class="pre">**</span></span><span class="n"><span
class="pre">pool_kwargs</span></span></em>,</dd>
</dl>
<span class="sig-paren">)</span> <span class="sig-return"><span
class="sig-return-icon">→</span> <span class="sig-return-typehint"><a
class="reference internal"
href="#burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister"
title="burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister"><span
class="pre">AsyncPostgreSQLPersister</span></a></span></span><a
class="headerlink"
href="#burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister.from_values"
title=" [...]
@@ -1866,8 +1823,6 @@ If using a direct connection, just returns a new
persister with the same connect
<li><p><strong>host</strong> – the host of the PostgreSQL database.</p></li>
<li><p><strong>port</strong> – the port of the PostgreSQL database.</p></li>
<li><p><strong>table_name</strong> – the table name to store things
under.</p></li>
-<li><p><strong>use_pool</strong> – whether to use a connection pool (True) or
a direct connection (False)</p></li>
-<li><p><strong>pool_kwargs</strong> – additional kwargs to pass to the pool
creation</p></li>
</ul>
</dd>
</dl>
@@ -2305,8 +2260,6 @@ It inherits from the AsyncBaseStatePersister class.</p>
<li><a class="reference internal"
href="#burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister"><code
class="docutils literal notranslate"><span
class="pre">AsyncPostgreSQLPersister</span></code></a><ul>
<li><a class="reference internal"
href="#burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister.__init__"><code
class="docutils literal notranslate"><span
class="pre">AsyncPostgreSQLPersister.__init__()</span></code></a></li>
<li><a class="reference internal"
href="#burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister.cleanup"><code
class="docutils literal notranslate"><span
class="pre">AsyncPostgreSQLPersister.cleanup()</span></code></a></li>
-<li><a class="reference internal"
href="#burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister.copy"><code
class="docutils literal notranslate"><span
class="pre">AsyncPostgreSQLPersister.copy()</span></code></a></li>
-<li><a class="reference internal"
href="#burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister.create_pool"><code
class="docutils literal notranslate"><span
class="pre">AsyncPostgreSQLPersister.create_pool()</span></code></a></li>
<li><a class="reference internal"
href="#burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister.create_table"><code
class="docutils literal notranslate"><span
class="pre">AsyncPostgreSQLPersister.create_table()</span></code></a></li>
<li><a class="reference internal"
href="#burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister.from_config"><code
class="docutils literal notranslate"><span
class="pre">AsyncPostgreSQLPersister.from_config()</span></code></a></li>
<li><a class="reference internal"
href="#burr.integrations.persisters.b_asyncpg.AsyncPostgreSQLPersister.from_values"><code
class="docutils literal notranslate"><span
class="pre">AsyncPostgreSQLPersister.from_values()</span></code></a></li>
diff --git a/pull/595/reference/state/index.html
b/pull/595/reference/state/index.html
index 84ba1023..75d10044 100644
--- a/pull/595/reference/state/index.html
+++ b/pull/595/reference/state/index.html
@@ -477,16 +477,6 @@ must correspond to an integer, or an error will be
raised.</p>
</dl>
</dd></dl>
-<dl class="py method">
-<dt class="sig sig-object py" id="burr.core.state.State.keys">
-<span class="sig-name descname"><span class="pre">keys</span></span><span
class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink"
href="#burr.core.state.State.keys" title="Link to this definition">¶</a></dt>
-<dd><p>Returns a list of the state keys only (without values for cleaner
display).</p>
-<dl class="simple">
-<dt>Returns:</dt><dd><p>list: A list of state keys</p>
-</dd>
-</dl>
-</dd></dl>
-
<dl class="py method">
<dt class="sig sig-object py" id="burr.core.state.State.merge">
<span class="sig-name descname"><span class="pre">merge</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">other</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><a
class="reference internal" href="#burr.core.state.State"
title="burr.core.state.State"><span
class="pre">State</span></a></span></em><span class="sig-paren">)</span> <span
class="sig-return"><span class="sig-return-icon">&#x [...]
@@ -680,7 +670,6 @@ tracking / persistence.</p>
<li><a class="reference internal" href="#burr.core.state.State.extend"><code
class="docutils literal notranslate"><span
class="pre">State.extend()</span></code></a></li>
<li><a class="reference internal" href="#burr.core.state.State.get_all"><code
class="docutils literal notranslate"><span
class="pre">State.get_all()</span></code></a></li>
<li><a class="reference internal"
href="#burr.core.state.State.increment"><code class="docutils literal
notranslate"><span class="pre">State.increment()</span></code></a></li>
-<li><a class="reference internal" href="#burr.core.state.State.keys"><code
class="docutils literal notranslate"><span
class="pre">State.keys()</span></code></a></li>
<li><a class="reference internal" href="#burr.core.state.State.merge"><code
class="docutils literal notranslate"><span
class="pre">State.merge()</span></code></a></li>
<li><a class="reference internal"
href="#burr.core.state.State.serialize"><code class="docutils literal
notranslate"><span class="pre">State.serialize()</span></code></a></li>
<li><a class="reference internal" href="#burr.core.state.State.subset"><code
class="docutils literal notranslate"><span
class="pre">State.subset()</span></code></a></li>
diff --git a/pull/595/searchindex.js b/pull/595/searchindex.js
index 2ad09cad..8ae01745 100644
--- a/pull/595/searchindex.js
+++ b/pull/595/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles":{"1. Agent application is modeled as State +
Actions \u2013>
Graph":[[28,"agent-application-is-modeled-as-state-actions-graph"]],"1. Make
your methods async":[[6,"make-your-methods-async"]],"2. Build application
\u2013> built in checkpointing &
tracking":[[28,"build-application-built-in-checkpointing-tracking"]],"2.
Implement the is_async method":[[6,"implement-the-is-async-method"]],"3. Comes
with a UI":[[28,"comes-with-a-ui"]],"3. Use async persisters with [...]
\ No newline at end of file
+Search.setIndex({"alltitles":{"1. Agent application is modeled as State +
Actions \u2013>
Graph":[[28,"agent-application-is-modeled-as-state-actions-graph"]],"1. Make
your methods async":[[6,"make-your-methods-async"]],"2. Build application
\u2013> built in checkpointing &
tracking":[[28,"build-application-built-in-checkpointing-tracking"]],"2.
Implement the is_async method":[[6,"implement-the-is-async-method"]],"3. Comes
with a UI":[[28,"comes-with-a-ui"]],"3. Use async persisters with [...]
\ No newline at end of file
