ग्राफक्यूएल
Postgres एक्सटेंशन pg_graphql, प्रति प्रोजेक्ट ऑप्ट-इन और डिफ़ॉल्ट रूप से अक्षम। एक बार सक्षम होने पर, यह आपके REST API के समान स्कीमा को उजागर करता है - RLS और भूमिकाओं को बिना किसी अलग GraphQL प्रमाणीकरण के साथ प्राप्त करता है - समर्पित /graphql मार्गों या सामान्य RPC प्रॉक्सी के माध्यम से।
एक ही स्कीमा को क्वेरी करने का दूसरा तरीका, एक अलग सेवा नहीं#
GraphQL सीधे आपके किरायेदार डेटाबेस के अंदर Postgres pg_graphql एक्सटेंशन द्वारा संचालित होता है, जो आपके SQL तालिकाओं, दृश्यों और संबंधों से एक GraphQL स्कीमा उत्पन्न करता है। इसे सक्षम करने से आपके REST API के समान Postgres स्कीमा पर एक दूसरी क्वेरी सतह जुड़ जाती है - जो बिल्कुल समान RLS नीतियों और भूमिकाओं को प्राप्त करती है, बिना किसी अलग GraphQL सर्वर या ऑथ लेयर के।
सभी प्रोजेक्ट के लिए डिफ़ॉल्ट रूप से अक्षम. Aurabase केवल प्रति प्रोजेक्ट स्पष्ट ऑप्ट-इन पर pg_graphql को सक्रिय करता है। पूर्ण क्वेरी, फ़िल्टर, कर्सर पेजिनेशन और म्यूटेशन सिंटैक्स के लिए आधिकारिक pg_graphql डॉक्स देखें।
एक SQL रिज़ॉल्वर /graphql और /rpc/graphql पर प्रदर्शित होता है#
किसी प्रोजेक्ट पर GraphQL को सक्षम करने से pg_graphql इंस्टॉल हो जाता है और एकल लेनदेन में "<project_schema>".graphql(query, variables, operationName, extensions) बन जाता है। प्रोजेक्ट उपडोमेन पर, POST /graphql, POST /graphql/v1, POST /v1/graphql, POST /v1/graphql/v1, और POST /v1/db/{project_id}/graphql (साथ ही POST /v1/db/{project_id}/rpc/graphql) के अनुरोधों को pg_graphql पर रूट किया जाता है और मानक { "data": ..., "errors": ... } GraphQL JSON पेलोड को REST { data, meta } रैपर के बिना सीधे लौटा दिया जाता है।
ACTIVATION ────▶ पोस्ट.../ग्राफ़कल/सक्षम या ऑरा प्रोजेक्ट ग्राफ़क्यूएल-सक्षम
ENQUEUE ────▶ कार्य "graphql_enable" पंक्तिबद्ध (निष्क्रिय, यदि पहले से ही सक्षम है तो नो-ऑप)
DDL ────▶ एक्सटेंशन बनाएं pg_graphql + रैपर फ़ंक्शन + अनुदान, 1 एकल लेनदेन
FLAG ────▶ project.graphql_enabled = सत्य, पूर्ण लेनदेन प्रतिबद्ध होने के बाद ही सेट करें
QUERY ────▶ POST /graphql या /v1/db/{project_id}/graphql (कच्चा GraphQL JSON लौटाता है)
सक्रियण लेनदेन परमाणु है: यदि कोई चरण (एक्सटेंशन, रैपर फ़ंक्शन, या अनुदान) विफल हो जाता है, तो सब कुछ वापस आ जाता है और graphql_enabled false रहता है।
कौन सा सक्रियण सेट होता है#
- स्वचालित रूप से जेनरेट किया गया स्कीमा। pg_graphql आपके Postgres स्कीमा का आत्मनिरीक्षण करता है और प्रत्येक तालिका को रिले ग्राफक्यूएल प्रकार (
<table>Collection,edges,node) के रूप में प्रदर्शित करता है, जिसमें SQLsnake_caseकॉलम डिफ़ॉल्ट रूप सेcamelCaseपर निर्भर होते हैं - हाथ से लिखने के लिए कोई एसडीएल नहीं है। - सुरक्षा आह्वानकर्ता - विरासत में मिला RLS। रैपर फ़ंक्शन कॉलर के विशेषाधिकारों (
aura_anon/aura_authenticated/aura_service_role) के साथ चलता है, जो REST अनुरोधों के समान RLS नीतियों को लागू करता है। - तीन सेटिंग्स जिन्हें आप बदल सकते हैं, परमाणु रूप से लागू।
introspection(डिफ़ॉल्ट रूप से बंद:{ __schema { ... } }कोUnknown field "__schema"के साथ अस्वीकार कर दिया गया है, इसलिए ग्राफीक्यूएल और अपोलो कोडजेन स्कीमा को तब तक नहीं खोज सकते जब तक आप इसे चालू नहीं करते),max_rows(प्रति संग्रह लौटाई गई पंक्तियाँ, 1 से 10000, डिफ़ॉल्ट 1000) औरinflect_names(created_at→createdAt, डिफ़ॉल्ट रूप से चालू)। pg_graphqlCOMMENT ON SCHEMA … @graphql(...)रेसिपी किसी प्रोजेक्ट से काम नहीं करती है (आपकी भूमिका स्कीमा की स्वामी नहीं है, और/rawE'…'शाब्दिक अर्थों को अस्वीकार करती है): इसके बजायaura projects graphql-configयाPATCH …/graphql/configका उपयोग करें, सेटिंग्स को ट्यून करें देखें। - ऑप्ट-इन सक्रियण, निष्क्रिय।
POST .../graphql/enable(कंसोल JWT) याaura projects graphql-enable --wait(CLI) प्रावधान कार्य भेजता है और,--waitके साथ, GraphQL वास्तव में सक्षम होने पर वापस आ जाता है; कभी भी स्वचालित रूप से चालू नहीं हुआ. - सभी Postgres स्तरों पर उपलब्ध है। काम करता है चाहे आपका प्रोजेक्ट किसी संगठन Postgres क्लस्टर या समर्पित एंटरप्राइज क्लस्टर पर चलता हो; मान्य एंड-टू-एंड (एक्सटेंशन, RLS रैपर, वास्तविक क्वेरी)।
- केवल Postgres प्रोजेक्ट। एक MongoDB प्रोजेक्ट सक्रियण से इनकार करता है (
GRAPHQL_UNSUPPORTED_ENGINE)।
सक्रिय करें, फिर क्वेरी करें#
# इडेम्पोटेंट: पहले से सक्षम प्रोजेक्ट पर बार-बार कॉल करना नो-ऑप है।
# --ग्राफक्यूएल वास्तव में सक्षम होने पर प्रतीक्षा करें (सक्रियण एक पृष्ठभूमि कार्य है)।
aura projects graphql-enable <project_id> --wait
सक्रियण अद्यतन प्रोजेक्ट (graphql_enabled: true) के साथ प्रतिक्रिया करता है। कॉलम विभक्ति (created_at → createdAt) पर ध्यान दें: फिल्टर, orderBy, कर्सर पेजिनेशन (first/after), और म्यूटेशन (insertInto<Table>Collection) के लिए आधिकारिक pg_graphql एपीआई संदर्भ देखें।
सेटिंग्स को ट्यून करें: आत्मनिरीक्षण, अधिकतम पंक्तियाँ, नाम विभक्ति#
pg_graphql आपके प्रोजेक्ट की स्कीमा पर एक टिप्पणी से इसकी सेटिंग्स पढ़ता है। केवल स्कीमा स्वामी ही इसे लिख सकता है, इसलिए आपके पूछने पर प्लेटफ़ॉर्म आपके लिए, एक लेनदेन में यह कर देता है। एक परिवर्तन निरर्थक है (जो पहले से ही लागू है उसके बारे में पूछने से कुछ नहीं होता है) और बाध्य है (कुछ भी कतारबद्ध होने से पहले 1-10000 के बाहर max_rows को अस्वीकार कर दिया जाता है)।
# सेटिंग्स को प्रभावी रूप से दिखाएँ
aura projects graphql-config <project_id>
# आत्मनिरीक्षण चालू करें (ग्राफीक्यूएल, ग्राफ़िकल-कोडजेन, अपोलो), इसके लागू होने तक प्रतीक्षा करें
aura projects graphql-config <project_id> --introspection on --wait
# संग्रहों को 100 पंक्तियों पर सीमित करें और SQL नाम वैसे ही रखें जैसे वे हैं
aura projects graphql-config <project_id> --max-rows 100 --inflect-names off --wait
state परिवर्तन के बारे में सच्चाई बताता है: pending जबकि इसे लागू किया जा रहा है (pending_config के साथ), failed यदि यह नहीं हो सका (config में सेटिंग्स अभी भी प्रभावी हैं), applied अन्यथा। GraphQL को पहले सक्षम किया जाना चाहिए (GRAPHQL_NOT_ENABLED अन्यथा), और दूसरा परिवर्तन जबकि एक उत्तर लंबित है GRAPHQL_CONFIG_PENDING: कुछ सेकंड में पुनः प्रयास करें।
introspection चालू होने पर, प्रोजेक्ट की सार्वजनिक कुंजी रखने वाला कोई भी व्यक्ति ग्राफक्यूएल द्वारा उजागर की गई प्रत्येक तालिका और कॉलम को सूचीबद्ध कर सकता है (RLS अभी भी पंक्तियों की सुरक्षा करता है)। यदि आपके स्कीमा का आकार संवेदनशील है तो इसे विकास के लिए चालू करें और उत्पादन के लिए फिर से बंद करें।
ध्यान देने योग्य बिंदु#
डिफ़ॉल्ट रूप से, pg_graphql SQL snake_case नामों को GraphQL camelCase में बदल देता है (created_at createdAt बन जाता है, तालिका blog_posts blogPostsCollection बन जाती है)। DDL में परिवर्तन के बाद, PostgREST अपने स्कीमा कैश को सेकंड के भीतर पुनः लोड करता है ताकि /graphql और /rpc/graphql दोनों अद्यतन फ़ील्ड को प्रदर्शित कर सकें।
आगे जाने के लिए#
- डेटाबेस
Postgres प्रबंधित, एक्सटेंशन सक्षम, RLS - वह स्कीमा जो pg_graphql उजागर करती है।
- Postgres फ़ंक्शन को कॉल करें
सामान्य RPC प्रॉक्सी (/rpc/{function}) जिसका उपयोग GraphQL क्वेरीज़ द्वारा किया जाता है।
- सुरक्षा एवं आरबीएसी
RLS, भूमिकाएँ anon/प्रमाणीकृत/service_role - ग्राफक्यूएल द्वारा विरासत में मिला मॉडल।
- सीएलआई
ऑरा प्रोजेक्ट ग्राफ़िकल-सक्षम और बाकी प्रोजेक्ट कमांड।