@@ -150,20 +150,9 @@ No description provided.
### Generate invite link.
-
-
-
-
```js
const { data: user, error } = await supabase.auth.api.generateLink(
'invite',
'email@example.com'
)
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-getuser.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-getuser.mdx
index 5cf3d958ba9..053e6326b90 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-getuser.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-getuser.mdx
@@ -2,7 +2,7 @@
id: auth-api-getuser
title: 'getUser()'
slug: auth-api-getuser
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -14,21 +14,10 @@ This method is called by the GoTrueClient `update` where
the jwt is set to this.currentSession.access_token
and therefore, acts like getting the currently authenticated user
-
-
-
-
```js
const { user, error } = await supabase.auth.api.getUser('ACCESS_TOKEN_JWT')
```
-
-
-
-
## Parameters
@@ -65,17 +54,6 @@ A valid, logged-in JWT. Typically, the access_token for the currentSession
### Fetch the user object using the access_token jwt.
-
-
-
-
```js
const { user, error } = await supabase.auth.api.getUser('ACCESS_TOKEN_JWT')
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-inviteuserbyemail.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-inviteuserbyemail.mdx
index 42b351402dc..ac02d608f34 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-inviteuserbyemail.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-inviteuserbyemail.mdx
@@ -2,7 +2,7 @@
id: auth-api-inviteuserbyemail
title: 'inviteUserByEmail()'
slug: auth-api-inviteuserbyemail
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -110,19 +110,8 @@ No description provided.
### Basic example.
-
-
-
-
```js
const { data: user, error } = await supabase.auth.api.inviteUserByEmail(
'email@example.com'
)
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-listusers.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-listusers.mdx
index 28c3b32bb40..0b14bd4ba43 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-listusers.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-listusers.mdx
@@ -2,7 +2,7 @@
id: auth-api-listusers
title: 'listUsers()'
slug: auth-api-listusers
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -12,21 +12,10 @@ Get a list of users.
This function should only be called on a server. Never expose your `service_role` key in the browser.
-
-
-
-
```js
const { data: user, error } = await supabase.auth.api.listUsers()
```
-
-
-
-
## Notes
- Requires a `service_role` key.
@@ -36,17 +25,6 @@ const { data: user, error } = await supabase.auth.api.listUsers()
### Get a full list of users.
-
-
-
-
```js
const { data: user, error } = await supabase.auth.api.listUsers()
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-resetpasswordforemail.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-resetpasswordforemail.mdx
index 044b55e6246..8b62fc6e743 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-resetpasswordforemail.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-resetpasswordforemail.mdx
@@ -2,7 +2,7 @@
id: auth-api-resetpasswordforemail
title: 'resetPasswordForEmail()'
slug: auth-api-resetpasswordforemail
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,23 +10,12 @@ import TabItem from '@theme/TabItem'
Sends a reset request to an email address.
-
-
-
-
```js
const { data, error } = await supabase.auth.api.resetPasswordForEmail(
'user@email.com'
)
```
-
-
-
-
## Parameters
@@ -140,19 +129,8 @@ const { error, data } = await supabase.auth.api.updateUser(access_token, {
### Reset password
-
-
-
-
```js
const { data, error } = await supabase.auth.api.resetPasswordForEmail(
'user@email.com'
)
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-sendmobileotp.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-sendmobileotp.mdx
index 3c206e079cf..08a1a60903c 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-sendmobileotp.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-sendmobileotp.mdx
@@ -2,7 +2,7 @@
id: auth-api-sendmobileotp
title: 'sendMobileOTP()'
slug: auth-api-sendmobileotp
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -110,17 +110,6 @@ No description provided.
### Basic example.
-
-
-
-
```js
const { data: user, error } = await supabase.auth.api.sendMobileOTP('12345879')
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-updateuserbyid.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-updateuserbyid.mdx
index b83d7947919..46a9489f7e8 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-updateuserbyid.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-updateuserbyid.mdx
@@ -2,7 +2,7 @@
id: auth-api-updateuserbyid
title: 'updateUserById()'
slug: auth-api-updateuserbyid
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,13 +10,6 @@ import TabItem from '@theme/TabItem'
Updates the user data.
-
-
-
-
```js
const { data: user, error } = await supabase.auth.api.updateUserById(
'6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',
@@ -24,10 +17,6 @@ const { data: user, error } = await supabase.auth.api.updateUserById(
)
```
-
-
-
-
## Parameters
@@ -85,13 +74,6 @@ This function should only be called on a server. Never expose your `service_role
### Updates a user's email.
-
-
-
-
```js
const { data: user, error } = await supabase.auth.api.updateUserById(
'6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',
@@ -99,19 +81,8 @@ const { data: user, error } = await supabase.auth.api.updateUserById(
)
```
-
-
-
-
### Updates a user's password.
-
-
-
-
```js
const { data: user, error } = await supabase.auth.api.updateUserById(
'6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',
@@ -119,19 +90,8 @@ const { data: user, error } = await supabase.auth.api.updateUserById(
)
```
-
-
-
-
### Updates a user's metadata.
-
-
-
-
```js
const { data: user, error } = await supabase.auth.api.updateUserById(
'6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',
@@ -139,19 +99,8 @@ const { data: user, error } = await supabase.auth.api.updateUserById(
)
```
-
-
-
-
### Updates a user's app_metadata.
-
-
-
-
```js
const { data: user, error } = await supabase.auth.api.updateUserById(
'6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',
@@ -159,19 +108,8 @@ const { data: user, error } = await supabase.auth.api.updateUserById(
)
```
-
-
-
-
### Confirms a user's email address.
-
-
-
-
```js
const { data: user, error } = await supabase.auth.api.updateUserById(
'6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',
@@ -179,26 +117,11 @@ const { data: user, error } = await supabase.auth.api.updateUserById(
)
```
-
-
-
-
### Confirms a user's phone number.
-
-
-
-
```js
const { data: user, error } = await supabase.auth.api.updateUserById(
'6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',
{ phone_confirm: true }
)
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-onauthstatechange.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-onauthstatechange.mdx
index 8ccf0c63fb8..e978622e0b8 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-onauthstatechange.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-onauthstatechange.mdx
@@ -2,7 +2,7 @@
id: auth-onauthstatechange
title: 'onAuthStateChange()'
slug: auth-onauthstatechange
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,23 +10,12 @@ import TabItem from '@theme/TabItem'
Receive a notification every time an auth event happens.
-
-
-
-
```js
supabase.auth.onAuthStateChange((event, session) => {
console.log(event, session)
})
```
-
-
-
-
## Parameters
@@ -57,133 +46,56 @@ No description provided.
### Listen to auth changes
-
-
-
-
```js
supabase.auth.onAuthStateChange((event, session) => {
console.log(event, session)
})
```
-
-
-
-
### Listen to sign in
-
-
-
-
```js
supabase.auth.onAuthStateChange((event, session) => {
if (event == 'SIGNED_IN') console.log('SIGNED_IN', session)
})
```
-
-
-
-
### Listen to sign out
-
-
-
-
```js
supabase.auth.onAuthStateChange((event, session) => {
if (event == 'SIGNED_OUT') console.log('SIGNED_OUT', session)
})
```
-
-
-
-
### Listen to token refresh
-
-
-
-
```js
supabase.auth.onAuthStateChange((event, session) => {
if (event == 'TOKEN_REFRESHED') console.log('TOKEN_REFRESHED', session)
})
```
-
-
-
-
### Listen to user updates
-
-
-
-
```js
supabase.auth.onAuthStateChange((event, session) => {
if (event == 'USER_UPDATED') console.log('USER_UPDATED', session)
})
```
-
-
-
-
### Listen to user deleted
-
-
-
-
```js
supabase.auth.onAuthStateChange((event, session) => {
if (event == 'USER_DELETED') console.log('USER_DELETED', session)
})
```
-
-
-
-
### Listen to password recovery events
-
-
-
-
```js
supabase.auth.onAuthStateChange((event, session) => {
if (event == 'PASSWORD_RECOVERY') console.log('PASSWORD_RECOVERY', session)
})
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-session.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-session.mdx
index 33725c8b844..131cd870799 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-session.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-session.mdx
@@ -2,7 +2,7 @@
id: auth-session
title: 'session()'
slug: auth-session
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,36 +10,14 @@ import TabItem from '@theme/TabItem'
Returns the session data, if there is an active session.
-
-
-
-
```js
const session = supabase.auth.session()
```
-
-
-
-
## Examples
### Get the session data
-
-
-
-
```js
const session = supabase.auth.session()
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-setauth.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-setauth.mdx
index 81a30c9f8d5..f6b3a246965 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-setauth.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-setauth.mdx
@@ -2,7 +2,7 @@
id: auth-setauth
title: 'setAuth()'
slug: auth-setauth
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,13 +10,6 @@ import TabItem from '@theme/TabItem'
Overrides the JWT on the current client. The JWT will then be sent in all subsequent network requests.
-
-
-
-
```js
function apiFunction(req, res) {
// Assuming the access token was sent as a header "X-Supabase-Auth"
@@ -31,10 +24,6 @@ function apiFunction(req, res) {
}
```
-
-
-
-
## Parameters
@@ -67,13 +56,6 @@ a jwt access token
This is most useful on server-side functions where you cannot log the user in, but have access to the user's access token.
-
-
-
-
```js
function apiFunction(req, res) {
// Assuming the access token was sent as a header "X-Supabase-Auth"
@@ -88,19 +70,8 @@ function apiFunction(req, res) {
}
```
-
-
-
-
### With Express.
-
-
-
-
```js
/**
* Make a request from the client to your server function
@@ -137,7 +108,3 @@ async function apiFunction(req, res) {
const { data } = await supabase.from('your_table').select()
}
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-signin.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-signin.mdx
index 73432bdbc55..c7ff4baf7ff 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-signin.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-signin.mdx
@@ -2,7 +2,7 @@
id: auth-signin
title: 'signIn()'
slug: auth-signin
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,13 +10,6 @@ import TabItem from '@theme/TabItem'
Log in an existing user, or login via a third-party provider.
-
-
-
-
```js
const { user, session, error } = await supabase.auth.signIn({
email: 'example@email.com',
@@ -24,10 +17,6 @@ const { user, session, error } = await supabase.auth.signIn({
})
```
-
-
-
-
## Parameters
@@ -190,13 +179,6 @@ No description provided.
### Sign in with email.
-
-
-
-
```js
const { user, session, error } = await supabase.auth.signIn({
email: 'example@email.com',
@@ -204,42 +186,20 @@ const { user, session, error } = await supabase.auth.signIn({
})
```
-
-
-
-
### Sign in with magic link.
If no password is provided, the user will be sent a "magic link" to their email address, which they can click to open your application with a valid session. By default, a given user can only request a Magic Link once every 60 seconds.
-
-
-
-
```js
const { user, session, error } = await supabase.auth.signIn({
email: 'example@email.com',
})
```
-
-
-
-
### Sign in using third-party providers.
Supabase supports many different [third-party providers](https://supabase.com/docs/guides/auth#providers).
-
-
-
-
```js
const { user, session, error } = await supabase.auth.signIn({
// provider can be 'github', 'google', 'gitlab', and more
@@ -247,21 +207,10 @@ const { user, session, error } = await supabase.auth.signIn({
})
```
-
-
-
-
### Sign in with Phone.
Supabase supports Phone Auth.
-
-
-
-
```js
const { user, session, error } = await supabase.auth.signIn({
phone: '+13334445555',
@@ -269,10 +218,6 @@ const { user, session, error } = await supabase.auth.signIn({
})
```
-
-
-
-
### Sign in with redirect.
Note that the `redirectTo` param is only relevant for OAuth logins, where the login flow is managed by
@@ -281,13 +226,6 @@ the Auth server. If you are using email/phone logins you should set up your own
Sometimes you want to control where the user is redirected to after they are logged in. Supabase supports this for
any URL path on your website (the URL must either be on the same domain as your Site URL [see Auth>Settings in dashboard], or must match one of the Additional Redirect URLs [also in Auth>Settings]).
-
-
-
-
```js
const { user, session, error } = await supabase.auth.signIn(
{
@@ -299,22 +237,11 @@ const { user, session, error } = await supabase.auth.signIn(
)
```
-
-
-
-
### Sign in with scopes.
If you need additional data from an OAuth provider, you can include a space-separated list of scopes in your request to get back an OAuth provider token.
You may also need to specify the scopes in the provider's OAuth app settings, depending on the provider.
-
-
-
-
```js
const { user, session, error } = await supabase.auth.signIn(
{
@@ -327,21 +254,10 @@ const { user, session, error } = await supabase.auth.signIn(
const oAuthToken = session.provider_token // use to access provider API
```
-
-
-
-
### Sign in using a refresh token (e.g. in React Native).
If you are completing a sign up or login in a React Native app you can pass the refresh token obtained from the provider to obtain a session.
-
-
-
-
```js
// An example using Expo's `AuthSession`
const redirectUri = AuthSession.makeRedirectUri({ useProxy: false })
@@ -357,7 +273,3 @@ AuthSession.startAsync({
})
})
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-signout.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-signout.mdx
index 8a157ce461c..976cf373065 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-signout.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-signout.mdx
@@ -2,7 +2,7 @@
id: auth-signout
title: 'signOut()'
slug: auth-signout
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -13,36 +13,14 @@ and log them out - removing all items from localstorage and then trigger a "SIGN
For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to `auth.api.signOut(JWT: string)`. There is no way to revoke a user's session JWT before it automatically expires
-
-
-
-
```js
const { error } = await supabase.auth.signOut()
```
-
-
-
-
## Examples
### Sign out
-
-
-
-
```js
const { error } = await supabase.auth.signOut()
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-signup.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-signup.mdx
index be5d55c5610..387e018a814 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-signup.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-signup.mdx
@@ -2,7 +2,7 @@
id: auth-signup
title: 'signUp()'
slug: auth-signup
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,13 +10,6 @@ import TabItem from '@theme/TabItem'
Creates a new user.
-
-
-
-
```js
const { user, session, error } = await supabase.auth.signUp({
email: 'example@email.com',
@@ -24,10 +17,6 @@ const { user, session, error } = await supabase.auth.signUp({
})
```
-
-
-
-
## Parameters
@@ -154,13 +143,6 @@ No description provided.
### Sign up.
-
-
-
-
```js
const { user, session, error } = await supabase.auth.signUp({
email: 'example@email.com',
@@ -168,19 +150,8 @@ const { user, session, error } = await supabase.auth.signUp({
})
```
-
-
-
-
### Sign up with additional user meta data.
-
-
-
-
```js
const { user, session, error } = await supabase.auth.signUp(
{
@@ -196,10 +167,6 @@ const { user, session, error } = await supabase.auth.signUp(
)
```
-
-
-
-
### Sign up with third-party providers.
You can sign up with OAuth providers using the [`signIn()`](/docs/reference/javascript/auth-signin#sign-in-using-third-party-providers) method.
@@ -208,13 +175,6 @@ You can sign up with OAuth providers using the [`signIn()`](/docs/reference/java
Supabase supports Phone Auth. After a user has verified their number, they can use the [`signIn()`](/docs/reference/javascript/auth-signin#sign-in-using-phone) method.
-
-
-
-
```js
const { user, session, error } = await supabase.auth.signUp({
phone: '+13334445555',
@@ -227,7 +187,3 @@ let { session, error } = await supabase.auth.verifyOTP({
token: '123456',
})
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-update.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-update.mdx
index a4f8d8e6bfe..c864b92e637 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-update.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-update.mdx
@@ -2,7 +2,7 @@
id: auth-update
title: 'update()'
slug: auth-update
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,21 +10,10 @@ import TabItem from '@theme/TabItem'
Updates user data, if there is a logged in user.
-
-
-
-
```js
const { user, error } = await supabase.auth.update({ email: 'new@email.com' })
```
-
-
-
-
## Parameters
@@ -65,53 +54,20 @@ Use the `update()` method if you have data which rarely changes or is specific o
Sends a "Confirm Email Change" email to the new email address.
-
-
-
-
```js
const { user, error } = await supabase.auth.update({ email: 'new@email.com' })
```
-
-
-
-
### Update password for authenticated user.
-
-
-
-
```js
const { user, error } = await supabase.auth.update({ password: 'new password' })
```
-
-
-
-
### Update a user's metadata.
-
-
-
-
```js
const { user, error } = await supabase.auth.update({
data: { hello: 'world' },
})
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-user.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-user.mdx
index 5631da9ebed..242000a148b 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-user.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-user.mdx
@@ -2,7 +2,7 @@
id: auth-user
title: 'user()'
slug: auth-user
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -12,21 +12,10 @@ Inside a browser context, `user()` will return the user data, if there is a logg
For server-side management, you can get a user through `auth.api.getUserByCookie()`
-
-
-
-
```js
const user = supabase.auth.user()
```
-
-
-
-
## Notes
This method gets the user object from memory.
@@ -35,17 +24,6 @@ This method gets the user object from memory.
### Get the logged in user
-
-
-
-
```js
const user = supabase.auth.user()
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/containedby.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/containedby.mdx
index 1a4beb88682..2c5dcddee2a 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/containedby.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/containedby.mdx
@@ -2,19 +2,12 @@
id: containedby
title: '.containedBy()'
slug: containedby
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -22,10 +15,6 @@ const { data, error } = await supabase
.containedBy('main_exports', ['cars', 'food', 'machine'])
```
-
-
-
-
## Notes
- `.containedBy()` can work on array columns or range columns.
@@ -41,13 +30,6 @@ const { data, error } = await supabase
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -55,19 +37,8 @@ const { data, error } = await supabase
.containedBy('main_exports', ['cars', 'food', 'machine'])
```
-
-
-
-
### With `update()`
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -75,19 +46,8 @@ const { data, error } = await supabase
.containedBy('main_exports', ['orks', 'surveillance', 'evil'])
```
-
-
-
-
### With `delete()`
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -95,26 +55,11 @@ const { data, error } = await supabase
.containedBy('main_exports', ['cars', 'food', 'machine'])
```
-
-
-
-
### With `rpc()`
-
-
-
-
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_countries')
.containedBy('main_exports', ['cars', 'food', 'machine'])
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/contains.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/contains.mdx
index 45d1b70c6e2..f92e086dc69 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/contains.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/contains.mdx
@@ -2,19 +2,12 @@
id: contains
title: '.contains()'
slug: contains
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -22,10 +15,6 @@ const { data, error } = await supabase
.contains('main_exports', ['oil'])
```
-
-
-
-
## Notes
- `.contains()` can work on array columns or range columns.
@@ -42,13 +31,6 @@ const { data, error } = await supabase
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -56,19 +38,8 @@ const { data, error } = await supabase
.contains('main_exports', ['oil'])
```
-
-
-
-
### With `update()`
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -76,19 +47,8 @@ const { data, error } = await supabase
.contains('main_exports', ['oil'])
```
-
-
-
-
### With `delete()`
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -96,26 +56,11 @@ const { data, error } = await supabase
.contains('main_exports', ['oil'])
```
-
-
-
-
### With `rpc()`
-
-
-
-
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_countries')
.contains('main_exports', ['oil'])
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/delete.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/delete.mdx
index 41075b120ef..86e08987590 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/delete.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/delete.mdx
@@ -2,7 +2,7 @@
id: delete
title: 'Delete data: delete()'
slug: delete
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,13 +10,6 @@ import TabItem from '@theme/TabItem'
Performs a DELETE on the table.
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -24,10 +17,6 @@ const { data, error } = await supabase
.match({ id: 666 })
```
-
-
-
-
## Parameters
@@ -112,20 +101,9 @@ Count algorithm to use to count rows in a table.
### Delete records
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
.delete()
.match({ id: 666 })
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/eq.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/eq.mdx
index 506ac14c24d..f41a2a305b0 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/eq.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/eq.mdx
@@ -2,7 +2,7 @@
id: eq
title: '.eq()'
slug: eq
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -11,13 +11,6 @@ import TabItem from '@theme/TabItem'
Finds all rows whose value on the stated `column` exactly matches the
specified `value`.
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -25,10 +18,6 @@ const { data, error } = await supabase
.eq('name', 'The shire')
```
-
-
-
-
## Parameters
@@ -79,13 +68,6 @@ The value to filter with.
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -93,19 +75,8 @@ const { data, error } = await supabase
.eq('name', 'The shire')
```
-
-
-
-
### With `update()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -113,19 +84,8 @@ const { data, error } = await supabase
.eq('name', 'San Francisco')
```
-
-
-
-
### With `delete()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -133,26 +93,11 @@ const { data, error } = await supabase
.eq('name', 'Mordor')
```
-
-
-
-
### With `rpc()`
-
-
-
-
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_cities')
.eq('name', 'San Francisco')
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/filter.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/filter.mdx
index 88f0190da3d..80437616d9e 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/filter.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/filter.mdx
@@ -2,7 +2,7 @@
id: filter
title: '.filter()'
slug: filter
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,13 +10,6 @@ import TabItem from '@theme/TabItem'
Finds all rows whose `column` satisfies the filter.
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -24,10 +17,6 @@ const { data, error } = await supabase
.filter('name', 'in', '("Paris","Tokyo")')
```
-
-
-
-
## Parameters
@@ -108,13 +97,6 @@ The value to filter with.
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -122,19 +104,8 @@ const { data, error } = await supabase
.filter('name', 'in', '("Paris","Tokyo")')
```
-
-
-
-
### With `update()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -142,19 +113,8 @@ const { data, error } = await supabase
.filter('name', 'in', '("Paris","Tokyo")')
```
-
-
-
-
### With `delete()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -162,19 +122,8 @@ const { data, error } = await supabase
.filter('name', 'in', '("Paris","Tokyo")')
```
-
-
-
-
### With `rpc()`
-
-
-
-
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
@@ -182,26 +131,11 @@ const { data, error } = await supabase
.filter('name', 'in', '("Paris","Tokyo")')
```
-
-
-
-
### Filter embedded resources
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
.select('name, countries ( name )')
.filter('countries.name', 'in', '("France","Japan")')
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/generating-types.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/generating-types.mdx
index dd81e860e66..a95fef1ec9f 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/generating-types.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/generating-types.mdx
@@ -2,7 +2,7 @@
id: generating-types
title: 'Generating Types'
slug: generating-types
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/getsubscriptions.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/getsubscriptions.mdx
index beea8b5a5fc..a4c69999390 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/getsubscriptions.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/getsubscriptions.mdx
@@ -2,7 +2,7 @@
id: getsubscriptions
title: 'getSubscriptions()'
slug: getsubscriptions
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,36 +10,14 @@ import TabItem from '@theme/TabItem'
Returns an array of all your subscriptions.
-
-
-
-
```js
const subscriptions = supabase.getSubscriptions()
```
-
-
-
-
## Examples
### Get all subscriptions
-
-
-
-
```js
const subscriptions = supabase.getSubscriptions()
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/gt.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/gt.mdx
index 1a8c50984eb..c176de4161f 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/gt.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/gt.mdx
@@ -2,7 +2,7 @@
id: gt
title: '.gt()'
slug: gt
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -11,13 +11,6 @@ import TabItem from '@theme/TabItem'
Finds all rows whose value on the stated `column` is greater than the
specified `value`.
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -25,10 +18,6 @@ const { data, error } = await supabase
.gt('country_id', 250)
```
-
-
-
-
## Parameters
@@ -79,13 +68,6 @@ The value to filter with.
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -93,19 +75,8 @@ const { data, error } = await supabase
.gt('country_id', 250)
```
-
-
-
-
### With `update()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -113,19 +84,8 @@ const { data, error } = await supabase
.gt('country_id', 250)
```
-
-
-
-
### With `delete()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -133,26 +93,11 @@ const { data, error } = await supabase
.gt('country_id', 250)
```
-
-
-
-
### With `rpc()`
-
-
-
-
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_cities')
.gt('country_id', 250)
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/gte.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/gte.mdx
index fd6424389d4..02a67e876f8 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/gte.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/gte.mdx
@@ -2,7 +2,7 @@
id: gte
title: '.gte()'
slug: gte
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -11,13 +11,6 @@ import TabItem from '@theme/TabItem'
Finds all rows whose value on the stated `column` is greater than or
equal to the specified `value`.
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -25,10 +18,6 @@ const { data, error } = await supabase
.gte('country_id', 250)
```
-
-
-
-
## Parameters
@@ -79,13 +68,6 @@ The value to filter with.
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -93,19 +75,8 @@ const { data, error } = await supabase
.gte('country_id', 250)
```
-
-
-
-
### With `update()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -113,19 +84,8 @@ const { data, error } = await supabase
.gte('country_id', 250)
```
-
-
-
-
### With `delete()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -133,26 +93,11 @@ const { data, error } = await supabase
.gte('country_id', 250)
```
-
-
-
-
### With `rpc()`
-
-
-
-
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_cities')
.gte('country_id', 250)
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/ilike.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/ilike.mdx
index 085bd2ef9ab..ed9d9b80231 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/ilike.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/ilike.mdx
@@ -2,7 +2,7 @@
id: ilike
title: '.ilike()'
slug: ilike
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -11,13 +11,6 @@ import TabItem from '@theme/TabItem'
Finds all rows whose value in the stated `column` matches the supplied
`pattern` (case insensitive).
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -25,10 +18,6 @@ const { data, error } = await supabase
.ilike('name', '%la%')
```
-
-
-
-
## Parameters
@@ -79,13 +68,6 @@ The pattern to filter with.
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -93,19 +75,8 @@ const { data, error } = await supabase
.ilike('name', '%la%')
```
-
-
-
-
### With `update()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -113,19 +84,8 @@ const { data, error } = await supabase
.ilike('name', '%la%')
```
-
-
-
-
### With `delete()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -133,26 +93,11 @@ const { data, error } = await supabase
.ilike('name', '%la%')
```
-
-
-
-
### With `rpc()`
-
-
-
-
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_cities')
.ilike('name', '%la%')
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/in.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/in.mdx
index d5e4a468107..e52122350c9 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/in.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/in.mdx
@@ -2,7 +2,7 @@
id: in
title: '.in()'
slug: in
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -11,13 +11,6 @@ import TabItem from '@theme/TabItem'
Finds all rows whose value on the stated `column` is found on the
specified `values`.
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -25,10 +18,6 @@ const { data, error } = await supabase
.in('name', ['Rio de Janeiro', 'San Francisco'])
```
-
-
-
-
## Parameters
@@ -79,13 +68,6 @@ The values to filter with.
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -93,19 +75,8 @@ const { data, error } = await supabase
.in('name', ['Rio de Janeiro', 'San Francisco'])
```
-
-
-
-
### With `update()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -113,19 +84,8 @@ const { data, error } = await supabase
.in('name', ['Rio de Janeiro', 'San Francisco'])
```
-
-
-
-
### With `delete()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -133,26 +93,11 @@ const { data, error } = await supabase
.in('name', ['Rio de Janeiro', 'San Francisco'])
```
-
-
-
-
### With `rpc()`
-
-
-
-
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_cities')
.in('name', ['Rio de Janeiro', 'San Francisco'])
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/index.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/index.mdx
index 24b27d1c8ba..0d0cc97fc5d 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/index.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/index.mdx
@@ -2,7 +2,7 @@
id: index
title: 'Supabase Client'
slug: supabase-client
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: ../../spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/initializing.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/initializing.mdx
index f921020d8f0..3051613f499 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/initializing.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/initializing.mdx
@@ -2,7 +2,7 @@
id: initializing
title: 'Initializing'
slug: initializing
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -83,13 +83,6 @@ No description provided.
### createClient()
-
-
-
-
```js
import { createClient } from '@supabase/supabase-js'
@@ -100,19 +93,8 @@ const supabase = createClient(
)
```
-
-
-
-
### With additional parameters
-
-
-
-
```js
import { createClient } from '@supabase/supabase-js'
@@ -130,19 +112,8 @@ const supabase = createClient(
)
```
-
-
-
-
### API schemas
-
-
-
-
```js
import { createClient } from '@supabase/supabase-js'
@@ -161,19 +132,8 @@ Go to `Settings > API > Schema` and add the schema which you want to expose to t
Note: each client connection can only access a single schema, so the code above can access the `other_schema` schema but cannot access the `public` schema.
-
-
-
-
### Custom `fetch` implementation
-
-
-
-
```js
import { createClient } from '@supabase/supabase-js'
@@ -189,7 +149,3 @@ const supabase = createClient(
`supabase-js` uses the [`cross-fetch`](https://www.npmjs.com/package/cross-fetch) library to make HTTP requests,
but an alternative `fetch` implementation can be provided as an option.
This is most useful in environments where `cross-fetch` is not compatible (for instance Cloudflare Workers).
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/insert.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/insert.mdx
index 8c41fdd2d3e..9b33b5019f5 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/insert.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/insert.mdx
@@ -2,7 +2,7 @@
id: insert
title: 'Create data: insert()'
slug: insert
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,23 +10,12 @@ import TabItem from '@theme/TabItem'
Performs an INSERT into the table.
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
.insert([{ name: 'The Shire', country_id: 554 }])
```
-
-
-
-
## Parameters
@@ -83,35 +72,17 @@ No description provided.
### Create a record
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
.insert([{ name: 'The Shire', country_id: 554 }])
```
-
-
-
-
### Bulk create
When running a bulk create, the operation is handled in a single transaction. If any of the inserts fail, all other operations are
rolled back.
-
-
-
-
```js
const { data, error } = await supabase.from('cities').insert([
{ name: 'The Shire', country_id: 554 },
@@ -119,10 +90,6 @@ const { data, error } = await supabase.from('cities').insert([
])
```
-
-
-
-
### Upsert
For upsert, if set to true, primary key columns would need to be included
@@ -131,13 +98,6 @@ used must be natural, not surrogate. There are however,
[workarounds](https://github.com/PostgREST/postgrest/issues/1118)
for surrogate primary keys.
-
-
-
-
```js
const { data, error } = await supabase.from('cities').insert(
[
@@ -148,7 +108,3 @@ const { data, error } = await supabase.from('cities').insert(
{ upsert: true }
)
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/installing.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/installing.mdx
index 960bac4e30f..5fe252d4cb0 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/installing.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/installing.mdx
@@ -2,7 +2,7 @@
id: installing
title: 'Installing'
slug: installing
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/invoke.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/invoke.mdx
index b553ac81c33..4e58484e479 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/invoke.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/invoke.mdx
@@ -2,7 +2,7 @@
id: invoke
title: 'invoke()'
slug: invoke
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,32 +10,12 @@ import TabItem from '@theme/TabItem'
Invokes a Supabase Function.
-:::caution
-
-Edge Functions are Experimental until 1 August 2022. There will breaking changes. Do not use them in Production.
-
-:::
-
-We have released Supabase Functions to gather feedback. You're welcome to try them out and send us feedback but we strongly advise against using them for anything in production.
-There will be breaking changes with no notice.
-
-
-
-
-
```js
const { data: user, error } = await supabase.functions.invoke('hello', {
body: JSON.stringify({ foo: 'bar' }),
})
```
-
-
-
-
## Parameters
@@ -94,34 +74,16 @@ object with the following properties
### Basic invocation.
-
-
-
-
```js
const { data: user, error } = await supabase.functions.invoke('hello', {
body: JSON.stringify({ foo: 'bar' }),
})
```
-
-
-
-
### Specifying response type.
By default, `invoke()` will parse the response as JSON. You can parse the response in the following formats: `json`, `blob`, `text`, and `arrayBuffer`.
-
-
-
-
```js
const { data: user, error } = await supabase.functions.invoke('hello', {
responseType: 'text',
@@ -129,21 +91,10 @@ const { data: user, error } = await supabase.functions.invoke('hello', {
})
```
-
-
-
-
### Parsing custom headers.
You can pass custom headers to your function. Note: supabase-js automatically passes the `Authorization` header with the signed in user's JWT.
-
-
-
-
```js
const { data: user, error } = await supabase.functions.invoke('hello', {
headers: {
@@ -152,7 +103,3 @@ const { data: user, error } = await supabase.functions.invoke('hello', {
body: JSON.stringify({ foo: 'bar' }),
})
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/is.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/is.mdx
index 289216e771d..c84c1df43dd 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/is.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/is.mdx
@@ -2,7 +2,7 @@
id: is
title: '.is()'
slug: is
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -11,13 +11,6 @@ import TabItem from '@theme/TabItem'
A check for exact equality (null, true, false), finds all rows whose
value on the stated `column` exactly match the specified `value`.
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -25,10 +18,6 @@ const { data, error } = await supabase
.is('name', null)
```
-
-
-
-
## Parameters
@@ -79,13 +68,6 @@ The value to filter with.
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -93,19 +75,8 @@ const { data, error } = await supabase
.is('name', null)
```
-
-
-
-
### With `update()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -113,41 +84,15 @@ const { data, error } = await supabase
.is('name', null)
```
-
-
-
-
### With `delete()`
-
-
-
-
```js
const { data, error } = await supabase.from('cities').delete().is('name', null)
```
-
-
-
-
### With `rpc()`
-
-
-
-
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase.rpc('echo_all_cities').is('name', null)
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/like.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/like.mdx
index abdb43b930a..4fb5fea0b39 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/like.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/like.mdx
@@ -2,7 +2,7 @@
id: like
title: '.like()'
slug: like
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -11,13 +11,6 @@ import TabItem from '@theme/TabItem'
Finds all rows whose value in the stated `column` matches the supplied
`pattern` (case sensitive).
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -25,10 +18,6 @@ const { data, error } = await supabase
.like('name', '%la%')
```
-
-
-
-
## Parameters
@@ -79,13 +68,6 @@ The pattern to filter with.
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -93,19 +75,8 @@ const { data, error } = await supabase
.like('name', '%la%')
```
-
-
-
-
### With `update()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -113,19 +84,8 @@ const { data, error } = await supabase
.like('name', '%la%')
```
-
-
-
-
### With `delete()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -133,26 +93,11 @@ const { data, error } = await supabase
.like('name', '%la%')
```
-
-
-
-
### With `rpc()`
-
-
-
-
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_cities')
.like('name', '%la%')
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/limit.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/limit.mdx
index d794c6c7dbf..1ae5329fb62 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/limit.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/limit.mdx
@@ -2,7 +2,7 @@
id: limit
title: 'limit()'
slug: limit
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,13 +10,6 @@ import TabItem from '@theme/TabItem'
Limits the result with the specified `count`.
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -24,10 +17,6 @@ const { data, error } = await supabase
.limit(1)
```
-
-
-
-
## Parameters
@@ -103,13 +92,6 @@ The foreign table to use (for foreign columns).
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -117,19 +99,8 @@ const { data, error } = await supabase
.limit(1)
```
-
-
-
-
### With embedded resources
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -137,7 +108,3 @@ const { data, error } = await supabase
.eq('name', 'United States')
.limit(1, { foreignTable: 'cities' })
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/lt.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/lt.mdx
index f7273a5d7eb..f43a76cff4f 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/lt.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/lt.mdx
@@ -2,7 +2,7 @@
id: lt
title: '.lt()'
slug: lt
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -11,13 +11,6 @@ import TabItem from '@theme/TabItem'
Finds all rows whose value on the stated `column` is less than the
specified `value`.
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -25,10 +18,6 @@ const { data, error } = await supabase
.lt('country_id', 250)
```
-
-
-
-
## Parameters
@@ -79,13 +68,6 @@ The value to filter with.
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -93,19 +75,8 @@ const { data, error } = await supabase
.lt('country_id', 250)
```
-
-
-
-
### With `update()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -113,19 +84,8 @@ const { data, error } = await supabase
.lt('country_id', 250)
```
-
-
-
-
### With `delete()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -133,26 +93,11 @@ const { data, error } = await supabase
.lt('country_id', 250)
```
-
-
-
-
### With `rpc()`
-
-
-
-
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_cities')
.lt('country_id', 250)
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/lte.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/lte.mdx
index 62522f0ce4f..766815379b5 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/lte.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/lte.mdx
@@ -2,7 +2,7 @@
id: lte
title: '.lte()'
slug: lte
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -11,13 +11,6 @@ import TabItem from '@theme/TabItem'
Finds all rows whose value on the stated `column` is less than or equal
to the specified `value`.
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -25,10 +18,6 @@ const { data, error } = await supabase
.lte('country_id', 250)
```
-
-
-
-
## Parameters
@@ -79,13 +68,6 @@ The value to filter with.
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -93,19 +75,8 @@ const { data, error } = await supabase
.lte('country_id', 250)
```
-
-
-
-
### With `update()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -113,19 +84,8 @@ const { data, error } = await supabase
.lte('country_id', 250)
```
-
-
-
-
### With `delete()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -133,26 +93,11 @@ const { data, error } = await supabase
.lte('country_id', 250)
```
-
-
-
-
### With `rpc()`
-
-
-
-
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_cities')
.lte('country_id', 250)
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/match.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/match.mdx
index 357b6258445..bdbce2c2815 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/match.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/match.mdx
@@ -2,7 +2,7 @@
id: match
title: '.match()'
slug: match
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,13 +10,6 @@ import TabItem from '@theme/TabItem'
Finds all rows whose columns match the specified `query` object.
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -24,10 +17,6 @@ const { data, error } = await supabase
.match({ name: 'Beijing', country_id: 156 })
```
-
-
-
-
## Parameters
@@ -59,13 +48,6 @@ to their filter values.
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -73,19 +55,8 @@ const { data, error } = await supabase
.match({ name: 'Beijing', country_id: 156 })
```
-
-
-
-
### With `update()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -93,19 +64,8 @@ const { data, error } = await supabase
.match({ name: 'Beijing', country_id: 156 })
```
-
-
-
-
### With `delete()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -113,26 +73,11 @@ const { data, error } = await supabase
.match({ name: 'Beijing', country_id: 156 })
```
-
-
-
-
### With `rpc()`
-
-
-
-
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_cities')
.match({ name: 'Beijing', country_id: 156 })
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/maybesingle.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/maybesingle.mdx
index 75b13d8d851..3c01ac380e3 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/maybesingle.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/maybesingle.mdx
@@ -2,7 +2,7 @@
id: maybesingle
title: 'maybeSingle()'
slug: maybesingle
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -12,13 +12,6 @@ Retrieves at most one row from the result. Result must be at most one row
(e.g. using `eq` on a UNIQUE column), otherwise this will result in an
error.
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -27,21 +20,10 @@ const { data, error } = await supabase
.maybeSingle()
```
-
-
-
-
## Examples
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -49,7 +31,3 @@ const { data, error } = await supabase
.eq('name', 'Singapore')
.maybeSingle()
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/neq.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/neq.mdx
index 32360b88899..d6883f2c401 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/neq.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/neq.mdx
@@ -2,7 +2,7 @@
id: neq
title: '.neq()'
slug: neq
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -11,13 +11,6 @@ import TabItem from '@theme/TabItem'
Finds all rows whose value on the stated `column` doesn't match the
specified `value`.
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -25,10 +18,6 @@ const { data, error } = await supabase
.neq('name', 'The shire')
```
-
-
-
-
## Parameters
@@ -79,13 +68,6 @@ The value to filter with.
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -93,19 +75,8 @@ const { data, error } = await supabase
.neq('name', 'The shire')
```
-
-
-
-
### With `update()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -113,19 +84,8 @@ const { data, error } = await supabase
.neq('name', 'San Francisco')
```
-
-
-
-
### With `delete()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -133,26 +93,11 @@ const { data, error } = await supabase
.neq('name', 'Mordor')
```
-
-
-
-
### With `rpc()`
-
-
-
-
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_cities')
.neq('name', 'Lagos')
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/not.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/not.mdx
index 7ba6d51392a..fc4a371f31d 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/not.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/not.mdx
@@ -2,7 +2,7 @@
id: not
title: '.not()'
slug: not
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,13 +10,6 @@ import TabItem from '@theme/TabItem'
Finds all rows which doesn't satisfy the filter.
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -24,10 +17,6 @@ const { data, error } = await supabase
.not('name', 'eq', 'Paris')
```
-
-
-
-
## Parameters
@@ -110,13 +99,6 @@ The value to filter with.
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -124,19 +106,8 @@ const { data, error } = await supabase
.not('name', 'eq', 'Paris')
```
-
-
-
-
### With `update()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -144,19 +115,8 @@ const { data, error } = await supabase
.not('name', 'eq', 'Paris')
```
-
-
-
-
### With `delete()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -164,26 +124,11 @@ const { data, error } = await supabase
.not('name', 'eq', 'Paris')
```
-
-
-
-
### With `rpc()`
-
-
-
-
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_cities')
.not('name', 'eq', 'Paris')
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/or.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/or.mdx
index 32c3dc8e7c3..daae1074551 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/or.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/or.mdx
@@ -2,7 +2,7 @@
id: or
title: '.or()'
slug: or
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,13 +10,6 @@ import TabItem from '@theme/TabItem'
Finds all rows satisfying at least one of the filters.
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -24,10 +17,6 @@ const { data, error } = await supabase
.or('id.eq.20,id.eq.30')
```
-
-
-
-
## Parameters
@@ -113,13 +102,6 @@ The foreign table to use (if `column` is a foreign column).
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -127,19 +109,8 @@ const { data, error } = await supabase
.or('id.eq.20,id.eq.30')
```
-
-
-
-
### Use `or` with `and`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -147,26 +118,11 @@ const { data, error } = await supabase
.or('id.gt.20,and(name.eq.New Zealand,name.eq.France)')
```
-
-
-
-
### Use `or` on foreign tables
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
.select('id, cities(*)')
.or('name.eq.Wellington,name.eq.Paris', { foreignTable: 'cities' })
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/order.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/order.mdx
index fc989769807..e8df0a356e4 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/order.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/order.mdx
@@ -2,7 +2,7 @@
id: order
title: 'order()'
slug: order
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,24 +10,13 @@ import TabItem from '@theme/TabItem'
Orders the result with the specified `column`.
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
- .select('name', 'country_id')
+ .select('name, country_id')
.order('id', { ascending: false })
```
-
-
-
-
## Parameters
@@ -143,33 +132,15 @@ If `true`, the result will be in ascending order.
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
- .select('name', 'country_id')
+ .select('name, country_id')
.order('id', { ascending: false })
```
-
-
-
-
### With embedded resources
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -178,6 +149,12 @@ const { data, error } = await supabase
.order('name', { foreignTable: 'cities' })
```
-
+### Ordering multiple columns
-
+```js
+const { data, error } = await supabase
+ .from('cities')
+ .select('name', 'country_id')
+ .order('country_id', { ascending: false })
+ .order('name', { ascending: false })
+```
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/overlaps.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/overlaps.mdx
index f038122dfd7..4871bab1949 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/overlaps.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/overlaps.mdx
@@ -2,19 +2,12 @@
id: overlaps
title: '.overlaps()'
slug: overlaps
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -22,10 +15,6 @@ const { data, error } = await supabase
.overlaps('main_exports', ['computers', 'minerals'])
```
-
-
-
-
## Notes
- `.overlaps()` can work on array columns or range columns.
@@ -41,13 +30,6 @@ const { data, error } = await supabase
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -55,19 +37,8 @@ const { data, error } = await supabase
.overlaps('main_exports', ['computers', 'minerals'])
```
-
-
-
-
### With `update()`
-
-
-
-
```js
let countries = await supabase
.from('countries')
@@ -75,19 +46,8 @@ let countries = await supabase
.overlaps('main_exports', ['computers', 'minerals'])
```
-
-
-
-
### With `delete()`
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -95,26 +55,11 @@ const { data, error } = await supabase
.overlaps('main_exports', ['computers', 'minerals'])
```
-
-
-
-
### With `rpc()`
-
-
-
-
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_countries')
.overlaps('main_exports', ['computers', 'minerals'])
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/range.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/range.mdx
index f300eb32556..3a86d479740 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/range.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/range.mdx
@@ -2,7 +2,7 @@
id: range
title: 'range()'
slug: range
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,13 +10,6 @@ import TabItem from '@theme/TabItem'
Limits the result to rows within the specified range, inclusive.
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -24,10 +17,6 @@ const { data, error } = await supabase
.range(0, 3)
```
-
-
-
-
## Parameters
@@ -123,20 +112,9 @@ The foreign table to use (for foreign columns).
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
.select('name, country_id')
.range(0, 3)
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/rangeadjacent.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/rangeadjacent.mdx
index 6f68d15687c..6ae5058e156 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/rangeadjacent.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/rangeadjacent.mdx
@@ -2,19 +2,12 @@
id: rangeadjacent
title: '.rangeAdjacent()'
slug: rangeadjacent
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -22,21 +15,10 @@ const { data, error } = await supabase
.rangeAdjacent('population_range_millions', '[70, 185]')
```
-
-
-
-
## Examples
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -44,19 +26,8 @@ const { data, error } = await supabase
.rangeAdjacent('population_range_millions', '[70, 185]')
```
-
-
-
-
### With `update()`
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -64,19 +35,8 @@ const { data, error } = await supabase
.rangeAdjacent('population_range_millions', '[70, 185]')
```
-
-
-
-
### With `delete()`
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -84,26 +44,11 @@ const { data, error } = await supabase
.rangeAdjacent('population_range_millions', '[70, 185]')
```
-
-
-
-
### With `rpc()`
-
-
-
-
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_countries')
.rangeAdjacent('population_range_millions', '[70, 185]')
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/rangegt.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/rangegt.mdx
index 9bef978e44b..3ead16ad803 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/rangegt.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/rangegt.mdx
@@ -2,19 +2,12 @@
id: rangegt
title: '.rangeGt()'
slug: rangegt
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -22,21 +15,10 @@ const { data, error } = await supabase
.rangeGt('population_range_millions', '[150, 250]')
```
-
-
-
-
## Examples
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -44,19 +26,8 @@ const { data, error } = await supabase
.rangeGt('population_range_millions', '[150, 250]')
```
-
-
-
-
### With `update()`
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -64,19 +35,8 @@ const { data, error } = await supabase
.rangeGt('population_range_millions', '[150, 250]')
```
-
-
-
-
### With `delete()`
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -84,26 +44,11 @@ const { data, error } = await supabase
.rangeGt('population_range_millions', '[150, 250]')
```
-
-
-
-
### With `rpc()`
-
-
-
-
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_countries')
.rangeGt('population_range_millions', '[150, 250]')
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/rangegte.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/rangegte.mdx
index 98cb11b6e64..0e87160bc6c 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/rangegte.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/rangegte.mdx
@@ -2,19 +2,12 @@
id: rangegte
title: '.rangeGte()'
slug: rangegte
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -22,21 +15,10 @@ const { data, error } = await supabase
.rangeGte('population_range_millions', '[150, 250]')
```
-
-
-
-
## Examples
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -44,19 +26,8 @@ const { data, error } = await supabase
.rangeGte('population_range_millions', '[150, 250]')
```
-
-
-
-
### With `update()`
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -64,19 +35,8 @@ const { data, error } = await supabase
.rangeGte('population_range_millions', '[150, 250]')
```
-
-
-
-
### With `delete()`
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -84,26 +44,11 @@ const { data, error } = await supabase
.rangeGte('population_range_millions', '[150, 250]')
```
-
-
-
-
### With `rpc()`
-
-
-
-
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_countries')
.rangeGte('population_range_millions', '[150, 250]')
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/rangelt.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/rangelt.mdx
index 1eb61061978..623b74d1e96 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/rangelt.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/rangelt.mdx
@@ -2,19 +2,12 @@
id: rangelt
title: '.rangeLt()'
slug: rangelt
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -22,21 +15,10 @@ const { data, error } = await supabase
.rangeLt('population_range_millions', '[150, 250]')
```
-
-
-
-
## Examples
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -44,19 +26,8 @@ const { data, error } = await supabase
.rangeLt('population_range_millions', '[150, 250]')
```
-
-
-
-
### With `update()`
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -64,19 +35,8 @@ const { data, error } = await supabase
.rangeLt('population_range_millions', '[150, 250]')
```
-
-
-
-
### With `delete()`
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -84,26 +44,11 @@ const { data, error } = await supabase
.rangeLt('population_range_millions', '[150, 250]')
```
-
-
-
-
### With `rpc()`
-
-
-
-
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_countries')
.rangeLt('population_range_millions', '[150, 250]')
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/rangelte.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/rangelte.mdx
index a32add366cc..4bf89e9ac7a 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/rangelte.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/rangelte.mdx
@@ -2,19 +2,12 @@
id: rangelte
title: '.rangeLte()'
slug: rangelte
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -22,21 +15,10 @@ const { data, error } = await supabase
.rangeLte('population_range_millions', '[150, 250]')
```
-
-
-
-
## Examples
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -44,19 +26,8 @@ const { data, error } = await supabase
.rangeLte('population_range_millions', '[150, 250]')
```
-
-
-
-
### With `update()`
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -64,19 +35,8 @@ const { data, error } = await supabase
.rangeLte('population_range_millions', '[150, 250]')
```
-
-
-
-
### With `delete()`
-
-
-
-
```js
const { data, error } = await supabase
.from('countries')
@@ -84,26 +44,11 @@ const { data, error } = await supabase
.rangeLte('population_range_millions', '[150, 250]')
```
-
-
-
-
### With `rpc()`
-
-
-
-
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_countries')
.rangeLte('population_range_millions', '[150, 250]')
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/removeallsubscriptions.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/removeallsubscriptions.mdx
index c04d28c9eef..b78bc655139 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/removeallsubscriptions.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/removeallsubscriptions.mdx
@@ -2,7 +2,7 @@
id: removeallsubscriptions
title: 'removeAllSubscriptions()'
slug: removeallsubscriptions
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -11,21 +11,10 @@ import TabItem from '@theme/TabItem'
Closes and removes all subscriptions and returns a list of removed
subscriptions and their errors.
-
-
-
-
```js
supabase.removeAllSubscriptions()
```
-
-
-
-
## Notes
- Removing subscriptions is a great way to maintain the performance of your project's database. Supabase will automatically handle cleanup 30 seconds after a user is disconnected, but unused subscriptions may cause degradation as more users are simultaneously subscribed.
@@ -34,17 +23,6 @@ supabase.removeAllSubscriptions()
### Removes all subscriptions
-
-
-
-
```js
supabase.removeAllSubscriptions()
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/removesubscription.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/removesubscription.mdx
index 5fa48695e0c..23a00f9f6df 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/removesubscription.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/removesubscription.mdx
@@ -2,7 +2,7 @@
id: removesubscription
title: 'removeSubscription()'
slug: removesubscription
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,21 +10,10 @@ import TabItem from '@theme/TabItem'
Closes and removes a subscription and returns the number of open subscriptions.
-
-
-
-
```js
supabase.removeSubscription(mySubscription)
```
-
-
-
-
## Parameters
@@ -59,17 +48,6 @@ The subscription you want to close and remove.
### Remove a subscription
-
-
-
-
```js
supabase.removeSubscription(mySubscription)
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/rpc.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/rpc.mdx
index d83c25466aa..ed042c72dd1 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/rpc.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/rpc.mdx
@@ -2,7 +2,7 @@
id: rpc
title: 'Postgres functions: rpc()'
slug: rpc
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -19,21 +19,10 @@ create or replace function hello_world() returns text as $$
$$ language sql;
```
-
-
-
-
```js
const { data, error } = await supabase.rpc('hello_world')
```
-
-
-
-
## Parameters
@@ -151,72 +140,32 @@ Count algorithm to use to count rows in a table.
This is an example of invoking a Postgres function with no parameters.
-
-
-
-
```js
const { data, error } = await supabase.rpc('hello_world')
```
-
-
-
-
### With Parameters
-
-
-
-
```js
const { data, error } = await supabase.rpc('echo_city', { name: 'The Shire' })
```
-
-
-
-
### Bulk processing
You can process large payloads at once using [array parameters](https://postgrest.org/en/stable/api.html#calling-functions-with-array-parameters).
-
-
-
-
```js
const { data, error } = await postgrest.rpc('echo_cities', {
names: ['The Shire', 'Mordor'],
})
```
-
-
-
-
### With filters
Postgres functions that return tables can also be combined with
[Modifiers](/docs/reference/javascript/using-modifiers) and
[Filters](/docs/reference/javascript/using-filters).
-
-
-
-
```js
const { data, error } = await supabase
.rpc('echo_all_cities')
@@ -224,22 +173,11 @@ const { data, error } = await supabase
.eq('name', 'The Shire')
```
-
-
-
-
### With count option
You can specify a count option to get the row count along with your data.
Allowed values for count option are `null`, `exact`, `planned` and `estimated`.
-
-
-
-
```js
const { data, error, count } = await supabase.rpc(
'hello_world',
@@ -247,7 +185,3 @@ const { data, error, count } = await supabase.rpc(
{ count: 'exact' }
)
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/select.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/select.mdx
index 0ca77c8161f..62395cdab2f 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/select.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/select.mdx
@@ -2,7 +2,7 @@
id: select
title: 'Fetch data: select()'
slug: select
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,21 +10,10 @@ import TabItem from '@theme/TabItem'
Performs vertical filtering with SELECT.
-
-
-
-
```js
const { data, error } = await supabase.from('cities').select()
```
-
-
-
-
## Parameters
@@ -127,51 +116,22 @@ Count algorithm to use to count rows in a table.
### Getting your data
-
-
-
-
```js
const { data, error } = await supabase.from('cities').select()
```
-
-
-
-
### Selecting specific columns
You can select specific fields from your tables.
-
-
-
-
```js
const { data, error } = await supabase.from('cities').select('name')
```
-
-
-
-
### Query foreign tables
If your database has foreign key relationships, you can query related tables too.
-
-
-
-
```js
const { data, error } = await supabase.from('countries').select(`
name,
@@ -181,10 +141,6 @@ const { data, error } = await supabase.from('countries').select(`
`)
```
-
-
-
-
:::note What about join tables
If you're in a situation where your tables are **NOT** directly related, but instead are joined by a _join table_,
you can still use the `select()` method to query the related data. The PostgREST engine detects the relationship automatically.
@@ -201,13 +157,6 @@ alias for each column. For example, if we had a shop of products,
and we wanted to get the supplier and the purchaser at the same time
(both in the users) table:
-
-
-
-
```js
const { data, error } = await supabase.from('products').select(`
id,
@@ -216,22 +165,11 @@ const { data, error } = await supabase.from('products').select(`
`)
```
-
-
-
-
### Filtering with inner joins
If you want to filter a table based on a child table's values you can use the `!inner()` function. For example, if you wanted
to select all rows in a `message` table which belong to a user with the `username` "Jane":
-
-
-
-
```js
const { data, error } = await supabase
.from('messages')
@@ -239,32 +177,17 @@ const { data, error } = await supabase
.eq('users.username', 'Jane')
```
-
-
-
-
### Querying with count option
You can get the number of rows by using the count option.
Allowed values for count option are `null`, [exact](https://postgrest.org/en/stable/api.html#exact-count), [planned](https://postgrest.org/en/stable/api.html#planned-count) and [estimated](https://postgrest.org/en/stable/api.html#estimated-count).
-
-
-
-
```js
const { data, error, count } = await supabase
.from('cities')
.select('name', { count: 'exact' }) // if you don't want to return any rows, you can use { count: 'exact', head: true }
```
-
-
-
-
### Querying JSON data
If you have data inside of a JSONB column, you can apply select
@@ -273,13 +196,6 @@ and query filters to the data values. Postgres offers a
for querying JSON data. Also see
[PostgREST docs](http://postgrest.org/en/v7.0.0/api.html#json-columns) for more details.
-
-
-
-
```js
const { data, error } = await supabase
.from('users')
@@ -292,40 +208,18 @@ const { data, error } = await supabase
.eq('address->postcode', 90210)
```
-
-
-
-
### Return data as CSV
By default the data is returned in JSON format, however you can also request for it to be returned as Comma Separated Values.
-
-
-
-
```js
const { data, error } = await supabase.from('users').select().csv()
```
-
-
-
-
### Aborting requests in-flight
You can use an [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) to abort requests. Note that `status` and `statusText` doesn't mean anything for aborted requests, since the request wasn't actually fulfilled.
-
-
-
-
```js
const ac = new AbortController()
supabase
@@ -348,7 +242,3 @@ ac.abort()
// statusText: 'Bad Request'
// }
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/single.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/single.mdx
index b28a0974dfe..d9599591717 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/single.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/single.mdx
@@ -2,7 +2,7 @@
id: single
title: 'single()'
slug: single
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -11,13 +11,6 @@ import TabItem from '@theme/TabItem'
Retrieves only one row from the result. Result must be one row (e.g. using
`limit`), otherwise this will result in an error.
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -26,21 +19,10 @@ const { data, error } = await supabase
.single()
```
-
-
-
-
## Examples
### With `select()`
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -48,7 +30,3 @@ const { data, error } = await supabase
.limit(1)
.single()
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-createbucket.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-createbucket.mdx
index 94677caa843..95c1ddd7fb4 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-createbucket.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-createbucket.mdx
@@ -2,7 +2,7 @@
id: storage-createbucket
title: 'createBucket()'
slug: storage-createbucket
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,23 +10,12 @@ import TabItem from '@theme/TabItem'
Creates a new Storage bucket
-
-
-
-
```js
const { data, error } = await supabase.storage.createBucket('avatars', {
public: false,
})
```
-
-
-
-
## Parameters
@@ -108,19 +97,8 @@ No description provided.
### Create bucket
-
-
-
-
```js
const { data, error } = await supabase.storage.createBucket('avatars', {
public: false,
})
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-deletebucket.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-deletebucket.mdx
index 5c88791d7c7..3db6ad86b34 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-deletebucket.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-deletebucket.mdx
@@ -2,7 +2,7 @@
id: storage-deletebucket
title: 'deleteBucket()'
slug: storage-deletebucket
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -11,21 +11,10 @@ import TabItem from '@theme/TabItem'
Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.
You must first `empty()` the bucket.
-
-
-
-
```js
const { data, error } = await supabase.storage.deleteBucket('avatars')
```
-
-
-
-
## Parameters
@@ -62,17 +51,6 @@ The unique identifier of the bucket you would like to delete.
### Delete bucket
-
-
-
-
```js
const { data, error } = await supabase.storage.deleteBucket('avatars')
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-emptybucket.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-emptybucket.mdx
index f432c74f542..328882c22f9 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-emptybucket.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-emptybucket.mdx
@@ -2,7 +2,7 @@
id: storage-emptybucket
title: 'emptyBucket()'
slug: storage-emptybucket
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,21 +10,10 @@ import TabItem from '@theme/TabItem'
Removes all objects inside a single bucket.
-
-
-
-
```js
const { data, error } = await supabase.storage.emptyBucket('avatars')
```
-
-
-
-
## Parameters
@@ -61,17 +50,6 @@ The unique identifier of the bucket you would like to empty.
### Empty bucket
-
-
-
-
```js
const { data, error } = await supabase.storage.emptyBucket('avatars')
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-copy.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-copy.mdx
index 3251e509584..a73137c6b6c 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-copy.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-copy.mdx
@@ -2,7 +2,7 @@
id: storage-from-copy
title: 'from.copy()'
slug: storage-from-copy
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,23 +10,12 @@ import TabItem from '@theme/TabItem'
Copies an existing file.
-
-
-
-
```js
const { data, error } = await supabase.storage
.from('avatars')
.copy('public/avatar1.png', 'private/avatar2.png')
```
-
-
-
-
## Parameters
@@ -83,19 +72,8 @@ The new file path, including the new file name. For example `folder/image-copy.p
### Copy file
-
-
-
-
```js
const { data, error } = await supabase.storage
.from('avatars')
.copy('public/avatar1.png', 'private/avatar2.png')
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-createsignedurl.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-createsignedurl.mdx
index f68b4484384..a3e4b69dc34 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-createsignedurl.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-createsignedurl.mdx
@@ -2,7 +2,7 @@
id: storage-from-createsignedurl
title: 'from.createSignedUrl()'
slug: storage-from-createsignedurl
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,23 +10,12 @@ import TabItem from '@theme/TabItem'
Create signed URL to download file without requiring permissions. This URL can be valid for a set number of seconds.
-
-
-
-
```js
const { signedURL, error } = await supabase.storage
.from('avatars')
.createSignedUrl('folder/avatar1.png', 60)
```
-
-
-
-
## Parameters
@@ -83,19 +72,8 @@ The number of seconds until the signed URL expires. For example, `60` for a URL
### Create Signed URL
-
-
-
-
```js
const { signedURL, error } = await supabase.storage
.from('avatars')
.createSignedUrl('folder/avatar1.png', 60)
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-createsignedurls.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-createsignedurls.mdx
index f56fc180ace..3f03752bce1 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-createsignedurls.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-createsignedurls.mdx
@@ -2,7 +2,7 @@
id: storage-from-createsignedurls
title: 'from.createSignedUrls()'
slug: storage-from-createsignedurls
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,23 +10,12 @@ import TabItem from '@theme/TabItem'
Create signed URLs to download files without requiring permissions. These URLs can be valid for a set number of seconds.
-
-
-
-
```js
const { data, error } = await supabase.storage
.from('avatars')
.createSignedUrls(['folder/avatar1.png', 'folder/avatar2.png'], 60)
```
-
-
-
-
## Parameters
@@ -83,19 +72,8 @@ The number of seconds until the signed URLs expire. For example, `60` for URLs w
### Create Signed URLs
-
-
-
-
```js
const { data, error } = await supabase.storage
.from('avatars')
.createSignedUrls(['folder/avatar1.png', 'folder/avatar2.png'], 60)
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-download.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-download.mdx
index 7e95e92396f..7c02120f8bc 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-download.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-download.mdx
@@ -2,7 +2,7 @@
id: storage-from-download
title: 'from.download()'
slug: storage-from-download
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,23 +10,12 @@ import TabItem from '@theme/TabItem'
Downloads a file.
-
-
-
-
```js
const { data, error } = await supabase.storage
.from('avatars')
.download('folder/avatar1.png')
```
-
-
-
-
## Parameters
@@ -63,19 +52,8 @@ The file path to be downloaded, including the path and file name. For example `f
### Download file
-
-
-
-
```js
const { data, error } = await supabase.storage
.from('avatars')
.download('folder/avatar1.png')
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-getpublicurl.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-getpublicurl.mdx
index 85de6499b3c..918fdcb9ddb 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-getpublicurl.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-getpublicurl.mdx
@@ -2,7 +2,7 @@
id: storage-from-getpublicurl
title: 'from.getPublicUrl()'
slug: storage-from-getpublicurl
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,23 +10,12 @@ import TabItem from '@theme/TabItem'
Retrieve URLs for assets in public buckets
-
-
-
-
```js
const { publicURL, error } = supabase.storage
.from('public-bucket')
.getPublicUrl('folder/avatar1.png')
```
-
-
-
-
## Parameters
@@ -64,19 +53,8 @@ The file path to be downloaded, including the path and file name. For example `f
### Returns the URL for an asset in a public bucket
-
-
-
-
```js
const { publicURL, error } = supabase.storage
.from('public-bucket')
.getPublicUrl('folder/avatar1.png')
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-list.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-list.mdx
index 14708feb725..a9257b5d64e 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-list.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-list.mdx
@@ -2,7 +2,7 @@
id: storage-from-list
title: 'from.list()'
slug: storage-from-list
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,13 +10,6 @@ import TabItem from '@theme/TabItem'
Lists all the files within a bucket.
-
-
-
-
```js
const { data, error } = await supabase.storage.from('avatars').list('folder', {
limit: 100,
@@ -25,10 +18,6 @@ const { data, error } = await supabase.storage.from('avatars').list('folder', {
})
```
-
-
-
-
## Parameters
@@ -105,13 +94,6 @@ Fetch parameters, currently only supports `signal`, which is an AbortController'
### List files in a bucket
-
-
-
-
```js
const { data, error } = await supabase.storage.from('avatars').list('folder', {
limit: 100,
@@ -120,19 +102,8 @@ const { data, error } = await supabase.storage.from('avatars').list('folder', {
})
```
-
-
-
-
### Search files in a bucket
-
-
-
-
```js
const { data, error } = await supabase.storage.from('avatars').list('folder', {
limit: 100,
@@ -141,7 +112,3 @@ const { data, error } = await supabase.storage.from('avatars').list('folder', {
search: 'jon',
})
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-move.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-move.mdx
index a1fef28d6e0..19bf572a353 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-move.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-move.mdx
@@ -2,7 +2,7 @@
id: storage-from-move
title: 'from.move()'
slug: storage-from-move
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,23 +10,12 @@ import TabItem from '@theme/TabItem'
Moves an existing file.
-
-
-
-
```js
const { data, error } = await supabase.storage
.from('avatars')
.move('public/avatar1.png', 'private/avatar2.png')
```
-
-
-
-
## Parameters
@@ -83,19 +72,8 @@ The new file path, including the new file name. For example `folder/image-new.pn
### Move file
-
-
-
-
```js
const { data, error } = await supabase.storage
.from('avatars')
.move('public/avatar1.png', 'private/avatar2.png')
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-remove.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-remove.mdx
index 47831f0e6d1..ccaf7b3aad6 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-remove.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-remove.mdx
@@ -2,7 +2,7 @@
id: storage-from-remove
title: 'from.remove()'
slug: storage-from-remove
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,23 +10,12 @@ import TabItem from '@theme/TabItem'
Deletes files within the same bucket
-
-
-
-
```js
const { data, error } = await supabase.storage
.from('avatars')
.remove(['folder/avatar1.png'])
```
-
-
-
-
## Parameters
@@ -63,19 +52,8 @@ An array of files to be deleted, including the path and file name. For example [
### Delete file
-
-
-
-
```js
const { data, error } = await supabase.storage
.from('avatars')
.remove(['folder/avatar1.png'])
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-update.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-update.mdx
index e05ec37c2ef..fb5cea0c821 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-update.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-update.mdx
@@ -2,7 +2,7 @@
id: storage-from-update
title: 'from.update()'
slug: storage-from-update
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,13 +10,6 @@ import TabItem from '@theme/TabItem'
Replaces an existing file at the specified path with a new one.
-
-
-
-
```js
const avatarFile = event.target.files[0]
const { data, error } = await supabase.storage
@@ -27,10 +20,6 @@ const { data, error } = await supabase.storage
})
```
-
-
-
-
## Parameters
@@ -111,13 +100,6 @@ HTTP headers.
### Update file
-
-
-
-
```js
const avatarFile = event.target.files[0]
const { data, error } = await supabase.storage
@@ -128,19 +110,8 @@ const { data, error } = await supabase.storage
})
```
-
-
-
-
### Update file using `ArrayBuffer` from base64 file data
-
-
-
-
```js
import { decode } from 'base64-arraybuffer'
@@ -150,7 +121,3 @@ const { data, error } = await supabase.storage
contentType: 'image/png',
})
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-upload.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-upload.mdx
index ab772372270..a4861490519 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-upload.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-upload.mdx
@@ -2,7 +2,7 @@
id: storage-from-upload
title: 'from.upload()'
slug: storage-from-upload
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,13 +10,6 @@ import TabItem from '@theme/TabItem'
Uploads a file to an existing bucket.
-
-
-
-
```js
const avatarFile = event.target.files[0]
const { data, error } = await supabase.storage
@@ -27,10 +20,6 @@ const { data, error } = await supabase.storage
})
```
-
-
-
-
## Parameters
@@ -111,13 +100,6 @@ HTTP headers.
### Upload file
-
-
-
-
```js
const avatarFile = event.target.files[0]
const { data, error } = await supabase.storage
@@ -128,19 +110,8 @@ const { data, error } = await supabase.storage
})
```
-
-
-
-
### Upload file using `ArrayBuffer` from base64 file data
-
-
-
-
```js
import { decode } from 'base64-arraybuffer'
@@ -150,7 +121,3 @@ const { data, error } = await supabase.storage
contentType: 'image/png',
})
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-getbucket.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-getbucket.mdx
index cb7075fed67..c8df1c3ad4f 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-getbucket.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-getbucket.mdx
@@ -2,7 +2,7 @@
id: storage-getbucket
title: 'getBucket()'
slug: storage-getbucket
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,21 +10,10 @@ import TabItem from '@theme/TabItem'
Retrieves the details of an existing Storage bucket.
-
-
-
-
```js
const { data, error } = await supabase.storage.getBucket('avatars')
```
-
-
-
-
## Parameters
@@ -61,17 +50,6 @@ The unique identifier of the bucket you would like to retrieve.
### Get bucket
-
-
-
-
```js
const { data, error } = await supabase.storage.getBucket('avatars')
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-listbuckets.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-listbuckets.mdx
index da973fa5d6f..866d5834099 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-listbuckets.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-listbuckets.mdx
@@ -2,7 +2,7 @@
id: storage-listbuckets
title: 'listBuckets()'
slug: storage-listbuckets
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,21 +10,10 @@ import TabItem from '@theme/TabItem'
Retrieves the details of all Storage buckets within an existing project.
-
-
-
-
```js
const { data, error } = await supabase.storage.listBuckets()
```
-
-
-
-
## Notes
- Policy permissions required:
@@ -35,17 +24,6 @@ const { data, error } = await supabase.storage.listBuckets()
### List buckets
-
-
-
-
```js
const { data, error } = await supabase.storage.listBuckets()
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-updatebucket.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-updatebucket.mdx
index 56b617c0d41..c6f28aa3cec 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/storage-updatebucket.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/storage-updatebucket.mdx
@@ -2,7 +2,7 @@
id: storage-updatebucket
title: 'updateBucket()'
slug: storage-updatebucket
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,23 +10,12 @@ import TabItem from '@theme/TabItem'
Updates a new Storage bucket
-
-
-
-
```js
const { data, error } = await supabase.storage.updateBucket('avatars', {
public: false,
})
```
-
-
-
-
## Parameters
@@ -108,19 +97,8 @@ No description provided.
### Update bucket
-
-
-
-
```js
const { data, error } = await supabase.storage.updateBucket('avatars', {
public: false,
})
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/subscribe.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/subscribe.mdx
index fea94883d1d..6f12cb21aad 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/subscribe.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/subscribe.mdx
@@ -2,7 +2,7 @@
id: subscribe
title: 'on().subscribe()'
slug: subscribe
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,13 +10,6 @@ import TabItem from '@theme/TabItem'
Subscribe to realtime changes in your database.
-
-
-
-
```js
const mySubscription = supabase
.from('*')
@@ -26,10 +19,6 @@ const mySubscription = supabase
.subscribe()
```
-
-
-
-
## Parameters
@@ -85,13 +74,6 @@ A callback that will handle the payload that is sent whenever your database chan
### Listen to all database changes
-
-
-
-
```js
const mySubscription = supabase
.from('*')
@@ -101,19 +83,8 @@ const mySubscription = supabase
.subscribe()
```
-
-
-
-
### Listening to a specific table
-
-
-
-
```js
const mySubscription = supabase
.from('countries')
@@ -123,19 +94,8 @@ const mySubscription = supabase
.subscribe()
```
-
-
-
-
### Listening to inserts
-
-
-
-
```js
const mySubscription = supabase
.from('countries')
@@ -145,10 +105,6 @@ const mySubscription = supabase
.subscribe()
```
-
-
-
-
### Listening to updates
By default, Supabase will send only the updated record. If you want to receive the previous values as well you can
@@ -158,13 +114,6 @@ enable full replication for the table you are listening too:
alter table "your_table" replica identity full;
```
-
-
-
-
```js
const mySubscription = supabase
.from('countries')
@@ -174,10 +123,6 @@ const mySubscription = supabase
.subscribe()
```
-
-
-
-
### Listening to deletes
By default, Supabase does not send deleted records. If you want to receive the deleted record you can
@@ -187,13 +132,6 @@ enable full replication for the table you are listening too:
alter table "your_table" replica identity full;
```
-
-
-
-
```js
const mySubscription = supabase
.from('countries')
@@ -203,21 +141,10 @@ const mySubscription = supabase
.subscribe()
```
-
-
-
-
### Listening to multiple events
You can chain listeners if you want to listen to multiple events for each table.
-
-
-
-
```js
const mySubscription = supabase
.from('countries')
@@ -226,28 +153,13 @@ const mySubscription = supabase
.subscribe()
```
-
-
-
-
### Listening to row level changes
You can listen to individual rows using the format `{table}:{col}=eq.{val}` - where `{col}` is the column name, and `{val}` is the value which you want to match.
-
-
-
-
```js
const mySubscription = supabase
.from('countries:id=eq.200')
.on('UPDATE', handleRecordUpdated)
.subscribe()
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/textsearch.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/textsearch.mdx
index 71f0db4b27d..4403d602741 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/textsearch.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/textsearch.mdx
@@ -2,7 +2,7 @@
id: textsearch
title: '.textSearch()'
slug: textsearch
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -106,13 +106,6 @@ The text search configuration to use.
### Text search
-
-
-
-
```js
const { data, error } = await supabase
.from('quotes')
@@ -122,21 +115,10 @@ const { data, error } = await supabase
})
```
-
-
-
-
### Basic normalization
Uses PostgreSQL's `plainto_tsquery` function.
-
-
-
-
```js
const { data, error } = await supabase
.from('quotes')
@@ -147,21 +129,10 @@ const { data, error } = await supabase
})
```
-
-
-
-
### Full normalization
Uses PostgreSQL's `phraseto_tsquery` function.
-
-
-
-
```js
const { data, error } = await supabase
.from('quotes')
@@ -172,10 +143,6 @@ const { data, error } = await supabase
})
```
-
-
-
-
### Websearch
Uses PostgreSQL's `websearch_to_tsquery` function.
@@ -187,13 +154,6 @@ with advanced operators.
- `OR`: the word “or” will be converted to the | operator.
- `-`: a dash will be converted to the ! operator.
-
-
-
-
```js
const { data, error } = await supabase
.from('quotes')
@@ -203,7 +163,3 @@ const { data, error } = await supabase
config: 'english',
})
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/update.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/update.mdx
index 7eddcaf76e7..d14ce2859ef 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/update.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/update.mdx
@@ -2,7 +2,7 @@
id: update
title: 'Modify data: update()'
slug: update
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,13 +10,6 @@ import TabItem from '@theme/TabItem'
Performs an UPDATE on the table.
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -24,10 +17,6 @@ const { data, error } = await supabase
.match({ name: 'Auckland' })
```
-
-
-
-
## Parameters
@@ -127,13 +116,6 @@ Count algorithm to use to count rows in a table.
### Updating your data
-
-
-
-
```js
const { data, error } = await supabase
.from('cities')
@@ -141,10 +123,6 @@ const { data, error } = await supabase
.match({ name: 'Auckland' })
```
-
-
-
-
### Updating JSON data
Postgres offers a
@@ -152,13 +130,6 @@ Postgres offers a
for working with JSON data. Right now it is only possible to update an entire JSON document,
but we are [working on ideas](https://github.com/PostgREST/postgrest/issues/465) for updating individual keys.
-
-
-
-
```js
const { data, error } = await supabase
.from('users')
@@ -172,7 +143,3 @@ const { data, error } = await supabase
)
.eq('address->postcode', 90210)
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/upsert.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/upsert.mdx
index 49e535357a1..06f1ecb2aaa 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/upsert.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/upsert.mdx
@@ -2,7 +2,7 @@
id: upsert
title: 'Upsert data: upsert()'
slug: upsert
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
@@ -10,23 +10,12 @@ import TabItem from '@theme/TabItem'
Performs an UPSERT into the table.
-
-
-
-
```js
const { data, error } = await supabase
.from('messages')
.upsert({ id: 3, message: 'foo', username: 'supabot' })
```
-
-
-
-
## Parameters
@@ -167,32 +156,14 @@ Count algorithm to use to count rows in a table.
### Upsert your data
-
-
-
-
```js
const { data, error } = await supabase
.from('messages')
.upsert({ id: 3, message: 'foo', username: 'supabot' })
```
-
-
-
-
### Bulk Upsert your data
-
-
-
-
```js
const { data, error } = await supabase.from('messages').upsert([
{ id: 3, message: 'foo', username: 'supabot' },
@@ -200,42 +171,20 @@ const { data, error } = await supabase.from('messages').upsert([
])
```
-
-
-
-
### Upserting into tables with constraints
Running the following will cause supabase to upsert data into the `users` table.
If the username 'supabot' already exists, the `onConflict` argument tells supabase to overwrite that row
based on the column passed into `onConflict`.
-
-
-
-
```js
const { data, error } = await supabase
.from('users')
.upsert({ username: 'supabot' }, { onConflict: 'username' })
```
-
-
-
-
### Return the exact number of rows
-
-
-
-
```js
const { data, error, count } = await supabase.from('users').upsert(
{
@@ -248,7 +197,3 @@ const { data, error, count } = await supabase.from('users').upsert(
}
)
```
-
-
-
-
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/using-filters.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/using-filters.mdx
index b52a0f5ae45..3bd2617a45f 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/using-filters.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/using-filters.mdx
@@ -2,7 +2,7 @@
id: using-filters
title: 'Using Filters'
slug: using-filters
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/using-modifiers.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/using-modifiers.mdx
index 4848aec4cea..1262fbc7c79 100644
--- a/apps/reference/_supabase_js_versioned_docs/version-v1/using-modifiers.mdx
+++ b/apps/reference/_supabase_js_versioned_docs/version-v1/using-modifiers.mdx
@@ -2,7 +2,7 @@
id: using-modifiers
title: 'Using Modifiers'
slug: using-modifiers
-custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml
+custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
---
import Tabs from '@theme/Tabs'
diff --git a/packages/generator/package.json b/packages/generator/package.json
index 6578efa23b7..3ad078a68bc 100644
--- a/packages/generator/package.json
+++ b/packages/generator/package.json
@@ -12,16 +12,14 @@
"cli:gen:config": "ts-node ./index.ts gen --type config --input ../../spec/cli_v1_config.yaml --output ../../apps/reference/_cli/generated/config.mdx",
"gotrue:gen": "npm run gotrue:gen:config",
"gotrue:gen:config": "ts-node ./index.ts gen --type config --input ../../spec/gotrue_v1_config.yaml --output ../../apps/reference/_gotrue/config.mdx",
- "dart:gen": "npm run dart:gen:ref && prettier --write ../../apps/reference/_supabase_dart/**/*.mdx",
- "dart:gen:ref": "ts-node ./LegacyReferenceGenerator.ts -o ../../apps/reference/_supabase_dart/generated ../../spec/supabase_dart_v1_legacy.yml",
- "dart:gen:old": "ts-node ./LegacyReferenceGenerator.ts -o ../../web/docs/reference/dart ../../spec/supabase_dart_v1_legacy.yml",
"storage:gen": "npm run storage:gen:api && npm run storage:gen:config",
"storage:gen:api": "ts-node ./index.ts gen --type api --input ../../spec/transforms/storage_v0_openapi_deparsed.json --output ../../apps/reference/_storage/generated/usage.mdx",
"storage:gen:config": "ts-node ./index.ts gen --type config --input ../../spec/storage_v1_config.yaml --output ../../apps/reference/_storage/generated/config.mdx",
- "supabase-js:gen": "npm run supabase-js:gen:sdk",
- "supabase-js:gen:sdk": "ts-node ./index.ts gen --type sdk --input ../../spec/supabase_js_v1_sdk.yaml --output ../../apps/reference/_supabase_js/usage.mdx",
- "supabase-dart:gen": "npm run supabase-dart:gen:sdk",
- "supabase-dart:gen:sdk": "ts-node ./index.ts gen --type sdk --input ../../spec/supabase_dart_sdk.yaml --output ../../apps/reference/_supabase_dart/usage.mdx "
+ "supabase-dart:gen": "npm run dart:gen:ref && prettier --write ../../apps/reference/_supabase_dart/**/*.mdx",
+ "supabase-dart:gen:ref": "ts-node ./LegacyReferenceGenerator.ts -o ../../apps/reference/_supabase_dart/generated ../../spec/supabase_dart_v1_legacy.yml",
+ "supabase-dart:gen:old": "ts-node ./LegacyReferenceGenerator.ts -o ../../web/docs/reference/dart ../../spec/supabase_dart_v1_legacy.yml",
+ "supabase-js:v1:gen": "npm run supabase-js:v1:gen:ref && prettier --write ../../apps/reference/_supabase_js_versioned_docs/version-v1/**/*.mdx",
+ "supabase-js:v1:gen:ref": "ts-node ./LegacyReferenceGenerator.ts -o ../../apps/reference/_supabase_js_versioned_docs/version-v1 ../../spec/supabase_js_v1_legacy.yml"
},
"devDependencies": {
"@apidevtools/swagger-cli": "^4.0.4",
diff --git a/spec/supabase_js_v1_legacy.yml b/spec/supabase_js_v1_legacy.yml
index c7fcc5a1c82..699f03e37a2 100644
--- a/spec/supabase_js_v1_legacy.yml
+++ b/spec/supabase_js_v1_legacy.yml
@@ -7,7 +7,7 @@ info:
Supabase JavaScript.
- definition: spec/tsdoc_v1/combined.json
+ definition: ../../spec/enrichments/tsdoc_v1/combined.json
specUrl: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
slugPrefix: ''
libraries:
diff --git a/spec/supabase_js_v2_legacy.yml b/spec/supabase_js_v2_legacy.yml
index 4e0489dc616..ea3a396b5a2 100644
--- a/spec/supabase_js_v2_legacy.yml
+++ b/spec/supabase_js_v2_legacy.yml
@@ -7,7 +7,7 @@ info:
Supabase JavaScript.
- definition: spec/tsdoc_v1/combined.json
+ definition: ../../spec/enrichments/tsdoc_v2/combined.json
specUrl: https://github.com/supabase/supabase/edit/master/spec/supabase_dart_v2_legacy.yml
slugPrefix: '/'
libraries: