@vibecode-db/client v3

Playground & Docs

Getting Started3
IntroductionInstallationCreating a Client
Adapters4
Mock AdapterSupabase AdapterPocketBase AdapterREST Adapter
CRUD9
Select All RowsSelect Specific ColumnsSelect Single RowSelect Maybe SingleInsert a RowInsert Multiple RowsUpdate RowsUpsert a RowDelete Rows
Filters10
Equal (eq)Not Equal (neq)Greater Than / Less ThanPattern Match (like)In Array (in)Is NullOR FilterNegated Filter (not)Match Multiple (match)Array Contains
Transforms5
Order AscendingOrder DescendingLimit ResultsRange (Pagination)Combined Query
Auth4
Sign UpSign InGet SessionSign Out
Storage4
Create & List BucketsUpload & DownloadList FilesGet Public URL
Realtime2
Listen for InsertsListen for All Changes
RPC2
Call RPC FunctionRPC with String Result
Sample Expo App4
OverviewFolder StructureArchitectureSwitching Adapters

Creating a Client

createClient(url, key, options)

ParameterTypeDescription
urlstringBackend URL (ignored by MockAdapter)
keystringAPI key (ignored by MockAdapter)
options.adapterDatabaseAdapterThe adapter instance
import { createClient } from '@vibecode-db/client';
import { MockAdapter } from '@vibecode-db/client/adapters/mock';

const client = createClient('', '', {
  adapter: new MockAdapter()
});

Client API

The client exposes the following properties and methods:

APIDescription
client.from(table)Start a query on a table
client.rpc(fn, args)Call a server-side function
client.authAuthentication operations
client.storageFile storage (buckets & files)
client.realtimeRealtime subscriptions
client.channel(name)Shorthand for realtime channel
client.functionsEdge function invocations

Query Builder Chain

All query methods return chainable builders:

const { data, error } = await client
  .from('users')        // returns QueryBuilderSelect
  .select('id, name')   // returns TransformBuilder
  .eq('status', 'active') // returns TransformBuilder (FilterBuilder)
  .order('name')        // returns TransformBuilder
  .limit(10);           // returns TransformBuilder
  // await triggers execution via adapter