@supabase/postgrest-js
Advanced tools
@supabase/postgrest-js is a JavaScript client library for interacting with PostgREST APIs. It allows you to perform CRUD operations, filter data, and manage real-time subscriptions with ease. This package is particularly useful for developers working with Supabase, a backend-as-a-service platform that provides a PostgREST API for interacting with PostgreSQL databases.
CRUD Operations
This feature allows you to perform basic CRUD (Create, Read, Update, Delete) operations on your database tables. The code sample demonstrates how to insert a new record, read records, update a record, and delete a record from a 'users' table.
const { createClient } = require('@supabase/postgrest-js');
const client = createClient('https://your-project.supabase.co', 'public-anon-key');
// Create a new record
client.from('users').insert({ username: 'johndoe', age: 30 }).then(response => console.log(response));
// Read records
client.from('users').select('*').then(response => console.log(response));
// Update a record
client.from('users').update({ age: 31 }).eq('username', 'johndoe').then(response => console.log(response));
// Delete a record
client.from('users').delete().eq('username', 'johndoe').then(response => console.log(response));Filtering Data
This feature allows you to filter data based on specific conditions. The code sample demonstrates how to filter records where the age is 30 and how to use advanced filtering with multiple conditions.
const { createClient } = require('@supabase/postgrest-js');
const client = createClient('https://your-project.supabase.co', 'public-anon-key');
// Filter records
client.from('users').select('*').eq('age', 30).then(response => console.log(response));
// Advanced filtering
client.from('users').select('*').or('age.eq.30,username.eq.johndoe').then(response => console.log(response));Real-time Subscriptions
This feature allows you to subscribe to real-time changes in your database tables. The code sample demonstrates how to set up a subscription to listen for any changes in the 'users' table and log the changes to the console.
const { createClient } = require('@supabase/postgrest-js');
const client = createClient('https://your-project.supabase.co', 'public-anon-key');
// Subscribe to changes in the 'users' table
const subscription = client.from('users').on('*', payload => {
console.log('Change received!', payload);
}).subscribe();The 'pg' package is a PostgreSQL client for Node.js. It allows you to interact with PostgreSQL databases using SQL queries. Unlike @supabase/postgrest-js, which provides a higher-level abstraction for CRUD operations and real-time subscriptions, 'pg' requires you to write raw SQL queries and manage connections manually.
Knex.js is a SQL query builder for Node.js, supporting multiple database types including PostgreSQL. It provides a more flexible and powerful way to build SQL queries compared to @supabase/postgrest-js. However, it does not offer built-in real-time subscriptions and requires more setup for basic CRUD operations.
Sequelize is a promise-based Node.js ORM for various SQL databases, including PostgreSQL. It provides a higher-level abstraction for database operations, similar to @supabase/postgrest-js, but with more features like model definitions, associations, and migrations. However, it does not natively support real-time subscriptions.
Isomorphic JavaScript client for PostgREST. The goal of this library is to make an "ORM-like" restful interface.
Contents
npm install --save @supabase/postgrest-js
import { PostgrestClient } from ' @supabase/postgrest-js'
let client = new PostgrestClient('https://your-postgrest.com')
// Basic
let { body: countries } = await client
.from('countries')
.select('*')
// Getting specific columns
let { body: countries } = await client
.from('countries')
.select('name')
// Query foreign tables
let { body: countries } = await client
.from('countries')
.select(`
name,
cities (
name
)
`)
// Filter foreign tables
let { body: countries } = await client
.from('countries')
.select(`
name,
cities (
name
)
`)
.filter('name', 'eq', 'New Zealand')
.filter('cities.name', 'eq', 'Auckland')
// Ordering
let { body: countries } = await client
.from('countries')
.select('name')
.order('name')
// Pagination
let { body: countries } = await client
.from('countries')
.select('name')
.range(0, 10)
// Match
let { body: countries } = await client
.from('countries')
.match({ 'continent': 'Asia' })
.select('*')
// Equal
let { body: countries } = await client
.from('countries')
.eq('name', 'New Zealand')
.select('*')
// Greater than
let { body: countries } = await client
.from('countries')
.gt('id', 20)
.select('*')
// Less than
let { body: countries } = await client
.from('countries')
.lt('id', 20)
.select('*')
// Greater than or equal
let { body: countries } = await client
.from('countries')
.gte('id', 20)
.select('*')
// Less than or equal
let { body: countries } = await client
.from('countries')
.lte('id', 20)
.select('*')
// String search - case sensitive
let { body: countries } = await client
.from('countries')
.like('name', '%Zeal%')
.select('*')
// String search - case insensitive
let { body: countries } = await client
.from('countries')
.ilike('name', '%Zeal%')
.select('*')
// Exact equality (null, true, false)
let { body: countries } = await client
.from('countries')
.is('name', null)
.select('*')
// In list
let { body: countries } = await client
.from('countries')
.in('name', ['China', 'France'])
.select('*')
// Not equal
let { body: countries } = await client
.from('countries')
.not('name', 'China')
.select('*')
You can insert records using insert(). Insert accepts an array of objects so that you can batch insert.
let { status } = await client
.from('messages')
.insert([{ message: 'Hello World 👋'])
You can update records using update().
let { status } = await client
.from('messages')
.eq('message', 'Hello World 👋')
.update({ message: 'Goodbye World 👋' })
You can delete records using delete().
let { status } = await client
.from('messages')
.eq('message', 'Goodbye World 👋')
.delete()
To see details examples of usage, see the Supabase docs:
Release Notes
gren release --override
This will create the changelog and the release.
This repo is liscenced under MIT.
Ready for production! Watch and star this repo to keep updated on releases.
FAQs
Isomorphic PostgREST client
The npm package @supabase/postgrest-js receives a total of 327,648 weekly downloads. As such, @supabase/postgrest-js popularity was classified as popular.
We found that @supabase/postgrest-js demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 12 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team uncovered a malicious Python package typosquatting the popular 'fabric' SSH library, silently exfiltrating AWS credentials from unsuspecting developers.
Security News
At its inaugural meeting, the JSR Working Group outlined plans for an open governance model and a roadmap to enhance JavaScript package management.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.