त्वरित शुरुआत
शून्य से क्वेरी योग्य एपीआई तक: समर्पित Postgres डेटाबेस, पंक्ति-स्तरीय सुरक्षा, रीयलटाइम और TypeScript प्रकार की पीढ़ी शामिल - कोई क्रेडिट कार्ड की आवश्यकता नहीं है।
आपके कोडिंग एजेंट के लिए प्रॉम्प्ट
Set up Aurabase in this app by following this page: https://aurabase.cloud/en/docs/getting-started.md
Documentation: read https://aurabase.cloud/llms.txt first. Every docs page is also available as Markdown: add .md to its URL, for example (the same works for every page): https://aurabase.cloud/en/docs/getting-started.md
Client: install @aurabase/aurabase-js and create the client with createClient(NEXT_PUBLIC_AURABASE_URL, NEXT_PUBLIC_AURABASE_ANON_KEY). Keep AURABASE_SERVICE_ROLE_KEY on the server: never put it in client code.
Project access: to read the schema and run SQL, start the Aurabase MCP server over stdio (82 tools with a project key):
npx -y -p @aurabase/mcp-server aurabase-mcp --url https://<slug>.aurabase.cloud --project-id <project-id> --service-role-key aura_sk_…
The project id is in Studio › Settings › General. The service role key is shown once when the project is created; regenerate it in Studio › Settings › Connection if you lost it.त्वरित शुरुआत#
एसडीके स्थापित करें, क्लाइंट बनाएं और अपनी पहली पंक्तियां पढ़ें।
1. एसडीके स्थापित करें#
अपने प्रोजेक्ट में SDK जोड़ें. Rust टैब aurabase क्रेट स्थापित करता है; कर्ल टैब जांचता है कि आपका प्रोजेक्ट यूआरएल प्रतिक्रिया देता है या नहीं।
pnpm add @aurabase/aurabase-js
2. क्लाइंट बनाएं#
स्टूडियो › सेटिंग्स › कनेक्शन दोनों में अपने प्रोजेक्ट यूआरएल और एनॉन कुंजी के साथ क्लाइंट बनाएं। सेवा भूमिका कुंजी को सर्वर पर रखें.
import { createClient } from '@aurabase/aurabase-js'
const aura = createClient(
process.env.NEXT_PUBLIC_AURABASE_URL!,
process.env.NEXT_PUBLIC_AURABASE_ANON_KEY!,
)
3. डेटाबेस को क्वेरी करें#
todos से 10 पंक्तियों तक पढ़ें। तालिका नीचे "एक तालिका बनाएं" अनुभाग में बनाई गई है; जब तक यह मौजूद है, error सेट है।
// `todos` नीचे "एक तालिका बनाएं" में बनाया गया है
const { data, error } = await aura
.from('todos')
.select('id, title, done')
.limit(10)
console.log(data, error)
आवश्यक शर्तें#
हम मानते हैं कि Node.js ≥ 20 स्थापित है और एक POSIX टर्मिनल सीमा के भीतर है। किसी स्थानीय डेटाबेस की आवश्यकता नहीं है: Aurabase प्रत्येक प्रोजेक्ट के लिए एक समर्पित Postgres डेटाबेस का प्रावधान करता है।
क्या आप Supabase या Firebase से आ रहे हैं? अधिकांश अवधारणाएँ ट्रांसपोज़ेबल हैं। माइग्रेशन गाइड देखें।
एसडीके स्थापित करना#
आधिकारिक एसडीके सीआरयूडी, ऑथ, रियलटाइम और स्टोरेज के लिए टाइप किए गए क्लाइंट को उजागर करता है। यह Next.js, React, Node, bun या Deno में उसी तरह काम करता है।
# अनुशंसित
pnpm add @aurabase/aurabase-js
पैकेज नाम में @aurabase/ स्कोप शामिल है। बिना स्कोप के पैकेज aurabase-js का रखरखाव Aurabase द्वारा नहीं किया जाता है: इसे इंस्टॉल न करें।
SDK में स्वचालित सत्र कुकी प्रबंधन और एंटी-ट्रंकेशन चंकिंग के साथ Next.js (ऐप राउटर, सर्वर एक्शन, मिडलवेयर), रीमिक्स, Nuxt और SvelteKit के लिए सीधे @aurabase/aurabase-js/ssr (createServerClient) निर्यात शामिल है।
एक प्रोजेक्ट बनाएं#
स्टूडियो से एक प्रोजेक्ट बनाएं. जब यह सक्रिय हो जाता है, तो स्टूडियो रेडी-टू-यूज़ .env.local के साथ कॉपी योर कीज़ नाउ पैनल दिखाता है (इसे कॉपी करें या डाउनलोड करें): service_role कुंजी वहां एक बार दिखाई देती है, उसके बाद केवल इसका हैश रखा जाता है। सेटिंग्स › कनेक्शन बाद में प्रोजेक्ट यूआरएल और सार्वजनिक एनॉन कुंजी दिखाता है; यदि आपने service_role कुंजी खो दी है, तो इसे वहां पुन: उत्पन्न करें (पिछला कुंजी रद्द कर दी गई है)। NEXT_PUBLIC_AURABASE_URL और NEXT_PUBLIC_AURABASE_ANON_KEY को ग्राहक पक्ष पर प्रकाशित किया जा सकता है; AURABASE_SERVICE_ROLE_KEY सर्वर साइड पर सख्ती से रहता है।
NEXT_PUBLIC_AURABASE_URL=https://<slug>.aurabase.cloud
NEXT_PUBLIC_AURABASE_ANON_KEY=aura_anon_…
AURABASE_SERVICE_ROLE_KEY=aura_sk_…
| योजना | पहुँच | रोकना |
|---|---|---|
project_{uuid} | आप | आपकी एप्लिकेशन तालिकाएँ |
project_{uuid}_auth | प्रणाली | users, sessions, oauth_accounts, mfa |
project_{uuid}_storage | प्रणाली | buckets, objects, rls_policies |
project_{uuid}_platform | प्रणाली | functions, jobs, cron_jobs, api_keys |
पूरा पथ CLI से भी काम करता है (इंस्टॉलेशन के लिए CLI देखें): aura projects create प्रोजेक्ट तैयार होने तक प्रतीक्षा करता है और URL और कुंजियों को एक बार प्रिंट करता है।
aura login
aura projects create todos-app --json > project.json # प्रोजेक्ट सक्रिय होने तक प्रतीक्षा करता है
aura link --project-id "$(jq -r .id project.json)"
export NEXT_PUBLIC_AURABASE_URL="$(jq -r .url project.json)"
export AURABASE_SERVICE_ROLE_KEY="$(jq -r .service_role_key project.json)"
aura db raw "create table todos (id bigint generated always as identity primary key, title text not null, done boolean not null default false, user_id uuid not null default auth.uid(), created_at timestamptz not null default now())"
aura db raw "create policy todos_own_read on todos for select to aura_authenticated using (auth.uid() = user_id)"
aura db raw "create policy todos_own_insert on todos for insert to aura_authenticated with check (auth.uid() = user_id)"
aura db table realtime todos on
aura db raw "select count(*) from todos" --as authenticated --user <a user id> # देखें कि वह उपयोगकर्ता क्या देखता है
क्लाइंट बंडल में कभी भी AURABASE_SERVICE_ROLE_KEY शामिल न करें। यह सभी RLS नीतियों को बायपास करता है, और एपीआई इसे ब्राउज़र (401 SECRET_KEY_IN_BROWSER) से अस्वीकार कर देता है। इसे सर्वर कॉल (रूट हैंडलर, सर्वर एक्शन, जॉब्स) के लिए आरक्षित करें।
एक तालिका बनाएं#
स्टूडियो में डेटाबेस खोलें, SQL एडिटर (टेबल पैनल के नीचे स्थित लिंक) पर क्लिक करें और इस स्क्रिप्ट को चलाएं। प्रत्येक तालिका पर पंक्ति-स्तरीय सुरक्षा सक्षम है: पहली दो नीतियां प्रत्येक साइन-इन उपयोगकर्ता को पढ़ने और अपनी पंक्तियां बनाने देती हैं, तीसरी एक उदाहरण है जो आगंतुकों को तालिका पढ़ने देती है ताकि आप साइन इन किए बिना अपनी पहली पंक्तियां देख सकें। नीतियां aura_authenticated भूमिका को लक्षित करती हैं (aura_anon आगंतुकों के लिए)।
create table todos (
id bigint generated always as identity primary key,
title text not null,
done boolean not null default false,
user_id uuid not null default auth.uid(),
created_at timestamptz not null default now()
);
create policy "todos_own_read" on todos for select to aura_authenticated using (auth.uid() = user_id);
create policy "todos_own_insert" on todos for insert to aura_authenticated with check (auth.uid() = user_id);
-- केवल उदाहरण: कोई भी आगंतुक प्रत्येक कार्य को पढ़ सकता है। उत्पादन से पहले इसे छोड़ें:
-- कार्य पर नीति "todos_public_read" छोड़ें;
create policy "todos_public_read" on todos for select to aura_anon using (true);
फिर अपने स्कीमा के TypeScript प्रकार उत्पन्न करें (कमांड .env.local पढ़ता है):
npx @aurabase/gen --out lib/aurabase.types.ts
पहला बुलावा#
पर्यावरण चर से कुंजियाँ पढ़कर एक पुन: प्रयोज्य Aurabase क्लाइंट बनाएं, फिर अपनी पहली तालिका को क्वेरी करें। नीचे दिए गए पथ आपके ऐप के रूट से संबंधित हैं: यदि आपका प्रोजेक्ट src/ निर्देशिका का उपयोग करता है, तो इसके अंदर lib/, components/ और app/ डालें, ताकि @/ आयात उपनाम हल हो जाए।
import { createClient } from '@aurabase/aurabase-js'
import type { Database } from './aurabase.types'
export const aura = createClient<Database>(
process.env.NEXT_PUBLIC_AURABASE_URL!,
process.env.NEXT_PUBLIC_AURABASE_ANON_KEY!,
)
फिर, रूट हैंडलर या सर्वर घटक में:
import { aura } from '@/lib/aurabase'
export async function GET() {
const { data, error } = await aura
.from('todos')
.select('id, title, done')
.order('created_at', { ascending: false })
.limit(10)
if (error) throw error
return Response.json(data)
}
This returns the rows of the table, including without a signed-in user, thanks to the example policy todos_public_read. Without it (once you dropped it, as you should before production) a visitor gets []: the other policies only open rows to aura_authenticated, so sign a user in first with aura.auth.signInWithPassword({ email, password }) (see Ready-made sign-in pages for Next.js). Regenerate the Database types with npx @aurabase/gen after each schema change.
पहली पंक्ति सम्मिलित करने के लिए, एक उपयोगकर्ता को साइन अप और इन करें, फिर सम्मिलित करें। user_id कॉलम डिफ़ॉल्ट रूप से auth.uid() होता है:
import { aura } from '../lib/aurabase'
async function main() {
const email = 'you@example.com'
const password = 'a-strong-password'
await aura.auth.signUp({ email, password })
await aura.auth.signInWithPassword({ email, password })
const { data, error } = await aura.from('todos').insert({ title: 'First todo' }).select()
console.log(data, error)
}
main().catch((err) => {
console.error(err)
process.exit(1)
})
इसे tsx के साथ चलाएं, जो एक्सटेंशन रहित आयात का समाधान करता है और .env.local पढ़ता है:
pnpm add -D tsx
pnpm approve-builds # पीएनपीएम 10+: ईएसबिल्ड की इंस्टॉल स्क्रिप्ट की अनुमति दें, फिर चलाएं:
pnpm exec tsx --env-file=.env.local scripts/first-row.ts
NPM 11 या बाद के संस्करण के साथ, npx tsx ''आपने किसी अन्य प्लेटफ़ॉर्म के लिए esbuild स्थापित किया है'' के साथ विफल हो जाता है क्योंकि esbuild की इंस्टॉल स्क्रिप्ट डिफ़ॉल्ट रूप से अवरुद्ध है। ऊपर बताए अनुसार pnpm का उपयोग करें, या tsx को छोड़ें और दो आयातों को उनके एक्सटेंशन ('../lib/aurabase.ts', './aurabase.types.ts'): node --env-file=.env.local --experimental-strip-types scripts/first-row.ts के साथ लिखने के बाद नोड के अंतर्निहित प्रकार स्ट्रिपिंग (नोड 22.6+) के साथ स्क्रिप्ट चलाएं।
आपके प्रोजेक्ट के उपयोगकर्ताओं के लिए, signUp के बाद signInWithPassword तुरंत काम करता है: जब तक आप इसे स्टूडियो › प्रमाणीकरण › कॉन्फ़िगरेशन में चालू नहीं करते हैं, तब तक ईमेल पुष्टिकरण से तक बंद रहता है (इसे एक मेल सर्वर की आवश्यकता होती है)। फिर कोई भी किसी भी पते से साइन अप कर सकता है, इसलिए उत्पादन से पहले इसे चालू करें।
service_role कुंजी में कोई साइन-इन उपयोगकर्ता नहीं है, इसलिए auth.uid() NULL है और डिफ़ॉल्ट पर निर्भर एक इंसर्ट NOT_NULL_VIOLATION के साथ विफल हो जाता है। सर्वर से, user_id को स्पष्ट रूप से पास करें।
रीयलटाइम कनेक्ट करें#
तीन ऑटो-नेगोशिएटेड ट्रांसपोर्ट: वेबसॉकेट, एसएसई, NATS। ग्राहक नेटवर्क के आधार पर सर्वश्रेष्ठ को चुनता है - किसी कॉन्फ़िगरेशन की आवश्यकता नहीं है।
सीएलआई के साथ एक बार टेबल पर रीयलटाइम सक्षम करें:
aura db table realtime todos on
या किसी सर्वर से HTTP API के साथ (.env.local से मान):
curl -X PUT "$NEXT_PUBLIC_AURABASE_URL/v1/db/schema/tables/todos/realtime" \
-H "apikey: $AURABASE_SERVICE_ROLE_KEY" \
-H "Content-Type: application/json" \
-d '{"enabled": true}'
फिर परिवर्तनों की सदस्यता लें। एक साइन-इन उपयोगकर्ता को वे पंक्तियाँ प्राप्त होती हैं जो उसकी RLS नीतियां उसे पढ़ने देती हैं, जिसमें साइन-इन से पहले चैनल खोला गया था (यह स्वचालित रूप से पुन: प्रमाणित होता है); अस्वीकृत सदस्यता कारण सहित CHANNEL_ERROR रिपोर्ट करती है।
'use client'
import { aura } from '@/lib/aurabase'
import { useEffect } from 'react'
export function LiveTodos() {
useEffect(() => {
const channel = aura.realtime
.channel('todos')
.on('postgres_changes', { event: '*', schema: 'public', table: 'todos' }, (change) =>
console.log(change.eventType, change.new),
)
.subscribe((status, err) => {
// विकास में रिएक्ट स्ट्रिक्टमोड घटक को माउंट, अनमाउंट और पुनः माउंट करता है:
// पहला CLOSED उस सफ़ाई से आता है और अपेक्षित है।
if (status === 'SUBSCRIBED') console.log('realtime connected')
if (status === 'CHANNEL_ERROR') console.error('realtime refused:', err?.message)
})
return () => {
void channel.unsubscribe()
}
}, [])
return null
}
सदस्यताएँ एकल टीसीपी कनेक्शन पर बहुसंकेतन होती हैं। जितनी आपको आवश्यकता हो उतने खोलें - शून्य अतिरिक्त नेटवर्क लागत।