زبان سلام
ویرایشگر آنلاین

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

الستیک سرچ db/elasticsearch

کارخواه الستیک سرچ و OpenSearch: سند، جستجو، تجمیع، بارگذاری دسته‌ای، اس کیو ال و مدیریت نمایه.

واردسازی دیتابیس.الستیک سرچ
در این صفحه
  1. آموزش: جستجو با الستیک سرچ
  2. یک خوشه برای گفتگو
  3. اتصال
  4. ذخیره و خواندن سند
  5. ساختن پرسمان
  6. جستجو و خواندن پاسخ
  7. تجمیع
  8. بارگذاری سندهای زیاد
  9. ورق زدن همه‌ی نتیجه‌ها
  10. اس کیو ال
  11. خطا و تلاش دوباره
  12. قدم بعدی
  13. گونه‌ها
  14. پایاها و متغیرها
  15. تابع‌ها

الستیک سرچ یک موتور جستجو و انبار سند است که با JSON روی HTTP با آن صحبت می‌شود. این بسته به زبان سلام و روی net.http و tls نوشته شده و به هیچ کتابخانه‌ی خارجی نیاز ندارد. با الستیک سرچ ۷ و ۸، Elastic Cloud (اتصال ابری) و OpenSearch کار می‌کند؛ فراخوانی‌های اس کیو ال و نقطه‌ی زمانی خودشان به نقطه‌های پایانی OpenSearch می‌روند. کارخواه برای هر گره یک اتصال باز نگه می‌دارد و می‌تواند چند گره داشته باشد: بینشان می‌چرخد، گرهی را که اتصال نمی‌پذیرد به مدت مهلت گره از کار افتاده کنار می‌گذارد و روی ۵۰۲، ۵۰۳ و ۵۰۴ دوباره تلاش می‌کند. سندها و بندهای پرسمان متن JSON ساده‌اند، پس می‌توانید سازنده‌های این بسته را با JSON دست‌نویس ترکیب کنید، و انجام به هر API که تابع جداگانه ندارد می‌رسد. پس از هر فراخوانی، خطا، نوع خطا و وضعیت می‌گویند سرور چه گفته است. نمونه‌ها چون به یک خوشه‌ی در حال اجرا نیاز دارند فقط بررسی می‌شوند.

آموزش: جستجو با الستیک سرچ

سندهای JSON را به الستیک سرچ می‌دهید و آن سندهایی را که با پرسمان جورند پیدا می‌کند، رتبه می‌دهد و به هر شکلی که بخواهید می‌شمارد. بخش‌های زیر یک فهرست کوچک کتابخانه می‌سازند، از نخستین اتصال تا بارگذاری دسته‌ای و اس کیو ال.

یک خوشه برای گفتگو

این بسته با الستیک سرچ ۷ و ۸، با Elastic Cloud و با OpenSearch، روی HTTP ساده یا TLS و بدون هیچ کتابخانه‌ی بیرونی گفتگو می‌کند. برای آزمایش، یک گره در داکر کافی است:

docker run -d -p 127.0.0.1:9200:9200 -e discovery.type=single-node -e xpack.security.enabled=false docker.elastic.co/elasticsearch/elasticsearch:8.15.3

این گره بدون رمز روی http://localhost:9200 پاسخ می‌دهد. نمونه‌هایی که به خوشه‌ی در حال اجرا نیاز دارند فقط بررسی می‌شوند؛ نمونه‌هایی که JSON می‌سازند یا پاسخ را می‌خوانند همین‌جا اجرا می‌شوند و خروجی واقعی‌شان دیده می‌شود.

اتصال

اتصال(نشانی) شکل کوتاه است. برای بیشتر از آن یک پیکربندی را پر کنید و به کارخواه تازه بدهید: چند گره، نام کاربری و رمز، کلید API، توکن حامل، پرونده‌ی مرجعی که گواهی خوشه را امضا کرده، مهلت و تعداد تلاش دوباره. نشانی گره خودش هم می‌تواند اعتبارنامه داشته باشد، مانند https://user:pass@host:9200.

es-connect.salam
واردسازی دیتابیس.الستیک سرچ

تابع ریشه:
    ناپایا پیکر := الستیک سرچ.پیکربندی پیش‌فرض()
    پیکر.گره‌ها = وکتور {} برگردان وکتور<رشته>
    پیکر.گره‌ها.بیفزا("https://es-1.example.com:9200")
    پیکر.گره‌ها.بیفزا("https://es-2.example.com:9200")
    پیکر.نام کاربری = "elastic"
    پیکر.گذرواژه = "s3cret"
    پیکر.پرونده مرجع گواهی = "/etc/elasticsearch/certs/http_ca.crt"
    پیکر.مهلت میلی‌ثانیه = 10000
    ناپایا ک := الستیک سرچ.کارخواه تازه(پیکر)
    اگر وارونه الستیک سرچ.پینگ(ک):
        سرچاپ "no answer:"، الستیک سرچ.خطا(ک)
        برگشت
    پایان
    آگاهی := الستیک سرچ.دریافت اطلاعات(ک)
    سرچاپ آگاهی.توزیع، آگاهی.نسخه، الستیک سرچ.سلامت خوشه(ک).وضعیت
    الستیک سرچ.بستن(ک)
پایان

ساختن کارخواه به شبکه دست نمی‌زند. پینگ می‌پرسد خوشه پاسخ می‌دهد یا نه، دریافت اطلاعات نام و نسخه و توزیع آن را برمی‌گرداند و سلامت خوشه وضعیت green، yellow یا red را. وقتی کارتان تمام شد بستن کارخواه و اتصال‌هایی را که باز نگه داشته آزاد می‌کند.

چیزی که داریدبه کار ببرید
یک گره‌ی محلی بدون امنیتاتصال("http://localhost:9200")
نام کاربری و رمزاتصال با رمز(نشانی، کاربر، رمز)
کلید APIاتصال با کلید(نشانی، کلید)، کدگذاری شده یا به شکل id:key
استقرار Elastic Cloudاتصال ابری(شناسه‌ی ابری، کلید)
توکن حساب سرویسپیکربندی با bearer
گواهی خودامضای خوشهپیکربندی با ca_file

ذخیره و خواندن سند

سند یک شیء JSON است که با یک شناسه در یک نمایه ذخیره می‌شود. سندها و بندهای پرسمان مقدارهای رشته ساده‌ای‌اند که JSON دارند، پس می‌توانید آن‌ها را دستی بنویسید، با بسته‌ی جیسون بسازید یا از سازنده‌های همین بسته استفاده کنید. ایجاد نمایه نمایه را با نگاشتش می‌سازد؛ نمایه کردن سند را ذخیره می‌کند؛ دریافت آن را برمی‌گرداند؛ به‌روزرسانی فیلدها را در آن ادغام می‌کند و حذف آن را برمی‌دارد.

es-documents.salam
واردسازی دیتابیس.الستیک سرچ

تابع ریشه:
    ناپایا ک := الستیک سرچ.اتصال("http://localhost:9200")
    طرح‌نگاشت := `{"mappings":{"properties":{"title":{"type":"text"},"author":{"type":"keyword"},"year":{"type":"integer"}}}}`
    اگر وارونه الستیک سرچ.نمایه موجود است(ک، "books"):
        الستیک سرچ.ایجاد نمایه(ک، "books"، طرح‌نگاشت)
    پایان

    نوشته := الستیک سرچ.نمایه کردن با گزینه(ک، "books"، "1"، `{"title":"Shahnameh","author":"ferdowsi","year":1010}`، الستیک سرچ.گزینه‌ها { تازه‌سازی = الستیک سرچ.تازه‌سازی با انتظار })
    سرچاپ نوشته.موفق، نوشته.نتیجه، نوشته.نسخه

    س := الستیک سرچ.دریافت(ک، "books"، "1")
    اگر س.یافت شد:
        سرچاپ س.منبع
    پایان

    به‌روزشده := الستیک سرچ.به‌روزرسانی با گزینه(ک، "books"، "1"، `{"year":1011}`، الستیک سرچ.گزینه‌ها { شرط شماره ترتیب = س.شماره ترتیب، شرط دوره اصلی = س.دوره اصلی })
    اگر وارونه به‌روزشده.موفق:
        سرچاپ "someone else changed it first:"، الستیک سرچ.نوع خطا(ک)
    پایان

    سرچاپ الستیک سرچ.موجود است(ک، "books"، "1")، الستیک سرچ.شمارش(ک، "books"، "")
    الستیک سرچ.حذف(ک، "books"، "1")
    الستیک سرچ.بستن(ک)
پایان

هر نوشتن یک نتیجه نوشتن برمی‌گرداند با ok، نتیجه در result (created، updated، deleted)، version تازه و شماره‌های ترتیب. اگر if_seq_no و if_primary_term را از یک دریافت بدهید، به‌روزرسانی به «مقایسه و جایگزینی» تبدیل می‌شود: اگر کسی در این فاصله سند را تغییر داده باشد، به‌روزرسانی با تعارض نسخه شکست می‌خورد و تغییر او را بازنویسی نمی‌کند.

سند تازه فقط پس از تازه‌سازی نمایه، حدود هر یک ثانیه، قابل جستجو است. گزینه‌ها { refresh = الستیک سرچ.تازه‌سازی با انتظار } فراخوانی را تا آن لحظه منتظر نگه می‌دارد که در آزمون‌ها و اسکریپت‌ها به کار می‌آید.

ساختن پرسمان

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

es-queries.salam
واردسازی دیتابیس.الستیک سرچ

تابع ریشه:
    ناپایا بایدها := وکتور {} برگردان وکتور<رشته>
    بایدها.بیفزا(الستیک سرچ.تطبیق("title"، "book of kings"))
    ناپایا پالایه := وکتور {} برگردان وکتور<رشته>
    پالایه.بیفزا(الستیک سرچ.بازه("year"، "900"، "1100"))
    پالایه.بیفزا(الستیک سرچ.نقیض(الستیک سرچ.واژه("status"، "draft")))
    پرس‌وجو := الستیک سرچ.پالایش شده(الستیک سرچ.همه شرط‌ها(بایدها)، پالایه)
    سرچاپ پرس‌وجو

    ناپایا ترتیب := وکتور {} برگردان وکتور<رشته>
    ترتیب.بیفزا(الستیک سرچ.مرتب نزولی("year"))
    ناپایا نمایان := وکتور {} برگردان وکتور<رشته>
    نمایان.بیفزا("title")
    نمایان.بیفزا("year")
    درخواست := الستیک سرچ.درخواست جستجو { پرسمان = پرس‌وجو، اندازه = 10، مرتب‌سازی = ترتیب، منبع = نمایان }
    سرچاپ الستیک سرچ.بدنه جستجو(درخواست)
پایان
خروجی{"bool": {"must": {"bool": {"must": [{"match": {"title": "book of kings"}}]}}, "filter": [{"range": {"year": {"gte": "900", "lte": "1100"}}}, {"bool": {"must_not": [{"term": {"status": "draft"}}]}}]}} {"query": {"bool": {"must": {"bool": {"must": [{"match": {"title": "book of kings"}}]}}, "filter": [{"range": {"year": {"gte": "900", "lte": "1100"}}}, {"bool": {"must_not": [{"term": {"status": "draft"}}]}}]}}, "size": 10, "sort": [{"year": {"order": "desc"}}], "_source": ["title", "year"]}

بندهای فهرست پالایه‌ی پالایش شده فقط تعیین می‌کنند سند جور است یا نه؛ امتیاز آن را تغییر نمی‌دهند و الستیک سرچ می‌تواند نتیجه‌شان را نگه دارد. متن آزاد را در پرسمان بگذارید و شرط‌های دقیق مانند تاریخ، وضعیت و شناسه را در پالایه.

جستجو(ک، نمایه، درخواست) درخواست را اجرا و پاسخ را به یک نتیجه جستجو تجزیه می‌کند: تعداد کل جورها در total، یافته‌های این صفحه در hits که هر کدام id، score، source و highlight دارند، و زمانی که صرف شد.

es-search.salam
واردسازی دیتابیس.الستیک سرچ

تابع ریشه:
    ناپایا ک := الستیک سرچ.اتصال("http://localhost:9200")
    ناپایا فیلدها := وکتور {} برگردان وکتور<رشته>
    فیلدها.بیفزا("title")
    درخواست := الستیک سرچ.درخواست جستجو { پرسمان = الستیک سرچ.تطبیق("title"، "kings")، اندازه = 5، برجسته‌سازی = الستیک سرچ.برجسته‌سازی(فیلدها) }
    نتیجه := الستیک سرچ.جستجو(ک، "books"، درخواست)
    اگر وارونه نتیجه.موفق:
        سرچاپ "search failed:"، الستیک سرچ.خطا(ک)
        برگشت
    پایان
    سرچاپ نتیجه.کل، "matches in"، نتیجه.زمان اجرا، "ms"
    هر یافته در نتیجه.یافته‌ها:
        سرچاپ یافته.شناسه، یافته.امتیاز، یافته.منبع، یافته.برجسته‌سازی
    پایان
    الستیک سرچ.بستن(ک)
پایان

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

es-results.salam
واردسازی دیتابیس.الستیک سرچ

تابع ریشه:
    بدنه := `{"took":3,"hits":{"total":{"value":2,"relation":"eq"},"max_score":1.8,"hits":[{"_id":"1","_score":1.8,"_source":{"title":"Shahnameh","year":1010}},{"_id":"7","_score":0.9,"_source":{"title":"Garshasp-nama","year":1066}}]}}`
    نتیجه := الستیک سرچ.تجزیه نتیجه جستجو(بدنه)
    سرچاپ نتیجه.کل، نتیجه.رابطه کل، نتیجه.بیشینه امتیاز
    هر یافته در نتیجه.یافته‌ها:
        سرچاپ یافته.شناسه، یافته.امتیاز، یافته.منبع
    پایان
پایان
خروجی2 eq 1.8 1 1.8 {"title":"Shahnameh","year":1010} 7 0.9 {"title":"Garshasp-nama","year":1066}

تجمیع

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

es-aggs.salam
واردسازی دیتابیس.الستیک سرچ

تابع ریشه:
    برای‌هرنویسنده := الستیک سرچ.زیرتجمیع‌ها(الستیک سرچ.تجمیع واژه‌ها("author"، 5)، الستیک سرچ.افزودن تجمیع(""، "avg_year"، الستیک سرچ.تجمیع میانگین("year")))
    ناپایا تجمیع‌ها := الستیک سرچ.افزودن تجمیع(""، "by_author"، برای‌هرنویسنده)
    تجمیع‌ها = الستیک سرچ.افزودن تجمیع(تجمیع‌ها، "oldest"، الستیک سرچ.تجمیع کمینه("year"))
    سرچاپ الستیک سرچ.بدنه جستجو(الستیک سرچ.درخواست جستجو { اندازه = 0، تجمیع‌ها = تجمیع‌ها })

    پاسخ := `{"hits":{"total":{"value":120,"relation":"eq"},"hits":[]},"aggregations":{"oldest":{"value":940.0},"by_author":{"buckets":[{"key":"ferdowsi","doc_count":70,"avg_year":{"value":1010.0}},{"key":"saadi","doc_count":50,"avg_year":{"value":1258.0}}]}}}`
    نتیجه := الستیک سرچ.تجزیه نتیجه جستجو(پاسخ)
    سرچاپ "oldest:"، الستیک سرچ.مقدار تجمیع(نتیجه، "oldest")
    هر د در الستیک سرچ.سطل‌های تجمیع(نتیجه، "by_author"):
        سرچاپ د.کلید، د.شمار اسناد، الستیک سرچ.مقدار تجمیع در(د.خام، "avg_year")
    پایان
پایان
خروجی{"size": 0, "aggs": {"by_author": {"terms": {"field": "author", "size": 5}, "aggs": {"avg_year": {"avg": {"field": "year"}}}}, "oldest": {"min": {"field": "year"}}}} oldest: 940 ferdowsi 70 1010 saadi 50 1258

با size = 0 وقتی فقط خلاصه مهم است یافته‌ها برگردانده نمی‌شوند و درخواست بسیار سبک‌تر می‌شود.

بارگذاری سندهای زیاد

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

es-bulk.salam
واردسازی رشته
واردسازی دیتابیس.الستیک سرچ

تابع ریشه:
    ناپایا د := الستیک سرچ.دسته‌ای تازه()
    تکرار 3 در ش:
        شناسه := رشته.از عدد(ش برگردان صحیح۶۴)
        الستیک سرچ.نمایه کردن دسته‌ای(د، "logs"، شناسه، `{"line":` + شناسه + `,"level":"info"}`)
    پایان
    الستیک سرچ.به‌روزرسانی دسته‌ای(د، "logs"، "1"، `{"level":"warn"}`)
    الستیک سرچ.حذف دسته‌ای(د، "logs"، "2")
    سرچاپ الستیک سرچ.طول دسته‌ای(د)، "actions"
    چاپ الستیک سرچ.بدنه دسته‌ای(د)

    پاسخ := `{"took":5,"errors":true,"items":[{"index":{"_id":"0","status":201,"result":"created"}},{"index":{"_id":"1","status":201,"result":"created"}},{"index":{"_id":"2","status":201,"result":"created"}},{"update":{"_id":"1","status":200,"result":"updated"}},{"delete":{"_id":"2","status":429,"error":{"type":"es_rejected_execution_exception","reason":"queue is full"}}}]}`
    نتیجه := الستیک سرچ.تجزیه نتیجه دسته‌ای(پاسخ)
    سرچاپ نتیجه.تعداد موفق، "ok,"، نتیجه.تعداد ناموفق، "failed"
    هر قلم در نتیجه.اقلام:
        اگر وارونه قلم.موفق:
            سرچاپ "retry"، قلم.عملیات، قلم.شناسه، قلم.نوع خطا
        پایان
    پایان
پایان
خروجی5 actions {"index": {"_index": "logs", "_id": "0"}} {"line":0,"level":"info"} {"index": {"_index": "logs", "_id": "1"}} {"line":1,"level":"info"} {"index": {"_index": "logs", "_id": "2"}} {"line":2,"level":"info"} {"update": {"_index": "logs", "_id": "1"}} {"doc": {"level":"warn"}} {"delete": {"_index": "logs", "_id": "2"}} 4 ok, 1 failed retry delete 2 es_rejected_execution_exception

برای بارهای بزرگ، هر هزار کنش یک دسته بفرستید و با بازنشانی دسته‌ای از نو شروع کنید. کارخواه اتصال به هر گره را بین فراخوانی‌ها باز نگه می‌دارد، پس روی HTTPS هزینه‌ی دست‌دادن TLS یک بار پرداخت می‌شود، نه برای هر درخواست.

es-bulk-run.salam
واردسازی رشته
واردسازی دیتابیس.الستیک سرچ

تابع ریشه:
    ناپایا ک := الستیک سرچ.اتصال("http://localhost:9200")
    ناپایا د := الستیک سرچ.دسته‌ای تازه()
    تکرار 10000 در ش:
        شناسه := رشته.از عدد(ش برگردان صحیح۶۴)
        الستیک سرچ.نمایه کردن دسته‌ای(د، "logs"، شناسه، `{"line":` + شناسه + `}`)
        اگر الستیک سرچ.طول دسته‌ای(د) برابر 1000:
            نتیجه := الستیک سرچ.اجرای دسته‌ای(ک، د)
            سرچاپ نتیجه.تعداد موفق، نتیجه.تعداد ناموفق
            الستیک سرچ.بازنشانی دسته‌ای(د)
        پایان
    پایان
    اگر الستیک سرچ.طول دسته‌ای(د) > 0:
        نتیجه := الستیک سرچ.اجرای دسته‌ای(ک، د)
        سرچاپ نتیجه.تعداد موفق، نتیجه.تعداد ناموفق
    پایان
    الستیک سرچ.تازه‌سازی(ک، "logs")
    سرچاپ الستیک سرچ.شمارش(ک، "logs"، "")
    الستیک سرچ.بستن(ک)
پایان

ورق زدن همه‌ی نتیجه‌ها

from و size برای چند صفحه‌ی نخست فهرست نتیجه مناسب‌اند. برای پیمودن همه‌ی جورها، با گشودن نقطه زمانی یک نقطه‌ی زمانی باز کنید، بر اساس فیلدهایی که لازم دارید مرتب کنید، و کل آرایه‌ی sort آخرین یافته را به عنوان search_after بدهید تا صفحه‌ی بعد بیاید. جستجو با نقطه‌ی زمانی یک مقدار یکتای _shard_doc به انتهای sort هر یافته می‌افزاید، پس هیچ دو یافته‌ای هم‌رتبه نمی‌شوند و نیازی به مرتب‌سازی بر اساس _id نیست. نقطه‌ی زمانی دید را هنگام خواندن ثابت نگه می‌دارد. جستجوی پیمایشی و پیمایش همین کار را به سبک قدیمی‌تر انجام می‌دهند.

es-paging.salam
واردسازی دیتابیس.الستیک سرچ

تابع ریشه:
    ناپایا ک := الستیک سرچ.اتصال("http://localhost:9200")
    ناپایا ترتیب := وکتور {} برگردان وکتور<رشته>
    ترتیب.بیفزا(الستیک سرچ.مرتب صعودی("year"))

    نقطه := الستیک سرچ.گشودن نقطه زمانی(ک، "books"، "1m")
    ناپایا نشانگر := ""
    ناپایا ادامه := درست
    تا ادامه:
        صفحه := الستیک سرچ.جستجو(ک، ""، الستیک سرچ.درخواست جستجو { اندازه = 500، مرتب‌سازی = ترتیب، شناسه نقطه زمانی = نقطه، مدت نگهداری نقطه زمانی = "1m"، نشانگر ادامه = نشانگر })
        اگر صفحه.یافته‌ها.طول() برابر 0:
            ادامه = نادرست
        وگرنه:
            هر یافته در صفحه.یافته‌ها:
                سرچاپ یافته.شناسه
            پایان
            نشانگر = صفحه.یافته‌ها.بگیر(صفحه.یافته‌ها.طول() - 1).مرتب‌سازی
        پایان
    پایان
    الستیک سرچ.بستن نقطه زمانی(ک، نقطه)
    الستیک سرچ.بستن(ک)
پایان

اس کیو ال

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

es-sql.salam
واردسازی دیتابیس
واردسازی دیتابیس.الستیک سرچ

تابع نویسندگان(رابط: پویا دیتابیس.اتصال):
    ردیف‌ها := رابط.پرسمان("SELECT author, COUNT(*) AS books FROM books GROUP BY author ORDER BY author")
    تا ردیف‌ها.بعدی():
        سرچاپ ردیف‌ها.متن(0)، ردیف‌ها.عدد صحیح(1)
    پایان
    ردیف‌ها.بستن()
پایان

تابع ریشه:
    ناپایا ک := الستیک سرچ.اتصال("http://localhost:9200")
    ناپایا پارامترها := وکتور {} برگردان وکتور<رشته>
    پارامترها.بیفزا("1000")
    ناپایا ردیف‌ها := الستیک سرچ.اس کیو ال با پارامتر(ک، "SELECT title, year FROM books WHERE year > ? ORDER BY year"، پارامترها، 100)
    تا ردیف‌ها.بعدی():
        سرچاپ ردیف‌ها.متن(0)، ردیف‌ها.عدد صحیح(1)
    پایان
    ردیف‌ها.بستن()
    نویسندگان(الستیک سرچ.اتصال عمومی(ک))
    الستیک سرچ.بستن(ک)
پایان

خطا و تلاش دوباره

فراخوانی ناموفق مقدار نگهبان خود را برمی‌گرداند (نادرست، ‎-1، رشته‌ی خالی یا نتیجه‌ای با ok نادرست) و کارخواه دلیلش را به خاطر می‌سپارد: خطا(ک) پیام را می‌دهد، نوع خطا(ک) نوع خطای الستیک سرچ مانند version_conflict_engine_exception را، و وضعیت(ک) وضعیت HTTP را که اگر هیچ گرهی پاسخ نداد ۰ است. با چند گره، کارخواه بینشان می‌چرخد، گرهی را که اتصال را نپذیرفت یک دقیقه کنار می‌گذارد و روی ۵۰۲، ۵۰۳ و ۵۰۴ دوباره تلاش می‌کند.

es-errors.salam
واردسازی دیتابیس.الستیک سرچ

تابع ریشه:
    ناپایا پیکر := الستیک سرچ.پیکربندی { بیشینه کوشش مجدد = 3، مهلت میلی‌ثانیه = 5000، اتصال پایدار = درست }
    پیکر.گره‌ها.بیفزا("http://es-1:9200")
    پیکر.گره‌ها.بیفزا("http://es-2:9200")
    ناپایا ک := الستیک سرچ.کارخواه تازه(پیکر)
    نوشته := الستیک سرچ.ایجاد(ک، "books"، "1"، `{"title":"Shahnameh"}`)
    اگر وارونه نوشته.موفق:
        ترابرد الستیک سرچ.نوع خطا(ک):
            "version_conflict_engine_exception":
                سرچاپ "already there"
                بشکن
            پایان
            "":
                سرچاپ "no node answered:"، الستیک سرچ.خطا(ک)
                بشکن
            پایان
            وگرنه:
                سرچاپ الستیک سرچ.وضعیت(ک)، الستیک سرچ.خطا(ک)
            پایان
        پایان
    پایان
    پ := الستیک سرچ.انجام(ک، "GET"، "/_cat/indices?format=json"، "")
    سرچاپ پ.وضعیت، پ.بدنه
    الستیک سرچ.بستن(ک)
پایان

هر چیزی که این بسته تابعی برایش ندارد با یک انجام(ک، روش، مسیر، بدنه) در دسترس است؛ وضعیت و بدنه‌ی خام را برمی‌گرداند.

قدم بعدی

نیازبه کار ببرید
تنظیمات، نگاشت، نام مستعار و الگوی نمایهتنظیم نگاشت، تنظیم تنظیمات، جابجایی نام مستعار، تنظیم الگوی نمایه
کپی کردن یک نمایهنمایه‌سازی دوباره، یا شروع نمایه‌سازی دوباره و دریافت کار در پس‌زمینه
پاک‌سازی سندها هنگام ورودتنظیم خط لوله و گزینه‌ها { pipeline = ... }
گزارش‌ها و دیگر داده‌های زمانیایجاد جریان داده، چرخش نمایه، تنظیم سیاست چرخه عمر
پشتیبان‌گیریتنظیم مخزن پشتیبان، ایجاد پشتیبان، بازیابی پشتیبان
جستجوهای طولانیارسال جستجوی ناهمگام و دریافت جستجوی ناهمگام
جستجوی بردارینزدیک‌ترین همسایه‌ها در فیلد knn درخواست جستجو

همه‌ی تابع‌ها، گونه‌ها و فیلدها با نمونه در مرجع پایین همین صفحه توضیح داده شده‌اند.

گونه‌ها

جستجوی ناهمگام AsyncSearch

ساختار جستجوی ناهمگام
یک جستجوی ناهمگام: شناسه، اینکه هنوز در حال اجراست، و نتیجه تا این لحظه.
نامانگلیسیگونهتوضیح
موفقokمنطقی = نادرستآیا موفق بود.
شناسهidرشته = ""شناسه برای آوردن یا حذف جستجو.
روانrunningمنطقی = نادرستآیا جستجو هنوز در حال اجراست.
ناقصpartialمنطقی = نادرستآیا نتیجه ناقص است.
نتیجهresultنتیجه جستجونتیجه‌ی جستجو تا این لحظه.
خطاerrorرشته = ""متن خطا؛ در موفقیت خالی.
db-elasticsearch-Admin.salam
واردسازی زمان
واردسازی کدگذاری.جیسون
واردسازی دیتابیس.الستیک سرچ

تابع ریشه:
    ک := الستیک سرچ.اتصال("http://localhost:9200")

    الستیک سرچ.تنظیم خط لوله(ک، "clean"، `{"processors":[{"lowercase":{"field":"tag"}},{"set":{"field":"seen","value":true}}]}`)
    آزمون := الستیک سرچ.شبیه‌سازی خط لوله(ک، "clean"، `{"docs":[{"_source":{"tag":"LOUD"}}]}`)
    سرچاپ جیسون.دریافت مسیر(آزمون، "docs.0.doc._source.tag")
    الستیک سرچ.نمایه کردن با گزینه(ک، "books"، "9"، `{"tag":"Poetry"}`، الستیک سرچ.گزینه‌ها { خط لوله = "clean" })

    الستیک سرچ.تنظیم الگوی نمایه(ک، "app_logs"، `{"index_patterns":["applog-*"],"data_stream":{},"priority":200}`)
    الستیک سرچ.ایجاد جریان داده(ک، "applog-web")
    الستیک سرچ.ایجاد(ک، "applog-web"، ""، `{"@timestamp":"2026-10-16T10:00:00Z","msg":"started"}`)
    الستیک سرچ.چرخش نمایه(ک، "applog-web"، "")
    سرچاپ الستیک سرچ.دریافت جریان داده(ک، "applog-web")

    سیاست := `{"policy":{"phases":{"delete":{"min_age":"30d","actions":{"delete":{}}}}}}`
    اگر وارونه الستیک سرچ.اوپن سرچ است(ک): الستیک سرچ.تنظیم سیاست چرخه عمر(ک، "month"، سیاست) پایان

    الستیک سرچ.تنظیم مخزن پشتیبان(ک، "backups"، `{"type":"fs","settings":{"location":"/mnt/backups"}}`)
    الستیک سرچ.ایجاد پشتیبان(ک، "backups"، "nightly"، `{"indices":"books"}`)
    سرچاپ الستیک سرچ.فهرست پشتیبان‌ها(ک، "backups")

    شناسه := الستیک سرچ.شروع به‌روزرسانی با پرسمان(ک، "books"، الستیک سرچ.تطبیق همه()، الستیک سرچ.اسکریپت("ctx._source.year += 1"، ""))
    ناپایا کار := الستیک سرچ.دریافت کار(ک، شناسه)
    تا کار.موفق و وارونه کار.تمام‌شده:
        زمان.خواب(200)
        کار = الستیک سرچ.دریافت کار(ک، شناسه)
    پایان
    سرچاپ جیسون.دریافت(کار.پاسخ، "updated")

    الستیک سرچ.تنظیم اسکریپت ذخیره(ک، "by_tag"، "mustache"، `{"query":{"term":{"tag":"{{tag}}"}}}`)
    یافته‌ها := الستیک سرچ.جستجو با الگو(ک، "books"، "by_tag"، `{"tag":"poetry"}`)
    سرچاپ یافته‌ها.کل

    ناپایا ج := الستیک سرچ.ارسال جستجوی ناهمگام(ک، "books"، الستیک سرچ.درخواست جستجو { پرسمان = الستیک سرچ.تطبیق همه() }، "1s")
    تا ج.روان:
        ج = الستیک سرچ.دریافت جستجوی ناهمگام(ک، ج.شناسه، "1s")
    پایان
    سرچاپ ج.نتیجه.کل
    الستیک سرچ.حذف جستجوی ناهمگام(ک، ج.شناسه)

    سرچاپ الستیک سرچ.اعتبارسنجی پرسمان(ک، "books"، الستیک سرچ.تطبیق("title"، "shahnameh"))
    سرچاپ الستیک سرچ.توضیح امتیاز(ک، "books"، "9"، الستیک سرچ.واژه("tag"، "poetry"))
    سرچاپ الستیک سرچ.تنظیم تنظیمات خوشه(ک، `{"persistent":{"indices.recovery.max_bytes_per_sec":"100mb"}}`)
پایان

کار Task

ساختار کار
کاری روی سرور که با یکی از فراخوانی‌های شروع آغاز شده.
نامانگلیسیگونهتوضیح
موفقokمنطقی = نادرستآیا موفق بود.
شناسهidرشته = ""شناسه‌ی کار به شکل node:number.
تمام‌شدهcompletedمنطقی = نادرستآیا کار تمام شده.
عملیاتactionرشته = ""کنش کار، مانند indices:data/write/update/byquery.
پاسخresponseرشته = ""پاسخ خام کار تمام شده، مانند تعداد سندهای به‌روز شده.
خامrawرشته = ""JSON خامی که از آن تجزیه شده.

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

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

ساختار ردیف‌های اس کیو ال
نتیجه‌ی پرسمان اس کیو ال؛ db.Rows را پیاده می‌کند و با فراخوانی بعدی صفحه‌های بعدی را با مکان‌نما می‌آورد.
نامانگلیسیگونهتوضیح
دستهhandleتهی*اشاره‌گر وضعیت درونی.
db-elasticsearch-Sql.salam
واردسازی دیتابیس
واردسازی دیتابیس.الستیک سرچ

تابع گزارش(رابط: پویا دیتابیس.اتصال):
    ردیف‌ها := رابط.پرسمان("SELECT level, COUNT(*) AS n FROM logs GROUP BY level")
    تا ردیف‌ها.بعدی():
        سرچاپ ردیف‌ها.متن(0)، ردیف‌ها.عدد صحیح(1)
    پایان
    ردیف‌ها.بستن()
پایان

تابع ریشه:
    ک := الستیک سرچ.اتصال("http://localhost:9200")
    ناپایا پارامترها := وکتور {} برگردان وکتور<رشته>
    پارامترها.بیفزا("100")
    ناپایا ردیف‌ها := الستیک سرچ.اس کیو ال با پارامتر(ک، "SELECT line, level FROM logs WHERE line < ? ORDER BY line"، پارامترها، 50)
    سرچاپ ردیف‌ها.تعداد ستون()، ردیف‌ها.نام ستون(0)، ردیف‌ها.نام نوع ستون(0)، ردیف‌ها.نوع ستون(0) برابر دیتابیس.نوع صحیح
    تا ردیف‌ها.بعدی():
        سرچاپ ردیف‌ها.عدد صحیح۶۴(0)، ردیف‌ها.متن(1)، ردیف‌ها.خالی است(1)
    پایان
    ردیف‌ها.بستن()
    چاپ الستیک سرچ.متن اس کیو ال(ک، "SELECT level FROM logs LIMIT 3")
    سرچاپ الستیک سرچ.ترجمه اس کیو ال(ک، "SELECT line FROM logs WHERE level = 'warn'")
    گزارش(الستیک سرچ.اتصال عمومی(ک))
پایان

معتبر Ok

تابع معتبر(): منطقی
آیا پرسمان موفق بود.

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

خطا Error

تابع خطا(): رشته
خطای پرسمان؛ در موفقیت خالی.

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

بعدی Next

تابع بعدی(): منطقی
به ردیف بعدی می‌رود و در صورت نیاز صفحه‌ی بعدی را می‌آورد.

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

تعداد ستون ColumnCount

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

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

نام ستون ColumnName

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

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

نام نوع ستون ColumnTypeName

تابع نام نوع ستون(col: صحیح): رشته
نوع الستیک سرچ یک ستون، مانند long یا keyword.

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

نوع ستون ColumnType

تابع نوع ستون(col: صحیح): صحیح
گونه‌ی db.TYPE_* یک ستون؛ برای خانه‌ی تهی TYPE_NULL.

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

خالی است IsNull

تابع خالی است(col: صحیح): منطقی
آیا خانه‌ای از ردیف جاری تهی است.

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

متن Text

تابع متن(col: صحیح): رشته
خانه به صورت متن؛ برای تهی خالی.

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

عدد صحیح Int

تابع عدد صحیح(col: صحیح): صحیح
خانه به صورت عدد صحیح.

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

عدد صحیح۶۴ Int64

تابع عدد صحیح۶۴(col: صحیح): صحیح۶۴
خانه به صورت i64.

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

عدد اعشار Float

تابع عدد اعشار(col: صحیح): اعشار۶۴
خانه به صورت اعشاری.

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

بستن Close

تابع بستن(): صحیح
ردیف‌ها را آزاد و مکان‌نمای باز را می‌بندد.

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

پایگاه داده Database

ساختار پایگاه داده
کارخواه از دید db.Connection، تا کدی که برای رابط‌های db نوشته شده بتواند الستیک سرچ را با اس کیو ال بخواند.
نامانگلیسیگونهتوضیح
دستهhandleتهی*اشاره‌گر وضعیت درونی.

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

نوع Kind

تابع نوع(): رشته
همیشه db.ELASTICSEARCH.

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

معتبر Ok

تابع معتبر(): منطقی
آیا کارخواه معتبر است.

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

پینگ Ping

تابع پینگ(): منطقی
آیا خوشه پاسخ می‌دهد.

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

اجرا Exec

تابع اجرا(_sql: رشته): صحیح
همیشه ‎-1: اس کیو ال الستیک سرچ فقط خواندنی است. با نمایه کردن، دسته‌ای یا حذف با پرسمان بنویسید.

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

پرسمان Query

تابع پرسمان(sql: رشته): dyn db.Rows
یک پرسمان اس کیو ال اجرا می‌کند.

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

شروع تراکنش Begin

تابع شروع تراکنش(): dyn db.Tx
تراکنشی برمی‌گرداند که همه‌ی فراخوانی‌هایش شکست می‌خورند؛ الستیک سرچ تراکنش ندارد.

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

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

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

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

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

تابع تعداد تغییرات(): صحیح۶۴
همیشه ۰.

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

خطا Error

تابع خطا(): رشته
خطای آخرین فراخوانی.

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

نقل قول Quote

تابع نقل قول(s: رشته): رشته
رشته را برای اس کیو ال نقل‌قول می‌کند.

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

بستن Close

تابع بستن(): صحیح
کارخواه را می‌بندد.

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

تراکنش Txn

ساختار تراکنش
تراکنشی که شروع تراکنش برمی‌گرداند. الستیک سرچ تراکنش ندارد، پس همه‌ی فراخوانی‌ها شکست می‌خورند.
نامانگلیسیگونهتوضیح
دستهhandleتهی*اشاره‌گر وضعیت درونی.

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

معتبر Ok

تابع معتبر(): منطقی
همیشه نادرست.

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

اجرا Exec

تابع اجرا(_sql: رشته): صحیح
همیشه ‎-1.

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

پرسمان Query

تابع پرسمان(_sql: رشته): dyn db.Rows
ردیف‌های خالی برمی‌گرداند.

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

ثبت تراکنش Commit

تابع ثبت تراکنش(): صحیح
همیشه ‎-1.

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

بازگردانی Rollback

تابع بازگردانی(): صحیح
همیشه ‎-1.

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

پیکربندی Config

ساختار پیکربندی
همه‌ی آنچه کارخواه لازم دارد: گره‌ها، اعتبارنامه، TLS، مهلت، تلاش دوباره و سرآیندهای اضافه.
نامانگلیسیگونهتوضیح
گره‌هاnodesوکتور<رشته>نشانی گره‌ها؛ هر کدام می‌تواند چند نشانی جدا شده با کاما باشد.
شناسه ابرcloud_idرشته = ""شناسه‌ی Elastic Cloud که پیش از nodes به کار می‌رود.
نام کاربریusernameرشته = ""کاربر احراز هویت پایه.
گذرواژهpasswordرشته = ""گذرواژه‌ی احراز هویت پایه.
کلید دسترسیapi_keyرشته = ""کلید API، کدگذاری شده یا id:key؛ بر احراز هویت پایه مقدم است.
توکن حاملbearerرشته = ""توکن حامل، مانند توکن حساب سرویس.
پرونده مرجع گواهیca_fileرشته = ""فایل PEM مرجعی که گواهی خوشه را امضا کرده، برای نمونه http_ca.crt.
ناامنinsecureمنطقی = نادرستاز بررسی گواهی TLS بگذر. فقط برای آزمایش محلی.
مهلت میلی‌ثانیهtimeout_msصحیح = 30000مهلت اتصال و خواندن یک درخواست به میلی‌ثانیه؛ ۰ یعنی بی‌پایان.
بیشینه کوشش مجددmax_retriesصحیح = 3پس از شکست اتصال یا ۵۰۲، ۵۰۳ یا ۵۰۴ چند گره‌ی دیگر امتحان شود.
اتصال پایدارkeep_aliveمنطقی = درستبرای هر گره یک اتصال را بین درخواست‌ها دوباره به کار بگیر (پیش‌فرض). روی HTTPS این کار دست‌دادن TLS را در هر فراخوانی حذف می‌کند؛ اتصالی که سرور بسته خودکار دوباره باز می‌شود.
سرآیندهاheadersنگاشت<رشته، رشته>سرآیندهای اضافه که با هر درخواست فرستاده می‌شوند.
db-elasticsearch-Client.salam
واردسازی دیتابیس.الستیک سرچ

تابع ریشه:
    ناپایا تنظیم := الستیک سرچ.پیکربندی پیش‌فرض()
    تنظیم.نام کاربری = "elastic"
    تنظیم.گذرواژه = "s3cret"
    تنظیم.پرونده مرجع گواهی = "/etc/elasticsearch/certs/http_ca.crt"
    تنظیم.مهلت میلی‌ثانیه = 10000
    تنظیم.سرآیندها.درج("X-Opaque-Id"، "salam-docs")
    ناپایا ک := الستیک سرچ.کارخواه تازه(تنظیم)
    اگر وارونه الستیک سرچ.پینگ(ک):
        سرچاپ "cannot reach elasticsearch:"، الستیک سرچ.خطا(ک)
        برگشت
    پایان
    دانسته := الستیک سرچ.دریافت اطلاعات(ک)
    سرچاپ دانسته.توزیع، دانسته.نسخه، الستیک سرچ.سلامت خوشه(ک).وضعیت

    نگاشت := `{"mappings":{"properties":{"title":{"type":"text"},"year":{"type":"integer"}}}}`
    اگر وارونه الستیک سرچ.نمایه موجود است(ک، "books"):
        الستیک سرچ.ایجاد نمایه(ک، "books"، نگاشت)
    پایان
    نوشته := الستیک سرچ.نمایه کردن با گزینه(ک، "books"، "1"، `{"title":"Shahnameh","year":1010}`، الستیک سرچ.گزینه‌ها { تازه‌سازی = الستیک سرچ.تازه‌سازی با انتظار })
    سرچاپ نوشته.نتیجه، نوشته.نسخه

    س := الستیک سرچ.دریافت(ک، "books"، "1")
    اگر س.یافت شد: سرچاپ س.منبع پایان
    ب := الستیک سرچ.به‌روزرسانی با گزینه(ک، "books"، "1"، `{"year":1011}`، الستیک سرچ.گزینه‌ها { شرط شماره ترتیب = س.شماره ترتیب، شرط دوره اصلی = س.دوره اصلی })
    اگر وارونه ب.موفق: سرچاپ "conflict:"، الستیک سرچ.نوع خطا(ک) پایان
    الستیک سرچ.به‌روزرسانی با اسکریپت(ک، "books"، "1"، "ctx._source.year += params.n"، `{"n": 1}`)
    سرچاپ الستیک سرچ.موجود است(ک، "books"، "1")، الستیک سرچ.شمارش(ک، "books"، "")

    پ := الستیک سرچ.انجام(ک، "GET"، "/_cat/health?format=json"، "")
    سرچاپ پ.وضعیت، پ.بدنه
    الستیک سرچ.حذف(ک، "books"، "1")
    الستیک سرچ.بستن(ک)
پایان

کارخواه Client

ساختار کارخواه
دستگیره‌ی کارخواه. ارسال آن با مقدار ارزان است؛ با بستن آزادش کنید.
نامانگلیسیگونهتوضیح
دستهhandleتهی*اشاره‌گر وضعیت درونی.

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

پاسخ Response

ساختار پاسخ
پاسخ خام انجام: وضعیت، بدنه و پاکت خطای تجزیه شده.
نامانگلیسیگونهتوضیح
وضعیتstatusصحیح = 0وضعیت HTTP، یا وضعیتی که برای این مورد گزارش شده.
موفقokمنطقی = نادرستآیا موفق بود.
بدنهbodyرشته = ""بدنه‌ی پاسخ.
خطاerrorرشته = ""متن خطا؛ در موفقیت خالی.
نوع خطاerror_typeرشته = ""error.type الستیک سرچ.
دلیل خطاerror_reasonرشته = ""error.reason الستیک سرچ.

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

گزینه‌ها Options

ساختار گزینه‌ها
پارامترهای اختیاری مشترک فراخوانی‌های نوشتن: تازه‌سازی، مسیریابی، خط لوله، هم‌روندی خوش‌بینانه و غیره.
نامانگلیسیگونهتوضیح
تازه‌سازیrefreshرشته = ""true، wait_for یا false؛ ثابت‌های تازه‌سازی را ببینید.
مسیریابیroutingرشته = ""مقدار مسیریابی سفارشی.
خط لولهpipelineرشته = ""خط لوله‌ی دریافتی که اول اجرا می‌شود.
مهلتtimeoutرشته = ""مهلت سمت سرور مانند 30s.
انتظار شاردهای فعالwait_for_active_shardsرشته = ""چند نسخه از شارد باید فعال باشد، یا all.
منبعsourceرشته = ""پالایش منبع: در Options فهرست فیلدها با کاما، در SearchRequest فیلدهای برگشتی؛ در نتیجه‌ها JSON خام _source.
تعارض‌هاconflictsرشته = ""proceed برای گذشتن از تعارض نسخه در عملیات با پرسمان.
شرط شماره ترتیبif_seq_noصحیح۶۴ = -1فقط وقتی بنویس که سند هنوز این شماره‌ی ترتیب را دارد؛ ‎-1 خاموشش می‌کند.
شرط دوره اصلیif_primary_termصحیح۶۴ = -1عبارت اصلی همراه if_seq_no.
کوشش مجدد تعارضretry_on_conflictصحیح = -1تعداد تلاش دوباره‌ی به‌روزرسانی هنگام تعارض نسخه؛ ‎-1 پیش‌فرض را نگه می‌دارد.

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

نتیجه نوشتن WriteResult

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

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

سند Document

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

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

یافته Hit

ساختار یافته
یک یافته‌ی جستجو.
نامانگلیسیگونهتوضیح
نمایهindexرشته = ""نام نمایه.
شناسهidرشته = ""شناسه‌ی سند.
امتیازscoreاعشار۶۴ = 0امتیاز ارتباط.
منبعsourceرشته = ""پالایش منبع: در Options فهرست فیلدها با کاما، در SearchRequest فیلدهای برگشتی؛ در نتیجه‌ها JSON خام _source.
مرتب‌سازیsortرشته = ""بندهای مرتب‌سازی در درخواست؛ در یافته مقدارهای مرتب‌سازی خام برای search_after.
برجسته‌سازیhighlightرشته = ""برجسته‌سازی: بخش آن در درخواست، تکه‌های خام در یافته.
فیلدهاfieldsرشته = ""فیلدهای ذخیره یا زمان اجرا: در نتیجه JSON خام، در SearchRequest فهرست فیلدها.
خامrawرشته = ""JSON خامی که از آن تجزیه شده.
db-elasticsearch-Search.salam
واردسازی دیتابیس.الستیک سرچ

تابع ریشه:
    ک := الستیک سرچ.اتصال("http://localhost:9200")
    ناپایا بایدها := وکتور {} برگردان وکتور<رشته>
    بایدها.بیفزا(الستیک سرچ.تطبیق("title"، "persian poetry"))
    ناپایا پالایه‌ها := وکتور {} برگردان وکتور<رشته>
    پالایه‌ها.بیفزا(الستیک سرچ.بازه("year"، "900"، "1500"))
    پالایه‌ها.بیفزا(الستیک سرچ.نقیض(الستیک سرچ.واژه("status"، "draft")))
    ناپایا تجمیع‌ها := الستیک سرچ.افزودن تجمیع(""، "by_author"، الستیک سرچ.زیرتجمیع‌ها(الستیک سرچ.تجمیع واژه‌ها("author"، 5)، الستیک سرچ.افزودن تجمیع(""، "avg_year"، الستیک سرچ.تجمیع میانگین("year"))))
    تجمیع‌ها = الستیک سرچ.افزودن تجمیع(تجمیع‌ها، "newest"، الستیک سرچ.تجمیع بیشینه("year"))
    ناپایا ترتیب := وکتور {} برگردان وکتور<رشته>
    ترتیب.بیفزا(الستیک سرچ.مرتب نزولی("year"))
    ناپایا فیلدها := وکتور {} برگردان وکتور<رشته>
    فیلدها.بیفزا("title")
    درخواست := الستیک سرچ.درخواست جستجو {
        پرسمان = الستیک سرچ.پالایش شده(الستیک سرچ.همه شرط‌ها(بایدها)، پالایه‌ها)، اندازه = 10، مرتب‌سازی = ترتیب، تجمیع‌ها = تجمیع‌ها، برجسته‌سازی = الستیک سرچ.برجسته‌سازی(فیلدها)
    }
    نتیجه := الستیک سرچ.جستجو(ک، "books"، درخواست)
    اگر وارونه نتیجه.موفق:
        سرچاپ الستیک سرچ.خطا(ک)
        برگشت
    پایان
    سرچاپ نتیجه.کل، نتیجه.رابطه کل، نتیجه.زمان اجرا
    هر ی در نتیجه.یافته‌ها:
        سرچاپ ی.شناسه، ی.امتیاز، ی.منبع، ی.برجسته‌سازی
    پایان
    سرچاپ الستیک سرچ.مقدار تجمیع(نتیجه، "newest")
    هر د در الستیک سرچ.سطل‌های تجمیع(نتیجه، "by_author"):
        سرچاپ د.کلید، د.شمار اسناد، الستیک سرچ.مقدار تجمیع در(د.خام، "avg_year")
    پایان

    ناپایا صفحه := الستیک سرچ.جستجوی پیمایشی(ک، "books"، الستیک سرچ.درخواست جستجو { پرسمان = الستیک سرچ.تطبیق همه()، اندازه = 500 }، "1m")
    تا صفحه.یافته‌ها.طول() بزرگتر 0:
        سرچاپ "page of"، صفحه.یافته‌ها.طول()
        صفحه = الستیک سرچ.پیمایش(ک، صفحه.شناسه پیمایش، "1m")
    پایان
    الستیک سرچ.پاک کردن پیمایش(ک، صفحه.شناسه پیمایش)

    نقطه := الستیک سرچ.گشودن نقطه زمانی(ک، "books"، "1m")
    نخست := الستیک سرچ.جستجو(ک، ""، الستیک سرچ.درخواست جستجو { شناسه نقطه زمانی = نقطه، اندازه = 100، مرتب‌سازی = ترتیب })
    اگر نخست.یافته‌ها.طول() بزرگتر 0:
        واپسین := نخست.یافته‌ها.بگیر(نخست.یافته‌ها.طول() - 1)
        پسین := الستیک سرچ.جستجو(ک، ""، الستیک سرچ.درخواست جستجو { شناسه نقطه زمانی = نقطه، اندازه = 100، مرتب‌سازی = ترتیب، نشانگر ادامه = واپسین.مرتب‌سازی })
        سرچاپ پسین.یافته‌ها.طول()
    پایان
    الستیک سرچ.بستن نقطه زمانی(ک، نقطه)
    سرچاپ الستیک سرچ.حذف با پرسمان(ک، "books"، الستیک سرچ.واژه("status"، "draft"))
پایان

نتیجه جستجو SearchResult

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

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

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

ساختار درخواست جستجو
یک درخواست جستجو؛ بدنه جستجو آن را به JSON تبدیل می‌کند. فیلدهای خالی حذف می‌شوند.
نامانگلیسیگونهتوضیح
پرسمانqueryرشته = ""JSON بند پرسمان؛ خالی با همه جور است.
شروعfromصحیح = -1جابه‌جایی نخستین یافته؛ ‎-1 حذفش می‌کند.
اندازهsizeصحیح = -1تعداد یافته‌های برگشتی؛ ‎-1 حذفش می‌کند.
مرتب‌سازیsortوکتور<رشته>بندهای مرتب‌سازی در درخواست؛ در یافته مقدارهای مرتب‌سازی خام برای search_after.
منبعsourceوکتور<رشته>پالایش منبع: در Options فهرست فیلدها با کاما، در SearchRequest فیلدهای برگشتی؛ در نتیجه‌ها JSON خام _source.
حذف منبعsource_excludesوکتور<رشته>فیلدهایی که از _source حذف می‌شوند.
بدون منبعno_sourceمنطقی = نادرستهیچ _source برنگردان.
فیلدهاfieldsوکتور<رشته>فیلدهای ذخیره یا زمان اجرا: در نتیجه JSON خام، در SearchRequest فهرست فیلدها.
تجمیع‌هاaggsرشته = ""شیء تجمیع‌ها که با افزودن تجمیع ساخته می‌شود.
برجسته‌سازیhighlightرشته = ""برجسته‌سازی: بخش آن در درخواست، تکه‌های خام در یافته.
فیلتر پسینpost_filterرشته = ""پالایه‌ای که پس از تجمیع‌ها اعمال می‌شود.
همسایه نزدیکknnرشته = ""بند نزدیک‌ترین همسایه‌ها برای جستجوی برداری.
ادغامcollapseرشته = ""فیلدی برای فشرده کردن یافته‌ها، یک یافته برای هر مقدار.
پیشنهادهاsuggestرشته = ""پیشنهاددهنده‌ها: بخش آن در درخواست، نتیجه‌ی خام در پاسخ.
نشانگر ادامهsearch_afterرشته = ""مقدارهای مرتب‌سازی خام آخرین یافته‌ی صفحه‌ی قبل.
شناسه نقطه زمانیpit_idرشته = ""شناسه‌ی نقطه‌ی زمانی: در درخواست برای جستجو در آن، در نتیجه شناسه‌ی تازه.
مدت نگهداری نقطه زمانیpit_keep_aliveرشته = ""مدت زنده ماندن نقطه‌ی زمانی، مانند 1m.
ردیابی کل یافته‌هاtrack_total_hitsرشته = ""true برای تعداد دقیق، یا یک عدد به عنوان سقف شمارش.
کمینه امتیازmin_scoreرشته = ""یافته‌های با امتیاز کمتر از این حذف شوند.
مهلتtimeoutرشته = ""مهلت سمت سرور مانند 30s.
افزودهextraوکتور<رشته>عضوهای خام که به بدنه اضافه می‌شوند، مانند "explain": true.

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

سطل Bucket

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

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

دسته‌ای Bulk

ساختار دسته‌ای
یک درخواست دسته‌ای در حال ساخت؛ کنش‌ها را با تابع‌های دسته‌ای اضافه کنید.
نامانگلیسیگونهتوضیح
خط‌هاlinesوکتور<رشته>خطوط NDJSON تا اینجا.
شمارcountصحیح = 0تعداد کنش‌های اضافه شده.
db-elasticsearch-Bulk.salam
واردسازی رشته
واردسازی دیتابیس.الستیک سرچ

تابع ریشه:
    ک := الستیک سرچ.اتصال("http://localhost:9200")
    ناپایا د := الستیک سرچ.دسته‌ای تازه()
    تکرار 1000 در ش:
        شناسه := رشته.از عدد(ش برگردان صحیح۶۴)
        الستیک سرچ.نمایه کردن دسته‌ای(د، "logs"، شناسه، `{"line":` + شناسه + `,"level":"info"}`)
    پایان
    الستیک سرچ.به‌روزرسانی دسته‌ای(د، "logs"، "7"، `{"level":"warn"}`)
    الستیک سرچ.درج روزآمد دسته‌ای(د، "logs"، "new"، `{"line":-1}`)
    الستیک سرچ.حذف دسته‌ای(د، "logs"، "8")
    سرچاپ الستیک سرچ.طول دسته‌ای(د)
    نتیجه := الستیک سرچ.اجرای دسته‌ای با گزینه(ک، ""، د، الستیک سرچ.گزینه‌ها { تازه‌سازی = الستیک سرچ.تازه‌سازی فوری })
    سرچاپ نتیجه.موفق، نتیجه.تعداد موفق، نتیجه.تعداد ناموفق، نتیجه.زمان اجرا
    اگر نتیجه.خطا دارد:
        هر قلم در نتیجه.اقلام:
            اگر وارونه قلم.موفق: سرچاپ قلم.عملیات، قلم.شناسه، قلم.وضعیت، قلم.نوع خطا، قلم.دلیل خطا پایان
        پایان
    پایان
    الستیک سرچ.بازنشانی دسته‌ای(د)
پایان

قلم دسته‌ای BulkItem

ساختار قلم دسته‌ای
نتیجه‌ی یک کنش در درخواست دسته‌ای.
نامانگلیسیگونهتوضیح
عملیاتactionرشته = ""index، create، update یا delete.
نمایهindexرشته = ""نام نمایه.
شناسهidرشته = ""شناسه‌ی سند.
وضعیتstatusصحیح = 0وضعیت HTTP، یا وضعیتی که برای این مورد گزارش شده.
موفقokمنطقی = نادرستآیا موفق بود.
نتیجهresultرشته = ""created، updated، deleted، noop یا not_found.
نسخهversionصحیح۶۴ = 0نسخه‌ی سند، یا نسخه‌ی خوشه برای Info.
نوع خطاerror_typeرشته = ""error.type الستیک سرچ.
دلیل خطاerror_reasonرشته = ""error.reason الستیک سرچ.

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

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

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

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

اطلاعات Info

ساختار اطلاعات
آنچه نقطه‌ی پایانی ریشه درباره‌ی خوشه می‌گوید.
نامانگلیسیگونهتوضیح
موفقokمنطقی = نادرستآیا موفق بود.
نامnameرشته = ""نام گرهی که پاسخ داد.
نام خوشهcluster_nameرشته = ""نام خوشه.
شناسه یکتای خوشهcluster_uuidرشته = ""شناسه‌ی یکتای خوشه.
نسخهversionرشته = ""شماره‌ی نسخه‌ی سرور.
توزیعdistributionرشته = ""elasticsearch یا opensearch.
نوع ساختbuild_flavorرشته = ""گونه‌ی ساخت، مانند default.
نسخه لوسینlucene_versionرشته = ""نسخه‌ی Lucene.
شعارtaglineرشته = ""شعاری که سرور می‌فرستد.

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

سلامت Health

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

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

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

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

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

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

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

پایا نشانی پیش‌فرض: رشته = "http://localhost:9200"
گره‌ای که وقتی پیکربندی هیچ گرهی ندارد استفاده می‌شود: http://localhost:9200.

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

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

پایا درگاه پیش‌فرض: صحیح۳۲ = 9200
درگاهی که وقتی نشانی گره درگاه ندارد استفاده می‌شود: ۹۲۰۰.

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

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

پایا مهلت گره از کار افتاده: صحیح۳۲ = 60000
مدتی به میلی‌ثانیه که گرهی که اتصال را نپذیرفته کنار گذاشته می‌شود و بعد دوباره امتحان می‌شود.

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

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

پایا تازه‌سازی فوری: رشته = "درست"
مقدار refresh: تغییر بلافاصله قابل جستجو شود.

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

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

پایا تازه‌سازی با انتظار: رشته = "wait_for"
مقدار refresh: تا تازه‌سازی بعدی صبر کن تا تغییر قابل جستجو شود.

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

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

پایا بدون تازه‌سازی: رشته = "نادرست"
مقدار refresh: بدون انتظار برای تازه‌سازی برگرد (پیش‌فرض).

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

تابع‌ها

ایجاد نمایه CreateIndex

تابع ایجاد نمایه(c: کارخواه، index: رشته، body: رشته): منطقی
نمایه‌ای با بدنه‌ی اختیاری تنظیمات و نگاشت می‌سازد.

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

حذف نمایه DeleteIndex

تابع حذف نمایه(c: کارخواه، index: رشته): منطقی
نمایه را حذف می‌کند.

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

نمایه موجود است IndexExists

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

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

دریافت نمایه GetIndex

تابع دریافت نمایه(c: کارخواه، index: رشته): رشته
تعریف JSON خام یک نمایه.

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

دریافت نگاشت GetMapping

تابع دریافت نگاشت(c: کارخواه، index: رشته): رشته
JSON خام نگاشت یک نمایه.

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

تنظیم نگاشت PutMapping

تابع تنظیم نگاشت(c: کارخواه، index: رشته، body: رشته): منطقی
فیلدهایی به نگاشت نمایه اضافه می‌کند.

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

دریافت تنظیمات GetSettings

تابع دریافت تنظیمات(c: کارخواه، index: رشته): رشته
JSON خام تنظیمات یک نمایه.

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

تنظیم تنظیمات PutSettings

تابع تنظیم تنظیمات(c: کارخواه، index: رشته، body: رشته): منطقی
تنظیمات پویای نمایه را تغییر می‌دهد.

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

تازه‌سازی Refresh

تابع تازه‌سازی(c: کارخواه، index: رشته): منطقی
تغییرات اخیر را قابل جستجو می‌کند؛ با نمایه‌ی خالی همه را.

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

تخلیه Flush

تابع تخلیه(c: کارخواه، index: رشته): منطقی
نمایه را روی دیسک می‌نویسد؛ با نمایه‌ی خالی همه را.

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

ادغام اجباری ForceMerge

تابع ادغام اجباری(c: کارخواه، index: رشته، max_segments: صحیح): منطقی
قطعه‌ها را ادغام می‌کند، تا max_segments وقتی بیش از ۰ است.

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

گشودن نمایه OpenIndex

تابع گشودن نمایه(c: کارخواه، index: رشته): منطقی
نمایه‌ی بسته را می‌گشاید.

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

بستن نمایه CloseIndex

تابع بستن نمایه(c: کارخواه، index: رشته): منطقی
نمایه را می‌بندد.

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

تنظیم نام مستعار PutAlias

تابع تنظیم نام مستعار(c: کارخواه، index: رشته، alias: رشته): منطقی
نام مستعاری را به نمایه اشاره می‌دهد.

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

حذف نام مستعار DeleteAlias

تابع حذف نام مستعار(c: کارخواه، index: رشته، alias: رشته): منطقی
نام مستعار را از نمایه برمی‌دارد.

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

نام مستعار موجود است AliasExists

تابع نام مستعار موجود است(c: کارخواه، alias: رشته): منطقی
آیا نام مستعار وجود دارد.

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

دریافت نام مستعار GetAlias

تابع دریافت نام مستعار(c: کارخواه، alias: رشته): وکتور<رشته>
نمایه‌هایی که نام مستعار به آن‌ها اشاره می‌کند.

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

جابجایی نام مستعار SwapAlias

تابع جابجایی نام مستعار(c: کارخواه، alias: رشته، old_index: رشته، new_index: رشته): منطقی
نام مستعار را به‌صورت اتمی از یک نمایه به دیگری می‌برد؛ گام معمول نمایه‌سازی دوباره بدون توقف.

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

به‌روزرسانی نام‌های مستعار UpdateAliases

تابع به‌روزرسانی نام‌های مستعار(c: کارخواه، actions: رشته): منطقی
آرایه‌ی JSON خامی از کنش‌های نام مستعار را به‌صورت اتمی اجرا می‌کند.

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

تنظیم الگوی نمایه PutIndexTemplate

تابع تنظیم الگوی نمایه(c: کارخواه، name: رشته، body: رشته): منطقی
الگوی نمایه‌ی ترکیب‌پذیر را می‌سازد یا جایگزین می‌کند.

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

حذف الگوی نمایه DeleteIndexTemplate

تابع حذف الگوی نمایه(c: کارخواه، name: رشته): منطقی
الگوی نمایه را حذف می‌کند.

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

الگوی نمایه موجود است IndexTemplateExists

تابع الگوی نمایه موجود است(c: کارخواه، name: رشته): منطقی
آیا الگوی نمایه وجود دارد.

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

نمایه‌سازی دوباره Reindex

تابع نمایه‌سازی دوباره(c: کارخواه، source: رشته، dest: رشته): صحیح۶۴
همه‌ی سندهای یک نمایه را در دیگری کپی می‌کند و تعداد نوشته شده را برمی‌گرداند؛ در خطا ‎-1.

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

تحلیل Analyze

تابع تحلیل(c: کارخواه، index: رشته، analyzer: رشته، text: رشته): وکتور<رشته>
توکن‌هایی که یک تحلیلگر از متن می‌سازد؛ با نمایه‌ی خالی از تحلیلگرهای خوشه استفاده می‌شود.

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

تنظیم خط لوله PutPipeline

تابع تنظیم خط لوله(c: کارخواه، id: رشته، body: رشته): منطقی
خط لوله‌ی دریافت را می‌سازد یا جایگزین می‌کند.

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

دریافت خط لوله GetPipeline

تابع دریافت خط لوله(c: کارخواه، id: رشته): رشته
JSON خام یک خط لوله؛ اگر نباشد خالی.

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

حذف خط لوله DeletePipeline

تابع حذف خط لوله(c: کارخواه، id: رشته): منطقی
خط لوله را حذف می‌کند.

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

شبیه‌سازی خط لوله SimulatePipeline

تابع شبیه‌سازی خط لوله(c: کارخواه، id: رشته، body: رشته): رشته
سندهای نمونه را از خط لوله عبور می‌دهد (با شناسه‌ی خالی خط لوله‌ی درون بدنه) و نتیجه‌ی خام را برمی‌گرداند.

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

ایجاد جریان داده CreateDataStream

تابع ایجاد جریان داده(c: کارخواه، name: رشته): منطقی
جریان داده می‌سازد؛ باید الگوی نمایه‌ی جور با data_stream وجود داشته باشد.

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

دریافت جریان داده GetDataStream

تابع دریافت جریان داده(c: کارخواه، name: رشته): رشته
JSON خام جریان‌های داده‌ی جور.

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

حذف جریان داده DeleteDataStream

تابع حذف جریان داده(c: کارخواه، name: رشته): منطقی
جریان داده و نمایه‌های پشتیبانش را حذف می‌کند.

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

چرخش نمایه Rollover

تابع چرخش نمایه(c: کارخواه، target: رشته، body: رشته): منطقی
نام مستعار یا جریان داده را به نمایه‌ای تازه می‌چرخاند، با شرط‌های اختیاری در بدنه.

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

تنظیم سیاست چرخه عمر PutLifecyclePolicy

تابع تنظیم سیاست چرخه عمر(c: کارخواه، name: رشته، body: رشته): منطقی
سیاست چرخه‌ی عمر می‌سازد: ILM روی الستیک سرچ و ISM روی OpenSearch. بدنه به قالب خود سرور است.

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

دریافت سیاست چرخه عمر GetLifecyclePolicy

تابع دریافت سیاست چرخه عمر(c: کارخواه، name: رشته): رشته
JSON خام یک سیاست چرخه‌ی عمر.

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

حذف سیاست چرخه عمر DeleteLifecyclePolicy

تابع حذف سیاست چرخه عمر(c: کارخواه، name: رشته): منطقی
سیاست چرخه‌ی عمر را حذف می‌کند.

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

تنظیم مخزن پشتیبان PutRepository

تابع تنظیم مخزن پشتیبان(c: کارخواه، name: رشته، body: رشته): منطقی
مخزن پشتیبان را ثبت می‌کند؛ مسیر fs باید در path.repo باشد.

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

حذف مخزن پشتیبان DeleteRepository

تابع حذف مخزن پشتیبان(c: کارخواه، name: رشته): منطقی
ثبت مخزن پشتیبان را برمی‌دارد.

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

ایجاد پشتیبان CreateSnapshot

تابع ایجاد پشتیبان(c: کارخواه، repository: رشته، snapshot: رشته، body: رشته): منطقی
پشتیبان می‌گیرد و تا پایانش صبر می‌کند.

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

بازیابی پشتیبان RestoreSnapshot

تابع بازیابی پشتیبان(c: کارخواه، repository: رشته، snapshot: رشته، body: رشته): منطقی
پشتیبان را بازیابی می‌کند و تا پایانش صبر می‌کند.

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

حذف پشتیبان DeleteSnapshot

تابع حذف پشتیبان(c: کارخواه، repository: رشته، snapshot: رشته): منطقی
پشتیبان را حذف می‌کند.

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

فهرست پشتیبان‌ها ListSnapshots

تابع فهرست پشتیبان‌ها(c: کارخواه، repository: رشته): وکتور<رشته>
نام پشتیبان‌های یک مخزن.

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

دریافت تنظیمات خوشه GetClusterSettings

تابع دریافت تنظیمات خوشه(c: کارخواه): رشته
تنظیمات خام خوشه به شکل تخت.

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

تنظیم تنظیمات خوشه PutClusterSettings

تابع تنظیم تنظیمات خوشه(c: کارخواه، body: رشته): منطقی
تنظیمات ماندگار یا گذرای خوشه را تغییر می‌دهد؛ null یکی را بازنشانی می‌کند.

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

دریافت کار GetTask

تابع دریافت کار(c: کارخواه، id: رشته): کار
وضعیت یک کار؛ تا completed شدن آن را بپرسید.

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

لغو کار CancelTask

تابع لغو کار(c: کارخواه، id: رشته): منطقی
کار در حال اجرا را لغو می‌کند؛ اگر هیچ گرهی آن را نشناسد نادرست.

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

شروع نمایه‌سازی دوباره StartReindex

تابع شروع نمایه‌سازی دوباره(c: کارخواه، body: رشته): رشته
نمایه‌سازی دوباره را در پس‌زمینه شروع و شناسه‌ی کارش را برمی‌گرداند.

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

شروع حذف با پرسمان StartDeleteByQuery

تابع شروع حذف با پرسمان(c: کارخواه، index: رشته، query: رشته): رشته
حذف با پرسمان را در پس‌زمینه شروع و شناسه‌ی کارش را برمی‌گرداند.

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

شروع به‌روزرسانی با پرسمان StartUpdateByQuery

تابع شروع به‌روزرسانی با پرسمان(c: کارخواه، index: رشته، query: رشته، script: رشته): رشته
به‌روزرسانی با پرسمان را در پس‌زمینه شروع و شناسه‌ی کارش را برمی‌گرداند.

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

تنظیم اسکریپت ذخیره PutStoredScript

تابع تنظیم اسکریپت ذخیره(c: کارخواه، id: رشته، lang: رشته، source: رشته): منطقی
اسکریپتی را ذخیره می‌کند: متن painless، یا الگوی جستجوی mustache به صورت JSON.

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

حذف اسکریپت ذخیره DeleteStoredScript

تابع حذف اسکریپت ذخیره(c: کارخواه، id: رشته): منطقی
اسکریپت ذخیره شده را حذف می‌کند.

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

جستجو با الگو SearchTemplate

تابع جستجو با الگو(c: کارخواه، index: رشته، id: رشته، params: رشته): نتیجه جستجو
الگوی جستجوی ذخیره شده را با پارامترهای JSON اجرا می‌کند.

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

ارسال جستجوی ناهمگام SubmitAsyncSearch

تابع ارسال جستجوی ناهمگام(c: کارخواه، index: رشته، req: درخواست جستجو، wait: رشته): جستجوی ناهمگام
جستجوی ناهمگام را شروع می‌کند و تا wait (مانند 1s) منتظر نتیجه می‌ماند. روی OpenSearch هم کار می‌کند.

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

دریافت جستجوی ناهمگام GetAsyncSearch

تابع دریافت جستجوی ناهمگام(c: کارخواه، id: رشته، wait: رشته): جستجوی ناهمگام
جستجوی ناهمگام را با شناسه می‌آورد.

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

حذف جستجوی ناهمگام DeleteAsyncSearch

تابع حذف جستجوی ناهمگام(c: کارخواه، id: رشته): منطقی
جستجوی ناهمگام و نتیجه‌ی ذخیره‌اش را حذف می‌کند.

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

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

تابع توضیح امتیاز(c: کارخواه، index: رشته، id: رشته، query: رشته): رشته
توضیح خام اینکه یک سند در برابر پرسمان چه امتیازی می‌گیرد.

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

اعتبارسنجی پرسمان ValidateQuery

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

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

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

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

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

بردارهای واژه TermVectors

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

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

آمار نمایه IndexStats

تابع آمار نمایه(c: کارخواه، index: رشته): رشته
آمار خام یک نمایه، یا با نام خالی همه.

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

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

تابع دسته‌ای تازه(): دسته‌ای
یک درخواست دسته‌ای خالی.

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

نمایه کردن دسته‌ای BulkIndex

تابع نمایه کردن دسته‌ای(b &: دسته‌ای، index: رشته، id: رشته، doc: رشته)
یک کنش نمایه کردن اضافه می‌کند؛ با شناسه‌ی خالی الستیک سرچ شناسه انتخاب می‌کند. JSON چندخطی فشرده می‌شود.

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

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

تابع ایجاد دسته‌ای(b &: دسته‌ای، index: رشته، id: رشته، doc: رشته)
یک کنش ایجاد اضافه می‌کند که برای شناسه‌ی موجود شکست می‌خورد.

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

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

تابع به‌روزرسانی دسته‌ای(b &: دسته‌ای، index: رشته، id: رشته، partial: رشته)
یک کنش به‌روزرسانی جزئی اضافه می‌کند.

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

درج روزآمد دسته‌ای BulkUpsert

تابع درج روزآمد دسته‌ای(b &: دسته‌ای، index: رشته، id: رشته، doc: رشته)
به‌روزرسانی‌ای اضافه می‌کند که اگر سند نباشد آن را می‌سازد.

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

حذف دسته‌ای BulkDelete

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

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

طول دسته‌ای BulkLen

تابع طول دسته‌ای(b: دسته‌ای): صحیح
تعداد کنش‌های درخواست دسته‌ای.

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

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

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

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

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

تابع بازنشانی دسته‌ای(b &: دسته‌ای)
درخواست دسته‌ای را برای استفاده‌ی دوباره خالی می‌کند.

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

تجزیه نتیجه دسته‌ای ParseBulkResult

تابع تجزیه نتیجه دسته‌ای(body: رشته): نتیجه دسته‌ای
پاسخ خام دسته‌ای را تجزیه می‌کند.

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

اجرای دسته‌ای RunBulk

تابع اجرای دسته‌ای(c: کارخواه، b: دسته‌ای): نتیجه دسته‌ای
درخواست دسته‌ای را می‌فرستد. اگر کنشی شکست بخورد ok نادرست است؛ items را ببینید.

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

اجرای دسته‌ای با گزینه RunBulkWith

تابع اجرای دسته‌ای با گزینه(c: کارخواه، index: رشته، b: دسته‌ای، opts: گزینه‌ها): نتیجه دسته‌ای
اجرای دسته‌ای با نمایه‌ی پیش‌فرض برای کنش‌های بی‌نمایه، و گزینه.

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

تجزیه نتیجه جستجو ParseSearchResult

تابع تجزیه نتیجه جستجو(body: رشته): نتیجه جستجو
پاسخ خام جستجو را تجزیه می‌کند، برای نمونه پاسخ انجام.

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

تابع جستجو(c: کارخواه، index: رشته، req: درخواست جستجو): نتیجه جستجو
روی یک نمایه، فهرستی جدا شده با کاما، یک الگو، یا با نمایه‌ی خالی روی یک نقطه‌ی زمانی جستجو می‌کند.

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

جستجوی پرسمان SearchQuery

تابع جستجوی پرسمان(c: کارخواه، index: رشته، query: رشته، size: صحیح): نتیجه جستجو
یک پرسمان را اجرا و تا size یافته برمی‌گرداند.

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

جستجوی خام SearchRaw

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

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

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

تابع جستجوی پیمایشی(c: کارخواه، index: رشته، req: درخواست جستجو، keep_alive: رشته): نتیجه جستجو
پیمایش را شروع می‌کند؛ پیمایش را با scroll_id صدا بزنید تا صفحه‌ای خالی برگردد.

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

پیمایش Scroll

تابع پیمایش(c: کارخواه، scroll_id: رشته، keep_alive: رشته): نتیجه جستجو
صفحه‌ی بعدی یک پیمایش.

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

پاک کردن پیمایش ClearScroll

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

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

گشودن نقطه زمانی OpenPit

تابع گشودن نقطه زمانی(c: کارخواه، index: رشته، keep_alive: رشته): رشته
یک نقطه‌ی زمانی روی نمایه برای صفحه‌بندی عمیق یکدست با search_after می‌گشاید.

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

بستن نقطه زمانی ClosePit

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

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

حذف با پرسمان DeleteByQuery

تابع حذف با پرسمان(c: کارخواه، index: رشته، query: رشته): صحیح۶۴
همه‌ی سندهای جور با پرسمان را حذف و تعدادشان را برمی‌گرداند؛ در خطا ‎-1.

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

حذف با پرسمان با گزینه DeleteByQueryWith

تابع حذف با پرسمان با گزینه(c: کارخواه، index: رشته، query: رشته، opts: گزینه‌ها): صحیح۶۴
حذف با پرسمان با گزینه‌هایی مانند refresh و conflicts.

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

به‌روزرسانی با پرسمان UpdateByQuery

تابع به‌روزرسانی با پرسمان(c: کارخواه، index: رشته، query: رشته، script: رشته): صحیح۶۴
اسکریپتی را روی همه‌ی سندهای جور با پرسمان اجرا و تعداد تغییر یافته را برمی‌گرداند؛ در خطا ‎-1.

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

به‌روزرسانی با پرسمان با گزینه UpdateByQueryWith

تابع به‌روزرسانی با پرسمان با گزینه(c: کارخواه، index: رشته، query: رشته، script: رشته، opts: گزینه‌ها): صحیح۶۴
به‌روزرسانی با پرسمان با گزینه.

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

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

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

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

مقدار تجمیع در AggValueIn

تابع مقدار تجمیع در(aggs: رشته، name: رشته): اعشار۶۴
مقدار value یک تجمیع سنجه درون JSON خام تجمیع‌ها، مانند Bucket.raw.

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

سطل‌های تجمیع در AggBucketsIn

تابع سطل‌های تجمیع در(aggs: رشته، name: رشته): وکتور<سطل>
سطل‌های یک تجمیع سطلی درون JSON خام تجمیع‌ها.

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

مقدار تجمیع AggValue

تابع مقدار تجمیع(res: نتیجه جستجو، name: رشته): اعشار۶۴
مقدار value یک تجمیع سنجه در نتیجه.

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

سطل‌های تجمیع AggBuckets

تابع سطل‌های تجمیع(res: نتیجه جستجو، name: رشته): وکتور<سطل>
سطل‌های یک تجمیع سطلی در نتیجه.

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

تجمیع خام AggRaw

تابع تجمیع خام(res: نتیجه جستجو، name: رشته): رشته
JSON خام یک تجمیع در نتیجه.

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

نمایه کردن Index

تابع نمایه کردن(c: کارخواه، index: رشته، id: رشته، doc: رشته): نتیجه نوشتن
یک سند را ذخیره می‌کند. با شناسه‌ی خالی الستیک سرچ شناسه‌ای انتخاب می‌کند که در id برمی‌گردد.

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

نمایه کردن با گزینه IndexWith

تابع نمایه کردن با گزینه(c: کارخواه، index: رشته، id: رشته، doc: رشته، opts: گزینه‌ها): نتیجه نوشتن
نمایه کردن با گزینه.

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

ایجاد Create

تابع ایجاد(c: کارخواه، index: رشته، id: رشته، doc: رشته): نتیجه نوشتن
سند را فقط وقتی شناسه‌اش تازه است ذخیره می‌کند؛ تکراری با وضعیت ۴۰۹ شکست می‌خورد.

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

ایجاد با گزینه CreateWith

تابع ایجاد با گزینه(c: کارخواه، index: رشته، id: رشته، doc: رشته، opts: گزینه‌ها): نتیجه نوشتن
ایجاد با گزینه.

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

دریافت Get

تابع دریافت(c: کارخواه، index: رشته، id: رشته): سند
سند را با شناسه می‌آورد. سند ناموجود found نادرست و بدون خطا دارد.

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

دریافت با گزینه GetWith

تابع دریافت با گزینه(c: کارخواه، index: رشته، id: رشته، opts: گزینه‌ها): سند
دریافت با گزینه؛ source فیلدهای برگشتی را پالایش می‌کند.

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

دریافت منبع GetSource

تابع دریافت منبع(c: کارخواه، index: رشته، id: رشته): رشته
فقط _source یک سند؛ اگر نباشد خالی.

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

موجود است Exists

تابع موجود است(c: کارخواه، index: رشته، id: رشته): منطقی
آیا سند وجود دارد.

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

به‌روزرسانی Update

تابع به‌روزرسانی(c: کارخواه، index: رشته، id: رشته، partial: رشته): نتیجه نوشتن
یک سند جزئی را با سند موجود ادغام می‌کند.

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

به‌روزرسانی با گزینه UpdateWith

تابع به‌روزرسانی با گزینه(c: کارخواه، index: رشته، id: رشته، partial: رشته، opts: گزینه‌ها): نتیجه نوشتن
به‌روزرسانی با گزینه، از جمله if_seq_no و if_primary_term برای هم‌روندی خوش‌بینانه.

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

درج روزآمد Upsert

تابع درج روزآمد(c: کارخواه، index: رشته، id: رشته، doc: رشته): نتیجه نوشتن
سند را به‌روز می‌کند، یا اگر نباشد آن را می‌سازد.

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

اسکریپت Script

تابع اسکریپت(source: رشته، params: رشته): رشته
شیء اسکریپت painless با پارامترهای JSON خام اختیاری.

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

به‌روزرسانی با اسکریپت UpdateScript

تابع به‌روزرسانی با اسکریپت(c: کارخواه، index: رشته، id: رشته، source: رشته، params: رشته): نتیجه نوشتن
سند را با یک اسکریپت painless به‌روز می‌کند.

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

حذف Delete

تابع حذف(c: کارخواه، index: رشته، id: رشته): نتیجه نوشتن
سند را با شناسه حذف می‌کند.

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

حذف با گزینه DeleteWith

تابع حذف با گزینه(c: کارخواه، index: رشته، id: رشته، opts: گزینه‌ها): نتیجه نوشتن
حذف با گزینه.

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

دریافت چندگانه MGet

تابع دریافت چندگانه(c: کارخواه، index: رشته، ids: وکتور<رشته>): وکتور<سند>
چند سند را در یک درخواست، به ترتیب شناسه‌ها، می‌آورد.

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

شمارش Count

تابع شمارش(c: کارخواه، index: رشته، query: رشته): صحیح۶۴
تعداد سندهایی که با پرسمان جورند (اگر خالی باشد همه)؛ در خطا ‎-1.

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

پینگ Ping

تابع پینگ(c: کارخواه): منطقی
آیا خوشه پاسخ می‌دهد.

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

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

تابع دریافت اطلاعات(c: کارخواه): اطلاعات
نام، نسخه و توزیع خوشه؛ روی OpenSearch مقدار distribution برابر opensearch است.

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

سلامت خوشه ClusterHealth

تابع سلامت خوشه(c: کارخواه): سلامت
سلامت خوشه.

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

انتظار برای وضعیت WaitForStatus

تابع انتظار برای وضعیت(c: کارخواه، status: رشته، timeout: رشته): سلامت
صبر می‌کند تا خوشه به وضعیتی مانند yellow برسد یا مهلت تمام شود؛ در پایان مهلت ok نادرست است.

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

آمار خوشه ClusterStats

تابع آمار خوشه(c: کارخواه): رشته
JSON خام آمار خوشه.

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

اطلاعات گره‌ها NodesInfo

تابع اطلاعات گره‌ها(c: کارخواه): رشته
JSON خام اطلاعات گره‌ها.

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

فهرست نمایه‌ها CatIndices

تابع فهرست نمایه‌ها(c: کارخواه، pattern: رشته): وکتور<اطلاعات نمایه>
نمایه‌هایی که با الگو جور هستند (اگر خالی باشد همه)، مرتب بر اساس نام.

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

اس کیو ال Sql

تابع اس کیو ال(c: کارخواه، query: رشته): ردیف‌های اس کیو ال
یک پرسمان اس کیو ال را با Elasticsearch SQL یا افزونه‌ی SQL اپن سرچ اجرا می‌کند.

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

اس کیو ال با پارامتر SqlWith

تابع اس کیو ال با پارامتر(c: کارخواه، query: رشته، params: وکتور<رشته>، fetch_size: صحیح): ردیف‌های اس کیو ال
اس کیو ال را با پارامترهای ? که مقدار JSON خام‌اند و اندازه‌ی صفحه اجرا می‌کند.

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

متن اس کیو ال SqlText

تابع متن اس کیو ال(c: کارخواه، query: رشته): رشته
نتیجه‌ی پرسمان اس کیو ال به صورت جدول متنی (روی OpenSearch به شکل CSV).

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

ترجمه اس کیو ال SqlTranslate

تابع ترجمه اس کیو ال(c: کارخواه، query: رشته): رشته
پرسمان DSL که یک پرسمان اس کیو ال به آن تبدیل می‌شود (روی OpenSearch برنامه‌ی اجرا).

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

اتصال عمومی Conn

تابع اتصال عمومی(c: کارخواه): dyn db.Connection
کارخواه به صورت db.Connection. بستن آن کارخواه را می‌بندد.

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

تطبیق همه MatchAll

تابع تطبیق همه(): رشته
پرسمانی که با همه‌ی سندها جور است.

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

تطبیق هیچ MatchNone

تابع تطبیق هیچ(): رشته
پرسمانی که با هیچ سندی جور نیست.

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

تطبیق Match

تابع تطبیق(field: رشته، text: رشته): رشته
پرسمان متنی کامل match.

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

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

تابع تطبیق همه واژه‌ها(field: رشته، text: رشته): رشته
پرسمان match که همه‌ی واژه‌ها را لازم دارد.

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

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

تابع تطبیق تقریبی(field: رشته، text: رشته): رشته
پرسمان match با تقریب خودکار که غلط تایپی را می‌بخشد.

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

تطبیق عبارت MatchPhrase

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

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

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

تابع تطبیق پیشوند عبارت(field: رشته، text: رشته): رشته
پرسمان عبارتی که واژه‌ی آخرش پیشوند است، برای جستجو هنگام تایپ.

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

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

تابع تطبیق چندگانه(text: رشته، fields: وکتور<رشته>): رشته
match روی چند فیلد؛ فیلد می‌تواند وزنی مانند title^2 داشته باشد.

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

واژه Term

تابع واژه(field: رشته، value: رشته): رشته
پرسمان مقدار دقیق term.

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

واژه عددی TermInt

تابع واژه عددی(field: رشته، value: صحیح۶۴): رشته
پرسمان term روی عدد.

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

واژه منطقی TermBool

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

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

واژه‌ها Terms

تابع واژه‌ها(field: رشته، values: وکتور<رشته>): رشته
با هر یک از چند مقدار دقیق جور است.

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

بازه Range

تابع بازه(field: رشته، low: رشته، high: رشته): رشته
پرسمان بازه‌ی بسته range؛ مرز خالی باز است. مرزها عدد یا تاریخ به صورت متن‌اند.

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

بازه باز RangeExclusive

تابع بازه باز(field: رشته، low: رشته، high: رشته): رشته
پرسمان range که مرزها را شامل نمی‌شود.

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

فیلد موجود FieldExists

تابع فیلد موجود(field: رشته): رشته
با سندهایی جور است که فیلد مقدار دارد.

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

پیشوند Prefix

تابع پیشوند(field: رشته، value: رشته): رشته
با مقدارهایی که با پیشوند شروع می‌شوند جور است.

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

نویسه عام Wildcard

تابع نویسه عام(field: رشته، pattern: رشته): رشته
پرسمان نویسه‌ی عام با * و ?.

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

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

تابع عبارت باقاعده(field: رشته، pattern: رشته): رشته
پرسمان عبارت باقاعده.

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

تقریبی Fuzzy

تابع تقریبی(field: رشته، value: رشته): رشته
پرسمان واژه‌ی تقریبی fuzzy.

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

شناسه‌ها Ids

تابع شناسه‌ها(ids: وکتور<رشته>): رشته
سندها را با شناسه جور می‌کند.

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

رشته پرسمان QueryString

تابع رشته پرسمان(query: رشته): رشته
پرسمان query_string با نحو Lucene.

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

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

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

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

ترکیب منطقی Bool

تابع ترکیب منطقی(must: وکتور<رشته>، filter: وکتور<رشته>، should: وکتور<رشته>، must_not: وکتور<رشته>): رشته
پرسمان bool از بندهای must، filter، should و must_not؛ هر فهرست می‌تواند خالی باشد.

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

همه شرط‌ها And

تابع همه شرط‌ها(clauses: وکتور<رشته>): رشته
وقتی همه‌ی بندها جورند جور است.

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

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

تابع یکی از شرط‌ها(clauses: وکتور<رشته>): رشته
وقتی دست‌کم یک بند جور است جور است.

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

نقیض Not

تابع نقیض(clause: رشته): رشته
وقتی بند جور نیست جور است.

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

پالایش شده Filtered

تابع پالایش شده(query: رشته، filters: وکتور<رشته>): رشته
پرسمان امتیازدار که با پالایه‌های بدون امتیاز محدود شده.

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

امتیاز ثابت ConstantScore

تابع امتیاز ثابت(filter: رشته): رشته
پالایه را اجرا می‌کند و به همه‌ی جورها امتیاز یکسان می‌دهد.

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

تودرتو Nested

تابع تودرتو(path: رشته، query: رشته): رشته
پرسمان روی شیءهای تودرتو زیر یک مسیر.

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

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

تابع فاصله جغرافیایی(field: رشته، lat: اعشار۶۴، lon: اعشار۶۴، distance: رشته): رشته
نقطه‌های جغرافیایی در فاصله‌ای مانند 10km از یک نقطه را جور می‌کند.

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

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

تابع نزدیک‌ترین همسایه‌ها(field: رشته، vector: وکتور<اعشار۶۴>، k: صحیح، num_candidates: صحیح): رشته
بند نزدیک‌ترین همسایه‌ی تقریبی برای جستجوی بردار متراکم؛ آن را در SearchRequest.knn بگذارید.

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

مرتب صعودی SortAsc

تابع مرتب صعودی(field: رشته): رشته
بند مرتب‌سازی صعودی.

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

مرتب نزولی SortDesc

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

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

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

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

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

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

تابع تجمیع واژه‌ها(field: رشته، size: صحیح): رشته
تجمیع سطلی terms، پرتکرارترین مقدارهای یک فیلد.

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

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

تابع تجمیع میانگین(field: رشته): رشته
میانگین یک فیلد.

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

تجمیع جمع SumAgg

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

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

تجمیع کمینه MinAgg

تابع تجمیع کمینه(field: رشته): رشته
کوچک‌ترین مقدار یک فیلد.

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

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

تابع تجمیع بیشینه(field: رشته): رشته
بزرگ‌ترین مقدار یک فیلد.

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

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

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

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

تجمیع یکتا CardinalityAgg

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

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

تجمیع آمار StatsAgg

تابع تجمیع آمار(field: رشته): رشته
شمار، کمینه، بیشینه، میانگین و مجموع با هم.

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

تجمیع بافت‌نگار HistogramAgg

تابع تجمیع بافت‌نگار(field: رشته، interval: اعشار۶۴): رشته
سطل‌هایی با پهنای عددی ثابت.

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

تجمیع بافت‌نگار تاریخ DateHistogramAgg

تابع تجمیع بافت‌نگار تاریخ(field: رشته، calendar_interval: رشته): رشته
سطل برای هر بازه‌ی تقویمی مانند day یا month.

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

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

تابع تجمیع پالایه(query: رشته): رشته
یک سطل از سندهایی که با پرسمان جورند.

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

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

تابع تجمیع برترین یافته‌ها(size: صحیح): رشته
بهترین یافته‌ها درون هر سطل.

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

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

تابع افزودن تجمیع(aggs: رشته، name: رشته، agg: رشته): رشته
یک تجمیع نام‌دار به شیء تجمیع‌ها اضافه می‌کند؛ از رشته‌ی خالی شروع کنید.

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

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

تابع زیرتجمیع‌ها(agg: رشته، aggs: رشته): رشته
شیء تجمیع‌ها را زیر یک تجمیع سطلی می‌گذارد.

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

افزودن عضو AddMember

تابع افزودن عضو(obj: رشته، key: رشته، raw: رشته): رشته
عضو خامی به یک شیء JSON اضافه می‌کند، برای گزینه‌هایی که تابع کمکی ندارند.

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

بدنه جستجو SearchBody

تابع بدنه جستجو(req: درخواست جستجو): رشته
بدنه‌ی JSON یک درخواست جستجو.

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

پیکربندی پیش‌فرض DefaultConfig

تابع پیکربندی پیش‌فرض(): پیکربندی
پیکربندی برای نشانی پیش‌فرض با مهلت و تلاش دوباره‌ی پیش‌فرض.

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

کارخواه تازه NewClient

تابع کارخواه تازه(cfg: پیکربندی): کارخواه
از پیکربندی یک کارخواه می‌سازد. نشانی گره می‌تواند اعتبارنامه (https://user:pass@host:9200) و پیشوند مسیر داشته باشد و یک رشته می‌تواند چند گره را با کاما جدا کند.

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

اتصال Connect

تابع اتصال(url: رشته): کارخواه
کارخواه برای یک نشانی، یا چند نشانی جدا شده با کاما.

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

اتصال با رمز ConnectAuth

تابع اتصال با رمز(url: رشته، username: رشته، password: رشته): کارخواه
کارخواهی که احراز هویت پایه‌ی HTTP می‌فرستد.

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

اتصال با کلید ConnectApiKey

تابع اتصال با کلید(url: رشته، api_key: رشته): کارخواه
کارخواهی که با کلید API احراز هویت می‌کند، چه کدگذاری شده و چه به شکل id:key.

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

اتصال ابری ConnectCloud

تابع اتصال ابری(cloud_id: رشته، api_key: رشته): کارخواه
کارخواه برای یک استقرار Elastic Cloud، از شناسه‌ی ابری و کلید API آن.

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

معتبر Ok

تابع معتبر(c: کارخواه): منطقی
آیا کارخواه دست‌کم یک گره معتبر دارد.

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

خطا Error

تابع خطا(c: کارخواه): رشته
خطای آخرین فراخوانی: نوع و علتی که الستیک سرچ فرستاده، یا خطای اتصال یا پیکربندی. پس از موفقیت خالی است.

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

نوع خطا ErrorType

تابع نوع خطا(c: کارخواه): رشته
error.type آخرین فراخوانی ناموفق، برای نمونه version_conflict_engine_exception.

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

علت خطا ErrorReason

تابع علت خطا(c: کارخواه): رشته
error.reason آخرین فراخوانی ناموفق.

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

وضعیت Status

تابع وضعیت(c: کارخواه): صحیح
وضعیت HTTP آخرین فراخوانی؛ اگر پاسخی نیامد ۰.

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

گره‌ها Nodes

تابع گره‌ها(c: کارخواه): وکتور<رشته>
نشانی گره‌هایی که کارخواه بینشان می‌چرخد.

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

سرآیند احراز AuthHeader

تابع سرآیند احراز(c: کارخواه): رشته
مقدار سرآیند Authorization که کارخواه می‌فرستد.

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

کدگشایی شناسه ابری DecodeCloudId

تابع کدگشایی شناسه ابری(cloud_id: رشته): رشته
شناسه‌ی Elastic Cloud را به نشانی HTTPS نقطه‌ی پایانی الستیک سرچ آن تبدیل می‌کند؛ اگر کدگشایی نشود خالی است.

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

بستن Close

تابع بستن(c &: کارخواه)
کارخواه را آزاد می‌کند. پس از آن دستگیره تهی است.

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

انجام Perform

تابع انجام(c: کارخواه، method: رشته، path: رشته، body: رشته): پاسخ
هر درخواستی را با بدنه‌ی JSON می‌فرستد و پاسخ خام را برمی‌گرداند. برای هر API که این بسته تابعی برایش ندارد از آن استفاده کنید.

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

انجام چندخطی PerformNdjson

تابع انجام چندخطی(c: کارخواه، method: رشته، path: رشته، body: رشته): پاسخ
مانند انجام، با بدنه‌ی application/x-ndjson.

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

توزیع Distribution

تابع توزیع(c: کارخواه): رشته
elasticsearch یا opensearch؛ یک بار از سرور پرسیده و به خاطر سپرده می‌شود.

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

اوپن سرچ است IsOpenSearch

تابع اوپن سرچ است(c: کارخواه): منطقی
آیا خوشه OpenSearch است. فراخوانی‌های اس کیو ال و نقطه‌ی زمانی خودشان نقطه‌ی پایانی درست را انتخاب می‌کنند.

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

کدگذاری پایه EncodeBasic

تابع کدگذاری پایه(username: رشته، password: رشته): رشته
base64 رشته‌ی user:password که در احراز هویت پایه به کار می‌رود.

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