mirror of
https://github.com/supabase/supabase.git
synced 2026-10-13 05:09:12 +03:00
173 lines
3.8 KiB
YAML
173 lines
3.8 KiB
YAML
openref: 0.1
|
|
|
|
info:
|
|
title: PostgREST Client
|
|
description: |
|
|
PostgREST is a standalone web server that turns your PostgreSQL database directly into a RESTful API.
|
|
|
|
Supabase provides client libraries to interact with the PostgREST.
|
|
|
|
definition: spec/postgrest.json
|
|
libraries:
|
|
- name: 'JavaScript'
|
|
id: 'js'
|
|
version: '0.0.1'
|
|
- name: 'Python'
|
|
id: 'py'
|
|
version: '0.0.1'
|
|
docs:
|
|
path: postgrest/client/
|
|
sidebar:
|
|
- name: 'About'
|
|
items:
|
|
- index
|
|
- Installing
|
|
- Initializing
|
|
- name: 'Query Builder'
|
|
items:
|
|
- from
|
|
- select
|
|
- insert
|
|
- update
|
|
- delete
|
|
- rpc
|
|
- name: 'Filters'
|
|
items:
|
|
- filter
|
|
- not
|
|
- eq
|
|
- neq
|
|
- gt
|
|
- gte
|
|
- lt
|
|
- lte
|
|
- like
|
|
- ilike
|
|
- is
|
|
- in
|
|
- cs
|
|
- cd
|
|
- sl
|
|
- sr
|
|
- nxl
|
|
- nxr
|
|
- adj
|
|
- ov
|
|
- fts
|
|
- plfts
|
|
- phfts
|
|
- wfts
|
|
|
|
pages:
|
|
|
|
Installing:
|
|
description: |
|
|
All JavaScript libraries are built directly by the Supabase team.
|
|
|
|
Other languages are built by the community and supported by Supabase.
|
|
|
|
## JavaScript
|
|
|
|
```bash
|
|
npm install @supabase/postgrest-js
|
|
```
|
|
|
|
- [Source code](https://github.com/supabase/postgrest-js)
|
|
|
|
## Python
|
|
|
|
```bash
|
|
# Not yet implemented
|
|
|
|
Initializing:
|
|
$ref: '"PostgrestClient".PostgrestClient.constructor'
|
|
|
|
from:
|
|
$ref: '"PostgrestClient".PostgrestClient.from'
|
|
|
|
select:
|
|
$ref: '"lib/PostgrestQueryBuilder".PostgrestQueryBuilder.select'
|
|
|
|
insert:
|
|
$ref: '"lib/PostgrestQueryBuilder".PostgrestQueryBuilder.insert'
|
|
|
|
update:
|
|
$ref: '"lib/PostgrestQueryBuilder".PostgrestQueryBuilder.update'
|
|
|
|
delete:
|
|
$ref: '"lib/PostgrestQueryBuilder".PostgrestQueryBuilder.delete'
|
|
|
|
rpc:
|
|
$ref: '"PostgrestClient".PostgrestClient.rpc'
|
|
|
|
filter:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.filter'
|
|
|
|
not:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.not'
|
|
|
|
eq:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.eq'
|
|
|
|
neq:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.neq'
|
|
|
|
gt:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.gt'
|
|
|
|
gte:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.gte'
|
|
|
|
lt:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.lt'
|
|
|
|
lte:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.lte'
|
|
|
|
like:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.like'
|
|
|
|
ilike:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.ilike'
|
|
|
|
is:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.is'
|
|
|
|
in:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.in'
|
|
|
|
cs:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.cs'
|
|
|
|
cd:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.cd'
|
|
|
|
sl:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.sl'
|
|
|
|
sr:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.sr'
|
|
|
|
nxl:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.nxl'
|
|
|
|
nxr:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.nxr'
|
|
|
|
adj:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.adj'
|
|
|
|
ov:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.ov'
|
|
|
|
fts:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.fts'
|
|
|
|
plfts:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.plfts'
|
|
|
|
phfts:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.phfts'
|
|
|
|
wfts:
|
|
$ref: '"lib/PostgrestFilterBuilder".PostgrestFilterBuilder.wfts' |