Add rum doc
authorDevrim Gunduz <[email protected]>
Wed, 29 Jan 2025 13:51:34 +0000 (14:51 +0100)
committerDevrim Gunduz <[email protected]>
Wed, 29 Jan 2025 13:51:34 +0000 (14:51 +0100)
templates/pages/extensions.html
templates/pages/extensions/rum.html [new file with mode: 0644]

index f6411f7d93f7d432bc5d78adfc14dba52f082f61..32ca993779126b7baffe80d2988fecc5e8f0a638 100644 (file)
@@ -104,6 +104,7 @@ w{% extends "base.html" %}
        <a href="/extensions/postgresql-numeral/">postgresql-numeral</a><br>
        <a href="/extensions/postgresql-unit/">postgresql-unit</a><br>  
        
+       <a href="/extensions/rum/">rum</a><br>
        <a href="/extensions/semver/">semver</a><br>
        <a href="/extensions/sequential_uuids/">sequential_uuids</a><br>
        <a href="/extensions/set_user/">set_user</a><br>
diff --git a/templates/pages/extensions/rum.html b/templates/pages/extensions/rum.html
new file mode 100644 (file)
index 0000000..ca60f42
--- /dev/null
@@ -0,0 +1,103 @@
+{%extends "base.html" %}
+{%block title%}Extension howto docs{%endblock%}
+{%block maincontent%}
+
+<h1>rum</h1>
+
+<h2>Website</h2>
+<p>
+<a href="https://github.com/postgrespro/rum/" target="_blank">https://github.com/postgrespro/rum/</a>
+</p>
+
+<h2>Description</h2>
+<p>
+<a href="https://github.com/postgrespro/rum/" target="_blank">rum</a>
+provides access method to work with RUM index. It is based on the GIN access
+methods code.
+</p>
+
+<h2>Package naming convention</h2>
+<p>
+The PostgreSQL RPM repository uses PostgreSQL version numbers in the RPM packages.
+For example rum for PostgreSQL 17 is named as <span class="pgyum-warning">rum_17</span>.
+Similarly rum for PostgreSQL 15 is named as <span class="pgyum-warning">rum_15</span>.
+</p>
+
+<h2>Subpackages</h2>
+<p>
+rum provides the following subpackages:
+</p>
+       <ul>
+               <li>devel: rum development header files</li>
+               <li>llvmjit: Provides just-in-time compilation support for rum</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 rum_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> rum;</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,13</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,13</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,13</td>
+            <td>Fedora Linux</td>
+            <td>x86_64</td>
+            <td class="pgyum-available">Available</td>
+        </tr>
+
+    </tbody>
+</table>
+</p>
+
+
+{%endblock%}