Version: Next

Updating

Toggle Example Tables

We will be fictional "world" database in all of our examples.

Countries
idnameiso2population_range_millionsmain_exports
76BrazilBR( 205, 215 )[ beans, minerals ]
156ChinaCN( 1380, 1390 )[ computers, phones ]
250FranceFR( 60, 70 )[ cars, machines ]
554New ZealandNZ( 4, 6 )[ food, machines ]
556NigeriaNG( 185, 195 )[ oil, beans ]
840United StatesUS( 320, 330 )[ oil, cars, food ]
Cities
namecountry_id
Rio de Janeiro76
Beijing156
Paris250
Auckland554
Lagos556
Los Angeles840
San Francisco840

Update record

Updates information about a city.
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', 'public-key-bOYapLADERfE')
const updateCityName = async () => {
try {
let updates = await supabase
.from('cities')
.update({ name: 'Middle Earth' })
.match({ name: 'Auckland' })
return updates
} catch (error) {
console.log('Error: ', error)
}
}

Reference

from()

supabase
.from(tableName)

tableName: string

Name of the database table to be listened to. Using the wildcard "*" will lead to all tables to be listened to.

tableName: string

Name of the database table that will be read from.

tableName: string

Name of the database table where data will be saved.

tableName: string

Name of the database table where data will be updated.

tableName: string

Name of the database table where data will be deleted.


update()

supabase
.from(tableName)
.update(data)

It is to note that it is required to apply filters when using .update(). Not using filters would result in an error.

data: object

New record values.


Filtering

filter()

Shows how to use filter( ) with update( )
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', 'public-key-bOYapLADERfE')
const updateCityName = async () => {
try {
let cities = await supabase
.from('cities')
.update({ name: 'Mordor' })
.filter('name', 'eq', 'Paris')
return cities
} catch (error) {
console.log('Error: ', error)
}
}

General form

supabase
.from(tableName)
.filter(columnName, operator, criteria)

This allows you to apply various filters on your query. Filters can also be chained together.

columnName: string

Name of the database column.

operator: string

Name of filter operator to be utilised.

criteria: { object | array | string | integer | boolean | null }

Value to compare to. Exact data type of criteria would depend on the operator used.


not()

Shows how to use not( ) with update( )
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', 'public-key-bOYapLADERfE')
const updateCities = async () => {
try {
let cities = await supabase
.from('cities')
.update({ name: 'Mordor' })
.not('name', 'eq', 'Paris')
return cities
} catch (error) {
console.log('Error: ', error)
}
}

General form

supabase
.from(tableName)
.not(columnName, operator, criteria)

Reverse of .filter(). Returns rows that do not meet the criteria specified using the columnName and operator provided.

columnName: string

Name of the database column.

operator: string

Name of filter operator to be utilised.

criteria: { object | array | string | integer | boolean | null }

Value to compare to. Exact data type of criteria would depend on the operator used.


match()

Shows how to use match( ) with update( )
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', 'public-key-bOYapLADERfE')
const updateCityName = async () => {
try {
let cities = await supabase
.from('cities')
.update({ name: 'Mordor' })
.match({name: 'Beijing', country_id: 156})
return cities
} catch (error) {
console.log('Error: ', error)
}
}

General form

supabase
.from(tableName)
.match(filterObject)

Finds rows that exactly match the specified filterObject. Equivalent of multiple filter('columnName', 'eq', criteria).

filterObject: object

An object of { 'columnName': 'criteria' }


eq()

Shows how to use eq( ) with update( )
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', 'public-key-bOYapLADERfE')
const updateCityName = async () => {
try {
let cities = await supabase
.from('cities')
.update({ name: 'Mordor' })
.eq('name', 'San Francisco')
return cities
} catch (error) {
console.log('Error: ', error)
}
}

General form

supabase
.from(tableName)
.eq(columnName, filterValue)

Finds all rows whose value on the stated columnName exactly matches the specified filterValue. Equivalent of filter(columnName, 'eq', criteria).

columnName: string

Name of the database column.

filterValue: { string | integer | boolean }

Value to match.


neq()

Shows how to use neq( ) with update( )
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', 'public-key-bOYapLADERfE')
const updateCityName = async () => {
try {
let cities = await supabase
.from('cities')
.update({ name: 'Mordor' })
.neq('name', 'Lagos')
return cities
} catch (error) {
console.log('Error: ', error)
}
}

General form

supabase
.from(tableName)
.neq(columnName, filterValue)

Finds all rows whose value on the stated columnName does not match the specified filterValue. Equivalent of filter(columnName, 'neq', criteria).

columnName: string

Name of database column.

filterValue: { string | integer | boolean }

Value to not match.


gt()

Shows how to use gt( ) with update( )
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', 'public-key-bOYapLADERfE')
const updateCityName = async () => {
try {
let cities = await supabase
.from('cities')
.update({ name: 'Mordor' })
.gt('country_id', 250)
return cities
} catch (error) {
console.log('Error: ', error)
}
}

General form

supabase
.from(tableName)
.gt(columnName, filterValue)

Finds all rows whose value on the stated columnName is greater than the specified filterValue. Eqiuvalent of filter(columnName, 'gt', criteria).

columnName: string

Name of database column.

filterValue: { string | integer | boolean }

Value to compare to.


lt()

Shows how to use lt( ) with update( )
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', 'public-key-bOYapLADERfE')
const updateCityName = async () => {
try {
let cities = await supabase
.from('cities')
.update({ name: 'Mordor' })
.lt('country_id', 250)
return cities
} catch (error) {
console.log('Error: ', error)
}
}

General form

supabase
.from(tableName)
.lt(columnName, filterValue)

Finds all rows whose value on the stated columnName is less than the specified filterValue. Eqiuvalent of filter(columnName, 'lt', criteria).

columnName: string

Name of database column.

filterValue: { string | integer | boolean }

Value to compare to.


gte()

Shows how to use gte( ) with update( )
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', 'public-key-bOYapLADERfE')
const updateCityName = async () => {
try {
let cities = await supabase
.from('cities')
.update({ name: 'Mordor' })
.gte('country_id', 250)
return cities
} catch (error) {
console.log('Error: ', error)
}
}

General form

supabase
.from(tableName)
.gte(columnName, filterValue)

Finds all rows whose value on the stated columnName is greater than or equal to the specified filterValue. Eqiuvalent of filter(columnName, 'gte', criteria).

columnName: string

Name of database column.

filterValue: { string | integer | boolean }

Value to compare to.


lte()

Shows how to use lte( ) with update( )
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', 'public-key-bOYapLADERfE')
const updateCityName = async () => {
try {
let cities = await supabase
.from('cities')
.update({ name: 'Mordor' })
.lte('country_id', 250)
return cities
} catch (error) {
console.log('Error: ', error)
}
}

General form

supabase
.from(tableName)
.lte(columnName, filterValue)

Finds all rows whose value on the stated columnName is less than or equal to the specified filterValue. Eqiuvalent of filter(columnName, 'lte', criteria).

columnName: string

Name of database column.

filterValue: { string | integer | boolean }

Value to compare to.


like()

Shows how to use like( ) with update( )
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', 'public-key-bOYapLADERfE')
const updateCityName = async () => {
try {
let cities = await supabase
.from('cities')
.update({ name: 'Mordor' })
.like('name', '%la%')
return cities
} catch (error) {
console.log('Error: ', error)
}
}
}

General form

supabase
.from(tableName)
.like(columnName, stringPattern)

Finds all rows whose value in the stated columnName matches the supplied pattern. Equivalent of filter(columnName, 'like', stringPattern).

columnName: string

Name of database column.

stringPattern: string

String pattern to compare to. A comprehensive guide on how to form proper patterns can be found here.


ilike()

Shows how to use ilike( ) with update( )
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', 'public-key-bOYapLADERfE')
const updateCityName = async () => {
try {
let cities = await supabase
.from('cities')
.update({ name: 'Mordor' })
.ilike('name', '%la%')
return cities
} catch (error) {
console.log('Error: ', error)
}
}

General form

supabase
.from(tableName)
.ilike(columnName, stringPattern)

A case-sensitive version of like(). Equivalent of filter(columnName, 'ilike', stringPattern).

columnName: string

Name of database column.

stringPattern: string

String pattern to compare to. A comprehensive guide on how to form proper patterns can be found here.


is()

Shows how to use is( ) with update( )
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', 'public-key-bOYapLADERfE')
const updateCityName = async () => {
try {
let cities = await supabase
.from('cities')
.update({ name: 'Mordor' })
.is('name', null)
return cities
} catch (error) {
console.log('Error: ', error)
}
}

General form

supabase
.from(tableName)
.is(columnName, filterValue)

A check for exact equality (null, true, false), finds all rows whose value on the state columnName exactly match the specified filterValue. Equivalent of filter(columnName, 'is', filterValue).

columnName: string

Name of database column.

filterValue: { null | boolean }

Value to match.


in()

Shows how to use in( ) with update( )
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', 'public-key-bOYapLADERfE')
const updateCityName = async () => {
try {
let cities = await supabase
.from('cities')
.update({ name: 'Mordor' })
.in('name', ['Rio de Janeiro', 'San Francisco'])
return cities
} catch (error) {
console.log('Error: ', error)
}
}

General form

supabase
.from(tableName)
.in(columnName, filterArray)

Finds all rows whose value on the stated columnName is found on the specified filterArray. Equivalent of filter(columnName, 'in', criteria).

columnName: string

Name of database column.

filterArray: array

Array of values to find a match. Data type of values is dependent on the columnName specified.


cs()

Shows how to use cs( ) with update( )
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', 'public-key-bOYapLADERfE')
const updateCountryName = async () => {
try {
let countries = await supabase
.from('countries')
.update({ name: 'Mordor' })
.cs('main_exports', ['oil'])
return countries
} catch (error) {
console.log('Error: ', error)
}
}

General form

supabase
.from(tableName)
.cs(columnName, filterObject)

Finds all rows whose json, array, or range value on the stated columnName contains the items specified in the filterObject. Equivalent of filter(columName, 'cs', criteria).

columnName: string

Name of the database column.

filterObject: { array | object }

Value to compare to.


cd()

Shows how to use cd( ) with update( )
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', 'public-key-bOYapLADERfE')
const updateCountryName = async () => {
try {
let countries = await supabase
.from('countries')
.update({ name: 'Mordor' })
.cd('main_exports', ['cars', 'food', 'machine'])
return countries
} catch (error) {
console.log('Error: ', error)
}
}

General form

supabase
.from(tableName)
.cd(columnName, filterObject)

Finds all rows whose json, array, or range value on the stated columnName is contained by the specific filterObject. Equivalent of filter(columName, 'cd', criteria).

columnName: string

Name of the database column.

filterObject: { array | object }

Value to compare to.


ova()

Shows how to use ova( ) with update( )
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', 'public-key-bOYapLADERfE')
const updateCountryName = async () => {
try {
let countries = await supabase
.from('countries')
.update({ name: 'Mordor' })
.ova('main_exports', ['computers', 'minerals'])
return countries
} catch (error) {
console.log('Error: ', error)
}
}

General form

supabase
.from(tableName)
.ova(columnName, filterArray)

Finds all rows whose array value on the stated columnName overlaps with the specified filterArray. Equivalent of filter(columnName, 'ova', criteria).

columnName: string

Name of the database column.

filterArray: array

Value to compare to.


ovr()

Shows how to use ovr( ) with update( )
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', 'public-key-bOYapLADERfE')
const updateCountryName = async () => {
try {
let countries = await supabase
.from('countries')
.update({ name: 'Mordor' })
.ovr('population_range_millions', [150, 250])
return countries
} catch (error) {
console.log('Error: ', error)
}
}

General form

supabase
.from(tableName)
.ovr(columnName, filterRange)

Finds all rows whose range value on the stated columnName overlaps with the specified filterRange. Equivalent of filter(columnName, 'ovr', criteria).

columnName: string

Name of the database column.

filterRange: array

Array to compare to. Returns an error if length of array provided is not equal to 2.


sl()

Shows how to use sl( ) with update( )
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', 'public-key-bOYapLADERfE')
const updateCountryName = async () => {
try {
let countries = await supabase
.from('countries')
.update({ name: 'Mordor' })
.sl('population_range_millions', [150, 250])
return countries
} catch (error) {
console.log('Error: ', error)
}
}

General form

supabase
.from(tableName)
.sl(columnName, filterRange)

Finds all rows whose range value on the stated columnName is strictly on the left hand side of the specified filterRange. Equivalent of filter(columnName, 'sl', criteria).

columnName: string

Name of the database column.

filterRange: array

Array to compare to. Returns an error if length of array provided is not equal to 2.


sr()

Shows how to use sr( ) with update( )
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', 'public-key-bOYapLADERfE')
const updateCountryName = async () => {
try {
let countries = await supabase
.from('countries')
.update({ name: 'Mordor' })
.sr('population_range_millions', [150, 250])
return countries
} catch (error) {
console.log('Error: ', error)
}
}

General form

supabase
.from(tableName)
.sr(columnName, filterRange)

Finds all rows whose range value on the stated columnName is strictly on the right hand side of the specified filterRange. Equivalent of filter(columnName, 'sr', criteria).

columnName: string

Name of the database column.

filterRange: array

Array to compare to. Returns an error if length of array provided is not equal to 2.


nxl()

Shows how to use nxl( ) with update( )
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', 'public-key-bOYapLADERfE')
const updateCountryName = async () => {
try {
let countries = await supabase
.from('countries')
.update({ name: 'Mordor' })
.nxl('population_range_millions', [150, 250])
return countries
} catch (error) {
console.log('Error: ', error)
}
}

General form

supabase
.from(tableName)
.nxl(columnName, filterRange)

Finds all rows whose range value on the stated columnName does not extend to the left of the specified filterRange. Equivalent of filter(columnName, 'nxl', criteria).

columnName: string

Name of the database column.

filterRange: array

Array to compare to. Returns an error if length of array provided is not equal to 2.


nxr()

Shows how to use nxr( ) with update( )
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', 'public-key-bOYapLADERfE')
const updateCountryName = async () => {
try {
let countries = await supabase
.from('countries')
.update({ name: 'Mordor' })
.nxr('population_range_millions', [150, 250])
return countries
} catch (error) {
console.log('Error: ', error)
}
}

General form

supabase
.from(tableName)
.nxr(columnName, filterRange)

Finds all rows whose range value on the stated columnName does not extend to the right of the specified filterRange. Equivalent of filter(columnName, 'nxr', criteria).

columnName: string

Name of the database column.

filterRange: array

Array to compare to. Returns an error if length of array provided is not equal to 2.


adj()

Shows how to use adj( ) with update( )
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', 'public-key-bOYapLADERfE')
const updateCountryName = async () => {
try {
let countries = await supabase
.from('countries')
.update({ name: 'Mordor' })
.adj('population_range_millions', [70, 185])
return countries
} catch (error) {
console.log('Error: ', error)
}
}

General form

supabase
.from(tableName)
.adj(columnName, filterRange)

Finds all rows whose range value on the stated columnName is adjacent to the specified filterRange. Equivalent of filter(columnName, 'adj', criteria).

columnName: string

Name of the database column.

filterRange: array

Array to compare to. Returns an error if length of array provided is not equal to 2.


Responses

200 OK

Successful request

400 Bad request

An invalid syntax or configuration was sent.

401 Unauthorized

Invalid credentials were provided.

404 Not found

Requested resource cannot be found.

406 Not acceptable

The response provided by the server does not match the list of acceptable values stated in the request's headers.

409 Violating foreign key constraint

Raised when you are trying to insert or update into a table with a foreign key which doesn't exist on the target foreign relationship.

500 Internal Server Error

The server was unable to encounter the situation it encountered.