Files
supabase/web/docs/library/delete.mdx
T
2020-01-14 14:42:28 +08:00

117 lines
1.8 KiB
Plaintext

---
id: delete
title: 'Deleting'
---
import DummyData from '../common/DummyData.mdx'
import Collapsable from '../../src/components/Collapsable'
import CommonResponses from '../common/CommonResponses.mdx'
import CommonFilters from '../common/CommonFilters'
import FromFunction from '../common/FromFunction.mdx'
<DummyData />
### Delete records
This example how to delete a city:
<!-- prettier-ignore -->
```js {7-10}
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://world.supabase.co', '1a2b-3c4d-5e6f-7g8h')
const updateCountryName = async () => {
try {
let values = await supabase
.from('cities')
.match({ id: 666 })
.delete()
return values
} catch (error) {
console.log('Error: ', error)
}
}
```
<Collapsable title="Toggle Example Response">
@todo
</Collapsable>
## Reference
### `from()`
<FromFunction verb='delete' />
### `delete()`
```js {3}
supabase
.from(tableName)
.delete(options?)
```
#### `options: object?`
```js
/**
* @param {boolean} [bulk=false]
* Protects against bulk updates. Set to true if you intend to perform a bulk change.
*/
const options = {
bulk: false
}
```
----
## Filtering
### `filter()`
<CommonFilters filter='filter'/>
### `match()`
<CommonFilters filter='match'/>
### `eq()`
<CommonFilters filter='eq'/>
### `gt()`
<CommonFilters filter='gt'/>
### `lt()`
<CommonFilters filter='lt'/>
### `gte()`
<CommonFilters filter='gte'/>
### `lte()`
<CommonFilters filter='lte'/>
### `like()`
<CommonFilters filter='like'/>
### `ilike()`
<CommonFilters filter='ilike'/>
### `is()`
<CommonFilters filter='is'/>
### `in()`
<CommonFilters filter='in'/>
### `not()`
<CommonFilters filter='not'/>
## Responses
#### 200 OK
Successful
<CommonResponses />