Add docs for pgmq (#30144)

* Revert "Revert "Add docs for pgmq" (#30108)" This reverts commit a265374. * remove create_partitioned since its not yet supported * re-arange pgmq extension docs * update queue docs to match cron structure * consistent header level for api functions
supabase · Dec 16, 2024 · a208912 · a208912
1 parent 2d12fb6
commit a208912
Show file tree

Hide file tree

Showing 4 changed files with 680 additions and 2 deletions.
diff --git a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts
@@ -1020,6 +1020,10 @@ export const database: NavMenuConstant = {
           name: 'PostGIS: Geo queries',
           url: '/guides/database/extensions/postgis',
         },
+        {
+          name: 'pgmq: Queues',
+          url: '/guides/database/extensions/pgmq',
+        },
         {
           name: 'pgsodium (pending deprecation): Encryption Features',
           url: '/guides/database/extensions/pgsodium',
@@ -1164,7 +1168,10 @@ export const queues: NavMenuConstant = {
     {
       name: 'References',
       url: undefined,
-      items: [{ name: 'API', url: '/guides/queues/api' }],
+      items: [
+        { name: 'API', url: '/guides/queues/api' },
+        { name: 'PGMQ Extension', url: '/guides/queues/pgmq' },
+      ],
     },
   ],
 }

diff --git a/apps/docs/content/guides/database/extensions/pgmq.mdx b/apps/docs/content/guides/database/extensions/pgmq.mdx
@@ -0,0 +1,7 @@
+---
+id: 'pgmq'
+title: 'pgmq: Queues'
+description: 'pgmq: Managed queues in Postgres'
+---
+
+See the [Supabase Cron docs](/docs/guides/queues).
diff --git a/apps/docs/content/guides/queues/api.mdx b/apps/docs/content/guides/queues/api.mdx
@@ -7,7 +7,7 @@ When you create a Queue in Supabase, you can choose to create helper database fu
 
 Database functions in `pgmq_public` can be exposed via Supabase Data API so consumers client-side can call them. Visit the [Quickstart](/docs/guides/queues/quickstart) for an example.
 
-## `pgmq_public.pop(queue_name)`
+### `pgmq_public.pop(queue_name)`
 
 Retrieves the next available message and deletes it from the specified Queue.