Docs build 2024-11-16

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

@@ -10,7 +10,7 @@ See also: :doc:`../operations/postgres`.
 
 .. code:: python
 
-    host.get_fact(PostgresDatabases, psql_user=None, psql_password=None, psql_host=None, psql_port=None)
+    host.get_fact(PostgresDatabases, psql_user=None, psql_password=None, psql_host=None, psql_port=None, psql_database=None)
 
 Returns a dict of PostgreSQL databases and metadata:
 
@@ -33,7 +33,7 @@ Returns a dict of PostgreSQL databases and metadata:
 
 .. code:: python
 
-    host.get_fact(PostgresRoles, psql_user=None, psql_password=None, psql_host=None, psql_port=None)
+    host.get_fact(PostgresRoles, psql_user=None, psql_password=None, psql_host=None, psql_port=None, psql_database=None)
 
 Returns a dict of PostgreSQL roles and data:
 

en/latest/_sources/facts/postgresql.rst.txt

@@ -10,7 +10,7 @@ See also: :doc:`../operations/postgresql`.
 
 .. code:: python
 
-    host.get_fact(PostgresqlDatabases, psql_user=None, psql_password=None, psql_host=None, psql_port=None)
+    host.get_fact(PostgresqlDatabases, psql_user=None, psql_password=None, psql_host=None, psql_port=None, psql_database=None)
 
 
 .. _facts:postgresql.PostgresqlRoles:
@@ -20,5 +20,5 @@ See also: :doc:`../operations/postgresql`.
 
 .. code:: python
 
-    host.get_fact(PostgresqlRoles, psql_user=None, psql_password=None, psql_host=None, psql_port=None)
+    host.get_fact(PostgresqlRoles, psql_user=None, psql_password=None, psql_host=None, psql_port=None, psql_database=None)
 

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

@@ -11,6 +11,7 @@ All operations in this module take four optional arguments:
     + ``psql_password``: the password for the connecting user
     + ``psql_host``: the hostname of the server to connect to
     + ``psql_port``: the port of the server to connect to
+    + ``psql_database``: the database on the server to connect to
 
 See example/postgresql.py for detailed example
 
@@ -32,7 +33,7 @@ Add/remove PostgreSQL databases.
         encoding: str | None=None, lc_collate: str | None=None, lc_ctype: str | None=None,
         tablespace: str | None=None, 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_port: int | None=None, psql_database: str | None=None,
     )
 
 + **name**: name of the database
@@ -80,12 +81,11 @@ Dump a PostgreSQL database into a ``.sql`` file. Requires ``pg_dump``.
 .. code:: python
 
     postgres.dump(
-        dest: str, database: str | None=None, psql_user: str | None=None,
-        psql_password: str | None=None, psql_host: str | None=None, psql_port: int | None=None,
+        dest: str, 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,
     )
 
 + **dest**: name of the file to dump the SQL to
-+ **database**: name of the database to dump
 + **psql_***: global module arguments, see above
 
 **Example:**
@@ -95,7 +95,6 @@ Dump a PostgreSQL database into a ``.sql`` file. Requires ``pg_dump``.
     postgresql.dump(
         name="Dump the pyinfra_stuff database",
         dest="/tmp/pyinfra_stuff.dump",
-        database="pyinfra_stuff",
         sudo_user="postgres",
     )
 
@@ -116,12 +115,11 @@ Load ``.sql`` file into a database.
 .. code:: python
 
     postgres.load(
-        src: str, database: str | None=None, psql_user: str | None=None,
-        psql_password: str | None=None, psql_host: str | None=None, psql_port: int | None=None,
+        src: str, 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,
     )
 
 + **src**: the filename to read from
-+ **database**: name of the database to import into
 + **psql_***: global module arguments, see above
 
 **Example:**
@@ -131,7 +129,6 @@ Load ``.sql`` file into a database.
     postgresql.load(
         name="Import the pyinfra_stuff dump into pyinfra_stuff_copy",
         src="/tmp/pyinfra_stuff.dump",
-        database="pyinfra_stuff_copy",
         sudo_user="postgres",
     )
 
@@ -150,6 +147,7 @@ Add/remove PostgreSQL roles.
         inherit=False, createdb=False, createrole=False, replication=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,
     )
 
 + **role**: name of the role
@@ -199,11 +197,10 @@ Execute arbitrary SQL against PostgreSQL.
 .. code:: python
 
     postgres.sql(
-        sql: str, database: str | None=None, psql_user: str | None=None,
-        psql_password: str | None=None, psql_host: str | None=None, psql_port: int | None=None,
+        sql: str, 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,
     )
 
 + **sql**: SQL command(s) to execute
-+ **database**: optional database to execute against
 + **psql_***: global module arguments, see above
 

en/latest/facts/postgres.html

@@ -187,7 +187,7 @@ <h1>Postgres Facts<a class="headerlink" href="#postgres-facts" title="Permalink
 <p>See also: <a class="reference internal" href="../operations/postgres.html"><span class="doc">Postgres Operations</span></a>.</p>
 <div class="section" id="postgres-postgresdatabases">
 <span id="facts-postgres-postgresdatabases"></span><h2><code class="code docutils literal notranslate"><span class="pre">postgres.PostgresDatabases</span></code><a class="headerlink" href="#postgres-postgresdatabases" title="Permalink to this heading">¶</a></h2>
-<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">host</span><span class="o">.</span><span class="n">get_fact</span><span class="p">(</span><span class="n">PostgresDatabases</span><span class="p">,</span> <span class="n">psql_user</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_password</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_host</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_port</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">host</span><span class="o">.</span><span class="n">get_fact</span><span class="p">(</span><span class="n">PostgresDatabases</span><span class="p">,</span> <span class="n">psql_user</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_password</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_host</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_port</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_database</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
 </pre></div>
 </div>
 <p>Returns a dict of PostgreSQL databases and metadata:</p>
@@ -204,7 +204,7 @@ <h1>Postgres Facts<a class="headerlink" href="#postgres-facts" title="Permalink
 </div>
 <div class="section" id="postgres-postgresroles">
 <span id="facts-postgres-postgresroles"></span><h2><code class="code docutils literal notranslate"><span class="pre">postgres.PostgresRoles</span></code><a class="headerlink" href="#postgres-postgresroles" title="Permalink to this heading">¶</a></h2>
-<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">host</span><span class="o">.</span><span class="n">get_fact</span><span class="p">(</span><span class="n">PostgresRoles</span><span class="p">,</span> <span class="n">psql_user</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_password</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_host</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_port</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">host</span><span class="o">.</span><span class="n">get_fact</span><span class="p">(</span><span class="n">PostgresRoles</span><span class="p">,</span> <span class="n">psql_user</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_password</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_host</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_port</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_database</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
 </pre></div>
 </div>
 <p>Returns a dict of PostgreSQL roles and data:</p>

en/latest/facts/postgresql.html

@@ -187,13 +187,13 @@ <h1>Postgresql Facts<a class="headerlink" href="#postgresql-facts" title="Permal
 <p>See also: <a class="reference internal" href="../operations/postgresql.html"><span class="doc">Postgresql Operations</span></a>.</p>
 <div class="section" id="postgresql-postgresqldatabases">
 <span id="facts-postgresql-postgresqldatabases"></span><h2><code class="code docutils literal notranslate"><span class="pre">postgresql.PostgresqlDatabases</span></code><a class="headerlink" href="#postgresql-postgresqldatabases" title="Permalink to this heading">¶</a></h2>
-<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">host</span><span class="o">.</span><span class="n">get_fact</span><span class="p">(</span><span class="n">PostgresqlDatabases</span><span class="p">,</span> <span class="n">psql_user</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_password</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_host</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_port</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">host</span><span class="o">.</span><span class="n">get_fact</span><span class="p">(</span><span class="n">PostgresqlDatabases</span><span class="p">,</span> <span class="n">psql_user</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_password</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_host</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_port</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_database</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
 </pre></div>
 </div>
 </div>
 <div class="section" id="postgresql-postgresqlroles">
 <span id="facts-postgresql-postgresqlroles"></span><h2><code class="code docutils literal notranslate"><span class="pre">postgresql.PostgresqlRoles</span></code><a class="headerlink" href="#postgresql-postgresqlroles" title="Permalink to this heading">¶</a></h2>
-<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">host</span><span class="o">.</span><span class="n">get_fact</span><span class="p">(</span><span class="n">PostgresqlRoles</span><span class="p">,</span> <span class="n">psql_user</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_password</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_host</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_port</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">host</span><span class="o">.</span><span class="n">get_fact</span><span class="p">(</span><span class="n">PostgresqlRoles</span><span class="p">,</span> <span class="n">psql_user</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_password</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_host</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_port</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">psql_database</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
 </pre></div>
 </div>
 </div>