इस रेफ़रंस गाइड में, कॉमन एक्सप्रेशन लैंग्वेज (सीईएल) सिंटैक्स के बारे में बताया गया है. इसका इस्तेमाल, @auth(expr:), @check(expr:), और @refresh(onMutationExecuted:) डायरेक्टिव के लिए एक्सप्रेशन बनाने में किया जाता है.
सीईएल के बारे में पूरी जानकारी, सीईएल स्पेसिफ़िकेशन में दी गई है.
क्वेरी और म्यूटेशन में पास किए गए टेस्ट वैरिएबल
@auth(expr) सिंटैक्स की मदद से, क्वेरी और म्यूटेशन से वैरिएबल को ऐक्सेस और टेस्ट किया जा सकता है.
उदाहरण के लिए, vars.status का इस्तेमाल करके, $status जैसे ऑपरेशन वैरिएबल को शामिल किया जा सकता है.
mutation Update($id: UUID!, $status: Any) @auth(expr: "has(vars.status)")
एक्सप्रेशन के लिए उपलब्ध डेटा: request, response, this
डेटा का इस्तेमाल इन कामों के लिए किया जाता है:
@auth(expr:)और@check(expr:)डायरेक्टिव में सीईएल एक्सप्रेशन की मदद से आकलन करना- सर्वर एक्सप्रेशन का इस्तेमाल करके असाइनमेंट,
<field>_expr.
@auth(expr:), @check(expr:), @refresh(onMutationExecuted:) सीईएल एक्सप्रेशन, इनका आकलन कर सकते हैं:
request.operationNamevars(request.variablesका दूसरा नाम)auth(request.authका दूसरा नाम)
म्यूटेशन में, इनके कॉन्टेंट को ऐक्सेस और असाइन किया जा सकता है:
response(कई चरणों वाले लॉजिक में, कुछ नतीजों की जांच करने के लिए)
इसके अलावा, @check(expr:) एक्सप्रेशन इनका आकलन कर सकते हैं:
this(मौजूदा फ़ील्ड की वैल्यू)response(कई चरणों वाले लॉजिक में, कुछ नतीजों की जांच करने के लिए)
@refresh(onMutationExecuted:) एक्सप्रेशन में ये बाइंडिंग होती हैं:
mutation.variablesmutation.auth
request.operationName बाइंडिंग
request.operarationName बाइंडिंग, ऑपरेशन के टाइप को स्टोर करती है. यह क्वेरी या म्यूटेशन हो सकता है.
vars बाइंडिंग (request.vars)
vars बाइंडिंग की मदद से, आपके एक्सप्रेशन आपकी क्वेरी या म्यूटेशन में पास किए गए सभी वैरिएबल को ऐक्सेस कर सकते हैं.
vars.<variablename> का इस्तेमाल, किसी एक्सप्रेशन में पूरी तरह से क्वालिफ़ाइड request.variables.<variablename> के लिए, उपनाम के तौर पर किया जा सकता है:
# The following are equivalent
mutation StringType($v: String!) @auth(expr: "vars.v == 'hello'")
mutation StringType($v: String!) @auth(expr: "request.variables.v == 'hello'")
auth बाइंडिंग (request.auth)
Authentication, आपके डेटा को ऐक्सेस करने का अनुरोध करने वाले उपयोगकर्ताओं की पहचान करता है. साथ ही, उस जानकारी को बाइंडिंग के तौर पर उपलब्ध कराता है, जिसका इस्तेमाल करके एक्सप्रेशन बनाए जा सकते हैं.
अपने फ़िल्टर और एक्सप्रेशन में, auth को request.auth के लिए उपनाम के तौर पर इस्तेमाल किया जा सकता है.
पुष्टि करने की बाइंडिंग में यह जानकारी शामिल होती है:
uid: अनुरोध करने वाले उपयोगकर्ता को असाइन किया गया यूनीक यूज़र आईडी.token: Authentication से इकट्ठा की गई वैल्यू का मैप.
auth.token के कॉन्टेंट के बारे में ज़्यादा जानकारी के लिए, पुष्टि करने वाले टोकन में मौजूद डेटा देखें
response बाइंडिंग
response बाइंडिंग में वह डेटा होता है जिसे सर्वर, किसी क्वेरी या म्यूटेशन के जवाब में इकट्ठा करता है. यह डेटा इकट्ठा होने के दौरान ही बाइंडिंग में शामिल हो जाता है.
जैसे-जैसे कार्रवाई आगे बढ़ती है और हर चरण पूरा होता है, वैसे-वैसे response में, पूरे हो चुके चरणों के रिस्पॉन्स का डेटा शामिल होता जाता है.
response बाइंडिंग को उससे जुड़े ऑपरेशन के आकार के हिसाब से स्ट्रक्चर किया जाता है. इसमें (कई) नेस्ट किए गए फ़ील्ड और (अगर लागू हो) एम्बेड की गई क्वेरी शामिल होती हैं.
ध्यान दें कि एम्बेड की गई क्वेरी के रिस्पॉन्स डेटा को ऐक्सेस करने पर, डेटा फ़ील्ड में किसी भी तरह का डेटा टाइप हो सकता है. यह एम्बेड की गई क्वेरी में अनुरोध किए गए डेटा पर निर्भर करता है. _insert और _delete जैसे म्यूटेशन फ़ील्ड से मिले डेटा को ऐक्सेस करने पर, उनमें यूयूआईडी कुंजियां, मिटाए गए डेटा की संख्या, और शून्य वैल्यू शामिल हो सकती हैं. इसके बारे में ज़्यादा जानने के लिए, म्यूटेशन रेफ़रंस देखें.
उदाहरण के लिए:
- एम्बेड की गई क्वेरी वाले म्यूटेशन में,
responseबाइंडिंग मेंresponse.query.<fieldName>.<fieldName>....पर लुकअप डेटा होता है. इस मामले में,response.query.todoListऔरresponse.query.todoList.priority.
mutation CheckTodoPriority(
$uniqueListName: String!
) {
# This query is identified as `response.query`
query @check(expr: "response.query.todoList.priority == 'high'", message: "This list is not for high priority items!") {
# This field is identified as `response.query.todoList`
todoList(where: { name: $uniqueListName }) {
# This field is identified as `response.query.todoList.priority`
priority
}
}
}
- कई चरणों वाले म्यूटेशन में, जैसे कि कई
_insertफ़ील्ड के साथ,responseबाइंडिंग मेंresponse.<fieldName>.<fieldName>....पर अधूरा डेटा होता है. इस मामले में,response.todoList_insert.id.
mutation CreateTodoListWithFirstItem(
$listName: String!,
$itemContent: String!
) @transaction {
# Step 1
todoList_insert(data: {
id_expr: "uuidV4()",
name: $listName,
})
# Step 2:
todo_insert(data: {
listId_expr: "response.todoList_insert.id" # <-- Grab the newly generated ID from the partial response so far.
content: $itemContent,
})
}
this बाइंडिंग
बाइंडिंग this, उस फ़ील्ड का आकलन करती है जिससे @check डायरेक्टिव अटैच है. सामान्य तौर पर, आपको क्वेरी के ऐसे नतीजों का आकलन करना पड़ सकता है जिनमें सिर्फ़ एक वैल्यू हो.
mutation UpdateMovieTitle (
$movieId: UUID!,
$newTitle: String!)
@auth(level: USER)
@transaction {
# Step 1: Query and check
query @redact {
moviePermission( # Look up a join table called MoviePermission with a compound key.
key: {movieId: $movieId, userId_expr: "auth.uid"}
) {
# Check if the user has the editor role for the movie. `this` is the string value of `role`.
# If the parent moviePermission is null, the @check will also fail automatically.
role @check(expr: "this == 'editor'", message: "You must be an editor of this movie to update title")
}
}
# Step 2: Act
movie_update(id: $movieId, data: {
title: $newTitle
})
}
अगर फ़ील्ड में मौजूद वैल्यू कई बार दिखती है, क्योंकि कोई पैरंट फ़ील्ड एक सूची है, तो हर वैल्यू की जांच की जाती है. इसके लिए, this को हर वैल्यू से जोड़ा जाता है.
किसी पाथ के लिए, अगर कोई पैरंट null या [] है, तो फ़ील्ड तक नहीं पहुंचा जा सकेगा. साथ ही, उस पाथ के लिए सीईएल की जांच को छोड़ दिया जाएगा. दूसरे शब्दों में, आकलन सिर्फ़ तब होता है, जब this, null या नॉन-null हो, लेकिन कभी भी undefined न हो.
जब फ़ील्ड खुद एक सूची या ऑब्जेक्ट होता है, तो this उसी स्ट्रक्चर का पालन करता है (इसमें ऑब्जेक्ट के मामले में चुने गए सभी डिसेंडेंट शामिल होते हैं), जैसा कि नीचे दिए गए उदाहरण में दिखाया गया है.
mutation UpdateMovieTitle2($movieId: UUID!, $newTitle: String!) @auth(level: USER) @transaction {
# Step 1: Query and check
query {
moviePermissions( # Now we query for a list of all matching MoviePermissions.
where: {movieId: {eq: $movieId}, userId: {eq_expr: "auth.uid"}}
# This time we execute the @check on the list, so `this` is the list of objects.
# We can use the `.exists` macro to check if there is at least one matching entry.
) @check(expr: "this.exists(p, p.role == 'editor')", message: "You must be an editor of this movie to update title") {
role
}
}
# Step 2: Act
movie_update(id: $movieId, data: {
title: $newTitle
})
}
जटिल एक्सप्रेशन सिंटैक्स
&& और || ऑपरेटर को मिलाकर, ज़्यादा जटिल एक्सप्रेशन लिखे जा सकते हैं.
mutation UpsertUser($username: String!) @auth(expr: "(auth != null) && (vars.username == 'joe')")
यहां दिए गए सेक्शन में, उपलब्ध सभी ऑपरेटर के बारे में बताया गया है.
ऑपरेटर और ऑपरेटर की प्राथमिकता
ऑपरेटर और उनकी प्राथमिकता के लिए, यहां दी गई टेबल का इस्तेमाल करें.
कोई भी एक्सप्रेशन a और b, फ़ील्ड f, और इंडेक्स i दिया गया है.
| ऑपरेटर | ब्यौरा | असोसिएटिविटी |
|---|---|---|
a[i] a() a.f |
इंडेक्स, कॉल, फ़ील्ड ऐक्सेस | बाएं से दाएं |
!a -a |
यूनरी निगेशन | दाईं से बाईं ओर |
a/b a%b a*b |
गुणा करने वाले ऑपरेटर | बाएं से दाएं |
a+b a-b |
एडिटिव ऑपरेटर | बाएं से दाएं |
a>b a>=b a<b a<=b |
रिलेशनल ऑपरेटर | बाएं से दाएं |
a in b |
सूची या मैप में मौजूद होना | बाएं से दाएं |
type(a) == t |
टाइप की तुलना, जहां t बूल, इंट, फ़्लोट,
नंबर, स्ट्रिंग, सूची, मैप, टाइमस्टैंप या अवधि हो सकती है |
बाएं से दाएं |
a==b a!=b |
कंपैरिज़न ऑपरेटर | बाएं से दाएं |
a && b |
कंडिशनल AND | बाएं से दाएं |
a || b |
कंडिशनल OR | बाएं से दाएं |
a ? true_value : false_value |
टर्नरी एक्सप्रेशन | बाएं से दाएं |
पुष्टि करने वाले टोकन में मौजूद डेटा
auth.token ऑब्जेक्ट में ये वैल्यू शामिल हो सकती हैं:
| फ़ील्ड | ब्यौरा |
|---|---|
email |
खाते से जुड़ा ईमेल पता, अगर मौजूद हो. |
email_verified |
true, अगर उपयोगकर्ता ने पुष्टि की है कि उसके पास email पते का ऐक्सेस है. ईमेल की सेवा देने वाली कुछ कंपनियां, अपने मालिकाना हक वाले ईमेल पतों की पुष्टि अपने-आप कर लेती हैं. |
phone_number |
खाते से जुड़ा फ़ोन नंबर, अगर मौजूद हो. |
name |
उपयोगकर्ता का डिसप्ले नेम, अगर सेट किया गया हो. |
sub |
उपयोगकर्ता का Firebase यूआईडी. यह किसी प्रोजेक्ट में यूनीक होता है. |
firebase.identities |
इस उपयोगकर्ता के खाते से जुड़ी सभी पहचानों की डिक्शनरी. डिक्शनरी की कुंजियां इनमें से कोई भी हो सकती हैं: email, phone, google.com, facebook.com, github.com, twitter.com. डिक्शनरी की वैल्यू, खाते से जुड़े हर आइडेंटिटी प्रोवाइडर के यूनीक आइडेंटिफ़ायर के कलेक्शन होती हैं. उदाहरण के लिए, auth.token.firebase.identities["google.com"][0] में खाते से जुड़ा पहला Google यूज़र आईडी शामिल होता है. |
firebase.sign_in_provider |
इस टोकन को पाने के लिए इस्तेमाल किया गया साइन-इन प्रोवाइडर. इनमें से कोई एक स्ट्रिंग हो सकती है: custom, password, phone, anonymous, google.com, facebook.com, github.com, twitter.com. |
firebase.tenant |
खाते से जुड़ा tenantId, अगर मौजूद हो. उदाहरण के लिए, tenant2-m6tyz |
JWT आईडी टोकन में अतिरिक्त फ़ील्ड
इन auth.token फ़ील्ड को भी ऐक्सेस किया जा सकता है:
| कस्टम टोकन के दावे | ||
|---|---|---|
alg |
एल्गोरिदम | "RS256" |
iss |
जारी करने वाला | आपके प्रोजेक्ट के सेवा खाते का ईमेल पता |
sub |
विषय | आपके प्रोजेक्ट के सेवा खाते का ईमेल पता |
aud |
ऑडियंस | "https://identitytoolkit.googleapis.com/google.identity.identitytoolkit.v1.IdentityToolkit" |
iat |
जारी करने का समय | Unix epoch के बाद से, मौजूदा समय सेकंड में दिखता है |
exp |
समाप्ति समय |
UNIX epoch के बाद से सेकंड में वह समय जब टोकन की समयसीमा खत्म हो जाती है. यह iat के ज़्यादा से ज़्यादा 3,600 सेकंड बाद हो सकता है.
ध्यान दें: इससे सिर्फ़ यह कंट्रोल किया जाता है कि कस्टम टोकन की समयसीमा कब खत्म होगी. हालांकि, signInWithCustomToken() का इस्तेमाल करके किसी उपयोगकर्ता को साइन इन कराने के बाद, वह डिवाइस में तब तक साइन इन रहेगा, जब तक उसका सेशन अमान्य नहीं हो जाता या वह साइन आउट नहीं कर देता.
|
<claims> (ज़रूरी नहीं) |
टोकन में शामिल करने के लिए, पसंद के मुताबिक बनाए गए वैकल्पिक दावे. इन्हें एक्सप्रेशन में auth.token (या request.auth.token) की मदद से ऐक्सेस किया जा सकता है. उदाहरण के लिए, अगर आपने कस्टम क्लेम
adminClaim बनाया है, तो उसे
auth.token.adminClaim से ऐक्सेस किया जा सकता है.
|
|