Commit Graph
59 Commits
Author SHA1 Message Date
Vaibhav 5bf9948bb0 docs: fix embeddings (#45968)
- closes https://github.com/supabase/supabase/issues/45954

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Updated guidance on embedding job batching to reflect improved
handling of edge cases.

* **Bug Fixes**
* Fixed handling of scenarios where no embedding job batches exist,
ensuring consistent behavior in queue processing.

<!-- review_stack_entry_start -->

[![Review Change
Stack](https://storage.googleapis.com/coderabbit_public_assets/review-stack-in-coderabbit-ui.svg)](https://app.coderabbit.ai/change-stack/supabase/supabase/pull/45968)

<!-- review_stack_entry_end -->

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-05-15 13:52:11 +01:00
Chris Chinchilla 2024855c8d docs: Update old Deno usage (#45934) 2026-05-14 15:56:41 +01:00
d8bd6b047c docs: Examples Key changes (#45170)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Updated examples and guides to use Supabase publishable (client) keys
instead of anon keys for client-side usage across frameworks and
platforms.
* Renamed environment variable examples and .env templates to reflect
publishable key naming.
* Adjusted sample requests and client-init examples to send/use the
publishable key via the apikey header where applicable.
* Updated references from service_role to secret for server-side
credential guidance.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: fadymak <fady@fadymak.com>
2026-05-04 12:58:16 +02:00
Apoorva Verma b6d6ade2a1 docs: fix "an" → "a" grammar errors before consonant words (#45299)
Fixes two indefinite-article grammar errors where 'an' is used before a
consonant-starting word:

-
`apps/docs/content/troubleshooting/how-postgres-chooses-which-index-to-use-_JHrf4.mdx`:
"an traversable" → "a traversable"
- `apps/docs/content/guides/ai/examples/nextjs-vector-search.mdx`: "an
remote procedure" → "a remote procedure"

Pure docs grammar fix — no functional changes.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Fixed a grammar typo in the AI vector search guide to improve clarity
in the “Perform similarity search” step.
* Normalized trailing whitespace in the PostgreSQL indexing
troubleshooting guide’s “Postgres internals” table to tidy formatting
and ensure consistent display.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-04-29 09:48:56 +00:00
Chris ChinchillaandCopilot 0e736457c8 docs: update docs to reflect new permission models for data api (#45288)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Instructed granting least-privilege table permissions for anon,
authenticated, and service roles prior to enabling Row Level Security
across multiple guides and quickstarts.
* Clarified SQL examples and inline comments, added explicit GRANT steps
and RLS SELECT policies, rephrased policy guidance, and adjusted example
ordering and section numbering for clearer setup and testing.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-04-29 06:54:49 +00:00
Katerina SkroumpelouandJeremias Menichelli 81049969d9 docs: document filtering vector search by metadata column (#45310)
Adds a worked example for combining a vector similarity search with a
filter on another column from the JS client, and a short note explaining
how filtering interacts with HNSW indexes (including iterative index
scans introduced in `pgvector` 0.8.0). The new `match_documents` variant
takes a typed filter parameter so the planner can apply the predicate
during the index scan, and a jsonb `@>` variant covers the
metadata-column case. Cross-links between `semantic-search`,
`vector-columns`, and `vector-indexes/hnsw-indexes` so readers land on
the answer regardless of which page they start on.

Closes supabase/supabase-js#896

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Added guidance for filtering vector and semantic search results by
metadata, with JS client examples.
* Explained how filters affect vector (HNSW) queries and planner choice
between index and sequential scans.
* Clarified that selective filters can reduce returned matches and
documented pgvector 0.8.0 controls for iterative/index scan behavior.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Jeremias Menichelli <jmenichelli@gmail.com>
2026-04-28 15:59:12 +03:00
Chris Chinchillaandfadymak 03f6083b1b docs: Update AI section keys (#45161)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Updated AI and embedding guides to reflect new Supabase credential
variable names for client initialization
* Updated test request documentation to use the publishable key approach
for API requests

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: fadymak <dev@fadymak.com>
2026-04-23 15:14:09 +00:00
bc13eb56ac docs: add pgvector index tuning guide (ivfflat & hnsw) (#44671)
## What does this PR do?

Adds a pgvector index tuning guide covering:

- IVFFlat vs HNSW index selection
- Parameter tuning (`lists`, `probes`, `m`, `ef_construction`)
- Performance trade-offs
- Recommendations for production workloads (100k+ embeddings)

## Why?

There is currently limited guidance on index tuning for semantic search
workloads. This helps developers optimize query latency and accuracy
when using Supabase for AI applications.

## Type of change

- [x] Documentation update

Closes #44598 

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Added a semantic search guide section with practical index-tuning
recommendations for large datasets, including IVFFlat and HNSW index
explanations, best-use scenarios, and sample index creation guidance to
balance performance and accuracy.
* **Style**
* Minor import formatting cleanup in a UI utility module (no behavior
changes).
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-04-16 08:06:07 +00:00
Taryn King 65c6929414 chore(docs): update docs to use postgres over postgresql language (#44881)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## What kind of change does this PR introduce?

Updates verbiage throughout docs to use postgres over postgresql.


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Updated terminology throughout documentation, guides, and resources
for consistent product naming across all user-facing materials,
including page titles, descriptions, and reference documentation.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-04-15 09:49:45 +00:00
Ivan VasilovandJoshen Lim 9fa96977be chore: Minor prettier fixes (#43849)
This PR fixes some prettier issues:
- Bump and unify all prettier versions to 3.7.3 across teh whole repo
- Bump the SQL prettier plugin
- When running `test:prettier`, check `mdx` files also
- Run the new prettier format on all files

---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2026-03-17 11:17:42 +01:00
Prashant SridharanandAlan Daniel 14d36e9480 Bolt webinar cta page (#43107)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## What kind of change does this PR introduce?

New Go landing page for the upcoming Bolt webinar. This is where we will
direct customers who want to learn more to go to request a meeting.

---------

Co-authored-by: Alan Daniel <stylesshjs@gmail.com>
2026-02-24 10:50:54 +00:00
Jeremias Menichelli f6ec43a9ed [DOCS-454] fix(Docs): Fix images from causing CLS on pages (#43026) 2026-02-23 19:02:31 +01:00
Yogeshwaran C 647ac43c0a fix: correct indefinite article usage for acronyms (an HTTP, an API, an RLS) (#42919)
## What kind of change does this PR introduce?

Grammar corrections across documentation and test descriptions.

## What is the current behavior?

Multiple docs and test files use "a" before acronyms that start with a
vowel sound when pronounced:
- "a HTTP" (pronounced "aitch-tee-tee-pee") should be "an HTTP"
- "a API" (pronounced "ay-pee-eye") should be "an API"  
- "a RLS" (pronounced "arr-ell-ess") should be "an RLS"
- "the all users" is redundant (should be "all users")

## What is the new behavior?

All instances corrected to use proper English indefinite articles:

### Docs files (11 files):
- `firebase-auth.mdx` — "the all users" -> "all users" (2 occurrences)
- `log-drains.mdx` — "a HTTP drain" -> "an HTTP drain"
- `securing-your-api.mdx` — "a HTTP 402" and "a HTTP 420" -> "an HTTP"
- `scan-error-*.mdx` — "a HTTP 500" -> "an HTTP 500"
- `roboflow.mdx` — "a HTTP interface" -> "an HTTP interface"
- `auth-hooks.mdx` — "A HTTP Hook" -> "An HTTP Hook", "a HTTP hook" ->
"an HTTP hook", "a HTTP error" -> "an HTTP error"
- `auth-mfa.mdx` — "a HTTP 401" -> "an HTTP 401"
- `password-verification-hook.mdx` — "a HTTP request" -> "an HTTP
request"
- `before-user-created-hook.mdx` — "a HTTP implementation" -> "an HTTP
implementation"
- `pgtap-extended.mdx` — "a API exposed schema" -> "an API exposed
schema"
- `error-codes.mdx` — "a RLS policy" -> "an RLS policy"
- `broadcast.mdx` — "a RLS" -> "an RLS"

### Studio files (1 file):
- `CronJobs.utils.test.ts` — "a HTTP request" -> "an HTTP request" (9
test descriptions) + "notationa" typo -> "notation"

## Additional context

The rule: use "an" before acronyms pronounced with a leading vowel
sound. "HTTP" starts with "aitch" (vowel sound), "API" starts with "ay"
(vowel sound), and "RLS" starts with "arr" (vowel sound).
2026-02-19 07:23:18 -07:00
SheikhandChris Chinchilla 26a2cb1263 docs(ai): update example code to use Transformers.js v3 (#39915)
More info: https://github.com/huggingface/transformers.js/issues/1291

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-01-20 22:31:13 +00:00
GaryAustin1 4e0db9f72d docs: Update pgvector extension creation syntax (#40087)
Added schema specification to pgvector extension creation.
This is needed or vector extension is installed in public schema.
2026-01-12 09:36:15 +00:00
Dinesh DawonauthandChris Chinchilla 9a04c38395 docs: fix grammatical error in generate-text-embeddings guide (#41187)
* docs: fix grammatical error in generate-text-embeddings guide

* Update generate-text-embeddings.mdx

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2025-12-11 09:14:15 +00:00
Andrew AgostiniandChris Chinchilla a6a598f824 docs: Fix broken urls (#40457)
* docs: update link to Vecs Python source code in developers guide

* docs: update README to remove outdated GDScript links. These repos have been deleted

* docs: update links in CONTRIBUTING.md for consistency and accuracy

* docs: update Twilio verification service link

* docs: update Mixpeek Python Client link in video search guide, remove link to missing code example

* docs: update GIN index link to point to PostgreSQL 16 documentation ('current' symantic no longer exists)

* docs: update Cloudflare Turnstile links to avoid 302 redirect

* docs: update LlamaIndex SupabaseVectorStore link to the correct documentation

* docs: update link to related issue for error message translation in auth-ui guide (to avoid 302 redirect)

* docs: update link from Next.js middleware to Next.js Proxy in auth-helpers guide to follow Next.js's new naming convention

* Update DEVELOPERS.md

* Update CONTRIBUTING.md

Direct to correct URL

* Update hybrid-search.mdx

Fix URL

* docs: renam Next.js middleware to proxy

* Update DEVELOPERS.md

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2025-11-28 08:58:11 +00:00
Rodrigo Mansueli 6a142b7752 feat: AI docs update (#40183)
* feat: AI docs update

* Update Rule003Spelling.toml
2025-11-06 17:57:30 +01:00
Tyler 5cfc390a6a docs: Add schema qualified object references throughout the docs (#39904)
* Update vector type

* Update http and postgis

* Missed a spot on Postgis

* convert the gis reference to extensions in postgis guide
2025-10-28 17:42:50 +09:00
Yadong (Adam) Zhang 699dd6d19e docs: update outdated langchain usage. (#38616)
* fix(apps/docs): update outdated langchain usage.

* fix(apps/docs): update outdated langchain usage.
2025-09-16 14:31:24 +00:00
CharisandChris Chinchilla 47705a8968 chore: replace all supabase urls with relative urls (#38537)
* fix: rewrite relative URLs when syncing to GitHub discussion

Relative URLs back to supabse.com won't work in GitHub discussions, so
rewrite them back to absolute URLs starting with https://supabase.com

* fix: replace all supabase urls with relative urls

* chore: add linting for relative urls

* chore: bump linter version

* Prettier

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2025-09-09 12:54:33 +00:00
Chris ChinchillaandDanny White 039e5c0345 docs: Update database settings to connection popup (#38462)
* Draft

* Draft

* Draft

* Draft

* Update apps/docs/content/guides/ai/rag-with-permissions.mdx

Co-authored-by: Danny White <3104761+dnywh@users.noreply.github.com>

* Update apps/docs/content/guides/database/beekeeper-studio.mdx

Co-authored-by: Danny White <3104761+dnywh@users.noreply.github.com>

* Update apps/docs/content/guides/platform/read-replicas.mdx

Co-authored-by: Danny White <3104761+dnywh@users.noreply.github.com>

---------

Co-authored-by: Danny White <3104761+dnywh@users.noreply.github.com>
2025-09-08 10:40:25 +00:00
Stojan DimitrovskiandChris Chinchilla 93ba2a312c docs: indicate publishable key instead of anon in many examples (#37411)
* docs: indicate publishable key instead of anon in many examples

* replace your-anon-key to string indicating publishable or anon

* fix your_...

* apply suggestion from @ChrisChinchilla

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>

* Update keys in code examples

* Prettier fix

* Update apps/docs/content/guides/functions/schedule-functions.mdx

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2025-08-18 13:47:48 +02:00
Danny WhiteandJoshen Lim d914b81f47 feat: consolidate settings (#37580)
* feat: move storage settings

* feat: redirect

* feat: database settings in service area

* feat: move data api settings

* fix: revert data API placement

* feat: minor UX touches

* fix: simplify configuration group

* feat: references to database settings

* feat: references to storage settings

* fix: redirects and formatting

* fix: Import StorageMenu dynamically to avoid SSR issues with useLocalStorage

* fix: move Data API closer to semantic siblings

* fix: revert smart comma

* Shift bucket sort logic into storage explorer store

---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2025-08-04 16:21:54 +10:00
Carlos Manuel GonzalezandCharis Lam b27a7da097 Set security definer in queue_embeddings function (#35600)
* Update automatic-embeddings.mdx

Set `security definer` in `queue_embeddings` function

* add search_path

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-06-11 21:00:42 +00:00
Lakshan Perera 3c390c7891 chore: Use npm specifier instead of jsr for supabase-js imports (#36291)
chore: update examples to use npm specifier instead of jsr
2025-06-09 22:36:48 -04:00
PeterandTyler 6a812a04b6 Update docs for new connection strings and disk/compute pages in the dashboard (#35128)
* Update all docs that make references to the database settings to find the connection strings.

Update all docs that references the database settings for the compute and disk page

* run prettier

* run pnpm format instead of prettier directly.

* first run through, fix grammar and reword awkward sentences

* Fix typos and remove unnecessary whitespace

* Apply suggestions from code review

Co-authored-by: Tyler <dshukertjr@gmail.com>

---------

Co-authored-by: Tyler <dshukertjr@gmail.com>
2025-04-21 08:59:43 -05:00
Charis 2709fa4a3e feat: pre-compile-time partials (#34028)
Partials are currently defined via MDX includes. This PR switches to pre-compile-time partials, which have a new syntax:

```
<$Partial path="path/to/file.mdx" />
```

## Rationale

This produces two improvements:

1. Partial substitution can occur in pipelines that don't use MDX compilation. For example, we can now do partial substitution before building the search index, so partial content will also be indexed.
2. After the App Router migration, the MDXProviders should've been deprecated, but were kept around for the sole reason of making partials work, and leading to us shipping unnecessary client-side code. We get a minor decrease in overall client bundle size (5.74 MB to 5.6 MB) by getting rid of the Providers.

## Breaking changes

Besides the change to partial syntax, the arguments are also less powerful than before because we are doing string substitution and don't have the full power of JS. Defining string variables is still possible (documented in the Contributing guide), and since that's all we actually do in practice, this shouldn't be too cumbersome. There is always the escape hatch of making a custom component for more complex content reuse cases.
2025-03-18 10:37:39 -04:00
Charis a820c56ed0 chore: docs linting (#33574) 2025-02-21 14:13:00 -05:00
Greg Richardson ca91bedbe9 Docs: Automatic embedding updates (#33773)
* docs: add back dimension size to halfvec column

* docs: change headers back to lowercase
2025-02-21 11:30:23 -07:00
174b32470e Docs: Automatic embeddings (#33498)
* docs: automatic embeddings

* feat: add dashboard instructions to enable extensions

* feat: internal linking

* fix: response status and headers

* chore: add 'enqueues' to spelling lint

* chore: add 'matryoshka' to spelling lint

* fix: 'eg.' to 'e.g.'

* feat: pgmq links to dedicated queue docs

* fix: ignore heading for mdx lint

* docs: remove double word

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* docs: change 'reuse' to 'use'

Co-authored-by: Oliver Rice <github@oliverrice.com>

* docs: remove dimensions on halfvec column

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
Co-authored-by: Oliver Rice <github@oliverrice.com>
2025-02-11 13:27:56 -07:00
Charis 2d55512553 chore: activate spelling and admonitions lints for docs (#33292) 2025-02-04 13:18:31 -05:00
Sadman Yasar Sayem c1322fd9de Update semantic-search.mdx - Fix Typo (#31203) 2024-12-17 23:26:19 +00:00
TheOtherBrian1 590294c4bf Update structured-unstructured.mdx (#31083) 2024-12-12 18:03:46 -05:00
Han Qiao 822cf92322 chore: update docs links to database migrations page (#30922) 2024-12-06 11:40:49 +08:00
Charis 78d0755008 docs(ci): expand linter scope (#30678)
Expand linter scope to cover `ai` directory as well.
2024-11-26 14:28:40 -05:00
LeonardandCharis f6f5bf8331 Update structured-unstructured.mdx (#29991)
* Update structured-unstructured.mdx

* Update apps/docs/content/guides/ai/structured-unstructured.mdx

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-10-29 16:34:24 +00:00
a8fc87f6f5 mixpeek multimodal embed integration (#29014)
* mixpeek embed PR

* fix: undo remove and nav.

* Apply suggestions from code review

* chore: format.

---------

Co-authored-by: thorwebdev <thor@supabase.io>
Co-authored-by: Thor 雷神 Schaeff <5748289+thorwebdev@users.noreply.github.com>
2024-09-04 07:57:03 +00:00
Charis 8313397aa7 fix(docs): duplicate heading ids (#28328) 2024-08-02 13:59:01 -04:00
Wen Bo Xieandegor ce42139560 fix: update gist-960 with the correct tab name (#28217)
* fix: update gist-960 with the correct tab name

* Apply suggestions from code review

---------

Co-authored-by: egor <58992960+egor-romanov@users.noreply.github.com>
2024-07-27 23:23:40 +00:00
Francesco Sansalvadore 1baf027fb1 chore: update pricing page / compute wording (#28017) 2024-07-19 15:39:11 +08:00
Francesco Sansalvadore efc5ee6ec4 global image component (#27410)
* global ui Image component

* migrate docs images to new global component

* use Image component in www mdx components

* update Image description

* remove redundant props

* better ZoomContent types

* remove ThemeImage

* remove ZommableImg component

* add use client to Image component
2024-07-03 13:02:13 +02:00
Thor 雷神 Schaeff 0dbb5e5225 docs: update deno deps to jsr. (#27766)
docs: update deno desp to jsr.
2024-07-03 18:06:55 +08:00
Olivier 6bf236cce2 Update hybrid-search.mdx fix column name on documents table, fixes #26364 (#26365)
* Update hybrid-search.mdx fix column name on documents table

The function uses `doc_vector` but table is setup with `embedding` so changed it to `doc_vector`

* Update col description in hybrid-search.mdx

* Update hybrid-search.mdx

back to `embedding` as col name
2024-05-22 18:36:28 +00:00
Greg Richardson b173ca0404 Docs: fix column name in match_documents example (#26494) 2024-05-21 08:34:09 -06:00
Wen Bo Xie db24eb2e90 fix: revert renaming vector to pgvector on the client (#25911)
* Revert "docs: rename vector to pgvector (#23308)"

This reverts commit c30d5f0b1f.

* Revert "docs: update vector reference to pgvector (#23305)"

This reverts commit b2bae1351c.

* Revert "Fix vector extension (#23386)"

This reverts commit 7341b30c27.

* Revert "Rename vector to pgvector on client side (#23286)"

This reverts commit b48b6e201b.

* docs: add note to pgvector docs that ext name is vector

* fix: add link to vector ext card
2024-05-09 21:19:02 -07:00
Greg Richardson c30d5f0b1f docs: rename vector to pgvector (#23308) 2024-04-26 21:52:51 -07:00
Wen Bo Xie b2bae1351c docs: update vector reference to pgvector (#23305) 2024-04-26 16:40:30 -07:00
Terry Sutton a5d00f9923 Chore/rename open ai key name (#21856)
* Rename OPENAI_KEY to OPENAI_API_KEY

* Force a redeploy
2024-04-25 09:38:56 -02:30
Liam BirkinandCharis 7ac0f0fcc6 fix: broken links & typo in docs (#23118)
* Fix typos in testing-and-linting.mdx

- Changed an to and
- Fixed a 404 link due to missing forward slash

* Fix typo in vector-columns.mdx

- Fixed 404 link due to missing forward slash

* Fix typo in vector-columns.mdx

- Fixed 404 link due to missing forward slash

* found a few more 404 links

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-04-22 14:32:20 +00:00