Deployed 5f9c62b with MkDocs version: 1.6.0

assets/demo_schema.graphql

@@ -424,7 +424,7 @@ An opaque string using for tracking a position in results during pagination
 """
 scalar Cursor
 
-"""A date wihout time information"""
+"""A date without time information"""
 scalar Date
 
 """

changelog/index.html

@@ -641,6 +641,13 @@
     1.5.7
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#158" class="md-nav__link">
+    1.5.8
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -827,6 +834,13 @@
     1.5.7
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#158" class="md-nav__link">
+    1.5.8
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -969,6 +983,10 @@ <h2 id="157">1.5.7</h2>
 <li>bugfix: UDF argument with a complex default expression was marked as required</li>
 <li>bugfix: not null foreign keys referencing tables with RLS are marked as nullable</li>
 </ul>
+<h2 id="158">1.5.8</h2>
+<ul>
+<li>bugfix: relational query with more than 100 fields fails</li>
+</ul>
 <h2 id="master">master</h2>
 
 

contributing/index.html

@@ -494,6 +494,13 @@
     Testing
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#debugging" class="md-nav__link">
+    Debugging
+  </a>
+
 </li>
 
           <li class="md-nav__item">
@@ -595,6 +602,13 @@
     Testing
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#debugging" class="md-nav__link">
+    Debugging
+  </a>
+
 </li>
 
           <li class="md-nav__item">
@@ -660,20 +674,32 @@ <h1>Contributing</h1>
 
 <p>pg_graphql is OSS. PR and issues are welcome.</p>
 <h2 id="development">Development</h2>
-<p>Requirements:</p>
-<ul>
-<li>rust</li>
-<li>cargo</li>
-<li><a href="https://github.com/tcdi/pgrx">pgrx</a></li>
-</ul>
+<p>To start developing <code>pg_graphql</code>:</p>
+<ol>
+<li><a href="https://www.rust-lang.org/tools/install">Install Rust</a>.</li>
+<li><a href="https://github.com/pgcentralfoundation/pgrx">Install pgrx</a></li>
+</ol>
 <h3 id="testing">Testing</h3>
-<p>Tests are located in <code>./test/sql</code> with expected output in <code>./test/expected</code></p>
-<p>To run tests locally, execute:</p>
+<p>Tests are located in sql files in the <code>./test/sql</code> folder. Each sql file has a corresponding expected output file in <code>./test/expected</code> folder. For example, <code>./test/sql/aliases.sql</code>'s expected output is in <code>./tests/expected/aliases.out</code>. When a test runs, its actual output is saved in the <code>./results</code> folder. If the file in <code>./results</code> folder matches the corresponding file in the <code>./test/expected</code> folder, the test passes, otherwise it fails.</p>
+<p>To run tests locally, first execute:</p>
+<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>cargo<span class="w"> </span>pgrx<span class="w"> </span>install
+</code></pre></div></td></tr></table></div>
+<p>to build <code>pg_graphql</code> from source and install it in the Postgres instance specified by <code>pg_config</code>. This step must be run when you have made any changes in the Rust code. It can be skipped if there are no Rust code changes since the last time the command was run. The skipping is expecially useful when you are only modifying the test sql files.</p>
+<p>Next, run all the tests by executing:</p>
+<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>./bin/installcheck
+</code></pre></div></td></tr></table></div>
+<p>You can combine the last two steps to build and install <code>pg_graphql</code> and run all the tests:</p>
 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>$<span class="w"> </span>cargo<span class="w"> </span>pgrx<span class="w"> </span>install<span class="p">;</span><span class="w"> </span>./bin/installcheck
 </code></pre></div></td></tr></table></div>
+<p>You can run a single test by passing its name to the <code>installcheck</code> command. For example, the following runs the test in <code>./test/sql/aliases.sql</code>.</p>
+<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>./bin/installcheck<span class="w"> </span>aliases
+</code></pre></div></td></tr></table></div>
+<p>When writing a new test, or editing an existing one, the file in <code>./result</code> should be inspected manually and then copied over to the <code>./test/expected</code> folder to make the test pass.</p>
+<h3 id="debugging">Debugging</h3>
+<p>You can print to the output by using the <code>pgrx_pg_sys::submodules::elog::info!</code> macro in the Rust code. Lines printed with this macro will show in the .out file in the <code>./results</code> folder.</p>
 <h3 id="interactive-psql-development">Interactive PSQL Development</h3>
 <p>To reduce the iteration cycle, you may want to launch a psql prompt with <code>pg_graphql</code> installed to experiment</p>
-<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>cargo<span class="w"> </span>pgrx<span class="w"> </span>run<span class="w"> </span>pg14
+<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>cargo<span class="w"> </span>pgrx<span class="w"> </span>run<span class="w"> </span>pg16
 </code></pre></div></td></tr></table></div>
 <p>Try out the commands below to spin up a database with the extension installed &amp; query a table using GraphQL. Experiment with aliasing field/table names and filtering on different columns.</p>
 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>

example_schema/index.html

@@ -1855,7 +1855,7 @@ <h1>Example Schema</h1>
 <span class="c c-Multi">&quot;&quot;&quot;</span>
 <span class="k">scalar</span> <span class="k">Cursor</span>
 
-<span class="c c-Multi">&quot;&quot;&quot;A date wihout time information&quot;&quot;&quot;</span>
+<span class="c c-Multi">&quot;&quot;&quot;A date without time information&quot;&quot;&quot;</span>
 <span class="k">scalar</span> <span class="k">Date</span>
 
 <span class="c c-Multi">&quot;&quot;&quot;</span>

installation/index.html

@@ -524,14 +524,14 @@ <h1>Installation</h1>
 cargo<span class="w"> </span>pgrx<span class="w"> </span>install<span class="w"> </span>--release
 </code></pre></div></td></tr></table></div>
 <p>Before enabling the extension you need to initialize <code>pgrx</code>. The easiest way to get started is to allow <code>pgrx</code> to manage its own version/s of Postgres:</p>
-<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>cargo<span class="w"> </span>pgrx<span class="w"> </span>init<span class="w"> </span>--pg16<span class="o">=</span>download
+<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>cargo<span class="w"> </span>pgrx<span class="w"> </span>init<span class="w"> </span>--pg17<span class="o">=</span>download
 </code></pre></div></td></tr></table></div>
 <p>For more advanced configuration options, like building against an existing Postgres installation from e.g. Homebrew, see the <a href="https://github.com/pgcentralfoundation/pgrx">pgrx docs</a></p>
 <p>To start the database:</p>
-<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>cargo<span class="w"> </span>pgrx<span class="w"> </span>start<span class="w"> </span>pg16
+<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>cargo<span class="w"> </span>pgrx<span class="w"> </span>start<span class="w"> </span>pg17
 </code></pre></div></td></tr></table></div>
 <p>To connect:</p>
-<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>cargo<span class="w"> </span>pgrx<span class="w"> </span>connect<span class="w"> </span>pg16
+<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>cargo<span class="w"> </span>pgrx<span class="w"> </span>connect<span class="w"> </span>pg17
 </code></pre></div></td></tr></table></div>
 <p>Finally, to enable the <code>pg_graphql</code> extension in Postgres, execute the <code>create extension</code> statement. This extension creates its own schema/namespace named <code>graphql</code> to avoid naming conflicts.</p>
 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">create</span><span class="w"> </span><span class="k">extension</span><span class="w"> </span><span class="n">pg_graphql</span><span class="p">;</span>

sitemap.xml

@@ -2,82 +2,82 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://supabase.github.io/pg_graphql/</loc>
-         <lastmod>2024-07-10</lastmod>
+         <lastmod>2024-10-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/api/</loc>
-         <lastmod>2024-07-10</lastmod>
+         <lastmod>2024-10-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/changelog/</loc>
-         <lastmod>2024-07-10</lastmod>
+         <lastmod>2024-10-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/computed_fields/</loc>
-         <lastmod>2024-07-10</lastmod>
+         <lastmod>2024-10-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/configuration/</loc>
-         <lastmod>2024-07-10</lastmod>
+         <lastmod>2024-10-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/contributing/</loc>
-         <lastmod>2024-07-10</lastmod>
+         <lastmod>2024-10-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/example_schema/</loc>
-         <lastmod>2024-07-10</lastmod>
+         <lastmod>2024-10-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/functions/</loc>
-         <lastmod>2024-07-10</lastmod>
+         <lastmod>2024-10-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/installation/</loc>
-         <lastmod>2024-07-10</lastmod>
+         <lastmod>2024-10-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/quickstart/</loc>
-         <lastmod>2024-07-10</lastmod>
+         <lastmod>2024-10-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/security/</loc>
-         <lastmod>2024-07-10</lastmod>
+         <lastmod>2024-10-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/sql_interface/</loc>
-         <lastmod>2024-07-10</lastmod>
+         <lastmod>2024-10-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/supabase/</loc>
-         <lastmod>2024-07-10</lastmod>
+         <lastmod>2024-10-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/usage_with_apollo/</loc>
-         <lastmod>2024-07-10</lastmod>
+         <lastmod>2024-10-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/usage_with_relay/</loc>
-         <lastmod>2024-07-10</lastmod>
+         <lastmod>2024-10-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/views/</loc>
-         <lastmod>2024-07-10</lastmod>
+         <lastmod>2024-10-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
 </urlset>

usage_with_relay/index.html

@@ -670,7 +670,7 @@ <h3 id="configuring-the-relay-compiler">Configuring the Relay Compiler</h3>
 <span class="w">    </span><span class="nx">nodeInterfaceIdField</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;nodeId&#39;</span><span class="p">,</span>
 <span class="w">    </span><span class="nx">nodeInterfaceIdVariableName</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;nodeId&#39;</span><span class="p">,</span>
 <span class="w">  </span><span class="p">},</span>
-<span class="w">  </span><span class="nx">customScalars</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
+<span class="w">  </span><span class="nx">customScalarTypes</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
 <span class="w">    </span><span class="nx">UUID</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;string&#39;</span><span class="p">,</span>
 <span class="w">    </span><span class="nx">Datetime</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;string&#39;</span><span class="p">,</span>
 <span class="w">    </span><span class="nb">JSON</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;string&#39;</span><span class="p">,</span>
@@ -682,8 +682,12 @@ <h3 id="configuring-the-relay-compiler">Configuring the Relay Compiler</h3>
 </code></pre></div></td></tr></table></div>
 <ul>
 <li><code>schemaConfig</code> tells the Relay compiler where to find the <code>nodeId</code> field on the <code>node</code> interface</li>
-<li><code>customScalars</code> will improve Relay's type emission</li>
+<li><code>customScalarTypes</code> will improve Relay's type emission</li>
 </ul>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>For Relay versions older than v16.2.0, it should be named <code>customScalars</code> instead.</p>
+</div>
 <h3 id="configuring-your-relay-environment">Configuring your Relay Environment</h3>
 <p>This example uses <a href="https://supabase.com">Supabase</a> for the GraphQL server, but pg_graphql can be used independently.</p>
 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>