Add pgspider_ext doc
authorDevrim Gunduz <devrim@gunduz.org>
Mon, 3 Mar 2025 14:16:59 +0000 (17:16 +0300)
committerDevrim Gunduz <devrim@gunduz.org>
Mon, 3 Mar 2025 14:16:59 +0000 (17:16 +0300)
templates/pages/extensions.html
templates/pages/extensions/pgspider_ext.html [new file with mode: 0644]

index 3908606554e3ebbe458879e47442095028b5c6f1..11682766390c7f89133a412529af8ef2e418ac9f 100644 (file)
@@ -332,6 +332,7 @@ PostgreSQL extensions on RPM based systems.
                <a href="/extensions/pg_background">pg_background</a> :<code> Allows you to execute arbitrary SQL commands in background worker processes within PostgreSQL</code> <br>
                <a href="/extensions/pg_ivm">pg_ivm</a> :<code> pg_ivm is a way to make materialized views up-to-date in which only incremental changes are computed and applied on views rather than recomputing the contents from scratch as REFRESH MATERIALIZED VIEW does</code> <br>
                <a href="/extensions/pg_strom">pg_strom</a> :<code> PG-Strom is designed to accelerate mostly batch and analytics workloads with utilization of GPU and NVME-SSD, and Apache Arrow columnar</code><br>
+               <a href="/extensions/pgspider_ext">pgspider_ext</a> :<code> PostgreSQL extension to construct High-Performance SQL Cluster Engine for distributed big data</code><br>
                <a href="/extensions/pgvector">pgvector</a> :<code> Open-source vector similarity search for Postgres</code> <br>
                <a href="/extensions/plproxy">plproxy</a> :<code> Database partitioning system implemented as PL language</code> <br>
                <a href="/extensions/temporal_tables">temporal_tables</a> :<code> Table that records the period of time when a row is valid</code> <br>
diff --git a/templates/pages/extensions/pgspider_ext.html b/templates/pages/extensions/pgspider_ext.html
new file mode 100644 (file)
index 0000000..02a1933
--- /dev/null
@@ -0,0 +1,106 @@
+{%extends "base.html" %}
+{%block title%}Extension howto docs{%endblock%}
+{%block maincontent%}
+
+<h1>pgspider_ext</h1>
+
+<h2>Website</h2>
+<p>
+<a href="https://github.com/pgspider/pgspider_ext/" target="_blank">https://github.com/pgspider/pgspider_ext/</a>
+</p>
+
+<h2>Description</h2>
+<p>
+<a href="https://github.com/pgspider/pgspider_ext/" target="_blank">pgspider_ext</a>
+is an extension to construct High-Performance SQL Cluster Engine for
+distributed big data. pgspider_ext enables PostgreSQL to access a number of
+data sources using Foreign Data Wrapper(FDW) and retrieves the distributed
+data source vertically.
+</p>
+
+<h2>Package naming convention</h2>
+<p>
+The PostgreSQL RPM repository uses PostgreSQL version numbers in the RPM packages.
+For example pgspider_ext for PostgreSQL 17 is named as <span class="pgyum-warning">pgspider_ext_17</span>.
+Similarly pgspider_ext for PostgreSQL 15 is named as <span class="pgyum-warning">pgspider_ext_15</span>.
+</p>
+
+<h2>Subpackages</h2>
+<p>
+pgspider_ext provides the following subpackages:
+</p>
+       <ul>
+               <li>llvmjit: Provides just-in-time compilation support for pgspider_ext</li>
+       </ul>
+</p>
+
+<h2>Package specifications and repository requirements</h2>
+<h3>PostgreSQL PGDG RPM repository</h3>
+<p>Install PGDG repository from: <a href="https://yum.postgresql.org/repopackages/" target="_blank">https://yum.postgresql.org/repopackages/</a></p>
+
+<h2>Installation</h2>
+<p>
+<table class="table">
+    <thead>
+       <tr class="thead-light">
+            <th width="30%">OS</th>
+            <th width="70%">Command</th>
+        </tr>
+    </thead>
+
+    <tbody>
+       <tr>
+            <td>RHEL / Rocky Linux / AlmaLinux / Fedora</td>
+            <td>dnf install pgspider_ext_17 <span class="pgyum-warning">(or change the version as described above)</span></td>
+        </tr>
+    </tbody>
+</table>
+</p>
+
+<h2>Post-installation</h2>
+<p>Connect to the database that you want to create the extension as superuser and run:<br>
+<code><a href="https://www.postgresql.org/docs/current/sql-createextension.html" target="_blank">CREATE EXTENSION</a> pgspider_ext;</code>
+<br>
+<code><a href="https://www.postgresql.org/docs/current/sql-createextension.html" target="_blank">CREATE EXTENSION</a> postgres_fdw;</code>
+</p>
+
+<h2>Available packages</h2>
+<p>
+<table class="table">
+    <thead>
+       <tr class="thead-light">
+            <th width="10%">PostgreSQL version(s)</th>
+            <th width="40%">OS version</th>
+            <th width="10%">Arch</th>
+            <th width="30%">Status</th>
+        </tr>
+    </thead>
+
+    <tbody>
+       <tr>
+            <td>17,16,15,14</td>
+            <td>RHEL / Rocky Linux / AlmaLinux 9</td>
+            <td>x86_64, aarch64</td>
+            <td class="pgyum-available">Available</td>
+        </tr>
+
+       <tr>
+            <td>17,16,15,14</td>
+            <td>RHEL / Rocky Linux / AlmaLinux 8</td>
+            <td>x86_64, aarch64</td>
+            <td class="pgyum-available">Available</td>
+        </tr>
+
+       <tr>
+            <td>17,16,15,14</td>
+            <td>Fedora Linux</td>
+            <td>x86_64</td>
+            <td class="pgyum-available">Available</td>
+        </tr>
+
+    </tbody>
+</table>
+</p>
+
+
+{%endblock%}