bump version to 12.2.10

Otherwise performance was reduced unnecessarily.

.cirrus.yml

@@ -0,0 +1,42 @@
+freebsd_instance:
+  image_family: freebsd-14-2
+
+build_task:
+  # Don't change this name without adjusting .github/workflows/build.yaml
+  name: Build FreeBSD (Stack)
+  install_script: pkg install -y postgresql16-client hs-stack git
+
+  only_if: |
+    $CIRRUS_TAG != '' || $CIRRUS_BRANCH == 'main' || $CIRRUS_BRANCH =~ 'v*' ||
+    changesInclude(
+      '.github/workflows/build.yaml',
+      '.github/actions/artifact-from-cirrus/**',
+      '.cirrus.yml',
+      'postgrest.cabal',
+      'stack.yaml*',
+      '**.hs'
+    )
+
+  stack_cache:
+    folders: /.stack
+    fingerprint_script:
+      - echo $CIRRUS_OS
+      - stack --version
+      - md5sum postgrest.cabal
+      - md5sum stack.yaml.lock
+
+  stack_work_cache:
+    folders: .stack-work
+    fingerprint_script:
+      - echo $CIRRUS_OS
+      - stack --version
+      - md5sum postgrest.cabal
+      - md5sum stack.yaml.lock
+      - find main src -type f -iname '*.hs' -exec md5sum "{}" +
+
+  build_script: |
+    stack build -j 1 --local-bin-path . --copy-bins --stack-yaml stack-21.7.yaml
+    strip postgrest
+
+  bin_artifacts:
+    path: postgrest

.editorconfig

@@ -1,9 +0,0 @@
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-indent_size = 2
-indent_style = space
-insert_final_newline = true
-trim_trailing_whitespace = true

.github/CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing to PostgREST
+
+**First:** if you're unsure or afraid of _anything_, just ask or
+submit the issue or pull request anyways. You won't be yelled at
+for giving your best effort. The worst that can happen is that
+you'll be politely asked to change something. We appreciate any
+sort of contributions, and don't want a wall of rules to get in the
+way of that.
+
+However, for those individuals who want a bit more guidance on the
+best way to contribute to the project, read on. This document will
+cover what we're looking for. By addressing all the points we're
+looking for, it raises the chances we can quickly merge or address
+your contributions.
+
+## Issues
+
+For questions on how to use PostgREST, please use
+[GitHub discussions](https://github.com/PostgREST/postgrest/discussions).
+
+### Reporting an Issue
+
+* Make sure you test against the latest [stable release](https://github.com/PostgREST/postgrest/releases/latest)
+  and also against the latest [nightly release](https://github.com/PostgREST/postgrest/releases/tag/nightly).
+  It is possible we already fixed the bug you're experiencing.
+
+* Provide steps to reproduce the issue, including your OS version and
+  the specific database schema that you are using.
+
+* Please include SQL logs for issues involving runtime problems. To obtain logs first
+  [enable logging all statements](http://www.microhowto.info/howto/log_all_queries_to_a_postgresql_server.html),
+  then [find your logs](http://blog.endpoint.com/2014/11/dear-postgresql-where-are-my-logs.html).
+
+* If your database schema has changed while the PostgREST server is running,
+  [send the server a `SIGUSR1` signal](http://postgrest.org/en/latest/admin.html#schema-reloading) or restart it to ensure the schema cache
+  is not stale. This sometimes fixes apparent bugs.
+
+## Code
+
+We have a fully nix-based development environment with many tools for a smooth development workflow available.
+Check the [development docs](https://github.com/PostgREST/postgrest/blob/main/nix/README.md) on how to set it up and use it.
+
+### Haskell Conventions
+
+* All contributions must pass the tests before being merged. When
+  you create a pull request your code will automatically be tested.
+
+* All code must also pass [hlint](http://community.haskell.org/~ndm/hlint/) and [stylish-haskell](https://github.com/jaspervdj/stylish-haskell)
+  with no warnings. This helps enforce a uniform style for all committers. Continuous integration will check this as well on every
+  pull request. There are useful tools in the nix-shell that help with checking this locally. You can run `postgrest-check` to do this manually but
+  we recommend adding it to `.git/hooks/pre-commit` as `nix-shell --run postgrest-check` to automatically check this before doing a commit.
+
+### Running Tests
+
+For instructions on running tests, see the [development docs](https://github.com/PostgREST/postgrest/blob/main/nix/README.md#testing).

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,17 @@
+<!--
+Before reporting a bug:
+If your database schema has changed while the PostgREST server is running,
+send the server a SIGUSR1 signal or restart it(http://postgrest.org/en/stable/admin.html#schema-reloading)
+to ensure the schema cache is not stale. This sometimes fixes apparent bugs.
+-->
+### Environment
+
+* PostgreSQL version: (if using docker, specify the image)
+* PostgREST version: (if using docker, specify the image)
+* Operating system:
+
+### Description of issue
+
+(Expected behavior vs actual behavior)
+
+(Steps to reproduce: Include a minimal SQL definition plus how you make the request to PostgREST and the response body)

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,28 +0,0 @@
----
-name: Bug report
-about: Create a bug report to help us improve
-type: Bug
-title: ''
-labels: ''
-assignees: ''
-
----
-
-<!--
-Before reporting a bug:
-If your database schema has changed while the PostgREST server is running,
-send the server a SIGUSR1 signal or restart it (http://postgrest.org/en/stable/admin.html#schema-reloading) to ensure the schema cache is not stale. This sometimes fixes apparent bugs.
--->
-### Environment
-
-* PostgreSQL version: (if using docker, specify the image)
-* PostgREST version: (if using docker, specify the image)
-* Operating system:
-
-### Description of issue
-
-Describe the behavior you expected vs the actual behavior. Include:
-
-- A minimal SQL definition.
-- How you make the request to PostgREST (curl command preferred).
-- The PostgREST response.

.github/ISSUE_TEMPLATE/config.yml

@@ -1 +0,0 @@
-blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,17 +0,0 @@
----
-name: Feature request
-about: Suggest an enhancement for this project
-type: Feature
-title: ''
-labels: ''
-assignees: ''
-
----
-
-## Problem
-
-A clear and concise description of what the problem is.
-
-## Solution
-
-A clear and concise description of what you want to happen.

.github/PULL_REQUEST_TEMPLATE.md

@@ -4,18 +4,17 @@ When submitting a new feature or fix:
 - Add a new entry to the CHANGELOG - https://github.com/PostgREST/postgrest/blob/main/CHANGELOG.md#unreleased
 - If relevant, update the docs
 - Use a prefix for the PR title or commits, e.g. "fix: description of the fix".
-  + `add`, Add a new feature
-  + `amend`, To amend an unrealease commit
-  + `change`, Breaking changes
-  + `chore`, Maintenance, update sponsors, changelog, readme etc
-  + `ci`, CI configuration files and scripts
-  + `docs`, Documentation
-  + `fix`, Bug fix
-  + `nix`, Related to Nix
-  + `perf`, Performance improvements
-  + `refactor`, Refactoring code
-  + `remove`, Remove a feature or fix
-  + `test`, Adding tests
+  + `fix`, bug fixes
+  + `feat`, new features added
+  + `perf`, performance improvements
+  + `docs`, updating the documentation
+  + `nix`, related to the Nix development environment
+  + `ci`, related to the Continuous Integration modules
+  + `test`, related to the testing modules
+  + `refactor`, refactoring code
+  + `deprecate`, deprecating a feature
+  + `changelog`, updating the CHANGELOG
+  + `chore`, maintenance (build process, updating sponsors, etc.)
   + Other prefixes may be used if necessary
 - If there's a breaking change, add `BREAKING CHANGE` and an explanation to your commit message
 -->

.github/actionlint.yml

@@ -0,0 +1,5 @@
+# TODO: Remove this once a new actionlint release has been cut
+# and made its way to us through nixpkgs.
+self-hosted-runner:
+  labels:
+    - ubuntu-24.04-arm

.github/actions/artifact-from-cirrus/action.yaml

@@ -0,0 +1,119 @@
+name: Artifact from Cirrus
+
+description: Waits for a specific Cirrus CI run to complete, then downloads the artifact and uploads it to the current workflow. This will silently succeed if Cirrus CI did not schedule a task within 2 minutes.
+
+inputs:
+  download:
+    description: Name of Artifact to download from Cirrus CI
+    required: true
+  task:
+    description: Name of Cirrus Task
+    required: true
+  token:
+    description: GitHub Token
+    required: true
+  upload:
+    description: Name of Artifact to upload on GitHub Actions
+    required: true
+
+runs:
+  using: composite
+  steps:
+    - shell: bash
+      run: echo "GH_TOKEN=${{ inputs.token }}" >> "$GITHUB_ENV"
+    - name: Wait for Check Suite to be created
+      id: check-suite
+      env:
+        # GITHUB_SHA does weird things for pull request, so we roll our own:
+        COMMIT: ${{ github.event.pull_request.head.sha || github.sha }}
+      shell: bash
+      run: |
+        get_check_runs_url() {
+          gh api "repos/{owner}/{repo}/commits/${COMMIT}/check-suites" \
+            | jq -r '.check_suites[] | select(.app.slug == "cirrus-ci") | .check_runs_url'
+        }
+        for _ in $(seq 1 12); do
+          check_runs_url="$(get_check_runs_url)"
+          if [ -z "$check_runs_url" ]; then
+            echo "Cirrus CI task has not started, yet. Waiting..."
+            sleep 10
+          else
+            echo "check_runs_url=$check_runs_url" >> "$GITHUB_OUTPUT"
+            exit 0
+          fi
+        done
+        >&2 echo "Cirrus CI check suite not found. Is Cirrus CI enabled for this repo?"
+    - name: Find task by name
+      id: find-task
+      if: steps.check-suite.outputs.check_runs_url
+      shell: bash
+      run: |
+        get_number_of_tasks() {
+          gh api "${{ steps.check-suite.outputs.check_runs_url }}" \
+            | jq -r '.check_runs | map(select(.name == "${{ inputs.task }}")) | length'
+        }
+        tasks="$(get_number_of_tasks)"
+        case "$tasks" in
+          0)
+            echo "Task not found, assuming it's skipped intentionally..."
+            exit 0
+            ;;
+          1)
+            echo "task_found=1" >> "$GITHUB_OUTPUT"
+            exit 0
+            ;;
+          *)
+            >&2 echo "More than 1 task with the same name found. Don't know what to do..."
+            exit 1
+            ;;
+        esac
+    - name: Wait for Cirrus CI to complete task
+      if: steps.find-task.outputs.task_found
+      shell: bash
+      run: |
+        get_conclusion() {
+          gh api "${{ steps.check-suite.outputs.check_runs_url }}" \
+            | jq -r '.check_runs[] | select(.name == "${{ inputs.task }}" and .status == "completed") | .conclusion'
+        }
+        while true; do
+          conclusion="$(get_conclusion)"
+          if [ -z "$conclusion" ]; then
+            echo "Cirrus CI task has not completed, yet. Waiting..."
+            sleep 30
+          else
+            if [ "$conclusion" == "success" ]; then
+              break
+            else
+              exit 1
+            fi
+          fi
+        done
+    - name: Download artifact from Cirrus CI
+      if: steps.find-task.outputs.task_found
+      id: download
+      shell: bash
+      run: |
+        get_external_id() {
+          gh api "${{ steps.check-suite.outputs.check_runs_url }}" \
+            | jq -er '.check_runs[] | select(.name == "${{ inputs.task }}") | .external_id'
+        }
+        archive="$(mktemp)"
+        artifacts="$(mktemp -d)"
+        until curl --no-progress-meter --fail -o "${archive}" \
+                "https://api.cirrus-ci.com/v1/artifact/task/$(get_external_id)/${{ inputs.download }}.zip"
+        do
+          # This happens when a tag is pushed on the same commit. In this case the
+          # job is immediately marked as "completed" for us, so we end up here after a few
+          # seconds - but the actual Cirrus CI task is still running and didn't produce its artifact, yet.
+          echo "Artifact not found on Cirrus CI, yet. Waiting..."
+          sleep 30
+        done
+        unzip "${archive}" -d "${artifacts}"
+        echo "artifacts=${artifacts}" >> "$GITHUB_OUTPUT"
+    - name: Save artifact to GitHub Actions
+      if: steps.find-task.outputs.task_found
+      uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+      with:
+        name: ${{ inputs.upload }}
+        path: ${{ steps.download.outputs.artifacts }}
+        if-no-files-found: error

.github/actions/cache-on-main/action.yaml

@@ -8,6 +8,7 @@ inputs:
     required: true
   save-prs:
     description: Whether to additionally store the cache in a pull request, too. Should only be used for very small caches.
+    type: boolean
   prefix:
     description: Cache key prefix to be used in both primary key and restore-keys.
     required: true
@@ -18,17 +19,17 @@ inputs:
 runs:
   using: composite
   steps:
-    - uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
+    - uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3
       if: ${{ startsWith(github.ref, 'refs/heads/') || (inputs.save-prs && startsWith(github.ref, 'refs/pull/')) }}
       with:
         path: ${{ inputs.path }}
-        key: ${{ runner.os }}-${{ runner.arch }}-${{ inputs.prefix }}-${{ inputs.suffix }}
+        key: ${{ runner.os }}-${{ inputs.prefix }}-${{ inputs.suffix }}
         restore-keys: |
-          ${{ runner.os }}-${{ runner.arch }}-${{ inputs.prefix }}-
-    - uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
+          ${{ runner.os }}-${{ inputs.prefix }}-
+    - uses: actions/cache/restore@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3
       if: ${{ !startsWith(github.ref, 'refs/heads/') && !(inputs.save-prs && startsWith(github.ref, 'refs/pull/'))  }}
       with:
         path: ${{ inputs.path }}
-        key: ${{ runner.os }}-${{ runner.arch }}-${{ inputs.prefix }}-${{ inputs.suffix }}
+        key: ${{ runner.os }}-${{ inputs.prefix }}-${{ inputs.suffix }}
         restore-keys: |
-          ${{ runner.os }}-${{ runner.arch }}-${{ inputs.prefix }}-
+          ${{ runner.os }}-${{ inputs.prefix }}-

.github/actions/run-anywhere/action.yaml

@@ -1,35 +0,0 @@
-name: Run anywhere
-
-description: Runs the same code either in a VM or on the bare machine
-
-inputs:
-  vm:
-    description: Which VM to run on.
-  envs:
-    description: List of relevant environment variables, which might need to be copied into the VM.
-  prepare:
-    description: Code to run in a prepare step, e.g. installing dependencies.
-  run:
-    description: Code to run as the main action.
-    required: true
-
-runs:
-  using: composite
-  steps:
-    - if: ${{ inputs.vm == 'freebsd' }}
-      uses: vmactions/freebsd-vm@83b151f58c6047089f4c80eb5ba2039d158ce093 # v1.5.3
-      with:
-        envs: ${{ inputs.envs }}
-        prepare: ${{ inputs.prepare }}
-        # Work around https://github.com/vmactions/freebsd-vm/issues/59
-        run: |
-          pw user add -n action -m
-          su action -c '${{ inputs.run }}'
-    - if: ${{ inputs.vm == '' }}
-      name: Prepare
-      shell: ${{ runner.os == 'Windows' && 'pwsh' || 'bash' }}
-      run: ${{ inputs.prepare }}
-    - if: ${{ inputs.vm == '' }}
-      name: Run
-      shell: ${{ runner.os == 'Windows' && 'pwsh' || 'bash' }}
-      run: ${{ inputs.run }}

.github/actions/setup-nix/action.yaml

@@ -11,12 +11,12 @@ inputs:
 runs:
   using: composite
   steps:
-    - uses: nixbuild/nix-quick-install-action@9f63be77f412a248c9d9a65a4c82cf066cdf8f0c # v35
+    - uses: nixbuild/nix-quick-install-action@5bb6a3b3abe66fd09bbf250dce8ada94f856a703 # v30
       with:
         nix_conf: |-
           always-allow-substitutes = true
           max-jobs = auto
-    - uses: cachix/cachix-action@5f2d7c5294214f71b873db4b969586b980625e71 # v17
+    - uses: cachix/cachix-action@0fc020193b5a1fa3ac4575aa3a7d3aa6a35435ad # v16
       with:
         name: postgrest
         authToken: ${{ inputs.authToken }}

.github/codecov.yml

@@ -4,9 +4,6 @@ codecov:
 
 comment: false
 
-github_checks:
-  annotations: true
-
 coverage:
   status:
     project:

.github/renovate.json

@@ -3,26 +3,23 @@
   "extends": [
     "config:best-practices"
   ],
-  "baseBranchPatterns": [
+  "baseBranches": [
     "main",
     "/^v[0-9]+/"
   ],
   "rebaseWhen": "conflicted",
-  "pip_requirements": {
-    "enabled": false
-  },
   "packageRules": [
     {
-      "matchManagers": [
-        "haskell-cabal"
-      ],
-      "enabled": false
+      "matchBaseBranches": [ "/^v[0-9]+/" ],
+      "groupName": "all dependencies"
     },
     {
-      "matchBaseBranches": [
-        "/^v[0-9]+/"
-      ],
-      "groupName": "all dependencies"
+      "matchPackageNames": ["docutils"],
+      "allowedVersions": "<0.21.0"
+    },
+    {
+      "matchPackageNames": ["macos"],
+      "allowedVersions": "<13"
     }
   ]
 }

.github/workflows/backport.yaml

@@ -1,53 +0,0 @@
-name: Backport
-
-on:
-  pull_request_target:
-    types:
-      - closed
-      - labeled
-
-jobs:
-  backport:
-    name: Backport
-    runs-on: ubuntu-slim
-    # It triggers only when PR is already merged on either:
-    #
-    # - The merge event itself (action != labeled) or
-    # - A label event with the right label (backport ...).
-    #
-    # The result will be that we can add the label before or after merge,
-    # but the workflow will only run once the PR had been merged.
-    if: >
-      github.event.pull_request.merged &&
-      (
-        github.event.action != 'labeled' ||
-        startsWith(github.event.label.name, 'backport')
-      )
-    steps:
-
-      # This actions creates the github token using the postgrest app secrets
-      - name: Create Github App Token
-        id: app-token
-        uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0
-        with:
-          client-id: ${{ vars.POSTGREST_CI_APP_ID }}
-          private-key: ${{ secrets.POSTGREST_CI_PRIVATE_KEY }}
-          permission-contents: write
-          permission-pull-requests: write
-          permission-workflows: write # required when backporting CI changes
-
-      # This is required for backport action to cherry-pick the PR
-      - name: Fetch PR ref
-        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
-        with:
-          allow-unsafe-pr-checkout: true
-          ref: ${{ github.event.pull_request.head.sha }}
-          token: ${{ steps.app-token.outputs.token }}
-
-      # Backport action that creates the PR with given settings
-      - name: Create backport PR
-        uses: korthout/backport-action@2e830a1d0b8269505846ddd407a70876913ad1f8 # v4.6
-        with:
-          github_token: ${{ steps.app-token.outputs.token }}
-          pull_description: 'Backport for #${pull_number}.'
-          pull_title: '${target_branch}: ${pull_title}'

.github/workflows/build.yaml

@@ -16,7 +16,6 @@ on:
       - .github/*
       - '*.nix'
       - nix/**
-      - flake.lock
       - .cirrus.yml
       - cabal.project*
       - postgrest.cabal
@@ -31,66 +30,56 @@ concurrency:
 
 jobs:
   static:
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - name: Linux aarch64
-            runs-on: ubuntu-24.04-arm
-            artifact: aarch64
-          - name: Linux x86-64
-            runs-on: ubuntu-24.04
-            artifact: x86-64
-    name: Nix - ${{ matrix.name }} static
-    runs-on: ${{ matrix.runs-on }}
+    name: Nix - Linux x86-64 static
+    runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Setup Nix Environment
         uses: ./.github/actions/setup-nix
         with:
           authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
 
       - name: Build static executable
-        run: nix-build -A postgrestStatic -A postgrestStatic.tests
+        run: nix-build -A postgrestStatic
       - name: Save built executable as artifact
-        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
         with:
-          name: postgrest-linux-static-${{ matrix.artifact }}
+          name: postgrest-linux-static-x86-64
           path: result/bin/postgrest
           if-no-files-found: error
 
       - name: Build Docker image
-        run: nix-build -A docker.image --out-link postgrest-docker-${{ matrix.artifact }}.tar.gz
+        run: nix-build -A docker.image --out-link postgrest-docker.tar.gz
       - name: Save built Docker image as artifact
-        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
         with:
-          name: postgrest-docker-${{ matrix.artifact }}
-          path: postgrest-docker-${{ matrix.artifact }}.tar.gz
+          name: postgrest-docker-x86-64
+          path: postgrest-docker.tar.gz
           if-no-files-found: error
 
-      - name: Test static executable with NixOS' VM test
-        # GHA's ARM runner does not support KVM
-        if: runner.arch == 'X64'
-        run: nix-build -A nixpkgs-nixos-test
-
 
   macos:
     name: Nix - MacOS
-    runs-on: macos-26
+    runs-on: macos-14
     steps:
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Setup Nix Environment
         uses: ./.github/actions/setup-nix
         with:
           authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
-      - name: Install nix-build-uncached
-        run: nix-env -f default.nix -iA nix-build-uncached
+      - name: Install gnu sed
+        run: brew install gnu-sed
 
-      - name: Build everything (default.nix)
-        run: nix-build-uncached
-
-      - name: Build everything (shell.nix)
-        run: nix-build-uncached shell.nix
+      - name: Build everything
+        run: |
+          # The --dry-run will give us a list of derivations to download from cachix and
+          # derivations to build. We only take those that would have to be built and then build
+          # those explicitly. This has the advantage that pure verification will not include
+          # a download anymore, making it much faster. If something needs to be built, only
+          # the dependencies required to do so will be downloaded, but not everything.
+          nix-build --dry-run 2>&1 \
+            | gsed -e '1,/derivations will be built:$/d' -e '/paths will be fetched/Q' \
+            | xargs nix-build
 
 
   stack:
@@ -98,66 +87,66 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - name: FreeBSD x86-64
-            runs-on: ubuntu-24.04
-            vm: freebsd
-            artifact: postgrest-freebsd-x86-64
-            deps: pkg install -y git postgresql16-client hs-stack
+          - name: Linux aarch64
+            runs-on: ubuntu-24.04-arm
+            cache: |
+              ~/.stack/pantry
+              ~/.stack/snapshots
+              ~/.stack/stack.sqlite3
+            artifact: postgrest-ubuntu-aarch64
+            deps: sudo apt-get update && sudo apt-get install libpq-dev
 
-          - name: MacOS aarch64
+          - name: MacOS
             runs-on: macos-14
+            cache: |
+              ~/.stack/pantry
+              ~/.stack/snapshots
+              ~/.stack/stack.sqlite3
             artifact: postgrest-macos-aarch64
             deps: brew link --force libpq
 
-          - name: MacOS x86-64
-            runs-on: macos-15-intel
-            artifact: postgrest-macos-x86-64
-            deps: brew link --force libpq
-
           - name: Windows
             runs-on: windows-2022
+            cache: |
+              C:\sr\pantry
+              C:\sr\snapshots
+              C:\sr\stack.sqlite3
             deps: Add-Content $env:GITHUB_PATH $env:PGBIN
             artifact: postgrest-windows-x86-64
 
     name: Stack - ${{ matrix.name }}
     runs-on: ${{ matrix.runs-on }}
-    env:
-      # Putting .stack in the working directory helps with moving this in and out of the FreeBSD VM.
-      STACK_ROOT: ${{ github.workspace }}/.stack
     steps:
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
-      - if: ${{ !matrix.vm }}
-        uses: haskell-actions/setup@6037f33647c3f17758a2356c80fc4a53d7e0685d # v2.12.0
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: haskell-actions/setup@d9b5b3fcf7ca56b8fe585c9b77d3b0ce466affd2 # v2.7.10
         with:
           # This must match the version in stack.yaml's resolver
-          ghc-version: 9.10.3
+          ghc-version: 9.6.5
           enable-stack: true
           stack-no-global: true
           stack-setup-ghc: true
-      - name: Cache .stack
+      - name: Cache ~/.stack
         uses: ./.github/actions/cache-on-main
         with:
-          path: .stack
-          prefix: ${{ matrix.vm }}${{ matrix.vm && '-' }}stack
+          path: ${{ matrix.cache }}
+          prefix: stack
           suffix: ${{ hashFiles('postgrest.cabal', 'stack.yaml.lock') }}
       - name: Cache .stack-work
         uses: ./.github/actions/cache-on-main
         with:
           path: .stack-work
           save-prs: true
-          prefix: ${{ matrix.vm }}${{ matrix.vm && '-' }}stack-work-${{ hashFiles('postgrest.cabal', 'stack.yaml.lock') }}
+          prefix: stack-work-${{ hashFiles('postgrest.cabal', 'stack.yaml.lock') }}
           suffix: ${{ hashFiles('main/**/*.hs', 'src/**/*.hs') }}
+      - name: Install dependencies
+        if: matrix.deps
+        run: ${{ matrix.deps }}
       - name: Build with Stack
-        uses: ./.github/actions/run-anywhere
-        with:
-          vm: ${{ matrix.vm }}
-          envs: STACK_ROOT
-          prepare: ${{ matrix.deps }}
-          run: |
-            stack build --lock-file error-on-write --local-bin-path result --copy-bins
-            strip result/postgrest*
+        run: stack build --lock-file error-on-write --local-bin-path result --copy-bins
+      - name: Strip Executable
+        run: strip result/postgrest*
       - name: Save built executable as artifact
-        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
         with:
           name: ${{ matrix.artifact }}
           path: |
@@ -166,16 +155,29 @@ jobs:
           if-no-files-found: error
 
 
+  freebsd:
+    name: Stack - FreeBSD from CirrusCI
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: ./.github/actions/artifact-from-cirrus
+        with:
+          token: ${{ github.token }}
+          task: Build FreeBSD (Stack)
+          download: bin
+          upload: postgrest-freebsd-x86-64
+
+
   cabal:
     strategy:
       matrix:
-        ghc: ['9.10.3', '9.12.3']
+        ghc: ['9.6.4', '9.8.2']
       fail-fast: false
     name: Cabal - Linux x86-64 - GHC ${{ matrix.ghc }}
     runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
-      - uses: haskell-actions/setup@6037f33647c3f17758a2356c80fc4a53d7e0685d # v2.12.0
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: haskell-actions/setup@d9b5b3fcf7ca56b8fe585c9b77d3b0ce466affd2 # v2.7.10
         with:
           ghc-version: ${{ matrix.ghc }}
       - name: Cache .cabal
@@ -184,8 +186,8 @@ jobs:
           path: |
             ~/.cabal/packages
             ~/.cabal/store
-          prefix: cabal-${{ matrix.ghc }}-${{ hashFiles('cabal.project.freeze') }}
-          suffix: ${{ hashFiles('postgrest.cabal', 'cabal.project') }}
+          prefix: cabal-${{ matrix.ghc }}
+          suffix: ${{ hashFiles('postgrest.cabal', 'cabal.project', 'cabal.project.freeze') }}
       - name: Cache dist-newstyle
         uses: ./.github/actions/cache-on-main
         with:

.github/workflows/check.yaml

@@ -20,7 +20,7 @@ jobs:
     name: Lint & Style
     runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Setup Nix Environment
         uses: ./.github/actions/setup-nix
         with:
@@ -30,24 +30,3 @@ jobs:
         run: postgrest-lint
       - name: Run style check (auto-format with `nix-shell --run postgrest-style`)
         run: postgrest-style-check
-
-  commit:
-    if: github.event_name != 'push'  # we don't run this on a push, a failure on push disrupts the release workflow
-    name: Commit
-    runs-on: ubuntu-24.04
-    steps:
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
-        with:
-          fetch-depth: 100  # fetch history (last 100 commits) instead of default shallow clone history, this is deemed enough for a PR history
-      - name: Setup Nix Environment
-        uses: ./.github/actions/setup-nix
-        with:
-          authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
-          tools: gitTools.commitCheck.bin
-      - name: Run commitlint (check locally with `nix-shell --run postgrest-commitlint`)
-        run: |
-          # Fetch target branch explicitly
-          git fetch origin ${{ github.base_ref }}
-
-          # Run commitlint
-          postgrest-commitlint --from origin/${{ github.base_ref }} --to HEAD

.github/workflows/ci.yaml

@@ -41,22 +41,23 @@ jobs:
     concurrency:
       # Never tag outdated commits on the main branch by skipping superseded commits
       group: ci-tag-${{ (github.ref == 'refs/heads/main' && github.ref) || github.run_id }}
-      cancel-in-progress: true
+      # TODO: Enable this once https://github.com/orgs/community/discussions/13015 is solved
+      cancel-in-progress: false
     if: vars.RELEASE_ENABLED
-    runs-on: ubuntu-slim
+    runs-on: ubuntu-24.04
     needs:
       - docs
       - test
       - build
     steps:
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           ssh-key: ${{ secrets.POSTGREST_SSH_KEY }}
       - name: Tag latest commit
         run: |
           cabal_version="$(grep -oP '^version:\s*\K.*' postgrest.cabal)"
 
-          if [[ "$cabal_version" == *.* ]]; then
+          if [[ "$cabal_version" == *.*.* ]]; then
             git fetch --tags
 
             if [ -z "$(git tag --list "v$cabal_version")" ]; then

.github/workflows/docs.yaml

@@ -14,7 +14,6 @@ on:
       - .github/actions/setup-nix/**
       - default.nix
       - nix/**
-      - flake.lock
       - docs/**
       - '!**.md'
 
@@ -28,7 +27,7 @@ jobs:
     name: Build
     runs-on: ubuntu-24.04
     steps:
-    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
     - name: Setup Nix Environment
       uses: ./.github/actions/setup-nix
       with:
@@ -42,7 +41,7 @@ jobs:
     name: Spellcheck
     runs-on: ubuntu-24.04
     steps:
-    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
     - name: Setup Nix Environment
       uses: ./.github/actions/setup-nix
       with:
@@ -52,3 +51,17 @@ jobs:
       run: postgrest-docs-spellcheck
     - name: Run dictcheck
       run: postgrest-docs-dictcheck
+
+
+  linkcheck:
+    name: Linkcheck
+    if: github.base_ref == 'main'
+    runs-on: ubuntu-24.04
+    steps:
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+    - name: Setup Nix Environment
+      uses: ./.github/actions/setup-nix
+      with:
+        authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
+        tools: docs.linkcheck.bin
+    - run: postgrest-docs-linkcheck

.github/workflows/linkcheck.yaml

@@ -1,43 +0,0 @@
-name: Linkcheck
-
-on:
-  schedule:
-    - cron: '1 2 * * 3'
-  workflow_dispatch:
-
-jobs:
-  linkcheck:
-    name: Linkcheck
-    runs-on: ubuntu-24.04
-    steps:
-    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
-    - name: Setup Nix Environment
-      uses: ./.github/actions/setup-nix
-      with:
-        authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
-        tools: docs.linkcheck.bin
-
-    - name: Run Linkcheck
-      id: linkcheck
-      run: postgrest-docs-linkcheck
-
-    # This actions creates the github token using the postgrest app secrets
-    - name: Create Github App Token (Runs only on linkcheck failure)
-      id: app-token
-      if: ${{ failure() && steps.linkcheck.outcome == 'failure' }} # only create the token on linkcheck failure
-      uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0
-      with:
-        client-id: ${{ vars.POSTGREST_CI_APP_ID }}
-        private-key: ${{ secrets.POSTGREST_CI_PRIVATE_KEY }}
-        permission-issues: write # required for commenting on issues
-
-    - name: Notify on linkcheck failure by commenting on GH Issue 4106
-      if: ${{ failure() && steps.linkcheck.outcome == 'failure' }}
-      uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9 # v5.0.0
-      with:
-        token: ${{ steps.app-token.outputs.token }}
-        issue-number: 4106
-        body: |
-          **Linkcheck Job Failed!**
-
-          A broken link was detected in the docs. Please check the [failed run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) for details.

.github/workflows/release.yaml

@@ -9,7 +9,8 @@ on:
 concurrency:
   # Terminate all previous runs of the same workflow for the same tag.
   group: release-${{ github.ref }}
-  cancel-in-progress: true
+  # TODO: Enable this once https://github.com/orgs/community/discussions/13015 is solved
+  cancel-in-progress: false
 
 jobs:
   build:
@@ -19,15 +20,13 @@ jobs:
       CACHIX_AUTH_TOKEN: ${{ secrets.CACHIX_AUTH_TOKEN }}
 
 
-  github:
-    name: GitHub
-    permissions:
-      contents: write
-    runs-on: ubuntu-slim
+  prepare:
+    name: Prepare
+    runs-on: ubuntu-24.04
     needs:
       - build
     steps:
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Check the version to be released
         run: |
           cabal_version="$(grep -oP '^version:\s*\K.*' postgrest.cabal)"
@@ -49,9 +48,25 @@ jobs:
 
           echo "Relevant extract from CHANGELOG.md:"
           cat CHANGES.md
+      - name: Save CHANGES.md as artifact
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        with:
+          name: release-changes
+          path: CHANGES.md
+          if-no-files-found: error
 
+
+  github:
+    name: GitHub
+    permissions:
+      contents: write
+    runs-on: ubuntu-24.04
+    needs:
+      - prepare
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Download all artifacts
-        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e # v4.2.1
         with:
           path: artifacts
       - name: Create release bundle with archives for all builds
@@ -60,26 +75,23 @@ jobs:
 
           mkdir -p release-bundle
 
-          tar cJvf "release-bundle/postgrest-${GITHUB_REF_NAME}-linux-static-aarch64.tar.xz" \
-            -C artifacts/postgrest-linux-static-aarch64 postgrest
-
           tar cJvf "release-bundle/postgrest-${GITHUB_REF_NAME}-linux-static-x86-64.tar.xz" \
             -C artifacts/postgrest-linux-static-x86-64 postgrest
 
           tar cJvf "release-bundle/postgrest-${GITHUB_REF_NAME}-macos-aarch64.tar.xz" \
             -C artifacts/postgrest-macos-aarch64 postgrest
 
-          tar cJvf "release-bundle/postgrest-${GITHUB_REF_NAME}-macos-x86-64.tar.xz" \
-            -C artifacts/postgrest-macos-x86-64 postgrest
-
           tar cJvf "release-bundle/postgrest-${GITHUB_REF_NAME}-freebsd-x86-64.tar.xz" \
             -C artifacts/postgrest-freebsd-x86-64 postgrest
 
+          tar cJvf "release-bundle/postgrest-${GITHUB_REF_NAME}-ubuntu-aarch64.tar.xz" \
+            -C artifacts/postgrest-ubuntu-aarch64 postgrest
+
           zip --junk-paths "release-bundle/postgrest-${GITHUB_REF_NAME}-windows-x86-64.zip" \
             artifacts/postgrest-windows-x86-64/postgrest.exe
 
       - name: Save release bundle
-        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
         with:
           name: release-bundle
           path: release-bundle
@@ -101,14 +113,14 @@ jobs:
             gh release edit devel \
               -t devel \
               --verify-tag \
-              -F CHANGES.md \
+              -F artifacts/release-changes/CHANGES.md \
               --prerelease
             gh release upload --clobber devel release-bundle/*
           else
             gh release create "${GITHUB_REF_NAME}" \
               -t "${GITHUB_REF_NAME}" \
               --verify-tag \
-              -F CHANGES.md \
+              -F artifacts/release-changes/CHANGES.md \
               release-bundle/*
           fi
 
@@ -117,55 +129,70 @@ jobs:
     name: Docker Hub
     runs-on: ubuntu-24.04-arm
     needs:
-      - github
+      - prepare
     if: |
       vars.DOCKER_REPO && vars.DOCKER_USER
     env:
       DOCKER_REPO: ${{ vars.DOCKER_REPO }}
     steps:
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
-      - name: Download aarch64 Docker image
-        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
-        with:
-          name: postgrest-docker-aarch64
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Download x86-64 Docker image
-        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e # v4.2.1
         with:
           name: postgrest-docker-x86-64
-      - uses: docker/setup-buildx-action@bb05f3f5519dd87d3ba754cc423b652a5edd6d2c # v4.2.0
-      - uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
+      - name: Download aarch64 binary
+        uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e # v4.2.1
+        with:
+          name: postgrest-ubuntu-aarch64
+      - uses: docker/setup-buildx-action@b5ca514318bd6ebac0fb2aedd5d36ec1b5c232a2 # v3.10.0
+      - uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # v3.4.0
         with:
           username: ${{ vars.DOCKER_USER }}
           password: ${{ secrets.DOCKER_PASS }}
+      - name: Build aarch64 Docker image
+        run: |
+          # This only pushes the image via digest, not a tag. This will not appear
+          # in the image list on Docker Hub, yet. It will be later added to the main
+          # tag's manifest.
+          docker buildx build \
+            -t "$DOCKER_REPO/postgrest" \
+            --platform linux/arm64 \
+            --output push-by-digest=true,type=image,push=true \
+            --metadata-file metadata.json \
+            .
+          echo "SHA256_ARM=$(jq -r '."containerimage.digest"' metadata.json)" >> "$GITHUB_ENV"
       - name: Publish images on Docker Hub
         run: |
-          docker load -i postgrest-docker-aarch64.tar.gz
-          docker tag postgrest:latest "$DOCKER_REPO/postgrest:${GITHUB_REF_NAME}-linux-arm64"
-          docker push "$DOCKER_REPO/postgrest:${GITHUB_REF_NAME}-linux-arm64"
+          docker load -i postgrest-docker.tar.gz
 
-          docker load -i postgrest-docker-x86-64.tar.gz
-          docker tag postgrest:latest "$DOCKER_REPO/postgrest:${GITHUB_REF_NAME}-linux-amd64"
-          docker push "$DOCKER_REPO/postgrest:${GITHUB_REF_NAME}-linux-amd64"
-
-          docker manifest create "$DOCKER_REPO/postgrest:${GITHUB_REF_NAME}" \
-            "$DOCKER_REPO/postgrest:${GITHUB_REF_NAME}-linux-arm64" \
-            "$DOCKER_REPO/postgrest:${GITHUB_REF_NAME}-linux-amd64"
-          docker manifest push "$DOCKER_REPO/postgrest:${GITHUB_REF_NAME}"
+          docker tag postgrest:latest "$DOCKER_REPO/postgrest:${GITHUB_REF_NAME}"
+          docker push "$DOCKER_REPO/postgrest:${GITHUB_REF_NAME}"
+          docker buildx imagetools create --append \
+            -t "$DOCKER_REPO/postgrest:${GITHUB_REF_NAME}" \
+            "$DOCKER_REPO/postgrest@$SHA256_ARM"
 
           # Only tag 'latest' for full releases
           if [ "${GITHUB_REF_NAME}" != "devel" ]; then
             echo "Pushing to 'latest' tag for full release of ${GITHUB_REF_NAME} ..."
-            docker manifest create "$DOCKER_REPO/postgrest:latest" \
-              "$DOCKER_REPO/postgrest:${GITHUB_REF_NAME}-linux-arm64" \
-              "$DOCKER_REPO/postgrest:${GITHUB_REF_NAME}-linux-amd64"
-            docker manifest push "$DOCKER_REPO/postgrest:latest"
+            docker tag postgrest:latest "$DOCKER_REPO"/postgrest:latest
+            docker push "$DOCKER_REPO"/postgrest:latest
+            docker buildx imagetools create --append \
+              -t "$DOCKER_REPO/postgrest:latest" \
+              "$DOCKER_REPO/postgrest@$SHA256_ARM"
           else
             echo "Skipping push to 'latest' tag for pre-release..."
           fi
 
-      - uses: peter-evans/dockerhub-description@1b9a80c056b620d92cedb9d9b5a223409c68ddfa # v5.0.0
-        if: github.ref == 'refs/tags/devel'
-        name: Docker Hub Description
+
+  docker-description:
+    name: Docker Hub Description
+    runs-on: ubuntu-24.04
+    if: |
+      vars.DOCKER_REPO && vars.DOCKER_USER &&
+      github.ref == 'refs/tags/devel'
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: peter-evans/dockerhub-description@432a30c9e07499fd01da9f8a49f0faf9e0ca5b77 # v4.0.2
         with:
           username: ${{ vars.DOCKER_USER }}
           password: ${{ secrets.DOCKER_PASS }}
@@ -173,54 +200,3 @@ jobs:
           short-description: ${{ github.event.repository.description }}
           readme-filepath: ./docker-hub-readme.md
 
-
-  ghcr:
-    name: GitHub Container Registry
-    runs-on: ubuntu-24.04-arm
-    needs:
-      - github
-    permissions:
-      packages: write
-    steps:
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
-      - name: Download aarch64 Docker image
-        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
-        with:
-          name: postgrest-docker-aarch64
-      - name: Download x86-64 Docker image
-        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
-        with:
-          name: postgrest-docker-x86-64
-      - uses: docker/setup-buildx-action@bb05f3f5519dd87d3ba754cc423b652a5edd6d2c # v4.2.0
-      - uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
-        with:
-          registry: ghcr.io
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-      - name: Publish images on Docker Hub
-        run: |
-          docker load -i postgrest-docker-aarch64.tar.gz
-          docker tag postgrest:latest "ghcr.io/${GITHUB_REPOSITORY,,}:${GITHUB_REF_NAME}-linux-arm64"
-          docker push "ghcr.io/${GITHUB_REPOSITORY,,}:${GITHUB_REF_NAME}-linux-arm64"
-
-          docker load -i postgrest-docker-x86-64.tar.gz
-          docker tag postgrest:latest "ghcr.io/${GITHUB_REPOSITORY,,}:${GITHUB_REF_NAME}-linux-amd64"
-          docker push "ghcr.io/${GITHUB_REPOSITORY,,}:${GITHUB_REF_NAME}-linux-amd64"
-
-          docker manifest create "ghcr.io/${GITHUB_REPOSITORY,,}:${GITHUB_REF_NAME}" \
-            "ghcr.io/${GITHUB_REPOSITORY,,}:${GITHUB_REF_NAME}-linux-arm64" \
-            "ghcr.io/${GITHUB_REPOSITORY,,}:${GITHUB_REF_NAME}-linux-amd64"
-          docker manifest push "ghcr.io/${GITHUB_REPOSITORY,,}:${GITHUB_REF_NAME}"
-
-          # Only tag 'latest' for full releases
-          if [ "${GITHUB_REF_NAME}" != "devel" ]; then
-            echo "Pushing to 'latest' tag for full release of ${GITHUB_REF_NAME} ..."
-            docker manifest create "ghcr.io/${GITHUB_REPOSITORY,,}:latest" \
-              "ghcr.io/${GITHUB_REPOSITORY,,}:${GITHUB_REF_NAME}-linux-arm64" \
-              "ghcr.io/${GITHUB_REPOSITORY,,}:${GITHUB_REF_NAME}-linux-amd64"
-            docker manifest push "ghcr.io/${GITHUB_REPOSITORY,,}:latest"
-          else
-            echo "Skipping push to 'latest' tag for pre-release..."
-          fi
-
-

.github/workflows/test.yaml

@@ -17,7 +17,6 @@ on:
       - .github/actions/setup-nix/**
       - default.nix
       - nix/**
-      - flake.lock
       - .stylish-haskell.yaml
       - cabal.project
       - postgrest.cabal
@@ -25,10 +24,6 @@ on:
       - test/**
       - '!**.md'
 
-defaults:
-  run:
-    shell: bash
-
 concurrency:
   # Terminate all previous runs of the same workflow for pull requests
   group: test-${{ github.head_ref || github.run_id }}
@@ -44,26 +39,24 @@ jobs:
         # https://github.com/actions/runner/issues/241#issuecomment-842566950
         shell: script -qec "bash --noprofile --norc -eo pipefail {0}"
     steps:
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Setup Nix Environment
         uses: ./.github/actions/setup-nix
         with:
           authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
-          tools: tests.coverage.bin tests.testDoctests.bin tests.testSpecIdempotence.bin cabalTools.update.bin
+          tools: tests.coverage.bin tests.testDoctests.bin tests.testSpecIdempotence.bin
 
-      - run: postgrest-cabal-update
-
-      - name: Run coverage (IO tests and Spec tests against latest supported PostgreSQL)
+      - name: Run coverage (IO tests and Spec tests against PostgreSQL 15)
         run: postgrest-coverage
       - name: Upload coverage to codecov
-        uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0
+        uses: codecov/codecov-action@0565863a31f2c772f9f0395002a31e3f06189574 # v5.4.0
         with:
           files: ./coverage/codecov.json
           token: ${{ secrets.CODECOV_TOKEN }}
 
       - name: Run doctests
         if: always()
-        run: nix-shell --run postgrest-test-doctests
+        run: postgrest-test-doctests
 
       - name: Check the spec tests for idempotence
         if: always()
@@ -74,9 +67,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        # Latest version is tested via `coverage` above.
-        pgVersion: [pg-14, pg-15, pg-16, pg-17, oriole-18, pg-18]
-    name: ${{ matrix.pgVersion }}
+        pgVersion: ["9_6", 10, 11, 12, 13, 14, 15, 16]
+    name: PG ${{ matrix.pgVersion }}
     runs-on: ubuntu-24.04
     defaults:
       run:
@@ -84,126 +76,57 @@ jobs:
         # https://github.com/actions/runner/issues/241#issuecomment-842566950
         shell: script -qec "bash --noprofile --norc -eo pipefail {0}"
     steps:
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Setup Nix Environment
         uses: ./.github/actions/setup-nix
         with:
           authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
-          tools: tests.testSpec.bin tests.testObservability.bin tests.testIO.bin tests.testBigSchema.bin withTools.${{ matrix.pgVersion }}.bin cabalTools.update.bin
-
-      - run: postgrest-cabal-update
+          tools: tests.testSpec.bin tests.testIO.bin tests.testBigSchema.bin withTools.postgresql-${{ matrix.pgVersion }}.bin
 
       - name: Run spec tests
         if: always()
-        run: postgrest-with-${{ matrix.pgVersion }} postgrest-test-spec
-
-      - name: Run observability tests
-        if: always()
-        run: postgrest-with-${{ matrix.pgVersion }} postgrest-test-observability
+        run: postgrest-with-postgresql-${{ matrix.pgVersion }} postgrest-test-spec
 
       - name: Run IO tests
         if: always()
-        run: postgrest-with-${{ matrix.pgVersion }} postgrest-test-io -vv
+        run: postgrest-with-postgresql-${{ matrix.pgVersion }} postgrest-test-io -vv
 
       - name: Run IO tests on a big schema
         if: always()
-        run: postgrest-with-${{ matrix.pgVersion }} postgrest-test-big-schema -vv
+        run: postgrest-with-postgresql-${{ matrix.pgVersion }} postgrest-test-big-schema -vv
 
 
   memory:
     name: Memory
     runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Setup Nix Environment
         uses: ./.github/actions/setup-nix
         with:
           authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
-          tools: tests.testMemory.bin cabalTools.update.bin
-
-      - run: postgrest-cabal-update
-
+          tools: memory.test.bin
       - name: Run memory tests
         run: postgrest-test-memory
 
 
   loadtest:
-    strategy:
-      fail-fast: false
-      matrix:
-        kind: ['mixed', 'jwt-cache']
     name: Loadtest
     runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           fetch-depth: 0
       - name: Setup Nix Environment
         uses: ./.github/actions/setup-nix
         with:
           authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
-          tools: loadtest.loadtestAgainst.bin loadtest.report.bin loadtest.report-load.bin cabalTools.update.bin
-
-      - run: postgrest-cabal-update
-
+          tools: loadtest.loadtestAgainst.bin loadtest.report.bin
+      - uses: WyriHaximus/github-action-get-previous-tag@04e8485ecb6487243907e330d522ff60f02283ce # v1.4.0
+        id: get-latest-tag
+        with:
+          prefix: v
       - name: Run loadtest
-        env:
-          TARGET_BRANCH: ${{ github.base_ref || github.ref_name }}
         run: |
-          if [ "$TARGET_BRANCH" = "main" ]; then
-            latest_tag=$(git tag --sort=-creatordate --list "v*" | head -n1)
-          else
-            latest_tag=$(git tag --merged HEAD --sort=-creatordate "v*" | head -n1)
-          fi
-          postgrest-loadtest-against -k ${{ matrix.kind }} "$TARGET_BRANCH" "$latest_tag"
-
-      - name: Report P50
-        # This step checks whether any red cross indicators (:x:) are present in the step summary.
-        # The loadtest reporter writes them when any of individual steps fails the performance
-        # regression threshold.
-        run: |
-          ! (postgrest-loadtest-report -g ${{ matrix.kind }} -p 50 \
-              | tee "$GITHUB_STEP_SUMMARY" \
-              | grep ':x:')
-
-      - name: Report P0
-        if: always()
-        run: |
-          postgrest-loadtest-report -g ${{ matrix.kind }} -p 0 >> "$GITHUB_STEP_SUMMARY"
-
-      - name: Report P90
-        if: always()
-        run: |
-          postgrest-loadtest-report -g ${{ matrix.kind }} -p 90 >> "$GITHUB_STEP_SUMMARY"
-
-      - name: Report P95
-        if: always()
-        run: |
-          postgrest-loadtest-report -g ${{ matrix.kind }} -p 95 >> "$GITHUB_STEP_SUMMARY"
-
-      - name: Report CPU/MEM
-        if: always()
-        run: |
-          postgrest-loadtest-report-load -g ${{ matrix.kind }} >> "$GITHUB_STEP_SUMMARY"
-
-  flake:
-    strategy:
-      fail-fast: false
-      matrix:
-        runs-on:
-          - macos-14 # aarch64-darwin
-          - ubuntu-24.04 # x86_64-linux
-          - ubuntu-24.04-arm # aarch64-linux
-    name: Flake Check
-    runs-on: ${{ matrix.runs-on }}
-    steps:
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
-        with:
-          fetch-depth: 0
-      - name: Setup Nix Environment
-        uses: ./.github/actions/setup-nix
-        with:
-          authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
-      - name: Run flake check
-        run: |
-          nix flake check
+          postgrest-loadtest-against main ${{ steps.get-latest-tag.outputs.tag }}
+          postgrest-loadtest-report >> "$GITHUB_STEP_SUMMARY"

.gitignore

@@ -14,7 +14,7 @@ site
 .#*
 *.swp
 result*
-dist-*
+dist-newstyle
 postgrest.hp
 postgrest.prof
 __pycache__
@@ -24,10 +24,3 @@ coverage
 loadtest
 .history
 .docs-build
-gen_targets.http
-gen_jwks.json
-gen_private.json
-.pytest_cache
-.ruff_cache
-postgrest-module-graph.png
-.ghc.environment.*

.readthedocs.yaml

@@ -5,6 +5,6 @@ python:
    install:
    - requirements: docs/requirements.txt
 build:
-  os: ubuntu-24.04
+  os: ubuntu-22.04
   tools:
-    python: "3.12"
+    python: "3.11"

.stylish-haskell.yaml

@@ -200,7 +200,7 @@ steps:
 
 # A common setting is the number of columns (parts of) code will be wrapped
 # to. Different steps take this into account. Default: 80.
-columns: 80
+columns: 70
 
 # By default, line endings are converted according to the OS. You can override
 # preferred format here.

BACKERS.md

@@ -13,26 +13,31 @@ PostgREST ongoing development is only possible thanks to our Sponsors and Backer
         </a>
       </td>
       <td align="center" valign="middle">
-        <a href="https://supabase.io?utm_source=postgrest%20backers&utm_medium=open%20source%20partner&utm_campaign=postgrest%20backers%20github&utm_term=homepage" target="_blank">
-          <img width="296px" src="static/supabase.svg">
+        <a href="https://gnuhost.eu/?utm_source=sponsor&utm_campaign=postgrest" target="_blank">
+          <img width="296px" src="static/gnuhost.png">
         </a>
       </td>
       <td align="center" valign="middle">
-        <a href="https://www.euronodes.com/postgrest" target="_blank">
-          <img width="296px" src="static/euronodes.svg">
+        <a href="https://neon.tech/?utm_source=sponsor&utm_campaign=postgrest" target="_blank">
+          <img width="296px" src="static/neon.jpg">
         </a>
       </td>
     </tr>
     <tr></tr>
     <tr>
       <td align="center" valign="middle">
-        <a href="https://neon.tech/?utm_source=sponsor&utm_campaign=postgrest" target="_blank">
-          <img width="296px" src="static/neon.jpg">
+        <a href="https://code.build/?utm_source=sponsor&utm_campaign=postgrest" target="_blank">
+          <img width="296px" src="static/code-build.png">
         </a>
       </td>
       <td align="center" valign="middle">
-        <a href="https://www.bytebase.com/?utm_source=sponsor&utm_campaign=postgrest" target="_blank">
-          <img width="296px" src="static/bytebase.svg">
+        <a href="https://supabase.io?utm_source=postgrest%20backers&utm_medium=open%20source%20partner&utm_campaign=postgrest%20backers%20github&utm_term=homepage" target="_blank">
+          <img width="296px" src="static/supabase.png">
+        </a>
+      </td>
+      <td align="center" valign="middle">
+        <a href="https://tembo.io/?utm_source=sponsor&utm_campaign=postgrest" target="_blank">
+          <img width="296px" src="static/tembo.png">
         </a>
       </td>
     </tr>
@@ -88,16 +93,6 @@ PostgREST ongoing development is only possible thanks to our Sponsors and Backer
           <img width="222px" src="static/oblivious.jpg">
         </a>
       </td>
-      <td align="center" valign="middle">
-        <a href="https://code.build/?utm_source=sponsor&utm_campaign=postgrest" target="_blank">
-          <img width="222px" src="static/code-build.png">
-        </a>
-      </td>
-      <td align="center" valign="middle">
-        <a href="https://tembo.io/?utm_source=sponsor&utm_campaign=postgrest" target="_blank">
-          <img width="296px" src="static/tembo.png">
-        </a>
-      </td>
     </tr>
   </tbody>
 </table>

CHANGELOG.md

@@ -1,398 +1,10 @@
 # Change Log
 
-All notable changes to this project will be documented in this file. From version `14.0` onwards PostgREST follows a `MAJOR.PATCH` two-part versioning. Only even-numbered MAJOR versions will be released, reserving odd-numbered MAJOR versions for development.
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
 
-### Fixed
-
-- The OpenAPI output now reflects table privileges: only the granted HTTP methods are exposed (e.g. `SELECT` grants `GET`, `INSERT` grants `POST`) and column-level grants filter the columns shown on table definitions and row filters.
-
-## [16.1] - 2026-08-10
-
-### Fixed
-
-- JWT validation uses wrong current time due to a bug in auto-update by @mkleczek in #5159
-
-## [16.0] - 2026-08-07
-
-### Changes
-
-#### HTTP Server
-
-- [Graceful shutdown](https://docs.postgrest.org/en/v16/references/http_server.html#graceful-shutdown) by @mkleczek, @Vlix in #4702
-
-- [server-reuseport](https://docs.postgrest.org/en/v16/references/configuration.html#server-reuseport) allows starting multiple PostgREST instances using the same port on supported platforms by @mkleczek in #4703, #4694
-
-#### Performance
-
-- Optimize schema cache domain type resolution by using [pg_basetype](https://www.postgresql.org/docs/current/functions-info.html#FUNCTIONS-INFO-CATALOG) on PostgreSQL 17+ by @joelonsql in #4567
-
-- [Prefer: count=exact](https://docs.postgrest.org/en/v16/references/api/pagination_count.html#exact-count) no longer does a double count on requests that do not use ranges or `db-max-rows` by @laurenceisla in #3957
-
-- [Prefer: timezone](https://docs.postgrest.org/en/v16/references/api/preferences.html#prefer-timezone) no longer requires the schema cache by @steve-chavez in #5100
-  + Previously this required caching [pg_timezone_names](https://www.postgresql.org/docs/current/view-pg-timezone-names.html) which was slow in some systems
-
-#### Integrations
-
-- PostgREST is now tested to work with [OrioleDB](https://github.com/orioledb/orioledb/) in #4845 by @wolfgangwalther
-  + See [our guide for running OrioleDB on NixOS](https://docs.postgrest.org/en/v16/integrations/nixos.html)
-
-#### JWT
-
-- [JWT Role Extraction](https://docs.postgrest.org/en/v16/references/auth.html#jwt-role-extract) is now more flexible, supporting the standard JSON Path defined in RFC 9535 by @taimoorzaeem in #4984
-
-#### API
-
-- [Prefer: timezone](https://docs.postgrest.org/en/v16/references/api/preferences.html#timezone) now supports numeric offsets like `05:00` or `-4` by @steve-chavez in #5100
-
-- Fix unexpected results when embedding and filtering the same table more than once by @laurenceisla in #4075
-  + You need to set [url-use-legacy-target-names](https://docs.postgrest.org/en/v16/references/configuration.html#url-use-legacy-target-names) to `false`.
-
-- Deprecate filters, orders and limits with the name of an embedded table when it has an alias by @steve-chavez, @laurenceisla in #4075
-  + e.g. `?select=alias:table(*)&table.id=eq.1` will not be possible anymore, use `?select=alias:table(*)&alias.id=eq.1` instead.
-  + You will see a warning in the logs and a `Warning` header on the client response when this happens.
-  + You can disable this behavior now by setting `url-use-legacy-target-names = false`.
-
-- Add `Vary` header to responses by @develop7 in #4609
-
-- Fix automatic transaction retries on `40001 (serialization_failure)` errors to prevent replication lag by @laurenceisla in #3673
-
-#### Observability
-
-- [GHC runtime metrics](https://docs.postgrest.org/en/v16/references/observability.html#ghc-runtime-metrics) by @mkleczek in #4862
-- [client-error-verbosity](https://docs.postgrest.org/en/v16/references/configuration.html#client-error-verbosity) to customize responses error verbosity by @taimoorzaeem in #4088, #3980, #3824
-- [log-level](https://docs.postgrest.org/en/v16/references/configuration.html#log-level) config is now reloadable by @taimoorzaeem in #5113
-- Log error when `db-schemas` config contains schema `pg_catalog` or `information_schema` by @taimoorzaeem in #4359
-- Log schema cache queries timings on `log-level=debug` by @steve-chavez in #4805
-
-#### Admin Server
-
-- [admin-server-unix-socket](https://docs.postgrest.org/en/v16/references/configuration.html#admin-server-unix-socket)/[admin-server-unix-socket-mode](https://docs.postgrest.org/en/v16/references/configuration.html#admin-server-unix-socket-mode) to run the admin server on a unix socket by @wolfgangwalther in #5003
-- Fix responding with `Something went wrong` on Admin server when under EMFILE by @mkleczek in #5077
-
-#### Deployment
-
-- Make executable for aarch64-linux static instead of Ubuntu-based by @wolfgangwalther in #4193
-- Docker image for aarch64-linux is now built from scratch instead of being Ubuntu-based by @wolfgangwalther in #4193
-- Besides Docker Hub, docker images are now published to Github Container Registry by @wolfgangwalther in #2836
-
-#### Schema Cache
-
-- Fix requests failing when the schema cache fails to reload, when this happens PostgREST will continue serving requests in "best effort" by @mkleczek in #4873 #4869
-- Fix reporting 503s errors unnecessarily while the schema cache is loading at startup by @mkleczek in #4880
-- Fix schema cache dump missing RPC transaction isolation level by @taimoorzaeem in #5079
-
-#### Listener
-
-- Fix config `db-channel-enabled` not reloading by @taimoorzaeem in #4894
-
-### Migration to v16
-
-- Drop support for PostgreSQL EOL version 13 by @wolfgangwalther in #4193
-  + PostgreSQL 13 end of life was on 2025 ([ref](https://www.postgresql.org/support/versioning/))
-  + Upgrade your PostgreSQL version to at least 14 to use this new PostgREST version.
-
-- Fail at startup when `db-schemas` contains schema `pg_catalog` or `information_schema` by @taimoorzaeem in #4359
-  + Previously it failed at runtime with `PGRST205` on requests related to these schemas.
-  + Remove `pg_catalog` and `information_schema` from `db-schemas`.
-
-- `Prefer: timezone` no longer complies with `handling=lenient` and instead always fails by @steve-chavez in #5128
-  + Supporting this required caching `pg_timezone_names`, which was expensive.
-  + Ensure your requests always have a valid timezone.
-
-- `jwt-role-claim-key` no longer uses the JSPath DSL and instead uses JSON Path by @taimoorzaeem in #4984
-  + Now all config values must start with `$` character.
-     Example: `.roles.read` -> `$.roles.read`
-  + Keys with special characters, with the exception of `_` char must be quoted.
-      Example: `.roles.write-role` -> `$.roles["write-role"]`
-  + String comparison operators (`^==`, `==^` and `*==`) are replaced with regular expression search.
-      Example: `.roles[?(@ ^== "postgrest_test_")]` -> `$.roles[?search(@, "^postgrest_test_")]`
-  + Update the `jwt-role-claim-key` value accoring to the above rules. Also see the syntax reference: [RFC 9535](https://www.rfc-editor.org/rfc/rfc9535.html#name-jsonpath-syntax-and-semanti).
-
-## [14.16] - 2026-07-27
-
-### Fixed
-
-- Fix admin server crashing without a way to recover by @taimoorzaeem in #5096
-
-## [14.15] - 2026-07-13
-
-### Fixed
-
-- Fix admin server dying silently by @Vlix, @mkleczek, @steve-chavez in #5012
-
-## [14.14] - 2026-06-29
-
-### Fixed
-
-- Fix admin server not logging cause of failure by @taimoorzaeem in #5012
-
-## [14.13] - 2026-06-04
-
-### Fixed
-
-- Fix connection retrying message in `PGRST000` error by @netqo in #4980
-  + Remove redundant "Retrying the connection." from message because it is logged separately
-- Fix request failures when `work_mem` is set on a role by @laurenceisla in #4955
-
-## [14.12] - 2026-05-20
-
-### Fixed
-
-- Fix race condition in pool_available metric causing negative values during network instability by @mkleczek in #4622
-
-## [14.11] - 2026-05-04
-
-### Fixed
-
-- Fix login with uppercase and mixed case role names by @taimoorzaeem in #4678
-- Restore Listener query shape so it can be found in `pg_stat_activity` by @mkleczek in #4857 #4859
-- The LISTEN channel now automatically recovers when it stops working due to a PostgreSQL bug @laurenceisla in #3147
-- Fix misleading "Functions" name on schema cache summary in startup logs by @taimoorzaeem in #4821
-
-## [14.10] - 2026-04-16
-
-### Added
-
-- Log when the pool is released during schema cache reload on `log-level=debug` by @mkleczek in #4668
-
-### Fixed
-
-- Fix unnecessary connection pool flushes during schema cache reloading by @mkleczek in #4645
-
-## [14.9] - 2026-04-10
-
-### Added
-
-- Log host, port and pg version of listener database connection by @mkleczek in #4617 #4618
-
-### Fixed
-
-- Remove red herring warp logs on default log-level, only emit them on `log-level=debug` by @steve-chavez in #4799
-
-## [14.8] - 2026-04-03
-
-### Added
-
-- Log a `HINT` when the LISTEN channel stops working due to a PostgreSQL bug by @laurenceisla in #4581
-
-### Fixed
-
-- Fix invalid OpenAPI 2.0 format for integer types (`smallint`, `integer`, `bigint`) by @arturbent0 in #4641
-
-## [14.7] - 2026-03-20
-
-### Fixed
-
-- Fix not logging SIGTERM and SIGINT by @steve-chavez in #4728
-
-## [14.6] - 2026-03-06
-
-### Fixed
-
-- Fix leaking table and function names when calculating error hint by @taimoorzaeem in #4675
-
-## [14.5] - 2026-02-12
-
-### Fixed
-
-- Don't hide async exceptions in logs by @stevechavez in #4646
-
-## [14.4] - 2026-01-29
-
-### Fixed
-
-- Ensure Listener connections are released by @mkleczek in #4614
-- Fix incorrectly filtering the returned representation for PATCH requests when using `or/and` filters by @laurenceisla in #3707
-- Fix listener running with exception masked after first failure by @mkleczek in #4615
-
-## [14.3] - 2026-01-03
-
-### Fixed
-
-- Fix performance and high memory usage of relation hint calculation by @mkleczek in #4462, #4463
-
-## [14.2] - 2025-12-18
-
-### Fixed
-
-- Fix `hasSingleUnnamedParam` incorrectly matching functions with named parameters by @joelonsql in #4553
-  + Functions with a single named parameter (e.g., `foo(data json)`) no longer incorrectly match the single-param fallback, returning a clean `PGRST202` error instead of a confusing PostgreSQL `42883` error.
-- Fix misleading logs on unsupported PostgreSQL versions by @taimoorzaeem in #4519
-- Fix regression where the `PGRST103` error response was truncated by @laurenceisla in #4455
-  + Happened when an `offset` was greater than the rows requested and `Prefer: count=exact` was sent.
-- Fix not returning `Content-Length` on empty HTTP `201` responses by @laurenceisla in #4518
-- Fix inaccurate Server-Timing header durations by @steve-chavez in #4522
-- Fix inaccurate "Schema cache queried" logs by @steve-chavez in #4522
-
-## [14.1] - 2025-11-05
-
-## Fixed
-
-- Fix `db-pre-config` function failing when function names are pg reserved words by @taimoorzaeem in #4380
-- Fix `server-host=!6` incorrectly binds to IPv4 address by @taimoorzaeem in #3202
-
-## [14.0] - 2025-10-24
-
-### Added
-
-- Bounded JWT cache using the SIEVE algorithm by @mkleczek in #4084
-  + It now uses a fixed size cache instead of arbitrary sized cache.
-- Add `--ready` flag for postgrest healthcheck by @taimoorzaeem in #4239
-
-### Fixed
-
-- Fix not logging OpenAPI queries when `log-query=main-query` is enabled by @steve-chavez in #4226
-- Fix not logging explain query when `log-query=main-query` is enabled by @steve-chavez in #4319
-- Fix not logging transaction variables and db-pre-request function when `log-query=main-query` is enabled by @steve-chavez in #3934
-- Fix not logging the JSON message to stderr on a `PGRST002` error by @laurenceisla in #4129
-- Fix reloading the Schema Cache unnecessarily on a `PGRST002` error by @laurenceisla in #4367
-- Fix schema cache loading taking a long time for large schemas by @mkleczek in #4360, #3704
-
-### Changed
-
-- Drop support for PostgreSQL EOL version 12 by @wolfgangwalther in #3865
-- From now on PostgREST will follow a `MAJOR.PATCH` two-part versioning. Only even-numbered MAJOR versions will be released, reserving odd-numbered MAJOR versions for development.
-- Replaced `jwt-cache-max-lifetime` config with `jwt-cache-max-entries` by @mkleczek in #4084
-- `log-query` config now takes a boolean instead of a string value by @steve-chavez in #3934
-
-## [13.0.8] - 2025-10-24
-
-### Fixed
-
-- Fix loading utf-8 config files with `ASCII` locale set by @taimoorzaeem in #4386
-
-## [13.0.7] - 2025-09-14
-
-### Added
-
-- Improve the `PGRST106` error when the requested schema is invalid by @laurenceisla in #4089
-  + It now shows the invalid schema in the `message` field.
-  + The exposed schemas are now listed in the `hint` instead of the `message` field.
-- Improve error details of `PGRST301` error by @taimoorzaeem in #4051
-
-## [13.0.6] - 2025-08-30
-
-### Fixed
-
-- Fix logging the Haskell type instead of the listener error message directly by @laurenceisla in #3588
-- Fix format of `IPv6` address logged at PostgREST startup by @taimoorzaeem in #4291
-- Fix empty enum in `preferParams` OpenAPI parameter by @laurenceisla in #4292
-
-## [13.0.5] - 2025-08-24
-
-### Fixed
-
-- Fix OpenAPI broken docs link by @taimoorzaeem in #4080
-- Fix OpenAPI specification incorrectly exposing GET methods for volatile functions by @joelonsql in #4174
-- Fix empty spread embeddings return unexpected SQL error by @taimoorzaeem in #3887
-- Fix `/metrics` endpoint not responding with `Content-Type` header by @taimoorzaeem in #4271
-
-## [13.0.4] - 2025-06-17
-
-### Fixed
-
-- Fix regression that makes full-text search not work on domain types based on `tsvector` by @laurenceisla in #4135
-- Fix `jwt-aud` config not failing when set to an invalid URI by @taimoorzaeem in #4132
-
-## [13.0.3] - 2025-06-16
-
-- Fix `max-affected` preference not failing with RPC when `handling=strict` by @taimoorzaeem in #4100
-- Fix a property definition's type in OpenAPI not showing the correct base type of a recursive domain by @laurenceisla in #4136
-
-### Fixed
-
-## [13.0.2] - 2025-06-02
-
-### Fixed
-
-- Fix regression that makes `ORDER BY` with nulls-order not work alongside limits by @laurenceisla in #4109
-
-## [13.0.1] - 2025-06-01
-
-### Fixed
-
-- Fix jwt error returning HTTP status `400` for invalid role by @taimoorzaeem in #3601
-- Fix `db-extra-search-path` cannot be set to nothing by @taimoorzaeem in #4074
-  + It can now be disabled by setting it to empty string.
-  + Schema Cache load error is now logged including `db-schemas` and `db-extra-search-path` config values.
-
-## [13.0.0] - 2025-05-08
-
-### Added
-
- - #3558, Add the `admin-server-host` config to set the host for the admin server - @develop7
- - #3607, Log to stderr when the JWT secret is less than 32 characters long - @laurenceisla
- - #2858, Performance improvements when calling RPCs via GET using indexes in more cases - @wolfgangwalther
- - #3560, Log resolved host in "Listening on ..." messages - @develop7
- - #3727, Log maximum pool size - @steve-chavez
- - #1536, Add string comparison feature for jwt-role-claim-key - @taimoorzaeem
- - #3747, Allow `not_null` value for the `is` operator - @taimoorzaeem
- - #2255, Apply `to_tsvector()` explicitly to the full-text search filtered column (excluding `tsvector` types) - @laurenceisla
- - #1578, Log the main SQL query to stderr at the current `log-level` when `log-query=main-query` - @laurenceisla
- - #3903, Log connection pool borrows on `log-level=debug` - @taimoorzaeem
- - #3041, Allow spreading one-to-many and many-to-many embedded resources - @laurenceisla
-   + The selected columns in the embedded resources are aggregated into arrays
-   + Aggregates are not supported
- - #2967, Add `Proxy-Status` header for better error response - @taimoorzaeem
- - #4016, Add `Content-Length` response header - @laurenceisla
-
-### Fixed
-
- - #3693, Prevent spread embedding to allow aggregates when they are disabled - @laurenceisla
- - #3693, A nested spread embedding now correctly groups by the fields of its top parent relationship - @laurenceisla
- - #3693, Fix spread embedding errors when using the `count()` aggregate without a field - @laurenceisla
-   + Fixed `"column reference <col> is ambiguous"` error when selecting `?select=...table(col,count())`
-   + Fixed `"column <json_aggregate>.<alias> does not exist"` error when selecting `?select=...table(aias:count())`
- - #3727, Clarify "listening" logs - @steve-chavez
- - #3795, Clarify `Accept: vnd.pgrst.object` error message - @steve-chavez
- - #3697, #3602, Handle queries on non-existing table gracefully - @taimoorzaeem
- - #3600, #3926, Improve JWT errors - @taimoorzaeem
- - #3013, Fix `order=` with POST, PATCH, PUT and DELETE requests - @taimoorzaeem
- - #3965, Fix filter on unselected columns in a table-valued function - @taimoorzaeem
- - #4052, Fix schema cache load duplicate objects with different object type but same oid - @taimoorzaeem
-
-### Changed
-
- - #2052, Dropped support for PostgreSQL 9.6 - @wolfgangwalther
- - #2052, Dropped support for PostgreSQL 10 - @wolfgangwalther
- - #2052, Dropped support for PostgreSQL 11 - @wolfgangwalther
- - #3508, PostgREST now fails to start when `server-port` and `admin-server-port` config options are the same - @develop7
- - #3607, PostgREST now fails to start when the JWT secret is less than 32 characters long - @laurenceisla
- - #3644, Fail schema cache lookup with invalid `db-schemas` or `db-extra-search-path` config - @wolfgangwalther
-   - Previously, this would silently return 200 - OK on the root endpoint, but don't provide any usable endpoints.
-   - Note: This also applies when deleting the `public` schema - both config options default to that.
- - #3757, Remove support for `Prefer: params=single-object` - @joelonsql
-   + This preference was deprecated in favor of Functions with an array of JSON objects
- - #3013, Drop support for Limited updates/deletes
-   + The feature was complicated and largely unused.
- - #3956, Drop `/config` endpoint of admin server - @steve-chavez
-   + The endpoint was at risk of being left unprotected when exposing it.
-   + The accompanying `admin-server-config-enabled` config was also dropped.
- - #3598, PostgREST now validates the `kid` parameter of the JWT - @wolfgangwalther
-   + If the JWT contains a ``kid`` parameter, then PostgREST will look for the JSON Web Key in the `jwt-secret`.
-   + If the JWT doesn't contain a `kid`, the behavior should be backwards compatible. PostgREST  will try each key in the `jwt-secret` one by one until it finds one that works.
- - #3697, #3602, Querying non-existent table now returns `PGRST205` error instead of empty json - @taimoorzaeem
- - #3600, #3926, Improve JWT errors - @taimoorzaeem
-   + Return `PGRST301` error when `Bearer` in auth header is sent empty
-   + Diagnostic error messages instead of exposed internals
-   + Return new `PGRST303` error when jwt claims decoding fails
- - #3906, Return `PGRST125` and `PGRST126` errors instead of empty json - @taimoorzaeem
-
-## [12.2.12] - 2025-05-01
-
-### Fixed
-
-- #3956, Fix exposing admin server `/config` by default - @steve-chavez
-  + The above endpoint is now disabled unless the `admin-server-config-enabled` config is set to `true`
-
-## [12.2.11] - 2025-04-22
-
-### Fixed
-
- - #4030, Fix regression with parameter `charset=utf-8` in mediatype - @taimoorzaeem
-
 ## [12.2.10] - 2025-04-18
 
 ### Fixed
@@ -809,7 +421,7 @@ All notable changes to this project will be documented in this file. From versio
 ### Added
 
  - #1933, #2109, Add a minimal health check endpoint - @steve-chavez
-   + For enabling this, the `admin-server-port` config must be set explicitly
+   + For enabling this, the `admin-server-port` config must be set explictly
    + A `<host>:<admin_server_port>/live` endpoint is available for checking if postgrest is running on its port/socket. 200 OK = alive, 503 = dead.
    + A `<host>:<admin_server_port>/ready` endpoint is available for checking a correct internal state(the database connection plus the schema cache). 200 OK = ready, 503 = not ready.
  - #1988, Add the current user to the request log on stdout - @DavidLindbom, @wolfgangwalther
@@ -1292,7 +904,7 @@ All notable changes to this project will be documented in this file. From versio
 - Customize content negotiation per route - @begriffs
 - Allow using nulls order without explicit order direction - @steve-chavez
 - Fatal error on postgres unsupported version, format supported version in error message - @steve-chavez
-- Prevent database memory consumption by prepared statements caches - @ruslantalpa
+- Prevent database memory cosumption by prepared statements caches - @ruslantalpa
 - Use specific columns in the RETURNING section - @ruslantalpa
 - Fix columns alias for RETURNING - @steve-chavez
 

CONTRIBUTING.md

@@ -1,64 +1,3 @@
-# Contributing to PostgREST
+This repository follows the same contribution guidelines as the main PostgREST repository contribution guidelines:
 
-## AI Policy
-
-We adhere to [Gentoo's AI policy](https://wiki.gentoo.org/wiki/Project:Council/AI_policy):
-
-> It is expressly forbidden to contribute [...] any content that has been created with the assistance of Natural Language Processing artificial intelligence tools. This motion can be revisited, should a case been made over such a tool that does not pose copyright, ethical and quality concerns.
-
-You can find more about its rationale [here](https://wiki.gentoo.org/wiki/Project:Council/AI_policy#Rationale).
-
-## Issues
-
-For questions on how to use PostgREST, please use
-[GitHub discussions](https://github.com/PostgREST/postgrest/discussions).
-
-### Reporting an Issue
-
-* Make sure you test against the latest [stable release](https://github.com/PostgREST/postgrest/releases/latest)
-  and also against the latest [devel release](https://github.com/PostgREST/postgrest/releases/tag/devel).
-  It is possible we already fixed the bug you're experiencing.
-
-* Provide steps to reproduce the issue, including your OS version and
-  the specific database schema that you are using.
-
-* Please include SQL logs for issues involving runtime problems. To obtain logs first
-  [enable logging all statements](http://www.microhowto.info/howto/log_all_queries_to_a_postgresql_server.html),
-  then [find your logs](http://blog.endpoint.com/2014/11/dear-postgresql-where-are-my-logs.html).
-
-* If your database schema has changed while the PostgREST server is running,
-  [send the server a `SIGUSR1` signal](http://postgrest.org/en/latest/admin.html#schema-reloading) or restart it to ensure the schema cache
-  is not stale. This sometimes fixes apparent bugs.
-
-## Code
-
-We have a fully nix-based development environment with many tools for a smooth development workflow available.
-Check the [development docs](https://github.com/PostgREST/postgrest/blob/main/nix/README.md) on how to set it up and use it.
-
-* All contributions must pass the tests before being merged. When
-  you create a pull request your code will automatically be tested.
-
-* All fixes or features must have a test proving the improvement.
-
-* All features must document the new behavior. Critical fixes that introduce new behavior must be documented too.
-
-* All code must also pass a [linter](http://community.haskell.org/~ndm/hlint/) and [styler](https://github.com/jaspervdj/stylish-haskell)
-  with no warnings. This helps enforce a uniform style for all committers. Continuous integration will check this as well on every
-  pull request. There are useful tools in the nix-shell that help with checking this locally. You can run `postgrest-check` to do this manually but
-  we recommend adding it to `.git/hooks/pre-commit` as `nix-shell --run postgrest-check` to automatically check this before doing a commit.
-
-### Running Tests
-
-For instructions on running tests, see the [development docs](https://github.com/PostgREST/postgrest/blob/main/nix/README.md#testing).
-
-### Structuring commits in pull requests
-
-To simplify reviews, make it easy to split pull requests if deemed necessary, and to maintain clean and meaningful history of changes, you will be asked to update your PR if it does not follow the below rules:
-
-* It must be possible to merge the PR branch into target using `git merge --ff-only`, ie. the source branch must be rebased on top of target.
-* No merge commits in the source branch.
-* All commits in the source branch must be self contained, meaning: it should be possible to treat each commit as a separate PR.
-* Commits in the source branch must contain only related changes (related means the changes target a single problem/goal). For example, any refactorings should be isolated from the actual change implementation into separate commits.
-* Tests, documentation, and changelog updates should be contained in the same commits as the actual code changes they relate to. An exception to this rule is when test or documentation changes are made in separate PR.
-* Commit messages must be prefixed with one of the prefixes defined in [the list used by commit verification scripts](https://github.com/PostgREST/postgrest/blob/main/nix/tools/gitTools.nix#L11).
-* Commit messages should contain a longer description of the purpose of the changes contained in the commit and, for non-trivial changes, a description of the changes themselves.
+https://github.com/PostgREST/postgrest/blob/main/.github/CONTRIBUTING.md

Dockerfile

@@ -0,0 +1,21 @@
+# PostgREST Docker Hub image for aarch64.
+# The x86-64 is a single-static-binary image built via Nix, see:
+# nix/tools/docker/README.md
+
+FROM ubuntu:noble@sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782 AS postgrest
+
+RUN apt-get update -y \
+    && apt install -y --no-install-recommends libpq-dev zlib1g-dev jq gcc libnuma-dev \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+
+COPY postgrest /usr/bin/postgrest
+RUN chmod +x /usr/bin/postgrest
+
+EXPOSE 3000
+
+USER 1000
+
+# Use the array form to avoid running the command using bash, which does not handle `SIGTERM` properly. 
+# See https://docs.docker.com/compose/faq/#why-do-my-services-take-10-seconds-to-recreate-or-stop 
+CMD ["postgrest"]

LICENSE

@@ -1,4 +1,5 @@
-Copyright (c) 2014-2026 The PostgREST contributors
+Copyright (c) 2014 Joe Nelson
+Copyright (c) 2019 Steve Chavez
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

README.md

@@ -22,26 +22,31 @@ API than you are likely to write from scratch.
         </a>
       </td>
       <td align="center" valign="middle">
-        <a href="https://supabase.io?utm_source=postgrest%20backers&utm_medium=open%20source%20partner&utm_campaign=postgrest%20backers%20github&utm_term=homepage" target="_blank">
-          <img width="296px" src="static/supabase.svg">
+        <a href="https://gnuhost.eu/?utm_source=sponsor&utm_campaign=postgrest" target="_blank">
+          <img width="296px" src="static/gnuhost.png">
         </a>
       </td>
       <td align="center" valign="middle">
-        <a href="https://www.euronodes.com/postgrest" target="_blank">
-          <img width="296px" src="static/euronodes.svg">
+        <a href="https://neon.tech/?utm_source=sponsor&utm_campaign=postgrest" target="_blank">
+          <img width="296px" src="static/neon.jpg">
         </a>
       </td>
     </tr>
     <tr></tr>
     <tr>
       <td align="center" valign="middle">
-        <a href="https://neon.tech/?utm_source=sponsor&utm_campaign=postgrest" target="_blank">
-          <img width="296px" src="static/neon.jpg">
+        <a href="https://code.build/?utm_source=sponsor&utm_campaign=postgrest" target="_blank">
+          <img width="296px" src="static/code-build.png">
         </a>
       </td>
       <td align="center" valign="middle">
-        <a href="https://www.bytebase.com/?utm_source=sponsor&utm_campaign=postgrest" target="_blank">
-          <img width="296px" src="static/bytebase.svg">
+        <a href="https://supabase.io?utm_source=postgrest%20backers&utm_medium=open%20source%20partner&utm_campaign=postgrest%20backers%20github&utm_term=homepage" target="_blank">
+          <img width="296px" src="static/supabase.png">
+        </a>
+      </td>
+      <td align="center" valign="middle">
+        <a href="https://tembo.io/?utm_source=sponsor&utm_campaign=postgrest" target="_blank">
+          <img width="296px" src="static/tembo.png">
         </a>
       </td>
     </tr>
@@ -52,8 +57,8 @@ Big thanks to our sponsors! You can join them by supporting PostgREST on [Patreo
 
 ## Usage
 
-1. See the docs for [how to install PostgREST on your platform](https://docs.postgrest.org/en/stable/explanations/install.html). You can also [use Docker](https://docs.postgrest.org/en/stable/explanations/install.html#docker).
-
+1. Download the binary ([latest release](https://github.com/PostgREST/postgrest/releases/latest))
+   for your platform.
 2. Invoke for help:
 
     ```bash
@@ -125,7 +130,7 @@ and limited with - range headers. More about
 ## Data Integrity
 
 Rather than relying on an Object Relational Mapper and custom
-imperative coding, this system requires you to put declarative constraints
+imperative coding, this system requires you put declarative constraints
 directly into your database. Hence no application can corrupt your
 data (including your API server).
 
@@ -142,10 +147,6 @@ You can help PostgREST ongoing maintenance and development by making a regular d
 
 Every donation will be spent on making PostgREST better for the whole community.
 
-## Contributing
-
-Contributions are always welcome and appreciated. Please see the [Contributing guidelines](https://github.com/PostgREST/postgrest/blob/main/CONTRIBUTING.md).
-
 ## Thanks
 
 The PostgREST organization is grateful to:

cabal.project

@@ -1,7 +1,4 @@
 packages: postgrest.cabal
 tests: true
-allow-newer:
-  hasql:postgresql-libpq
-
--- https://github.com/martijnbastiaan/doctest-parallel/blob/main/example/README.md#cabalproject
-write-ghc-environment-files: always
+package *
+  ghc-options: -split-sections

cabal.project.freeze

@@ -1 +1 @@
-index-state: hackage.haskell.org 2026-08-10T16:58:32Z
+index-state: hackage.haskell.org 2025-02-01T14:59:33Z

default.nix

@@ -1,17 +1,9 @@
 { system ? builtins.currentSystem
 
-, compiler ? "ghc9123"
+, compiler ? "ghc948"
 
 , # Commit of the Nixpkgs repository that we want to use.
-  # It defaults to reading the inputs from flake.lock, which serves
-  # as a compatibility layer for non-flake builds / default.nix / shell.nix.
-  nixpkgsVersion ? let
-    lock = builtins.fromJSON (builtins.readFile ./flake.lock);
-  in
-  {
-    inherit (lock.nodes.nixpkgs.locked) owner repo rev;
-    tarballHash = lock.nodes.nixpkgs.locked.narHash;
-  }
+  nixpkgsVersion ? import nix/nixpkgs-version.nix
 
 , # Nix files that describe the Nixpkgs repository. We evaluate the expression
   # using `import` below.
@@ -27,7 +19,7 @@ let
     "postgrest";
 
   # PostgREST source files, filtered based on the rules in the .gitignore files
-  # and file extensions. We want to include as little as possible, as the files
+  # and file extensions. We want to include as litte as possible, as the files
   # added here will increase the space used in the Nix store and trigger the
   # build of new Nix derivations when changed.
   src =
@@ -43,7 +35,12 @@ let
       allOverlays.build-toolbox
       allOverlays.checked-shell-script
       allOverlays.gitignore
+      allOverlays.postgresql-libpq
+      allOverlays.postgresql-legacy
+      allOverlays.postgresql-future
+      allOverlays.postgis
       (allOverlays.haskell-packages { inherit compiler; })
+      allOverlays.slocat
     ];
 
   # Evaluated expression of the Nixpkgs repository.
@@ -52,32 +49,19 @@ let
 
   postgresqlVersions =
     [
-      { name = "pg-19"; postgresql = pkgs.postgresql_19.withPackages (p: [ p.postgis p.pg_safeupdate ]); }
-      { name = "pg-18"; postgresql = pkgs.postgresql_18.withPackages (p: [ p.postgis p.pg_safeupdate ]); }
-      { name = "pg-17"; postgresql = pkgs.postgresql_17.withPackages (p: [ p.postgis p.pg_safeupdate ]); }
-      { name = "pg-16"; postgresql = pkgs.postgresql_16.withPackages (p: [ p.postgis p.pg_safeupdate ]); }
-      { name = "pg-15"; postgresql = pkgs.postgresql_15.withPackages (p: [ p.postgis p.pg_safeupdate ]); }
-      { name = "pg-14"; postgresql = pkgs.postgresql_14.withPackages (p: [ p.postgis p.pg_safeupdate ]); }
-      {
-        name = "oriole-18";
-        postgresql = pkgs.orioledb.withPackages (p: [ p.postgis p.pg_safeupdate ]);
-        config = "
-          default_table_access_method = 'orioledb'
-          shared_preload_libraries = 'orioledb, pg_stat_statements'
-        ";
-      }
+      { name = "postgresql-16"; postgresql = pkgs.postgresql_16.withPackages (p: [ p.postgis p.pg_safeupdate ]); }
+      { name = "postgresql-15"; postgresql = pkgs.postgresql_15.withPackages (p: [ p.postgis p.pg_safeupdate ]); }
+      { name = "postgresql-14"; postgresql = pkgs.postgresql_14.withPackages (p: [ p.postgis p.pg_safeupdate ]); }
+      { name = "postgresql-13"; postgresql = pkgs.postgresql_13.withPackages (p: [ p.postgis p.pg_safeupdate ]); }
+      { name = "postgresql-12"; postgresql = pkgs.postgresql_12.withPackages (p: [ p.postgis p.pg_safeupdate ]); }
+      { name = "postgresql-11"; postgresql = pkgs.postgresql_11.withPackages (p: [ p.postgis p.pg_safeupdate ]); }
+      { name = "postgresql-10"; postgresql = pkgs.postgresql_10.withPackages (p: [ p.postgis p.pg_safeupdate ]); }
+      { name = "postgresql-9_6"; postgresql = pkgs.postgresql_9_6.withPackages (p: [ p.postgis p.pg_safeupdate ]); }
     ];
 
-  haskellPackages = pkgs.haskell.packages."${compiler}";
-
   # Dynamic derivation for PostgREST
-  postgrest = pkgs.lib.pipe (haskellPackages.callCabal2nix name src { }) [
-    # To allow ghc-datasize to be used.
-    lib.disableLibraryProfiling
-    # We are never going to use dynamic haskell libraries anyway. "Dynamic" refers to how
-    # non-haskell deps are linked. All haskell dependencies are always statically linked.
-    lib.disableSharedLibraries
-  ];
+  postgrest =
+    pkgs.haskell.packages."${compiler}".callCabal2nix name src { };
 
   staticHaskellPackage = import nix/static.nix { inherit compiler name pkgs src; };
 
@@ -85,38 +69,33 @@ let
   devCabalOptions =
     "-f dev --test-show-detail=direct";
 
-  inherit (pkgs.haskell) lib;
+  profiledHaskellPackages =
+    pkgs.haskell.packages."${compiler}".extend (_: super:
+      {
+        mkDerivation =
+          args:
+          super.mkDerivation (args // { enableLibraryProfiling = true; });
+      }
+    );
 
-  nixos-lib = import (pkgs.path + "/nixos/lib") { };
-  runTest = postgrest: test: (nixos-lib.runTest {
-    hostPkgs = pkgs;
-    # Replace the top-level `pkgs.postgrest` attribute with our current version on this branch.
-    defaults.nixpkgs.overlays = [ (_: _: { inherit postgrest; }) ];
-    # Speeds up evaluation a little bit; documentation is really not required for tests.
-    defaults.documentation.enable = pkgs.lib.mkDefault false;
-    imports = [ test ];
-  }).config.result;
+  inherit (pkgs.haskell) lib;
 in
 rec {
   inherit nixpkgs pkgs;
 
   # Derivation for the PostgREST Haskell package, including the executable,
   # libraries and documentation. We disable running the test suite on Nix
-  # builds, as they require a database to be set up. We split the binary
-  # into a separate output, so that the default distribution via flake.nix
-  # has a much smaller closure size.
-  postgrestPackage = pkgs.lib.pipe postgrest [
-    lib.dontCheck
-    lib.enableSeparateBinOutput
-    (haskellPackages.generateOptparseApplicativeCompletions [ "postgrest" ])
-  ];
+  # builds, as they require a database to be set up.
+  postgrestPackage =
+    lib.dontCheck postgrest;
 
   # Profiled dynamic executable.
-  postgrestProfiled = pkgs.lib.pipe postgrestPackage [
-    lib.enableExecutableProfiling
-    lib.enableLibraryProfiling
-    lib.dontHaddock
-  ];
+  postgrestProfiled =
+    lib.enableExecutableProfiling (
+      lib.dontHaddock (
+        lib.dontCheck (profiledHaskellPackages.callCabal2nix name src { })
+      )
+    );
 
   inherit (postgrest) env;
 
@@ -126,9 +105,6 @@ rec {
       inherit (pkgs.haskell.packages."${compiler}") ghcWithPackages;
     };
 
-  # Used by CI on MacOS
-  inherit (pkgs) nix-build-uncached;
-
   ### Tools
 
   cabalTools =
@@ -139,27 +115,27 @@ rec {
 
   # Development tools.
   devTools =
-    pkgs.callPackage nix/tools/devTools.nix { inherit tests style devCabalOptions hsie; };
+    pkgs.callPackage nix/tools/devTools.nix { inherit tests style devCabalOptions hsie withTools; };
 
   # Documentation tools.
   docs =
     pkgs.callPackage nix/tools/docs.nix { };
 
-  # Git tools.
-  gitTools =
-    pkgs.callPackage nix/tools/gitTools.nix { };
-
   # Load testing tools.
   loadtest =
     pkgs.callPackage nix/tools/loadtest.nix { inherit withTools; };
 
+  # Script for running memory tests.
+  memory =
+    pkgs.callPackage nix/tools/memory.nix { inherit postgrestProfiled withTools; };
+
   # Utility for updating the pinned version of Nixpkgs.
   nixpkgsTools =
     pkgs.callPackage nix/tools/nixpkgsTools.nix { };
 
   # Scripts for publishing new releases.
   release =
-    pkgs.callPackage nix/tools/release.nix { };
+    pkgs.callPackage nix/tools/release { };
 
   # Linting and styling tools.
   style =
@@ -181,7 +157,4 @@ rec {
   # Docker images and loading script.
   docker =
     pkgs.callPackage nix/tools/docker { postgrest = postgrestStatic; };
-
-  # NixOS VM tests
-  nixpkgs-nixos-test = runTest postgrestStatic (pkgs.path + "/nixos/tests/postgrest.nix");
 }

docker-hub-readme.md

@@ -19,26 +19,31 @@ write from scratch.
         </a>
       </td>
       <td align="center" valign="middle">
-        <a href="https://supabase.io?utm_source=postgrest%20backers&utm_medium=open%20source%20partner&utm_campaign=postgrest%20backers%20github&utm_term=homepage" target="_blank">
-          <img width="296px" src="https://raw.githubusercontent.com/PostgREST/postgrest/main/static/supabase.svg">
+        <a href="https://gnuhost.eu/?utm_source=sponsor&utm_campaign=postgrest" target="_blank">
+          <img width="296px" src="https://raw.githubusercontent.com/PostgREST/postgrest/main/static/gnuhost.png">
         </a>
       </td>
       <td align="center" valign="middle">
-        <a href="https://www.euronodes.com/postgrest" target="_blank">
-          <img width="296px" src="https://raw.githubusercontent.com/PostgREST/postgrest/main/static/euronodes.svg">
+        <a href="https://neon.tech/?utm_source=sponsor&utm_campaign=postgrest" target="_blank">
+          <img width="296px" src="https://raw.githubusercontent.com/PostgREST/postgrest/main/static/neon.jpg">
         </a>
       </td>
     </tr>
     <tr></tr>
     <tr>
       <td align="center" valign="middle">
-        <a href="https://neon.tech/?utm_source=sponsor&utm_campaign=postgrest" target="_blank">
-          <img width="296px" src="https://raw.githubusercontent.com/PostgREST/postgrest/main/static/neon.jpg">
+        <a href="https://code.build/?utm_source=sponsor&utm_campaign=postgrest" target="_blank">
+          <img width="296px" src="https://raw.githubusercontent.com/PostgREST/postgrest/main/static/code-build.png">
         </a>
       </td>
       <td align="center" valign="middle">
-        <a href="https://www.bytebase.com/?utm_source=sponsor&utm_campaign=postgrest" target="_blank">
-          <img width="296px" src="https://raw.githubusercontent.com/PostgREST/postgrest/main/static/bytebase.svg">
+        <a href="https://supabase.io?utm_source=postgrest%20backers&utm_medium=open%20source%20partner&utm_campaign=postgrest%20backers%20github&utm_term=homepage" target="_blank">
+          <img width="296px" src="https://raw.githubusercontent.com/PostgREST/postgrest/main/static/supabase.png">
+        </a>
+      </td>
+      <td align="center" valign="middle">
+        <a href="https://tembo.io/?utm_source=sponsor&utm_campaign=postgrest" target="_blank">
+          <img width="296px" src="https://raw.githubusercontent.com/PostgREST/postgrest/main/static/tembo.png">
         </a>
       </td>
     </tr>
@@ -59,5 +64,7 @@ The image is built from scratch using
 [Nix](https://nixos.org/nixpkgs/manual/#sec-pkgs-dockerTools) instead of a
 `Dockerfile`, which yields a highly secure and optimized image. This is also why
 no commands are listed in the image history. See the [PostgREST
-repository](https://github.com/PostgREST/postgrest/tree/main/nix/tools/docker) for
+respository](https://github.com/PostgREST/postgrest/tree/main/nix/tools/docker) for
 details on the build process and how to inspect the image.
+
+This does not apply to the arm64 variant, which is based on Ubuntu.

docs/_diagrams/uml/arch.uml

@@ -40,14 +40,9 @@ database "PostgreSQL" {
 
 :user:
 hexagon Proxy
-:user: .r-> Proxy : request with JWT
+:user: .r-> Proxy
 HTTPAPI <.l- Proxy
 
-hexagon ExternalAuth
-ExternalAuth -u[hidden]- Proxy
-:user: .r-> ExternalAuth : login
-:user: <.r- ExternalAuth : JWT
-
 :operator: .d-> HTTPADMIN
 :operator: .d-> CLI
 
@@ -56,18 +51,15 @@ PostgreSQL <.developer : "\t"
 Listener -r.> "PostgreSQL"
 "Connection Pool" -r.> "PostgreSQL" : "\t\t"
 
+
 note bottom of Auth
-  Validates the JWT
+  Authenticates the user request
 end note
 
 note bottom of ApiRequest
   Parses the URL syntax
 end note
 
-note bottom of Plan
-  Generates internal AST
-end note
-
 note bottom of Query
   Generates the SQL
 end note
@@ -76,19 +68,15 @@ note top of Listener
   LISTEN session
 end note
 
-url of ExternalAuth is [[../explanations/external_auth.html]]
 url of Admin is [[../references/admin_server.html#admin-server]]
 url of API is [[../explanations/schema_isolation.html]]
 url of Auth is [[../references/auth.html#authn]]
-url of ApiRequest is [[../explanations/architecture.html#api-request]]
-url of Plan is [[../explanations/architecture.html#plan]]
-url of Query is [[../explanations/architecture.html#query]]
 url of Authorization is [[../explanations/db_authz.html]]
 url of CLI is [[../references/cli.html#cli]]
 url of "Connection Pool" is [[../references/connection_pool.html]]
 url of Config is [[../references/configuration.html#configuration]]
-url of HTTPADMIN is [[../references/http_server.html]]
-url of HTTPAPI is [[../references/http_server.html]]
+url of HTTPADMIN is [[https://aosabook.org/en/posa/warp.html]]
+url of HTTPAPI is [[https://aosabook.org/en/posa/warp.html]]
 url of Listener is [[../references/listener.html#listener]]
 url of Proxy is [[../explanations/nginx.html]]
 url of "Schema Cache" is [[../references/schema_cache.html#schema-cache]]

docs/conf.py

@@ -12,6 +12,7 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
+import sys
 import os
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -48,14 +49,14 @@ source_suffix = ".rst"
 # The master toctree document.
 master_doc = "index"
 
-# This is overridden by readthedocs with the version tag anyway
-version = "16"
+# This is overriden by readthedocs with the version tag anyway
+version = "12.2"
 # To avoid repetition in <title> we set this to an empty string.
 release = ""
 
 # General information about the project.
 project = "PostgREST " + version
-author = "The PostgREST contributors"
+author = "Joe Nelson, Steve Chavez"
 copyright = "2017, " + author
 
 # The language for content autogenerated by Sphinx. Refer to documentation
@@ -113,7 +114,7 @@ html_theme = "sphinx_rtd_theme"
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-html_theme_options = {}
+html_theme_options = {"display_version": False}
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []
@@ -296,14 +297,8 @@ user_agent = (
 )
 
 linkcheck_ignore = [
-    # 403 only in CI / GitHub Actions
-    r"https://www.patreon.com/postgrest",
-    r"https://blog.frankel.ch/poor-man-api",
-    r"https://www.cybertec-postgresql.com/.*",
-    r"https://stackoverflow.com/.*",
     # Odd SSL error
     r"https://www.dripdepot.com",
-    r"https://www.euronodes.com",
     # New GitHub UI delays comment load, so anchor fails
     r"https://github.com/.*#issuecomment",
     # Random 500 Internal Server Error

docs/ecosystem.rst

@@ -6,7 +6,7 @@ Community Tutorials
 * `Building a Contacts List with PostgREST and Vue.js <https://www.youtube.com/watch?v=iHtsALtD5-U>`_ -
   In this video series, DigitalOcean shows how to build and deploy an Nginx + PostgREST(using a managed PostgreSQL database) + Vue.js webapp in an Ubuntu server droplet.
 
-* `PostgREST + Auth0: Create REST API in minutes, and add social login using Auth0 <https://samkhawase.com/blog/postgrest-1-introduction/>`_ - A step-by-step tutorial to show how to dockerize and integrate Auth0 to PostgREST service.
+* `PostgREST + Auth0: Create REST API in mintutes, and add social login using Auth0 <https://samkhawase.com/blog/postgrest/>`_ - A step-by-step tutorial to show how to dockerize and integrate Auth0 to PostgREST service.
 
 * `"CodeLess" backend using postgres, postgrest and oauth2 authentication with keycloak <https://www.mathieupassenaud.fr/codeless_backend/>`_ -
   A step-by-step tutorial for using PostgREST with KeyCloak(hosted on a managed service).
@@ -34,10 +34,9 @@ Templates
 Example Apps
 ------------
 
-* `archtika <https://github.com/thiloho/archtika>`_ - self-hosted CMS
+* `archtika <https://github.com/archtika/archtika>`_ - self‑hosted CMS
 * `delibrium-postgrest <https://gitlab.com/delibrium/delibrium-postgrest/>`_ - example school API and front-end in Vue.js
 * `ETH-transactions-storage <https://github.com/Adamant-im/ETH-transactions-storage>`_ - indexer for Ethereum to get transaction list by ETH address
-* `fullstack template <https://github.com/jenstroeger/fullstack-webapp-template>`_ - a complete fullstack webapp template using PG as db and message queue, Python and Dramatiq to implement async jobs, db migrations, test runners, and more.
 * `general <https://github.com/PierreRochard/general>`_ - example auth back-end
 * `guild-operators <https://github.com/cardano-community/koios-artifacts/tree/main/files/grest>`_ - example queries and functions that the Cardano Community uses for their Guild Operators' Repository
 * `PostGUI <https://github.com/priyank-purohit/PostGUI>`_ - React Material UI admin panel
@@ -83,7 +82,6 @@ Extensions
 Client-Side Libraries
 ---------------------
 
-* `efcore-postgrest <https://github.com/pedro-gilmora/EF.PostgREST.Provider>`_ - C#
 * `postgrest-csharp <https://github.com/supabase-community/postgrest-csharp>`_ - C#
 * `postgrest-dart <https://github.com/supabase/postgrest-dart>`_ - Dart
 * `postgrest-ex <https://github.com/supabase-community/postgrest-ex>`_ - Elixir

docs/explanations/architecture.rst

@@ -31,60 +31,65 @@ This section talks briefly about various important modules.
 Main
 ----
 
-The starting point of the program is `Main.hs <https://github.com/PostgREST/postgrest/blob/v16/src/executable/Main.hs>`_.
+The starting point of the program is `Main.hs <https://github.com/PostgREST/postgrest/blob/main/main/Main.hs>`_.
 
 CLI
 ---
 
-Main then calls `CLI.hs <https://github.com/PostgREST/postgrest/blob/v16/src/library/PostgREST/CLI.hs>`_, which is in charge of :ref:`cli`.
+Main then calls `CLI.hs <https://github.com/PostgREST/postgrest/blob/main/src/PostgREST/CLI.hs>`_, which is in charge of :ref:`cli`.
 
 App
 ---
 
-`App.hs <https://github.com/PostgREST/postgrest/blob/v16/src/library/PostgREST/App.hs>`_ is then in charge of composing the different modules.
+`App.hs <https://github.com/PostgREST/postgrest/blob/main/src/PostgREST/App.hs>`_ is then in charge of composing the different modules.
 
 Auth
 ----
 
-`Auth.hs <https://github.com/PostgREST/postgrest/blob/v16/src/library/PostgREST/Auth.hs>`_ is in charge  of :ref:`authn`.
+`Auth.hs <https://github.com/PostgREST/postgrest/blob/main/src/PostgREST/Auth.hs>`_ is in charge  of :ref:`authn`.
 
 Api Request
 -----------
 
-`ApiRequest.hs <https://github.com/PostgREST/postgrest/blob/v16/src/library/PostgREST/ApiRequest.hs>`_ is in charge of parsing the URL query string (following PostgREST syntax), the request headers, and the request body.
+`ApiRequest.hs <https://github.com/PostgREST/postgrest/blob/main/src/PostgREST/ApiRequest.hs>`_ is in charge of parsing the URL query string (following PostgREST syntax), the request headers, and the request body.
 
 A request might be rejected at this level if it's invalid. For example when providing an unknown media type to PostgREST or using an unknown HTTP method.
 
 Plan
 ----
 
-Using the Schema Cache, `Plan.hs <https://github.com/PostgREST/postgrest/blob/v16/src/library/PostgREST/Plan.hs>`_ generates an internal AST, filling out-of-band SQL details (like an ``ON CONFLICT (pk)`` clause) required to complete the user request.
+Using the Schema Cache, `Plan.hs <https://github.com/PostgREST/postgrest/blob/main/src/PostgREST/Plan.hs>`_ fills in out-of-band SQL details (like an ``ON CONFLICT (pk)`` clause) required to complete the user request.
 
 A request might be rejected at this level if it's invalid. For example when doing resource embedding on a nonexistent resource.
 
 Query
 -----
 
-`Query.hs <https://github.com/PostgREST/postgrest/blob/v16/src/library/PostgREST/Query.hs>`_ generates the SQL queries (parametrized and prepared) required to satisfy the user request.
+`Query.hs <https://github.com/PostgREST/postgrest/blob/main/src/PostgREST/Query.hs>`_ generates the SQL queries (parametrized and prepared) required to satisfy the user request.
 
 Only at this stage a connection from the pool might be used.
 
 Schema Cache
 ------------
 
-`SchemaCache.hs <https://github.com/PostgREST/postgrest/blob/v16/src/library/PostgREST/SchemaCache.hs>`_ is in charge of :ref:`schema_cache`.
+`SchemaCache.hs <https://github.com/PostgREST/postgrest/blob/main/src/PostgREST/SchemaCache.hs>`_ is in charge of :ref:`schema_cache`.
 
 Config
 ------
 
-`Config.hs <https://github.com/PostgREST/postgrest/blob/v16/src/library/PostgREST/Config.hs>`_ is in charge of :ref:`configuration`.
+`Config.hs <https://github.com/PostgREST/postgrest/blob/main/src/PostgREST/Config.hs>`_ is in charge of :ref:`configuration`.
 
 Admin
 -----
 
-`Admin.hs <https://github.com/PostgREST/postgrest/blob/v16/src/library/PostgREST/Admin.hs>`_ is in charge of the :ref:`admin_server`.
+`Admin.hs <https://github.com/PostgREST/postgrest/blob/main/src/PostgREST/Admin.hs>`_ is in charge of the :ref:`admin_server`.
+
+HTTP
+----
+
+The HTTP server is provided by `Warp <https://aosabook.org/en/posa/warp.html>`_.
 
 Listener
 --------
 
-`Reload.hs <https://github.com/PostgREST/postgrest/blob/v16/src/library/PostgREST/AppState/Reload.hs>`_ is in charge of the :ref:`listener`.
+`Listener.hs <https://github.com/PostgREST/postgrest/blob/main/src/PostgREST/Listener.hs>`_ is in charge of the :ref:`listener`.

docs/explanations/db_authz.rst

@@ -13,7 +13,7 @@ A role can be thought of as either a database user, or a group of database users
 Roles for Each Web User
 -----------------------
 
-PostgREST can accommodate either viewpoint. If you treat a role as a single user then :ref:`user_impersonation` does most of what you need. When an authenticated user makes a request PostgREST will switch into the database role for that user, which in addition to restricting queries, is available to SQL through the :code:`current_user` variable.
+PostgREST can accommodate either viewpoint. If you treat a role as a single user then the :ref:`jwt_impersonation` does most of what you need. When an authenticated user makes a request PostgREST will switch into the database role for that user, which in addition to restricting queries, is available to SQL through the :code:`current_user` variable.
 
 You can use row-level security to flexibly restrict visibility and access for the current user. Here is an `example <https://www.enterprisedb.com:443/blog/application-users-vs-row-level-security>`_ from Tomas Vondra, a chat table storing messages sent between users. Users can insert rows into it to send messages to other users, and query it to see messages sent to them by other users.
 
@@ -163,7 +163,7 @@ Another option is to define the function with the :code:`SECURITY DEFINER` optio
 
 .. code-block:: postgres
 
-  -- login as a user which has privileges on the private schemas
+  -- login as a user wich has privileges on the private schemas
 
   -- create a sample function
   create or replace function login(email text, pass text, out token text) as $$

docs/explanations/install.rst

@@ -16,11 +16,16 @@ Supported PostgreSQL versions
 =============================
 
 =============== =================================
-**Supported**   PostgreSQL >= 14
+**Supported**   PostgreSQL >= 9.6
 =============== =================================
 
-PostgREST works with all PostgreSQL versions still `officially supported <https://www.postgresql.org/support/versioning/>`_.
+PostgREST works with all PostgreSQL versions starting from 9.6.
 
+.. note::
+
+   Support for PostgreSQL versions 9.6, 10 and 11 is deprecated. From this on version onwards, PostgREST will only support non-end-of-life PostgreSQL versions.
+
+   See https://www.postgresql.org/support/versioning/.
 
 Running PostgREST
 =================
@@ -75,12 +80,8 @@ You can get the `official PostgREST Docker image <https://hub.docker.com/r/postg
 
 .. code-block:: bash
 
-  # pull the latest version
   docker pull postgrest/postgrest
 
-  # to pull a particular version, use one of the versions on https://hub.docker.com/r/postgrest/postgrest/tags
-  docker pull postgrest/postgrest:<version>
-
 To configure the container image, use :ref:`env_variables_config`.
 
 There are two ways to run the PostgREST container: with an existing external database, or through docker-compose.
@@ -146,7 +147,6 @@ To avoid having to install the database at all, you can run both it and the serv
       ports:
         - "3000:3000"
       environment:
-        PGRST_SERVER_HOST: 0.0.0.0 # necessary for `postgrest --ready` flag to work
         PGRST_DB_URI: postgres://app_user:password@db:5432/app_db
         PGRST_OPENAPI_SERVER_PROXY_URI: http://127.0.0.1:3000
       depends_on:
@@ -181,23 +181,6 @@ If you want to have a visual overview of your API in your browser you can add sw
 
 With this you can see the swagger-ui in your browser on port 8080.
 
-.. _docker_cpu_contraint:
-
-Docker Resource Constraints
----------------------------
-
-PostgREST does not support ``--cpus`` `constraint option <https://docs.docker.com/engine/containers/resource_constraints/#configure-the-default-cfs-scheduler>`_.
-
-As a workaround, you may use the `GHC RTS <https://ghc.gitlab.haskell.org/ghc/doc/users_guide/runtime_control.html#runtime-system-rts-options>`_ ``-N`` option. For instance, to limit it to 2 CPU cores, do:
-
-.. code::
-
-  # Set environment variable GHCRTS set to "-N2"
-  docker run --rm -p 3000:3000 \
-    -e PGRST_DB_URI="postgres://app_user:password@10.0.0.10/postgres" \
-    -e GHCRTS="-N2"
-    postgrest/postgrest
-
 .. _build_source:
 
 Building from Source

docs/how-tos/debugging-performance-with-pg-stat-statements.rst

@@ -1,62 +0,0 @@
-.. _debugging_performance_pg_stat_statements:
-
-Debugging Performance with pg_stat_statements
-=============================================
-
-This how-to shows how to get a query identifier through PostgREST and then use it to inspect the same query in ``pg_stat_statements``.
-
-.. important::
-
-  - :ref:`db-plan-enabled` must be enabled in PostgREST.
-  - PostgreSQL 14 or newer with ``pg_stat_statements`` available.
-
-Get the Query Identifier from PostgREST
----------------------------------------
-
-Request the plan in JSON format with the ``verbose`` option:
-
-.. code-block:: bash
-
-   curl "http://localhost:3000/projects?select=id,name&order=id" \
-     -H "Accept: application/vnd.pgrst.plan+json; options=verbose"
-
-The response will contain a top-level ``Query Identifier`` field:
-
-.. code-block:: json
-
-   [
-     {
-       "Plan": {
-         "Node Type": "Aggregate"
-       },
-       "Query Identifier": -432192689578025496
-     }
-   ]
-
-Look up the query in pg_stat_statements
----------------------------------------
-
-Use that identifier against ``pg_stat_statements``:
-
-.. code-block:: postgres
-
-   select
-     calls,
-     total_exec_time,
-     mean_exec_time,
-     rows,
-     query
-   from pg_stat_statements
-   where queryid = -432192689578025496;
-
-.. csv-table::
-   :header: "calls", "total_exec_time", "mean_exec_time", "rows", "query"
-
-   "13", "0.6355850000000001", "0.04889115384615385", "13", "WITH pgrst_source AS (...)"
-
-This lets you correlate a PostgREST request with PostgreSQL runtime statistics such as:
-
-- how often the query ran
-- total and average execution time
-- how many rows it produced
-- the normalized SQL text recorded by PostgreSQL

docs/how-tos/sql-user-management-using-postgres-users-and-passwords.rst

@@ -43,7 +43,7 @@ As in :ref:`sql_user_management`, we create the :code:`pgcrypto` and :code:`pgjw
   CREATE EXTENSION pgcrypto WITH SCHEMA ext_pgcrypto;
 
 
-Concerning the `pgjwt extension <https://github.com/michelp/pgjwt>`_, please cf. to :ref:`jwt-from-sql`.
+Concerning the `pgjwt extension <https://github.com/michelp/pgjwt>`_, please cf. to :ref:`client_auth`.
 
 .. code-block:: postgres
 
@@ -157,7 +157,7 @@ Here we use the username instead of the email address to identify a user.
 Logins
 ~~~~~~
 
-As described in :ref:`jwt-from-sql`, we'll create a JWT token inside our login function. Note that you'll need to adjust the secret key which is hard-coded in this example to a secure (at least thirty-two character) secret of your choosing.
+As described in :ref:`client_auth`, we'll create a JWT token inside our login function. Note that you'll need to adjust the secret key which is hard-coded in this example to a secure (at least thirty-two character) secret of your choosing.
 
 
 .. code-block:: postgres

docs/how-tos/sql-user-management.rst

@@ -3,7 +3,7 @@
 SQL User Management
 ===================
 
-As mentioned on :ref:`jwt_generation`, an external service can provide user management and coordinate with the PostgREST server using JWT. It's also possible to support logins entirely through SQL. It's a fair bit of work, so get ready.
+As mentioned on :ref:`jwt_generation`, an external service can provide user management and coordinate with the PostgREST server using JWT. It’s also possible to support logins entirely through SQL. It’s a fair bit of work, so get ready.
 
 Storing Users and Passwords
 ---------------------------
@@ -110,8 +110,6 @@ Then, add ``db-anon-role`` to the configuration file to allow anonymous requests
 
   db-anon-role = "anon"
 
-.. _jwt-from-sql:
-
 JWT from SQL
 ~~~~~~~~~~~~
 

docs/how-tos/working-with-postgresql-data-types.rst

@@ -318,6 +318,144 @@ You can insert a new product using a JSON object for the ``extra_info`` column:
 
 To query and filter the data see :ref:`json_columns` for a complete reference.
 
+.. _ww_postgis:
+
+PostGIS
+-------
+
+You can use the string representation for `PostGIS <https://postgis.net/>`_ data types such as ``geometry`` or ``geography`` (you need to `install PostGIS <https://postgis.net/documentation/getting_started/>`_ first).
+
+.. code-block:: postgres
+
+  -- Activate the postgis module in the current database
+  create extension if not exists postgis;
+
+  create table coverage (
+    id int primary key,
+    name text unique,
+    area geometry
+  );
+
+To add areas in polygon format, you can use string representation:
+
+.. code-block:: bash
+
+  curl "http://localhost:3000/coverage" \
+    -X POST -H "Content-Type: application/json" \
+    -d @- << EOF
+    [
+      { "id": 1, "name": "small", "area": "SRID=4326;POLYGON((0 0, 1 0, 1 1, 0 1, 0 0))" },
+      { "id": 2, "name": "big", "area": "SRID=4326;POLYGON((0 0, 10 0, 10 10, 0 10, 0 0))" }
+    ]
+  EOF
+
+Now, when you request the information, PostgREST will automatically cast the ``area`` column into a ``Polygon`` geometry type. Although this is useful, you may need the whole output to be in `GeoJSON <https://geojson.org/>`_ format out of the box, which can be done by including the ``Accept: application/geo+json`` in the request. This will work for PostGIS versions 3.0.0 and up and will return the output as a `FeatureCollection Object <https://www.rfc-editor.org/rfc/rfc7946#section-3.3>`_:
+
+.. code-block:: bash
+
+  curl "http://localhost:3000/coverage" \
+    -H "Accept: application/geo+json"
+
+.. code-block:: json
+
+  {
+    "type": "FeatureCollection",
+    "features": [
+      {
+        "type": "Feature",
+        "geometry": {
+          "type": "Polygon",
+          "coordinates": [
+            [[0,0],[1,0],[1,1],[0,1],[0,0]]
+          ]
+        },
+        "properties": {
+          "id": 1,
+          "name": "small"
+        }
+      },
+      {
+        "type": "Feature",
+        "geometry": {
+          "type": "Polygon",
+          "coordinates": [
+            [[0,0],[10,0],[10,10],[0,10],[0,0]]
+          ]
+        },
+        "properties": {
+          "id": 2,
+          "name": "big"
+        }
+      }
+    ]
+  }
+
+If you need to add an extra property, like the area in square units by using ``st_area(area)``, you could add a generated column to the table and it will appear in the ``properties`` key of each ``Feature``.
+
+.. code-block:: postgres
+
+  alter table coverage
+    add square_units double precision generated always as ( st_area(area) ) stored;
+
+In the case that you are using older PostGIS versions, then creating a function is your best option:
+
+.. code-block:: postgres
+
+  create or replace function coverage_geo_collection() returns json as $$
+    select
+      json_build_object(
+        'type', 'FeatureCollection',
+        'features', json_agg(
+          json_build_object(
+            'type', 'Feature',
+            'geometry', st_AsGeoJSON(c.area)::json,
+            'properties', json_build_object('id', c.id, 'name', c.name)
+          )
+        )
+      )
+    from coverage c;
+  $$ language sql;
+
+Now this query will return the same results:
+
+.. code-block:: bash
+
+  curl "http://localhost:3000/rpc/coverage_geo_collection"
+
+.. code-block:: json
+
+  {
+    "type": "FeatureCollection",
+    "features": [
+      {
+        "type": "Feature",
+        "geometry": {
+          "type": "Polygon",
+          "coordinates": [
+            [[0,0],[1,0],[1,1],[0,1],[0,0]]
+          ]
+        },
+        "properties": {
+          "id": 1,
+          "name": "small"
+        }
+      },
+      {
+        "type": "Feature",
+        "geometry": {
+          "type": "Polygon",
+          "coordinates": [
+            [[0,0],[10,0],[10,10],[0,10],[0,0]]
+          ]
+        },
+        "properties": {
+          "id": 2,
+          "name": "big"
+        }
+      }
+    ]
+  }
+
 Ranges
 ------
 
@@ -471,20 +609,3 @@ You can use other comparative filters and also all the `PostgreSQL special date/
       "due_date": "2022-02-27T06:00:00-05:00"
     }
   ]
-
-.. raw:: html
-
-  <script type="text/javascript">
-    let hash = window.location.hash;
-
-    const redirects = {
-      // PostGIS
-      '#postgis': '../integrations/postgis.html#postgis',
-    };
-
-    let willRedirectTo = redirects[hash];
-
-    if (willRedirectTo) {
-      window.location.href = willRedirectTo;
-    }
-  </script>

docs/index.rst

@@ -38,53 +38,49 @@ Sponsors
     .. image:: ../static/cybertec.svg
       :target: https://www.cybertec-postgresql.com/en/?utm_source=postgrest.org&utm_medium=referral&utm_campaign=postgrest
 
-  .. container:: img-dark
-
-    .. image:: ../static/supabase-dark.svg
-      :target: https://supabase.com/?utm_source=postgrest%20backers&utm_medium=open%20source%20partner&utm_campaign=postgrest%20backers%20github&utm_term=homepage
-
-  .. container:: img-light
-
-    .. image:: ../static/supabase.svg
-      :target: https://supabase.com/?utm_source=postgrest%20backers&utm_medium=open%20source%20partner&utm_campaign=postgrest%20backers%20github&utm_term=homepage
+  .. image:: ../static/gnuhost.png
+    :target: https://euronodes.com/?utm_source=sponsor&utm_campaign=postgrest
 
   .. container:: img-dark
 
-    .. image:: ../static/euronodes.svg
-      :target: https://www.euronodes.com/postgrest
+    .. image:: ../static/neon-dark.jpg
+      :target: https://neon.tech/?utm_source=sponsor&utm_campaign=postgrest
 
   .. container:: img-light
 
-    .. image:: ../static/euronodes.svg
-      :target: https://www.euronodes.com/postgrest
+    .. image:: ../static/neon.jpg
+      :target: https://neon.tech/?utm_source=sponsor&utm_campaign=postgrest
 
   |
 
   .. container:: img-dark
 
-    .. image:: ../static/neon-dark.jpg
-      :target: https://neon.com/?utm_source=sponsor&utm_campaign=postgrest
+    .. image:: ../static/code-build-dark.png
+      :target: https://code.build/?utm_source=sponsor&utm_campaign=postgrest
 
   .. container:: img-light
 
-    .. image:: ../static/neon.jpg
-      :target: https://neon.com/?utm_source=sponsor&utm_campaign=postgrest
+    .. image:: ../static/code-build.png
+      :target: https://code.build/?utm_source=sponsor&utm_campaign=postgrest
 
   .. container:: img-dark
 
-    .. image:: ../static/bytebase-dark.svg
-      :target: https://www.bytebase.com/?utm_source=sponsor&utm_campaign=postgrest
+    .. image:: ../static/supabase-dark.png
+      :target: https://supabase.com/?utm_source=postgrest%20backers&utm_medium=open%20source%20partner&utm_campaign=postgrest%20backers%20github&utm_term=homepage
 
   .. container:: img-light
 
-    .. image:: ../static/bytebase.svg
-      :target: https://www.bytebase.com/?utm_source=sponsor&utm_campaign=postgrest
+    .. image:: ../static/supabase.png
+      :target: https://supabase.com/?utm_source=postgrest%20backers&utm_medium=open%20source%20partner&utm_campaign=postgrest%20backers%20github&utm_term=homepage
+
+  .. image:: ../static/tembo.png
+    :target: https://tembo.io/?utm_source=sponsor&utm_campaign=postgrest
 
   .. The static/empty.png(created with `convert -size 320x95 xc:#fcfcfc empty.png`) is an ugly workaround
      to create space and center the logos. It's not easy to layout with restructuredText.
 
-  .. image:: _static/empty.png
-    :target: #sponsors
+  .. .. image:: _static/empty.png
+       :target: #sponsors
 
 |
 
@@ -113,20 +109,10 @@ Getting Support
 
 The project has a friendly and growing community. For discussions, use the Github `discussions page <https://github.com/PostgREST/postgrest/discussions>`_. You can also report or search for bugs/features on the Github `issues <https://github.com/PostgREST/postgrest/issues>`_ page.
 
-Releases
---------
+Release Notes
+-------------
 
-PostgREST follows ``MAJOR.PATCH`` two-part versioning:
-
-- ``MAJOR``: feature release, may deprecate or remove things.
-- ``PATCH``: fix/security release only, no features and no behavior changes.
-
-MAJOR releases are published twice a year, with their scope and target dates tracked through `GitHub milestones <https://github.com/PostgREST/postgrest/milestones>`_.
-PATCH releases are published on an as-needed basis.
-
-Starting from ``v14.0``, only even-numbered MAJOR versions are released, reserving odd-numbered MAJOR versions for development.
-
-All releases are published on `PostgREST's GitHub release page <https://github.com/PostgREST/postgrest/releases>`_, along with the corresponding upgrade guides.
+The release notes are published on `PostgREST's GitHub release page <https://github.com/PostgREST/postgrest/releases>`_.
 
 Tutorials
 ---------
@@ -223,14 +209,20 @@ In Production
 Here are some companies that use PostgREST in production.
 
 * `Catarse <https://www.catarse.me>`_
+* `Datrium <https://www.datrium.com>`_
 * `Drip Depot <https://www.dripdepot.com>`_
 * `Image-charts <https://www.image-charts.com>`_
+* `Moat <https://www.oracle.com/advertising/>`_
 * `Netwo <https://www.netwo.io>`_
 * `Nimbus <https://www.nimbusfacility.com/sg/home>`_
   - See how Nimbus uses PostgREST in `Paul Copplestone's blog post <https://paul.copplest.one/blog/nimbus-tech-2019-04.html>`_.
 * `OpenBooking <https://openbooking.ch>`_
 * `Supabase <https://supabase.com>`_
 
+.. Failing links
+  * `eGull <http://www.egull.co>`_
+  * `MotionDynamic - Fast highly dynamic video generation at scale <https://motiondynamic.tech>`_
+
 Testimonials
 ------------
 
@@ -274,21 +266,4 @@ Testimonials
 Contributing
 ------------
 
-Please see the `Contributing guidelines <https://github.com/PostgREST/postgrest/blob/main/CONTRIBUTING.md>`_ in the main PostgREST repository.
-
-.. raw:: html
-
-  <script type="text/javascript">
-    let hash = window.location.hash;
-
-    const redirects = {
-      // Tables and Views
-      '#release-notes': '#releases',
-    };
-
-    let willRedirectTo = redirects[hash];
-
-    if (willRedirectTo) {
-      window.location.href = willRedirectTo;
-    }
-  </script>
+Please see the `Contributing guidelines <https://github.com/PostgREST/postgrest/blob/main/.github/CONTRIBUTING.md>`_ in the main PostgREST repository.

docs/integrations/greenplum.rst

@@ -0,0 +1,6 @@
+Greenplum
+#########
+
+`Greenplum <https://blogs.vmware.com/tanzu/tanzu-greenplum/>`_ has been reported to work by adding ``LOGIN`` to the :ref:`anonymous and user roles <roles>`.
+
+For more details, see https://github.com/PostgREST/postgrest/issues/2021.

docs/integrations/jwt_gen.rst

@@ -1,6 +1,6 @@
-.. _external_auth:
+.. _external_jwt:
 
-External Authentication
+External JWT Generation
 -----------------------
 
 JWT from Auth0

docs/integrations/nixos.rst

@@ -1,36 +0,0 @@
-NixOS
-=====
-
-Nixpkgs contains a `NixOS module to run PostgREST <https://search.nixos.org/options?channel=unstable&query=services.postgrest&type=options>`_, which can be enabled with ``services.postgrest.enable = true``.
-
-A PostgreSQL server can be enabled on the same machine with ``services.postgresql.enable = true``. Connections will use the name of the system user as user and database names by default, in this case ``postgrest``.
-
-A minimal example could look like this:
-
-.. code-block:: nix
-
-  {
-    pkgs,
-    ...
-  }:
-
-  {
-    services.postgresql = {
-      enable = true;
-      initialScript = pkgs.writeText "init.sql" ''
-        CREATE ROLE postgrest LOGIN NOINHERIT;
-        CREATE ROLE anon ROLE postgrest;
-      '';
-    };
-
-    services.postgrest = {
-      enable = true;
-      settings.db-anon-role = "anon";
-      settings.db-uri.dbname = "postgres";
-    };
-  }
-
-This will expose the PostgREST server on localhost on the NixOS machine and allow anonymous access.
-
-.. tip::
-  NixOS also allows to quickly spin up different PostgreSQL versions or even forks this way. For example, to test the current beta version of `OrioleDB <https://www.orioledb.com>`_, use ``services.postgresql.package = pkgs.orioledb``.

docs/integrations/postgis.rst

@@ -1,154 +0,0 @@
-.. _ww_postgis:
-
-PostGIS
-=======
-
-To work with `PostGIS <https://postgis.net/>`_ data types such as ``geometry`` or ``geography``, you'll need to `install PostGIS <https://postgis.net/documentation/getting_started/>`_ first.
-
-.. code-block:: postgres
-
-  -- Activate the postgis module in the current database
-  create extension if not exists postgis;
-
-  create table coverage (
-    id int primary key,
-    name text unique,
-    area geometry
-  );
-
-  insert into coverage (id, name, area) values
-    (1, 'small', ST_GeomFromText('POLYGON((0 0, 1 0, 1 1, 0 1, 0 0))',4326)),
-    (2, 'big', ST_GeomFromText('POLYGON((0 0, 10 0, 10 10, 0 10, 0 0))', 4326);
-
-.. _application/geo+json:
-
-``application/geo+json``
-------------------------
-
-PostgREST supports the `standard <https://www.iana.org/assignments/media-types/application/geo+json>`_ ``application/geo+json`` media type which can be used to get the output in `GeoJSON <https://geojson.org/>`_ format. This will work for PostGIS versions 3.0.0 and up and will return the output as a `FeatureCollection Object <https://www.rfc-editor.org/rfc/rfc7946#section-3.3>`_:
-
-.. code-block:: bash
-
-  curl "http://localhost:3000/coverage" \
-    -H "Accept: application/geo+json"
-
-.. code-block:: json
-
-  {
-    "type": "FeatureCollection",
-    "features": [
-      {
-        "type": "Feature",
-        "geometry": {
-          "type": "Polygon",
-          "coordinates": [
-            [[0,0],[1,0],[1,1],[0,1],[0,0]]
-          ]
-        },
-        "properties": {
-          "id": 1,
-          "name": "small"
-        }
-      },
-      {
-        "type": "Feature",
-        "geometry": {
-          "type": "Polygon",
-          "coordinates": [
-            [[0,0],[10,0],[10,10],[0,10],[0,0]]
-          ]
-        },
-        "properties": {
-          "id": 2,
-          "name": "big"
-        }
-      }
-    ]
-  }
-
-Using generated columns
------------------------
-
-If you need to add an extra property, like the area in square units by using ``st_area(area)``, you could add a generated column to the table and it will appear in the ``properties`` key of each ``Feature``.
-
-.. code-block:: postgres
-
-  alter table coverage
-    add square_units double precision generated always as ( st_area(area) ) stored;
-
-In the case that you are using older PostGIS versions, then creating a function is your best option:
-
-.. code-block:: postgres
-
-  create or replace function coverage_geo_collection() returns json as $$
-    select
-      json_build_object(
-        'type', 'FeatureCollection',
-        'features', json_agg(
-          json_build_object(
-            'type', 'Feature',
-            'geometry', st_AsGeoJSON(c.area)::json,
-            'properties', json_build_object('id', c.id, 'name', c.name)
-          )
-        )
-      )
-    from coverage c;
-  $$ language sql;
-
-Now this query will return the same results:
-
-.. code-block:: bash
-
-  curl "http://localhost:3000/rpc/coverage_geo_collection"
-
-.. code-block:: json
-
-  {
-    "type": "FeatureCollection",
-    "features": [
-      {
-        "type": "Feature",
-        "geometry": {
-          "type": "Polygon",
-          "coordinates": [
-            [[0,0],[1,0],[1,1],[0,1],[0,0]]
-          ]
-        },
-        "properties": {
-          "id": 1,
-          "name": "small"
-        }
-      },
-      {
-        "type": "Feature",
-        "geometry": {
-          "type": "Polygon",
-          "coordinates": [
-            [[0,0],[10,0],[10,10],[0,10],[0,0]]
-          ]
-        },
-        "properties": {
-          "id": 2,
-          "name": "big"
-        }
-      }
-    ]
-  }
-
-Using string representation
----------------------------
-
-To insert areas in polygon format, you can use string representation:
-
-.. code-block:: bash
-
-  curl "http://localhost:3000/coverage" \
-    -X POST -H "Content-Type: application/json" \
-    -d @- << EOF
-    [
-      { "id": 3, "name": "strip", "area": "SRID=4326;POLYGON((0 0, 50 0, 50 2, 0 2, 0 0))" },
-      { "id": 4, "name": "diamond", "area": "SRID=4326;POLYGON((5 0, 10 5, 5 10, 0 5, 5 0))" }
-    ]
-  EOF
-
-PostgREST will automatically cast the ``area`` column into a ``Polygon`` geometry type. 

docs/postgrest.dict

@@ -1,11 +1,8 @@
 personal_ws-1.1 en 0 utf-8
 api
-autoscaling
 API's
 APIs
 APISIX
-AST
-async
 aud
 Auth
 auth
@@ -16,7 +13,6 @@ BOM
 Bytea
 Cardano
 cd
-CDNs
 centric
 CLI
 CMS
@@ -32,12 +28,9 @@ durations
 DDL
 DOM
 DevOps
-Dramatiq
 dockerize
 enum
-ECS
 Enums
-Entra
 eq
 ETH
 Ethereum
@@ -45,14 +38,12 @@ EveryLayout
 filename
 FreeBSD
 fts
-fullstack
-GC
 GeoJSON
-GHC
 Github
 Google
 grantor
 GraphQL
+Greenplum
 gte
 GUC
 Haskell
@@ -80,7 +71,6 @@ JSON
 JWK
 JWT
 jwt
-Keycloak
 Kubernetes
 localhost
 login
@@ -99,17 +89,15 @@ namespaced
 Nanos
 neq
 nginx
-NixOS
 nixpkgs
 npm
 nxl
 nxr
 OAuth
-ORM
 Observability
-Okta
 OpenAPI
 openapi
+ORM
 ov
 parametrized
 passphrase
@@ -145,13 +133,11 @@ Redux
 refactor
 reloadable
 Reloadable
-reuseport
 requester's
 RESTful
 RLS
 RPC
 RSA
-RTS
 safeupdate
 savepoint
 schemas
@@ -183,7 +169,6 @@ unikernel
 unix
 updatable
 unfulfillable
-unselected
 Untyped
 UPSERT
 Upsert
@@ -197,12 +182,9 @@ verifier
 versioning
 Vondra
 Vue
-webapp
 webhooks
 websearch
 Websockets
 webuser
 wfts
 www
-debouncing
-deduplicates

docs/references/admin_server.rst

@@ -3,9 +3,7 @@
 Admin Server
 ############
 
-PostgREST provides an admin server that can be enabled by setting :ref:`admin-server-port` or :ref:`admin-server-unix-socket`.
-
-Multiple PostgREST instances can share the same public API host and port when :ref:`server-reuseport` is enabled. Admin ports are not shared: give each instance a different :ref:`admin-server-port`, otherwise the new instance will fail to start.
+PostgREST provides an admin server that can be enabled by setting :ref:`admin-server-port`.
 
 .. _health_check:
 
@@ -14,7 +12,7 @@ Health Check
 
 You can enable a health check to verify if PostgREST is available for client requests. Also to check the status of its internal state.
 
-Two endpoints ``live`` and ``ready`` will then be available. Both these endpoints reply with a status code and empty response body.
+Two endpoints ``live`` and ``ready`` will then be available.
 
 .. important::
 
@@ -57,6 +55,23 @@ Metrics
 
 Provides :ref:`metrics`.
 
+Runtime Configuration
+=====================
+
+Provides a ``config`` endpoint that returns the runtime :ref:`configuration`.
+
+.. code-block:: bash
+
+  curl "http://localhost:3001/config"
+
+.. code-block::
+
+  db-aggregates-enabled = false
+  db-anon-role = "web_anon"
+  db-channel = "pgrst"
+  db-channel-enabled = false
+  ...
+
 Runtime Schema Cache
 ====================
 
@@ -74,4 +89,5 @@ Provides the ``schema_cache`` endpoint that prints the runtime :ref:`schema_cach
     "dbRepresentations": ["..."],
     "dbRoutines": ["..."],
     "dbTables": ["..."],
+    "dbTimezones": ["..."]
   }

docs/references/api.rst

@@ -21,7 +21,6 @@ PostgREST exposes three database objects of a schema as resources: tables, views
    api/aggregate_functions.rst
    api/openapi.rst
    api/preferences.rst
-   api/vary_header.rst
    api/*
 
 .. raw:: html

docs/references/api/aggregate_functions.rst

@@ -225,10 +225,10 @@ If we also want to get the total ``amount`` grouped by the ``order_date`` of the
 Note that the aggregate is done within the embedded resource ``orders``.
 It is not affected by any of the columns from the top-level relationship ``customers``.
 
-Aggregates in To-One Spreads
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Using Aggregates in Spreads
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-All the aggregates inside a :ref:`one-to-one or many-to-one spread embedded resource <spread_to_one_embed>` will be hoisted to the top-level relationship.
+All the aggregates inside a :ref:`spread embedded resource <spread_embed>` will be hoisted to the top-level relationship.
 In other words, it will behave as if the aggregate was done in the top-level relationship itself. For example:
 
 .. code-block:: bash
@@ -251,7 +251,3 @@ This will take the ``max`` and ``min`` subscription date of every customer and g
       "min": "2016-02-11"
     }
   ]
-
-.. note::
-
-  Aggregates inside to-many spreads are not supported

docs/references/api/domain_representations.rst

@@ -173,4 +173,4 @@ Domain Representations avoid all the above drawbacks. Their only drawback is tha
 
   Why not create a `base type <https://www.postgresql.org/docs/current/sql-createtype.html#id-1.9.3.94.5.8>`_ instead? ``CREATE TYPE app_uuid (INTERNALLENGTH = 22, INPUT = app_uuid_parser, OUTPUT = app_uuid_formatter)``.
 
-  Creating base types need superuser, which is restricted on cloud hosted databases. Additionally this way lets "how the data is presented" dictate "how the data is stored" which would be backwards.
+  Creating base types need superuser, which is restricted on cloud hosted databases. Additionally this way lets “how the data is presented” dictate “how the data is stored” which would be backwards.

docs/references/api/functions.rst

@@ -69,26 +69,6 @@ If the function doesn't modify the database, it will also run under the GET meth
 
 The function parameter names match the JSON object keys in the POST case, for the GET case they match the query parameters ``?a=1&b=2``.
 
-If the function is defined to have default values for the parameters then arguments for these parameters can be omitted in the request. For instance:
-
-.. code-block:: postgres
-
-  CREATE FUNCTION greet_user(username TEXT DEFAULT 'guest')
-  RETURNS TEXT AS $$
-    SELECT 'Hello ' || username || '!';
-  $$ LANGUAGE SQL IMMUTABLE;
-
-.. code-block:: bash
-
-  curl -i "http://localhost:3000/rpc/greet_user"
-
-.. code-block:: http
-
-  HTTP/1.1 200 OK
-  Context-Type: application/json; charset=utf-8
-
-  "Hello guest!"
-
 .. _function_single_json:
 
 Functions with an array of JSON objects
@@ -151,6 +131,10 @@ For this the ``Content-Type: application/json`` header must be included in the r
 
  If an overloaded function has a single ``json`` or ``jsonb`` unnamed parameter, PostgREST will call this function as a fallback provided that no other overloaded function is found with the parameters sent in the POST request.
 
+.. warning::
+
+ Sending the JSON request body as a single argument is also possible with :ref:`Prefer: params=single-object <prefer_params>` but this method is **deprecated**.
+
 .. _function_single_unnamed:
 
 Functions with a single unnamed parameter
@@ -314,23 +298,6 @@ Let's get its :ref:`explain_plan` when calling it with filters applied:
 
 Notice there's no "Function Scan" node in the plan, which tells us it has been inlined.
 
-Horizontal Filtering
-~~~~~~~~~~~~~~~~~~~~
-
-Table-valued functions support horizontal filtering on selected and unselected columns.
-
-For example, the following RPC with filter on unselected column returns:
-
-.. code-block:: bash
-
-  curl "http://localhost:3000/rpc/getallprojects?select=id,client_id&name=like.OSX"
-
-.. code-block:: json
-
-  [
-    { "id": 4, "client_id": 2 }
-  ]
-
 .. _scalar_functions:
 
 Scalar functions

docs/references/api/media_type_handlers.rst

@@ -15,7 +15,7 @@ Using these domains, :ref:`functions <functions>` can become handlers and `user-
 
 .. important::
 
-  - PostgREST vendor media types (``application/vnd.pgrst.plan``, ``application/vnd.pgrst.object`` and ``application/vnd.pgrst.array``) cannot be overridden.
+  - PostgREST vendor media types (``application/vnd.pgrst.plan``, ``application/vnd.pgrst.object`` and ``application/vnd.pgrst.array``) cannot be overriden.
   - Long media types like ``application/vnd.openxmlformats-officedocument.wordprocessingml.document`` cannot be expressed as domains since they surpass `PostgreSQL identifier length <https://www.postgresql.org/docs/current/limits.html#LIMITS-TABLE>`_.
     For these you can use the :ref:`any_handler`.
 

docs/references/api/openapi.rst

@@ -9,8 +9,6 @@ PostgREST automatically serves a full `OpenAPI <https://www.openapis.org/>`_ des
 
   By default, this output depends on the permissions of the role that is contained in the JWT role claim (or the :ref:`db-anon-role` if no JWT is sent). If you need to show all the endpoints disregarding the role's permissions, set the :ref:`openapi-mode` config to :code:`ignore-privileges`.
 
-  When following privileges, the output reflects both the granted HTTP methods and columns: a relation with only ``SELECT`` will only expose ``GET``, a relation with only ``INSERT`` will only expose ``POST``, and column-level grants limit the columns shown on the table definitions and row filters.
-
 For extra customization, the OpenAPI output contains a "description" field for every `SQL comment <https://www.postgresql.org/docs/current/sql-comment.html>`_ on any database object. For instance,
 
 .. code-block:: postgres
@@ -21,9 +19,6 @@ For extra customization, the OpenAPI output contains a "description" field for e
   COMMENT ON TABLE monotremes IS
     'Freakish mammals lay the best eggs for breakfast';
 
-  COMMENT ON VIEW monotremes_v IS
-    'Only the platypus is publicly visible';
-
   COMMENT ON COLUMN monotremes.has_venomous_claw IS
     'Sometimes breakfast is not worth it';
 

docs/references/api/preferences.rst

@@ -15,6 +15,7 @@ The following preferences are supported.
 - ``Prefer: missing``. See :ref:`prefer_missing`.
 - ``Prefer: max-affected``, See :ref:`prefer_max_affected`.
 - ``Prefer: tx``. See :ref:`prefer_tx`.
+- ``Prefer: params``. See :ref:`prefer_params`.
 
 .. _prefer_handling:
 
@@ -62,12 +63,8 @@ The server ignores unrecognized or unfulfillable preferences by default. You can
 Timezone
 ========
 
-.. important::
+The ``timezone`` preference allows you to change the `PostgreSQL timezone <https://www.postgresql.org/docs/current/runtime-config-client.html#GUC-TIMEZONE>`_. It accepts all time zones in `pg_timezone_names <https://www.postgresql.org/docs/current/view-pg-timezone-names.html>`_.
 
-  ``handling=lenient`` is ignored for ``timezone``. Invalid time zones always return an error.
-
-The ``timezone`` preference allows you to change the `PostgreSQL timezone <https://www.postgresql.org/docs/current/runtime-config-client.html#GUC-TIMEZONE>`_.
-It accepts all time zones in `pg_timezone_names <https://www.postgresql.org/docs/current/view-pg-timezone-names.html>`_ and numeric offsets.
 
 .. code-block:: bash
 
@@ -88,36 +85,35 @@ It accepts all time zones in `pg_timezone_names <https://www.postgresql.org/docs
     {"t":"2023-10-18T09:37:59.611-07:00"}
   ]
 
-Offsets are also accepted:
-
-.. code-block:: bash
-
-  curl -i "http://localhost:3000/timestamps" \
-    -H "Prefer: timezone=05:30"
-
-.. code-block:: http
-
-  HTTP/1.1 200 OK
-  Content-Type: application/json; charset=utf-8
-  Preference-Applied: timezone=05:30
-
-.. code-block:: json
-
-  [
-    {"t":"2023-10-18T17:07:59.611+05:30"},
-    {"t":"2023-10-18T19:07:59.611+05:30"},
-    {"t":"2023-10-18T21:07:59.611+05:30"}
-  ]
-
-You can also use negative offsets like ``-03:00``.
-
-For an invalid time zone, PostgREST returns a database error.
+For an invalid time zone, PostgREST returns values with the default time zone (configured on ``postgresql.conf`` or as a setting on the :ref:`authenticator <roles>`).
 
 .. code-block:: bash
 
   curl -i "http://localhost:3000/timestamps" \
     -H "Prefer: timezone=Jupiter/Red_Spot"
 
+.. code-block:: http
+
+  HTTP/1.1 200 OK
+  Content-Type: application/json; charset=utf-8
+
+.. code-block:: json
+
+  [
+    {"t":"2023-10-18T12:37:59.611+00:00"},
+    {"t":"2023-10-18T14:37:59.611+00:00"},
+    {"t":"2023-10-18T16:37:59.611+00:00"}
+  ]
+
+Note that there's no ``Preference-Applied`` in the response.
+
+However, with ``handling=strict``, an invalid time zone preference will throw an :ref:`error <pgrst122>`.
+
+.. code-block:: bash
+
+  curl -i "http://localhost:3000/timestamps" \
+    -H "Prefer: handling=strict, timezone=Jupiter/Red_Spot"
+
 .. code-block:: http
 
   HTTP/1.1 400 Bad Request
@@ -247,7 +243,7 @@ Will result in:
 Max Affected
 ============
 
-You can set a limit to the amount of resources affected in a request by sending ``max-affected`` preference. This feature works in combination with ``handling=strict`` preference. ``max-affected`` would be ignored with lenient handling. The "affected resources" are the number of rows returned by ``DELETE`` and ``PATCH`` requests.
+You can set a limit to the amount of resources affected in a request by sending ``max-affected`` preference. This feature works in combination with ``handling=strict`` preference. ``max-affected`` would be ignored with lenient handling. The "affected resources" are the number of rows returned by ``DELETE`` and ``PATCH`` requests. This is also supported through ``RPC`` calls.
 
 To illustrate the use of this preference, consider the following scenario where the ``items`` table contains 14 rows.
 
@@ -270,34 +266,30 @@ To illustrate the use of this preference, consider the following scenario where
       "hint": null
   }
 
-With :ref:`RPC <functions>`, the preference is honored completely on the basis of the number of rows returned in the result set of the function. This can be useful for complex mutation queries using `data-modifying statements <https://www.postgresql.org/docs/current/queries-with.html#QUERIES-WITH-MODIFYING>`_. A simple example:
+.. _prefer_params:
+
+Single JSON object as Function Parameter
+----------------------------------------
+
+.. warning::
+
+  Using this preference is **deprecated** in favor of :ref:`function_single_json`.
+
+:code:`Prefer: params=single-object` allows sending the JSON request body as the single argument of a :ref:`function <functions>`.
 
 .. code-block:: postgres
 
-  CREATE FUNCTION test.delete_items()
-  RETURNS SETOF items AS $$
-    DELETE FROM items WHERE id < 15 RETURNING *;
+  CREATE FUNCTION mult_them(param json) RETURNS int AS $$
+    SELECT (param->>'x')::int * (param->>'y')::int
   $$ LANGUAGE SQL;
 
 .. code-block:: bash
 
-  curl -i "http://localhost:3000/rpc/delete_items" \
-    -H "Content-Type: application/json" \
-    -H "Prefer: handling=strict, max-affected=10"
-
-.. code-block:: http
-
-  HTTP/1.1 400 Bad Request
+  curl "http://localhost:3000/rpc/mult_them" \
+    -X POST -H "Content-Type: application/json" \
+    -H "Prefer: params=single-object" \
+    -d '{ "x": 4, "y": 2 }'
 
 .. code-block:: json
 
-  {
-      "code": "PGRST124",
-      "message": "Query result exceeds max-affected preference constraint",
-      "details": "The query affects 14 rows",
-      "hint": null
-  }
-
-.. note::
-
-  It is important for functions to return ``SETOF`` or ``TABLE`` when called with ``max-affected`` preference. A violation of this would cause a :ref:`PGRST128 <pgrst128>` error.
+  8

docs/references/api/resource_embedding.rst

@@ -143,7 +143,7 @@ Since the table name is plural, we can be more accurate by making it singular wi
 One-to-many relationships
 -------------------------
 
-The **foreign key reference** establishes the inverse one-to-many relationship. In this case, ``films`` returns as a JSON array because of the "to-many" end.
+The **foreign key reference** establishes the inverse one-to-many relationship. In this case, ``films`` returns as a JSON array because of the “to-many” end.
 
 .. code-block:: bash
 
@@ -209,25 +209,18 @@ The join table is also detected if the composite key has additional columns.
 One-to-one relationships
 ------------------------
 
-One-to-one relationships are detected in two ways. (We'll use the ``films`` and ``technical_specs`` tables from the :ref:`sample film database <erd_film>` as an example).
+One-to-one relationships are detected in two ways.
 
-- When the foreign key is also a primary key.
+- When the foreign key is a primary key as specified in the :ref:`sample film database <erd_film>`.
+- When the foreign key has a unique constraint.
 
   .. code-block:: postgres
 
     create table technical_specs(
-      film_id int references films(id) primary key
-    -- ...
-    );
-
-- Or when the foreign key has a unique constraint.
-
-  .. code-block:: postgres
-
-    create table technical_specs(
-      id int primary key
-    , film_id int references films(id) unique
-    -- ...
+      film_id int references films(id) unique,
+      runtime time,
+      camera text,
+      sound text
     );
 
 .. code-block:: bash
@@ -251,12 +244,6 @@ Computed Relationships
 
 You can manually define relationships by using functions. This is useful for database objects that can't define foreign keys, like `Foreign Data Wrappers <https://wiki.postgresql.org/wiki/Foreign_data_wrappers>`_.
 
-Computed relationships have good performance as their intended design enable `function inlining <https://wiki.postgresql.org/wiki/Inlining_of_SQL_functions#Inlining_conditions_for_table_functions>`_.
-
-.. important::
-
-  - Always use ``SETOF`` when creating computed relationships. Functions can return a table without using ``SETOF``, but bear in mind that PostgreSQL will not inline them. e.g. ``RETURNS <table_name>`` is not inlinable.
-
 Assuming there's a foreign table ``premieres`` that we want to relate to ``films``.
 
 .. code-block:: postgres
@@ -289,10 +276,6 @@ The name of the function ``film`` is arbitrary and can be used to do the embeddi
     ".."
   ]
 
-.. warning::
-
-  - Make sure to correctly label the ``to-one`` part of the relationship. When using the ``ROWS 1`` estimation, PostgREST will expect a single row to be returned. If that is not the case, it will unnest the embedding and return repeated values for the top level resource.
-
 Now let's define the opposite one-to-many relationship.
 
 .. code-block:: postgres
@@ -341,6 +324,12 @@ Thanks to overloaded functions, you can use the same function name for different
 
 Computed relationships have good performance as their intended design enable `function inlining <https://wiki.postgresql.org/wiki/Inlining_of_SQL_functions#Inlining_conditions_for_table_functions>`_.
 
+.. warning::
+
+  - Always use ``SETOF`` when creating computed relationships. Functions can return a table without using ``SETOF``, but bear in mind that PostgreSQL will not inline them.
+
+  - Make sure to correctly label the ``to-one`` part of the relationship. When using the ``ROWS 1`` estimation, PostgREST will expect a single row to be returned. If that is not the case, it will unnest the embedding and return repeated values for the top level resource.
+
 .. _embed_disamb:
 .. _target_disamb:
 .. _hint_disamb:
@@ -938,12 +927,7 @@ Filters can also be applied on nested embedded resources:
 
 .. code-block:: bash
 
-  # curl "http://localhost:3000/films?select=*,roles(*,actors(*))&roles.actors.order=last_name&roles.actors.first_name=like.*Tom*"
-
-  curl --get "http://localhost:3000/films" \
-    -d "select=*,roles(*,actors(*))" \
-    -d "roles.actors.order=last_name" \
-    -d "roles.actors.first_name=like.*Tom*"
+  curl "http://localhost:3000/films?select=*,roles(*,actors(*))&roles.actors.order=last_name&roles.actors.first_name=like.*Tom*"
 
 The result will show the nested actors named Tom and order them by last name. Aliases can also be used instead of the resource names to filter the nested tables.
 
@@ -1154,19 +1138,14 @@ For example, to arrange the films in descending order using the director's last
 Spread embedded resource
 ========================
 
-You can modify the shape of the embedded resources by using the spread syntax (``...``).
-
-.. _spread_to_one_embed:
-
-Spread To-One relationships
----------------------------
-
-Spread on resources forming :ref:`one-to-one <one-to-one>` and :ref:`many-to-one <many-to-one>` relationships, will lift the embedded columns to the top object.
+On many-to-one and one-to-one relationships, you can "spread" the embedded resource. That is, remove the surrounding JSON object for the embedded resource columns.
 
 .. code-block:: bash
 
+   # curl "http://localhost:3000/films?select=title,...directors(director_last_name:last_name)&title=like.*Workers*"
+
   curl --get "http://localhost:3000/films" \
-    -d "select=title,...directors(director_first_name:first_name, director_last_name:last_name)" \
+    -d "select=title,...directors(director_last_name:last_name)" \
     -d "title=like.*Workers*"
 
 .. code-block:: json
@@ -1174,148 +1153,17 @@ Spread on resources forming :ref:`one-to-one <one-to-one>` and :ref:`many-to-one
    [
      {
        "title": "Workers Leaving The Lumière Factory In Lyon",
-       "director_first_name": "Louis",
        "director_last_name": "Lumière"
      }
    ]
 
-Note that there is no wrapping ``"directors"`` object, unlike regularly embedding :ref:`many-to-one <many-to-one>` relationships. Also note that embedded columns can be aliased normally.
+Note that there is no ``"directors"`` object. Also the embed columns can be aliased normally.
 
-.. _spread_to_many_embed:
-
-Spread To-Many relationships
-----------------------------
-
-Spread on resources forming :ref:`one-to-many <one-to-many>` and :ref:`many-to-many <many-to-many>` relationships, will convert the embedded columns into correlated arrays.
+You can use this to get the columns of a join table in a many-to-many relationship. For instance, to get films and its actors, but including the ``character`` column from the roles table:
 
 .. code-block:: bash
 
-  curl --get "http://localhost:3000/directors" \
-    -d "select=first_name,...films(film_titles:title,film_years:year)" \
-    -d "first_name=like.Quentin*"
-
-.. code-block:: json
-
-   [
-     {
-       "first_name": "Quentin",
-       "film_titles": [
-         "Pulp Fiction",
-         "Reservoir Dogs"
-       ],
-       "film_years": [
-         1994,
-         1992
-       ]
-     }
-   ]
-
-Note that ``films`` is no longer an array of objects, unlike regularly embedding :ref:`one-to-many`. The embedded columns become arrays and they're correlated-in the above result, we can say that "Pulp Fiction" premiered in 1994 and "Reservoir Dogs" in 1992.
-
-Order in spread to-many
-~~~~~~~~~~~~~~~~~~~~~~~
-
-In the above example, the order of the values inside the correlated arrays is unspecified, but all the values are guaranteed to be in the same unspecified order.
-
-You can order the correlated arrays explicitly. For example, to order by the film year:
-
-.. code-block:: bash
-
-  curl --get "http://localhost:3000/directors" \
-    -d "select=first_name,...films(film_titles:title,film_years:year)" \
-    -d "first_name=like.Quentin*" \
-    -d "films.order=year"
-
-.. code-block:: json
-
-   [
-     {
-       "first_name": "Quentin",
-       "film_titles": [
-         "Reservoir Dogs",
-         "Pulp Fiction"
-       ],
-       "film_years": [
-         1992,
-         1994
-       ]
-     }
-   ]
-
-.. warning::
-
-   Aliasing spread columns is recommended since JSON allows duplicate keys. Example:
-
-   .. code-block:: bash
-
-     curl --get "localhost:3000/projects" \
-       -d "select=id,name,...clients(id,name)"
-
-   .. code-block:: json
-
-     [{"id":1,"name":"Windows 7","id":1,"name":"Microsoft"},
-      {"id":2,"name":"Windows 10","id":1,"name":"Microsoft"},
-      {"id":3,"name":"IOS","id":2,"name":"Apple"},
-      {"id":4,"name":"OSX","id":2,"name":"Apple"},
-      {"id":5,"name":"Orphan","id":null,"name":null}]
-
-   This can be a problem in Javascript objects, since only the last duplicated key will be considered. To solve it do:
-
-   .. code-block:: bash
-
-     curl --get "localhost:3000/projects" \
-       -d "select=id,name,...clients(client_id:id,client_name:name)"
-
-
-Multiple Spreads
-----------------
-
-You can use multiple spreads at any level. For example, let's spread ``technical_specs`` and ``roles`` into ``films`` and then spread ``films`` into ``directors``:
-
-.. code-block:: bash
-
-  curl --get "http://localhost:3000/directors" \
-    -d "select=first_name,...films(film_titles:title,film_years:year,...technical_specs(film_runtimes:runtime),...roles(film_characters:character))" \
-    -d "first_name=like.Quentin*" \
-    -d "films.order=year" \
-    -d "films.roles.order=character"
-
-.. code-block:: json
-
-   [
-     {
-       "first_name": "Quentin",
-       "film_titles": [
-         "Reservoir Dogs",
-         "Pulp Fiction"
-       ],
-       "film_years": [
-         1992,
-         1994
-       ],
-       "film_runtimes": [
-         "01:39:00",
-         "02:29:00"
-       ]
-       "film_characters": [
-         [ "Mr. Pink", "Mr. White" ],
-         [ "Mia Wallace", "Vincent Vega" ]
-       ]
-     }
-   ]
-
-Note that:
-
-- All the ``film_*`` arrays are correlated-"Reservoir Dogs" premiered in 1992, its runtime is 1:39:00 and it has the following characters: ``[ "Mr. Pink", "Mr. White" ]``.
-- The ``film_*`` arrays are ordered by ``year`` (due to ``films.order=year``).
-- The bottom level array ``film_characters`` is ordered (due to ``films.roles.order=character``).
-
-Spread a join table
--------------------
-
-Spread can be used to move the columns of a join table in a :ref:`many-to-many <many-to-many>` to the top object. For instance, to get the ``character`` column of the ``roles`` join table into ``actors``:
-
-.. code-block:: bash
+   # curl "http://localhost:3000/films?select=title,actors:roles(character,...actors(first_name,last_name))&title=like.*Lighthouse*"
 
   curl --get "http://localhost:3000/films" \
     -d "select=title,actors:roles(character,...actors(first_name,last_name))" \
@@ -1336,4 +1184,6 @@ Spread can be used to move the columns of a join table in a :ref:`many-to-many <
      }
    ]
 
+.. note::
 
+  The spread operator ``...`` is borrowed from the Javascript `spread syntax <https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_syntax>`_.

docs/references/api/resource_representation.rst

@@ -51,7 +51,7 @@ Builtin handlers are offered for common standard media types.
 
 * ``text/csv`` and ``application/json``, for all API endpoints. See :ref:`tables_views` and :ref:`functions`.
 * ``application/openapi+json``, for the root endpoint. See :ref:`open-api`.
-* ``application/geo+json``, see :ref:`application/geo+json`.
+* ``application/geo+json``, see :ref:`ww_postgis`.
 * ``*/*``, resolves to ``application/json`` for API endpoints and to ``application/openapi+json`` for the root endpoint.
 
 The following vendor media types handlers are also supported.
@@ -100,15 +100,17 @@ This returns
 
   { "id": 1 }
 
+with a :code:`Content-Type: application/vnd.pgrst.object+json`.
+
 When a singular response is requested but no entries are found, the server responds with an error message and 406 Not Acceptable status code rather than the usual empty array and 200 status:
 
 .. code-block:: json
 
   {
-    "code": "PGRST116",
-    "message": "Cannot coerce the result to a single JSON object",
-    "details": "The result contains 0 rows",
-    "hint": null
+    "message": "JSON object requested, multiple (or no) rows returned",
+    "details": "Results contain 0 rows, application/vnd.pgrst.object+json requires 1 row",
+    "hint": null,
+    "code": "PGRST505"
   }
 
 .. note::

docs/references/api/schemas.rst

@@ -5,10 +5,6 @@ Schemas
 
 PostgREST can expose a single or multiple schema's tables, views and functions. The :ref:`active database role <roles>` must have the usage privilege on the schemas to access them.
 
-.. important::
-  
-  ``pg_catalog`` and ``information_schema`` are not allowed in :ref:`db-schemas`. This is done to prevent leaking sensitive information and hence they cannot be accessed directly. If you wish to expose objects of these schemas, expose another schema that contains wrapper views or functions over ``pg_catalog`` or ``information_schema`` objects.
-
 Single schema
 -------------
 

docs/references/api/tables_views.rst

@@ -72,7 +72,7 @@ imatch        :code:`~*`                ~* operator, see :ref:`pattern_matching`
 in            :code:`IN`                one of a list of values, e.g. :code:`?a=in.(1,2,3)`
                                         – also supports commas in quoted strings like
                                         :code:`?a=in.("hi,there","yes,you")`
-is            :code:`IS`                checking for exact equality (null,not_null,true,false,unknown)
+is            :code:`IS`                checking for exact equality (null,true,false,unknown)
 isdistinct    :code:`IS DISTINCT FROM`  not equal, treating :code:`NULL` as a comparable value
 fts           :code:`@@`                :ref:`fts` using to_tsquery
 plfts         :code:`@@`                :ref:`fts` using plainto_tsquery
@@ -175,56 +175,25 @@ To ensure best performance on larger data sets, an `appropriate index <https://w
 Full-Text Search
 ~~~~~~~~~~~~~~~~
 
-The :code:`fts` operator has a number of options to support flexible textual queries, namely the choice of plain vs phrase search and the language used for stemming.
-
-The following examples illustrate the possibilities, assuming column :code:`my_tsv` is of type `tsvector <https://www.postgresql.org/docs/current/datatype-textsearch.html>`_.
+The :code:`fts` filter mentioned above has a number of options to support flexible textual queries, namely the choice of plain vs phrase search and the language used for stemming. Suppose that :code:`tsearch` is a table with column :code:`my_tsv`, of type `tsvector <https://www.postgresql.org/docs/current/datatype-textsearch.html>`_. The following examples illustrate the possibilities.
 
 .. code-block:: bash
 
-  curl --get "http://localhost:3000/people" \
-    -d "my_tsv=fts(french).amusant"
+  curl "http://localhost:3000/tsearch?my_tsv=fts(french).amusant"
 
 .. code-block:: bash
 
-  curl --get "http://localhost:3000/people" \
-    -d "my_tsv=plfts.The%20Fat%20Cats"
+  curl "http://localhost:3000/tsearch?my_tsv=plfts.The%20Fat%20Cats"
 
 .. code-block:: bash
 
-  curl --get "http://localhost:3000/people" \
-    -d "my_tsv=not.phfts(english).The%20Fat%20Cats"
+  curl "http://localhost:3000/tsearch?my_tsv=not.phfts(english).The%20Fat%20Cats"
 
 .. code-block:: bash
 
-  curl --get "http://localhost:3000/people" \
-    -d "my_tsv=not.wfts(french).amusant"
+  curl "http://localhost:3000/tsearch?my_tsv=not.wfts(french).amusant"
 
-.. _fts_to_tsvector:
-
-Automatic ``tsvector`` conversion
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-If the filtered column is not of type ``tsvector``, then it will be automatically converted using `to_tsvector() <https://www.postgresql.org/docs/current/functions-textsearch.html#TEXTSEARCH-FUNCTIONS-TABLE>`_.
-This allows using the ``fts`` operator on ``text`` and ``json`` types out of the box.
-
-.. code-block:: bash
-
-  curl --get "http://localhost:3000/people" \
-    -d "my_text_column=fts(french).amusant"
-
-.. code-block:: bash
-
-  curl --get "http://localhost:3000/people" \
-    -d "my_json_column=not.phfts(english).The%20Fat%20Cats"
-
-.. important::
-
-  To ensure this operation is fast, you need to create an index on the expression:
-
-  .. code-block:: postgres
-
-    CREATE INDEX idx_people_col ON people
-    USING GIN (to_tsvector('french', my_text_column));
+Using `websearch_to_tsquery` requires PostgreSQL of version at least 11.0 and will raise an error in earlier versions of the database.
 
 .. _v_filter:
 
@@ -639,7 +608,7 @@ However, it can work with surrogate primary keys (e.g. ``id serial primary key``
 
 .. code-block:: bash
 
-  curl "http://localhost:3000/employees?columns=id,name,salary" \
+  curl "http://localhost:3000/employees?colums=id,name,salary" \
     -X POST -H "Content-Type: application/json" \
     -H "Prefer: resolution=merge-duplicates, missing=default" \
     -d @- << EOF
@@ -714,6 +683,31 @@ Deletions also support :ref:`prefer_return`, :ref:`resource_embedding` and :ref:
 
   Beware of accidentally deleting all rows in a table. To learn to prevent that see :ref:`block_fulltable`.
 
+.. _limited_update_delete:
+
+Limited Update/Delete
+=====================
+
+You can limit the amount of affected rows by :ref:`update` or :ref:`delete` with the ``limit`` query parameter. For this, you must add an explicit ``order`` on a unique column(s).
+
+.. code-block:: bash
+
+  curl -X PATCH "/users?limit=10&order=id&last_login=lt.2020-01-01" \
+    -H "Content-Type: application/json" \
+    -d '{ "status": "inactive" }'
+
+.. code-block:: bash
+
+  curl -X DELETE "http://localhost:3000/users?limit=10&order=id&status=eq.inactive"
+
+If your table has no unique columns, you can use the `ctid <https://www.postgresql.org/docs/current/ddl-system-columns.html>`_ system column.
+
+Using ``offset`` to target a different subset of rows is also possible.
+
+.. note::
+
+  There is no native ``UPDATE...LIMIT`` or ``DELETE...LIMIT`` support in PostgreSQL; the generated query simulates that behavior and is based on `this Crunchy Data blog post <https://www.crunchydata.com/blog/simulating-update-or-delete-with-limit-in-postgres-ctes-to-the-rescue>`_.
+
 .. raw:: html
 
   <script type="text/javascript">

docs/references/api/url_grammar.rst

@@ -14,7 +14,7 @@ Custom Queries
 
 The PostgREST URL grammar limits the kinds of queries clients can perform. It prevents arbitrary, potentially poorly constructed and slow client queries. It's good for quality of service, but means database administrators must create custom views and functions to provide richer endpoints. The most common causes for custom endpoints are
 
-* SET operators like `UNION, INTERSECT and EXCEPT <https://www.postgresql.org/docs/current/queries-union.html>`_.
+* Table unions
 * More complicated joins than those provided by :ref:`resource_embedding`.
 * Geo-spatial queries that require an argument, like "points near (lat,lon)"
 
@@ -51,7 +51,7 @@ You can request table/columns with spaces in them by percent encoding the spaces
 Reserved characters
 ~~~~~~~~~~~~~~~~~~~
 
-If filters include PostgREST reserved characters(``,``, ``.``, ``:``, ``*``, ``(``, ``)``) you'll have to surround them in percent encoded double quotes ``%22`` for correct processing.
+If filters include PostgREST reserved characters(``,``, ``.``, ``:``, ``()``) you'll have to surround them in percent encoded double quotes ``%22`` for correct processing.
 
 Here ``Hebdon,John`` and ``Williams,Mary`` are values.
 

docs/references/api/vary_header.rst

@@ -1,16 +0,0 @@
-.. _vary_header:
-
-Vary Header
-===========
-
-In order to assist caching proxies and CDNs, PostgREST includes a ``Vary`` header of value
-``Accept, Prefer, Range`` in its responses which should fit most of the bills. As any other
-response header, it's available for override
-by updating ``response.headers`` GUC variable accordingly, for example:
-
-.. code-block:: postgres
-
-   -- Override the Vary header to include Accept, Prefer and X-Test-Vary headers
-   perform set_config('response.headers', '[{"Vary": "Accept, Prefer, X-Test-Vary"}]', true);
-
-In this case PostgREST will use provided value verbatim.

docs/references/auth.rst

@@ -31,7 +31,7 @@ The authenticator role is used for connecting to the database and should be conf
 .. _user_impersonation:
 
 User Impersonation
-~~~~~~~~~~~~~~~~~~
+------------------
 
 The picture below shows how the server handles authentication. If auth succeeds, it switches into the user role specified by the request, otherwise it switches into the anonymous role (if it's set in :ref:`db-anon-role`).
 
@@ -43,13 +43,12 @@ This role switching mechanism is called **user impersonation**. In PostgreSQL it
 
   The impersonated roles will have their settings applied. See :ref:`impersonated_settings`.
 
-.. _jwt_auth:
+.. _jwt_impersonation:
 
-JWT Authentication
-------------------
+JWT-Based User Impersonation
+----------------------------
 
-We use `JSON Web Tokens <https://datatracker.ietf.org/doc/html/rfc7519/>`_ to authenticate API requests, this allows us to be stateless and not require database lookups for verification.
-As you'll recall a JWT contains a list of cryptographically signed claims. All claims are allowed but PostgREST cares specifically about a claim called role (configurable with :ref:`jwt_role_extract`).
+We use `JSON Web Tokens <https://jwt.io/>`_ to authenticate API requests, this allows us to be stateless and not require database lookups for verification. As you'll recall a JWT contains a list of cryptographically signed claims. All claims are allowed but PostgREST cares specifically about a claim called role.
 
 .. code:: json
 
@@ -73,10 +72,17 @@ Note that the database administrator must allow the authenticator role to switch
 
 If the client included no JWT (or one without a role claim) then PostgREST switches into the anonymous role. The database administrator must set the anonymous role permissions correctly to prevent anonymous users from seeing or changing things they shouldn't.
 
-.. _bearer_auth:
+.. _jwt_generation:
 
-Bearer Authentication
-~~~~~~~~~~~~~~~~~~~~~
+JWT Generation
+~~~~~~~~~~~~~~
+
+You can create a valid JWT either from inside your database (see :ref:`sql_user_management`) or via an external service (see :ref:`external_jwt`).
+
+.. _client_auth:
+
+Client Auth
+~~~~~~~~~~~
 
 To make an authenticated request the client must include an :code:`Authorization` HTTP header with the value :code:`Bearer <jwt>`. For instance:
 
@@ -87,29 +93,24 @@ To make an authenticated request the client must include an :code:`Authorization
 
 The ``Bearer`` header value can be used with or without capitalization(``bearer``).
 
-.. _jwt_generation:
+.. _jwt_caching:
 
-JWT Generation
-~~~~~~~~~~~~~~
+JWT Caching
+-----------
 
-You can create a valid JWT either from inside your database (see :ref:`sql_user_management`) or via an external service (see :ref:`external_auth`).
+PostgREST validates ``JWTs`` on every request. We can cache ``JWTs`` to avoid this performance overhead.
 
-.. _jwt_signature:
+To enable JWT caching, the config :code:`jwt-cache-max-lifetime` is to be set. It is the maximum number of seconds for which the cache stores the JWT validation results. The cache uses the :code:`exp` claim to set the cache entry lifetime. If the JWT does not have an :code:`exp` claim, it uses the config value. See :ref:`jwt-cache-max-lifetime` for more details.
 
-JWT Signature Verification
---------------------------
+.. note::
 
-PostgREST supports both symmetric and asymmetric keys for verifying the signature of the token.
+  You can use the :ref:`server-timing_header` to see the effect of JWT caching.
 
 Symmetric Keys
 ~~~~~~~~~~~~~~
 
-In the case of symmetric cryptography the signer and verifier share the same secret passphrase, which can be configured with :ref:`jwt-secret`.
-If it is set to a simple string then PostgREST interprets it as an HMAC-SHA256 passphrase.
-
-.. code-block:: ini
-
-  jwt-secret = "reallyreallyreallyreallyverysafe"
+Each token is cryptographically signed with a secret key. In the case of symmetric cryptography the signer and verifier share the same secret passphrase, which can be configured with :ref:`jwt-secret`.
+If it is set to a simple string value like “reallyreallyreallyreallyverysafe” then PostgREST interprets it as an HMAC-SHA256 passphrase.
 
 .. _asym_keys:
 
@@ -155,103 +156,21 @@ You can specify the literal value as we saw earlier, or reference a filename to
 
   jwt-secret = "@rsa.jwk.pub"
 
-``kid`` verification
-^^^^^^^^^^^^^^^^^^^^
-
-PostgREST has built-in verification of the `key ID parameter <https://www.rfc-editor.org/rfc/rfc7517#section-4.5>`_, useful when working with a JSON Web Key Set.
-It goes as follows:
-
-- If the JWT contains a ``kid`` parameter, then PostgREST will look for the JSON Web Key in the :ref:`jwt-secret`.
-
-  + If no key has a matching ``kid`` (or if they don't have one defined), the token will be rejected with a :ref:`401 Unauthorized <pgrst301>` error.
-  + If a key matches the ``kid`` value then it will validate the token against that key accordingly.
-
-- If the JWT doesn't have a ``kid``, PostgREST  will try each key in the :ref:`jwt-secret` one by one until it finds one that works.
-
-.. _jwt_claims_validation:
-
 JWT Claims Validation
----------------------
+~~~~~~~~~~~~~~~~~~~~~
 
-Time-Based claims validation
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The time-based JWT claims specified in `RFC 7519 <https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.4>`_ are validated:
+PostgREST honors the following `JWT claims <https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.4>`_:
 
 - ``exp`` Expiration Time
 - ``iat`` Issued At
 - ``nbf`` Not Before
-
-We allow a 30-second clock skew when validating the above claims. In other words, we give an extra 30 seconds before the JWT is rejected if there is a slight discrepancy in the timestamps.
-
-.. _jwt_aud:
-
-``aud`` validation
-~~~~~~~~~~~~~~~~~~
-
-PostgREST has built-in validation of the `JWT audience claim <https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.3>`_.
-It works this way:
-
-- If :ref:`jwt-aud` is not set (the default), PostgREST identifies with all audiences and allows the JWT for any ``aud`` claim.
-- If :ref:`jwt-aud` is set to a specific audience, PostgREST will check if this audience is present in the ``aud`` claim:
-
-  + If the ``aud`` value is a JSON string, it will match it to the :ref:`jwt-aud`.
-  + If the ``aud`` value is a JSON array of strings, it will search every element for a match.
-  + If the match fails or if the ``aud`` value is not a string or array of strings, then the token will be rejected with a :ref:`401 Unauthorized <pgrst303>` error.
-  + If the ``aud`` key **is not present** or if its value is ``null`` or ``[]``, PostgREST will interpret this token as allowed for all audiences and will complete the request.
-
-.. _jwt_caching:
-
-JWT Cache
----------
-
-JWT signature validation (specially :ref:`asym_keys` such as RSA) is slow, we can cache ``JWT`` validation results to avoid this performance overhead.
-
-The JWT cache is bounded and uses the `SIEVE algorithm <https://cachemon.github.io/SIEVE-website>`_ for efficient eviction. The cache is enabled by default and can be configured with :ref:`jwt-cache-max-entries`.
-
-It's recommended to leave the JWT cache enabled as our load tests indicate ~20% more throughput for simple GET requests when using it. This while reducing CPU utilization in exchange for a bit more memory.
-
-:ref:`jwt_cache_metrics` are available.
+- ``aud`` Audience, see :ref:`jwt-aud`
 
 .. note::
-
-  - If the ``jwt-secret`` is changed and the config is reloaded, the JWT cache will reset.
-  - JWTs that pass :ref:`jwt_signature` are cached, regardless if they pass :ref:`jwt_claims_validation`. We do this to ensure responses stays fast under common failure cases (such as expired JWTs).
-  - You can use the :ref:`server-timing_header` to see the performance benefit of JWT caching.
-
-.. _jwt_role_extract:
-
-JWT Role Extraction
--------------------
-
-A JSON Path (`RFC 9535 <https://www.rfc-editor.org/rfc/rfc9535.html>`_) can be specified for the location of the :code:`role` key in the JWT claims. It's configured by :ref:`jwt-role-claim-key`. This can be used to consume a JWT provided by a third party service like Auth0, Okta, Microsoft Entra or Keycloak.
-
-You can quickly try out JSON Path by visiting https://serdejsonpath.live.
-
-Usage examples:
-
-  .. code:: bash
-
-    # {"postgrest":{"roles": ["other", "author"]}}
-    jwt-role-claim-key = "$$.postgrest.roles[1]"
-
-    # {"https://www.example.com/role": { "key": "author" }}
-    # non-alphanumerical characters can go inside single quotes
-    jwt-role-claim-key = "$$['https://www.example.com/role'].key"
-
-    # {"postgrest":{"roles": ["other", "author"]}}
-    # filter based on equality or regular expression
-    jwt-role-claim-key = "$$.postgrest.roles[?(@ == 'author')]"
-    jwt-role-claim-key = "$$.postgrest.roles[?search(@, '^au')]"
-
-.. note::
-
-  - If JSON Path query returns multiple values, the first one gets selected.
-  - Only when using the :ref:`file_config`, all ``$`` characters in the value must be escaped with an additional ``$`` char. For :ref:`env_variables_config` and :ref:`in_db_config`, only use a single ``$`` char.
-  - In our implementation, only the `search()` function from `JSON Path Functions <https://www.rfc-editor.org/rfc/rfc9535.html#name-function-extensions>`_ is available for filtering.
+  PostgREST allows for a 30-second clock skew when validating the ``exp`` and ``iat`` claims. In other words, it gives an extra 30 seconds before the token is rejected if there is a slight discrepancy in the timestamps.
 
 JWT Security
-------------
+~~~~~~~~~~~~
 
 There are at least three types of common critiques against using JWT: 1) against the standard itself, 2) against using libraries with known security vulnerabilities, and 3) against using JWT for web sessions. We'll briefly explain each critique, how PostgREST deals with it, and give recommendations for appropriate user action.
 
@@ -287,23 +206,3 @@ doing custom logic based on the web user info.
     END IF;
   END
   $$ LANGUAGE plpgsql;
-
-.. raw:: html
-
-  <script type="text/javascript">
-    let hash = window.location.hash;
-
-    const redirects = {
-      '#jwt-based-user-impersonation': '#jwt-authentication',
-      '#client-auth': '#bearer-authentication',
-      '#jwt-caching': '#jwt-cache',
-      '#jwk-kid-validation': '#kid-verification',
-      '#jwt-aud-claim-validation': '#aud-validation',
-    };
-
-    let willRedirectTo = redirects[hash];
-
-    if (willRedirectTo) {
-      window.location.href = willRedirectTo;
-    }
-  </script>

docs/references/cli.rst

@@ -3,47 +3,23 @@
 CLI
 ===
 
-PostgREST provides a CLI with the options listed below:
-
-.. code:: text
-
-  Usage: postgrest [-v|--version] [-e|--example] [--dump-config | --dump-schema | --ready]
-                 [FILENAME]
-
-    PostgREST / create a REST API to an existing Postgres
-    database
-
-  Available options:
-    -h,--help                Show this help text
-    -v,--version             Show the version information
-    -e,--example             Show an example configuration file
-    --dump-config            Dump loaded configuration and exit
-    --dump-schema            Dump loaded schema as JSON and exit (for debugging,
-                             output structure is unstable)
-    --ready                  Checks the health of PostgREST by doing a request on
-                             the admin server /ready endpoint
-    FILENAME                 Path to configuration file
-
-FILENAME
---------
-
-Runs PostgREST with the given :ref:`file_config`.
+PostgREST provides a CLI with the commands listed below:
 
 Help
 ----
 
 .. code:: bash
 
-  $ postgrest --help
+  $ postgrest [-h|--help]
 
-Shows all the options available.
+Shows all the commands available.
 
 Version
 -------
 
 .. code:: bash
 
-  $ postgrest --version
+  $ postgrest [-v|--version]
 
 Prints the PostgREST version.
 
@@ -52,16 +28,16 @@ Example
 
 .. code:: bash
 
-  $ postgrest --example
+  $ postgrest [-e|--example]
 
-Shows example configuration settings.
+Shows example configuration options.
 
 Dump Config
 -----------
 
 .. code:: bash
 
-  $ postgrest --dump-config
+  $ postgrest [--dump-config]
 
 Dumps the loaded :ref:`configuration` values, considering the configuration file, environment variables and :ref:`in_db_config`.
 
@@ -70,20 +46,6 @@ Dump Schema
 
 .. code:: bash
 
-  $ postgrest --dump-schema
+  $ postgrest [--dump-schema]
 
 Dumps the schema cache in JSON format.
-
-Ready Flag
-----------
-
-Makes a request to the ``/ready`` endpoint of the :ref:`admin_server`. It exits with a return code of ``0`` on success and ``1`` on failure.
-
-.. code-block:: bash
-
-  $ postgrest --ready
-  OK: http://localhost:3001/ready
-
-.. note::
-
-  The ``--ready`` flag cannot be used when :ref:`server-host` is configured with special hostnames. We suggest to change it to ``localhost``.

docs/references/configuration.rst

@@ -146,21 +146,6 @@ To reload the configuration from within the database, you can use the ``NOTIFY``
 List of parameters
 ==================
 
-.. _admin-server-host:
-
-admin-server-host
------------------
-
-  =============== =======================
-  **Type**        String
-  **Default**     `server-host` value
-  **Reloadable**  N
-  **Environment** PGRST_ADMIN_SERVER_HOST
-  **In-Database** `n/a`
-  =============== =======================
-
-  Specifies the host for the :ref:`admin_server`. Defaults to :ref:`server-host` value.
-
 .. _admin-server-port:
 
 admin-server-port
@@ -174,47 +159,7 @@ admin-server-port
   **In-Database** `n/a`
   =============== =======================
 
-  Specifies the port for the :ref:`admin_server`. Cannot be equal to :ref:`server-port`.
-
-.. _admin-server-unix-socket:
-
-admin-server-unix-socket
-------------------------
-
-  =============== =================================
-  **Type**        String
-  **Default**     `n/a`
-  **Reloadable**  N
-  **Environment** PGRST_ADMIN_SERVER_UNIX_SOCKET
-  **In-Database** `n/a`
-  =============== =================================
-
-  `Unix domain socket <https://en.wikipedia.org/wiki/Unix_domain_socket>`_ where to bind the :ref:`admin_server`.
-  If specified, this takes precedence over :ref:`admin-server-port`. Example:
-
-  .. code:: bash
-
-    admin-server-unix-socket = "/tmp/pgrst-admin.sock"
-
-.. _admin-server-unix-socket-mode:
-
-admin-server-unix-socket-mode
------------------------------
-
-  =============== ===================================
-  **Type**        String
-  **Default**     660
-  **Reloadable**  N
-  **Environment** PGRST_ADMIN_SERVER_UNIX_SOCKET_MODE
-  **In-Database** `n/a`
-  =============== ===================================
-
-  `Unix file mode <https://en.wikipedia.org/wiki/File_system_permissions>`_ to be set for the socket specified in :ref:`admin-server-unix-socket`
-  Needs to be a valid octal between 600 and 777.
-
-  .. code:: bash
-
-    admin-server-unix-socket-mode = "660"
+  Specifies the port for the :ref:`admin_server`.
 
 .. _app.settings.*:
 
@@ -231,37 +176,6 @@ app.settings.*
 
   Arbitrary settings that can be used to pass in secret keys directly as strings, or via OS environment variables. For instance: :code:`app.settings.jwt_secret = "$(MYAPP_JWT_SECRET)"` will take :code:`MYAPP_JWT_SECRET` from the environment and make it available to PostgreSQL functions as :code:`current_setting('app.settings.jwt_secret')`.
 
-  When using the environment variable `PGRST_APP_SETTINGS_*` form, the remainder of the variable is used as the new name. Case is not important : :code:`PGRST_APP_SETTINGS_MY_ENV_VARIABLE=some_value` can be accessed in postgres as :code:`current_setting('app.settings.my_env_variable')`.
-
-  The :code:`current_setting` function has `an optional boolean second <https://www.postgresql.org/docs/current/functions-admin.html#FUNCTIONS-ADMIN-SET>`_ argument to avoid it from raising an error if the value was not defined. Default values to :code:`app.settings` can then be given by combining this argument with :code:`coalesce` and :code:`nullif` : :code:`coalesce(nullif(current_setting('app.settings.my_custom_variable', true), ''), 'default value')`. The use of :code:`nullif` is necessary because if set in a transaction, the setting is sometimes not "rolled back" to :code:`null`. See also :ref:`this section <guc_req_headers_cookies_claims>` for more information on this behaviour.
-
-.. _client-error-verbosity:
-
-client-error-verbosity
-----------------------
-
-  =============== =======================
-  **Type**        String
-  **Default**     verbose
-  **Reloadable**  Y
-  **Environment** PGRST_CLIENT_ERROR_VERBOSITY
-  **In-Database** pgrst.client_error_verbosity
-  =============== =======================
-
-  Specifies the verbosity of PostgREST errors. See :ref:`client_error_verbosity`.
-
-  .. code:: bash
-
-    # Return error "code", "message", "details" and "hint"
-    client-error-verbosity = "verbose"
-
-    # Return only "code" and "message"
-    client-error-verbosity = "minimal"
-
-  .. note::
-
-    This setting only affects client side error messages. Server side logs are not affected by this setting.
-
 .. _db-aggregates-enabled:
 
 db-aggregates-enabled
@@ -331,7 +245,7 @@ db-channel-enabled
 
   When this is set to :code:`true`, the notification channel specified in :ref:`db-channel` is enabled.
 
-  You should set this to ``false`` when using PostgreSQL behind an external connection pooler such as PgBouncer working in transaction pooling mode. See :ref:`this section <external_connection_poolers>` for more information.
+  You should set this to ``false`` when using PostgresSQL behind an external connection pooler such as PgBouncer working in transaction pooling mode. See :ref:`this section <external_connection_poolers>` for more information.
 
 .. _db-config:
 
@@ -382,10 +296,6 @@ db-extra-search-path
 
   Multiple schemas can be added in a comma-separated string, e.g. ``public, extensions``.
 
-.. important::
-
-  We default this config to ``public`` because it is the most common schema used to install PostgreSQL extensions such as :ref:`PostGIS <ww_postgis>`. You can disable this by setting this config to ``""``.
-
 .. _db-hoisted-tx-settings:
 
 db-hoisted-tx-settings
@@ -476,7 +386,7 @@ db-pool-max-idletime
   **In-Database** `n/a`
   =============== =================================
 
-   *For backwards compatibility, this config parameter is also available as "db-pool-timeout".*
+   *For backwards compatibility, this config parameter is also available as “db-pool-timeout”.*
 
    Time in seconds to close idle pool connections.
 
@@ -546,7 +456,7 @@ db-prepared-statements
 
   When disabled, the generated queries will be parameterized (invulnerable to SQL injection) but they will not be prepared (cached in the database session). Not using prepared statements will noticeably decrease performance, so it's recommended to always have this setting enabled.
 
-  You should only set this to ``false`` when using PostgreSQL behind an external connection pooler such as PgBouncer working in transaction pooling mode. See :ref:`this section <external_connection_poolers>` for more information.
+  You should only set this to ``false`` when using PostgresSQL behind an external connection pooler such as PgBouncer working in transaction pooling mode. See :ref:`this section <external_connection_poolers>` for more information.
 
 .. _db-root-spec:
 
@@ -593,7 +503,7 @@ db-tx-end
   **In-Database** pgrst.db_tx_end
   =============== =================================
 
-  Specifies how to terminate the database transactions. See :ref:`prefer_tx`.
+  Specifies how to terminate the database transactions.
 
   .. code:: bash
 
@@ -670,7 +580,11 @@ jwt-aud
   **In-Database** pgrst.jwt_aud
   =============== =================================
 
-    Specifies an audience for the JWT ``aud`` claim. See :ref:`jwt_aud`.
+  Specifies the `JWT audience claim <https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.3>`_. If this claim is present in the client provided JWT then you must set this to the same value as in the JWT, otherwise verifying the JWT will fail.
+
+  .. warning::
+
+     Using this setting will only reject tokens with a different audience claim. Tokens **without** audience claim will still be accepted.
 
 .. _jwt-role-claim-key:
 
@@ -679,7 +593,7 @@ jwt-role-claim-key
 
   =============== =================================
   **Type**        String
-  **Default**     $.role
+  **Default**     .role
   **Reloadable**  Y
   **Environment** PGRST_JWT_ROLE_CLAIM_KEY
   **In-Database** pgrst.jwt_role_claim_key
@@ -687,11 +601,17 @@ jwt-role-claim-key
 
   *For backwards compatibility, this config parameter is also available without prefix as "role-claim-key".*
 
-  See :ref:`jwt_role_extract` on how to specify key paths and usage examples.
+  A JSPath DSL that specifies the location of the :code:`role` key in the JWT claims. This can be used to consume a JWT provided by a third party service like Auth0, Okta or Keycloak. Usage examples:
 
-.. warning::
+  .. code:: bash
 
-  Only when using :ref:`file_config`, the ``$`` char needs to be escaped, so use ``$$`` and PostgREST will interpret it as a single ``$`` character.
+    # {"postgrest":{"roles": ["other", "author"]}}
+    # the DSL accepts characters that are alphanumerical or one of "_$@" as keys
+    jwt-role-claim-key = ".postgrest.roles[1]"
+
+    # {"https://www.example.com/role": { "key": "author }}
+    # non-alphanumerical characters can go inside quotes(escaped in the config value)
+    jwt-role-claim-key = ".\"https://www.example.com/role\".key"
 
 .. _jwt-secret:
 
@@ -729,20 +649,20 @@ jwt-secret-is-base64
 
   When this is set to :code:`true`, the value derived from :code:`jwt-secret` will be treated as a base64 encoded secret.
 
-.. _jwt-cache-max-entries:
+.. _jwt-cache-max-lifetime:
 
-jwt-cache-max-entries
+jwt-cache-max-lifetime
 ----------------------
 
   =============== =================================
   **Type**        Int
-  **Default**     1000
+  **Default**     0
   **Reloadable**  Y
-  **Environment** PGRST_JWT_CACHE_MAX_ENTRIES
-  **In-Database** pgrst.jwt_cache_max_entries
+  **Environment** PGRST_JWT_CACHE_MAX_LIFETIME
+  **In-Database** pgrst.jwt_cache_max_lifetime
   =============== =================================
 
-  Maximum number of entries in JWT cache. The value :code:`0` disables JWT caching. See :ref:`jwt_caching`.
+  Maximum number of seconds of lifetime for cached entries. The default :code:`0` disables caching. See :ref:`jwt_caching`.
 
 .. _log-level:
 
@@ -752,7 +672,7 @@ log-level
   =============== =================================
   **Type**        String
   **Default**     error
-  **Reloadable**  Y
+  **Reloadable**  N
   **Environment** PGRST_LOG_LEVEL
   **In-Database** `n/a`
   =============== =================================
@@ -779,21 +699,6 @@ log-level
 
   Because currently there's no buffering for logging, the levels with minimal logging(``crit/error``) will increase throughput.
 
-.. _log-query:
-
-log-query
----------
-
-  =============== =================================
-  **Type**        Boolean
-  **Default**     False
-  **Reloadable**  Y
-  **Environment** PGRST_LOG_QUERY
-  **In-Database** `n/a`
-  =============== =================================
-
-  Logs the SQL query for the corresponding request at the current :ref:`log-level`. See :ref:`sql_query_logs`.
-
 .. _openapi-mode:
 
 openapi-mode
@@ -907,12 +812,6 @@ server-host
   * :code:`*6` - any IPv4 or IPv6 hostname, IPv6 preferred
   * :code:`!6` - any IPv6 hostname
 
-  Examples:
-
-  .. code:: bash
-
-    server-host = "127.0.0.1"
-
 .. _server-port:
 
 server-port
@@ -928,50 +827,6 @@ server-port
 
   The TCP port to bind the web server. Use ``0`` to automatically assign a port.
 
-.. _server-reuseport:
-
-server-reuseport
-----------------
-
-  =============== =================================
-  **Type**        Bool
-  **Default**     false
-  **Reloadable**  N
-  **Environment** PGRST_SERVER_REUSEPORT
-  **In-Database** `n/a`
-  =============== =================================
-
-  Enables ``SO_REUSEPORT`` on the TCP server socket. This allows multiple
-  PostgREST processes to bind to the same :ref:`server-host` and
-  :ref:`server-port` when the operating system supports it.
-  
-  For example, two PostgREST processes can use the same configuration:
-
-  .. code:: ini
-
-    server-host = "127.0.0.1"
-    server-port = 3000
-    server-reuseport = true
-
-  New connections are then distributed by the operating system between the
-  running PostgREST processes. This can be used to start a replacement process
-  before stopping the old one, or to run several PostgREST processes behind one
-  port.
-
-  If ``server-reuseport`` is disabled, starting another PostgREST process on
-  the same host and port will fail with the usual address-in-use error.
-
-  Enabling this setting on an operating system that does not support
-  ``SO_REUSEPORT`` is a configuration error. PostgREST will fail to start
-  instead of falling back to a normal TCP socket.
-
-  When running multiple PostgREST instances on the same :ref:`server-port`, use
-  a different ``admin-server-port`` for each instance. Admin ports are not shared
-  between instances, so readiness checks always target one specific PostgREST
-  instance.
-
-  This setting does not apply when :ref:`server-unix-socket` is used.
-
 .. _server-trace-header:
 
 server-trace-header
@@ -1000,7 +855,7 @@ server-timing-enabled
   **In-Database** pgrst.server_timing_enabled
   =============== =================================
 
-  Enables the `Server-Timing <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Server-Timing>`_ header.
+  Enables the `Server-Timing <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing>`_ header.
   See :ref:`server-timing_header`.
 
 .. _server-unix-socket:
@@ -1042,37 +897,3 @@ server-unix-socket-mode
   .. code:: bash
 
     server-unix-socket-mode = "660"
-
-.. _url-use-legacy-target-names:
-
-url-use-legacy-target-names
----------------------------
-
-  =============== =================================
-  **Type**        Boolean
-  **Default**     True
-  **Reloadable**  Y
-  **Environment** PGRST_URL_USE_LEGACY_TARGET_NAMES
-  **In-Database** pgrst.url_use_legacy_target_names
-  =============== =================================
-
-  When active, it allows using the the name of an embedded table in filters, orders or limits even if it has an alias:
-
-  .. code:: bash
-
-    curl "http://localhost:3000/table?select=alias:target(*)&target.order=id" -i
-
-  .. code:: text
-
-    Warning: 299 PostgRESTv16 "Embedded resource was referenced by relation name even though it has an alias. This is deprecated and will stop working in a future release. Update `target` to `alias` in query string filters, orders or limits."
-    [...]
-
-  Note that the response includes a deprecation message in the ``Warning`` header.
-  This will also show in the PostgREST logs:
-
-  .. code::
-
-    28/May/2026:20:33:22 -0500: WARNING: Embedded resource was referenced by relation name even though it has an alias. This is deprecated and will stop working in a future release.
-    28/May/2026:20:33:22 -0500: Update filters, orders or limits that use `target` to `alias` in `GET /table?select=alias:target(*)&target.order=id`
-
-  This feature will be removed in a future release, so you should start using the ``alias`` in these cases.

docs/references/connection_pool.rst

@@ -15,7 +15,7 @@ Dynamic Connection Pool
 
 To conserve system resources, PostgREST uses a dynamic connection pool. This enables the number of connections in the pool to increase and decrease depending on request traffic.
 
-- If all the connections are being used, a new connection is added. The pool can grow until it reaches the :ref:`db-pool` size. Note that it's pointless to set this higher than the ``max_connections`` setting in your database.
+- If all the connections are being used, a new connection is added. The pool can grow until it reaches the :ref:`db-pool` size. Note that it’s pointless to set this higher than the ``max_connections`` setting in your database.
 - If a connection is unused for a period of time (:ref:`db-pool-max-idletime`), it will be released.
 - For connecting to the database, the :ref:`authenticator <roles>` role is used. You can configure this using :ref:`db-uri`.
 
@@ -47,8 +47,6 @@ Under a busy system, the :ref:`db-pool-max-idletime` won't be reached and the co
 To avoid this problem and save resources, a connection max lifetime (:ref:`db-pool-max-lifetime`) is enforced.
 After the max lifetime is reached, connections from the pool will be released and new ones will be created. This doesn't affect running requests, only unused connections will be released.
 
-.. _pool_timeout:
-
 Acquisition Timeout
 -------------------
 
@@ -108,4 +106,4 @@ Also set :ref:`db-channel-enabled` to ``false`` since ``LISTEN`` is not compatib
 
 .. note::
 
-  It's not recommended to use an external connection pooler. `Our benchmarks <https://github.com/PostgREST/postgrest/issues/2294#issuecomment-1139148672>`_ indicate it provides much lower performance than PostgREST built-in pool.
+  It’s not recommended to use an external connection pooler. `Our benchmarks <https://github.com/PostgREST/postgrest/issues/2294#issuecomment-1139148672>`_ indicate it provides much lower performance than PostgREST built-in pool.

docs/references/errors.rst

@@ -5,8 +5,6 @@ Errors
 
 PostgREST error messages follow the PostgreSQL error structure. It includes ``MESSAGE``, ``DETAIL``, ``HINT``, ``ERRCODE`` and will add an HTTP status code to the response.
 
-.. _postgresql_errors:
-
 Errors from PostgreSQL
 ======================
 
@@ -199,7 +197,7 @@ Related to the HTTP request elements.
 |               |             | :ref:`switching schemas <multiple-schemas>` is not present  |
 | PGRST106      |             | in the :ref:`db-schemas` configuration variable.            |
 +---------------+-------------+-------------------------------------------------------------+
-| .. _pgrst107: | 406         | The ``Accept`` media type sent in the request is invalid.   |
+| .. _pgrst107: | 415         | The ``Content-Type`` sent in the request is invalid.        |
 |               |             |                                                             |
 | PGRST107      |             |                                                             |
 +---------------+-------------+-------------------------------------------------------------+
@@ -207,6 +205,14 @@ Related to the HTTP request elements.
 |               |             | specified in the ``select`` part of the query string.       |
 | PGRST108      |             | See :ref:`embed_filters`.                                   |
 +---------------+-------------+-------------------------------------------------------------+
+| .. _pgrst109: | 400         | Restricting a Deletion or an Update using limits must       |
+|               |             | include the ordering of a unique column.                    |
+| PGRST109      |             | See :ref:`limited_update_delete`.                           |
++---------------+-------------+-------------------------------------------------------------+
+| .. _pgrst110: | 400         | When restricting a Deletion or an Update using limits       |
+|               |             | modifies more rows than the maximum specified in the limit. |
+| PGRST110      |             | See :ref:`limited_update_delete`.                           |
++---------------+-------------+-------------------------------------------------------------+
 | .. _pgrst111: | 500         | An invalid ``response.headers`` was set.                    |
 |               |             | See :ref:`guc_resp_hdrs`.                                   |
 | PGRST111      |             |                                                             |
@@ -235,6 +241,10 @@ Related to the HTTP request elements.
 |               |             | there is no many-to-one or one-to-one relationship between  |
 | PGRST118      |             | them.                                                       |
 +---------------+-------------+-------------------------------------------------------------+
+| .. _pgrst119: | 400         | Could not use the spread operator on the related table      |
+|               |             | because there is no many-to-one or one-to-one relationship  |
+| PGRST119      |             | between them.                                               |
++---------------+-------------+-------------------------------------------------------------+
 | .. _pgrst120: | 400         | An embedded resource can only be filtered using the         |
 |               |             | ``is.null`` or ``not.is.null`` :ref:`operators <operators>`.|
 | PGRST120      |             |                                                             |
@@ -247,31 +257,6 @@ Related to the HTTP request elements.
 |               |             | ``Prefer: handling=strict``. See :ref:`prefer_handling`.    |
 | PGRST122      |             |                                                             |
 +---------------+-------------+-------------------------------------------------------------+
-| .. _pgrst123: | 400         | Aggregate functions are disabled.                           |
-|               |             | See :ref:`db-aggregates-enabled`.                           |
-| PGRST123      |             |                                                             |
-+---------------+-------------+-------------------------------------------------------------+
-| .. _pgrst124: | 400         | ``max-affected`` preference is violated.                    |
-|               |             | See :ref:`prefer_max_affected`.                             |
-| PGRST124      |             |                                                             |
-+---------------+-------------+-------------------------------------------------------------+
-| .. _pgrst125: | 404         | Invalid path is specified in request URL.                   |
-|               |             |                                                             |
-| PGRST125      |             |                                                             |
-+---------------+-------------+-------------------------------------------------------------+
-| .. _pgrst126: | 404         | Open API config is disabled but API root path is            |
-|               |             | accessed. See :ref:`openapi-mode`.                          |
-| PGRST126      |             |                                                             |
-+---------------+-------------+-------------------------------------------------------------+
-| .. _pgrst127: | 400         | The feature specified in the ``details`` field is not       |
-|               |             | implemented.                                                |
-| PGRST127      |             |                                                             |
-+---------------+-------------+-------------------------------------------------------------+
-| .. _pgrst128: | 400         | ``max-affected`` preference is violated with ``RPC`` call.  |
-|               |             | See :ref:`prefer_max_affected`.                             |
-| PGRST128      |             |                                                             |
-+---------------+-------------+-------------------------------------------------------------+
-
 
 .. _pgrst2**:
 
@@ -305,10 +290,6 @@ Related to a :ref:`schema_cache`. Most of the time, these errors are solved by :
 |               |             | in the ``columns`` query parameter is not found.            |
 | PGRST204      |             |                                                             |
 +---------------+-------------+-------------------------------------------------------------+
-| .. _pgrst205: | 404         | Caused when the :ref:`table specified <tables_views>` in    |
-|               |             | the URI is not found.                                       |
-| PGRST205      |             |                                                             |
-+---------------+-------------+-------------------------------------------------------------+
 
 .. _pgrst3**:
 
@@ -324,18 +305,14 @@ Related to the authentication process using JWT. You can follow the :ref:`tut1`
 |               |             | configuration.                                              |
 | PGRST300      |             |                                                             |
 +---------------+-------------+-------------------------------------------------------------+
-| .. _pgrst301: | 401         | Provided JWT couldn't be decoded or it is invalid.          |
-|               |             |                                                             |
+| .. _pgrst301: | 401         | Any error related to the verification of the JWT,           |
+|               |             | which means that the JWT provided is invalid in some way.   |
 | PGRST301      |             |                                                             |
 +---------------+-------------+-------------------------------------------------------------+
 | .. _pgrst302: | 401         | Attempted to do a request without                           |
-|               |             | :ref:`bearer_auth` when the anonymous role                  |
+|               |             | :ref:`authentication <client_auth>` when the anonymous role |
 | PGRST302      |             | is disabled by not setting it in :ref:`db-anon-role`.       |
 +---------------+-------------+-------------------------------------------------------------+
-| .. _pgrst303: | 401         | :ref:`JWT claims validation <jwt_claims_validation>`        |
-|               |             | or parsing failed.                                          |
-| PGRST303      |             |                                                             |
-+---------------+-------------+-------------------------------------------------------------+
 
 .. The Internal Errors Group X** is always at the end
 
@@ -354,8 +331,6 @@ Internal errors. If you encounter any of these, you may have stumbled on a Postg
 | PGRSTX00      |             |                                                             |
 +---------------+-------------+-------------------------------------------------------------+
 
-.. _custom_errors:
-
 Custom Errors
 =============
 
@@ -452,59 +427,3 @@ For non standard HTTP status, you can optionally add ``status_text`` to describe
   detail = '{"status":419,"status_text":"Page Expired","headers":{"X-Powered-By":"Nerd Rage"}}';
 
 If PostgREST can't parse the JSON objects ``message`` and ``detail``, it will throw a ``PGRST121`` error. See :ref:`Errors from PostgREST<pgrst1**>`.
-
-.. _proxy-status_header:
-
-Proxy-Status Header
-===================
-
-For error cases, the standard `Proxy-Status <https://www.rfc-editor.org/rfc/rfc9209.html#name-the-proxy-status-http-field>`_ header is returned with the error code. The error code comes from either :ref:`PostgREST <pgrst_errors>`, :ref:`PostgreSQL <postgresql_errors>` or :ref:`Custom <custom_errors>` errors. This is useful when doing ``HEAD`` requests where the HTTP status is not descriptive enough.
-
-For example, doing a request on a table with high count (say 30_000_000), we get:
-
-.. code-block:: http
-
-  HEAD /table HTTP/1.1
-  Prefer: count=exact
-
-.. code-block:: http
-
-  HTTP/1.1 500 Internal Server Error
-  Proxy-Status: PostgREST; error=57014
-
-The PostgreSQL error code ``57014`` (`ref <https://www.postgresql.org/docs/current/errcodes-appendix.html>`_) reveals that the error is due to a short ``statement_timeout`` value.
-
-.. _client_error_verbosity:
-
-Client Error Verbosity
-======================
-
-For HTTP clients, the error verbosity can be set via :ref:`client-error-verbosity` config.
-
-With ``verbose``, it returns ``code``, ``message``, ``details`` and ``hint``.
-
-.. code:: bash
-
-  curl "localhost:3000/itemsxx"
-
-.. code-block:: json
-
-  {
-      "code": "PGRST205",
-      "message": "Could not find the table 'public.itemsxx' in the schema cache",
-      "details": "Perhaps you meant the table 'public.items'",
-      "hint": null
-  }
-
-With ``minimal``, just ``code`` and ``message`` is returned.
-
-.. code:: bash
-
-  curl "localhost:3000/itemsxx"
-
-.. code-block:: json
-
-  {
-      "code": "PGRST205",
-      "message": "Could not find the table 'public.itemsxx' in the schema cache"
-  }

docs/references/http_server.rst

@@ -1,18 +0,0 @@
-.. _http_server:
-
-HTTP Server
-###########
-
-The HTTP server is provided by `Warp <https://aosabook.org/en/posa/warp.html>`_.
-
-Graceful shutdown
------------------
-
-PostgREST uses Warp's graceful shutdown, when a ``SIGTERM`` is received:
-
-- It stops accepting new requests.
-- Allows requests that are already in progress to finish.
-- Closes idle ``Keep-Alive`` connections instead of waiting for them to expire.
-- Responses sent during shutdown indicate that the connection should not be reused (e.g. for HTTP/1.x, it sends ``Connection: close``).
-
-This allows PostgREST to shut down promptly without interrupting in-flight requests. Useful for zero-downtime upgrades and autoscaling/load-balancing under cloud environments (AWS ECS, Kubernetes).

docs/references/listener.rst

@@ -4,7 +4,7 @@ Listener
 ########
 
 PostgREST uses `LISTEN <https://www.postgresql.org/docs/current/sql-listen.html>`_ to reload its :ref:`Schema Cache <schema_reloading_notify>` and :ref:`Configuration <config_reloading_notify>` via `NOTIFY <https://www.postgresql.org/docs/current/sql-notify.html>`_.
-This is useful in environments where you can't send SIGUSR1 or SIGUSR2 Unix Signals.
+This is useful in environments where you can’t send SIGUSR1 or SIGUSR2 Unix Signals.
 Like on cloud managed containers or on Windows systems.
 
 .. code:: postgresql
@@ -46,9 +46,7 @@ This will cause the :ref:`connection_pool` to connect to the read replica host a
 
 .. note::
 
-  - Under the hood, PostgREST forces `target_session_attrs=read-write <https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNECT-TARGET-SESSION-ATTRS>`_ for the ``LISTEN`` session.
-    So if you specify ``target_session_attrs=read-only`` as mentioned above, PostgREST will override it for the ``LISTEN``.
-  - ``read-only`` is only available on libpq >= 14, if you use a lower version you will get an error like ``invalid target_session_attrs value: \"read-only\"``.
+  Under the hood, PostgREST forces `target_session_attrs=read-write <https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNECT-TARGET-SESSION-ATTRS>`_ for the ``LISTEN`` session.
 
 .. _listener_automatic_recovery:
 

docs/references/observability.rst

@@ -15,14 +15,12 @@ Observability allows measuring a system's current state based on the data it gen
 Logs
 ====
 
-PostgREST logs basic request information to ``stdout``, including the authenticated user if available, the requesting IP address and user agent, the URL requested, the HTTP response status and the response body size in bytes if available.
-
-With :ref:`log-level` set to ``info``, we get:
+PostgREST logs basic request information to ``stdout``, including the authenticated user if available, the requesting IP address and user agent, the URL requested, and HTTP response status.
 
 .. code::
 
-   127.0.0.1 - user [26/Jul/2021:01:56:38 -0500] "GET /clients HTTP/1.1" 200 56 "" "curl/7.64.0"
-   127.0.0.1 - anonymous [26/Jul/2021:01:56:48 -0500] "GET /unexistent HTTP/1.1" 404 162 "" "curl/7.64.0"
+   127.0.0.1 - user [26/Jul/2021:01:56:38 -0500] "GET /clients HTTP/1.1" 200 - "" "curl/7.64.0"
+   127.0.0.1 - anonymous [26/Jul/2021:01:56:48 -0500] "GET /unexistent HTTP/1.1" 404 - "" "curl/7.64.0"
 
 For diagnostic information about the server itself, PostgREST logs to ``stderr``:
 
@@ -33,50 +31,22 @@ For diagnostic information about the server itself, PostgREST logs to ``stderr``
 .. code::
 
    06/May/2024:08:16:11 -0500: Starting PostgREST 12.1...
+   06/May/2024:08:16:11 -0500: Attempting to connect to the database...
    06/May/2024:08:16:11 -0500: Successfully connected to PostgreSQL 14.10 (Ubuntu 14.10-0ubuntu0.22.04.1) on x86_64-pc-linux-gnu, compiled by gcc (Ubuntu 11.4.0-1ubuntu1~22.04) 11.4.0, 64-bit
-   06/May/2024:08:16:11 -0500: Connection Pool initialized with a maximum size of 10 connections
-   06/May/2024:08:16:11 -0500: API server listening on port 3000
-   06/May/2024:08:16:11 -0500: Listening for database notifications on the "pgrst" channel
+   06/May/2024:08:16:11 -0500: Listening on port 3000
+   06/May/2024:08:16:11 -0500: Listening for notifications on the "pgrst" channel
    06/May/2024:08:16:11 -0500: Config reloaded
    06/May/2024:08:16:11 -0500: Schema cache queried in 3.8 milliseconds
-   06/May/2024:08:16:11 -0500: Schema cache loaded 15 Relations, 8 Relationships, 8 RPCs, 0 Domain Representations, 4 Media Type Handlers
+   06/May/2024:08:16:11 -0500: Schema cache loaded 15 Relations, 8 Relationships, 8 Functions, 0 Domain Representations, 4 Media Type Handlers
    06/May/2024:14:11:27 -0500: Received a config reload message on the "pgrst" channel
    06/May/2024:14:11:27 -0500: Config reloaded
 
-.. note::
-
-  Logs are based on the ``log-level`` setting. See :ref:`log-level`.
-
-.. _sql_query_logs:
-
-SQL Query Logs
---------------
-
-To log the SQL queries executed for a request, set the :ref:`log-query` to ``true``. It will be logged based on the current :ref:`log-level` setting.
-
-.. code-block:: bash
-
-  log-level = "warn"
-  log-query = "true"
-
-The SQL queries will only be logged on ``400`` HTTP errors and up.
-So, if the user requests a resource without sufficient privileges:
-
-.. code-block:: bash
-
-  curl "localhost:3000/protected_table"
-
-This will be logged by PostgREST:
-
-.. code::
-
-  17/Feb/2025:17:28:15 -0500: WITH pgrst_source AS ( SELECT "public"."protected_table".* FROM "public"."protected_table"  )  SELECT null::bigint AS total_result_set, pg_catalog.count(_postgrest_t) AS page_total, coalesce(json_agg(_postgrest_t), '[]') AS body, nullif(current_setting('response.headers', true), '') AS response_headers, nullif(current_setting('response.status', true), '') AS response_status, '' AS response_inserted FROM ( SELECT * FROM pgrst_source ) _postgrest_t
-  127.0.0.1 - web_anon [17/Feb/2025:17:28:15 -0500] "GET /protected_table HTTP/1.1" 401 99 "" "curl/8.7.1"
-
 Database Logs
 -------------
 
-Additionally, to find all the SQL operations, you can watch the database logs. By default PostgreSQL does not keep these logs, so you'll need to make the configuration changes below.
+Currently PostgREST doesn't log the SQL commands executed against the underlying database.
+
+To find the SQL operations, you can watch the database logs. By default PostgreSQL does not keep these logs, so you'll need to make the configuration changes below.
 
 Find :code:`postgresql.conf` inside your PostgreSQL data directory (to find that, issue the command :code:`show data_directory;`). Either find the settings scattered throughout the file and change them to the following values, or append this block of code to the end of the configuration file.
 
@@ -120,17 +90,12 @@ Restart the database and watch the log file in real-time to understand how HTTP
 Metrics
 =======
 
-The ``metrics`` endpoint on the :ref:`admin_server` endpoint provides metrics in `Prometheus text format <https://prometheus.io/docs/instrumenting/exposition_formats/#prometheus-text-format>`_.
+The ``metrics`` endpoint on the :ref:`admin_server` endpoint provides metrics in `Prometheus text format <https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format>`_.
 
 .. code-block:: bash
 
   curl "http://localhost:3001/metrics"
 
-.. code-block:: http
-
-  HTTP/1.1 200 OK
-  Content-Type: text/plain; charset=utf-8
-
   # HELP pgrst_schema_cache_query_time_seconds The query time in seconds of the last schema cache load
   # TYPE pgrst_schema_cache_query_time_seconds gauge
   pgrst_schema_cache_query_time_seconds 1.5937927e-2
@@ -204,79 +169,6 @@ pgrst_db_pool_max
 
 Max pool connections.
 
-.. _jwt_cache_metrics:
-
-JWT Cache Metrics
------------------
-
-Metrics related to the :ref:`jwt_caching`.
-
-pgrst_jwt_cache_requests_total
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-======== =======
-**Type** Counter
-======== =======
-
-The total number of JWT cache lookups.
-
-pgrst_jwt_cache_hits_total
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-======== =======
-**Type** Counter
-======== =======
-
-The total number of JWT cache hits.
-
-pgrst_jwt_cache_evictions_total
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-======== =======
-**Type** Counter
-======== =======
-
-The total number of JWT cache evictions.
-
-GHC Runtime Metrics
--------------------
-
-PostgREST can also expose GHC runtime system metrics. These use the ``ghc_*``
-prefix and include
-`GHC RTS statistics <https://ghc.gitlab.haskell.org/ghc/doc/libraries/base-4.22.0.0-inplace/GHC-Stats.html#g:1>`_
-for runtime allocation, garbage collection, memory, and CPU/elapsed time.
-
-These are useful for monitoring PostgREST process health and diagnosing memory
-pressure or GC behavior.
-
-To expose these metrics, enable GHC RTS statistics when starting PostgREST:
-
-.. code-block:: bash
-
-  postgrest +RTS -T -RTS
-
-When enabled, the admin ``/metrics`` endpoint includes samples such as:
-
-.. code-block:: text
-
-  # HELP ghc_gcs_total Total number of GCs
-  # TYPE ghc_gcs_total counter
-  ghc_gcs_total 1
-  # HELP ghc_allocated_bytes_total Total bytes allocated
-  # TYPE ghc_allocated_bytes_total counter
-  ghc_allocated_bytes_total 12345678
-
-Other available GHC runtime metrics include:
-
-- ``ghc_gcs_total``
-- ``ghc_major_gcs_total``
-- ``ghc_allocated_bytes_total``
-- ``ghc_max_live_bytes``
-- ``ghc_max_mem_in_use_bytes``
-- ``ghc_mutator_cpu_seconds_total``
-- ``ghc_gc_cpu_seconds_total``
-- ``ghc_elapsed_seconds_total``
-
 Traces
 ======
 
@@ -312,17 +204,12 @@ You can enable tracing HTTP requests by setting :ref:`server-trace-header`. Spec
   HTTP/1.1 200 OK
   X-Request-Id: 123
 
-Proxy-Status Header
--------------------
-
-See :ref:`proxy-status_header`.
-
 .. _server-timing_header:
 
 Server-Timing Header
 --------------------
 
-You can enable the `Server-Timing <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Server-Timing>`_ header by setting :ref:`server-timing-enabled` on.
+You can enable the `Server-Timing <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing>`_ header by setting :ref:`server-timing-enabled` on.
 This header communicates metrics of the different phases in the request-response cycle.
 
 .. code-block:: bash
@@ -336,7 +223,7 @@ This header communicates metrics of the different phases in the request-response
   Server-Timing: jwt;dur=14.9, parse;dur=71.1, plan;dur=109.0, transaction;dur=353.2, response;dur=4.4
 
 - All the durations (``dur``) are in milliseconds.
-- The ``jwt`` stage is when :ref:`jwt_auth` is done. This duration can be lowered with :ref:`jwt_caching`.
+- The ``jwt`` stage is when :ref:`jwt_impersonation` is done. This duration can be lowered with :ref:`jwt_caching`.
 - On the ``parse`` stage, the :ref:`url_grammar` is parsed.
 - On the ``plan`` stage, the :ref:`schema_cache` is used to generate the :ref:`main_query` of the transaction.
 - The ``transaction`` stage corresponds to the database transaction. See :ref:`transactions`.
@@ -346,27 +233,6 @@ This header communicates metrics of the different phases in the request-response
 
   We're working on lowering the duration of the ``parse`` and ``plan`` stages on https://github.com/PostgREST/postgrest/issues/2816.
 
-.. _content-length_header:
-
-Content-Length Header
----------------------
-
-You can verify the response body size in bytes in the `Content-Length header <https://httpwg.org/specs/rfc9110.html#field.content-length>`_.
-
-.. code-block:: bash
-
-  curl -i 'localhost:3000/users'
-
-.. code-block:: http
-
-  HTTP/1.1 200 OK
-  Content-Length: 104
-
-Note that this header won't be returned on ``HEAD`` requests for optimization purposes (see :ref:`head_req`).
-This is in line with `RFC 9110 <https://httpwg.org/specs/rfc9110.html#field.content-length>`_.
-
-The body size is also present in the :ref:`PostgREST logs <pgrst_logging>`.
-
 .. _explain_plan:
 
 Execution plan
@@ -430,8 +296,6 @@ By default the plan is assumed to generate the JSON representation of a resource
 
 The other available parameters are ``analyze``, ``verbose``, ``settings``, ``buffers`` and ``wal``, which correspond to the `EXPLAIN command options <https://www.postgresql.org/docs/current/sql-explain.html>`_. To use the ``analyze`` and ``wal`` parameters for example, you would add them like ``Accept: application/vnd.pgrst.plan; options=analyze|wal``.
 
-For a workflow that takes the ``Query Identifier`` from a verbose PostgREST plan and uses it to inspect the same query in ``pg_stat_statements``, see :ref:`debugging_performance_pg_stat_statements`.
-
 Note that akin to the EXPLAIN command, the changes will be committed when using the ``analyze`` option. To avoid this, you can use the :ref:`db-tx-end` and the ``Prefer: tx=rollback`` header.
 
 Securing the Execution Plan

docs/references/schema_cache.rst

@@ -3,16 +3,10 @@
 Schema Cache
 ============
 
-PostgREST requires metadata from the database to provide a REST API that abstracts SQL details. One example of this is the interface for :ref:`resource_embedding`.
+PostgREST requires metadata from the database schema to provide a REST API that abstracts SQL details. One example of this is the interface for :ref:`resource_embedding`.
 
 Getting this metadata requires expensive queries. To avoid repeating this work, PostgREST uses a schema cache.
 
-.. note::
-
-  - Schema cache queries have been optimized over time to stay fast, even on complex databases. You can see a summary of their execution time in :ref:`pgrst_logging` and :ref:`metrics`.
-  - If the schema cache queries are slow, the most likely cause is *system catalog bloat*, see `issue#3212 <https://github.com/PostgREST/postgrest/issues/3212>`_ for more details.
-  - You can turn the :ref:`log-level` to ``debug`` to see the time of each schema cache query.
-
 .. _schema_reloading:
 
 Schema Cache Reloading
@@ -24,7 +18,7 @@ You can do this with UNIX signals or with PostgreSQL notifications. It's also po
 
 .. note::
 
-  - If the schema cache fails to reload (e.g. due to a ``statement_timeout`` or :ref:`pool timeout <pool_timeout>`), PostgREST will continue serving requests in a "best effort" basis.
+  - Requests will wait until the schema cache reload is done. This to prevent client errors due to an stale schema cache.
   - If you are using the :ref:`in_db_config`, a schema cache reload will :ref:`reload the configuration<config_reloading>` as well.
 
 .. _schema_reloading_signals:
@@ -59,19 +53,6 @@ To reload the schema cache from within the database, you can use the ``NOTIFY``
 
   NOTIFY pgrst, 'reload schema'
 
-Debouncing
-~~~~~~~~~~
-
-PostgREST does not reload the schema cache for each notification when several ``NOTIFY pgrst`` events are generated quickly after one another.
-
-There are two cases to consider: when notifications are sent within a single transaction and when they are sent across multiple transactions.
-
-In the first case, PostgreSQL deduplicates identical ``NOTIFY`` events within the same transaction. This means that even if multiple ``NOTIFY pgrst`` statements are executed before a ``COMMIT``, only a single notification is delivered to PostgREST.
-
-In the second case, when notifications are sent from separate transactions in a short time span, PostgREST applies a debouncing mechanism to avoid excessive schema cache reloads.
-
-Instead of reloading the schema cache for each notification, events are grouped within a small time window of 100 milliseconds. The reload function is executed once immediately when the first notification is received and once more after the burst of events settles, resulting in at most two executions within that time window.
-
 .. _auto_schema_reloading:
 
 Automatic Schema Cache Reloading

docs/references/transactions.rst

@@ -221,7 +221,7 @@ Notice that the ``response.headers`` should be set to an *array* of single-key o
 
 .. note::
 
-  PostgREST provided headers such as ``Content-Type``, ``Location``, etc. can be overridden this way. Note that irrespective of overridden ``Content-Type`` response header, the content will still be converted to JSON, unless you use :ref:`custom_media`.
+  PostgREST provided headers such as ``Content-Type``, ``Location``, etc. can be overriden this way. Note that irrespective of overridden ``Content-Type`` response header, the content will still be converted to JSON, unless you use :ref:`custom_media`.
 
 .. _guc_resp_status:
 
@@ -284,10 +284,11 @@ However, starting from PostgreSQL 15, you can grant privileges for these setting
 
   GRANT SET ON PARAMETER <setting> TO <authenticator>;
 
-Hoisted Function Settings
-~~~~~~~~~~~~~~~~~~~~~~~~~
+Function Settings
+~~~~~~~~~~~~~~~~~
 
-PostgREST can "hoist" function settings to transaction-scoped settings. This allows functions settings to override the impersonated and connection role settings.
+In addition to :ref:`impersonated_settings`, PostgREST will also apply function settings as transaction-scoped settings. This allows functions settings to override
+the impersonated and connection role settings.
 
 .. code-block:: postgres
 
@@ -302,7 +303,7 @@ When calling the above function (see :ref:`functions`), the statement timeout wi
 
 .. note::
 
-   Only the settings in :ref:`db-hoisted-tx-settings` will be hoisted.
+   Only the transactions that are hoisted by config :ref:`db-hoisted-tx-settings` will be applied.
 
 .. _main_query:
 

docs/requirements.txt

@@ -1,7 +1,9 @@
-# This file is auto-generated by postgrest-nixpkgs-upgrade
-sphinx==9.1.0
-sphinx-copybutton==0.5.2
-sphinx-rtd-dark-mode==1.3.0
-sphinx-rtd-theme==3.1.0
-sphinx-tabs==3.5.0
-sphinxext-opengraph==0.13.0
+docutils==0.20.1
+sphinx-copybutton
+sphinx-intl
+sphinx-rtd-theme>=0.5.1
+sphinx-rtd-dark-mode>=1.3.0
+sphinx-tabs>=3.2.0
+sphinx>=5.0.2
+sphinxext-opengraph==0.9.1
+urllib3==2.2.3

docs/shared/installation.rst

@@ -28,7 +28,7 @@
 
           pacman -S postgrest
 
-      .. tab:: Nix via nixpkgs
+      .. tab:: Nix
 
         You can install PostgREST from nixpkgs.
 
@@ -36,17 +36,6 @@
 
           nix-env -i postgrest
 
-      .. tab:: Nix via flake
-
-        You can install PostgREST via flake.
-
-        .. code:: nix
-
-          {
-            inputs.postgrest.url = "github:postgrest/postgrest";
-            # ...
-          }
-
   .. group-tab:: Windows
 
     You can install PostgREST using `Chocolatey <https://community.chocolatey.org/packages/postgrest>`_ or `Scoop <https://github.com/ScoopInstaller/Scoop>`_.

docs/tutorials/tut0.rst

@@ -22,7 +22,7 @@ Step 1. Install PostgreSQL
 
 If you're already familiar with using PostgreSQL and have it installed on your system you can use the existing installation (see :ref:`pg-dependency` for minimum requirements). For this tutorial we'll describe how to use the database in Docker because database configuration is otherwise too complicated for a simple tutorial.
 
-If Docker is not installed, you can get it `here <https://www.docker.com/get-started>`_. Make sure that Docker service is `started <https://docs.docker.com/engine/daemon/start/#start-the-daemon-using-operating-system-utilities>`_. Next, let's pull and start the database image:
+If Docker is not installed, you can get it `here <https://www.docker.com/get-started>`_. Next, let's pull and start the database image:
 
 .. code-block:: bash
 
@@ -213,8 +213,12 @@ You should see something similar to:
 .. code-block:: text
 
   Starting PostgREST 12.0.2...
-  Successfully connected to PostgreSQL 14.10 (Ubuntu 14.10-0ubuntu0.22.04.1) on x86_64-pc-linux-gnu, compiled by gcc (Ubuntu 11.4.0-1ubuntu1~22.04) 11.4.0, 64-bit
-  API server listening on port 3000
+  Attempting to connect to the database...
+  Connection successful
+  Listening on port 3000
+  Config reloaded
+  Listening for notifications on the pgrst channel
+  Schema cache loaded
 
 It's now ready to serve web requests. There are many nice graphical API exploration tools you can use, but for this tutorial we'll use :code:`curl` because it's likely to be installed on your system already. Open a new terminal (leaving the one open that PostgREST is running inside). Try doing an HTTP request for the todos.
 

docs/tutorials/tut1.rst

@@ -52,31 +52,17 @@ Check that the :code:`tutorial.conf` (created in the previous tutorial) has the
 
 If the PostgREST server is still running from the previous tutorial, restart it to load the updated configuration file.
 
-.. _tut1_step3:
-
 Step 3. Sign a Token
 --------------------
 
-Ordinarily your own code in the database or in another server will create and sign authentication tokens, but for this tutorial we will make one "by hand" using ``bash`` and ``openssl``.
+Ordinarily your own code in the database or in another server will create and sign authentication tokens, but for this tutorial we will make one "by hand." Go to `jwt.io <https://jwt.io/#debugger-io>`_ and fill in the fields like this:
 
-.. code:: bash
+.. figure:: ../_static/tuts/tut1-jwt-io.png
+   :alt: jwt.io interface
 
-  #!/bin/bash
-  set -e
+   How to create a token at https://jwt.io
 
-  JWT_SECRET='test_secret_that_is_at_least_32_characters_long'
-
-  _base64 () { openssl base64 -e -A | tr '+/' '-_' | tr -d '='; }
-
-  header=$(echo -n '{"alg":"HS256","typ":"JWT"}' | _base64)
-
-  payload=$(echo -n "{\"role\":\"todo_user\"}" | _base64)
-
-  signature=$(echo -n "$header.$payload" | openssl dgst -sha256 -hmac "$JWT_SECRET" -binary | _base64)
-
-  echo -n "$header.$payload.$signature"
-
-**Remember to fill in the secret you generated rather than keeping the "test_secret_that_is_at_least_32_characters_long".** After you have filled in the secret and payload, the encoded data on the left will update. Copy the encoded token.
+**Remember to fill in the secret you generated rather than the word "secret".** After you have filled in the secret and payload, the encoded data on the left will update. Copy the encoded token.
 
 .. note::
 
@@ -159,22 +145,14 @@ To observe expiration in action, we'll add an :code:`exp` claim of five minutes
 
   select extract(epoch from now() + '5 minutes'::interval) :: integer;
 
-Or in ``bash``:
+Go back to jwt.io and change the payload to
 
+.. code-block:: json
 
-.. code-block:: bash
-
-  exp=$(( EPOCHSECONDS + 5*60 ))  # five minutes
-
-  echo $exp
-
-Go back to :ref:`tut1_step3` and change the payload to
-
-.. code-block:: bash
-
-  payload=$(echo -n "{\"role\":\"todo_user\",\"exp\":123456789}" | _base64)
-
-  echo -n "$header.$payload.$signature"
+  {
+    "role": "todo_user",
+    "exp": 123456789
+  }
 
 **NOTE**: Don't forget to change the dummy epoch value :code:`123456789` in the snippet above to the epoch value returned by the :code:`psql` command.
 

flake.lock

@@ -1,27 +0,0 @@
-{
-  "nodes": {
-    "nixpkgs": {
-      "locked": {
-        "lastModified": 1784115452,
-        "narHash": "sha256-BoYPdqk6jlKXy+DyUzyGV/CtRGfAhk2MmIgBhsemTGI=",
-        "owner": "nixos",
-        "repo": "nixpkgs",
-        "rev": "35d3407a3816f3b341d8cf1d60abaf2b7b8166ac",
-        "type": "github"
-      },
-      "original": {
-        "owner": "nixos",
-        "ref": "nixpkgs-unstable",
-        "repo": "nixpkgs",
-        "type": "github"
-      }
-    },
-    "root": {
-      "inputs": {
-        "nixpkgs": "nixpkgs"
-      }
-    }
-  },
-  "root": "root",
-  "version": 7
-}

flake.nix

@@ -1,54 +0,0 @@
-{
-  description = "REST API for any Postgres database";
-
-  inputs = {
-    nixpkgs.url = "github:nixos/nixpkgs/nixpkgs-unstable";
-  };
-
-  nixConfig = {
-    extra-substituters = "https://postgrest.cachix.org";
-    extra-trusted-public-keys = "postgrest.cachix.org-1:icgW4R15fz1+LqvhPjt4EnX/r19AaqxiVV+1olwlZtI=";
-  };
-
-  outputs = { nixpkgs, ... }:
-    let
-      systems = [
-        "aarch64-darwin"
-        "aarch64-linux"
-        "x86_64-darwin"
-        "x86_64-linux"
-      ];
-
-      pgrstFor = system: import ./default.nix {
-        inherit system;
-        nixpkgsVersion = {
-          owner = "nixos";
-          repo = "nixpkgs";
-          inherit (nixpkgs) rev;
-          tarballHash = nixpkgs.narHash;
-        };
-      };
-
-      genSystems = f: nixpkgs.lib.genAttrs systems (system: f (pgrstFor system));
-    in
-    {
-      packages = genSystems (attrs: {
-        default = attrs.postgrestPackage.bin;
-        profiled = attrs.postgrestProfiled.bin;
-      } // nixpkgs.lib.optionalAttrs (attrs ? postgrestStatic) {
-        static = attrs.postgrestStatic;
-      });
-
-      apps = genSystems (attrs: {
-        default = {
-          type = "app";
-          program = "${attrs.postgrestStatic or attrs.postgrestPackage.bin}/bin/postgrest";
-          meta.description = "REST API for any Postgres database";
-        };
-      });
-
-      devShells = genSystems (postgrest: {
-        default = import ./shell.nix { inherit postgrest; };
-      });
-    };
-}

nix/README.md

@@ -70,16 +70,47 @@ The PostgREST utilities available in `nix-shell` all have names that begin with
 `<tab>`) in `nix-shell` to see all that are available:
 
 ```bash
+# Note: The utilities listed here might not be up to date.
 [nix-shell]$ postgrest-<tab>
-postgrest-build
-postgrest-cabal-update
-postgrest-check
-postgrest-clean
-postgrest-commitlint
+postgrest-build                   postgrest-test-spec
+postgrest-check                   postgrest-watch
+postgrest-clean                   postgrest-with-all
+postgrest-coverage                postgrest-with-postgresql-10
+postgrest-lint                    postgrest-with-postgresql-11
+postgrest-run                     postgrest-with-postgresql-12
+postgrest-style                   postgrest-with-postgresql-13
+postgrest-style-check             postgrest-with-postgresql-9.6
+postgrest-test-io
 ...
+
+[nix-shell]$
+
 ```
 
-Most of these commands provide a `--help` output, make sure to check it out.
+Some additional modules like `memory`, `docker` and `release`
+have large dependencies that would need to be built before the shell becomes
+available, which could take an especially long time if the cachix binary cache
+is not used. You can activate those by passing a flag to `nix-shell` with
+`nix-shell --arg <module> true`. This will make the respective utilities available:
+
+```bash
+$ nix-shell --arg memory true
+[nix-shell]$ postgrest-<tab>
+postgrest-build                   postgrest-test-spec
+postgrest-check                   postgrest-watch
+postgrest-clean                   postgrest-with-all
+postgrest-coverage                postgrest-with-postgresql-10
+postgrest-lint                    postgrest-with-postgresql-11
+postgrest-run                     postgrest-with-postgresql-12
+postgrest-style                   postgrest-with-postgresql-13
+postgrest-style-check             postgrest-with-postgresql-9.6
+postgrest-test-io
+postgrest-test-memory
+...
+
+```
+
+Note that `postgrest-test-memory` is now also available.
 
 To run one-off commands, you can also use `nix-shell --run <command>`, which
 will launch the Nix shell, run that one command and exit. Note that the tab
@@ -95,6 +126,16 @@ $ nix-shell --run "postgrest-foo --bar"
 
 ```
 
+A third option is to install utilities that you use very often locally:
+
+```bash
+$ nix-env -f default.nix -iA devTools
+
+# `postgrest-style` can now be run directly:
+$ postgrest-style
+
+```
+
 If you use `nix-shell` very often, you might like to use
 https://github.com/xzfc/cached-nix-shell, which skips evaluating all our Nix
 expressions if nothing changed, reducing startup time for the shell
@@ -125,7 +166,7 @@ $ nix-shell --run "postgrest-with-all postgrest-test-spec"
 
 # Run the tests against a specific version of PostgreSQL (use tab-completion in
 # nix-shell to see all available versions):
-$ nix-shell --run "postgrest-with-pg-17 postgrest-test-spec"
+$ nix-shell --run "postgrest-with-postgresql-13 postgrest-test-spec"
 
 ```
 
@@ -160,7 +201,13 @@ The loadtests ensure that performance doesn't drop on a change. Underlyingly the
 [nix-shell]$ postgrest-loadtest
 
 # You can loadtest comparing to a different branch
-[nix-shell]$ postgrest-loadtest-against main
+[nix-shell]$ postgrest-loadtest-against master
+
+# You can simulate latency client/postgrest and postgrest/database
+[nix-shell]$ PGRST_DELAY=5ms PGDELAY=5ms postgrest-loadtest
+
+# You can build postgrest directly with cabal for faster iteration
+[nix-shell]$ PGRST_BUILD_CABAL=1 postgrest-loadtest
 
 # Produce a markdown report to be used on CI
 [nix-shell]$ postgrest-loadtest-report
@@ -229,7 +276,7 @@ Tools like `postgrest-build`, `postgrest-run`, `postgrest-repl` etc. are simple
 also run in CI, with the exception of the IO and Memory checks that need to be run
 separately.
 
-`postgrest-with-pg-*` take a command as an argument and will run it
+`postgrest-with-postgresql-*` take a command as an argument and will run it
 with a temporary database. `postgrest-with-all` will run the command against
 all supported PostgreSQL versions. Tests run without `postgrest-with-*` are
 run against the latest PostgreSQL version by default.
@@ -324,8 +371,10 @@ that).
 
 We also use `default.nix` to load our pinned version of the `nixpkgs`
 repository. This set of packages will always be the same, independently from
-where or when you use it. The pinned version is taken from `flake.lock` and
-can be updated with `postgrest-nixpkgs-upgrade`.
+where or when you use it. The pinned version can be upgraded with the small
+`nixpkgs-upgrade` utility. Running `nixpkgs-upgrade > nix/nixpkgs-version.nix`
+in `nix-shell` will upgrade the pinned version to the latest `nixpkgs-unstable`
+version.
 
 ### `shell.nix`
 

nix/UPGRADE.md

@@ -16,8 +16,11 @@ The following checklist guides you through the complete process in more detail.
 ## Upgrade the pinned version of `nixpkgs`
 
 The pinned version of [`nixpkgs`](https://github.com/NixOS/nixpkgs) is defined
-in [`flake.nix`](../flake.nix). To upgrade it, you can use a small utility
-script defined in [`nix/tools/nixpkgsTools.nix`](tools/nixpkgsTools.nix):
+in [`nix/nixpkgs-version.nix`](nixpkgs-version.nix). The pin refers directly to
+a GitHub tarball for the given revision, which is more efficient than pulling
+the complete Git repository. To upgrade it to the current `main` of
+`nixpkgs`, you can use a small utility script defined in
+[`nix/nixpkgs-update.nix`](nixpkgs-update.nix):
 
 ```bash
 # From the root of the repository, enter nix-shell
@@ -27,12 +30,21 @@ nix-shell
 postgrest-nixpkgs-upgrade
 
 # Exit the nix-shell with Ctrl-d
+
 ```
 
 ## Review overlays
 
 Check whether the individual [overlays](overlays) are still required.
 
+## Check if patches are still required and update them as needed
+
+We track a number of PostgREST-specific patches in [`nix/patches`](patches).
+Check whether the pull-requests/issues linked in the
+[`default.nix`](patches/default.nix) have progressed and remove/modify the
+patches if they did. If conflicting changes occurred, you might have to rebase
+the respective patches.
+
 ## Build everything
 
 Using the PostgREST binary Nix cache is recommended. Install
@@ -46,19 +58,25 @@ errors, this is probably due to one of our patches. Try to fix them and re-run
 
 ## Update the PostgREST binary cache
 
-If you have access to the PostgREST cachix project, you can push the
+If you have access to the PostgREST cachix signing key, you can push the
 artifacts that you built locally to the binary cache. This will accelerate the
 CI builds and tests, sometimes dramatically. This might sometimes even be
 required to avoid build timeouts in CI.
 
-You'll need to login with your token with `cachix authtoken <token>`.
+You'll need to set the `CACHIX_SIGNING_KEY` before proceeding, e.g. by creating
+a file containing `export CACHIX_SIGNING_KEY=...` and sourcing that file, which
+avoids having the secret in your shell history.
 
 To push all new artifacts to Cachix, run:
 
 ```
+nix-store -qR --include-outputs $$(nix-instantiate) | cachix push postgrest
+
+# Or, equivalently
 nix-shell --run postgrest-push-cachix
+
 ```
 
-The `postgrest-push-cachix` command will query the nix-store to list all
-dependencies and build artifacts of PostgREST. It will then push
+The `nix-store` command will query the nix-store to list all dependencies and
+build artifacts of PostgREST. The `cachix` command will efficiently push
 everything that is not yet cached to the binary cache.

nix/docs-extensions/sphinx-rtd-dark-mode.nix

@@ -0,0 +1,46 @@
+{ buildPythonPackage
+, fetchFromGitHub
+, lib
+, nose
+, sphinx
+, sphinx-rtd-theme
+}:
+
+buildPythonPackage rec {
+  pname = "sphinx-rtd-dark-mode";
+  version = "1.3.0";
+  format = "setuptools";
+
+  src = fetchFromGitHub {
+    owner = "MrDogeBro";
+    repo = "sphinx_rtd_dark_mode";
+    rev = "refs/tags/v${version}";
+    hash = "sha256-N5KG2Wqn9wfGNY3VH4FnBce1aZUbnvVmwD10Loe0Qn4=";
+  };
+
+  propagatedBuildInputs = [
+    sphinx-rtd-theme
+  ];
+
+  nativeCheckInputs = [
+    nose
+    sphinx
+  ];
+
+  checkPhase = ''
+    runHook preCheck
+    nosetests tests
+    runHook postCheck
+  '';
+
+  pythonImportsCheck = [
+    "sphinx_rtd_dark_mode"
+  ];
+
+  meta = with lib; {
+    description = "Adds a toggleable dark mode to the Read the Docs theme for Sphinx.";
+    homepage = "https://github.com/MrDogeBro/sphinx_rtd_dark_mode";
+    changelog = "https://github.com/MrDogeBro/sphinx_rtd_dark_mode/releases/tag/v${version}";
+    license = licenses.mit;
+  };
+}

nix/hsie/Main.hs

@@ -4,7 +4,6 @@
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE RecordWildCards   #-}
 {-# LANGUAGE TupleSections     #-}
-{-# LANGUAGE TypeApplications  #-}
 {-# LANGUAGE TypeFamilies      #-}
 
 -- | Haskell Imports and Exports tool
@@ -34,15 +33,13 @@ import Data.Function              ((&))
 import Data.List                  (intercalate)
 import Data.Maybe                 (catMaybes, mapMaybe)
 import Data.Text                  (Text)
-import GHC.Driver.Errors.Types    (GhcMessage)
 import GHC.Generics               (Generic)
 import GHC.Hs.Extension           (GhcPs)
-import GHC.Types.Error            (Messages, defaultDiagnosticOpts, getMessages)
+import GHC.Types.Error            (getMessages)
 import GHC.Types.Name.Occurrence  (occNameString)
 import GHC.Types.Name.Reader      (rdrNameOcc)
-import GHC.Unit.Module            (moduleNameString)
+import GHC.Unit.Module.Name       (moduleNameString)
 import GHC.Utils.Error            (pprMsgEnvelopeBagWithLoc)
-import GHC.Utils.Outputable       (showSDocUnsafe)
 import System.Directory.Recursive (getFilesRecursive)
 import System.Exit                (exitFailure)
 
@@ -201,7 +198,7 @@ sourceSymbols source = do
       return $ concatMap (importSymbols source filepath . GHC.unLoc) hsmodImports
 
 -- | Parse a Haskell module
-parseModule :: FilePath -> IO (GHC.HsModule GhcPs)
+parseModule :: FilePath -> IO GHC.HsModule
 parseModule filepath = do
   result <- ExactPrint.parseModule GHC.Paths.libdir filepath
   case result of
@@ -209,13 +206,7 @@ parseModule filepath = do
       return $ GHC.unLoc hsmod
     Left errs ->
       fail $ "Errors with " <> show filepath <> ":\n    "
-        <> formatParseErrors errs
-
-formatParseErrors :: Messages GhcMessage -> String
-formatParseErrors errs =
-  intercalate "\n    "
-    . fmap showSDocUnsafe
-    $ pprMsgEnvelopeBagWithLoc (defaultDiagnosticOpts @GhcMessage) (getMessages errs)
+        <> show (pprMsgEnvelopeBagWithLoc $ getMessages errs)
 
 -- | Symbols imported in an import declaration.
 --
@@ -223,12 +214,9 @@ formatParseErrors errs =
 -- only one item is returned.
 importSymbols :: FilePath -> FilePath -> GHC.ImportDecl GhcPs -> [ImportedSymbol]
 importSymbols source filepath GHC.ImportDecl{..} =
-  case ideclImportList of
-    Just (importListInterpretation, syms) ->
-      symbol (if importListInterpretation == GHC.EverythingBut then Hiding else Explicit)
-        . Just
-        . GHC.unLoc
-        <$> GHC.unLoc syms
+  case ideclHiding of
+    Just (hiding, syms) ->
+      symbol (if hiding then Hiding else Explicit) . Just . GHC.unLoc <$> GHC.unLoc syms
     Nothing ->
       [ symbol Wildcard Nothing ]
   where

nix/hsie/README.md

@@ -5,10 +5,10 @@ project. It's available in PostgREST's `nix-shell` by default.
 
 ## Dumping imports
 
-Given source code in the directories `src/library` and `src/executable`, for example, you can run:
+Given source code in the directories `src` and `main`, for example, you can run:
 
 ```
-hsie dump-imports src/library src/executable
+hsie dump-imports src main
 ```
 
 This dumps all imports of the modules in the given directory to a CSV file,
@@ -18,7 +18,7 @@ To dump to a JSON file (e.g., to further process with `jq`), add the `--json`
 flag:
 
 ```
-hsie dump-imports --json src/library src/executable
+hsie dump-imports --json src main
 ```
 
 ## Graphing imports
@@ -27,7 +27,7 @@ The tool can generate `graphviz` graphs of module and symbol imports by printing
 a file to `stdout` that can directly be rendered with `dot`:
 
 ```
-hsie graph-modules src/library src/executable | dot -Tpng -o modules.png
+hsie graph-modules src main | dot -Tpng -o modules.png
 ```
 
 The command `graph-modules` prints a graph of which modules insert which other
@@ -39,7 +39,7 @@ To check whether modules are imported under consistent aliases in your project,
 run:
 
 ```
-hsie check-aliases src/library src/executable
+hsie check-aliases main src
 ```
 
 This will exit with a non-zero exit code if any inconsistent aliases are found.
@@ -48,13 +48,13 @@ The following command checks whether any modules are imported as wildcards, i.e.
 not qualified and without specifying symbols.
 
 ```
-hsie check-wildcards src/library src/executable
+hsie check-wildcards main src
 ```
 
 To whitelist certain modules to be imported as wildcards, use `--ok`:
 
 ```
-hsie check-wildcards src/library src/executable --ok Protolude --ok Test.Module
+hsie check-wildcards main src --ok Protolude --ok Test.Module
 ```
 
 ## Current limitations

nix/libpq.nix

@@ -0,0 +1,57 @@
+# Creating a separate libpq package is is discussed in
+# https://github.com/NixOS/nixpkgs/issues/61580, but nixpkgs has not moved
+# forward, yet.
+# This package is passed to postgresql-libpq (haskell) which needs to be
+# cross-compiled to the static build and possibly other architectures as
+# as well. To reduce the number of dependencies that need to be built with
+# it, this derivation focuses on building the client libraries only. No
+# server, no tests.
+{ stdenv
+, lib
+, openssl
+, zlib
+, postgresql
+, pkg-config
+, tzdata
+}:
+
+stdenv.mkDerivation {
+  pname = "libpq";
+  inherit (postgresql) src version patches;
+
+  configureFlags = [
+    "--without-gssapi"
+    "--without-icu"
+    "--without-readline"
+    "--with-openssl"
+    "--with-system-tzdata=${tzdata}/share/zoneinfo"
+    "--sysconfdir=/etc/postgresql"
+  ];
+
+  nativeBuildInputs = [ pkg-config tzdata ];
+  buildInputs = [ openssl zlib ];
+
+  buildFlags = [ "submake-libpq" "submake-libpgport" ];
+
+  installPhase = ''
+    runHook preInstall
+
+    make -C src/bin/pg_config install
+    make -C src/common install
+    make -C src/include install
+    make -C src/interfaces/libpq install
+    make -C src/port install
+
+    rm -rfv $out/share
+
+    runHook postInstall
+  '';
+
+  outputs = [ "out" ];
+
+  meta = with lib; {
+    homepage = "https://www.postgresql.org";
+    description = "Client API library for PostgreSQL";
+    license = licenses.postgresql;
+  };
+}

nix/nixpkgs-version.nix

@@ -0,0 +1,8 @@
+# Pinned version of Nixpkgs, generated with postgrest-nixpkgs-upgrade.
+{
+  owner = "NixOS";
+  repo = "nixpkgs";
+  date = "2024-05-29";
+  rev = "a15e8d1b3d9e6496c4a3214e2104f6d28dfa7df7";
+  tarballHash = "sha256:0r4a4165f4n1zlpnyjrdrwrg86n1b6g3axsdh3j5iizpmjrlxmd7";
+}

nix/overlays/checked-shell-script/checked-shell-script.nix

@@ -6,7 +6,6 @@
 , coreutils
 , git
 , lib
-, moreutils
 , runCommand
 , shellcheck
 , stdenv
@@ -57,7 +56,7 @@ let
         # Example: This way `postgrest-watch -h` will return the help output for watch, while
         # `postgrest-watch postgrest-test-spec -h` will return the help output for test-spec.
         # Taken from: https://github.com/matejak/argbash/issues/114#issuecomment-557108274
-        sed '/_positionals_count + 1/a\\t\t\t\tset -- "''${@:1:1}" "--" "''${@:2}"' $out | ${moreutils}/bin/sponge $out
+        sed '/_positionals_count + 1/a\\t\t\t\tset -- "''${@:1:1}" "--" "''${@:2}"' -i $out
       '';
 
   bash-completion =
@@ -67,7 +66,7 @@ let
       ''
 
       + lib.optionalString (positionalCompletion != "") ''
-        sed 's#COMPREPLY.*compgen -o bashdefault .*$#${escape positionalCompletion}#' $out | ${moreutils}/bin/sponge $out
+        sed 's#COMPREPLY.*compgen -o bashdefault .*$#${escape positionalCompletion}#' -i $out
       ''
     );
 
@@ -104,7 +103,8 @@ let
         ''
 
         + lib.optionalString withTmpDir ''
-          tmpdir="$(${coreutils}/bin/mktemp -d --tmpdir=/tmp ${name}-XXX)"
+          mkdir -p "''${TMPDIR:-/tmp}/postgrest"
+          tmpdir="$(${coreutils}/bin/mktemp -d --tmpdir postgrest/${name}-XXX)"
 
           # we keep the tmpdir when an error occurs for debugging
           trap 'echo Temporary directory kept at: $tmpdir' ERR

nix/overlays/default.nix

@@ -3,4 +3,9 @@
   checked-shell-script = import ./checked-shell-script;
   gitignore = import ./gitignore.nix;
   haskell-packages = import ./haskell-packages.nix;
+  postgis = import ./postgis.nix;
+  postgresql-libpq = import ./postgresql-libpq.nix;
+  postgresql-legacy = import ./postgresql-legacy.nix;
+  postgresql-future = import ./postgresql-future.nix;
+  slocat = import ./slocat.nix;
 }

nix/overlays/haskell-packages.nix

@@ -47,64 +47,39 @@ let
       # - To modify and try packages locally, see "Working with locally modified Haskell packages" in the Nix README.
 
       # Before upgrading fuzzyset to 0.3, check: https://github.com/PostgREST/postgrest/issues/3329
-      fuzzyset = prev.fuzzyset_0_2_4;
-
-      # TODO: Remove once available in nixpkgs
-      auto-update =
-        prev.callHackageDirect
+      # jailbreak, because hspec limit for tests
+      fuzzyset = lib.doJailbreak
+        (prev.callHackageDirect
           {
-            pkg = "auto-update";
-            ver = "0.2.7";
-            sha256 = "sha256-fHX/OqF/cB9rbpGpLUtA29bcEJS43HUWHcK55yUxKoo=";
+            pkg = "fuzzyset";
+            ver = "0.2.4";
+            sha256 = "sha256-lpkrTFcR0B4rT/P6x7ui31Twgq7BBj6KIvjKyqXKdpc=";
           }
-          { };
+          { });
 
-      # TODO: Remove once available in nixpkgs
-      aeson-jsonpath =
-        prev.callHackageDirect
-          {
-            pkg = "aeson-jsonpath";
-            ver = "0.4.2.0";
-            sha256 = "sha256-K+3brf1zjSSjojtSCXFrip5rrP7AO/S4zndAxAnvEfc=";
-          }
-          { };
+      hasql-pool = lib.dontCheck (prev.callHackageDirect
+        {
+          pkg = "hasql-pool";
+          ver = "1.0.1";
+          sha256 = "sha256-Hf1f7lX0LWkjrb25SDBovCYPRdmUP1H6pAxzi7kT4Gg=";
+        }
+        { }
+      );
 
-      http2 =
-        prev.callHackageDirect
-          {
-            pkg = "http2";
-            ver = "5.4.0";
-            sha256 = "sha256-PeEWVd61bQ8G7LvfLeXklzXqNJFaAjE2ecRMWJZESPE=";
-          }
-          { };
+      postgresql-libpq = lib.dontCheck
+        (prev.postgresql-libpq.override {
+          postgresql = super.libpq;
+        });
 
-      http-semantics =
-        prev.callHackageDirect
-          {
-            pkg = "http-semantics";
-            ver = "0.4.0";
-            sha256 = "sha256-rh0z51EKvsu5rQd5n2z3fSRjjEObouNZSBPO9NFYOF0=";
-          }
-          { };
+      hasql-notifications = lib.dontCheck (prev.callHackageDirect
+        {
+          pkg = "hasql-notifications";
+          ver = "0.2.2.2";
+          sha256 = "sha256-myKwlug7OgTa/qP6mHfCD+5Q8IhM17JvpJBfSo+M01k=";
+        }
+        { }
+      );
 
-      network-run =
-        prev.callHackageDirect
-          {
-            pkg = "network-run";
-            ver = "0.5.0";
-            sha256 = "sha256-vbXh+CzxDsGApjqHxCYf/ijpZtUCApFbkcF5gyN0THU=";
-          }
-          { };
-
-      warp =
-        lib.dontCheck
-          (prev.callHackageDirect
-            {
-              pkg = "warp";
-              ver = "3.4.14";
-              sha256 = "sha256-RnoOUlC6dOP0sK/tYAJCX1oLzVFG1GILUY+yVbmvW8Y=";
-            }
-            { });
     };
 in
 {

nix/overlays/postgis.nix

@@ -0,0 +1,28 @@
+final: prev:
+let
+  postgis_3_2_3 = rec {
+    version = "3.2.3";
+    src = final.fetchurl {
+      url = "https://download.osgeo.org/postgis/source/postgis-${version}.tar.gz";
+      sha256 = "sha256-G02LXHVuWrpZ77wYM7Iu/k1lYneO7KVvpJf+susTZow=";
+    };
+    meta.broken = false;
+  };
+in
+{
+  postgresql_11 = prev.postgresql_11.override { this = final.postgresql_11; } // {
+    pkgs = prev.postgresql_11.pkgs // {
+      postgis = prev.postgresql_11.pkgs.postgis.overrideAttrs (_: postgis_3_2_3);
+    };
+  };
+  postgresql_10 = prev.postgresql_10.override { this = final.postgresql_11; } // {
+    pkgs = prev.postgresql_10.pkgs // {
+      postgis = prev.postgresql_10.pkgs.postgis.overrideAttrs (_: postgis_3_2_3);
+    };
+  };
+  postgresql_9_6 = prev.postgresql_9_6.override { this = final.postgresql_11; } // {
+    pkgs = prev.postgresql_9_6.pkgs // {
+      postgis = prev.postgresql_9_6.pkgs.postgis.overrideAttrs (_: postgis_3_2_3);
+    };
+  };
+}

nix/overlays/postgresql-future.nix

@@ -0,0 +1,19 @@
+_: _:
+# Overlay that adds future versions of PostgreSQL that are supported by
+# PostgREST.
+{
+  ## Example for including a postgresql version from a specific nixpks commit:
+  ##
+  #  postgresql_16 =
+  #    let
+  #      rev = "5148520bfab61f99fd25fb9ff7bfbb50dad3c9db";
+  #      tarballHash = "1dfjmz65h8z4lk845724vypzmf3dbgsdndjpj8ydlhx6c7rpcq3p";
+  #
+  #      pinnedPkgs =
+  #        builtins.fetchTarball {
+  #          url = "https://github.com/nixos/nixpkgs/archive/${rev}.tar.gz";
+  #          sha256 = tarballHash;
+  #        };
+  #    in
+  #    (import pinnedPkgs { }).pkgs.postgresql_16;
+}