Dashboard

Client cheat sheet

One-page map of the voltbase-js surface.

Surface

index.ts
import { createClient } from 'voltbase-js';

const vb = createClient(projectUrl, apiKey);

// Database
vb.from('t').select('*').eq('id', id).order('c', 'desc').limit(10)
vb.from('t').insert({  })
vb.from('t').eq('id', id).update({  })
vb.from('t').eq('id', id).delete()
vb.rpc('fn', { arg: 1 })
vb.rpc('match_documents', { query_embedding, match_threshold, match_count })

// Auth
vb.auth.signUp / signIn / sendMagicLink
vb.auth.signInWithGoogle / signInWithGithub
vb.auth.resendVerification / resetPasswordForEmail / updatePassword
vb.auth.getSession / setSession / getUser / getAccessToken / signOut
vb.auth.onAuthStateChange(cb)

// Storage
vb.storage.listBuckets / createBucket / deleteBucket
vb.storage.from('b').list / upload / remove / getSignedUrl

// Realtime
vb.realtime.subscribe(table, cb, { event?, filter? })
vb.realtime.channel(topic).on().subscribe() / send / track