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

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

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

واردسازی دیتابیس.الستیک سرچ

در این صفحه

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

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

گونه‌ها

پیکربندی `Config`

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

همه‌ی آنچه کارخواه لازم دارد: گره‌ها، اعتبارنامه، TLS، مهلت، تلاش دوباره و سرآیندهای اضافه.

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

db-elasticsearch-Client.salam

واردسازی دیتابیس.الستیک سرچ

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

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

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

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

کارخواه `Client`

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

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

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

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

پاسخ `Response`

ساختار پاسخ

پاسخ خام انجام: وضعیت، بدنه و پاکت خطای تجزیه شده.

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

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

گزینه‌ها `Options`

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

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

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

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

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

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

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

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

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

سند `Document`

ساختار سند

یک سند دریافت شده با فراداده و _source خام.

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

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

یافته `Hit`

ساختار یافته

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

نام	انگلیسی	گونه	توضیح
index	`index`	`رشته = ""`	نام نمایه.
id	`id`	`رشته = ""`	شناسه‌ی سند.
score	`score`	`اعشار۶۴ = 0`	امتیاز ارتباط.
source	`source`	`رشته = ""`	پالایش منبع: در `Options` فهرست فیلدها با کاما، در `SearchRequest` فیلدهای برگشتی؛ در نتیجه‌ها JSON خام `_source`.
sort	`sort`	`رشته = ""`	بندهای مرتب‌سازی در درخواست؛ در یافته مقدارهای مرتب‌سازی خام برای `search_after`.
highlight	`highlight`	`رشته = ""`	برجسته‌سازی: بخش آن در درخواست، تکه‌های خام در یافته.
fields	`fields`	`رشته = ""`	فیلدهای ذخیره یا زمان اجرا: در نتیجه JSON خام، در `SearchRequest` فهرست فیلدها.
raw	`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")
    درخواست := الستیک سرچ.درخواست جستجو {
        query = الستیک سرچ.پالایش شده(الستیک سرچ.همه شرط‌ها(بایدها)، پالایه‌ها)، size = 10، sort = ترتیب، aggs = تجمیع‌ها، highlight = الستیک سرچ.برجسته‌سازی(فیلدها)
    }
    نتیجه := الستیک سرچ.جستجو(ک، "books"، درخواست)
    اگر وارونه نتیجه.ok:
        سرچاپ الستیک سرچ.خطا(ک)
        برگشت
    پایان
    سرچاپ نتیجه.total، نتیجه.total_relation، نتیجه.took
    هر ی در نتیجه.hits:
        سرچاپ ی.id، ی.score، ی.source، ی.highlight
    پایان
    سرچاپ الستیک سرچ.مقدار تجمیع(نتیجه، "newest")
    هر د در الستیک سرچ.سطل‌های تجمیع(نتیجه، "by_author"):
        سرچاپ د.key، د.doc_count، الستیک سرچ.مقدار تجمیع در(د.raw، "avg_year")
    پایان

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

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

نتیجه جستجو `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`	`رشته = ""`	پیشنهاددهنده‌ها: بخش آن در درخواست، نتیجه‌ی خام در پاسخ.
scroll_id	`scroll_id`	`رشته = ""`	شناسه برای `پیمایش` بعدی.
pit_id	`pit_id`	`رشته = ""`	شناسه‌ی نقطه‌ی زمانی: در درخواست برای جستجو در آن، در نتیجه شناسه‌ی تازه.
raw	`raw`	`رشته = ""`	JSON خامی که از آن تجزیه شده.
error	`error`	`رشته = ""`	متن خطا؛ در موفقیت خالی.

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

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

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

یک درخواست جستجو؛ بدنه جستجو آن را به JSON تبدیل می‌کند. فیلدهای خالی حذف می‌شوند.

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

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

سطل `Bucket`

ساختار سطل

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

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

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

دسته‌ای `Bulk`

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

یک درخواست دسته‌ای در حال ساخت؛ کنش‌ها را با تابع‌های دسته‌ای اضافه کنید.

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

db-elasticsearch-Bulk.salam

واردسازی رشته
واردسازی دیتابیس.الستیک سرچ

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

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

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

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

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

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

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

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

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

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

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

اطلاعات `Info`

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

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

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

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-elasticsearch-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-elasticsearch-Client.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-elasticsearch-Client.salam

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

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

نتیجه‌ی پرسمان اس کیو ال؛ db.Rows را پیاده می‌کند و با فراخوانی بعدی صفحه‌های بعدی را با مکان‌نما می‌آورد.

نام	انگلیسی	گونه	توضیح
handle	`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	`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	`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

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

نشانی پیش‌فرض `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

تابع‌ها

تطبیق همه `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

دسته‌ای تازه `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

پینگ `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

ایجاد نمایه `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

نمایه کردن `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

پیکربندی پیش‌فرض `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

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

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

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

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

جستجو `Search`

تابع جستجو(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

اس کیو ال `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

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

گونه‌ها

پیکربندی Config

کارخواه Client

پاسخ Response

گزینه‌ها Options

نتیجه نوشتن WriteResult

سند Document

یافته Hit

نتیجه جستجو SearchResult

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

سطل Bucket

دسته‌ای Bulk

قلم دسته‌ای BulkItem

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

اطلاعات Info

سلامت Health

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

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

معتبر Ok

خطا Error

بعدی Next

تعداد ستون ColumnCount

نام ستون ColumnName

نام نوع ستون ColumnTypeName

نوع ستون ColumnType

خالی است IsNull

متن Text

عدد صحیح Int

عدد صحیح۶۴ Int64

عدد اعشار Float

بستن Close

پایگاه داده Database

نوع Kind

معتبر Ok

پینگ Ping

اجرا Exec

پرسمان Query

شروع تراکنش Begin

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

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

خطا Error

نقل قول Quote

بستن Close

تراکنش Txn

معتبر Ok

اجرا Exec

پرسمان Query

ثبت تراکنش Commit

بازگردانی Rollback

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

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

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

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

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

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

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

تابع‌ها

تطبیق همه MatchAll

تطبیق هیچ MatchNone

تطبیق Match

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

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

تطبیق عبارت MatchPhrase

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

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

واژه Term

واژه عددی TermInt

واژه منطقی TermBool

واژه‌ها Terms

بازه Range

بازه باز RangeExclusive

فیلد موجود FieldExists

پیشوند Prefix

نویسه عام Wildcard

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

تقریبی Fuzzy

شناسه‌ها Ids

رشته پرسمان QueryString

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

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

پیکربندی `Config`

کارخواه `Client`

پاسخ `Response`

گزینه‌ها `Options`

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

سند `Document`

یافته `Hit`

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

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

سطل `Bucket`

دسته‌ای `Bulk`

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

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

اطلاعات `Info`

سلامت `Health`

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

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

معتبر `Ok`

خطا `Error`

بعدی `Next`

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

نام ستون `ColumnName`

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

نوع ستون `ColumnType`

خالی است `IsNull`

متن `Text`

عدد صحیح `Int`

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

عدد اعشار `Float`

بستن `Close`

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

نوع `Kind`

معتبر `Ok`

پینگ `Ping`

اجرا `Exec`

پرسمان `Query`

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

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

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

خطا `Error`

نقل قول `Quote`

بستن `Close`

تراکنش `Txn`

معتبر `Ok`

اجرا `Exec`

پرسمان `Query`

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

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

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

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

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

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

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

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

تطبیق همه `MatchAll`

تطبیق هیچ `MatchNone`

تطبیق `Match`

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

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

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

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

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

واژه `Term`

واژه عددی `TermInt`

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

واژه‌ها `Terms`

بازه `Range`

بازه باز `RangeExclusive`

فیلد موجود `FieldExists`

پیشوند `Prefix`

نویسه عام `Wildcard`

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

تقریبی `Fuzzy`

شناسه‌ها `Ids`

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

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

ترکیب منطقی `Bool`

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

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