Docs build 2025-04-16

Author: github-actions

en/latest/_sources/operations/postgres.rst.txt

@@ -150,9 +150,9 @@ Add/remove PostgreSQL roles.
 .. code:: python
 
     postgres.role(
-        role: str, present=True, password: str | None=None, login=True, superuser=False,
-        inherit=False, createdb=False, createrole=False, replication=False,
-        connection_limit: int | None=None, psql_user: str | None=None,
+        role: str, present: bool=True, password: str | None=None, login: bool=True,
+        superuser: bool=False, inherit: bool=False, createdb: bool=False, createrole: bool=False,
+        replication: bool=False, connection_limit: int | None=None, psql_user: str | None=None,
         psql_password: str | None=None, psql_host: str | None=None, psql_port: int | None=None,
         psql_database: str | None=None, **kwargs,
     )
@@ -184,7 +184,7 @@ Updates:
         password="somepassword",
         superuser=True,
         login=True,
-        sudo_user="postgres",
+        _sudo_user="postgres",
     )
 Note:
 	This operation also inherits all :doc:`global arguments </arguments>`.

en/latest/operations/postgres.html

@@ -311,9 +311,9 @@ <h1>Postgres Operations<a class="headerlink" href="#postgres-operations" title="
 <span id="operations-postgres-role"></span><h2><code class="code docutils literal notranslate"><span class="pre">postgres.role</span></code><a class="headerlink" href="#postgres-role" title="Link to this heading">¶</a></h2>
 <p>Add/remove PostgreSQL roles.</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">postgres</span><span class="o">.</span><span class="n">role</span><span class="p">(</span>
-    <span class="n">role</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">present</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">password</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">login</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">superuser</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
-    <span class="n">inherit</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">createdb</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">createrole</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">replication</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
-    <span class="n">connection_limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_user</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+    <span class="n">role</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">present</span><span class="p">:</span> <span class="nb">bool</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">password</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">login</span><span class="p">:</span> <span class="nb">bool</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
+    <span class="n">superuser</span><span class="p">:</span> <span class="nb">bool</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">inherit</span><span class="p">:</span> <span class="nb">bool</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">createdb</span><span class="p">:</span> <span class="nb">bool</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">createrole</span><span class="p">:</span> <span class="nb">bool</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
+    <span class="n">replication</span><span class="p">:</span> <span class="nb">bool</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">connection_limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_user</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
     <span class="n">psql_password</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_host</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_port</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
     <span class="n">psql_database</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
 <span class="p">)</span>
@@ -345,7 +345,7 @@ <h1>Postgres Operations<a class="headerlink" href="#postgres-operations" title="
     <span class="n">password</span><span class="o">=</span><span class="s2">&quot;somepassword&quot;</span><span class="p">,</span>
     <span class="n">superuser</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
     <span class="n">login</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
-    <span class="n">sudo_user</span><span class="o">=</span><span class="s2">&quot;postgres&quot;</span><span class="p">,</span>
+    <span class="n">_sudo_user</span><span class="o">=</span><span class="s2">&quot;postgres&quot;</span><span class="p">,</span>
 <span class="p">)</span>
 </pre></div>
 </div>

en/latest/searchindex.js

@@ -150,9 +150,9 @@ Add/remove PostgreSQL roles.
 .. code:: python
 
     postgres.role(
-        role: str, present=True, password: str | None=None, login=True, superuser=False,
-        inherit=False, createdb=False, createrole=False, replication=False,
-        connection_limit: int | None=None, psql_user: str | None=None,
+        role: str, present: bool=True, password: str | None=None, login: bool=True,
+        superuser: bool=False, inherit: bool=False, createdb: bool=False, createrole: bool=False,
+        replication: bool=False, connection_limit: int | None=None, psql_user: str | None=None,
         psql_password: str | None=None, psql_host: str | None=None, psql_port: int | None=None,
         psql_database: str | None=None, **kwargs,
     )
@@ -184,7 +184,7 @@ Updates:
         password="somepassword",
         superuser=True,
         login=True,
-        sudo_user="postgres",
+        _sudo_user="postgres",
     )
 Note:
 	This operation also inherits all :doc:`global arguments </arguments>`.

en/next/_sources/operations/postgres.rst.txt

@@ -311,9 +311,9 @@ <h1>Postgres Operations<a class="headerlink" href="#postgres-operations" title="
 <span id="operations-postgres-role"></span><h2><code class="code docutils literal notranslate"><span class="pre">postgres.role</span></code><a class="headerlink" href="#postgres-role" title="Link to this heading">¶</a></h2>
 <p>Add/remove PostgreSQL roles.</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">postgres</span><span class="o">.</span><span class="n">role</span><span class="p">(</span>
-    <span class="n">role</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">present</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">password</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">login</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">superuser</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
-    <span class="n">inherit</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">createdb</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">createrole</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">replication</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
-    <span class="n">connection_limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_user</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+    <span class="n">role</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">present</span><span class="p">:</span> <span class="nb">bool</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">password</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">login</span><span class="p">:</span> <span class="nb">bool</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
+    <span class="n">superuser</span><span class="p">:</span> <span class="nb">bool</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">inherit</span><span class="p">:</span> <span class="nb">bool</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">createdb</span><span class="p">:</span> <span class="nb">bool</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">createrole</span><span class="p">:</span> <span class="nb">bool</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
+    <span class="n">replication</span><span class="p">:</span> <span class="nb">bool</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">connection_limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_user</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
     <span class="n">psql_password</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_host</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_port</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
     <span class="n">psql_database</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
 <span class="p">)</span>
@@ -345,7 +345,7 @@ <h1>Postgres Operations<a class="headerlink" href="#postgres-operations" title="
     <span class="n">password</span><span class="o">=</span><span class="s2">&quot;somepassword&quot;</span><span class="p">,</span>
     <span class="n">superuser</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
     <span class="n">login</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
-    <span class="n">sudo_user</span><span class="o">=</span><span class="s2">&quot;postgres&quot;</span><span class="p">,</span>
+    <span class="n">_sudo_user</span><span class="o">=</span><span class="s2">&quot;postgres&quot;</span><span class="p">,</span>
 <span class="p">)</span>
 </pre></div>
 </div>