जावास्क्रिप्ट एसडीके के साथ अपने डेटाबेस को क्वेरी करें
aura.db का रोजमर्रा का प्रवाह, असुरक्षित कॉल को अस्वीकार करने वाले नियम, और पंक्ति-स्तरीय सुरक्षा के साथ तालिका की सुरक्षा कैसे करें।
पंक्तियाँ पढ़ें#
const { data, error } = await aura
.from('todos')
.select('id, title, done')
.eq('done', false)
.order('created_at', { ascending: false })
.limit(20)
aura.from('todos') इस दस्तावेज़ में उपयोग किया जाने वाला फ़ॉर्म है (यह aura.db.from('todos'), वही कॉल का शॉर्टकट है)। प्रत्येक कॉल { data, error } लौटाती है और कभी फेंकती नहीं है, क्लाइंट विकल्प और त्रुटियां देखें।
फ़िल्टर श्रृंखला: eq, neq, gt, gte, lt, lte, like, ilike, in, is, और डेटाबेस संदर्भ में सूचीबद्ध अन्य। पंक्तियों के एक पृष्ठ के लिए, range(from, to) का उपयोग करें।
सम्मिलित करें, अद्यतन करें और हटाएँ#
// एक पंक्ति, या पंक्तियों की एक श्रृंखला सम्मिलित करें, और उन्हें वापस प्राप्त करें
const { data } = await aura.from('todos').insert({ title: 'Write the docs' }).select()
// अपसर्ट
await aura.from('todos').upsert({ id, title: 'Renamed' }).select()
// अपडेट और डिलीट के लिए एक फिल्टर की जरूरत है
await aura.from('todos').update({ done: true }).eq('id', id)
await aura.from('todos').delete().eq('id', id)
जब तक आप .select() को श्रृंखलाबद्ध नहीं करते, तब तक लिखने से कुछ नहीं मिलता (data null है) : 10,000 पंक्तियाँ सम्मिलित करने से 10,000 पंक्तियाँ वापस नहीं आतीं। .select() के साथ पंक्तियाँ वापस आती हैं, और कोई PATCH या POST जो किसी भी पंक्ति से मेल नहीं खाता है, meta.hint में क्यों बताता है।
दो नियम आपको गलतियों से बचाते हैं:
- एक बैच इंसर्ट के लिए प्रत्येक पंक्ति में समान कुंजियों की आवश्यकता होती है। विभिन्न कुंजियों वाली पंक्तियाँ
All object keys must matchके साथ400लौटाती हैं। लुप्त कुंजियों कोnullसे भरें। - बिना फ़िल्टर वाले
update()औरdelete()को किसी भी अनुरोध को भेजने से पहले त्रुटि कोडUNFILTERED_MUTATIONके साथ क्लाइंट द्वारा अस्वीकार कर दिया जाता है। प्रत्येक पंक्ति को जानबूझकर बदलने के लिए, सर्वर से SQL चलाएँ।
एक पंक्ति, अनेक पंक्तियाँ, मायने रखती हैं#
// बिल्कुल एक पंक्ति: यदि कोई नहीं या अनेक हैं तो त्रुटि
const one = await aura.from('todos').select('*').eq('id', id).single()
// → त्रुटि.स्थिति 406 जब फ़िल्टर शून्य या कई पंक्तियों से मेल खाता है
// शून्य या एक पंक्ति: जब कुछ भी मेल नहीं खाता तो डेटा शून्य होता है
const maybe = await aura.from('todos').select('*').eq('id', id).maybeSingle()
// पंक्तियाँ और उनका कुल
const page = await aura.from('todos').select('*', { count: 'exact' }).range(0, 9)
// पेज.काउंट कुल है, चाहे सीमा कुछ भी हो
// केवल कुल, कोई पंक्तियाँ नहीं
const { count } = await aura.from('todos').select('*', { count: 'exact', head: true })
count: 'exact' प्रत्येक मिलान पंक्ति को गिनता है। 'planned' और 'estimated' बहुत बड़ी तालिकाओं पर तेज़ और अनुमानित हैं।
एक मेज को सुरक्षित रखें#
Aurabase (db.sql(), माइग्रेशन, स्टूडियो, या टेबल एपीआई) के माध्यम से बनाई गई तालिकाएँ स्वचालित रूप से ENABLE और FORCE ROW LEVEL SECURITY प्राप्त करती हैं (जब तक कि आप अपने DDL बैच में DISABLE ROW LEVEL SECURITY को स्पष्ट रूप से शामिल नहीं करते हैं)। अभी तक कोई नीति नहीं होने के कारण, anon और authenticated कॉल करने वालों को [] दिखाई देता है। प्रत्यक्ष Postgres कनेक्शन के माध्यम से बनाई गई तालिकाओं को स्पष्ट रूप से enable row level security की आवश्यकता होती है। आपको आवश्यक नीतियां जोड़ें:
create policy todos_own_read on todos
for select to aura_authenticated
using (auth.uid() = owner);
कैनोनिकल डेटाबेस भूमिकाएँ aura_anon, aura_authenticated और aura_service_role हैं (समूह उपनाम anon, authenticated, service_role उन्हें प्रबंधित क्लस्टर पर भी मैप करते हैं)। auth.uid() सार्वजनिक कुंजी के लिए NULL है और साइन-इन किए गए उपयोगकर्ता के लिए एक उपयोगकर्ता आईडी है। पंक्ति-स्तरीय सुरक्षा देखें।
service_role कुंजी डिज़ाइन द्वारा RLS को बायपास करती है: इसे अपने सर्वर पर रखें।
एसक्यूएल फ़ंक्शंस और आरपीसी#
किसी सर्वर से एक फ़ंक्शन बनाएं, फिर उसे rpc() से कहीं से भी कॉल करें:
await admin.db.createFunction({
name: 'add',
args: [
{ name: 'a', data_type: 'int', mode: 'IN' },
{ name: 'b', data_type: 'int', mode: 'IN' },
],
returns: 'int',
language: 'sql',
body: 'SELECT a + b',
grant_execute_to: ['anon', 'authenticated'],
})
const { data } = await aura.rpc('add', { a: 1, b: 2 }) // → 3
- इसे कॉल करने के लिए
grant_execute_toआवश्यक है। इसके बिना कोई भी फ़ंक्शन निष्पादित नहीं कर सकता। जो भूमिका सूचीबद्ध नहीं है उसे403 permission denied for functionमिलता है।authenticatedऔरaura_authenticatedदोनों स्वीकार किए जाते हैं। यह आपके द्वाराdb.sql()के साथ बनाए गए कार्यों या इस परिवर्तन के बाद बनाई गई परियोजनाओं पर माइग्रेशन पर भी लागू होता है (PUBLICका डिफ़ॉल्टEXECUTEविशेषाधिकार रद्द कर दिया जाता है):grant execute on function hello(text) to aura_authenticated;को स्वयं जोड़ें। - एक नया फ़ंक्शन कुछ सेकंड के बाद कॉल करने योग्य होता है। जब तक एपीआई अपनी स्कीमा को पुनः लोड नहीं करता,
rpc()404 Could not find the functionलौटाता है। - SQL के माध्यम से कार्य (
db.sql()):CREATE FUNCTION/CREATE OR REPLACE FUNCTIONकोSECURITY INVOKERमोड (डिफ़ॉल्ट) में अनुमति है;SECURITY DEFINERको/rawपर अस्वीकार कर दिया गया है और इसेcreateFunction(POST /v1/db/{project_id}/functions) या स्पष्टgrant_execute_toके साथ CLI/माइग्रेशन के माध्यम से बनाया जाना चाहिए।
किसी सर्वर से SQL चलाएँ#
import { createAdminClient } from '@aurabase/aurabase-js'
const admin = createAdminClient(process.env.NEXT_PUBLIC_AURABASE_URL!, process.env.AURABASE_SERVICE_ROLE_KEY!)
await admin.db.sql(`
create table if not exists todos (
id uuid primary key default gen_random_uuid(),
title text not null,
done boolean not null default false,
owner uuid,
created_at timestamptz not null default now()
)
`)
db.sql() को service_role कुंजी की आवश्यकता है। यह WHERE के बिना DELETE को अस्वीकार कर देता है, और यह pg_class या pg_roles जैसे सिस्टम कैटलॉग को नहीं पढ़ता है। अपनी तालिकाओं को सूचीबद्ध करने के लिए, admin.db.schema() का उपयोग करें।
पृष्ठांकन, पंक्ति कैप और सटीक संख्याएँ
- एक रीड अधिकतम 1,000 पंक्तियाँ लौटाता है - डिफ़ॉल्ट और हार्ड सीलिंग, जो भी
limit()याrange()आप मांगते हैं। जब अधिक पंक्तियाँ मेल खाती हैं तोmeta.has_moretrueहै;meta.totalपाने के लिएcount: 'exact'मांगें। - पेज को कीसेट पेजिनेशन के साथ एक बड़ी तालिका के माध्यम से, जिसकी लागत दस लाखवें पेज पर समान है:
aura.from('events').select('id,label').limit(1000).after('id', lastId)(यह.order('id').gt('id', lastId)है)।.cursor()केवल MongoDB है;offsetआप जितना गहराई में जाते हैं, उतना धीमा होता जाता है। - जावास्क्रिप्ट के 2^53 से अधिक संख्याएँ। 9,007,199,254,740,991 से ऊपर का
bigintJS नंबर के रूप में पार्स किए जाने पर अपने अंतिम अंक खो देता है: उन मानों को स्ट्रिंग के रूप में प्राप्त करने के लिए{ parseBigIntAsString: true }के साथ क्लाइंट बनाएं। एकnumericको JSON नंबर के रूप में लौटाया जाता है जब यह बिल्कुल प्रतिनिधित्व योग्य होता है, और अन्यथा एक सटीक दशमलव स्ट्रिंग के रूप में (लंबे मान जैसे12345678901234567890.123456789)। count: 'planned'और'estimated'केवल अनुमान हैं। वे PostgreSQL के आँकड़ों से आते हैं, जो अभी लोड की गई मेज पर खाली हैं (60-पंक्ति तालिका 430 की रिपोर्ट कर सकती है)। जब संख्या मायने रखती है तोcount: 'exact'का प्रयोग करें।- एक
vectorकॉलम एक स्ट्रिंग जैसे"[0.1,0.2,0.3]"के रूप में वापस आता है:number[]प्राप्त करने के लिए इसेJSON.parseके साथ पार्स करें। - एक दृश्य आपके विशेषाधिकारों के साथ पढ़ता है। आपके द्वारा बनाए गए दृश्य (SQL, माइग्रेशन) को
security_invoker = trueमिलते हैं, इसलिए अंतर्निहित तालिकाओं की नीतियां पाठक पर लागू होती हैं।with (security_invoker = false)को स्पष्ट रूप से केवल तभी लिखें यदि आप वास्तव में चाहते हैं कि दृश्य RLS को बायपास कर दे। db.sql()Retry-Afterविलंब के बाद429को पुनः प्रयास करता है (अस्वीकृत अनुरोध कभी नहीं चलता)।/rawप्रति प्रोजेक्ट सीमित है; थोक भार के लिए एक सरणी के साथ टाइप किए गएinsert()का उपयोग करें।