کتابخانه‌ی استاندارد · پایگاه داده

اپن سرچ `db/opensearch`

کارخواه OpenSearch: سند، دسته‌ای، زبان پرسمان، تجمیع، پیمایش و نقطه‌ی زمانی، مدیریت نمایه، SQL و PPL، جستجوی برداری k-NN، سیاست ISM، امنیت و امضای AWS.

واردسازی دیتابیس.اپن سرچ

در این صفحه

گونه‌ها
پایاها و متغیرها
تابع‌ها

اپن سرچ یک موتور جستجو و تحلیل متن‌باز است. این بسته مستقیم و بدون هیچ کتابخانه‌ی بیرونی، با net.tcp و tls با API آن کار می‌کند: چند گره با تلاش دوباره و کنار گذاشتن گره از کار افتاده، احراز هویت پایه، توکن حامل و امضای AWS SigV4 (برای Amazon OpenSearch Service و Serverless) و TLS با پرونده‌ی CA خودتان یا، برای سرور آزمایشی، بدون وارسی گواهی. روی این‌ها سند، دسته‌ای، پرسمان‌ها و تجمیع‌های رایج، صفحه‌بندی با پیمایش و نقطه‌ی زمانی، مدیریت نمایه، نام مستعار، الگو و جریان داده، مدیریت خوشه، کار، تصویر لحظه‌ای و خط لوله را پوشش می‌دهد و افزونه‌هایی که اپن سرچ را اپن سرچ می‌کنند: SQL و PPL، جستجوی k-NN و عصبی، خط لوله‌ی جستجوی ترکیبی، سیاست‌های ISM، افزونه‌ی امنیت، پایشگرهای هشدار و ML Commons.

پرسمان‌ها، تجمیع‌ها و بدنه‌ی درخواست‌ها متن ساده‌ی JSON هستند: سازنده‌هایی مثل تطبیق، پرسمان منطقی ساخته و تجمیع واژه‌ها آن را برمی‌گردانند و هر چه را پوشش نمی‌دهند می‌شود با رشته‌ی بک‌تیک نوشت. نتیجه‌ها ساختارهای سلام هستند و بخش‌های JSON آن‌ها (منبع یک یافته، تجمیع‌ها) متن خام‌اند که با سطل‌ها، مقدار تجمیع و مسیر جیسون خوانده می‌شوند. هر فراخوانی وضعیت و خطای خود را روی کارخواه ثبت می‌کند؛ پس از فراخوانی‌ای که نادرست برگرداند خطا یا نوع خطا را بخوانید. اتصال عمومی کارخواه را به شکل اتصال دیتابیس درمی‌آورد تا کد SQL نوشته‌شده برای موتورهای دیگر از اپن سرچ هم پرسمان کند. برای مسیری که تابع جداگانه ندارد انجام را به کار ببرید. فقط نمونه‌های سازنده‌های پرسمان و امضای درخواست این‌جا اجرا می‌شوند؛ بقیه به سرور نیاز دارند و فقط بررسی می‌شوند.

الستیک سرچ هم با API پایه‌ی اپن سرچ کار می‌کند. هر جا به چیزی نیاز دارید که فقط اپن سرچ دارد این بسته را به کار ببرید: PPL، جستجوی k-NN، عصبی و ترکیبی، ISM، افزونه‌ی امنیت، هشدار، ML Commons یا امضای AWS SigV4 برای Amazon OpenSearch Service و Serverless.

گونه‌ها

پرسمان منطقی `BoolQuery`

ساختار پرسمان منطقی

چهار فهرست بند و گزینه‌های یک پرسمان منطقی، برای پرسمان منطقی ساخته.

نام	انگلیسی	گونه	توضیح
must	`must`	`وکتور<رشته>`	باید تطبیق بخورد و به امتیاز می‌افزاید.
filter	`filter`	`وکتور<رشته>`	باید تطبیق بخورد ولی امتیاز نمی‌دهد؛ در حافظه‌ی نهان می‌ماند.
should	`should`	`وکتور<رشته>`	بهتر است تطبیق بخورد؛ امتیاز را بالا می‌برد.
must_not	`must_not`	`وکتور<رشته>`	نباید تطبیق بخورد.
minimum_should_match	`minimum_should_match`	`رشته = ""`	چند بند should باید تطبیق بخورند، مثل `1` یا `75%`.
boost	`boost`	`اعشار۶۴ = 0`	امتیاز را چند برابر می‌کند؛ ۰ آن را کنار می‌گذارد.

db-opensearch-Query.salam

واردسازی دیتابیس.اپن سرچ

تابع list(a: رشته، b: رشته): وکتور<رشته>:
    ناپایا v := وکتور {} برگردان وکتور<رشته>
    v.بیفزا(a)
    اگر b.طول() بزرگتر 0: v.بیفزا(b) پایان
    برگشت v
پایان

تابع ریشه:
    سرچاپ اپن سرچ.تطبیق همه()، اپن سرچ.تطبیق هیچ()
    سرچاپ اپن سرچ.تطبیق("title"، "salam")، اپن سرچ.تطبیق همه واژه‌ها("title"، "salam world")
    سرچاپ اپن سرچ.تطبیق تقریبی("title"، "slam")، اپن سرچ.تطبیق عبارت("title"، "hello world")
    سرچاپ اپن سرچ.تطبیق عبارت با فاصله("title"، "hello world"، 2)، اپن سرچ.تطبیق پیشوند عبارت("title"، "sal")
    سرچاپ اپن سرچ.تطبیق پیشوند منطقی("title"، "quick bro")
    سرچاپ اپن سرچ.تطبیق چندگانه("salam"، list("title^2"، "body"))، اپن سرچ.تطبیق چندگانه نوع‌دار("salam"، list("title"، "body")، "phrase")
    سرچاپ اپن سرچ.واژه("tag"، "news")، اپن سرچ.واژه عددی("year"، 1403)، اپن سرچ.واژه منطقی("published"، درست)
    سرچاپ اپن سرچ.واژه بدون حساسیت حروف("tag"، "News")، اپن سرچ.واژه‌ها("tag"، list("news"، "sport"))
    ناپایا years := وکتور {} برگردان وکتور<صحیح۶۴>
    years.بیفزا(1402)
    years.بیفزا(1403)
    سرچاپ اپن سرچ.واژه‌های عددی("year"، years)، اپن سرچ.واژه‌های ارجاعی("tag"، "users"، "7"، "follows")
    سرچاپ اپن سرچ.مجموعه واژه‌ها("skills"، list("go"، "salam")، "required")
    سرچاپ اپن سرچ.بازه("date"، "2026-01-01"، "2026-12-31")، اپن سرچ.بازه باز("price"، "10"، "20")
    سرچاپ اپن سرچ.بازه عددی("price"، 9.5، 20.0)، اپن سرچ.بازه صحیح("stock"، 1، 100)، اپن سرچ.بازه با عملگر("price"، "lt"، "5")
    سرچاپ اپن سرچ.بازه تاریخ("at"، "now-7d/d"، "now"، ""، "+03:30")
    سرچاپ اپن سرچ.وجود فیلد("email")، اپن سرچ.پیشوند("sku"، "AB-")، اپن سرچ.نویسه عام("sku"، "AB-*-9")
    سرچاپ اپن سرچ.عبارت باقاعده("sku"، "AB-[0-9]+")، اپن سرچ.تقریبی("name"، "maryem")، اپن سرچ.شناسه‌ها(list("1"، "2"))
    سرچاپ اپن سرچ.رشته پرسمان("title:salam AND year:1403")
    سرچاپ اپن سرچ.رشته پرسمان در فیلدها("salam world"، list("title"، "body")، "AND")
    سرچاپ اپن سرچ.رشته پرسمان ساده("salam -draft"، list("title"، ""))

    ناپایا b := اپن سرچ.پرسمان منطقی { minimum_should_match = "1"، boost = 1.5 }
    b.must.بیفزا(اپن سرچ.تطبیق("title"، "salam"))
    b.filter.بیفزا(اپن سرچ.واژه("status"، "published"))
    b.should.بیفزا(اپن سرچ.واژه("tag"، "featured"))
    b.must_not.بیفزا(اپن سرچ.واژه("tag"، "spam"))
    سرچاپ اپن سرچ.پرسمان منطقی ساخته(b)
    سرچاپ اپن سرچ.منطقی(list(اپن سرچ.تطبیق("t"، "x")، "")، list(اپن سرچ.واژه("a"، "1")، "")، وکتور {} برگردان وکتور<رشته>، وکتور {} برگردان وکتور<رشته>)
    سرچاپ اپن سرچ.همه شرط‌ها(list(اپن سرچ.واژه("a"، "1")، اپن سرچ.واژه("b"، "2")))
    سرچاپ اپن سرچ.یکی از شرط‌ها(list(اپن سرچ.واژه("a"، "1")، اپن سرچ.واژه("b"، "2")))، اپن سرچ.نقیض(اپن سرچ.واژه("a"، "1"))
    سرچاپ اپن سرچ.پالایش شده(اپن سرچ.تطبیق("t"، "x")، list(اپن سرچ.واژه("a"، "1")، ""))
    سرچاپ اپن سرچ.امتیاز ثابت(اپن سرچ.واژه("tag"، "news")، 1.2)
    سرچاپ اپن سرچ.بیشینه جداگانه(list(اپن سرچ.تطبیق("title"، "x")، اپن سرچ.تطبیق("body"، "x"))، 0.3)
    سرچاپ اپن سرچ.تقویت(اپن سرچ.تطبیق("t"، "apple")، اپن سرچ.تطبیق("t"، "pie")، 0.5)
    سرچاپ اپن سرچ.تودرتو("comments"، اپن سرچ.تطبیق("comments.text"، "great"))
    سرچاپ اپن سرچ.دارای فرزند("answer"، اپن سرچ.تطبیق همه())، اپن سرچ.دارای والد("question"، اپن سرچ.تطبیق همه())
    سرچاپ اپن سرچ.مشابه(list("title"، "body")، "search engines in Salam")
    سرچاپ اپن سرچ.پرسمان اسکریپت("doc['stock'].value > params.min"، `{"min":5}`)
    سرچاپ اپن سرچ.امتیاز اسکریپتی(اپن سرچ.تطبیق همه()، "_score * doc['rank'].value"، "")
    سرچاپ اپن سرچ.امتیاز تابعی(اپن سرچ.تطبیق("t"، "x")، list(اپن سرچ.ضریب مقدار فیلد("likes"، 1.2، "log1p")، "")، "sum"، "multiply")
    سرچاپ اپن سرچ.فاصله جغرافیایی("location"، 35.69، 51.39، "5km")
    سرچاپ اپن سرچ.کادر جغرافیایی("location"، 36.0، 51.0، 35.5، 51.8)

    ناپایا v := وکتور {} برگردان وکتور<اعشار۶۴>
    v.بیفزا(0.12)
    v.بیفزا(-0.5)
    v.بیفزا(0.9)
    سرچاپ اپن سرچ.نزدیک‌ترین همسایه‌ها("embedding"، v، 10)، اپن سرچ.بردار همسایه‌یابی(v)
    سرچاپ اپن سرچ.نزدیک‌ترین همسایه‌های پالایش شده("embedding"، v، 10، اپن سرچ.واژه("lang"، "fa"))
    سرچاپ اپن سرچ.همسایه‌های شعاعی("embedding"، v، 0.5)، اپن سرچ.همسایه‌ها با کمینه امتیاز("embedding"، v، 0.8)
    سرچاپ اپن سرچ.عصبی("embedding"، "a cosy cafe"، "model-1"، 5)، اپن سرچ.عصبی پراکنده("tokens"، "a cosy cafe"، "model-2")
    سرچاپ اپن سرچ.ترکیبی(list(اپن سرچ.تطبیق("text"، "cafe")، اپن سرچ.عصبی("embedding"، "cafe"، "model-1"، 5)))

    سرچاپ اپن سرچ.مرتب صعودی("price")، اپن سرچ.مرتب نزولی("date")، اپن سرچ.مرتب‌سازی امتیازی()
    سرچاپ اپن سرچ.مرتب‌سازی مکانی("location"، 35.69، 51.39، "km")
    سرچاپ اپن سرچ.برجسته‌سازی(list("title"، "body"))، اپن سرچ.برجسته‌سازی با برچسب(list("title"، "")، "<mark>"، "</mark>")
    سرچاپ اپن سرچ.ادغام فیلدی("author")، اپن سرچ.پیشنهاد واژه("fix"، "salm"، "title")
    سرچاپ اپن سرچ.پیشنهاد تکمیل("auto"، "sal"، "title.suggest"، 5)

    ناپایا aggs := اپن سرچ.افزودن تجمیع("{}"، "tags"، اپن سرچ.تجمیع واژه‌ها("tag"، 10))
    aggs = اپن سرچ.افزودن تجمیع(aggs، "avg_price"، اپن سرچ.تجمیع میانگین("price"))
    aggs = اپن سرچ.افزودن تجمیع(aggs، "total"، اپن سرچ.تجمیع جمع("price"))
    aggs = اپن سرچ.افزودن تجمیع(aggs، "cheapest"، اپن سرچ.تجمیع کمینه("price"))
    aggs = اپن سرچ.افزودن تجمیع(aggs، "dearest"، اپن سرچ.تجمیع بیشینه("price"))
    aggs = اپن سرچ.افزودن تجمیع(aggs، "priced"، اپن سرچ.تجمیع شمار مقدار("price"))
    aggs = اپن سرچ.افزودن تجمیع(aggs، "authors"، اپن سرچ.تجمیع یکتاها("author"))
    سرچاپ aggs
    ناپایا pcts := وکتور {} برگردان وکتور<اعشار۶۴>
    pcts.بیفزا(50.0)
    pcts.بیفزا(99.0)
    سرچاپ اپن سرچ.تجمیع آمار("price")، اپن سرچ.تجمیع آمار گسترده("price")، اپن سرچ.تجمیع صدک‌ها("ms"، pcts)
    سرچاپ اپن سرچ.تجمیع هیستوگرام("price"، 10.0)، اپن سرچ.تجمیع بازه("price"، pcts)
    monthly := اپن سرچ.زیرتجمیع‌ها(اپن سرچ.تجمیع هیستوگرام تاریخ("date"، "month")، اپن سرچ.افزودن تجمیع("{}"، "sales"، اپن سرچ.تجمیع جمع("price")))
    سرچاپ monthly
    سرچاپ اپن سرچ.تجمیع پالایه(اپن سرچ.واژه("tag"، "news"))، اپن سرچ.تجمیع تودرتو("comments")، اپن سرچ.تجمیع گمشده‌ها("price")
    سرچاپ اپن سرچ.تجمیع برترین یافته‌ها(3)، اپن سرچ.تجمیع ترکیبی(list("tag"، "author")، 100)
    سرچاپ اپن سرچ.افزودن عضو(`{"size":0}`، "aggs"، aggs)

    ناپایا req := اپن سرچ.درخواست جستجو { query = اپن سرچ.پرسمان منطقی ساخته(b)، from = 0، size = 20، track_total_hits = "true" }
    req.sort.بیفزا(اپن سرچ.مرتب نزولی("date"))
    req.source.بیفزا("title")
    req.source_excludes.بیفزا("body")
    req.fields.بیفزا("date")
    req.docvalue_fields.بیفزا("price")
    req.aggs = aggs
    req.highlight = اپن سرچ.برجسته‌سازی(list("title"، ""))
    req.post_filter = اپن سرچ.واژه("color"، "red")
    req.collapse = اپن سرچ.ادغام فیلدی("author")
    req.suggest = اپن سرچ.پیشنهاد واژه("fix"، "salm"، "title")
    req.rescore = `{"window_size":50,"query":{"rescore_query":{"match_phrase":{"title":"salam"}}}}`
    req.script_fields = `{"double":{"script":{"source":"doc['price'].value * 2"}}}`
    req.search_after = `[1700000000000]`
    req.track_scores = درست
    req.min_score = "0.1"
    req.timeout = "2s"
    req.explain = نادرست
    req.version = درست
    req.seq_no_primary_term = درست
    req.ext = `{"rag":{"llm_question":"why"}}`
    req.extra.بیفزا(`"profile":false`)
    سرچاپ اپن سرچ.بدنه جستجو(req)
    سرچاپ اپن سرچ.بدنه جستجو(اپن سرچ.درخواست جستجو { query = اپن سرچ.تطبیق همه()، pit_id = "PIT"، pit_keep_alive = "1m"، no_source = درست })
پایان

خروجی{"match_all":{}} {"match_none":{}} {"match":{"title":"salam"}} {"match":{"title":{"query":"salam world","operator":"and"}}} {"match":{"title":{"query":"slam","fuzziness":"AUTO"}}} {"match_phrase":{"title":"hello world"}} {"match_phrase":{"title":{"query":"hello world","slop":2}}} {"match_phrase_prefix":{"title":"sal"}} {"match_bool_prefix":{"title":"quick bro"}} {"multi_match":{"query":"salam","fields":["title^2","body"]}} {"multi_match":{"query":"salam","fields":["title","body"],"type":"phrase"}} {"term":{"tag":"news"}} {"term":{"year":1403}} {"term":{"published":true}} {"term":{"tag":{"value":"News","case_insensitive":true}}} {"terms":{"tag":["news","sport"]}} {"terms":{"year":[1402,1403]}} {"terms":{"tag":{"index":"users","id":"7","path":"follows"}}} {"terms_set":{"skills":{"terms":["go","salam"],"minimum_should_match_field":"required"}}} {"range":{"date":{"gte":"2026-01-01","lte":"2026-12-31"}}} {"range":{"price":{"gt":"10","lt":"20"}}} {"range":{"price":{"gte":9.5,"lte":20}}} {"range":{"stock":{"gte":1,"lte":100}}} {"range":{"price":{"lt":"5"}}} {"range":{"at":{"gte":"now-7d/d","lte":"now","time_zone":"+03:30"}}} {"exists":{"field":"email"}} {"prefix":{"sku":"AB-"}} {"wildcard":{"sku":"AB-*-9"}} {"regexp":{"sku":"AB-[0-9]+"}} {"fuzzy":{"name":"maryem"}} {"ids":{"values":["1","2"]}} {"query_string":{"query":"title:salam AND year:1403"}} {"query_string":{"query":"salam world","fields":["title","body"],"default_operator":"AND"}} {"simple_query_string":{"query":"salam -draft","fields":["title"]}} {"bool":{"must":[{"match":{"title":"salam"}}],"filter":[{"term":{"status":"published"}}],"should":[{"term":{"tag":"featured"}}],"must_not":[{"term":{"tag":"spam"}}],"minimum_should_match":"1","boost":1.5}} {"bool":{"must":[{"match":{"t":"x"}}],"filter":[{"term":{"a":"1"}}]}} {"bool":{"must":[{"term":{"a":"1"}},{"term":{"b":"2"}}]}} {"bool":{"should":[{"term":{"a":"1"}},{"term":{"b":"2"}}],"minimum_should_match":"1"}} {"bool":{"must_not":[{"term":{"a":"1"}}]}} {"bool":{"must":[{"match":{"t":"x"}}],"filter":[{"term":{"a":"1"}}]}} {"constant_score":{"filter":{"term":{"tag":"news"}},"boost":1.2}} {"dis_max":{"queries":[{"match":{"title":"x"}},{"match":{"body":"x"}}],"tie_breaker":0.3}} {"boosting":{"positive":{"match":{"t":"apple"}},"negative":{"match":{"t":"pie"}},"negative_boost":0.5}} {"nested":{"path":"comments","query":{"match":{"comments.text":"great"}}}} {"has_child":{"type":"answer","query":{"match_all":{}}}} {"has_parent":{"parent_type":"question","query":{"match_all":{}}}} {"more_like_this":{"fields":["title","body"],"like":"search engines in Salam","min_term_freq":1,"min_doc_freq":1}} {"script":{"script":{"source":"doc['stock'].value > params.min","lang":"painless","params":{"min":5}}}} {"script_score":{"query":{"match_all":{}},"script":{"source":"_score * doc['rank'].value","lang":"painless"}}} {"function_score":{"query":{"match":{"t":"x"}},"functions":[{"field_value_factor":{"field":"likes","factor":1.2,"modifier":"log1p","missing":1}}],"score_mode":"sum","boost_mode":"multiply"}} {"geo_distance":{"distance":"5km","location":{"lat":35.69,"lon":51.39}}} {"geo_bounding_box":{"location":{"top_left":{"lat":36,"lon":51},"bottom_right":{"lat":35.5,"lon":51.8}}}} {"knn":{"embedding":{"vector":[0.12,-0.5,0.9],"k":10}}} [0.12,-0.5,0.9] {"knn":{"embedding":{"vector":[0.12,-0.5,0.9],"k":10,"filter":{"term":{"lang":"fa"}}}}} {"knn":{"embedding":{"vector":[0.12,-0.5,0.9],"max_distance":0.5}}} {"knn":{"embedding":{"vector":[0.12,-0.5,0.9],"min_score":0.8}}} {"neural":{"embedding":{"query_text":"a cosy cafe","model_id":"model-1","k":5}}} {"neural_sparse":{"tokens":{"query_text":"a cosy cafe","model_id":"model-2"}}} {"hybrid":{"queries":[{"match":{"text":"cafe"}},{"neural":{"embedding":{"query_text":"cafe","model_id":"model-1","k":5}}}]}} {"price":{"order":"asc"}} {"date":{"order":"desc"}} "_score" {"_geo_distance":{"location":{"lat":35.69,"lon":51.39},"order":"asc","unit":"km"}} {"fields":{"title":{},"body":{}}} {"pre_tags":["<mark>"],"post_tags":["</mark>"],"fields":{"title":{}}} {"field":"author"} {"fix":{"text":"salm","term":{"field":"title"}}} {"auto":{"prefix":"sal","completion":{"field":"title.suggest","size":5}}} {"tags":{"terms":{"field":"tag","size":10}},"avg_price":{"avg":{"field":"price"}},"total":{"sum":{"field":"price"}},"cheapest":{"min":{"field":"price"}},"dearest":{"max":{"field":"price"}},"priced":{"value_count":{"field":"price"}},"authors":{"cardinality":{"field":"author"}}} {"stats":{"field":"price"}} {"extended_stats":{"field":"price"}} {"percentiles":{"field":"ms","percents":[50,99]}} {"histogram":{"field":"price","interval":10}} {"range":{"field":"price","ranges":[{"to":50},{"from":50,"to":99},{"from":99}]}} {"date_histogram":{"field":"date","calendar_interval":"month"},"aggs":{"sales":{"sum":{"field":"price"}}}} {"filter":{"term":{"tag":"news"}}} {"nested":{"path":"comments"}} {"missing":{"field":"price"}} {"top_hits":{"size":3}} {"composite":{"size":100,"sources":[{"tag":{"terms":{"field":"tag"}}},{"author":{"terms":{"field":"author"}}}]}} {"size":0,"aggs":{"tags":{"terms":{"field":"tag","size":10}},"avg_price":{"avg":{"field":"price"}},"total":{"sum":{"field":"price"}},"cheapest":{"min":{"field":"price"}},"dearest":{"max":{"field":"price"}},"priced":{"value_count":{"field":"price"}},"authors":{"cardinality":{"field":"author"}}}} {"query":{"bool":{"must":[{"match":{"title":"salam"}}],"filter":[{"term":{"status":"published"}}],"should":[{"term":{"tag":"featured"}}],"must_not":[{"term":{"tag":"spam"}}],"minimum_should_match":"1","boost":1.5}},"from":0,"size":20,"sort":[{"date":{"order":"desc"}}],"_source":{"includes":["title"],"excludes":["body"]},"fields":["date"],"docvalue_fields":["price"],"aggs":{"tags":{"terms":{"field":"tag","size":10}},"avg_price":{"avg":{"field":"price"}},"total":{"sum":{"field":"price"}},"cheapest":{"min":{"field":"price"}},"dearest":{"max":{"field":"price"}},"priced":{"value_count":{"field":"price"}},"authors":{"cardinality":{"field":"author"}}},"highlight":{"fields":{"title":{}}},"post_filter":{"term":{"color":"red"}},"collapse":{"field":"author"},"suggest":{"fix":{"text":"salm","term":{"field":"title"}}},"rescore":{"window_size":50,"query":{"rescore_query":{"match_phrase":{"title":"salam"}}}},"script_fields":{"double":{"script":{"source":"doc['price'].value * 2"}}},"search_after":[1700000000000],"track_total_hits":true,"track_scores":true,"min_score":0.1,"timeout":"2s","version":true,"seq_no_primary_term":true,"ext":{"rag":{"llm_question":"why"}},"profile":false} {"query":{"match_all":{}},"_source":false,"pit":{"id":"PIT","keep_alive":"1m"}}

پارامترهای جستجو `SearchParams`

ساختار پارامترهای جستجو

تنظیماتی که در نشانی یک جستجو فرستاده می‌شوند. رشته‌های خالی کنار گذاشته می‌شوند.

نام	انگلیسی	گونه	توضیح
routing	`routing`	`رشته = ""`	فقط شاردهای این مقدار مسیریابی جستجو شوند.
preference	`preference`	`رشته = ""`	کدام نسخه‌های شارد ترجیح داده شوند، مثل `_local`.
search_pipeline	`search_pipeline`	`رشته = ""`	یک خط لوله‌ی جستجو برای اجرا، مثل خط لوله‌ی جستجوی ترکیبی.
search_type	`search_type`	`رشته = ""`	`query_then_fetch` یا `dfs_query_then_fetch`.
scroll	`scroll`	`رشته = ""`	پیمایش این مدت باز بماند.
request_cache	`request_cache`	`رشته = ""`	`true` یا `false`: حافظه‌ی نهان درخواست به کار رود.
allow_partial_search_results	`allow_partial_search_results`	`رشته = ""`	`false` وقتی شاردی شکست بخورد جستجو را ناموفق می‌کند.
ignore_unavailable	`ignore_unavailable`	`منطقی = نادرست`	نمایه‌های نبوده یا بسته را رد کن.

db-opensearch-Search.salam

واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    c := اپن سرچ.اتصال("http://localhost:9200")
    ناپایا req := اپن سرچ.درخواست جستجو { query = اپن سرچ.تطبیق("title"، "kings")، size = 10 }
    req.sort.بیفزا(اپن سرچ.مرتب نزولی("year"))
    req.aggs = اپن سرچ.افزودن تجمیع(اپن سرچ.افزودن تجمیع("{}"، "by_tag"، اپن سرچ.تجمیع واژه‌ها("tag"، 5))، "avg_year"، اپن سرچ.تجمیع میانگین("year"))
    req.aggs = اپن سرچ.افزودن تجمیع(req.aggs، "stats"، اپن سرچ.تجمیع آمار("year"))
    req.suggest = اپن سرچ.پیشنهاد واژه("fix"، "kngs"، "title")
    r := اپن سرچ.جستجو با درخواست(c، "books"، req)
    سرچاپ r.ok، r.status، r.took، r.timed_out، r.total، r.total_relation، r.max_score، r.error
    هر h در r.hits:
        سرچاپ h.index، h.id، h.score، h.source، h.sort، h.highlight، h.fields، h.inner_hits، h.matched_queries، h.raw.طول()
    پایان
    هر bk در اپن سرچ.سطل‌ها(r.aggregations، "by_tag"):
        سرچاپ bk.key، bk.key_as_string، bk.doc_count، bk.raw.طول()
    پایان
    سرچاپ اپن سرچ.مقدار تجمیع(r.aggregations، "avg_year")، اپن سرچ.فیلد تجمیع(r.aggregations، "stats"، "max")
    سرچاپ اپن سرچ.تجمیع خام(r.aggregations، "stats")، اپن سرچ.پیشنهادها(r.suggest، "fix")
    سرچاپ اپن سرچ.جستجو(c، "books,articles"، اپن سرچ.تطبیق همه()).total
    سرچاپ اپن سرچ.جستجوی خام(c، "books"، `{"query":{"match_all":{}},"size":1}`).hits.طول()
    p := اپن سرچ.پارامترهای جستجو {
        routing = "poetry"، preference = "_local"، search_pipeline = "rerank"، search_type = "dfs_query_then_fetch"،
        request_cache = "true"، allow_partial_search_results = "false"، ignore_unavailable = درست
    }
    سرچاپ اپن سرچ.جستجو با پارامتر(c، "books"، `{"size":0}`، p).total، p.scroll.طول()
    parsed := اپن سرچ.تجزیه جستجو(r.raw)
    سرچاپ parsed.hits.طول()، parsed.scroll_id، parsed.pit_id

    ناپایا page := اپن سرچ.جستجوی پیمایشی(c، "books"، اپن سرچ.درخواست جستجو { query = اپن سرچ.تطبیق همه()، size = 500 }، "1m")
    ناپایا seen := 0
    تا page.hits.طول() بزرگتر 0:
        seen += page.hits.طول()
        page = اپن سرچ.پیمایش(c، page.scroll_id، "1m")
    پایان
    سرچاپ seen، اپن سرچ.پاک‌سازی پیمایش(c، page.scroll_id)

    pit := اپن سرچ.ایجاد نقطه زمانی(c، "books"، "2m")
    ناپایا preq := اپن سرچ.درخواست جستجو { query = اپن سرچ.تطبیق همه()، size = 100، pit_id = pit، pit_keep_alive = "2m" }
    preq.sort.بیفزا(اپن سرچ.مرتب صعودی("year"))
    ناپایا pp := اپن سرچ.جستجو با درخواست(c، ""، preq)
    تا pp.hits.طول() بزرگتر 0:
        preq.search_after = pp.hits.بگیر(pp.hits.طول() - 1).sort
        pp = اپن سرچ.جستجو با درخواست(c، ""، preq)
    پایان
    سرچاپ اپن سرچ.فهرست نقطه‌های زمانی(c)، اپن سرچ.حذف نقطه زمانی(c، pit)، اپن سرچ.حذف همه نقطه‌های زمانی(c)

    ناپایا bodies := وکتور {} برگردان وکتور<رشته>
    bodies.بیفزا(`{"query":{"term":{"tag":"poetry"}},"size":0}`)
    bodies.بیفزا(`{"query":{"match_all":{}},"size":0}`)
    هر one در اپن سرچ.جستجوی چندگانه(c، "books"، bodies):
        سرچاپ one.ok، one.total
    پایان
    سرچاپ اپن سرچ.جستجوی الگو(c، "books"، "by_tag"، `{"tag":"poetry"}`).total
    سرچاپ اپن سرچ.جستجوی الگوی درون‌خطی(c، "books"، `{"query":{"term":{"tag":"{{t}}"}}}`، `{"t":"poetry"}`).total
    سرچاپ اپن سرچ.نمایش الگو(c، `{"query":{"term":{"tag":"{{t}}"}}}`، `{"t":"poetry"}`)
    سرچاپ اپن سرچ.توضیح امتیاز(c، "books"، "1"، اپن سرچ.تطبیق("title"، "kings"))
    سرچاپ اپن سرچ.اعتبارسنجی پرسمان(c، "books"، اپن سرچ.تطبیق("title"، "kings"))
    ناپایا fields := وکتور {} برگردان وکتور<رشته>
    fields.بیفزا("title")
    سرچاپ اپن سرچ.توانایی فیلدها(c، "books"، fields)
    سرچاپ اپن سرچ.مسیر جیسون(r.raw، "hits.hits.0._source.title")، اپن سرچ.مسیر خام جیسون(r.raw، "hits.total")
    سرچاپ اپن سرچ.اقلام جیسون(`[1,"two",{"three":3}]`).طول()
پایان

اطلاعات کار `TaskInfo`

ساختار اطلاعات کار

یک کار پس‌زمینه.

نام	انگلیسی	گونه	توضیح
ok	`ok`	`منطقی = نادرست`	درخواست موفق بود و کار شکست نخورد.
id	`id`	`رشته = ""`	شناسه‌ی کار، `node:number`.
completed	`completed`	`منطقی = نادرست`	پایان یافته است.
action	`action`	`رشته = ""`	چه کاری می‌کند، مثل `indices:data/write/reindex`.
description	`description`	`رشته = ""`	یک توضیح.
status	`status`	`رشته = ""`	پیشرفت آن به شکل JSON خام.
response	`response`	`رشته = ""`	نتیجه‌ی آن به شکل JSON خام، پس از پایان.
error	`error`	`رشته = ""`	چه چیزی خراب شد.

db-opensearch-ClusterHealth.salam

واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    c := اپن سرچ.اتصال("http://localhost:9200")
    h := اپن سرچ.سلامت خوشه(c)
    سرچاپ h.ok، h.cluster_name، h.status، h.timed_out، h.nodes، h.data_nodes، h.active_primary_shards
    سرچاپ h.active_shards، h.relocating_shards، h.initializing_shards، h.unassigned_shards، h.pending_tasks، h.active_shards_percent
    سرچاپ اپن سرچ.انتظار وضعیت(c، "books"، "yellow"، "30s").status
    سرچاپ اپن سرچ.آمار خوشه(c).طول() بزرگتر 0، اپن سرچ.حالت خوشه(c، "metadata").طول() بزرگتر 0
    سرچاپ اپن سرچ.تنظیم تنظیمات خوشه(c، `{"cluster.routing.allocation.enable":"all"}`، "")
    سرچاپ اپن سرچ.دریافت تنظیمات خوشه(c)
    سرچاپ اپن سرچ.توضیح تخصیص(c، `{"index":"books","shard":0,"primary":true}`).طول()
    سرچاپ اپن سرچ.اطلاعات گره‌ها(c، "os").طول() بزرگتر 0، اپن سرچ.آمار گره‌ها(c، "jvm").طول() بزرگتر 0، اپن سرچ.نخ‌های پرکار(c).طول() بزرگتر 0
    هر row در اپن سرچ.فهرست(c، "shards?h=index,shard,state"):
        سرچاپ row
    پایان
    سرچاپ اپن سرچ.فهرست متنی(c، "nodes")، اپن سرچ.افزونه‌ها(c)، اپن سرچ.دارای افزونه(c، "opensearch-knn")

    rx := اپن سرچ.نمایه‌سازی دوباره با بدنه(c، `{"source":{"index":"books"},"dest":{"index":"books_v4"}}`، نادرست)
    t := اپن سرچ.دریافت کار(c، rx.task)
    سرچاپ t.ok، t.id، t.completed، t.action، t.description، t.status، t.response، t.error
    سرچاپ اپن سرچ.انتظار کار(c، rx.task، "60s").completed، اپن سرچ.لغو کار(c، rx.task)
    سرچاپ اپن سرچ.فهرست کارها(c، "*reindex").طول() بزرگتر 0

    سرچاپ اپن سرچ.تنظیم مخزن(c، "backups"، "fs"، `{"location":"/mnt/backups"}`)، اپن سرچ.وارسی مخزن(c، "backups")
    سرچاپ اپن سرچ.دریافت مخزن(c، "backups")، اپن سرچ.ایجاد تصویر لحظه‌ای(c، "backups"، "nightly-1"، "books"، درست)
    سرچاپ اپن سرچ.تصویرهای لحظه‌ای(c، "backups")، اپن سرچ.دریافت تصویر لحظه‌ای(c، "backups"، "nightly-1").طول() بزرگتر 0
    سرچاپ اپن سرچ.وضعیت تصویر لحظه‌ای(c، "backups"، "nightly-1").طول() بزرگتر 0
    سرچاپ اپن سرچ.بازیابی تصویر لحظه‌ای(c، "backups"، "nightly-1"، `{"indices":"books","rename_pattern":"(.+)","rename_replacement":"restored_$1"}`، درست)
    سرچاپ اپن سرچ.حذف تصویر لحظه‌ای(c، "backups"، "nightly-1")، اپن سرچ.حذف مخزن(c، "backups")

    ناپایا procs := وکتور {} برگردان وکتور<رشته>
    procs.بیفزا(اپن سرچ.پردازنده("lowercase"، `{"field":"tag"}`))
    procs.بیفزا(اپن سرچ.پردازنده("set"، `{"field":"seen","value":true}`))
    سرچاپ اپن سرچ.تنظیم خط لوله(c، "clean"، اپن سرچ.خط لوله("tidy incoming books"، procs))
    ناپایا docs := وکتور {} برگردان وکتور<رشته>
    docs.بیفزا(`{"tag":"POETRY"}`)
    سرچاپ اپن سرچ.شبیه‌سازی خط لوله(c، "clean"، docs)، اپن سرچ.دریافت خط لوله(c، "clean").طول() بزرگتر 0
    سرچاپ اپن سرچ.حذف خط لوله(c، "clean")

    سرچاپ اپن سرچ.تنظیم اسکریپت(c، "double"، "doc['stock'].value * 2")، اپن سرچ.دریافت اسکریپت(c، "double")
    سرچاپ اپن سرچ.تنظیم الگوی جستجو(c، "by_tag"، `{"query":{"term":{"tag":"{{tag}}"}}}`)، اپن سرچ.حذف اسکریپت(c، "by_tag")، اپن سرچ.حذف اسکریپت(c، "double")
پایان

اطلاعات احراز `AuthInfo`

ساختار اطلاعات احراز

افزونه‌ی امنیت می‌گوید شما کیستید.

نام	انگلیسی	گونه	توضیح
ok	`ok`	`منطقی = نادرست`	درخواست موفق بود.
user	`user`	`رشته = ""`	نام کاربر.
roles	`roles`	`وکتور<رشته>`	نقش‌های امنیتی.
backend_roles	`backend_roles`	`وکتور<رشته>`	نقش‌های پشتیبان.
tenants	`tenants`	`وکتور<رشته>`	مستاجرهایی که کاربر می‌تواند به کار ببرد.
error	`error`	`رشته = ""`	چه چیزی خراب شد.

db-opensearch-PutPolicy.salam

واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    c := اپن سرچ.اتصال بدون وارسی گواهی("https://localhost:9200"، "admin"، "S3cret-pass!")
    ناپایا patterns := وکتور {} برگردان وکتور<رشته>
    patterns.بیفزا("logs-*")
    سرچاپ اپن سرچ.تنظیم سیاست(c، "logs-30d"، اپن سرچ.سیاست حذف پس از("drop old logs"، "30d"، patterns))
    سرچاپ اپن سرچ.دریافت سیاست(c، "logs-30d").طول() بزرگتر 0
    سرچاپ اپن سرچ.به‌روزرسانی سیاست(c، "logs-30d"، اپن سرچ.سیاست حذف پس از("drop old logs"، "60d"، patterns)، 0 برگردان صحیح۶۴، 1 برگردان صحیح۶۴)
    سرچاپ اپن سرچ.افزودن سیاست(c، "logs-000001"، "logs-30d")، اپن سرچ.شناسه سیاست نمایه(c، "logs-000001")
    سرچاپ اپن سرچ.تغییر سیاست(c، "logs-000001"، "logs-30d"، "hot")، اپن سرچ.تلاش دوباره سیاست(c، "logs-000001")
    سرچاپ اپن سرچ.توضیح سیاست(c، "logs-000001")، اپن سرچ.برداشتن سیاست(c، "logs-000001")، اپن سرچ.حذف سیاست(c، "logs-30d")

    me := اپن سرچ.من کیستم(c)
    سرچاپ me.ok، me.user، me.roles، me.backend_roles، me.tenants، me.error
    سرچاپ اپن سرچ.سلامت امنیت(c)
    ناپایا perms := وکتور {} برگردان وکتور<رشته>
    perms.بیفزا("cluster_monitor")
    ناپایا actions := وکتور {} برگردان وکتور<رشته>
    actions.بیفزا("read")
    سرچاپ اپن سرچ.تنظیم نقش(c، "logs_reader"، اپن سرچ.بدنه نقش(perms، patterns، actions))، اپن سرچ.دریافت نقش(c، "logs_reader")
    سرچاپ اپن سرچ.تنظیم کاربر(c، "maryam"، "Strong-Pass-1!"، وکتور {} برگردان وکتور<رشته>، `{"team":"ops"}`)، اپن سرچ.دریافت کاربر(c، "maryam")
    ناپایا users := وکتور {} برگردان وکتور<رشته>
    users.بیفزا("maryam")
    سرچاپ اپن سرچ.تنظیم نگاشت نقش(c، "logs_reader"، users، وکتور {} برگردان وکتور<رشته>)، اپن سرچ.دریافت نگاشت نقش(c، "logs_reader")
    سرچاپ اپن سرچ.کاربران(c)، اپن سرچ.تغییر گذرواژه(c، "S3cret-pass!"، "N3w-secret-pass!")
    سرچاپ اپن سرچ.حذف نگاشت نقش(c، "logs_reader")، اپن سرچ.حذف کاربر(c، "maryam")، اپن سرچ.حذف نقش(c، "logs_reader")

    monitor := `{"type":"monitor","name":"errors","enabled":true,"schedule":{"period":{"interval":5,"unit":"MINUTES"}},"inputs":[{"search":{"indices":["logs-*"],"query":{"size":0,"query":{"match":{"level":"error"}}}}}],"triggers":[]}`
    id := اپن سرچ.ایجاد پایشگر(c، monitor)
    سرچاپ id، اپن سرچ.دریافت پایشگر(c، id).طول() بزرگتر 0، اپن سرچ.به‌روزرسانی پایشگر(c، id، monitor)
    سرچاپ اپن سرچ.اجرای پایشگر(c، id، درست).طول() بزرگتر 0، اپن سرچ.جستجوی پایشگرها(c، اپن سرچ.تطبیق همه()).total
    سرچاپ اپن سرچ.حذف پایشگر(c، id)
پایان

روش همسایه‌یابی `KnnMethod`

ساختار روش همسایه‌یابی

یک فیلد knn_vector چگونه نمایه می‌شود.

نام	انگلیسی	گونه	توضیح
name	`name`	`رشته = "hnsw"`	الگوریتم، `hnsw` یا `ivf`.
engine	`engine`	`رشته = "lucene"`	`lucene`، `faiss` یا `nmslib`.
space_type	`space_type`	`رشته = "l2"`	فاصله: `l2`، `cosinesimil`، `innerproduct` و بقیه، بسته به موتور.
m	`m`	`صحیح = 0`	شمار پیوندهای HNSW؛ ۰ برای پیش‌فرض.
ef_construction	`ef_construction`	`صحیح = 0`	کیفیت ساخت HNSW؛ ۰ برای پیش‌فرض.

db-opensearch-Knn.salam

واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    c := اپن سرچ.اتصال("http://localhost:9200")
    method := اپن سرچ.روش همسایه‌یابی { name = "hnsw"، engine = "lucene"، space_type = "cosinesimil"، m = 16، ef_construction = 128 }
    ناپایا extra := وکتور {} برگردان وکتور<رشته>
    extra.بیفزا(اپن سرچ.ویژگی("text"، "text"))
    سرچاپ اپن سرچ.تنظیمات نمایه همسایه‌یابی(1، 0)، اپن سرچ.فیلد بردار همسایه‌یابی(3، method)
    سرچاپ اپن سرچ.ایجاد نمایه(c، "places"، اپن سرچ.بدنه نمایه همسایه‌یابی("embedding"، 3، method، extra))
    اپن سرچ.نمایه‌سازی(c، "places"، "1"، `{"text":"a cafe","embedding":[0.1,0.9,0.2]}`)
    اپن سرچ.تازه‌سازی(c، "places")
    ناپایا v := وکتور {} برگردان وکتور<اعشار۶۴>
    v.بیفزا(0.1)
    v.بیفزا(0.8)
    v.بیفزا(0.3)
    r := اپن سرچ.جستجو(c، "places"، اپن سرچ.نزدیک‌ترین همسایه‌ها("embedding"، v، 5))
    سرچاپ r.total
    سرچاپ اپن سرچ.گرم‌کردن همسایه‌یابی(c، "places")، اپن سرچ.پاک‌سازی حافظه همسایه‌یابی(c، "places")، اپن سرچ.آمار همسایه‌یابی(c).طول() بزرگتر 0
    سرچاپ اپن سرچ.آموزش مدل همسایه‌یابی(c، "pq-model"، `{"training_index":"train","training_field":"v","dimension":3,"method":{"name":"ivf","engine":"faiss"}}`)
    سرچاپ اپن سرچ.دریافت مدل همسایه‌یابی(c، "pq-model")، اپن سرچ.حذف مدل همسایه‌یابی(c، "pq-model")

    ناپایا w := وکتور {} برگردان وکتور<اعشار۶۴>
    w.بیفزا(0.3)
    w.بیفزا(0.7)
    سرچاپ اپن سرچ.تنظیم خط لوله جستجو(c، "hybrid"، اپن سرچ.خط لوله نرمال‌سازی("min_max"، "arithmetic_mean"، w))
    سرچاپ اپن سرچ.دریافت خط لوله جستجو(c، "hybrid")، اپن سرچ.حذف خط لوله جستجو(c، "hybrid")

    task := اپن سرچ.ثبت مدل یادگیری(c، `{"name":"huggingface/sentence-transformers/all-MiniLM-L6-v2","version":"1.0.1","model_format":"TORCH_SCRIPT"}`)
    سرچاپ اپن سرچ.دریافت کار یادگیری(c، task)
    سرچاپ اپن سرچ.استقرار مدل یادگیری(c، "model-1")، اپن سرچ.دریافت مدل یادگیری(c، "model-1").طول() بزرگتر 0
    سرچاپ اپن سرچ.پیش‌بینی مدل(c، "text_embedding"، "model-1"، `{"text_docs":["salam"]}`)
    سرچاپ اپن سرچ.برچیدن مدل یادگیری(c، "model-1")، اپن سرچ.حذف مدل یادگیری(c، "model-1")
پایان

نتیجه پرسمانی `ByQueryResult`

ساختار نتیجه پرسمانی

نتیجه‌ی حذف پرسمانی، به‌روزرسانی پرسمانی یا نمایه‌سازی دوباره.

نام	انگلیسی	گونه	توضیح
ok	`ok`	`منطقی = نادرست`	بدون شکست پایان یافت.
status	`status`	`صحیح = 0`	وضعیت HTTP.
took	`took`	`صحیح۶۴ = 0`	زمان آن، به میلی‌ثانیه.
timed_out	`timed_out`	`منطقی = نادرست`	مهلت آن سر رسید.
total	`total`	`صحیح۶۴ = 0`	چند سند را بررسی کرد.
created	`created`	`صحیح۶۴ = 0`	چند سند ساخت.
updated	`updated`	`صحیح۶۴ = 0`	چند سند را به‌روز کرد.
deleted	`deleted`	`صحیح۶۴ = 0`	چند سند را حذف کرد.
batches	`batches`	`صحیح۶۴ = 0`	چند دسته‌ی پیمایش طول کشید.
version_conflicts	`version_conflicts`	`صحیح۶۴ = 0`	چند سند به ناسازگاری نسخه خوردند.
noops	`noops`	`صحیح۶۴ = 0`	اسکریپت چند سند را دست‌نخورده گذاشت.
failures	`failures`	`رشته = ""`	شکست‌ها به شکل JSON خام؛ اگر نبودند خالی است.
task	`task`	`رشته = ""`	شناسه‌ی کار، وقتی در پس‌زمینه اجرا می‌شود.
error	`error`	`رشته = ""`	چه چیزی خراب شد.

db-opensearch-Index.salam

واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    c := اپن سرچ.اتصال("http://localhost:9200")
    w := اپن سرچ.نمایه‌سازی(c، "books"، "1"، `{"title":"The Book of Kings","year":1010,"stock":3}`)
    سرچاپ w.ok، w.status، w.index، w.id، w.result، w.version، w.seq_no، w.primary_term
    سرچاپ w.shards_total، w.shards_successful، w.error
    auto := اپن سرچ.نمایه‌سازی با گزینه(c، "books"، ""، `{"title":"Masnavi"}`، اپن سرچ.گزینه‌ها { refresh = اپن سرچ.تازه‌سازی با انتظار، routing = "poetry" })
    سرچاپ auto.id
    dup := اپن سرچ.ایجاد سند(c، "books"، "1"، `{"title":"again"}`)
    سرچاپ dup.ok، dup.status
    piped := اپن سرچ.ایجاد سند با گزینه(c، "books"، "2"، `{"title":"Golestan"}`، اپن سرچ.گزینه‌ها { pipeline = "clean"، timeout = "5s"، wait_for_active_shards = "1" })
    سرچاپ piped.result

    d := اپن سرچ.دریافت(c، "books"، "1")
    سرچاپ d.found، d.index، d.id، d.version، d.seq_no، d.primary_term، d.routing، d.source، d.fields، d.error
    ناپایا only := وکتور {} برگردان وکتور<رشته>
    only.بیفزا("title")
    سرچاپ اپن سرچ.دریافت فیلدها(c، "books"، "1"، only، "").source
    سرچاپ اپن سرچ.دریافت منبع(c، "books"، "1")، اپن سرچ.وجود سند(c، "books"، "1")

    سرچاپ اپن سرچ.به‌روزرسانی(c، "books"، "1"، `{"stock":2}`).result
    cas := اپن سرچ.به‌روزرسانی با گزینه(c، "books"، "1"، `{"doc":{"stock":1}}`، اپن سرچ.گزینه‌ها { if_seq_no = d.seq_no، if_primary_term = d.primary_term، retry_on_conflict = -1 })
    سرچاپ cas.ok، اپن سرچ.نوع خطا(c)
    سرچاپ اپن سرچ.به‌روزرسانی درجی(c، "books"، "9"، `{"title":"Shahnameh","stock":1}`).result
    سرچاپ اپن سرچ.به‌روزرسانی اسکریپتی(c، "books"، "1"، اپن سرچ.اسکریپت("ctx._source.stock += params.n"، `{"n":5}`)، `{"stock":5}`).result
    سرچاپ اپن سرچ.حذف سند با گزینه(c، "books"، "9"، اپن سرچ.گزینه‌ها { refresh = اپن سرچ.تازه‌سازی فوری، version = 3، version_type = "external" }).result
    سرچاپ اپن سرچ.حذف سند(c، "books"، "2").result

    ناپایا ids := وکتور {} برگردان وکتور<رشته>
    ids.بیفزا("1")
    ids.بیفزا("404")
    هر doc در اپن سرچ.دریافت چندگانه(c، "books"، ids):
        سرچاپ doc.id، doc.found
    پایان
    سرچاپ اپن سرچ.شمارش(c، "books"، "")، اپن سرچ.شمارش(c، "books"، اپن سرچ.بازه("year"، "1000"، ""))

    ناپایا b := اپن سرچ.دسته‌ای تازه()
    اپن سرچ.نمایه‌سازی دسته‌ای(b، "books"، "10"، `{"title":"Divan"}`)
    اپن سرچ.نمایه‌سازی دسته‌ای مسیردار(b، "books"، "11"، "poetry"، `{"title":"Rubaiyat"}`)
    اپن سرچ.ایجاد دسته‌ای(b، "books"، ""، `{"title":"Bustan"}`)
    اپن سرچ.به‌روزرسانی دسته‌ای(b، "books"، "10"، `{"stock":4}`)
    اپن سرچ.به‌روزرسانی درجی دسته‌ای(b، "books"، "12"، `{"title":"Kalila"}`)
    اپن سرچ.حذف دسته‌ای(b، "books"، "3")
    سرچاپ اپن سرچ.اندازه دسته‌ای(b)، b.count، b.lines.طول()
    چاپ اپن سرچ.بدنه دسته‌ای(b)
    br := اپن سرچ.ارسال دسته‌ای با تازه‌سازی(c، b، اپن سرچ.بدون تازه‌سازی)
    سرچاپ br.ok، br.status، br.took، br.errors، br.succeeded، br.failed، br.error
    هر it در br.items:
        سرچاپ it.action، it.index، it.id، it.status، it.ok، it.result، it.version، it.error_type، it.error_reason
    پایان
    اپن سرچ.بازنشانی دسته‌ای(b)
    اپن سرچ.نمایه‌سازی دسته‌ای(b، "books"، "13"، `{"title":"Makhzan"}`)
    سرچاپ اپن سرچ.ارسال دسته‌ای(c، b).ok
    اپن سرچ.آزادسازی دسته‌ای(b)
    سرچاپ اپن سرچ.تجزیه دسته‌ای(`{"took":1,"errors":false,"items":[]}`).ok

    ub := اپن سرچ.به‌روزرسانی پرسمانی(c، "books"، اپن سرچ.واژه("stock"، "0")، اپن سرچ.اسکریپت("ctx._source.out = true"، ""))
    سرچاپ ub.ok، ub.status، ub.took، ub.timed_out، ub.total، ub.updated، ub.batches، ub.version_conflicts، ub.noops، ub.failures
    ub2 := اپن سرچ.به‌روزرسانی پرسمانی با گزینه(c، "books"، ""، ""، اپن سرچ.گزینه‌ها { conflicts = "proceed"، pipeline = "clean" })
    سرچاپ ub2.updated
    dq := اپن سرچ.حذف پرسمانی(c، "books"، اپن سرچ.واژه("out"، "true"))
    سرچاپ dq.deleted، اپن سرچ.حذف پرسمانی با گزینه(c، "books"، اپن سرچ.تطبیق همه()، اپن سرچ.گزینه‌ها { refresh = "true"، conflicts = "proceed" }).deleted
    rx := اپن سرچ.نمایه‌سازی دوباره(c، "books"، "books_v2")
    سرچاپ rx.created، rx.error
    task := اپن سرچ.نمایه‌سازی دوباره با بدنه(c، `{"source":{"index":"books"},"dest":{"index":"books_v3"}}`، نادرست)
    سرچاپ task.task
پایان

پیکربندی `Config`

ساختار پیکربندی

هر چه کارخواه تازه لازم دارد.

نام	انگلیسی	گونه	توضیح
nodes	`nodes`	`وکتور<رشته>`	نشانی گره‌ها؛ هر عضو می‌تواند چند نشانی جداشده با ویرگول داشته باشد و هر نشانی می‌تواند `user:password@` و پیشوند مسیر داشته باشد.
username	`username`	`رشته = ""`	کاربر احراز هویت پایه.
password	`password`	`رشته = ""`	گذرواژه‌ی احراز هویت پایه.
bearer	`bearer`	`رشته = ""`	یک توکن حامل که به جای احراز هویت پایه فرستاده می‌شود.
ca_file	`ca_file`	`رشته = ""`	پرونده‌ی PEM مراجع صدور گواهی مورد اعتماد برای https.
insecure	`insecure`	`منطقی = نادرست`	وارسی گواهی را رد کن؛ فقط برای سرور آزمایشی با گواهی خودامضا.
timeout_ms	`timeout_ms`	`صحیح = 30000`	بیشترین زمان یک درخواست، به میلی‌ثانیه؛ ۰ یعنی بی‌حد.
max_retries	`max_retries`	`صحیح = 3`	پس از اتصال ناموفق یا پاسخ 502، 503 یا 504 درخواست چند بار دیگر روی گره‌ی دیگری آزموده شود.
headers	`headers`	`نگاشت<رشته، رشته>`	سرآیندهای بیشتری که با هر درخواست فرستاده می‌شوند.
aws_region	`aws_region`	`رشته = ""`	هر درخواست را با AWS SigV4 برای این ناحیه امضا کن؛ خالی یعنی بدون امضا.
aws_service	`aws_service`	`رشته = ""`	سرویس AWS برای امضا، `سرویس دامنه` (پیش‌فرض) یا `سرویس بی‌سرور`.
aws_access_key	`aws_access_key`	`رشته = ""`	شناسه‌ی کلید دسترسی AWS.
aws_secret_key	`aws_secret_key`	`رشته = ""`	کلید دسترسی محرمانه‌ی AWS.
aws_session_token	`aws_session_token`	`رشته = ""`	توکن نشست AWS برای اعتبارنامه‌ی موقت؛ اگر نیست خالی.

db-opensearch-Client.salam

واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    ناپایا cfg := اپن سرچ.پیکربندی پیش‌فرض()
    cfg.nodes.بیفزا("https://node2.example.com:9200, https://node3.example.com:9200")
    cfg.username = "admin"
    cfg.password = "S3cret-pass!"
    cfg.ca_file = "/etc/ssl/certs/opensearch-ca.pem"
    cfg.timeout_ms = 10000
    cfg.max_retries = 2
    cfg.headers.درج("X-Opaque-Id"، "shop-api")
    ناپایا c := اپن سرچ.کارخواه تازه(cfg)
    اگر وارونه اپن سرچ.معتبر(c):
        سرچاپ اپن سرچ.خطا(c)
        برگشت 1
    پایان
    سرچاپ اپن سرچ.گره‌ها(c)، اپن سرچ.سرآیند احراز(c).طول() بزرگتر 0، اپن سرچ.نسخه کارخواه
    سرچاپ اپن سرچ.پینگ(c)

    info := اپن سرچ.دریافت اطلاعات(c)
    سرچاپ info.ok، info.name، info.cluster_name، info.cluster_uuid، info.version، info.distribution
    سرچاپ info.build_type، info.lucene_version، info.minimum_wire_compatibility_version، info.tagline

    r := اپن سرچ.انجام(c، "GET"، "/_cat/health?format=json"، "")
    سرچاپ r.ok، r.status، r.body
    اگر وارونه r.ok:
        سرچاپ r.error، r.error_type، r.error_reason
    پایان
    nd := اپن سرچ.انجام چندخطی(c، "POST"، "/_bulk"، "{\"delete\":{\"_index\":\"shop\",\"_id\":\"1\"}}\n")
    سرچاپ nd.status، اپن سرچ.وضعیت(c)، اپن سرچ.نوع خطا(c)، اپن سرچ.علت خطا(c)
    txt := اپن سرچ.انجام متنی(c، "POST"، "/_plugins/_sql?format=csv"، `{"query":"SELECT 1"}`، "application/json")
    سرچاپ txt.body
    اپن سرچ.بستن(c)

    ناپایا local := اپن سرچ.اتصال(اپن سرچ.نشانی پیش‌فرض)
    سرچاپ اپن سرچ.معتبر(local)، اپن سرچ.درگاه پیش‌فرض، اپن سرچ.مهلت گره از کار افتاده
    اپن سرچ.بستن(local)
    ناپایا demo := اپن سرچ.اتصال بدون وارسی گواهی("https://localhost:9200"، "admin"، "S3cret-pass!")
    اپن سرچ.بستن(demo)
    ناپایا auth := اپن سرچ.اتصال با رمز("https://search.example.com"، "reader"، "pass")
    سرچاپ اپن سرچ.کدگذاری پایه("reader"، "pass")
    اپن سرچ.بستن(auth)

    ناپایا aws := اپن سرچ.اتصال آمازون(
        "https://search-shop.eu-west-1.es.amazonaws.com"، "eu-west-1"، اپن سرچ.سرویس دامنه،
        "AKIAEXAMPLE"، "secret-key"، ""
    )
    اپن سرچ.تنظیم زمان امضا(aws، 1700000000 برگردان صحیح۶۴)
    سرچاپ اپن سرچ.سلامت خوشه(aws).status
    اپن سرچ.بستن(aws)
    ناپایا serverless := اپن سرچ.اتصال آمازون(
        "https://abc123.eu-west-1.aoss.amazonaws.com"، "eu-west-1"، اپن سرچ.سرویس بی‌سرور،
        "AKIAEXAMPLE"، "secret-key"، "session-token"
    )
    اپن سرچ.بستن(serverless)
    برگشت 0
پایان

کارخواه `Client`

ساختار کارخواه

اتصال به یک خوشه‌ی اپن سرچ؛ با بستن آزادش کنید.

نام	انگلیسی	گونه	توضیح
handle	`handle`	`تهی*`	حالت درونی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

پاسخ `Response`

ساختار پاسخ

پاسخ خام یک درخواست.

نام	انگلیسی	گونه	توضیح
status	`status`	`صحیح = 0`	وضعیت HTTP؛ اگر پاسخی نیامد ۰.
ok	`ok`	`منطقی = نادرست`	وضعیت 2xx بود.
body	`body`	`رشته = ""`	بدنه‌ی پاسخ.
error	`error`	`رشته = ""`	چه چیزی خراب شد، همراه نوع و علت خطای سرور اگر فرستاده باشد.
error_type	`error_type`	`رشته = ""`	نوع خطای سرور، مثل `index_not_found_exception`.
error_reason	`error_reason`	`رشته = ""`	علت خطای سرور.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

گزینه‌ها `Options`

ساختار گزینه‌ها

تنظیمات اختیاری نوشتن. رشته‌های خالی و عددهای منفی کنار گذاشته می‌شوند.

نام	انگلیسی	گونه	توضیح
refresh	`refresh`	`رشته = ""`	یکی از مقدارهای تازه‌سازی.
routing	`routing`	`رشته = ""`	مقدار مسیریابی، برای گذاشتن سند روی شارد دلخواه.
pipeline	`pipeline`	`رشته = ""`	خط لوله‌ی ورودی‌ای که سند از آن بگذرد.
timeout	`timeout`	`رشته = ""`	مدت انتظار برای شاردها، مثل `5s`.
wait_for_active_shards	`wait_for_active_shards`	`رشته = ""`	چند نسخه‌ی شارد باید فعال باشند، یا `all`.
conflicts	`conflicts`	`رشته = ""`	برای فراخوانی‌های پرسمانی: `proceed` با وجود ناسازگاری نسخه ادامه می‌دهد.
if_seq_no	`if_seq_no`	`صحیح۶۴ = -1`	فقط اگر سند هنوز این شماره‌ی ترتیب را دارد بنویس.
if_primary_term	`if_primary_term`	`صحیح۶۴ = -1`	فقط اگر سند هنوز این دوره‌ی اصلی را دارد بنویس.
retry_on_conflict	`retry_on_conflict`	`صحیح = -1`	برای به‌روزرسانی: چند بار هنگام ناسازگاری نسخه دوباره تلاش شود.
version	`version`	`صحیح۶۴ = -1`	نسخه‌ی صریح سند.
version_type	`version_type`	`رشته = ""`	گونه‌ی نسخه، مثل `external`.
require_alias	`require_alias`	`منطقی = نادرست`	مقصد باید نام مستعار باشد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

نتیجه نوشتن `WriteResult`

ساختار نتیجه نوشتن

نتیجه‌ی نوشتن روی یک سند.

نام	انگلیسی	گونه	توضیح
ok	`ok`	`منطقی = نادرست`	نوشتن موفق بود.
status	`status`	`صحیح = 0`	وضعیت HTTP.
index	`index`	`رشته = ""`	نمایه‌ای که در آن نوشته شد.
id	`id`	`رشته = ""`	شناسه‌ی سند؛ اگر چیزی ندادید ساخته می‌شود.
result	`result`	`رشته = ""`	`created`، `updated`، `deleted`، `noop` یا `not_found`.
version	`version`	`صحیح۶۴ = 0`	نسخه‌ی تازه‌ی سند.
seq_no	`seq_no`	`صحیح۶۴ = -1`	شماره‌ی ترتیب تازه.
primary_term	`primary_term`	`صحیح۶۴ = 0`	دوره‌ی اصلی.
shards_total	`shards_total`	`صحیح = 0`	چند نسخه‌ی شارد باید نوشته را داشته باشند.
shards_successful	`shards_successful`	`صحیح = 0`	چند تا داشتند.
error	`error`	`رشته = ""`	چه چیزی خراب شد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

سند `Document`

ساختار سند

یک سند که با شناسه خوانده شده.

نام	انگلیسی	گونه	توضیح
found	`found`	`منطقی = نادرست`	سند وجود دارد.
index	`index`	`رشته = ""`	نمایه‌ی آن.
id	`id`	`رشته = ""`	شناسه‌ی آن.
version	`version`	`صحیح۶۴ = 0`	نسخه‌ی آن.
seq_no	`seq_no`	`صحیح۶۴ = -1`	شماره‌ی ترتیب آن، برای نوشتن شرطی بعدی.
primary_term	`primary_term`	`صحیح۶۴ = 0`	دوره‌ی اصلی آن، برای نوشتن شرطی بعدی.
routing	`routing`	`رشته = ""`	مقدار مسیریابی آن اگر دارد.
source	`source`	`رشته = ""`	سند به شکل JSON خام.
fields	`fields`	`رشته = ""`	فیلدهای ذخیره‌شده به شکل JSON خام، اگر خواسته شوند.
error	`error`	`رشته = ""`	چه چیزی خراب شد؛ وقتی سند فقط وجود ندارد خالی است.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

یافته `Hit`

ساختار یافته

یک یافته‌ی جستجو.

نام	انگلیسی	گونه	توضیح
index	`index`	`رشته = ""`	نمایه‌ای که از آن آمده.
id	`id`	`رشته = ""`	شناسه‌ی سند.
score	`score`	`اعشار۶۴ = 0`	امتیاز ارتباط آن.
source	`source`	`رشته = ""`	سند به شکل JSON خام.
sort	`sort`	`رشته = ""`	مقدارهای مرتب‌سازی آن به شکل JSON خام؛ مقدار آخرین یافته را به `search_after` بدهید تا صفحه‌ی بعد بیاید.
highlight	`highlight`	`رشته = ""`	تکه‌های برجسته‌شده به شکل JSON خام.
fields	`fields`	`رشته = ""`	فیلدهای خواسته‌شده به شکل JSON خام.
inner_hits	`inner_hits`	`رشته = ""`	یافته‌های درونی پرسمان تودرتو یا ادغام‌شده، به شکل JSON خام.
matched_queries	`matched_queries`	`رشته = ""`	پرسمان‌های نام‌داری که تطبیق خوردند، به شکل JSON خام.
raw	`raw`	`رشته = ""`	کل یافته به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

نتیجه جستجو `SearchResult`

ساختار نتیجه جستجو

نتیجه‌ی یک جستجو.

نام	انگلیسی	گونه	توضیح
ok	`ok`	`منطقی = نادرست`	جستجو موفق بود.
status	`status`	`صحیح = 0`	وضعیت HTTP.
took	`took`	`صحیح۶۴ = 0`	زمان آن روی سرور، به میلی‌ثانیه.
timed_out	`timed_out`	`منطقی = نادرست`	سرور به خاطر سررسید مهلت زود ایستاد.
total	`total`	`صحیح۶۴ = 0`	چند سند تطبیق خورد.
total_relation	`total_relation`	`رشته = ""`	`eq` وقتی `total` دقیق است و `gte` وقتی کران پایین است.
max_score	`max_score`	`اعشار۶۴ = 0`	بهترین امتیاز.
hits	`hits`	`وکتور<یافته>`	یافته‌های این صفحه.
aggregations	`aggregations`	`رشته = ""`	تجمیع‌ها به شکل JSON خام؛ با `سطل‌ها` و `مقدار تجمیع` بخوانیدشان.
suggest	`suggest`	`رشته = ""`	پیشنهادها به شکل JSON خام؛ با `پیشنهادها` بخوانیدشان.
scroll_id	`scroll_id`	`رشته = ""`	شناسه برای فراخوانی بعدی `پیمایش`.
pit_id	`pit_id`	`رشته = ""`	شناسه‌ی نقطه‌ی زمانی که سرور برگرداند.
raw	`raw`	`رشته = ""`	کل پاسخ.
error	`error`	`رشته = ""`	چه چیزی خراب شد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

درخواست جستجو `SearchRequest`

ساختار درخواست جستجو

یک جستجو. رشته‌ها و فهرست‌های خالی و عددهای منفی از بدنه‌ی درخواست کنار گذاشته می‌شوند.

نام	انگلیسی	گونه	توضیح
query	`query`	`رشته = ""`	پرسمان، ساخته‌شده با سازنده‌ها یا نوشته‌شده به شکل JSON.
from	`from`	`صحیح = -1`	چند یافته رد شود.
size	`size`	`صحیح = -1`	چند یافته برگردد.
sort	`sort`	`وکتور<رشته>`	بندهای مرتب‌سازی، مثل `مرتب نزولی("date")`.
source	`source`	`وکتور<رشته>`	فقط این فیلدهای منبع برگردند.
source_excludes	`source_excludes`	`وکتور<رشته>`	این فیلدهای منبع کنار گذاشته شوند.
no_source	`no_source`	`منطقی = نادرست`	هیچ منبعی برنگردد.
fields	`fields`	`وکتور<رشته>`	فیلدهایی که در فیلدهای یافته برگردند.
docvalue_fields	`docvalue_fields`	`وکتور<رشته>`	فیلدهای مقدار سند که برگردند.
aggs	`aggs`	`رشته = ""`	تجمیع‌ها، ساخته‌شده با `افزودن تجمیع`.
highlight	`highlight`	`رشته = ""`	تنظیمات برجسته‌سازی، از `برجسته‌سازی`.
post_filter	`post_filter`	`رشته = ""`	پالایه‌ای که پس از شمردن تجمیع‌ها اعمال می‌شود.
collapse	`collapse`	`رشته = ""`	ادغام یافته‌ها روی یک فیلد، از `ادغام فیلدی`.
suggest	`suggest`	`رشته = ""`	پیشنهاددهنده‌ها، از `پیشنهاد واژه` یا `پیشنهاد تکمیل`.
rescore	`rescore`	`رشته = ""`	یک بند امتیازدهی دوباره به شکل JSON.
script_fields	`script_fields`	`رشته = ""`	فیلدهای اسکریپتی به شکل JSON.
search_after	`search_after`	`رشته = ""`	مقدارهای مرتب‌سازی آخرین یافته به شکل آرایه‌ی JSON، برای گرفتن صفحه‌ی بعد.
pit_id	`pit_id`	`رشته = ""`	شناسه‌ی نقطه‌ی زمانی از `ایجاد نقطه زمانی`؛ آن‌گاه جستجو به `/_search` می‌رود و نمایه نام برده نمی‌شود.
pit_keep_alive	`pit_keep_alive`	`رشته = ""`	نقطه‌ی زمانی چقدر دیگر نگه داشته شود، مثل `1m`.
track_total_hits	`track_total_hits`	`رشته = ""`	`true`، `false` یا یک عدد: تا کجا تطبیق‌ها دقیق شمرده شوند.
track_scores	`track_scores`	`منطقی = نادرست`	حتی هنگام مرتب‌سازی با فیلد هم امتیاز حساب شود.
min_score	`min_score`	`رشته = ""`	یافته‌های کمتر از این امتیاز کنار گذاشته شوند.
timeout	`timeout`	`رشته = ""`	پس از این مدت جستجو بایستد، مثل `2s`.
explain	`explain`	`منطقی = نادرست`	توضیح بده هر امتیاز چگونه حساب شد.
version	`version`	`منطقی = نادرست`	نسخه‌ی هر یافته را برگردان.
seq_no_primary_term	`seq_no_primary_term`	`منطقی = نادرست`	شماره‌ی ترتیب و دوره‌ی اصلی هر یافته را برگردان.
ext	`ext`	`رشته = ""`	افزونه‌های جستجو به شکل JSON، مثل تنظیمات تولید پاسخ با بازیابی.
extra	`extra`	`وکتور<رشته>`	عضوهای بیشتر به شکل `"key":value` که همان‌طور افزوده می‌شوند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

سطل `Bucket`

ساختار سطل

یک سطل از یک تجمیع سطلی.

نام	انگلیسی	گونه	توضیح
key	`key`	`رشته = ""`	کلید آن به شکل متن.
key_as_string	`key_as_string`	`رشته = ""`	کلید قالب‌بندی‌شده، برای تاریخ‌ها و عددهای دارای قالب.
doc_count	`doc_count`	`صحیح۶۴ = 0`	چند سند در آن افتاد.
raw	`raw`	`رشته = ""`	سطل به شکل JSON خام، با زیرتجمیع‌هایش.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

دسته‌ای `Bulk`

ساختار دسته‌ای

دسته‌ای از کنش‌های نمایه‌سازی، ایجاد، به‌روزرسانی و حذف که در یک درخواست فرستاده می‌شوند.

نام	انگلیسی	گونه	توضیح
lines	`lines`	`وکتور<رشته>`	خط‌های NDJSON تا این‌جا.
count	`count`	`صحیح = 0`	چند کنش در آن است.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

قلم دسته‌ای `BulkItem`

ساختار قلم دسته‌ای

نتیجه‌ی یک کنش دسته‌ای.

نام	انگلیسی	گونه	توضیح
action	`action`	`رشته = ""`	`index`، `create`، `update` یا `delete`.
index	`index`	`رشته = ""`	نمایه.
id	`id`	`رشته = ""`	شناسه‌ی سند.
status	`status`	`صحیح = 0`	وضعیت HTTP این کنش.
ok	`ok`	`منطقی = نادرست`	موفق بود؛ حذف سندی که وجود ندارد هم مانند خود اپن سرچ موفق شمرده می‌شود.
result	`result`	`رشته = ""`	نتیجه، مثل `created`.
version	`version`	`صحیح۶۴ = 0`	نسخه‌ی تازه‌ی سند.
error_type	`error_type`	`رشته = ""`	نوع خطا وقتی شکست خورد.
error_reason	`error_reason`	`رشته = ""`	علت خطا وقتی شکست خورد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

نتیجه دسته‌ای `BulkResult`

ساختار نتیجه دسته‌ای

نتیجه‌ی یک درخواست دسته‌ای.

نام	انگلیسی	گونه	توضیح
ok	`ok`	`منطقی = نادرست`	همه‌ی کنش‌ها موفق بودند.
status	`status`	`صحیح = 0`	وضعیت HTTP درخواست.
took	`took`	`صحیح۶۴ = 0`	زمان آن، به میلی‌ثانیه.
errors	`errors`	`منطقی = نادرست`	سرور دست‌کم یک کنش ناموفق گزارش کرد.
succeeded	`succeeded`	`صحیح = 0`	چند کنش موفق بودند.
failed	`failed`	`صحیح = 0`	چند کنش شکست خوردند.
items	`items`	`وکتور<قلم دسته‌ای>`	یک نتیجه برای هر کنش، به همان ترتیب.
error	`error`	`رشته = ""`	خلاصه‌ی آن‌چه خراب شد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

اطلاعات `Info`

ساختار اطلاعات

آن‌چه خوشه درباره‌ی خودش می‌گوید.

نام	انگلیسی	گونه	توضیح
ok	`ok`	`منطقی = نادرست`	درخواست موفق بود.
name	`name`	`رشته = ""`	نام گره.
cluster_name	`cluster_name`	`رشته = ""`	نام خوشه.
cluster_uuid	`cluster_uuid`	`رشته = ""`	شناسه‌ی خوشه.
version	`version`	`رشته = ""`	نسخه‌ی اپن سرچ، مثل `2.17.1`.
distribution	`distribution`	`رشته = ""`	`opensearch`.
build_type	`build_type`	`رشته = ""`	شکل بسته‌بندی، مثل `tar` یا `rpm`.
lucene_version	`lucene_version`	`رشته = ""`	نسخه‌ی لوسین.
minimum_wire_compatibility_version	`minimum_wire_compatibility_version`	`رشته = ""`	قدیمی‌ترین نسخه‌ای که می‌تواند با آن گفتگو کند.
tagline	`tagline`	`رشته = ""`	شعار.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

سلامت `Health`

ساختار سلامت

سلامت یک خوشه یا یک نمایه.

نام	انگلیسی	گونه	توضیح
ok	`ok`	`منطقی = نادرست`	درخواست موفق بود.
cluster_name	`cluster_name`	`رشته = ""`	نام خوشه.
status	`status`	`رشته = ""`	`green`، `yellow` یا `red`.
timed_out	`timed_out`	`منطقی = نادرست`	انتظار برای وضعیت با سررسید مهلت پایان یافت.
nodes	`nodes`	`صحیح = 0`	شمار گره‌ها.
data_nodes	`data_nodes`	`صحیح = 0`	شمار گره‌های داده.
active_primary_shards	`active_primary_shards`	`صحیح = 0`	شاردهای اصلی فعال.
active_shards	`active_shards`	`صحیح = 0`	همه‌ی شاردهای فعال.
relocating_shards	`relocating_shards`	`صحیح = 0`	شاردهایی که میان گره‌ها جابه‌جا می‌شوند.
initializing_shards	`initializing_shards`	`صحیح = 0`	شاردهایی که در حال راه‌اندازی‌اند.
unassigned_shards	`unassigned_shards`	`صحیح = 0`	شاردهای بی‌گره.
pending_tasks	`pending_tasks`	`صحیح = 0`	کارهای خوشه در صف.
active_shards_percent	`active_shards_percent`	`اعشار۶۴ = 0`	سهم شاردهای فعال، از ۰ تا ۱۰۰.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

اطلاعات نمایه `IndexInfo`

ساختار اطلاعات نمایه

یک ردیف از فهرست نمایه‌ها.

نام	انگلیسی	گونه	توضیح
health	`health`	`رشته = ""`	`green`، `yellow` یا `red`.
status	`status`	`رشته = ""`	`open` یا `close`.
index	`index`	`رشته = ""`	نام نمایه.
uuid	`uuid`	`رشته = ""`	شناسه‌ی نمایه.
primaries	`primaries`	`صحیح = 0`	شمار شاردهای اصلی.
replicas	`replicas`	`صحیح = 0`	شمار نسخه‌های تکراری.
docs_count	`docs_count`	`صحیح۶۴ = 0`	شمار سندها.
docs_deleted	`docs_deleted`	`صحیح۶۴ = 0`	سندهای حذف‌شده‌ای که هنوز ادغام نشده‌اند.
store_size	`store_size`	`رشته = ""`	اندازه روی دیسک، به بایت.

db-opensearch-CreateIndex.salam

واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    c := اپن سرچ.اتصال("http://localhost:9200")
    ناپایا props := وکتور {} برگردان وکتور<رشته>
    props.بیفزا(اپن سرچ.ویژگی("title"، "text"))
    props.بیفزا(اپن سرچ.ویژگی با گزینه("title_fa"، "text"، `{"analyzer":"persian"}`))
    props.بیفزا(اپن سرچ.ویژگی("tag"، "keyword"))
    props.بیفزا(اپن سرچ.ویژگی("year"، "integer"))
    سرچاپ اپن سرچ.ایجاد نمایه با تنظیمات(c، "books"، 1، 0، اپن سرچ.ویژگی‌ها(props))
    سرچاپ اپن سرچ.ایجاد نمایه(c، "logs-000001"، `{"aliases":{"logs":{"is_write_index":true}}}`)
    سرچاپ اپن سرچ.وجود نمایه(c، "books")، اپن سرچ.دریافت نمایه(c، "books").طول() بزرگتر 0
    سرچاپ اپن سرچ.تنظیم نگاشت(c، "books"، "{" + اپن سرچ.ویژگی("isbn"، "keyword") + "}")
    سرچاپ اپن سرچ.تنظیم نگاشت با بدنه(c، "books"، `{"dynamic":"strict"}`)، اپن سرچ.دریافت نگاشت(c، "books")
    سرچاپ اپن سرچ.تنظیم تنظیمات(c، "books"، `{"index":{"refresh_interval":"5s"}}`)
    سرچاپ اپن سرچ.دریافت تنظیمات(c، "books").طول() بزرگتر 0، اپن سرچ.دریافت یک تنظیم(c، "books"، "index.refresh_interval")
    سرچاپ اپن سرچ.تازه‌سازی(c، "books")، اپن سرچ.تخلیه(c، "books")، اپن سرچ.ادغام اجباری(c، "books"، 1)، اپن سرچ.پاک‌سازی حافظه نهان(c، "books")
    سرچاپ اپن سرچ.بستن نمایه(c، "books")، اپن سرچ.گشودن نمایه(c، "books")
    سرچاپ اپن سرچ.تنظیم تنظیمات(c، "books"، `{"index.blocks.write":true}`)
    سرچاپ اپن سرچ.همسان‌سازی نمایه(c، "books"، "books_clone"، "")، اپن سرچ.کوچک‌سازی نمایه(c، "books"، "books_small"، "")، اپن سرچ.شکافتن نمایه(c، "books"، "books_big"، `{"settings":{"index.number_of_shards":2}}`)
    سرچاپ اپن سرچ.آمار نمایه(c، "books").طول() بزرگتر 0

    سرچاپ اپن سرچ.افزودن نام مستعار(c، "books"، "library")، اپن سرچ.وجود نام مستعار(c، "library")، اپن سرچ.نمایه‌های نام مستعار(c، "library")
    سرچاپ اپن سرچ.افزودن نام مستعار پالایش شده(c، "books"، "poetry"، اپن سرچ.واژه("tag"، "poetry")، نادرست)
    سرچاپ اپن سرچ.دریافت نام‌های مستعار(c، "books")، اپن سرچ.حذف نام مستعار(c، "books"، "poetry")
    ناپایا acts := وکتور {} برگردان وکتور<رشته>
    acts.بیفزا(اپن سرچ.کنش نام مستعار("add"، "books_clone"، "library"))
    acts.بیفزا(اپن سرچ.کنش نام مستعار("remove"، "books"، "library"))
    سرچاپ اپن سرچ.به‌روزرسانی نام‌های مستعار(c، acts)، اپن سرچ.جابجایی نام مستعار(c، "library"، "books_clone"، "books")

    ناپایا patterns := وکتور {} برگردان وکتور<رشته>
    patterns.بیفزا("logs-*")
    tpl := اپن سرچ.الگوی نمایه(patterns، `{"number_of_replicas":0}`، "{" + اپن سرچ.ویژگی("msg"، "text") + "}"، 10)
    سرچاپ اپن سرچ.تنظیم الگوی نمایه(c، "logs"، tpl)، اپن سرچ.وجود الگوی نمایه(c، "logs")، اپن سرچ.دریافت الگوی نمایه(c، "logs").طول() بزرگتر 0
    سرچاپ اپن سرچ.تنظیم الگوی جزء(c، "base"، `{"template":{"settings":{"number_of_shards":1}}}`)، اپن سرچ.دریافت الگوی جزء(c، "base").طول() بزرگتر 0
    سرچاپ اپن سرچ.چرخش نمایه(c، "logs"، `{"max_docs":1000000,"max_age":"7d"}`)
    سرچاپ اپن سرچ.تنظیم الگوی نمایه(c، "events"، `{"index_patterns":["events-*"],"data_stream":{}}`)
    سرچاپ اپن سرچ.ایجاد جریان داده(c، "events-web")، اپن سرچ.جریان‌های داده(c)، اپن سرچ.حذف جریان داده(c، "events-web")
    سرچاپ اپن سرچ.تحلیل متن(c، ""، "standard"، "Salam to OpenSearch")
    هر ix در اپن سرچ.فهرست نمایه‌ها(c، "books*"):
        سرچاپ ix.health، ix.status، ix.index، ix.uuid، ix.primaries، ix.replicas، ix.docs_count، ix.docs_deleted، ix.store_size
    پایان
    سرچاپ اپن سرچ.حذف الگوی نمایه(c، "logs")، اپن سرچ.حذف الگوی نمایه(c، "events")، اپن سرچ.حذف الگوی جزء(c، "base")
    سرچاپ اپن سرچ.حذف نمایه(c، "books_clone,books_small,books_big")، اپن سرچ.حذف نمایه موجود(c، "never-made")
پایان

ردیف‌های اس کیو ال `SqlRows`

ساختار ردیف‌های اس کیو ال

ردیف‌های یک پرسمان SQL یا PPL؛ هر چه پیش بروید صفحه‌های بیشتری می‌گیرد و ردیف‌های دیتابیس را پیاده می‌کند.

نام	انگلیسی	گونه	توضیح
handle	`handle`	`تهی*`	حالت درونی.

db-opensearch-Sql.salam

واردسازی دیتابیس
واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    c := اپن سرچ.اتصال("http://localhost:9200")
    conn := اپن سرچ.اتصال عمومی(c)
    سرچاپ conn.نوع()، conn.معتبر()، conn.پینگ()، دیتابیس.پرسمان عدد(conn، "SELECT COUNT(*) FROM books")
    rows := conn.پرسمان("SELECT title, year, price FROM books WHERE year > 1000 ORDER BY year")
    سرچاپ rows.معتبر()، rows.تعداد ستون()، rows.نام ستون(0)، rows.نوع ستون(1)
    تا rows.بعدی():
        سرچاپ rows.متن(0)، rows.عدد صحیح(1)، rows.عدد صحیح۶۴(1)، rows.عدد اعشار(2)، rows.خالی است(2)
    پایان
    rows.بستن()
    سرچاپ conn.اجرا("DELETE FROM books WHERE year < 0")، conn.تعداد تغییرات()، conn.شناسه آخرین درج()، conn.خطا()، conn.نقل قول("it's")
    tx := conn.شروع تراکنش()
    سرچاپ tx.معتبر()، tx.اجرا("SELECT 1")، tx.پرسمان("SELECT 1").معتبر()، tx.ثبت تراکنش()، tx.بازگردانی()

    ناپایا params := وکتور {} برگردان وکتور<رشته>
    params.بیفزا(اپن سرچ.پارامتر اس کیو ال("integer"، "1000"))
    ناپایا paged := اپن سرچ.اس کیو ال با پارامتر(c، "SELECT title FROM books WHERE year > ?"، params، 100)
    سرچاپ paged.مجموع()، paged.نام نوع ستون(0)، paged.خطا()
    تا paged.بعدی():
        سرچاپ paged.خام(0)
    پایان
    paged.بستن()
    rs := اپن سرچ.اس کیو ال(c، "SHOW TABLES LIKE books%")
    rs.بستن()
    سرچاپ اپن سرچ.اس کیو ال با قالب(c، "SELECT title FROM books"، "csv")
    سرچاپ اپن سرچ.توضیح اس کیو ال(c، "SELECT title FROM books").طول() بزرگتر 0

    p := اپن سرچ.پی پی ال(c، "source=books | where year > 1000 | stats count() by tag")
    تا p.بعدی():
        سرچاپ p.عدد صحیح(0)، p.متن(1)
    پایان
    p.بستن()
    سرچاپ اپن سرچ.پی پی ال با قالب(c، "source=books | fields title"، "raw")، اپن سرچ.توضیح پی پی ال(c، "source=books").طول() بزرگتر 0
    d := اپن سرچ.پایگاه داده { handle = c.handle }
    t := اپن سرچ.تراکنش {}
    سرچاپ d.نوع()، t.معتبر()، conn.بستن()
پایان

معتبر `Ok`

تابع معتبر(): منطقی

پرسمان موفق بود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

خطا `Error`

تابع خطا(): رشته

چه چیزی خراب شد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

مجموع `Total`

تابع مجموع(): صحیح۶۴

شمار ردیفی که سرور با آخرین صفحه گزارش کرد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

بعدی `Next`

تابع بعدی(): منطقی

به ردیف بعد می‌رود و در صورت نیاز صفحه‌ی بعد را می‌گیرد؛ در پایان نادرست.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

تعداد ستون `ColumnCount`

تابع تعداد ستون(): صحیح

شمار ستون‌ها.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

نام ستون `ColumnName`

تابع نام ستون(col: صحیح): رشته

نام یک ستون، یا نام مستعارش.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

نام نوع ستون `ColumnTypeName`

تابع نام نوع ستون(col: صحیح): رشته

گونه‌ی اپن سرچ یک ستون، مثل keyword یا long.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

نوع ستون `ColumnType`

تابع نوع ستون(col: صحیح): صحیح

گونه‌ی یک ستون در ردیف جاری، یکی از ثابت‌های گونه‌ی دیتابیس.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

خالی است `IsNull`

تابع خالی است(col: صحیح): منطقی

مقدار تهی است.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

متن `Text`

تابع متن(col: صحیح): رشته

مقدار به شکل متن.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

خام `Raw`

تابع خام(col: صحیح): رشته

مقدار به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

عدد صحیح `Int`

تابع عدد صحیح(col: صحیح): صحیح

مقدار به شکل عدد صحیح.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

عدد صحیح۶۴ `Int64`

تابع عدد صحیح۶۴(col: صحیح): صحیح۶۴

مقدار به شکل عدد صحیح ۶۴ بیتی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

عدد اعشار `Float`

تابع عدد اعشار(col: صحیح): اعشار۶۴

مقدار به شکل عدد اعشاری.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

بستن `Close`

تابع بستن(): صحیح

ردیف‌ها را آزاد می‌کند و اگر صفحه‌ای مانده مکان‌نمای سرور را می‌بندد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

پایگاه داده `Database`

ساختار پایگاه داده

یک کارخواه به شکل اتصال دیتابیس، از اتصال عمومی.

نام	انگلیسی	گونه	توضیح
handle	`handle`	`تهی*`	حالت کارخواه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

نوع `Kind`

تابع نوع(): رشته

دیتابیس.اپن سرچ.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

معتبر `Ok`

تابع معتبر(): منطقی

کارخواه معتبر است.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

پینگ `Ping`

تابع پینگ(): منطقی

خوشه پاسخ می‌دهد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

اجرا `Exec`

تابع اجرا(sql: رشته): صحیح

یک DELETE در SQL اجرا می‌کند و اگر خوشه حذف با SQL را اجازه دهد شمار سندهای حذف‌شده را برمی‌گرداند؛ هر چیز دیگر ۱- است، چون SQL اپن سرچ جز این فقط‌خواندنی است.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

پرسمان `Query`

تابع پرسمان(sql: رشته): dyn db.Rows

یک پرسمان SQL اجرا می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

شروع تراکنش `Begin`

تابع شروع تراکنش(): dyn db.Tx

اپن سرچ تراکنش ندارد؛ نتیجه هرگز معتبر نیست.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

شناسه آخرین درج `LastInsertId`

تابع شناسه آخرین درج(): صحیح۶۴

همیشه ۰؛ شناسه را از نمایه‌سازی بگیرید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

تعداد تغییرات `Changes`

تابع تعداد تغییرات(): صحیح۶۴

آخرین اجرا چند سند حذف کرد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

خطا `Error`

تابع خطا(): رشته

آخرین خطا.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

نقل قول `Quote`

تابع نقل قول(s: رشته): رشته

یک مقدار متنی نقل‌قول‌شده برای SQL.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

بستن `Close`

تابع بستن(): صحیح

کارخواه را آزاد می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

تراکنش `Txn`

ساختار تراکنش

تراکنشی که شروع تراکنش برمی‌گرداند؛ هر فراخوانی شکست می‌خورد.

نام	انگلیسی	گونه	توضیح
handle	`handle`	`تهی*`	به کار نمی‌رود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

معتبر `Ok`

تابع معتبر(): منطقی

همیشه نادرست.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

اجرا `Exec`

تابع اجرا(_sql: رشته): صحیح

همیشه ۱-.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

پرسمان `Query`

تابع پرسمان(_sql: رشته): dyn db.Rows

ردیف‌هایی که هرگز معتبر نیستند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

ثبت تراکنش `Commit`

تابع ثبت تراکنش(): صحیح

همیشه ۱-.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

بازگردانی `Rollback`

تابع بازگردانی(): صحیح

همیشه ۱-.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

پایاها و متغیرها

نسخه کارخواه `VERSION`

پایا نسخه کارخواه: رشته = "1.0.0"

نسخه‌ی این کارخواه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

نشانی پیش‌فرض `DEFAULT_URL`

پایا نشانی پیش‌فرض: رشته = "http://localhost:9200"

نشانی‌ای که وقتی گره‌ای داده نشده به کار می‌رود: http://localhost:9200.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

درگاه پیش‌فرض `DEFAULT_PORT`

پایا درگاه پیش‌فرض: صحیح۳۲ = 9200

درگاهی که وقتی نشانی گره درگاه ندارد به کار می‌رود: 9200.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

مهلت گره از کار افتاده `DEAD_NODE_MS`

پایا مهلت گره از کار افتاده: صحیح۳۲ = 60000

مدتی که گره‌ای که اتصال را رد کرده کنار گذاشته می‌شود، به میلی‌ثانیه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

تازه‌سازی فوری `REFRESH_TRUE`

پایا تازه‌سازی فوری: رشته = "درست"

بی‌درنگ تازه‌سازی کن تا تغییر هنگام برگشت فراخوانی قابل جستجو باشد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

تازه‌سازی با انتظار `REFRESH_WAIT_FOR`

پایا تازه‌سازی با انتظار: رشته = "wait_for"

پیش از برگشت منتظر تازه‌سازی زمان‌بندی‌شده‌ی بعدی بمان.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

بدون تازه‌سازی `REFRESH_FALSE`

پایا بدون تازه‌سازی: رشته = "نادرست"

تازه‌سازی نکن؛ حالت پیش‌فرض.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

سرویس دامنه `SERVICE_ES`

پایا سرویس دامنه: رشته = "es"

نام سرویس امضای AWS برای یک دامنه‌ی Amazon OpenSearch Service.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

سرویس بی‌سرور `SERVICE_AOSS`

پایا سرویس بی‌سرور: رشته = "aoss"

نام سرویس امضای AWS برای یک مجموعه‌ی OpenSearch Serverless.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

تابع‌ها

دسته‌ای تازه `NewBulk`

تابع دسته‌ای تازه(): دسته‌ای

یک دسته‌ی خالی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

نمایه‌سازی دسته‌ای `BulkIndex`

تابع نمایه‌سازی دسته‌ای(b &: دسته‌ای، index: رشته، id: رشته، doc: رشته)

یک کنش نمایه‌سازی می‌افزاید؛ شناسه‌ی خالی یعنی سرور یکی بسازد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

نمایه‌سازی دسته‌ای مسیردار `BulkIndexRouted`

تابع نمایه‌سازی دسته‌ای مسیردار(b &: دسته‌ای، index: رشته، id: رشته، routing: رشته، doc: رشته)

یک کنش نمایه‌سازی با مقدار مسیریابی می‌افزاید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

ایجاد دسته‌ای `BulkCreate`

تابع ایجاد دسته‌ای(b &: دسته‌ای، index: رشته، id: رشته، doc: رشته)

یک کنش ایجاد می‌افزاید که اگر شناسه باشد شکست می‌خورد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

به‌روزرسانی دسته‌ای `BulkUpdate`

تابع به‌روزرسانی دسته‌ای(b &: دسته‌ای، index: رشته، id: رشته، partial: رشته)

یک به‌روزرسانی می‌افزاید که فیلدهای داده‌شده را ادغام می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

به‌روزرسانی درجی دسته‌ای `BulkUpsert`

تابع به‌روزرسانی درجی دسته‌ای(b &: دسته‌ای، index: رشته، id: رشته، doc: رشته)

یک به‌روزرسانی می‌افزاید که اگر سند نباشد آن را می‌سازد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

حذف دسته‌ای `BulkDelete`

تابع حذف دسته‌ای(b &: دسته‌ای، index: رشته، id: رشته)

یک کنش حذف می‌افزاید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

اندازه دسته‌ای `BulkLen`

تابع اندازه دسته‌ای(b: دسته‌ای): صحیح

چند کنش در دسته است.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

بدنه دسته‌ای `BulkBody`

تابع بدنه دسته‌ای(b: دسته‌ای): رشته

بدنه‌ی NDJSON که دسته می‌فرستد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

بازنشانی دسته‌ای `BulkReset`

تابع بازنشانی دسته‌ای(b &: دسته‌ای)

دسته را خالی می‌کند تا دوباره پر شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

آزادسازی دسته‌ای `BulkFree`

تابع آزادسازی دسته‌ای(b &: دسته‌ای)

دسته را آزاد می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

تجزیه دسته‌ای `ParseBulk`

تابع تجزیه دسته‌ای(body: رشته): نتیجه دسته‌ای

یک پاسخ دسته‌ای را می‌خواند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

ارسال دسته‌ای `BulkSend`

تابع ارسال دسته‌ای(c: کارخواه، b: دسته‌ای): نتیجه دسته‌ای

دسته را می‌فرستد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

ارسال دسته‌ای با تازه‌سازی `BulkSendWith`

تابع ارسال دسته‌ای با تازه‌سازی(c: کارخواه، b: دسته‌ای، refresh: رشته): نتیجه دسته‌ای

دسته را با یک تنظیم تازه‌سازی می‌فرستد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

تطبیق همه `MatchAll`

تابع تطبیق همه(): رشته

با همه‌ی سندها تطبیق می‌خورد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تطبیق هیچ `MatchNone`

تابع تطبیق هیچ(): رشته

با هیچ سندی تطبیق نمی‌خورد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تطبیق `Match`

تابع تطبیق(field: رشته، text: رشته): رشته

تطبیق تمام‌متن روی یک فیلد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تطبیق همه واژه‌ها `MatchAnd`

تابع تطبیق همه واژه‌ها(field: رشته، text: رشته): رشته

تطبیق تمام‌متن که همه‌ی واژه‌ها باید باشند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تطبیق تقریبی `MatchFuzzy`

تابع تطبیق تقریبی(field: رشته، text: رشته): رشته

تطبیق تمام‌متن که از اشتباه تایپی می‌گذرد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تطبیق عبارت `MatchPhrase`

تابع تطبیق عبارت(field: رشته، text: رشته): رشته

واژه‌ها به همین ترتیب.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تطبیق عبارت با فاصله `MatchPhraseSlop`

تابع تطبیق عبارت با فاصله(field: رشته، text: رشته، slop: صحیح): رشته

واژه‌ها به همین ترتیب، با حداکثر slop واژه در میان.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تطبیق پیشوند عبارت `MatchPhrasePrefix`

تابع تطبیق پیشوند عبارت(field: رشته، text: رشته): رشته

عبارتی که واژه‌ی آخرش می‌تواند پیشوند باشد؛ برای جستجو هنگام تایپ.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تطبیق پیشوند منطقی `MatchBoolPrefix`

تابع تطبیق پیشوند منطقی(field: رشته، text: رشته): رشته

همه‌ی واژه‌ها، آخری به شکل پیشوند، به هر ترتیبی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تطبیق چندگانه `MultiMatch`

تابع تطبیق چندگانه(text: رشته، fields: وکتور<رشته>): رشته

تطبیق تمام‌متن روی چند فیلد؛ title^2 به یک فیلد وزن می‌دهد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تطبیق چندگانه نوع‌دار `MultiMatchType`

تابع تطبیق چندگانه نوع‌دار(text: رشته، fields: وکتور<رشته>، kind: رشته): رشته

تطبیق چندگانه از گونه‌ای مثل best_fields، most_fields، phrase یا cross_fields.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

واژه `Term`

تابع واژه(field: رشته، value: رشته): رشته

یک مقدار دقیق، برای فیلدهای keyword.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

واژه عددی `TermInt`

تابع واژه عددی(field: رشته، value: صحیح۶۴): رشته

یک عدد دقیق.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

واژه منطقی `TermBool`

تابع واژه منطقی(field: رشته، value: منطقی): رشته

یک مقدار منطقی دقیق.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

واژه بدون حساسیت حروف `TermCaseInsensitive`

تابع واژه بدون حساسیت حروف(field: رشته، value: رشته): رشته

یک مقدار دقیق بدون توجه به بزرگی و کوچکی حروف.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

واژه‌ها `Terms`

تابع واژه‌ها(field: رشته، values: وکتور<رشته>): رشته

هر یک از این مقدارهای دقیق.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

واژه‌های عددی `TermsInt`

تابع واژه‌های عددی(field: رشته، values: وکتور<صحیح۶۴>): رشته

هر یک از این عددها.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

واژه‌های ارجاعی `TermsLookup`

تابع واژه‌های ارجاعی(field: رشته، index: رشته، id: رشته، path: رشته): رشته

هر یک از مقدارهای ذخیره‌شده در مسیری از سندی دیگر.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

مجموعه واژه‌ها `TermsSet`

تابع مجموعه واژه‌ها(field: رشته، values: وکتور<رشته>، minimum_field: رشته): رشته

دست‌کم به همان شماری از این مقدارها که فیلدی دیگر می‌گوید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

بازه `Range`

تابع بازه(field: رشته، low: رشته، high: رشته): رشته

بازه‌ای که به شکل متن داده شده، شامل دو سر؛ برای بازه‌ی باز یک سر را خالی بگذارید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

بازه باز `RangeExclusive`

تابع بازه باز(field: رشته، low: رشته، high: رشته): رشته

بازه‌ای که به شکل متن داده شده، بدون دو سر.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

بازه عددی `RangeNum`

تابع بازه عددی(field: رشته، low: اعشار۶۴، high: اعشار۶۴): رشته

بازه‌ای از عددهای اعشاری، شامل دو سر.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

بازه صحیح `RangeInt`

تابع بازه صحیح(field: رشته، low: صحیح۶۴، high: صحیح۶۴): رشته

بازه‌ای از عددهای صحیح، شامل دو سر.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

بازه با عملگر `RangeOp`

تابع بازه با عملگر(field: رشته، op: رشته، value: رشته): رشته

یک کران با عملگر: gt، gte، lt یا lte.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

بازه تاریخ `DateRange`

تابع بازه تاریخ(field: رشته، low: رشته، high: رشته، format: رشته، time_zone: رشته): رشته

بازه‌ی تاریخ با قالب و منطقه‌ی زمانی اختیاری؛ ریاضی تاریخ مثل now-7d/d کار می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

وجود فیلد `FieldExists`

تابع وجود فیلد(field: رشته): رشته

فیلد مقدار دارد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

پیشوند `Prefix`

تابع پیشوند(field: رشته، value: رشته): رشته

مقدار با این آغاز می‌شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

نویسه عام `Wildcard`

تابع نویسه عام(field: رشته، pattern: رشته): رشته

الگویی با * و ?.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

عبارت باقاعده `Regexp`

تابع عبارت باقاعده(field: رشته، pattern: رشته): رشته

یک عبارت باقاعده روی کل مقدار.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تقریبی `Fuzzy`

تابع تقریبی(field: رشته، value: رشته): رشته

مقداری نزدیک به این.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

شناسه‌ها `Ids`

تابع شناسه‌ها(ids: وکتور<رشته>): رشته

سندهایی با این شناسه‌ها.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

رشته پرسمان `QueryString`

تابع رشته پرسمان(query: رشته): رشته

یک رشته‌ی پرسمان لوسین، مثل title:salam AND year:1403.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

رشته پرسمان در فیلدها `QueryStringFields`

تابع رشته پرسمان در فیلدها(query: رشته، fields: وکتور<رشته>، default_operator: رشته): رشته

رشته‌ی پرسمانی روی فیلدهای داده‌شده با یک عملگر پیش‌فرض.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

رشته پرسمان ساده `SimpleQueryString`

تابع رشته پرسمان ساده(query: رشته، fields: وکتور<رشته>): رشته

رشته‌ی پرسمان باگذشتی که هرگز در تجزیه شکست نمی‌خورد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

پرسمان منطقی ساخته `BoolOf`

تابع پرسمان منطقی ساخته(q: پرسمان منطقی): رشته

پرسمان منطقی از یک پرسمان منطقی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

منطقی `Bool`

تابع منطقی(must: وکتور<رشته>، filter: وکتور<رشته>، should: وکتور<رشته>، must_not: وکتور<رشته>): رشته

پرسمان منطقی از چهار فهرست بند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

همه شرط‌ها `And`

تابع همه شرط‌ها(clauses: وکتور<رشته>): رشته

همه‌ی بندها باید تطبیق بخورند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

یکی از شرط‌ها `Or`

تابع یکی از شرط‌ها(clauses: وکتور<رشته>): رشته

دست‌کم یک بند باید تطبیق بخورد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

نقیض `Not`

تابع نقیض(clause: رشته): رشته

بند نباید تطبیق بخورد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

پالایش شده `Filtered`

تابع پالایش شده(query: رشته، filters: وکتور<رشته>): رشته

یک پرسمان به همراه پالایه‌هایی که امتیاز نمی‌دهند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

امتیاز ثابت `ConstantScore`

تابع امتیاز ثابت(filter: رشته، boost: اعشار۶۴): رشته

پالایه‌ای که در آن هر تطبیق امتیاز یکسان می‌گیرد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

بیشینه جداگانه `DisMax`

تابع بیشینه جداگانه(queries: وکتور<رشته>، tie_breaker: اعشار۶۴): رشته

بهترین امتیاز از چند پرسمان، به همراه سهمی از بقیه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تقویت `Boosting`

تابع تقویت(positive: رشته، negative: رشته، negative_boost: اعشار۶۴): رشته

امتیاز تطبیق‌های یک پرسمان منفی را به جای کنار گذاشتن پایین می‌آورد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تودرتو `Nested`

تابع تودرتو(path: رشته، query: رشته): رشته

پرسمانی روی شیءهای تودرتو.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

دارای فرزند `HasChild`

تابع دارای فرزند(child_type: رشته، query: رشته): رشته

والدهایی با فرزند منطبق، برای فیلدهای پیوند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

دارای والد `HasParent`

تابع دارای والد(parent_type: رشته، query: رشته): رشته

فرزندانی با والد منطبق، برای فیلدهای پیوند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

مشابه `MoreLikeThis`

تابع مشابه(fields: وکتور<رشته>، like: رشته): رشته

سندهایی مانند متن داده‌شده.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

پرسمان اسکریپت `ScriptQuery`

تابع پرسمان اسکریپت(source: رشته، params: رشته): رشته

سندهایی که اسکریپتی برایشان درست است.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

اسکریپت `Script`

تابع اسکریپت(source: رشته، params: رشته): رشته

یک اسکریپت painless با پارامترهای اختیاری به شکل JSON.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

امتیاز اسکریپتی `ScriptScore`

تابع امتیاز اسکریپتی(query: رشته، source: رشته، params: رشته): رشته

تطبیق‌های یک پرسمان را با اسکریپت امتیاز می‌دهد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

امتیاز تابعی `FunctionScore`

تابع امتیاز تابعی(query: رشته، functions: وکتور<رشته>، score_mode: رشته، boost_mode: رشته): رشته

امتیازهای یک پرسمان را با تابع‌هایی مثل ضریب مقدار فیلد تغییر می‌دهد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

ضریب مقدار فیلد `FieldValueFactor`

تابع ضریب مقدار فیلد(field: رشته، factor: اعشار۶۴، modifier: رشته): رشته

یک تابع امتیاز از یک فیلد عددی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

فاصله جغرافیایی `GeoDistance`

تابع فاصله جغرافیایی(field: رشته، lat: اعشار۶۴، lon: اعشار۶۴، distance: رشته): رشته

نقطه‌هایی در فاصله‌ای، مثل 5km، از یک مکان.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

کادر جغرافیایی `GeoBoundingBox`

تابع کادر جغرافیایی(field: رشته، top: اعشار۶۴، left: اعشار۶۴، bottom: اعشار۶۴، right: اعشار۶۴): رشته

نقطه‌هایی درون کادری که با بالا، چپ، پایین و راست داده شده.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

نزدیک‌ترین همسایه‌ها `Knn`

تابع نزدیک‌ترین همسایه‌ها(field: رشته، vector: وکتور<اعشار۶۴>، k: صحیح): رشته

k نزدیک‌ترین همسایه‌ی یک بردار، برای یک فیلد knn_vector.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

نزدیک‌ترین همسایه‌های پالایش شده `KnnFiltered`

تابع نزدیک‌ترین همسایه‌های پالایش شده(field: رشته، vector: وکتور<اعشار۶۴>، k: صحیح، filter: رشته): رشته

k نزدیک‌ترین همسایه در میان سندهایی که با پالایه‌ای تطبیق می‌خورند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

همسایه‌های شعاعی `KnnRadial`

تابع همسایه‌های شعاعی(field: رشته، vector: وکتور<اعشار۶۴>، max_distance: اعشار۶۴): رشته

همه‌ی همسایه‌ها در یک فاصله.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

همسایه‌ها با کمینه امتیاز `KnnMinScore`

تابع همسایه‌ها با کمینه امتیاز(field: رشته، vector: وکتور<اعشار۶۴>، min_score: اعشار۶۴): رشته

همه‌ی همسایه‌ها با دست‌کم این امتیاز.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

عصبی `Neural`

تابع عصبی(field: رشته، query_text: رشته، model_id: رشته، k: صحیح): رشته

جستجوی معنایی: سرور متن را با یک مدل به بردار تبدیل می‌کند؛ به افزونه‌ی جستجوی عصبی نیاز دارد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

عصبی پراکنده `NeuralSparse`

تابع عصبی پراکنده(field: رشته، query_text: رشته، model_id: رشته): رشته

جستجوی عصبی پراکنده با یک مدل.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

ترکیبی `Hybrid`

تابع ترکیبی(queries: وکتور<رشته>): رشته

چند پرسمان، معمولا یک تطبیق متنی و یک عصبی، را ترکیب می‌کند؛ با یک خط لوله‌ی جستجوی نرمال‌سازی اجرایش کنید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

مرتب صعودی `SortAsc`

تابع مرتب صعودی(field: رشته): رشته

مرتب‌سازی صعودی با یک فیلد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

مرتب نزولی `SortDesc`

تابع مرتب نزولی(field: رشته): رشته

مرتب‌سازی نزولی با یک فیلد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

مرتب‌سازی امتیازی `SortScore`

تابع مرتب‌سازی امتیازی(): رشته

مرتب‌سازی با امتیاز.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

مرتب‌سازی مکانی `SortGeo`

تابع مرتب‌سازی مکانی(field: رشته، lat: اعشار۶۴، lon: اعشار۶۴، unit: رشته): رشته

مرتب‌سازی با فاصله از یک مکان.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

برجسته‌سازی `Highlight`

تابع برجسته‌سازی(fields: وکتور<رشته>): رشته

تطبیق‌ها را در این فیلدها برجسته کن.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

برجسته‌سازی با برچسب `HighlightTags`

تابع برجسته‌سازی با برچسب(fields: وکتور<رشته>، pre: رشته، post: رشته): رشته

با برچسب‌های خودتان دور هر تطبیق برجسته کن.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

ادغام فیلدی `Collapse`

تابع ادغام فیلدی(field: رشته): رشته

برای هر مقدار یک فیلد فقط بهترین یافته را برگردان.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

پیشنهاد واژه `TermSuggest`

تابع پیشنهاد واژه(name: رشته، text: رشته، field: رشته): رشته

پیشنهاددهنده‌ای که واژه‌های یک متن را درست می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

پیشنهاد تکمیل `CompletionSuggest`

تابع پیشنهاد تکمیل(name: رشته، prefix: رشته، field: رشته، size: صحیح): رشته

پیشنهاددهنده‌ای که پیشوندی را از یک فیلد completion کامل می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تجمیع واژه‌ها `TermsAgg`

تابع تجمیع واژه‌ها(field: رشته، size: صحیح): رشته

سطل‌هایی برای رایج‌ترین مقدارهای یک فیلد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تجمیع میانگین `AvgAgg`

تابع تجمیع میانگین(field: رشته): رشته

میانگین یک فیلد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تجمیع جمع `SumAgg`

تابع تجمیع جمع(field: رشته): رشته

جمع یک فیلد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تجمیع کمینه `MinAgg`

تابع تجمیع کمینه(field: رشته): رشته

کوچک‌ترین مقدار یک فیلد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تجمیع بیشینه `MaxAgg`

تابع تجمیع بیشینه(field: رشته): رشته

بزرگ‌ترین مقدار یک فیلد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تجمیع شمار مقدار `ValueCountAgg`

تابع تجمیع شمار مقدار(field: رشته): رشته

یک فیلد چند مقدار دارد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تجمیع یکتاها `CardinalityAgg`

تابع تجمیع یکتاها(field: رشته): رشته

یک فیلد تقریبا چند مقدار یکتا دارد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تجمیع آمار `StatsAgg`

تابع تجمیع آمار(field: رشته): رشته

شمار، کمینه، بیشینه، میانگین و جمع یک فیلد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تجمیع آمار گسترده `ExtendedStatsAgg`

تابع تجمیع آمار گسترده(field: رشته): رشته

تجمیع آمار به همراه واریانس و انحراف معیار.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تجمیع صدک‌ها `PercentilesAgg`

تابع تجمیع صدک‌ها(field: رشته، percents: وکتور<اعشار۶۴>): رشته

صدک‌های داده‌شده‌ی یک فیلد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تجمیع هیستوگرام `HistogramAgg`

تابع تجمیع هیستوگرام(field: رشته، interval: اعشار۶۴): رشته

سطل‌هایی با پهنای عددی ثابت.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تجمیع هیستوگرام تاریخ `DateHistogramAgg`

تابع تجمیع هیستوگرام تاریخ(field: رشته، calendar_interval: رشته): رشته

سطل‌هایی با بازه‌ی تقویمی، مثل day یا month.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تجمیع بازه `RangeAgg`

تابع تجمیع بازه(field: رشته، bounds: وکتور<اعشار۶۴>): رشته

سطل‌هایی میان کران‌های داده‌شده، به همراه یکی زیر نخستین و یکی بالای آخرین.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تجمیع پالایه `FilterAgg`

تابع تجمیع پالایه(query: رشته): رشته

یک سطل از سندهایی که با پرسمانی تطبیق می‌خورند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تجمیع تودرتو `NestedAgg`

تابع تجمیع تودرتو(path: رشته): رشته

شیءهای تودرتو در یک مسیر را تجمیع می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تجمیع گمشده‌ها `MissingAgg`

تابع تجمیع گمشده‌ها(field: رشته): رشته

یک سطل از سندهایی که برای فیلدی مقدار ندارند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تجمیع برترین یافته‌ها `TopHitsAgg`

تابع تجمیع برترین یافته‌ها(size: صحیح): رشته

بهترین یافته‌ها در هر سطل.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

تجمیع ترکیبی `CompositeAgg`

تابع تجمیع ترکیبی(fields: وکتور<رشته>، size: صحیح): رشته

صفحه به صفحه از همه‌ی ترکیب‌های مقدارهای چند فیلد می‌گذرد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

افزودن تجمیع `AddAgg`

تابع افزودن تجمیع(aggs: رشته، name: رشته، agg: رشته): رشته

یک تجمیع نام‌دار به شیء تجمیع‌ها می‌افزاید؛ از {} آغاز کنید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

زیرتجمیع‌ها `SubAggs`

تابع زیرتجمیع‌ها(agg: رشته، aggs: رشته): رشته

تجمیع‌هایی را درون یک تجمیع سطلی می‌گذارد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

افزودن عضو `AddMember`

تابع افزودن عضو(obj: رشته، key: رشته، raw: رشته): رشته

عضوی به یک شیء JSON می‌افزاید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

بدنه جستجو `SearchBody`

تابع بدنه جستجو(req: درخواست جستجو): رشته

بدنه‌ی JSON یک درخواست جستجو.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

جستجو `Search`

تابع جستجو(c: کارخواه، index: رشته، query: رشته): نتیجه جستجو

پرسمانی را روی یک نمایه اجرا می‌کند؛ فهرست یا الگو هم کار می‌کند و نمایه‌ی خالی یعنی همه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

جستجو با درخواست `SearchWith`

تابع جستجو با درخواست(c: کارخواه، index: رشته، req: درخواست جستجو): نتیجه جستجو

یک درخواست کامل جستجو را اجرا می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

جستجوی خام `SearchRaw`

تابع جستجوی خام(c: کارخواه، index: رشته، body: رشته): نتیجه جستجو

جستجویی با بدنه‌ای که خودتان نوشته‌اید اجرا می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

جستجو با پارامتر `SearchParamsWith`

تابع جستجو با پارامتر(c: کارخواه، index: رشته، body: رشته، p: پارامترهای جستجو): نتیجه جستجو

یک بدنه‌ی جستجو را با تنظیمات نشانی، مثل یک خط لوله‌ی جستجو، اجرا می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

تجزیه جستجو `ParseSearch`

تابع تجزیه جستجو(body: رشته): نتیجه جستجو

پاسخ جستجویی را که در دست دارید می‌خواند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

جستجوی پیمایشی `SearchScroll`

تابع جستجوی پیمایشی(c: کارخواه، index: رشته، req: درخواست جستجو، keep_alive: رشته): نتیجه جستجو

پیمایشی را آغاز می‌کند: صفحه‌ی نخست و یک شناسه‌ی پیمایش.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

پیمایش `Scroll`

تابع پیمایش(c: کارخواه، scroll_id: رشته، keep_alive: رشته): نتیجه جستجو

صفحه‌ی بعدی یک پیمایش؛ صفحه‌ی خالی یعنی پایان.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

پاک‌سازی پیمایش `ClearScroll`

تابع پاک‌سازی پیمایش(c: کارخواه، scroll_id: رشته): منطقی

پیمایشی را روی سرور آزاد می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

ایجاد نقطه زمانی `CreatePit`

تابع ایجاد نقطه زمانی(c: کارخواه، index: رشته، keep_alive: رشته): رشته

یک نقطه‌ی زمانی روی نمایه‌ای باز می‌کند، برای صفحه‌بندی پایدار با search_after؛ شناسه‌اش را برمی‌گرداند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

حذف نقطه زمانی `DeletePit`

تابع حذف نقطه زمانی(c: کارخواه، pit_id: رشته): منطقی

یک نقطه‌ی زمانی را می‌بندد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

حذف همه نقطه‌های زمانی `DeleteAllPits`

تابع حذف همه نقطه‌های زمانی(c: کارخواه): منطقی

همه‌ی نقطه‌های زمانی را می‌بندد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

فهرست نقطه‌های زمانی `ListPits`

تابع فهرست نقطه‌های زمانی(c: کارخواه): وکتور<رشته>

شناسه‌ی همه‌ی نقطه‌های زمانی باز.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

جستجوی چندگانه `MSearch`

تابع جستجوی چندگانه(c: کارخواه، index: رشته، bodies: وکتور<رشته>): وکتور<نتیجه جستجو>

چند بدنه‌ی جستجو را در یک درخواست روی یک نمایه اجرا می‌کند؛ یک نتیجه برای هر بدنه، به همان ترتیب.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

جستجوی الگو `SearchTemplate`

تابع جستجوی الگو(c: کارخواه، index: رشته، template_id: رشته، params: رشته): نتیجه جستجو

یک الگوی جستجوی ذخیره‌شده را با پارامترها اجرا می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

جستجوی الگوی درون‌خطی `SearchInlineTemplate`

تابع جستجوی الگوی درون‌خطی(c: کارخواه، index: رشته، source: رشته، params: رشته): نتیجه جستجو

یک الگوی mustache داده‌شده به شکل JSON را با پارامترها اجرا می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

نمایش الگو `RenderTemplate`

تابع نمایش الگو(c: کارخواه، source: رشته، params: رشته): رشته

بدنه‌ی جستجویی که یک الگو با پارامترهای داده‌شده می‌سازد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

توضیح امتیاز `Explain`

تابع توضیح امتیاز(c: کارخواه، index: رشته، id: رشته، query: رشته): رشته

امتیاز یک سند برای یک پرسمان چگونه حساب شد، به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

اعتبارسنجی پرسمان `Validate`

تابع اعتبارسنجی پرسمان(c: کارخواه، index: رشته، query: رشته): منطقی

پرسمان برای نمایه معتبر است.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

توانایی فیلدها `FieldCaps`

تابع توانایی فیلدها(c: کارخواه، index: رشته، fields: وکتور<رشته>): رشته

هر فیلد در یک نمایه چه می‌تواند بکند، به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

سطل‌ها `Buckets`

تابع سطل‌ها(aggregations: رشته، name: رشته): وکتور<سطل>

سطل‌های یک تجمیع سطلی، فهرستی یا کلیددار.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

مقدار تجمیع `AggValue`

تابع مقدار تجمیع(aggregations: رشته، name: رشته): اعشار۶۴

مقدار یک تجمیع تک‌مقداری مثل avg.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

فیلد تجمیع `AggField`

تابع فیلد تجمیع(aggregations: رشته، name: رشته، field: رشته): اعشار۶۴

یک عدد نام‌دار از یک تجمیع، مثل max از stats.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

تجمیع خام `AggRaw`

تابع تجمیع خام(aggregations: رشته، name: رشته): رشته

یک تجمیع به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

پیشنهادها `Suggestions`

تابع پیشنهادها(suggest: رشته، name: رشته): وکتور<رشته>

متن‌هایی که یک پیشنهاددهنده پیشنهاد کرد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

مسیر جیسون `JsonPath`

تابع مسیر جیسون(text: رشته، path: رشته): رشته

مقداری در یک مسیر نقطه‌دار، با عدد برای اقلام آرایه، مثل hits.hits.0._id؛ رشته‌ها بی‌نقل‌قول برمی‌گردند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

مسیر خام جیسون `JsonPathRaw`

تابع مسیر خام جیسون(text: رشته، path: رشته): رشته

مقداری در یک مسیر نقطه‌دار به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

اقلام جیسون `JsonItems`

تابع اقلام جیسون(raw: رشته): وکتور<رشته>

اقلام یک آرایه‌ی JSON به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Search.salam

دریافت اطلاعات `GetInfo`

تابع دریافت اطلاعات(c: کارخواه): اطلاعات

آن‌چه خوشه درباره‌ی خودش می‌گوید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

پینگ `Ping`

تابع پینگ(c: کارخواه): منطقی

خوشه پاسخ می‌دهد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

سلامت خوشه `ClusterHealth`

تابع سلامت خوشه(c: کارخواه): سلامت

سلامت خوشه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

انتظار وضعیت `WaitForStatus`

تابع انتظار وضعیت(c: کارخواه، index: رشته، status: رشته، timeout: رشته): سلامت

صبر می‌کند تا خوشه، یا یک نمایه، به وضعیتی مثل yellow برسد یا مهلت سر برسد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

آمار خوشه `ClusterStats`

تابع آمار خوشه(c: کارخواه): رشته

آمار خوشه به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

حالت خوشه `ClusterState`

تابع حالت خوشه(c: کارخواه، metrics: رشته): رشته

حالت خوشه به شکل JSON خام، اگر بخواهید فقط برخی سنجه‌ها مثل metadata.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

دریافت تنظیمات خوشه `GetClusterSettings`

تابع دریافت تنظیمات خوشه(c: کارخواه): رشته

تنظیمات خوشه به شکل JSON خام، با نام‌های تخت.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

تنظیم تنظیمات خوشه `PutClusterSettings`

تابع تنظیم تنظیمات خوشه(c: کارخواه، persistent: رشته، transient: رشته): منطقی

تنظیمات ماندگار و گذرای خوشه را تغییر می‌دهد؛ برای دست نزدن به یکی رشته‌ی خالی بدهید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

توضیح تخصیص `AllocationExplain`

تابع توضیح تخصیص(c: کارخواه، body: رشته): رشته

چرا یک شارد تخصیص یافته یا نیافته، به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

اطلاعات گره‌ها `NodesInfo`

تابع اطلاعات گره‌ها(c: کارخواه، metrics: رشته): رشته

اطلاعات گره‌ها، اگر بخواهید فقط برخی سنجه‌ها.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

آمار گره‌ها `NodesStats`

تابع آمار گره‌ها(c: کارخواه، metrics: رشته): رشته

آمار گره‌ها، اگر بخواهید فقط برخی سنجه‌ها.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

نخ‌های پرکار `HotThreads`

تابع نخ‌های پرکار(c: کارخواه): رشته

پرکارترین نخ‌ها چه می‌کنند، به شکل متن.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

فهرست `Cat`

تابع فهرست(c: کارخواه، what: رشته): وکتور<رشته>

یک API فهرستی، مثل shards یا nodes، به شکل یک شیء JSON برای هر ردیف.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

فهرست متنی `CatText`

تابع فهرست متنی(c: کارخواه، what: رشته): رشته

یک API فهرستی به شکل جدول متنی هم‌ترازی که آدم‌ها می‌خوانند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

افزونه‌ها `Plugins`

تابع افزونه‌ها(c: کارخواه): وکتور<رشته>

افزونه‌های نصب‌شده روی خوشه، هر کدام یک بار.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

دارای افزونه `HasPlugin`

تابع دارای افزونه(c: کارخواه، name: رشته): منطقی

افزونه‌ای، مثل opensearch-knn، نصب است.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

دریافت کار `GetTask`

تابع دریافت کار(c: کارخواه، task_id: رشته): اطلاعات کار

یک کار پس‌زمینه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

انتظار کار `WaitTask`

تابع انتظار کار(c: کارخواه، task_id: رشته، timeout: رشته): اطلاعات کار

تا مهلتی صبر می‌کند تا کار پایان یابد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

لغو کار `CancelTask`

تابع لغو کار(c: کارخواه، task_id: رشته): منطقی

کاری را لغو می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

فهرست کارها `ListTasks`

تابع فهرست کارها(c: کارخواه، actions: رشته): رشته

کارهای در حال اجرا به شکل JSON خام، اگر بخواهید فقط کنش‌های منطبق با یک الگو.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

تنظیم مخزن `PutRepository`

تابع تنظیم مخزن(c: کارخواه، name: رشته، kind: رشته، settings: رشته): منطقی

یک مخزن تصویر لحظه‌ای از گونه‌ای مثل fs یا s3 ثبت می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

دریافت مخزن `GetRepository`

تابع دریافت مخزن(c: کارخواه، name: رشته): رشته

یک مخزن تصویر لحظه‌ای به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

وارسی مخزن `VerifyRepository`

تابع وارسی مخزن(c: کارخواه، name: رشته): منطقی

بررسی می‌کند که همه‌ی گره‌ها بتوانند مخزنی را به کار ببرند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

حذف مخزن `DeleteRepository`

تابع حذف مخزن(c: کارخواه، name: رشته): منطقی

مخزن تصویر لحظه‌ای را برمی‌دارد؛ تصویرها سر جای خود می‌مانند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

ایجاد تصویر لحظه‌ای `CreateSnapshot`

تابع ایجاد تصویر لحظه‌ای(c: کارخواه، repo: رشته، snapshot: رشته، indices: رشته، wait: منطقی): منطقی

از برخی نمایه‌ها، یا اگر خالی باشد همه، تصویر لحظه‌ای می‌گیرد؛ با wait درست فقط وقتی تصویر موفق بود درست است.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

دریافت تصویر لحظه‌ای `GetSnapshot`

تابع دریافت تصویر لحظه‌ای(c: کارخواه، repo: رشته، snapshot: رشته): رشته

یک تصویر لحظه‌ای به شکل JSON خام؛ الگو یا _all هم کار می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

تصویرهای لحظه‌ای `Snapshots`

تابع تصویرهای لحظه‌ای(c: کارخواه، repo: رشته): وکتور<رشته>

نام همه‌ی تصویرهای لحظه‌ای یک مخزن.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

وضعیت تصویر لحظه‌ای `SnapshotStatus`

تابع وضعیت تصویر لحظه‌ای(c: کارخواه، repo: رشته، snapshot: رشته): رشته

پیشرفت یک تصویر لحظه‌ای به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

حذف تصویر لحظه‌ای `DeleteSnapshot`

تابع حذف تصویر لحظه‌ای(c: کارخواه، repo: رشته، snapshot: رشته): منطقی

یک تصویر لحظه‌ای را حذف می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

بازیابی تصویر لحظه‌ای `RestoreSnapshot`

تابع بازیابی تصویر لحظه‌ای(c: کارخواه، repo: رشته، snapshot: رشته، body: رشته، wait: منطقی): منطقی

یک تصویر لحظه‌ای را با بدنه‌ی بازیابی، مثل کدام نمایه‌ها و چگونه تغییر نام بدهند، بازیابی می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

تنظیم خط لوله `PutPipeline`

تابع تنظیم خط لوله(c: کارخواه، id: رشته، body: رشته): منطقی

یک خط لوله‌ی ورودی می‌سازد یا جایگزین می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

خط لوله `Pipeline`

تابع خط لوله(description: رشته، processors: وکتور<رشته>): رشته

بدنه‌ی خط لوله‌ی ورودی از یک توضیح و چند پردازنده.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

پردازنده `Processor`

تابع پردازنده(kind: رشته، config: رشته): رشته

یک پردازنده‌ی ورودی، مثل پردازنده("lowercase"، `{"field":"tag"}`).

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

دریافت خط لوله `GetPipeline`

تابع دریافت خط لوله(c: کارخواه، id: رشته): رشته

یک خط لوله‌ی ورودی به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

حذف خط لوله `DeletePipeline`

تابع حذف خط لوله(c: کارخواه، id: رشته): منطقی

یک خط لوله‌ی ورودی را حذف می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

شبیه‌سازی خط لوله `SimulatePipeline`

تابع شبیه‌سازی خط لوله(c: کارخواه، id: رشته، docs: وکتور<رشته>): وکتور<رشته>

سندها را بدون ذخیره از خط لوله می‌گذراند؛ منبع هر نتیجه را برمی‌گرداند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

تنظیم اسکریپت `PutScript`

تابع تنظیم اسکریپت(c: کارخواه، id: رشته، source: رشته): منطقی

یک اسکریپت painless را زیر یک شناسه ذخیره می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

تنظیم الگوی جستجو `PutSearchTemplate`

تابع تنظیم الگوی جستجو(c: کارخواه، id: رشته، source: رشته): منطقی

یک الگوی جستجوی mustache را زیر یک شناسه ذخیره می‌کند، برای جستجوی الگو.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

دریافت اسکریپت `GetScript`

تابع دریافت اسکریپت(c: کارخواه، id: رشته): رشته

منبع یک اسکریپت یا الگوی ذخیره‌شده.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

حذف اسکریپت `DeleteScript`

تابع حذف اسکریپت(c: کارخواه، id: رشته): منطقی

یک اسکریپت یا الگوی ذخیره‌شده را حذف می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-ClusterHealth.salam

تنظیمات نمایه همسایه‌یابی `KnnIndexSettings`

تابع تنظیمات نمایه همسایه‌یابی(shards: صحیح، replicas: صحیح): رشته

تنظیمات نمایه با k-NN روشن؛ ۰ شارد یا ۱- نسخه آن تنظیم را کنار می‌گذارد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Knn.salam

فیلد بردار همسایه‌یابی `KnnVectorField`

تابع فیلد بردار همسایه‌یابی(dimension: صحیح، method: روش همسایه‌یابی): رشته

نگاشت یک فیلد knn_vector.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Knn.salam

بدنه نمایه همسایه‌یابی `KnnIndexBody`

تابع بدنه نمایه همسایه‌یابی(field: رشته، dimension: صحیح، method: روش همسایه‌یابی، extra_properties: وکتور<رشته>): رشته

یک بدنه‌ی کامل نمایه با k-NN روشن، یک فیلد بردار و ویژگی‌های بیشتر.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Knn.salam

بردار همسایه‌یابی `KnnVector`

تابع بردار همسایه‌یابی(values: وکتور<اعشار۶۴>): رشته

یک بردار به شکل آرایه‌ی JSON.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Query.salam

آمار همسایه‌یابی `KnnStats`

تابع آمار همسایه‌یابی(c: کارخواه): رشته

آمار افزونه‌ی k-NN به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Knn.salam

گرم‌کردن همسایه‌یابی `KnnWarmup`

تابع گرم‌کردن همسایه‌یابی(c: کارخواه، index: رشته): منطقی

نمایه‌های برداری یک نمایه را پیش از نخستین جستجو در حافظه بار می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Knn.salam

پاک‌سازی حافظه همسایه‌یابی `KnnClearCache`

تابع پاک‌سازی حافظه همسایه‌یابی(c: کارخواه، index: رشته): منطقی

نمایه‌های برداری یک نمایه را از حافظه بیرون می‌اندازد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Knn.salam

آموزش مدل همسایه‌یابی `KnnTrainModel`

تابع آموزش مدل همسایه‌یابی(c: کارخواه، model_id: رشته، body: رشته): منطقی

یک مدل k-NN، مثلا برای IVF یا PQ، آموزش می‌دهد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Knn.salam

دریافت مدل همسایه‌یابی `KnnGetModel`

تابع دریافت مدل همسایه‌یابی(c: کارخواه، model_id: رشته): رشته

یک مدل آموزش‌دیده‌ی k-NN به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Knn.salam

حذف مدل همسایه‌یابی `KnnDeleteModel`

تابع حذف مدل همسایه‌یابی(c: کارخواه، model_id: رشته): منطقی

یک مدل k-NN را حذف می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Knn.salam

تنظیم سیاست `PutPolicy`

تابع تنظیم سیاست(c: کارخواه، id: رشته، policy: رشته): منطقی

یک سیاست ISM می‌سازد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

به‌روزرسانی سیاست `UpdatePolicy`

تابع به‌روزرسانی سیاست(c: کارخواه، id: رشته، policy: رشته، seq_no: صحیح۶۴، primary_term: صحیح۶۴): منطقی

یک سیاست ISM را با شماره‌ی ترتیب و دوره‌ی اصلی سیاست جاری جایگزین می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

دریافت سیاست `GetPolicy`

تابع دریافت سیاست(c: کارخواه، id: رشته): رشته

یک سیاست ISM به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

حذف سیاست `DeletePolicy`

تابع حذف سیاست(c: کارخواه، id: رشته): منطقی

یک سیاست ISM را حذف می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

افزودن سیاست `AddPolicy`

تابع افزودن سیاست(c: کارخواه، index: رشته، policy_id: رشته): صحیح

نمایه‌هایی را زیر یک سیاست می‌برد؛ شمارشان را برمی‌گرداند و هنگام شکست ۱-.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

برداشتن سیاست `RemovePolicy`

تابع برداشتن سیاست(c: کارخواه، index: رشته): صحیح

نمایه‌ها را از سیاستشان بیرون می‌آورد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

تغییر سیاست `ChangePolicy`

تابع تغییر سیاست(c: کارخواه، index: رشته، policy_id: رشته، state: رشته): صحیح

نمایه‌ها را به سیاستی دیگر می‌برد، اگر بخواهید با آغاز از حالتی معین.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

تلاش دوباره سیاست `RetryPolicy`

تابع تلاش دوباره سیاست(c: کارخواه، index: رشته): صحیح

گام ناموفق یک سیاست را دوباره می‌آزماید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

توضیح سیاست `ExplainPolicy`

تابع توضیح سیاست(c: کارخواه، index: رشته): رشته

نمایه‌ها کجای سیاستشان هستند، به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

شناسه سیاست نمایه `PolicyIdOf`

تابع شناسه سیاست نمایه(c: کارخواه، index: رشته): رشته

شناسه‌ی سیاستی که یک نمایه زیر آن است.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

سیاست حذف پس از `DeleteAfterPolicy`

تابع سیاست حذف پس از(description: رشته، min_index_age: رشته، patterns: وکتور<رشته>): رشته

سیاستی که نمایه را وقتی از سنی مثل 30d پیرتر شد حذف می‌کند؛ با الگوها خودش روی نمایه‌های تازه‌ی منطبق هم اعمال می‌شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

من کیستم `WhoAmI`

تابع من کیستم(c: کارخواه): اطلاعات احراز

افزونه‌ی امنیت می‌گوید شما کیستید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

سلامت امنیت `SecurityHealth`

تابع سلامت امنیت(c: کارخواه): رشته

وضعیت افزونه‌ی امنیت، مثل UP.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

تنظیم کاربر `PutUser`

تابع تنظیم کاربر(c: کارخواه، name: رشته، password: رشته، backend_roles: وکتور<رشته>، attributes: رشته): منطقی

یک کاربر درونی با نقش‌های پشتیبان و ویژگی‌هایی به شکل JSON می‌سازد یا جایگزین می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

دریافت کاربر `GetUser`

تابع دریافت کاربر(c: کارخواه، name: رشته): رشته

یک کاربر درونی به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

کاربران `Users`

تابع کاربران(c: کارخواه): وکتور<رشته>

نام همه‌ی کاربران درونی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

حذف کاربر `DeleteUser`

تابع حذف کاربر(c: کارخواه، name: رشته): منطقی

یک کاربر درونی را حذف می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

تغییر گذرواژه `ChangePassword`

تابع تغییر گذرواژه(c: کارخواه، current: رشته، password: رشته): منطقی

گذرواژه‌ی کاربری را که کارخواه با آن وارد شده تغییر می‌دهد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

بدنه نقش `RoleBody`

تابع بدنه نقش(cluster_permissions: وکتور<رشته>، index_patterns: وکتور<رشته>، allowed_actions: وکتور<رشته>): رشته

بدنه‌ی یک نقش از مجوزهای خوشه، الگوهای نمایه و کنش‌های مجاز روی آن‌ها.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

تنظیم نقش `PutRole`

تابع تنظیم نقش(c: کارخواه، name: رشته، body: رشته): منطقی

یک نقش می‌سازد یا جایگزین می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

دریافت نقش `GetRole`

تابع دریافت نقش(c: کارخواه، name: رشته): رشته

یک نقش به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

حذف نقش `DeleteRole`

تابع حذف نقش(c: کارخواه، name: رشته): منطقی

یک نقش را حذف می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

تنظیم نگاشت نقش `PutRoleMapping`

تابع تنظیم نگاشت نقش(c: کارخواه، role: رشته، users: وکتور<رشته>، backend_roles: وکتور<رشته>): منطقی

نقشی را به کاربران و نقش‌های پشتیبان می‌دهد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

دریافت نگاشت نقش `GetRoleMapping`

تابع دریافت نگاشت نقش(c: کارخواه، role: رشته): رشته

یک نگاشت نقش به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

حذف نگاشت نقش `DeleteRoleMapping`

تابع حذف نگاشت نقش(c: کارخواه، role: رشته): منطقی

یک نگاشت نقش را حذف می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

تنظیم خط لوله جستجو `PutSearchPipeline`

تابع تنظیم خط لوله جستجو(c: کارخواه، id: رشته، body: رشته): منطقی

یک خط لوله‌ی جستجو می‌سازد یا جایگزین می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Knn.salam

دریافت خط لوله جستجو `GetSearchPipeline`

تابع دریافت خط لوله جستجو(c: کارخواه، id: رشته): رشته

یک خط لوله‌ی جستجو به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Knn.salam

حذف خط لوله جستجو `DeleteSearchPipeline`

تابع حذف خط لوله جستجو(c: کارخواه، id: رشته): منطقی

یک خط لوله‌ی جستجو را حذف می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Knn.salam

خط لوله نرمال‌سازی `NormalizationPipeline`

تابع خط لوله نرمال‌سازی(normalization: رشته، combination: رشته، weights: وکتور<اعشار۶۴>): رشته

بدنه‌ی خط لوله‌ی جستجو برای جستجوی ترکیبی: یک روش نرمال‌سازی مثل min_max، یک روش ترکیب مثل arithmetic_mean و وزن‌های اختیاری.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Knn.salam

ایجاد پایشگر `CreateMonitor`

تابع ایجاد پایشگر(c: کارخواه، body: رشته): رشته

یک پایشگر هشدار می‌سازد؛ شناسه‌اش را برمی‌گرداند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

دریافت پایشگر `GetMonitor`

تابع دریافت پایشگر(c: کارخواه، id: رشته): رشته

یک پایشگر به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

به‌روزرسانی پایشگر `UpdateMonitor`

تابع به‌روزرسانی پایشگر(c: کارخواه، id: رشته، body: رشته): منطقی

یک پایشگر را جایگزین می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

حذف پایشگر `DeleteMonitor`

تابع حذف پایشگر(c: کارخواه، id: رشته): منطقی

یک پایشگر را حذف می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

اجرای پایشگر `ExecuteMonitor`

تابع اجرای پایشگر(c: کارخواه، id: رشته، dry_run: منطقی): رشته

پایشگری را همین حالا، اگر بخواهید به شکل آزمایشی، اجرا می‌کند؛ نتیجه را به شکل JSON خام برمی‌گرداند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

جستجوی پایشگرها `SearchMonitors`

تابع جستجوی پایشگرها(c: کارخواه، query: رشته): نتیجه جستجو

در پایشگرها جستجو می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-PutPolicy.salam

ثبت مدل یادگیری `MlRegisterModel`

تابع ثبت مدل یادگیری(c: کارخواه، body: رشته): رشته

یک مدل ML Commons را ثبت می‌کند؛ شناسه‌ی کار را برمی‌گرداند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Knn.salam

استقرار مدل یادگیری `MlDeployModel`

تابع استقرار مدل یادگیری(c: کارخواه، model_id: رشته): رشته

یک مدل را مستقر می‌کند؛ شناسه‌ی کار را برمی‌گرداند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Knn.salam

برچیدن مدل یادگیری `MlUndeployModel`

تابع برچیدن مدل یادگیری(c: کارخواه، model_id: رشته): منطقی

استقرار یک مدل را برمی‌چیند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Knn.salam

دریافت مدل یادگیری `MlGetModel`

تابع دریافت مدل یادگیری(c: کارخواه، model_id: رشته): رشته

یک مدل به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Knn.salam

حذف مدل یادگیری `MlDeleteModel`

تابع حذف مدل یادگیری(c: کارخواه، model_id: رشته): منطقی

یک مدل را حذف می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Knn.salam

دریافت کار یادگیری `MlGetTask`

تابع دریافت کار یادگیری(c: کارخواه، task_id: رشته): رشته

یک کار یادگیری ماشین به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Knn.salam

پیش‌بینی مدل `MlPredict`

تابع پیش‌بینی مدل(c: کارخواه، algorithm: رشته، model_id: رشته، body: رشته): رشته

مدلی، مثل text_embedding، را روی ورودی‌ای به شکل JSON اجرا می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Knn.salam

ایجاد نمایه `CreateIndex`

تابع ایجاد نمایه(c: کارخواه، name: رشته، body: رشته): منطقی

نمایه‌ای با بدنه‌ی تنظیمات و نگاشت می‌سازد؛ بدنه‌ی خالی پیش‌فرض‌ها را به کار می‌برد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

ایجاد نمایه با تنظیمات `CreateIndexWith`

تابع ایجاد نمایه با تنظیمات(c: کارخواه، name: رشته، shards: صحیح، replicas: صحیح، properties: رشته): منطقی

نمایه‌ای از شمار شارد و نسخه‌ی تکراری و ویژگی‌های نگاشت می‌سازد؛ ۰ شارد یا ۱- نسخه آن تنظیم را کنار می‌گذارد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

حذف نمایه `DeleteIndex`

تابع حذف نمایه(c: کارخواه، name: رشته): منطقی

نمایه‌ای را حذف می‌کند؛ فهرست یا الگو هم کار می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

حذف نمایه موجود `DeleteIndexIfExists`

تابع حذف نمایه موجود(c: کارخواه، name: رشته): منطقی

نمایه‌ای را حذف می‌کند و وقتی وجود نداشت هم درست است.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

وجود نمایه `IndexExists`

تابع وجود نمایه(c: کارخواه، name: رشته): منطقی

نمایه وجود دارد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

دریافت نمایه `GetIndex`

تابع دریافت نمایه(c: کارخواه، name: رشته): رشته

تنظیمات، نگاشت و نام‌های مستعار یک نمایه به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

دریافت نگاشت `GetMapping`

تابع دریافت نگاشت(c: کارخواه، index: رشته): رشته

نگاشت به شکل JSON خام؛ نمایه‌ی خالی یعنی همه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

تنظیم نگاشت `PutMapping`

تابع تنظیم نگاشت(c: کارخواه، index: رشته، properties: رشته): منطقی

فیلدهایی را که به شکل عضوهای properties داده شده‌اند به نگاشت می‌افزاید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

تنظیم نگاشت با بدنه `PutMappingBody`

تابع تنظیم نگاشت با بدنه(c: کارخواه، index: رشته، body: رشته): منطقی

نگاشت را با یک بدنه‌ی کامل تغییر می‌دهد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

دریافت تنظیمات `GetSettings`

تابع دریافت تنظیمات(c: کارخواه، index: رشته): رشته

تنظیمات به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

دریافت یک تنظیم `GetSetting`

تابع دریافت یک تنظیم(c: کارخواه، index: رشته، name: رشته): رشته

یک تنظیم یک نمایه، مثل index.refresh_interval.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

تنظیم تنظیمات `PutSettings`

تابع تنظیم تنظیمات(c: کارخواه، index: رشته، settings: رشته): منطقی

تنظیمات نمایه را تغییر می‌دهد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

تازه‌سازی `Refresh`

تابع تازه‌سازی(c: کارخواه، index: رشته): منطقی

نوشته‌های تازه را قابل جستجو می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

تخلیه `Flush`

تابع تخلیه(c: کارخواه، index: رشته): منطقی

گزارش تراکنش را روی دیسک می‌نویسد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

ادغام اجباری `ForceMerge`

تابع ادغام اجباری(c: کارخواه، index: رشته، max_segments: صحیح): منطقی

بخش‌ها را ادغام می‌کند، اگر عدد بیشتر از ۰ باشد تا همان شمار.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

پاک‌سازی حافظه نهان `ClearCache`

تابع پاک‌سازی حافظه نهان(c: کارخواه، index: رشته): منطقی

حافظه‌های نهان یک نمایه را پاک می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

گشودن نمایه `OpenIndex`

تابع گشودن نمایه(c: کارخواه، index: رشته): منطقی

نمایه‌ی بسته‌ای را باز می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

بستن نمایه `CloseIndex`

تابع بستن نمایه(c: کارخواه، index: رشته): منطقی

نمایه‌ای را می‌بندد؛ داده‌هایش می‌ماند ولی خواندن و نوشتن نمی‌پذیرد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

همسان‌سازی نمایه `CloneIndex`

تابع همسان‌سازی نمایه(c: کارخواه، source: رشته، target: رشته، body: رشته): منطقی

نمایه‌ای را که نوشتنش بسته شده در نمایه‌ای تازه رونوشت می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

کوچک‌سازی نمایه `ShrinkIndex`

تابع کوچک‌سازی نمایه(c: کارخواه، source: رشته، target: رشته، body: رشته): منطقی

نمایه‌ای را در نمایه‌ای با شاردهای کمتر رونوشت می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

شکافتن نمایه `SplitIndex`

تابع شکافتن نمایه(c: کارخواه، source: رشته، target: رشته، body: رشته): منطقی

نمایه‌ای را در نمایه‌ای با شاردهای بیشتر رونوشت می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

آمار نمایه `IndexStats`

تابع آمار نمایه(c: کارخواه، index: رشته): رشته

آمار یک نمایه به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

افزودن نام مستعار `PutAlias`

تابع افزودن نام مستعار(c: کارخواه، index: رشته، alias: رشته): منطقی

نام مستعاری را به نمایه‌ای نشانه می‌رود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

افزودن نام مستعار پالایش شده `PutAliasFiltered`

تابع افزودن نام مستعار پالایش شده(c: کارخواه، index: رشته، alias: رشته، filter: رشته، is_write_index: منطقی): منطقی

نام مستعاری با پالایه به نمایه‌ای نشانه می‌رود و اگر بخواهید آن را نمایه‌ی نوشتن می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

حذف نام مستعار `DeleteAlias`

تابع حذف نام مستعار(c: کارخواه، index: رشته، alias: رشته): منطقی

نام مستعاری را از نمایه‌ای برمی‌دارد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

وجود نام مستعار `AliasExists`

تابع وجود نام مستعار(c: کارخواه، alias: رشته): منطقی

نام مستعار وجود دارد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

دریافت نام‌های مستعار `GetAliases`

تابع دریافت نام‌های مستعار(c: کارخواه، index: رشته): رشته

نام‌های مستعار یک نمایه، یا همه، به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

نمایه‌های نام مستعار `AliasIndices`

تابع نمایه‌های نام مستعار(c: کارخواه، alias: رشته): وکتور<رشته>

نمایه‌هایی که نام مستعار به آن‌ها نشانه می‌رود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

کنش نام مستعار `AliasAction`

تابع کنش نام مستعار(action: رشته، index: رشته، alias: رشته): رشته

یک کنش add یا remove برای به‌روزرسانی نام‌های مستعار.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

به‌روزرسانی نام‌های مستعار `UpdateAliases`

تابع به‌روزرسانی نام‌های مستعار(c: کارخواه، actions: وکتور<رشته>): منطقی

چند کنش نام مستعار را در یک گام یکپارچه اعمال می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

جابجایی نام مستعار `SwapAlias`

تابع جابجایی نام مستعار(c: کارخواه، alias: رشته، old_index: رشته، new_index: رشته): منطقی

نام مستعاری را در یک گام یکپارچه از نمایه‌ای به نمایه‌ی دیگر می‌برد؛ راه بازسازی نمایه بدون توقف.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

تنظیم الگوی نمایه `PutIndexTemplate`

تابع تنظیم الگوی نمایه(c: کارخواه، name: رشته، body: رشته): منطقی

یک الگوی نمایه می‌سازد یا جایگزین می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

الگوی نمایه `IndexTemplate`

تابع الگوی نمایه(patterns: وکتور<رشته>، settings: رشته، properties: رشته، priority: صحیح): رشته

بدنه‌ی الگوی نمایه از الگوها، تنظیمات، ویژگی‌های نگاشت و اولویت.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

دریافت الگوی نمایه `GetIndexTemplate`

تابع دریافت الگوی نمایه(c: کارخواه، name: رشته): رشته

یک الگوی نمایه به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

وجود الگوی نمایه `IndexTemplateExists`

تابع وجود الگوی نمایه(c: کارخواه، name: رشته): منطقی

الگوی نمایه وجود دارد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

حذف الگوی نمایه `DeleteIndexTemplate`

تابع حذف الگوی نمایه(c: کارخواه، name: رشته): منطقی

یک الگوی نمایه را حذف می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

تنظیم الگوی جزء `PutComponentTemplate`

تابع تنظیم الگوی جزء(c: کارخواه، name: رشته، body: رشته): منطقی

یک الگوی جزء می‌سازد یا جایگزین می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

دریافت الگوی جزء `GetComponentTemplate`

تابع دریافت الگوی جزء(c: کارخواه، name: رشته): رشته

یک الگوی جزء به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

حذف الگوی جزء `DeleteComponentTemplate`

تابع حذف الگوی جزء(c: کارخواه، name: رشته): منطقی

یک الگوی جزء را حذف می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

ایجاد جریان داده `CreateDataStream`

تابع ایجاد جریان داده(c: کارخواه، name: رشته): منطقی

یک جریان داده می‌سازد؛ باید یک الگوی نمایه‌ی منطبق با data_stream وجود داشته باشد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

حذف جریان داده `DeleteDataStream`

تابع حذف جریان داده(c: کارخواه، name: رشته): منطقی

یک جریان داده و نمایه‌های پشتیبانش را حذف می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

جریان‌های داده `DataStreams`

تابع جریان‌های داده(c: کارخواه): وکتور<رشته>

نام همه‌ی جریان‌های داده.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

چرخش نمایه `Rollover`

تابع چرخش نمایه(c: کارخواه، alias: رشته، conditions: رشته): رشته

نام مستعار یا جریان داده را به نمایه‌ای تازه می‌چرخاند، اگر بخواهید فقط وقتی شرط‌ها برقرارند؛ نام نمایه‌ی تازه را برمی‌گرداند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

تحلیل متن `Analyze`

تابع تحلیل متن(c: کارخواه، index: رشته، analyzer: رشته، text: رشته): وکتور<رشته>

واژه‌هایی که یک تحلیلگر از یک متن می‌سازد؛ تحلیلگر خالی یعنی standard.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

فهرست نمایه‌ها `CatIndices`

تابع فهرست نمایه‌ها(c: کارخواه، pattern: رشته): وکتور<اطلاعات نمایه>

یک ردیف برای هر نمایه، مرتب با نام؛ الگوی خالی یعنی همه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

ویژگی `Property`

تابع ویژگی(name: رشته، kind: رشته): رشته

یک فیلد نگاشت، "name":{"type":kind}، برای ویژگی‌ها.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

ویژگی با گزینه `PropertyWith`

تابع ویژگی با گزینه(name: رشته، kind: رشته، extra: رشته): رشته

یک فیلد نگاشت با تنظیمات بیشتر، مثل یک تحلیلگر.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

ویژگی‌ها `Properties`

تابع ویژگی‌ها(props: وکتور<رشته>): رشته

شیء ویژگی‌های نگاشت از چند فیلد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-CreateIndex.salam

نمایه‌سازی `Index`

تابع نمایه‌سازی(c: کارخواه، index: رشته، id: رشته، doc: رشته): نتیجه نوشتن

سندی را می‌افزاید یا جایگزین می‌کند؛ شناسه‌ی خالی یعنی سرور یکی بسازد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

نمایه‌سازی با گزینه `IndexWith`

تابع نمایه‌سازی با گزینه(c: کارخواه، index: رشته، id: رشته، doc: رشته، o: گزینه‌ها): نتیجه نوشتن

نمایه‌سازی با گزینه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

ایجاد سند `Create`

تابع ایجاد سند(c: کارخواه، index: رشته، id: رشته، doc: رشته): نتیجه نوشتن

سندی را فقط اگر سندی با آن شناسه نباشد می‌افزاید؛ در غیر این صورت 409.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

ایجاد سند با گزینه `CreateWith`

تابع ایجاد سند با گزینه(c: کارخواه، index: رشته، id: رشته، doc: رشته، o: گزینه‌ها): نتیجه نوشتن

ایجاد سند با گزینه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

دریافت `Get`

تابع دریافت(c: کارخواه، index: رشته، id: رشته): سند

سندی را با شناسه می‌خواند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

دریافت فیلدها `GetFields`

تابع دریافت فیلدها(c: کارخواه، index: رشته، id: رشته، includes: وکتور<رشته>، routing: رشته): سند

فقط برخی فیلدهای منبع یک سند را می‌خواند، اگر بخواهید با مقدار مسیریابی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

دریافت منبع `GetSource`

تابع دریافت منبع(c: کارخواه، index: رشته، id: رشته): رشته

فقط منبع یک سند؛ اگر نباشد خالی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

وجود سند `Exists`

تابع وجود سند(c: کارخواه، index: رشته، id: رشته): منطقی

سند وجود دارد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

به‌روزرسانی `Update`

تابع به‌روزرسانی(c: کارخواه، index: رشته، id: رشته، partial: رشته): نتیجه نوشتن

فیلدهای داده‌شده را در یک سند ادغام می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

به‌روزرسانی با گزینه `UpdateWith`

تابع به‌روزرسانی با گزینه(c: کارخواه، index: رشته، id: رشته، body: رشته، o: گزینه‌ها): نتیجه نوشتن

یک بدنه‌ی کامل به‌روزرسانی، مثل {"doc":...} یا {"script":...}، را با گزینه می‌فرستد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

به‌روزرسانی درجی `Upsert`

تابع به‌روزرسانی درجی(c: کارخواه، index: رشته، id: رشته، doc: رشته): نتیجه نوشتن

فیلدها را در یک سند ادغام می‌کند و اگر سند نباشد آن را می‌سازد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

به‌روزرسانی اسکریپتی `UpdateScript`

تابع به‌روزرسانی اسکریپتی(c: کارخواه، index: رشته، id: رشته، script: رشته، upsert: رشته): نتیجه نوشتن

سندی را با اسکریپتی از اسکریپت تغییر می‌دهد؛ سند درجی، اگر داده شود، وقتی سند نیست به کار می‌رود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

حذف سند `Delete`

تابع حذف سند(c: کارخواه، index: رشته، id: رشته): نتیجه نوشتن

سندی را حذف می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

حذف سند با گزینه `DeleteWith`

تابع حذف سند با گزینه(c: کارخواه، index: رشته، id: رشته، o: گزینه‌ها): نتیجه نوشتن

حذف سند با گزینه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

دریافت چندگانه `MGet`

تابع دریافت چندگانه(c: کارخواه، index: رشته، ids: وکتور<رشته>): وکتور<سند>

چند سند از یک نمایه را یک‌جا و به همان ترتیب خواسته‌شده می‌خواند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

شمارش `Count`

تابع شمارش(c: کارخواه، index: رشته، query: رشته): صحیح۶۴

چند سند با پرسمانی تطبیق می‌خورند؛ پرسمان خالی همه را می‌شمارد و هنگام خطا ۱- است.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

حذف پرسمانی `DeleteByQuery`

تابع حذف پرسمانی(c: کارخواه، index: رشته، query: رشته): نتیجه پرسمانی

هر سندی را که با پرسمانی تطبیق بخورد حذف می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

حذف پرسمانی با گزینه `DeleteByQueryWith`

تابع حذف پرسمانی با گزینه(c: کارخواه، index: رشته، query: رشته، o: گزینه‌ها): نتیجه پرسمانی

حذف پرسمانی با گزینه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

به‌روزرسانی پرسمانی `UpdateByQuery`

تابع به‌روزرسانی پرسمانی(c: کارخواه، index: رشته، query: رشته، script: رشته): نتیجه پرسمانی

اسکریپتی را روی هر سندی که با پرسمانی تطبیق بخورد اجرا می‌کند؛ پرسمان خالی یعنی همه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

به‌روزرسانی پرسمانی با گزینه `UpdateByQueryWith`

تابع به‌روزرسانی پرسمانی با گزینه(c: کارخواه، index: رشته، query: رشته، script: رشته، o: گزینه‌ها): نتیجه پرسمانی

به‌روزرسانی پرسمانی با گزینه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

نمایه‌سازی دوباره `Reindex`

تابع نمایه‌سازی دوباره(c: کارخواه، source: رشته، dest: رشته): نتیجه پرسمانی

همه‌ی سندهای یک نمایه را در نمایه‌ای دیگر رونوشت می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

نمایه‌سازی دوباره با بدنه `ReindexBody`

تابع نمایه‌سازی دوباره با بدنه(c: کارخواه، body: رشته، wait: منطقی): نتیجه پرسمانی

با یک بدنه‌ی کامل دوباره نمایه‌سازی می‌کند؛ اگر wait نادرست باشد بی‌درنگ با شناسه‌ی کار برمی‌گردد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Index.salam

پیکربندی پیش‌فرض `DefaultConfig`

تابع پیکربندی پیش‌فرض(): پیکربندی

پیکربندی‌ای با گره‌ی پیش‌فرض، آماده‌ی تغییر.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

کارخواه تازه `NewClient`

تابع کارخواه تازه(cfg: پیکربندی): کارخواه

از یک پیکربندی کارخواه می‌سازد؛ با معتبر بررسی‌اش کنید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

اتصال `Connect`

تابع اتصال(url: رشته): کارخواه

کارخواهی برای نشانی یک گره؛ نشانی می‌تواند user:password@ داشته باشد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

اتصال با رمز `ConnectAuth`

تابع اتصال با رمز(url: رشته، username: رشته، password: رشته): کارخواه

کارخواهی برای یک گره با احراز هویت پایه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

اتصال بدون وارسی گواهی `ConnectInsecure`

تابع اتصال بدون وارسی گواهی(url: رشته، username: رشته، password: رشته): کارخواه

کارخواهی که گواهی سرور را وارسی نمی‌کند؛ فقط برای راه‌اندازی نمایشی و سرورهای آزمایشی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

اتصال آمازون `ConnectAWS`

تابع اتصال آمازون(url: رشته، region: رشته، service: رشته، access_key: رشته، secret_key: رشته، session_token: رشته): کارخواه

کارخواهی که هر درخواست را با AWS SigV4 امضا می‌کند، برای Amazon OpenSearch Service یا Serverless.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

معتبر `Ok`

تابع معتبر(c: کارخواه): منطقی

پیکربندی معتبر بود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

خطا `Error`

تابع خطا(c: کارخواه): رشته

خطای آخرین درخواست، یا خطای پیکربندی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

نوع خطا `ErrorType`

تابع نوع خطا(c: کارخواه): رشته

نوع خطای سرور در آخرین درخواست.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

علت خطا `ErrorReason`

تابع علت خطا(c: کارخواه): رشته

علت خطای سرور در آخرین درخواست.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

وضعیت `Status`

تابع وضعیت(c: کارخواه): صحیح

وضعیت HTTP آخرین درخواست.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

گره‌ها `Nodes`

تابع گره‌ها(c: کارخواه): وکتور<رشته>

نشانی گره‌ها، همان‌طور که کارخواه به کارشان می‌برد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

سرآیند احراز `AuthHeader`

تابع سرآیند احراز(c: کارخواه): رشته

مقدار سرآیند Authorization که با هر درخواست فرستاده می‌شود؛ با امضای AWS خالی است چون هر درخواست جداگانه امضا می‌شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

تنظیم زمان امضا `SetSigningTime`

تابع تنظیم زمان امضا(c: کارخواه، epoch: صحیح۶۴)

ساعت مورد استفاده‌ی امضای AWS را ثابت می‌کند، به ثانیه‌ی یونیکس؛ برای آزمون. ۰ به ساعت واقعی برمی‌گردد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

بستن `Close`

تابع بستن(c &: کارخواه)

کارخواه را آزاد می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

انجام `Perform`

تابع انجام(c: کارخواه، method: رشته، path: رشته، body: رشته): پاسخ

هر درخواستی را با بدنه‌ی JSON می‌فرستد و پاسخ خام را برمی‌گرداند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

انجام چندخطی `PerformNdjson`

تابع انجام چندخطی(c: کارخواه، method: رشته، path: رشته، body: رشته): پاسخ

درخواستی با بدنه‌ی NDJSON می‌فرستد، همان‌طور که دسته‌ای و جستجوی چندگانه می‌خواهند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

انجام متنی `PerformText`

تابع انجام متنی(c: کارخواه، method: رشته، path: رشته، body: رشته، content_type: رشته): پاسخ

درخواستی با بدنه‌ای از گونه‌ی محتوای داده‌شده می‌فرستد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

کدگذاری پایه `EncodeBasic`

تابع کدگذاری پایه(username: رشته، password: رشته): رشته

پایه۶۴ عبارت user:password، همان‌طور که احراز هویت پایه می‌فرستد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Client.salam

پارامتر اس کیو ال `SqlParam`

تابع پارامتر اس کیو ال(kind: رشته، value: رشته): رشته

یک پارامتر پرسمان برای اس کیو ال با پارامتر، مثل پارامتر اس کیو ال("integer"، "5").

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

اس کیو ال `Sql`

تابع اس کیو ال(c: کارخواه، query: رشته): ردیف‌های اس کیو ال

یک پرسمان SQL اجرا می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

اس کیو ال با پارامتر `SqlWith`

تابع اس کیو ال با پارامتر(c: کارخواه، query: رشته، params: وکتور<رشته>، fetch_size: صحیح): ردیف‌های اس کیو ال

یک پرسمان SQL با پارامترهای ? و اندازه‌ی صفحه اجرا می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

اس کیو ال با قالب `SqlFormat`

تابع اس کیو ال با قالب(c: کارخواه، query: رشته، format: رشته): رشته

نتیجه‌ی SQL در قالبی دیگر: csv، raw، json یا jdbc.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

توضیح اس کیو ال `SqlExplain`

تابع توضیح اس کیو ال(c: کارخواه، query: رشته): رشته

یک پرسمان SQL چگونه اجرا می‌شود، به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

پی پی ال `Ppl`

تابع پی پی ال(c: کارخواه، query: رشته): ردیف‌های اس کیو ال

یک پرسمان PPL اجرا می‌کند، مثل source=logs | where code > 499 | stats count() by host.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

پی پی ال با قالب `PplFormat`

تابع پی پی ال با قالب(c: کارخواه، query: رشته، format: رشته): رشته

نتیجه‌ی PPL در قالبی دیگر.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

توضیح پی پی ال `PplExplain`

تابع توضیح پی پی ال(c: کارخواه، query: رشته): رشته

یک پرسمان PPL چگونه اجرا می‌شود، به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

اتصال عمومی `Conn`

تابع اتصال عمومی(c: کارخواه): dyn db.Connection

کارخواه به شکل اتصال، برای کدی که با دیتابیس نوشته شده.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-opensearch-Sql.salam

امضای درخواست آمازون `SignRequest`

تابع امضای درخواست آمازون(method: رشته، host: رشته، path: رشته، body: رشته، region: رشته، service: رشته، access_key: رشته، secret_key: رشته، token: رشته، epoch: صحیح۶۴): رشته

سرآیندهای AWS SigV4 برای یک درخواست: روش، میزبان، مسیر با پرس‌وجو، بدنه، ناحیه، سرویس، کلیدها، توکن نشست و زمان یونیکس.

db-opensearch-SignRequest.salam

واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    headers := اپن سرچ.امضای درخواست آمازون(
        "GET"، "example.amazonaws.com"، "/"، ""، "us-east-1"، "service"، "AKIDEXAMPLE"،
        "wJalrXUtnFEMI/K7MDENG+bPxRfiCYEXAMPLEKEY"، ""، 1440938160 برگردان صحیح۶۴
    )
    هر line در headers.بشکاف("\r\n"):
        اگر line.طول() بزرگتر 0: سرچاپ line پایان
    پایان
پایان

خروجیX-Amz-Date: 20150830T123600Z X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20150830/us-east-1/service/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=726c5c4879a6b4ccbbd3b24edbd6b8826d34f87450fbbf4e85546fc7ba9c1642

اپن سرچ db/opensearch

گونه‌ها

پرسمان منطقی BoolQuery

پارامترهای جستجو SearchParams

اطلاعات کار TaskInfo

اطلاعات احراز AuthInfo

روش همسایه‌یابی KnnMethod

نتیجه پرسمانی ByQueryResult

پیکربندی Config

کارخواه Client

پاسخ Response

گزینه‌ها Options

نتیجه نوشتن WriteResult

سند Document

یافته Hit

نتیجه جستجو SearchResult

درخواست جستجو SearchRequest

سطل Bucket

دسته‌ای Bulk

قلم دسته‌ای BulkItem

نتیجه دسته‌ای BulkResult

اطلاعات Info

سلامت Health

اطلاعات نمایه IndexInfo

ردیف‌های اس کیو ال SqlRows

معتبر Ok

خطا Error

مجموع Total

بعدی Next

تعداد ستون ColumnCount

نام ستون ColumnName

نام نوع ستون ColumnTypeName

نوع ستون ColumnType

خالی است IsNull

متن Text

خام Raw

عدد صحیح Int

عدد صحیح۶۴ Int64

عدد اعشار Float

بستن Close

پایگاه داده Database

نوع Kind

معتبر Ok

پینگ Ping

اجرا Exec

پرسمان Query

شروع تراکنش Begin

شناسه آخرین درج LastInsertId

تعداد تغییرات Changes

خطا Error

نقل قول Quote

بستن Close

تراکنش Txn

معتبر Ok

اجرا Exec

پرسمان Query

ثبت تراکنش Commit

بازگردانی Rollback

پایاها و متغیرها

نسخه کارخواه VERSION

نشانی پیش‌فرض DEFAULT_URL

درگاه پیش‌فرض DEFAULT_PORT

مهلت گره از کار افتاده DEAD_NODE_MS

تازه‌سازی فوری REFRESH_TRUE

تازه‌سازی با انتظار REFRESH_WAIT_FOR

بدون تازه‌سازی REFRESH_FALSE

سرویس دامنه SERVICE_ES

سرویس بی‌سرور SERVICE_AOSS

تابع‌ها

دسته‌ای تازه NewBulk

نمایه‌سازی دسته‌ای BulkIndex

نمایه‌سازی دسته‌ای مسیردار BulkIndexRouted

ایجاد دسته‌ای BulkCreate

به‌روزرسانی دسته‌ای BulkUpdate

به‌روزرسانی درجی دسته‌ای BulkUpsert

حذف دسته‌ای BulkDelete

اندازه دسته‌ای BulkLen

بدنه دسته‌ای BulkBody

بازنشانی دسته‌ای BulkReset

آزادسازی دسته‌ای BulkFree

اپن سرچ `db/opensearch`

پرسمان منطقی `BoolQuery`

پارامترهای جستجو `SearchParams`

اطلاعات کار `TaskInfo`

اطلاعات احراز `AuthInfo`

روش همسایه‌یابی `KnnMethod`

نتیجه پرسمانی `ByQueryResult`

پیکربندی `Config`

کارخواه `Client`

پاسخ `Response`

گزینه‌ها `Options`

نتیجه نوشتن `WriteResult`

سند `Document`

یافته `Hit`

نتیجه جستجو `SearchResult`

درخواست جستجو `SearchRequest`

سطل `Bucket`

دسته‌ای `Bulk`

قلم دسته‌ای `BulkItem`

نتیجه دسته‌ای `BulkResult`

اطلاعات `Info`

سلامت `Health`

اطلاعات نمایه `IndexInfo`

ردیف‌های اس کیو ال `SqlRows`

معتبر `Ok`

خطا `Error`

مجموع `Total`

بعدی `Next`

تعداد ستون `ColumnCount`

نام ستون `ColumnName`

نام نوع ستون `ColumnTypeName`

نوع ستون `ColumnType`

خالی است `IsNull`

متن `Text`

خام `Raw`

عدد صحیح `Int`

عدد صحیح۶۴ `Int64`

عدد اعشار `Float`

بستن `Close`

پایگاه داده `Database`

نوع `Kind`

معتبر `Ok`

پینگ `Ping`

اجرا `Exec`

پرسمان `Query`

شروع تراکنش `Begin`

شناسه آخرین درج `LastInsertId`

تعداد تغییرات `Changes`

خطا `Error`

نقل قول `Quote`

بستن `Close`

تراکنش `Txn`

معتبر `Ok`

اجرا `Exec`

پرسمان `Query`

ثبت تراکنش `Commit`

بازگردانی `Rollback`

نسخه کارخواه `VERSION`

نشانی پیش‌فرض `DEFAULT_URL`

درگاه پیش‌فرض `DEFAULT_PORT`

مهلت گره از کار افتاده `DEAD_NODE_MS`

تازه‌سازی فوری `REFRESH_TRUE`

تازه‌سازی با انتظار `REFRESH_WAIT_FOR`

بدون تازه‌سازی `REFRESH_FALSE`

سرویس دامنه `SERVICE_ES`

سرویس بی‌سرور `SERVICE_AOSS`

دسته‌ای تازه `NewBulk`

نمایه‌سازی دسته‌ای `BulkIndex`

نمایه‌سازی دسته‌ای مسیردار `BulkIndexRouted`

ایجاد دسته‌ای `BulkCreate`

به‌روزرسانی دسته‌ای `BulkUpdate`

به‌روزرسانی درجی دسته‌ای `BulkUpsert`

حذف دسته‌ای `BulkDelete`

اندازه دسته‌ای `BulkLen`

بدنه دسته‌ای `BulkBody`

بازنشانی دسته‌ای `BulkReset`

آزادسازی دسته‌ای `BulkFree`

تجزیه دسته‌ای `ParseBulk`

ارسال دسته‌ای `BulkSend`

ارسال دسته‌ای با تازه‌سازی `BulkSendWith`