dima/supabase
1
0 Fork 0
mirror of https://github.com/supabase/supabase.git synced 2026-10-05 17:35:10 +03:00
Code Issues Packages Projects Releases Wiki Activity

generate v1 docs

Browse Source
This commit is contained in:
Copple committed 2022-08-15 11:18:27 +02:00
1 parent c921d3d9a3
commit cfd87f30de
81 files changed
+96 -3045
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-createuser.mdx
+1 -45
View File
@@ -2,7 +2,7 @@
id: auth-api-createuser
title: 'createUser()'
slug: auth-api-createuser
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 @@ Creates a new user.
This function should only be called on a server. Never expose your `service_role` key in the browser.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data: user, error } = await supabase.auth.api.createUser({
email: 'user@email.com',
@@ -27,10 +20,6 @@ const { data: user, error } = await supabase.auth.api.createUser({
})
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -67,13 +56,6 @@ The data you want to create the user with.
### Create a new user.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data: user, error } = await supabase.auth.api.createUser({
email: 'user@email.com',
@@ -82,19 +64,8 @@ const { data: user, error } = await supabase.auth.api.createUser({
})
```
</TabItem>
</Tabs>
### Auto-confirm email.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data: user, error } = await supabase.auth.api.createUser({
email: 'user@email.com',
@@ -102,26 +73,11 @@ const { data: user, error } = await supabase.auth.api.createUser({
})
```
</TabItem>
</Tabs>
### Auto-confirm phone.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data: user, error } = await supabase.auth.api.createUser({
phone: '1234567890',
phone_confirm: true,
})
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-deleteuser.mdx
+1 -23
View File
@@ -2,7 +2,7 @@
id: auth-api-deleteuser
title: 'deleteUser()'
slug: auth-api-deleteuser
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,23 +12,12 @@ Delete a user. Requires a `service_role` key.
This function should only be called on a server. Never expose your `service_role` key in the browser.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data: user, error } = await supabase.auth.api.deleteUser(
'715ed5db-f090-4b8c-a067-640ecee36aa0'
)
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -64,19 +53,8 @@ The user uid you want to remove.
### Remove a user completely.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data: user, error } = await supabase.auth.api.deleteUser(
'715ed5db-f090-4b8c-a067-640ecee36aa0'
)
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-generatelink.mdx
+2 -13
View File
@@ -2,7 +2,7 @@
id: auth-api-generatelink
title: 'generateLink()'
slug: auth-api-generatelink
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'
@@ -23,7 +23,7 @@ Generates links to be sent via email or other.
required
</span>
<span className="method-list-item-validation">
<code>signup</code> | <code>magiclink</code> | <code>recovery</code> | <code>invite</code>
<code>signup</code> | <code>magiclink</code> | <code>recovery</code> | <code>invite</code> | <code>email_change_current</code> | <code>email_change_new</code>
</span>
</h4>
<div class="method-list-item-description">
@@ -150,20 +150,9 @@ No description provided.
### Generate invite link.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data: user, error } = await supabase.auth.api.generateLink(
'invite',
'email@example.com'
)
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-getuser.mdx
+1 -23
View File
@@ -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
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { user, error } = await supabase.auth.api.getUser('ACCESS_TOKEN_JWT')
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { user, error } = await supabase.auth.api.getUser('ACCESS_TOKEN_JWT')
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-inviteuserbyemail.mdx
+1 -12
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data: user, error } = await supabase.auth.api.inviteUserByEmail(
'email@example.com'
)
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-listusers.mdx
+1 -23
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data: user, error } = await supabase.auth.api.listUsers()
```
</TabItem>
</Tabs>
## 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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data: user, error } = await supabase.auth.api.listUsers()
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-resetpasswordforemail.mdx
+1 -23
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.auth.api.resetPasswordForEmail(
'user@email.com'
)
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -140,19 +129,8 @@ const { error, data } = await supabase.auth.api.updateUser(access_token, {
### Reset password
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.auth.api.resetPasswordForEmail(
'user@email.com'
)
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-sendmobileotp.mdx
+1 -12
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data: user, error } = await supabase.auth.api.sendMobileOTP('12345879')
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-updateuserbyid.mdx
+1 -78
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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(
)
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -85,13 +74,6 @@ This function should only be called on a server. Never expose your `service_role
### Updates a user's email.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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(
)
```
</TabItem>
</Tabs>
### Updates a user's password.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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(
)
```
</TabItem>
</Tabs>
### Updates a user's metadata.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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(
)
```
</TabItem>
</Tabs>
### Updates a user's app_metadata.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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(
)
```
</TabItem>
</Tabs>
### Confirms a user's email address.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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(
)
```
</TabItem>
</Tabs>
### Confirms a user's phone number.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data: user, error } = await supabase.auth.api.updateUserById(
'6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',
{ phone_confirm: true }
)
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/auth-onauthstatechange.mdx
+1 -89
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
supabase.auth.onAuthStateChange((event, session) => {
console.log(event, session)
})
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -57,133 +46,56 @@ No description provided.
### Listen to auth changes
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
supabase.auth.onAuthStateChange((event, session) => {
console.log(event, session)
})
```
</TabItem>
</Tabs>
### Listen to sign in
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
supabase.auth.onAuthStateChange((event, session) => {
if (event == 'SIGNED_IN') console.log('SIGNED_IN', session)
})
```
</TabItem>
</Tabs>
### Listen to sign out
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
supabase.auth.onAuthStateChange((event, session) => {
if (event == 'SIGNED_OUT') console.log('SIGNED_OUT', session)
})
```
</TabItem>
</Tabs>
### Listen to token refresh
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
supabase.auth.onAuthStateChange((event, session) => {
if (event == 'TOKEN_REFRESHED') console.log('TOKEN_REFRESHED', session)
})
```
</TabItem>
</Tabs>
### Listen to user updates
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
supabase.auth.onAuthStateChange((event, session) => {
if (event == 'USER_UPDATED') console.log('USER_UPDATED', session)
})
```
</TabItem>
</Tabs>
### Listen to user deleted
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
supabase.auth.onAuthStateChange((event, session) => {
if (event == 'USER_DELETED') console.log('USER_DELETED', session)
})
```
</TabItem>
</Tabs>
### Listen to password recovery events
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
supabase.auth.onAuthStateChange((event, session) => {
if (event == 'PASSWORD_RECOVERY') console.log('PASSWORD_RECOVERY', session)
})
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/auth-session.mdx
+1 -23
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const session = supabase.auth.session()
```
</TabItem>
</Tabs>
## Examples
### Get the session data
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const session = supabase.auth.session()
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/auth-setauth.mdx
+1 -34
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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) {
}
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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) {
}
```
</TabItem>
</Tabs>
### With Express.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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()
}
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/auth-signin.mdx
+1 -89
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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({
})
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -190,13 +179,6 @@ No description provided.
### Sign in with email.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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({
})
```
</TabItem>
</Tabs>
### 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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { user, session, error } = await supabase.auth.signIn({
email: 'example@email.com',
})
```
</TabItem>
</Tabs>
### Sign in using third-party providers.
Supabase supports many different [third-party providers](https://supabase.com/docs/guides/auth#providers).
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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({
})
```
</TabItem>
</Tabs>
### Sign in with Phone.
Supabase supports Phone Auth.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { user, session, error } = await supabase.auth.signIn({
phone: '+13334445555',
@@ -269,10 +218,6 @@ const { user, session, error } = await supabase.auth.signIn({
})
```
</TabItem>
</Tabs>
### 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]).
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { user, session, error } = await supabase.auth.signIn(
{
@@ -299,22 +237,11 @@ const { user, session, error } = await supabase.auth.signIn(
)
```
</TabItem>
</Tabs>
### 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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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
```
</TabItem>
</Tabs>
### 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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
// An example using Expo's `AuthSession`
const redirectUri = AuthSession.makeRedirectUri({ useProxy: false })
@@ -357,7 +273,3 @@ AuthSession.startAsync({
})
})
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/auth-signout.mdx
+1 -23
View File
@@ -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
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { error } = await supabase.auth.signOut()
```
</TabItem>
</Tabs>
## Examples
### Sign out
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { error } = await supabase.auth.signOut()
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/auth-signup.mdx
+1 -45
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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({
})
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -154,13 +143,6 @@ No description provided.
### Sign up.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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({
})
```
</TabItem>
</Tabs>
### Sign up with additional user meta data.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { user, session, error } = await supabase.auth.signUp(
{
@@ -196,10 +167,6 @@ const { user, session, error } = await supabase.auth.signUp(
)
```
</TabItem>
</Tabs>
### 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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { user, session, error } = await supabase.auth.signUp({
phone: '+13334445555',
@@ -227,7 +187,3 @@ let { session, error } = await supabase.auth.verifyOTP({
token: '123456',
})
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/auth-update.mdx
+1 -45
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { user, error } = await supabase.auth.update({ email: 'new@email.com' })
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { user, error } = await supabase.auth.update({ email: 'new@email.com' })
```
</TabItem>
</Tabs>
### Update password for authenticated user.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { user, error } = await supabase.auth.update({ password: 'new password' })
```
</TabItem>
</Tabs>
### Update a user's metadata.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { user, error } = await supabase.auth.update({
data: { hello: 'world' },
})
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/auth-user.mdx
+1 -23
View File
@@ -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()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const user = supabase.auth.user()
```
</TabItem>
</Tabs>
## 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
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const user = supabase.auth.user()
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/containedby.mdx
+1 -56
View File
@@ -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'
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -22,10 +15,6 @@ const { data, error } = await supabase
.containedBy('main_exports', ['cars', 'food', 'machine'])
```
</TabItem>
</Tabs>
## Notes
- `.containedBy()` can work on array columns or range columns.
@@ -41,13 +30,6 @@ const { data, error } = await supabase
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -55,19 +37,8 @@ const { data, error } = await supabase
.containedBy('main_exports', ['cars', 'food', 'machine'])
```
</TabItem>
</Tabs>
### With `update()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -75,19 +46,8 @@ const { data, error } = await supabase
.containedBy('main_exports', ['orks', 'surveillance', 'evil'])
```
</TabItem>
</Tabs>
### With `delete()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -95,26 +55,11 @@ const { data, error } = await supabase
.containedBy('main_exports', ['cars', 'food', 'machine'])
```
</TabItem>
</Tabs>
### With `rpc()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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'])
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/contains.mdx
+1 -56
View File
@@ -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'
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -22,10 +15,6 @@ const { data, error } = await supabase
.contains('main_exports', ['oil'])
```
</TabItem>
</Tabs>
## Notes
- `.contains()` can work on array columns or range columns.
@@ -42,13 +31,6 @@ const { data, error } = await supabase
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -56,19 +38,8 @@ const { data, error } = await supabase
.contains('main_exports', ['oil'])
```
</TabItem>
</Tabs>
### With `update()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -76,19 +47,8 @@ const { data, error } = await supabase
.contains('main_exports', ['oil'])
```
</TabItem>
</Tabs>
### With `delete()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -96,26 +56,11 @@ const { data, error } = await supabase
.contains('main_exports', ['oil'])
```
</TabItem>
</Tabs>
### With `rpc()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_countries')
.contains('main_exports', ['oil'])
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/delete.mdx
+1 -23
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -24,10 +17,6 @@ const { data, error } = await supabase
.match({ id: 666 })
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -112,20 +101,9 @@ Count algorithm to use to count rows in a table.
### Delete records
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
.delete()
.match({ id: 666 })
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/eq.mdx
+1 -56
View File
@@ -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`.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -25,10 +18,6 @@ const { data, error } = await supabase
.eq('name', 'The shire')
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -79,13 +68,6 @@ The value to filter with.
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -93,19 +75,8 @@ const { data, error } = await supabase
.eq('name', 'The shire')
```
</TabItem>
</Tabs>
### With `update()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -113,19 +84,8 @@ const { data, error } = await supabase
.eq('name', 'San Francisco')
```
</TabItem>
</Tabs>
### With `delete()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -133,26 +93,11 @@ const { data, error } = await supabase
.eq('name', 'Mordor')
```
</TabItem>
</Tabs>
### With `rpc()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_cities')
.eq('name', 'San Francisco')
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/filter.mdx
+1 -67
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -24,10 +17,6 @@ const { data, error } = await supabase
.filter('name', 'in', '("Paris","Tokyo")')
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -108,13 +97,6 @@ The value to filter with.
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -122,19 +104,8 @@ const { data, error } = await supabase
.filter('name', 'in', '("Paris","Tokyo")')
```
</TabItem>
</Tabs>
### With `update()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -142,19 +113,8 @@ const { data, error } = await supabase
.filter('name', 'in', '("Paris","Tokyo")')
```
</TabItem>
</Tabs>
### With `delete()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -162,19 +122,8 @@ const { data, error } = await supabase
.filter('name', 'in', '("Paris","Tokyo")')
```
</TabItem>
</Tabs>
### With `rpc()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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")')
```
</TabItem>
</Tabs>
### Filter embedded resources
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
.select('name, countries ( name )')
.filter('countries.name', 'in', '("France","Japan")')
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/generating-types.mdx
+1 -1
View File
@@ -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'
apps/reference/_supabase_js_versioned_docs/version-v1/getsubscriptions.mdx
+1 -23
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const subscriptions = supabase.getSubscriptions()
```
</TabItem>
</Tabs>
## Examples
### Get all subscriptions
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const subscriptions = supabase.getSubscriptions()
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/gt.mdx
+1 -56
View File
@@ -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`.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -25,10 +18,6 @@ const { data, error } = await supabase
.gt('country_id', 250)
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -79,13 +68,6 @@ The value to filter with.
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -93,19 +75,8 @@ const { data, error } = await supabase
.gt('country_id', 250)
```
</TabItem>
</Tabs>
### With `update()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -113,19 +84,8 @@ const { data, error } = await supabase
.gt('country_id', 250)
```
</TabItem>
</Tabs>
### With `delete()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -133,26 +93,11 @@ const { data, error } = await supabase
.gt('country_id', 250)
```
</TabItem>
</Tabs>
### With `rpc()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_cities')
.gt('country_id', 250)
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/gte.mdx
+1 -56
View File
@@ -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`.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -25,10 +18,6 @@ const { data, error } = await supabase
.gte('country_id', 250)
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -79,13 +68,6 @@ The value to filter with.
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -93,19 +75,8 @@ const { data, error } = await supabase
.gte('country_id', 250)
```
</TabItem>
</Tabs>
### With `update()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -113,19 +84,8 @@ const { data, error } = await supabase
.gte('country_id', 250)
```
</TabItem>
</Tabs>
### With `delete()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -133,26 +93,11 @@ const { data, error } = await supabase
.gte('country_id', 250)
```
</TabItem>
</Tabs>
### With `rpc()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_cities')
.gte('country_id', 250)
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/ilike.mdx
+1 -56
View File
@@ -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).
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -25,10 +18,6 @@ const { data, error } = await supabase
.ilike('name', '%la%')
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -79,13 +68,6 @@ The pattern to filter with.
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -93,19 +75,8 @@ const { data, error } = await supabase
.ilike('name', '%la%')
```
</TabItem>
</Tabs>
### With `update()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -113,19 +84,8 @@ const { data, error } = await supabase
.ilike('name', '%la%')
```
</TabItem>
</Tabs>
### With `delete()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -133,26 +93,11 @@ const { data, error } = await supabase
.ilike('name', '%la%')
```
</TabItem>
</Tabs>
### With `rpc()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_cities')
.ilike('name', '%la%')
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/in.mdx
+1 -56
View File
@@ -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`.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -25,10 +18,6 @@ const { data, error } = await supabase
.in('name', ['Rio de Janeiro', 'San Francisco'])
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -79,13 +68,6 @@ The values to filter with.
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -93,19 +75,8 @@ const { data, error } = await supabase
.in('name', ['Rio de Janeiro', 'San Francisco'])
```
</TabItem>
</Tabs>
### With `update()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -113,19 +84,8 @@ const { data, error } = await supabase
.in('name', ['Rio de Janeiro', 'San Francisco'])
```
</TabItem>
</Tabs>
### With `delete()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -133,26 +93,11 @@ const { data, error } = await supabase
.in('name', ['Rio de Janeiro', 'San Francisco'])
```
</TabItem>
</Tabs>
### With `rpc()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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'])
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/index.mdx
+1 -1
View File
@@ -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'
apps/reference/_supabase_js_versioned_docs/version-v1/initializing.mdx
+1 -45
View File
@@ -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()
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
import { createClient } from '@supabase/supabase-js'
@@ -100,19 +93,8 @@ const supabase = createClient(
)
```
</TabItem>
</Tabs>
### With additional parameters
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
import { createClient } from '@supabase/supabase-js'
@@ -130,19 +112,8 @@ const supabase = createClient(
)
```
</TabItem>
</Tabs>
### API schemas
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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.
</TabItem>
</Tabs>
### Custom `fetch` implementation
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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).
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/insert.mdx
+1 -45
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
.insert([{ name: 'The Shire', country_id: 554 }])
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -83,35 +72,17 @@ No description provided.
### Create a record
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
.insert([{ name: 'The Shire', country_id: 554 }])
```
</TabItem>
</Tabs>
### 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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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([
])
```
</TabItem>
</Tabs>
### 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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.from('cities').insert(
[
@@ -148,7 +108,3 @@ const { data, error } = await supabase.from('cities').insert(
{ upsert: true }
)
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/installing.mdx
+1 -1
View File
@@ -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'
apps/reference/_supabase_js_versioned_docs/version-v1/invoke.mdx
+1 -54
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data: user, error } = await supabase.functions.invoke('hello', {
body: JSON.stringify({ foo: 'bar' }),
})
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -94,34 +74,16 @@ object with the following properties
### Basic invocation.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data: user, error } = await supabase.functions.invoke('hello', {
body: JSON.stringify({ foo: 'bar' }),
})
```
</TabItem>
</Tabs>
### 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`.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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', {
})
```
</TabItem>
</Tabs>
### 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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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' }),
})
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/is.mdx
+1 -56
View File
@@ -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`.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -25,10 +18,6 @@ const { data, error } = await supabase
.is('name', null)
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -79,13 +68,6 @@ The value to filter with.
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -93,19 +75,8 @@ const { data, error } = await supabase
.is('name', null)
```
</TabItem>
</Tabs>
### With `update()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -113,41 +84,15 @@ const { data, error } = await supabase
.is('name', null)
```
</TabItem>
</Tabs>
### With `delete()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.from('cities').delete().is('name', null)
```
</TabItem>
</Tabs>
### With `rpc()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase.rpc('echo_all_cities').is('name', null)
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/like.mdx
+1 -56
View File
@@ -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).
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -25,10 +18,6 @@ const { data, error } = await supabase
.like('name', '%la%')
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -79,13 +68,6 @@ The pattern to filter with.
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -93,19 +75,8 @@ const { data, error } = await supabase
.like('name', '%la%')
```
</TabItem>
</Tabs>
### With `update()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -113,19 +84,8 @@ const { data, error } = await supabase
.like('name', '%la%')
```
</TabItem>
</Tabs>
### With `delete()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -133,26 +93,11 @@ const { data, error } = await supabase
.like('name', '%la%')
```
</TabItem>
</Tabs>
### With `rpc()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_cities')
.like('name', '%la%')
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/limit.mdx
+1 -34
View File
@@ -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`.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -24,10 +17,6 @@ const { data, error } = await supabase
.limit(1)
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -103,13 +92,6 @@ The foreign table to use (for foreign columns).
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -117,19 +99,8 @@ const { data, error } = await supabase
.limit(1)
```
</TabItem>
</Tabs>
### With embedded resources
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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' })
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/lt.mdx
+1 -56
View File
@@ -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`.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -25,10 +18,6 @@ const { data, error } = await supabase
.lt('country_id', 250)
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -79,13 +68,6 @@ The value to filter with.
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -93,19 +75,8 @@ const { data, error } = await supabase
.lt('country_id', 250)
```
</TabItem>
</Tabs>
### With `update()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -113,19 +84,8 @@ const { data, error } = await supabase
.lt('country_id', 250)
```
</TabItem>
</Tabs>
### With `delete()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -133,26 +93,11 @@ const { data, error } = await supabase
.lt('country_id', 250)
```
</TabItem>
</Tabs>
### With `rpc()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_cities')
.lt('country_id', 250)
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/lte.mdx
+1 -56
View File
@@ -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`.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -25,10 +18,6 @@ const { data, error } = await supabase
.lte('country_id', 250)
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -79,13 +68,6 @@ The value to filter with.
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -93,19 +75,8 @@ const { data, error } = await supabase
.lte('country_id', 250)
```
</TabItem>
</Tabs>
### With `update()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -113,19 +84,8 @@ const { data, error } = await supabase
.lte('country_id', 250)
```
</TabItem>
</Tabs>
### With `delete()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -133,26 +93,11 @@ const { data, error } = await supabase
.lte('country_id', 250)
```
</TabItem>
</Tabs>
### With `rpc()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_cities')
.lte('country_id', 250)
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/match.mdx
+1 -56
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -24,10 +17,6 @@ const { data, error } = await supabase
.match({ name: 'Beijing', country_id: 156 })
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -59,13 +48,6 @@ to their filter values.
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -73,19 +55,8 @@ const { data, error } = await supabase
.match({ name: 'Beijing', country_id: 156 })
```
</TabItem>
</Tabs>
### With `update()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -93,19 +64,8 @@ const { data, error } = await supabase
.match({ name: 'Beijing', country_id: 156 })
```
</TabItem>
</Tabs>
### With `delete()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -113,26 +73,11 @@ const { data, error } = await supabase
.match({ name: 'Beijing', country_id: 156 })
```
</TabItem>
</Tabs>
### With `rpc()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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 })
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/maybesingle.mdx
+1 -23
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -27,21 +20,10 @@ const { data, error } = await supabase
.maybeSingle()
```
</TabItem>
</Tabs>
## Examples
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -49,7 +31,3 @@ const { data, error } = await supabase
.eq('name', 'Singapore')
.maybeSingle()
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/neq.mdx
+1 -56
View File
@@ -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`.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -25,10 +18,6 @@ const { data, error } = await supabase
.neq('name', 'The shire')
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -79,13 +68,6 @@ The value to filter with.
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -93,19 +75,8 @@ const { data, error } = await supabase
.neq('name', 'The shire')
```
</TabItem>
</Tabs>
### With `update()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -113,19 +84,8 @@ const { data, error } = await supabase
.neq('name', 'San Francisco')
```
</TabItem>
</Tabs>
### With `delete()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -133,26 +93,11 @@ const { data, error } = await supabase
.neq('name', 'Mordor')
```
</TabItem>
</Tabs>
### With `rpc()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_cities')
.neq('name', 'Lagos')
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/not.mdx
+1 -56
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -24,10 +17,6 @@ const { data, error } = await supabase
.not('name', 'eq', 'Paris')
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -110,13 +99,6 @@ The value to filter with.
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -124,19 +106,8 @@ const { data, error } = await supabase
.not('name', 'eq', 'Paris')
```
</TabItem>
</Tabs>
### With `update()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -144,19 +115,8 @@ const { data, error } = await supabase
.not('name', 'eq', 'Paris')
```
</TabItem>
</Tabs>
### With `delete()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -164,26 +124,11 @@ const { data, error } = await supabase
.not('name', 'eq', 'Paris')
```
</TabItem>
</Tabs>
### With `rpc()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
// Only valid if the Postgres function returns a table type.
const { data, error } = await supabase
.rpc('echo_all_cities')
.not('name', 'eq', 'Paris')
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/or.mdx
+1 -45
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -24,10 +17,6 @@ const { data, error } = await supabase
.or('id.eq.20,id.eq.30')
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -113,13 +102,6 @@ The foreign table to use (if `column` is a foreign column).
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -127,19 +109,8 @@ const { data, error } = await supabase
.or('id.eq.20,id.eq.30')
```
</TabItem>
</Tabs>
### Use `or` with `and`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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)')
```
</TabItem>
</Tabs>
### Use `or` on foreign tables
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
.select('id, cities(*)')
.or('name.eq.Wellington,name.eq.Paris', { foreignTable: 'cities' })
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/order.mdx
+11 -34
View File
@@ -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`.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
.select('name', 'country_id')
.select('name, country_id')
.order('id', { ascending: false })
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -143,33 +132,15 @@ If `true`, the result will be in ascending order.
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
.select('name', 'country_id')
.select('name, country_id')
.order('id', { ascending: false })
```
</TabItem>
</Tabs>
### With embedded resources
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -178,6 +149,12 @@ const { data, error } = await supabase
.order('name', { foreignTable: 'cities' })
```
</TabItem>
### Ordering multiple columns
</Tabs>
```js
const { data, error } = await supabase
.from('cities')
.select('name', 'country_id')
.order('country_id', { ascending: false })
.order('name', { ascending: false })
```
apps/reference/_supabase_js_versioned_docs/version-v1/overlaps.mdx
+1 -56
View File
@@ -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'
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -22,10 +15,6 @@ const { data, error } = await supabase
.overlaps('main_exports', ['computers', 'minerals'])
```
</TabItem>
</Tabs>
## Notes
- `.overlaps()` can work on array columns or range columns.
@@ -41,13 +30,6 @@ const { data, error } = await supabase
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -55,19 +37,8 @@ const { data, error } = await supabase
.overlaps('main_exports', ['computers', 'minerals'])
```
</TabItem>
</Tabs>
### With `update()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
let countries = await supabase
.from('countries')
@@ -75,19 +46,8 @@ let countries = await supabase
.overlaps('main_exports', ['computers', 'minerals'])
```
</TabItem>
</Tabs>
### With `delete()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -95,26 +55,11 @@ const { data, error } = await supabase
.overlaps('main_exports', ['computers', 'minerals'])
```
</TabItem>
</Tabs>
### With `rpc()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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'])
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/range.mdx
+1 -23
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -24,10 +17,6 @@ const { data, error } = await supabase
.range(0, 3)
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -123,20 +112,9 @@ The foreign table to use (for foreign columns).
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
.select('name, country_id')
.range(0, 3)
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/rangeadjacent.mdx
+1 -56
View File
@@ -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'
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -22,21 +15,10 @@ const { data, error } = await supabase
.rangeAdjacent('population_range_millions', '[70, 185]')
```
</TabItem>
</Tabs>
## Examples
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -44,19 +26,8 @@ const { data, error } = await supabase
.rangeAdjacent('population_range_millions', '[70, 185]')
```
</TabItem>
</Tabs>
### With `update()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -64,19 +35,8 @@ const { data, error } = await supabase
.rangeAdjacent('population_range_millions', '[70, 185]')
```
</TabItem>
</Tabs>
### With `delete()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -84,26 +44,11 @@ const { data, error } = await supabase
.rangeAdjacent('population_range_millions', '[70, 185]')
```
</TabItem>
</Tabs>
### With `rpc()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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]')
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/rangegt.mdx
+1 -56
View File
@@ -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'
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -22,21 +15,10 @@ const { data, error } = await supabase
.rangeGt('population_range_millions', '[150, 250]')
```
</TabItem>
</Tabs>
## Examples
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -44,19 +26,8 @@ const { data, error } = await supabase
.rangeGt('population_range_millions', '[150, 250]')
```
</TabItem>
</Tabs>
### With `update()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -64,19 +35,8 @@ const { data, error } = await supabase
.rangeGt('population_range_millions', '[150, 250]')
```
</TabItem>
</Tabs>
### With `delete()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -84,26 +44,11 @@ const { data, error } = await supabase
.rangeGt('population_range_millions', '[150, 250]')
```
</TabItem>
</Tabs>
### With `rpc()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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]')
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/rangegte.mdx
+1 -56
View File
@@ -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'
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -22,21 +15,10 @@ const { data, error } = await supabase
.rangeGte('population_range_millions', '[150, 250]')
```
</TabItem>
</Tabs>
## Examples
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -44,19 +26,8 @@ const { data, error } = await supabase
.rangeGte('population_range_millions', '[150, 250]')
```
</TabItem>
</Tabs>
### With `update()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -64,19 +35,8 @@ const { data, error } = await supabase
.rangeGte('population_range_millions', '[150, 250]')
```
</TabItem>
</Tabs>
### With `delete()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -84,26 +44,11 @@ const { data, error } = await supabase
.rangeGte('population_range_millions', '[150, 250]')
```
</TabItem>
</Tabs>
### With `rpc()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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]')
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/rangelt.mdx
+1 -56
View File
@@ -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'
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -22,21 +15,10 @@ const { data, error } = await supabase
.rangeLt('population_range_millions', '[150, 250]')
```
</TabItem>
</Tabs>
## Examples
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -44,19 +26,8 @@ const { data, error } = await supabase
.rangeLt('population_range_millions', '[150, 250]')
```
</TabItem>
</Tabs>
### With `update()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -64,19 +35,8 @@ const { data, error } = await supabase
.rangeLt('population_range_millions', '[150, 250]')
```
</TabItem>
</Tabs>
### With `delete()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -84,26 +44,11 @@ const { data, error } = await supabase
.rangeLt('population_range_millions', '[150, 250]')
```
</TabItem>
</Tabs>
### With `rpc()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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]')
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/rangelte.mdx
+1 -56
View File
@@ -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'
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -22,21 +15,10 @@ const { data, error } = await supabase
.rangeLte('population_range_millions', '[150, 250]')
```
</TabItem>
</Tabs>
## Examples
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -44,19 +26,8 @@ const { data, error } = await supabase
.rangeLte('population_range_millions', '[150, 250]')
```
</TabItem>
</Tabs>
### With `update()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -64,19 +35,8 @@ const { data, error } = await supabase
.rangeLte('population_range_millions', '[150, 250]')
```
</TabItem>
</Tabs>
### With `delete()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('countries')
@@ -84,26 +44,11 @@ const { data, error } = await supabase
.rangeLte('population_range_millions', '[150, 250]')
```
</TabItem>
</Tabs>
### With `rpc()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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]')
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/removeallsubscriptions.mdx
+1 -23
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
supabase.removeAllSubscriptions()
```
</TabItem>
</Tabs>
## 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
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
supabase.removeAllSubscriptions()
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/removesubscription.mdx
+1 -23
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
supabase.removeSubscription(mySubscription)
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -59,17 +48,6 @@ The subscription you want to close and remove.
### Remove a subscription
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
supabase.removeSubscription(mySubscription)
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/rpc.mdx
+1 -67
View File
@@ -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;
```
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.rpc('hello_world')
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.rpc('hello_world')
```
</TabItem>
</Tabs>
### With Parameters
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.rpc('echo_city', { name: 'The Shire' })
```
</TabItem>
</Tabs>
### Bulk processing
You can process large payloads at once using [array parameters](https://postgrest.org/en/stable/api.html#calling-functions-with-array-parameters).
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await postgrest.rpc('echo_cities', {
names: ['The Shire', 'Mordor'],
})
```
</TabItem>
</Tabs>
### 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).
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.rpc('echo_all_cities')
@@ -224,22 +173,11 @@ const { data, error } = await supabase
.eq('name', 'The Shire')
```
</TabItem>
</Tabs>
### 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`.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error, count } = await supabase.rpc(
'hello_world',
@@ -247,7 +185,3 @@ const { data, error, count } = await supabase.rpc(
{ count: 'exact' }
)
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/select.mdx
+1 -111
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.from('cities').select()
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -127,51 +116,22 @@ Count algorithm to use to count rows in a table.
### Getting your data
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.from('cities').select()
```
</TabItem>
</Tabs>
### Selecting specific columns
You can select specific fields from your tables.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.from('cities').select('name')
```
</TabItem>
</Tabs>
### Query foreign tables
If your database has foreign key relationships, you can query related tables too.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.from('countries').select(`
name,
@@ -181,10 +141,6 @@ const { data, error } = await supabase.from('countries').select(`
`)
```
</TabItem>
</Tabs>
:::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:
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.from('products').select(`
id,
@@ -216,22 +165,11 @@ const { data, error } = await supabase.from('products').select(`
`)
```
</TabItem>
</Tabs>
### 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":
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('messages')
@@ -239,32 +177,17 @@ const { data, error } = await supabase
.eq('users.username', 'Jane')
```
</TabItem>
</Tabs>
### 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).
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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 }
```
</TabItem>
</Tabs>
### 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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('users')
@@ -292,40 +208,18 @@ const { data, error } = await supabase
.eq('address->postcode', 90210)
```
</TabItem>
</Tabs>
### 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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.from('users').select().csv()
```
</TabItem>
</Tabs>
### 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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const ac = new AbortController()
supabase
@@ -348,7 +242,3 @@ ac.abort()
// statusText: 'Bad Request'
// }
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/single.mdx
+1 -23
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -26,21 +19,10 @@ const { data, error } = await supabase
.single()
```
</TabItem>
</Tabs>
## Examples
### With `select()`
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -48,7 +30,3 @@ const { data, error } = await supabase
.limit(1)
.single()
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/storage-createbucket.mdx
+1 -23
View File
@@ -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
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.storage.createBucket('avatars', {
public: false,
})
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -108,19 +97,8 @@ No description provided.
### Create bucket
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.storage.createBucket('avatars', {
public: false,
})
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/storage-deletebucket.mdx
+1 -23
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.storage.deleteBucket('avatars')
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -62,17 +51,6 @@ The unique identifier of the bucket you would like to delete.
### Delete bucket
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.storage.deleteBucket('avatars')
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/storage-emptybucket.mdx
+1 -23
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.storage.emptyBucket('avatars')
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -61,17 +50,6 @@ The unique identifier of the bucket you would like to empty.
### Empty bucket
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.storage.emptyBucket('avatars')
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-copy.mdx
+1 -23
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.storage
.from('avatars')
.copy('public/avatar1.png', 'private/avatar2.png')
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -83,19 +72,8 @@ The new file path, including the new file name. For example `folder/image-copy.p
### Copy file
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.storage
.from('avatars')
.copy('public/avatar1.png', 'private/avatar2.png')
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-createsignedurl.mdx
+1 -23
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { signedURL, error } = await supabase.storage
.from('avatars')
.createSignedUrl('folder/avatar1.png', 60)
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -83,19 +72,8 @@ The number of seconds until the signed URL expires. For example, `60` for a URL
### Create Signed URL
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { signedURL, error } = await supabase.storage
.from('avatars')
.createSignedUrl('folder/avatar1.png', 60)
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-createsignedurls.mdx
+1 -23
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.storage
.from('avatars')
.createSignedUrls(['folder/avatar1.png', 'folder/avatar2.png'], 60)
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -83,19 +72,8 @@ The number of seconds until the signed URLs expire. For example, `60` for URLs w
### Create Signed URLs
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.storage
.from('avatars')
.createSignedUrls(['folder/avatar1.png', 'folder/avatar2.png'], 60)
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-download.mdx
+1 -23
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.storage
.from('avatars')
.download('folder/avatar1.png')
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -63,19 +52,8 @@ The file path to be downloaded, including the path and file name. For example `f
### Download file
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.storage
.from('avatars')
.download('folder/avatar1.png')
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-getpublicurl.mdx
+1 -23
View File
@@ -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
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { publicURL, error } = supabase.storage
.from('public-bucket')
.getPublicUrl('folder/avatar1.png')
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -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
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { publicURL, error } = supabase.storage
.from('public-bucket')
.getPublicUrl('folder/avatar1.png')
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-list.mdx
+1 -34
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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', {
})
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -105,13 +94,6 @@ Fetch parameters, currently only supports `signal`, which is an AbortController'
### List files in a bucket
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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', {
})
```
</TabItem>
</Tabs>
### Search files in a bucket
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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',
})
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-move.mdx
+1 -23
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.storage
.from('avatars')
.move('public/avatar1.png', 'private/avatar2.png')
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -83,19 +72,8 @@ The new file path, including the new file name. For example `folder/image-new.pn
### Move file
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.storage
.from('avatars')
.move('public/avatar1.png', 'private/avatar2.png')
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-remove.mdx
+1 -23
View File
@@ -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
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.storage
.from('avatars')
.remove(['folder/avatar1.png'])
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -63,19 +52,8 @@ An array of files to be deleted, including the path and file name. For example [
### Delete file
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.storage
.from('avatars')
.remove(['folder/avatar1.png'])
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-update.mdx
+1 -34
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const avatarFile = event.target.files[0]
const { data, error } = await supabase.storage
@@ -27,10 +20,6 @@ const { data, error } = await supabase.storage
})
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -111,13 +100,6 @@ HTTP headers.
### Update file
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const avatarFile = event.target.files[0]
const { data, error } = await supabase.storage
@@ -128,19 +110,8 @@ const { data, error } = await supabase.storage
})
```
</TabItem>
</Tabs>
### Update file using `ArrayBuffer` from base64 file data
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
import { decode } from 'base64-arraybuffer'
@@ -150,7 +121,3 @@ const { data, error } = await supabase.storage
contentType: 'image/png',
})
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/storage-from-upload.mdx
+1 -34
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const avatarFile = event.target.files[0]
const { data, error } = await supabase.storage
@@ -27,10 +20,6 @@ const { data, error } = await supabase.storage
})
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -111,13 +100,6 @@ HTTP headers.
### Upload file
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const avatarFile = event.target.files[0]
const { data, error } = await supabase.storage
@@ -128,19 +110,8 @@ const { data, error } = await supabase.storage
})
```
</TabItem>
</Tabs>
### Upload file using `ArrayBuffer` from base64 file data
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
import { decode } from 'base64-arraybuffer'
@@ -150,7 +121,3 @@ const { data, error } = await supabase.storage
contentType: 'image/png',
})
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/storage-getbucket.mdx
+1 -23
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.storage.getBucket('avatars')
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -61,17 +50,6 @@ The unique identifier of the bucket you would like to retrieve.
### Get bucket
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.storage.getBucket('avatars')
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/storage-listbuckets.mdx
+1 -23
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.storage.listBuckets()
```
</TabItem>
</Tabs>
## Notes
- Policy permissions required:
@@ -35,17 +24,6 @@ const { data, error } = await supabase.storage.listBuckets()
### List buckets
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.storage.listBuckets()
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/storage-updatebucket.mdx
+1 -23
View File
@@ -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
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.storage.updateBucket('avatars', {
public: false,
})
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -108,19 +97,8 @@ No description provided.
### Update bucket
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase.storage.updateBucket('avatars', {
public: false,
})
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/subscribe.mdx
+1 -89
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const mySubscription = supabase
.from('*')
@@ -26,10 +19,6 @@ const mySubscription = supabase
.subscribe()
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -85,13 +74,6 @@ A callback that will handle the payload that is sent whenever your database chan
### Listen to all database changes
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const mySubscription = supabase
.from('*')
@@ -101,19 +83,8 @@ const mySubscription = supabase
.subscribe()
```
</TabItem>
</Tabs>
### Listening to a specific table
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const mySubscription = supabase
.from('countries')
@@ -123,19 +94,8 @@ const mySubscription = supabase
.subscribe()
```
</TabItem>
</Tabs>
### Listening to inserts
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const mySubscription = supabase
.from('countries')
@@ -145,10 +105,6 @@ const mySubscription = supabase
.subscribe()
```
</TabItem>
</Tabs>
### 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;
```
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const mySubscription = supabase
.from('countries')
@@ -174,10 +123,6 @@ const mySubscription = supabase
.subscribe()
```
</TabItem>
</Tabs>
### 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;
```
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const mySubscription = supabase
.from('countries')
@@ -203,21 +141,10 @@ const mySubscription = supabase
.subscribe()
```
</TabItem>
</Tabs>
### Listening to multiple events
You can chain listeners if you want to listen to multiple events for each table.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const mySubscription = supabase
.from('countries')
@@ -226,28 +153,13 @@ const mySubscription = supabase
.subscribe()
```
</TabItem>
</Tabs>
### 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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const mySubscription = supabase
.from('countries:id=eq.200')
.on('UPDATE', handleRecordUpdated)
.subscribe()
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/textsearch.mdx
+1 -45
View File
@@ -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
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('quotes')
@@ -122,21 +115,10 @@ const { data, error } = await supabase
})
```
</TabItem>
</Tabs>
### Basic normalization
Uses PostgreSQL's `plainto_tsquery` function.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('quotes')
@@ -147,21 +129,10 @@ const { data, error } = await supabase
})
```
</TabItem>
</Tabs>
### Full normalization
Uses PostgreSQL's `phraseto_tsquery` function.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('quotes')
@@ -172,10 +143,6 @@ const { data, error } = await supabase
})
```
</TabItem>
</Tabs>
### 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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('quotes')
@@ -203,7 +163,3 @@ const { data, error } = await supabase
config: 'english',
})
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/update.mdx
+1 -34
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -24,10 +17,6 @@ const { data, error } = await supabase
.match({ name: 'Auckland' })
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -127,13 +116,6 @@ Count algorithm to use to count rows in a table.
### Updating your data
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('cities')
@@ -141,10 +123,6 @@ const { data, error } = await supabase
.match({ name: 'Auckland' })
```
</TabItem>
</Tabs>
### 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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('users')
@@ -172,7 +143,3 @@ const { data, error } = await supabase
)
.eq('address->postcode', 90210)
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/upsert.mdx
+1 -56
View File
@@ -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.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('messages')
.upsert({ id: 3, message: 'foo', username: 'supabot' })
```
</TabItem>
</Tabs>
## Parameters
<ul className="method-list-group">
@@ -167,32 +156,14 @@ Count algorithm to use to count rows in a table.
### Upsert your data
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('messages')
.upsert({ id: 3, message: 'foo', username: 'supabot' })
```
</TabItem>
</Tabs>
### Bulk Upsert your data
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```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([
])
```
</TabItem>
</Tabs>
### 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`.
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error } = await supabase
.from('users')
.upsert({ username: 'supabot' }, { onConflict: 'username' })
```
</TabItem>
</Tabs>
### Return the exact number of rows
<Tabs
defaultValue="js"
groupId="reference/supabase-js"
values={[{ label: 'JavaScript', value: 'js' }]}>
<TabItem value="js">
```js
const { data, error, count } = await supabase.from('users').upsert(
{
@@ -248,7 +197,3 @@ const { data, error, count } = await supabase.from('users').upsert(
}
)
```
</TabItem>
</Tabs>
apps/reference/_supabase_js_versioned_docs/version-v1/using-filters.mdx
+1 -1
View File
@@ -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'
apps/reference/_supabase_js_versioned_docs/version-v1/using-modifiers.mdx
+1 -1
View File
@@ -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'
packages/generator/package.json
+5 -7
View File
@@ -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",
spec/supabase_js_v1_legacy.yml
+1 -1
View File
@@ -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:
spec/supabase_js_v2_legacy.yml
+1 -1
View File
@@ -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: