Files
supabase/apps/reference/_supabase_js/generated/range.mdx
T
Bobbie Soedirgo a7a56eb800 docs(reference/v2/postgrest-js): update spec
* `curl -sS https://supabase.github.io/postgrest-js/spec.json >
spec/enrichments/tsdoc_v2/postgrest.json`
* `cd spec && make transform generate.js.v2 format`
2022-09-20 16:34:12 +08:00

122 lines
2.4 KiB
Plaintext

---
id: range
title: 'range()'
slug: /range
custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v2_legacy.yml
---
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
Limit the query result by `from` and `to` inclusively.
```js
const { data, error } = await supabase
.from('cities')
.select('name, country_id')
.range(0, 3)
```
## Parameters
<ul className="method-list-group">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
from
</span>
<span className="method-list-item-label-badge required">
required
</span>
<span className="method-list-item-validation">
<code>number</code>
</span>
</h4>
<div class="method-list-item-description">
The starting index from which to limit the result
</div>
</li>
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
to
</span>
<span className="method-list-item-label-badge required">
required
</span>
<span className="method-list-item-validation">
<code>number</code>
</span>
</h4>
<div class="method-list-item-description">
The last index to which to limit the result
</div>
</li>
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
options
</span>
<span className="method-list-item-label-badge required">
required
</span>
<span className="method-list-item-validation">
<code>object</code>
</span>
</h4>
<div class="method-list-item-description">
Named parameters
</div>
<ul className="method-list-group">
<h5 class="method-list-title method-list-title-isChild expanded">Properties</h5>
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
foreignTable
</span>
<span className="method-list-item-label-badge false">
optional
</span>
<span className="method-list-item-validation">
<code>string</code>
</span>
</h4>
<div class="method-list-item-description">
Set this to limit rows of foreign tables
instead of the current table
</div>
</li>
</ul>
</li>
</ul>
## Examples
### With `select()`
```js
const { data, error } = await supabase
.from('cities')
.select('name, country_id')
.range(0, 3)
```