From 2d1bb1f2360908dbaeb5f15220138859a0c7e9ae Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Tue, 25 Feb 2025 18:50:29 -0600 Subject: [PATCH 1/2] delete asciidoc files --- docs/images/logo.png | Bin 10539 -> 0 bytes docs/index.asciidoc | 6 --- docs/installation.asciidoc | 20 --------- docs/overview.asciidoc | 90 ------------------------------------- 4 files changed, 116 deletions(-) delete mode 100644 docs/images/logo.png delete mode 100644 docs/index.asciidoc delete mode 100644 docs/installation.asciidoc delete mode 100644 docs/overview.asciidoc diff --git a/docs/images/logo.png b/docs/images/logo.png deleted file mode 100644 index 29eb8c9986558e2ca5a2ed57313267d26e4f494d..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 10539 zcmbVS2UJsCwhp~_q?ZsxL|SN}_ui2X(n1m-2!sxy_a*`&T@(-yL`6hIkQRDCMVf;2 z4uW)~gD?JV=ASk5-mG`mx;f{b{hi(S*~wi=HZjtsB4;B90030FIvS?95&r8YCB}Vv zFJznJ1~P9Q8$SR*g!k8t7hJ9!2mp}GA-UC5DE75#-RZK1?6CG zDC{=EALxv5MS3ZMwwu~OKqOodWF=(?HuP3UxFK~yd=X|LM&_`P+b~%;NLdM}5G;pd z;EC{u0)st0y!_;X6+yr8mBY<{EsKJHzd`(OD}q#i2?SajngG>Nz6c;h1S|{#gQbAd zvLa#-Nhw*d5KtT}4i*&?7X`}-i;2leNy|w}0{^%`IBC9c7dcZ6tv_Vpo)kfD{{G%_ zqM|`TK_WpCA}C*1Q88IrSy8aKsJOT=4k7G^_VR}Y3w!zT{>ecD;Ro|Ydix_$Ucg@* zq0XoPe?<^Z)89?-^!|&jm){?5!Z}Pd80sx5CIbFt(r-XG>@S>mfUn1I!r?Gcga^VC z;pOj#!;1Zd^>#z~qx{@Z|AF;iMELn@2I9>4!y*3`?Prem zMu?gs{7?bDFob3xPEFoFt?@^?{KK7p+x?63H@y(S$o~NSMfnTrEvN2_fcm3+%~2?i zKf`bGrz3#s>bP)=Nr^}SuUjF#;HV%!fnU1(u?wLA^+zaza0rMnE*r!p%*CYSBxL0z zr3A&ma$xZ9P(u_P>4N?fDlR4r78e$iHWw3@lY-#Te}m$(5f1f-{-0ntOwI-6>j}mA z66pzbMTmNPxq^UyMMzE^<$?0W3C3wB@z3kJ>gp!GC>Nv$j^Jmitp?Q9RELPkLLkE8 zB4WR(YiKB^>*ePU^@1UEH55TOTSbsaI4=JrVA2o-Tv!?kl@&%vNy3GpGH^*@gsixv z6x7ApMGOl0bH4@(7Vs;(e(nFg(BLQ-j>kXLlNEQ7m6nFUgyAv>F=4o*Bvcp*b%qK{ zON&cOIzwD!5HRUKxf%N+akUQh_-C%aw1VR}g5gjpgtQDq7%mQW7Dk9kLU4S*5MhXv z1Og0!z@%iHaeRK|h8&I!P9^BCf>H$GO#N-q`d6BH1pK}z0sie075g>(0kHYM0RNy{ zcp-7o5C;K&<=5{4FvFczI7dUIq$H&NST{iiBRs4%kU0PN{jQ4G-$*w9Li%-l{i-lI z9i$&FOVNKEFlGp!KV}|C;BQ4G2ZjA^2JBZpBjBJvmXZG^nE##IerFrxhQK-Oe@XG* zVSXqV{~)L@Le&-L<^QgZME{coe$c@GU4LhYn6$IAv$QZSRJc5pmXs8BmV!CsW?~SC zEEt!NlFonH|L^pd6qghKtM2~a`v2izm>bl~6@lwPqM-l3MgLuS{XHW8@g(`LEE2~R z{68ORzi;{%V?=+op5Jp#^k38PH`+h7DO@yvTf+6eU(>&uF7Dy4wvF(@`NrvepQzxE5Qb|0jD6+CBuVUtL zn(uh^c#83}g5>+zUKq-G4JRpYF>h)xs$i@Ma|h!Xr5z=#()&RQwNBfMra?38M9gun zae>Xo@u%>os62|=L(-ELvoqcTxV4W+XN6`eI1N7-4|YyIUkv6gV>{;BF;)rgpm!h_ zXTSNCGXtf)+=TgtmrbZZ%L8`DxT{&eAe}WOeMD}#Kfl$)d2BpaA#oUabf@jT z8MBE&bL^F^4-T3R&Qy=dMg6Ys-+~+2{iAFJ-!SW&m9;Dg; zvDg-8ah(hm2p$AWRHXgk%mH1(=*=Y|S@Gd2j}@LHfQdtsvyG68Btqw&^|Mn{&m@|N zg_;mnkOYGqk!9fT3Fx4)Cq-&?7d6d;6qpCmt);D#l(e8BQE$6QV(+7aMUQV?>;~#z zh!`{^qlTDz6*!TxX&F0%Zn1^C#oA^`DN!MrU(M-bb5Pm2 z$5(ddOItn~(E2iXYwD(KI=`H~8$N4U`0-(IxGtkwR{H+gBz3B$RG$9E8_BDLEVXO= zn5?9P>piu^Q@Lk-({CEfe5L%EZ#0q#`E6z3%{9(Z5QuEeq$7pfSq4-DZ(#_|@mOY()?2C- zj$W%+lv`NoVM7Im1)kO!F03mr{&)g5_K0gPb*z^$pyC}1Azwzbcz!Pbc4BY4$Wvj` zCzgmWRD+Q}Cdit0C~Tzkq^=~*rUgYs3L0V0_s9xY<)v7wrCZQrX4o3;Qa*>QwPJC3 z^06`KcXpG2Rl}2oBPc|Q z4Co0Hs#Jw&Xy3Q+5^M-365ixU%*yzhtT$y=cq2;xMpbpp?Hmd5v<9w2UeQ<{TDsYT zP?9;sKFggAeaF_8iW(PLYJnwoe4U}fW4QTk%tI$N z$67bD-)m%lu#jKl%6DNEXNDyjMpqG%#|)0rvNw3H%1jjcbNNzth*!d+pK{R9?eeaU zG4ibdUu(ZL&~q5dJ~8J}T|Rp3E6P-1Nx*Mm^0`h7ax>W7oKxIW2QObi%aara-Lwvg z;Jz_wQ#>z|r_LDiYC|?dkS@}&E^@rigp3Ea5QmI{GMY&SkVfl$#h#La*jNlL1LYe? z((jyvF+MH^z6oNguyrG8L6*>~X>npTEC6)%CVhom4scZq#q75Ns))U$1eT8L?pm#! z&CS}Lu92{JcU9{ps`5F1D0RCP%mNJVW(6`1 z%c=wPK)aKK64GAU)*WDyU z=)x7^k`hgHnQa)fAdKik8T;#@s9ouxFjbv?V$RUa%=^w&adwnpl!iTBo@CZ6@7cgP zNVAZ+y|KkD`M4k_T32o9fqIdt7J^`s#GS)~#pcnwKRw?EYzwH!D$WHCTr6wLYI&Sl zN@1OR2I@9J+9CdAVHC%b6L%{JIdv0ruuB#!6z*WAQKyIH<;vS8Y}**X$w$ud$ge3U zRhDsWYo}B1Lv;4@dq2gcIr-1jEHM7?q}gnf66Q$DfYb>ZC6i;!ypLuWm1mSb=o3Kr z&2JTcom+k00~CA~E}8gIS8Ap9THJFo=%Zn^9mSW!clvIU>6Z+PrW&sGQt_;DEky4~ zF;%QYy%>4nF0Qsx+Op?hUwEwJnt)PP#=tmPP4Q!t`dVXIzib)P9kNPl2<2!Q=4c9A zjvdRoIz*jjsE%hXt`Zj66s(j3PduVYWBZw;d)bJ{h6la{k{AmN_z(K&v`hJ>NEsFH zRT6IzI5-vtU*xE^?wBjrFWzK+y~C_wK{I`u!}wm{6=bjal44oLsJ5X|n$7d)^)ih; zpQ_lnDN32{wkLaVP|wVyF9yuUktV8q40w}#{n&%AJsW%Cs4aQ%a!)OEi2KkJlOXWf zR!axa5L*jfH`_RCxa@NPNkzExUaNj~EzAO67>}Hgyqjl|H#?yHrc)GD&$36z=p{|f zjjhG0dRoC}y;D)ffs?YE?7(&_CQev)Apg|rHmTMdOj?D`(v?md5<4Pf?h`rXTQer-<&$3v)HsaayOwe1UeQ~Sl1FHnw7YD;C0;cVdPQBKEz74meoae?0bsL-M z?@Xvxh?7HT9yUSFGSb<71w(+eGnRrf3DZzuqg7;Pr?YlSlqbr*XjCBS$zVWH8 z)t8AUoknViG~MQ4oxRxDx7#fZW!)=2j6-)#y0h-(pP!35wudzcv2AMcp;wT~fSRv`t`D26-4>UnGkC+C6Tw{^a!|Ugwu2tJZQB#&Iz# z6GrapcJKM`>3fmDKJf6aHrR#thE%sM^E9u61B89dXEcLT3f93Eci6uA7pL#HUTAZP zaCT76$!7@*U$u2rmV44j?iJ>f)GV;`3D=Ja7L@L9UdTqgmAA;^r46tu=D@tBfE~Ts z5{Q@55=rjYUy4D2CaWugzd;K9j**T!GobB6}`%k7x(u3LOg1%uzXI8&F-e!8LPr6*H{UMH;lV32m@I zFCO=5$pt=X;RI0;C&-67bcXRUigzca<2VuQ&Qa*I&r>g z`I8kMq6XQ-f-ko9-{r8bTVb`$*xc(f>8S@9H=Du5FCtrEOC17)2mBlh77<2OB2wI> zKl_qSq=8n?HS6suT8T3HR03JzI#ch9gT6e;q_s}5^Wg>^)@Ool2XQWW&Ne?>4GJ&| z?@%~T=z6%IAjm=E=vR2_i|6v!!%W>))|L%QvbwY~xoYQ0C$2b1?k8M1#%sdPq6}|! zEkx_vHuw*95kux3lif~k^rW=$GG7qV$&l6BD1NOHk{CASsrx3At=2WrW&MhYPT@rv z_GQsTyL?+X2?_DY=p!(Vx;;=G(61AuxMbLQca>`(AJ_N)qe2oIbWgKm`1jZ#v?G@XXXvZ zi^a-T?h<0|*zXY;vNd57pGRWFR|$HMwr?qTJ_7OZZce4KT}%rf$`?aUjE zMK*HiL2ZfiGO0FOmK&cL7E^G3zw;$S)o>6V={50Wj<*9vdO9Ma9xkg?D>q=cDwz}3 zmS$?#>ZAC!wK@B=fVd+kzQPGx-+199{}!j%-Cg3#)!{34gM$WBH!Nn7u{KFqn~ceX zu}F!7>FEAu%Hc2VM3fZGF#*PmJxd1kcHF*whPLu1agXXgD%(d&-pGgo+(tl7i-#ZMeeH6D4>XEt*?QSY9j3NN5FY= zYHD=zM?Pca{ulCZhs?)x2J5izM9`o3-1F-!KASS6)Ogk89-)G>-aZeFVn6&|ESSp~ zss59Esrjc$^|7Gu(2pbxId3 z;%fQM(u6F3F1?yJ71oV`oHT} zSnn@&o-bp#3U0I4lqGLAmc}*e%{Nd(N3?HQP+3HivNLp^zkgC8<2p?cw$*+2yB=T9 z?38Vi+woQ36N04jx4_4!I6LZW)&vdwdB-T9J>Deir}s}g<>hVm?<&_I9cgx#J&z4w zxVCl@N@tq6%P24@Fp!dm=~>7!+Xy=z1c4JO?H)50qz;tDZrq3nG$ODP5&hviDPg6=(NegEEv)vu2XUx%MDc`4VVQ#`oU(2U@59UaYe zaC^gZTM1ynT#~@0_G5-r55zPLxXk2ZX$yDZx0kW{cG>|LxVw< zJ20~7XU)7yO%-*qLF1BS`E+)l$_2M~My4lErY~FUrl$HyY?-_*Jqd1>>HxqCNd@}2 zT3}qs80K`9uAc6wKsjnV=&etz?{XN+LqBAmzXTA(L$jtZ_tu>3j?&5`38`jYOR6bt z-0Z7C>O|AWgty2R2=^6zLUC#LTqr)YtGz^hH>$|9vWQLQDtJO*ERbc&qBcCYKg5w7 zjoh2OXlmTa*G8Y2(d<{mZXS#`4pSf+;!-tc=HCY?^;x`q-c5E~`Rwk3oR{XL;1hDZ z>z{a?^GCJuyKOpoiL34m;c?@w=`XE%6#^igQ3(3_os}S;lf$$j8r_%z|G!4tMbuH4?VTzS|4+ha1=?a=in%k+FxJj=B$b zqB+vO-+KWtQyCb6H&^pvV{_}$co!2CCr>aV=?h0BZYf>fQ~4M4SLQ;vlz5PLEpM`? z)uMxw(v{vml1f*`wr!8A^>9AWP$UXHrH=x!?Qnl~Mpe|MY3Be*hx?D5sa+o}>KtfeM1$*R$Tieukd_U-re+taJ<)GZ9-+UG}Ky)q(K zo$&!Hc5g64a#ocr&Ub(2Kh6kv66aVrjY)C8a~Q#nO!DDM=5_Y$*GNU3>MHl%%hpL+?jPQt(36hTgnX zUlz5wBa-9A%V`BgnH7?jT7iLO*Oy(K1|_LqOS`~VJJpdZQavXJUl$)wUy@=CBpqkd z(*k6wa;@oKHym}K!{!g<9+OiaOn%=Sm|Ir3-1ul{x4&MHNgjBO!LIp|=SyI~u(iGV zpkzAwQy#4z-4U)oBaUAxie|&ZPYdspS;Xt`iRZ0+SZ~V4?*wC4_A;?`BweuTQWgMQNMTj~ccb{|sT(+u2RNI{f8+jb?U@#$lr zc_o!!Eagx!{bY5}=(;`|JllDD5P-VvRr>X%qd~x+vB>t$4ono<-I@0!nlT=|?^f^< zQ%7mX*eNe}vZMKO`8IQQ*LZ)aJcdce7x4P?TD89xTFa`Z{OJee>Ag!Xk#J|>i~dq6 z+xWdHy%_lqH|l=ADuWfL2Yqzx@_dPAuvC4=h8-{T{fLsSdB)%la$?K72b_}O)^rrpU0 zxr8fqT~#JC9yS(fTu&rfum~L&)93PMYBMHfKSQ2|W{^m4FXkU|ecArzJmyVYTYpIR znlkJaP9jZT()+xE(SQ$i2IAj@`t0rP4id7@4;h&0_j6emAtf|SEK;0C{9UsGZi(;S z4?aL^`E)+w42#$wSt=`&qVIgr2~Wjj5^r`A6pn$@Cmr{-s$L9hKCfVW*oma((0f&0 zTJ(bCbbL4wq8y=y(H<0kRi;8NR;$j|`$Ok|9}{@IK=g9HAn2iP!zjyJ z?qER^(4GaopO4s1P%+V5$tBm9^9!XcN#tFN#gMH+ega7z5(xpqn&s~l)=Wxa*7QVW zzUV`4z1j#@eo=p_nm4XVoZ+1ZKlpVJeoh5*Z-K6`WqV6ukEJ`eE%#@}9+^1U^Pet8 zJXa{q+{}(;q_S@^B~u`@Xs3NtaHa?&B-d0z`FVvie7qFn%zfsOxGd%{ErRXALfFm$!wJ^rJ(=yI!!FZ7q1b>d1@1)} zV+y1z2rdES%VB(7#q$ukHa`oq5HhO68nw-1P~+p_G!+mBOvf>6SD0bkbGA5^Hnj}3 zLGvpM=T#?#ZKm>$K~!aKNksR0;@B{bC8dGJAzv)`;zmuE@}_TrOAGwk^}|y#RC)qb zb&S&PYPOjKe`gC$U6tD|<9|ihc73$Mxsz7vQAyrlkA$uFi?4!W^D|@nsPK!+3sgDZQE= z$L)tcTT;Dvalq9jU#EqS*xRBc1o<-(&$AC2IcA5`{X+F#IeWWJ>=zf z3fbE8Jn`wp7Mi28DgnjW?{@G{#hX|@q=i`IV;T(@vT4OthN>^?V{Aq(*BeM#c%!p6 zqG+3+dVNn~D7Sk@f9qzyy1}l@D|Wd=5AQ5tmR6q4?dDvYKWNz1iBe&`;WixC8g zF%hc!bC7Y4z#-&)bf#CU48FSw3EW%~q^S%`Ej}u^ZmC(NH%#(+GoCE`9c@E@kI(Bu>mV+uqo>cxKwotM zWj6gD{V9hpVBqOfR~sRtexH?kC4JIDHI)bTb9pK1C2K}4sm2LU6hm1$K*%FddH3Ea zMapZt8#0YAOw|&Gywm}CYI|E~3e3R0qW5tC^rzB(Nox)^UbxI;d&z;9kVMx(PCb5n zuSs?6l^?4kY`5$SWs|5`QqE}qZ zZ<1ilo~K&UiS=F`zC7^SyCGka5)L9Id_p;xJCm&aDCnU-fmAzDw4 ziz}%MrTe+wfiMcir(Jnw7>*bd@;!)fD?KxZTtbm6I20gYutXP<%p*jb`Dh8k$hCdz z$8DoZ&I+Cr`YT-G=sMIUT?+N8RNP#GnS-{9PKY>Cs54KZUrT^6(c^);W0d~to1CQ= z?x)&Dm1v3ZZx1P5jut~sV)V*zzq271`O^ni-wx5=`q=9bPQ(8>UH;lqF2?wV=c)mR z5SmTy{J66DX#ddOt`W+4&m^t@w)S40m6Aty$&>yYqcZw)zFnhJUxT=;bbC&9)A*Ml zZqCjJHPe!$@ha=VeAmxivc9YdJa=!7TmHekAl<`Sx`lU15^wT7+v&+b2PZSz&V=WK zD%V&emKg)(R1-lIx@F!@FsryqUHb_EF zrdFsFzRnt6Wh|NCRzbV>bOe+7e_HEXt{Ks_92?zxXz_Bn`JGSV)Kq+0v9#Tzn{hI7 z?}7+ls9CMiUhPzo*Y-Kyxd&#C12i*v>Wi?pQZIXYjW^z9p9~s#pzC}RYi?r+WeqAC zer%I;^H978mdk*k!*K!6R1Il|`?f)L|riv0%}jwt6Fe1KrTydB|uZ zoxa>C84o&Fhfz3MH^*qs`-sRwChq)v&$td z-{2!E$}NFuQ`jl-VOW2~xY`_`jd9dA!qU7Otqo((g}fa$uitEpYFUHzpz=#x3oJfB zczA>5Lyi1a2B3JA5+CQ71t;4*43xA8w-K9;Rd)qq;((E<~;+Bfz#; zCf=mQ>P4dTNiw|DL6<{NO+{ZQm%!>VfiyR(-aS#7CF`VbENxqw&%j%G5fY9z9QtZn zgE2X0vx!V%uH>C=pomx|{nZpUPupNVQdU)}Q$W;P0CRE6I)5P{b!@~zLZ9-L%juq7 zANmhv!F*%_T2!`&j>(pYy2r*bcOD--zJ37m0&L0*rqx?*YZdKFx^|C$Tlk5GEbgJM UE97?g^>;>HO(TtJHK&;W0oJ?crT_o{ diff --git a/docs/index.asciidoc b/docs/index.asciidoc deleted file mode 100644 index f4cc819d..00000000 --- a/docs/index.asciidoc +++ /dev/null @@ -1,6 +0,0 @@ -= Elasticsearch Rust Client - -include::{asciidoc-dir}/../../shared/attributes.asciidoc[] - -include::overview.asciidoc[] -include::installation.asciidoc[] \ No newline at end of file diff --git a/docs/installation.asciidoc b/docs/installation.asciidoc deleted file mode 100644 index b66a60b0..00000000 --- a/docs/installation.asciidoc +++ /dev/null @@ -1,20 +0,0 @@ -[[installation]] -== Installation - -Add `elasticsearch` crate and version to Cargo.toml. Choose the version that is -compatible with the version of {es} you are using: - -[source,toml] ----- -[dependencies] -elasticsearch = "8.7.0-alpha.1" ----- - -The following _optional_ dependencies may also be useful to create requests and -read responses: - -[source,toml] ----- -serde = "~1" -serde_json = "~1" ----- diff --git a/docs/overview.asciidoc b/docs/overview.asciidoc deleted file mode 100644 index 9c4036a5..00000000 --- a/docs/overview.asciidoc +++ /dev/null @@ -1,90 +0,0 @@ -[[overview]] -== Overview - -This is the official Rust client for {es}. Full documentation is hosted on -https://docs.rs/elasticsearch[docs.rs] -- this page provides _only_ an overview. - -Further resources: - -* https://github.com/elastic/elasticsearch-rs[Source code] -* https://docs.rs/elasticsearch[API documentation] - - -[discrete] -[[features]] -=== Features - -* Fluent builders for all {es} REST API endpoints -* Persistent keep-alive connections -* TLS support with system or custom certificates -* Proxy support with authentication -* Async support with Tokio - - -[discrete] -=== {es} Version Compatibility - -The Elasticsearch Rust client is forward compatible; meaning that the client supports communicating with greater minor versions of Elasticsearch. Elasticsearch language clients are also backwards compatible with lesser supported minor Elasticsearch versions. - - -[discrete] -=== Create a client - -To create a client to make API calls to Elasticsearch running on `\https://localhost:9200` - -[source,rust] ----- -let client = Elasticsearch::default(); ----- - -Alternatively, you can create a client to make API calls against Elasticsearch running on a -specific `url::Url` - -[source,rust] ----- -let transport = Transport::single_node("https://example.com")?; -let client = Elasticsearch::new(transport); ----- - -If you're running against an Elasticsearch deployment in https://www.elastic.co/cloud/[Elastic Cloud], -a client can be created using a https://www.elastic.co/guide/en/cloud/current/ec-cloud-id.html[Cloud ID] -and credentials retrieved from the Cloud web console - -[source,rust] ----- -let cloud_id = ""; -let credentials = Credentials::Basic("".into(), "".into()); -let transport = Transport::cloud(cloud_id, credentials)?; -let client = Elasticsearch::new(transport); ----- - - -[discrete] -=== Making API calls - -The following makes an API call to `tweets/_search` with the json body -`{"query":{"match":{"message":"Elasticsearch"}}}` - -[source,rust] ----- -let response = client - .search(SearchParts::Index(&["tweets"])) - .from(0) - .size(10) - .body(json!({ - "query": { - "match": { - "message": "Elasticsearch rust" - } - } - })) - .send() - .await?; - -let response_body = response.json::().await?; -let took = response_body["took"].as_i64().unwrap(); -for hit in response_body["hits"]["hits"].as_array().unwrap() { - // print the source document - println!("{:?}", hit["_source"]); -} ----- From 2491aa316c615a316f7e6fb7e199e0962892cb65 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Tue, 25 Feb 2025 19:17:27 -0600 Subject: [PATCH 2/2] add migrated files --- docs/docset.yml | 485 +++++++++++++++++++++++++++++++++ docs/reference/index.md | 83 ++++++ docs/reference/installation.md | 21 ++ docs/reference/toc.yml | 3 + 4 files changed, 592 insertions(+) create mode 100644 docs/docset.yml create mode 100644 docs/reference/index.md create mode 100644 docs/reference/installation.md create mode 100644 docs/reference/toc.yml diff --git a/docs/docset.yml b/docs/docset.yml new file mode 100644 index 00000000..16ad5cb6 --- /dev/null +++ b/docs/docset.yml @@ -0,0 +1,485 @@ +project: 'Rust client' +cross_links: + - docs-content +toc: + - toc: reference +subs: + ref: "https://www.elastic.co/guide/en/elasticsearch/reference/current" + ref-bare: "https://www.elastic.co/guide/en/elasticsearch/reference" + ref-8x: "https://www.elastic.co/guide/en/elasticsearch/reference/8.1" + ref-80: "https://www.elastic.co/guide/en/elasticsearch/reference/8.0" + ref-7x: "https://www.elastic.co/guide/en/elasticsearch/reference/7.17" + ref-70: "https://www.elastic.co/guide/en/elasticsearch/reference/7.0" + ref-60: "https://www.elastic.co/guide/en/elasticsearch/reference/6.0" + ref-64: "https://www.elastic.co/guide/en/elasticsearch/reference/6.4" + xpack-ref: "https://www.elastic.co/guide/en/x-pack/6.2" + logstash-ref: "https://www.elastic.co/guide/en/logstash/current" + kibana-ref: "https://www.elastic.co/guide/en/kibana/current" + kibana-ref-all: "https://www.elastic.co/guide/en/kibana" + beats-ref-root: "https://www.elastic.co/guide/en/beats" + beats-ref: "https://www.elastic.co/guide/en/beats/libbeat/current" + beats-ref-60: "https://www.elastic.co/guide/en/beats/libbeat/6.0" + beats-ref-63: "https://www.elastic.co/guide/en/beats/libbeat/6.3" + beats-devguide: "https://www.elastic.co/guide/en/beats/devguide/current" + auditbeat-ref: "https://www.elastic.co/guide/en/beats/auditbeat/current" + packetbeat-ref: "https://www.elastic.co/guide/en/beats/packetbeat/current" + metricbeat-ref: "https://www.elastic.co/guide/en/beats/metricbeat/current" + filebeat-ref: "https://www.elastic.co/guide/en/beats/filebeat/current" + functionbeat-ref: "https://www.elastic.co/guide/en/beats/functionbeat/current" + winlogbeat-ref: "https://www.elastic.co/guide/en/beats/winlogbeat/current" + heartbeat-ref: "https://www.elastic.co/guide/en/beats/heartbeat/current" + journalbeat-ref: "https://www.elastic.co/guide/en/beats/journalbeat/current" + ingest-guide: "https://www.elastic.co/guide/en/ingest/current" + fleet-guide: "https://www.elastic.co/guide/en/fleet/current" + apm-guide-ref: "https://www.elastic.co/guide/en/apm/guide/current" + apm-guide-7x: "https://www.elastic.co/guide/en/apm/guide/7.17" + apm-app-ref: "https://www.elastic.co/guide/en/kibana/current" + apm-agents-ref: "https://www.elastic.co/guide/en/apm/agent" + apm-android-ref: "https://www.elastic.co/guide/en/apm/agent/android/current" + apm-py-ref: "https://www.elastic.co/guide/en/apm/agent/python/current" + apm-py-ref-3x: "https://www.elastic.co/guide/en/apm/agent/python/3.x" + apm-node-ref-index: "https://www.elastic.co/guide/en/apm/agent/nodejs" + apm-node-ref: "https://www.elastic.co/guide/en/apm/agent/nodejs/current" + apm-node-ref-1x: "https://www.elastic.co/guide/en/apm/agent/nodejs/1.x" + apm-rum-ref: "https://www.elastic.co/guide/en/apm/agent/rum-js/current" + apm-ruby-ref: "https://www.elastic.co/guide/en/apm/agent/ruby/current" + apm-java-ref: "https://www.elastic.co/guide/en/apm/agent/java/current" + apm-go-ref: "https://www.elastic.co/guide/en/apm/agent/go/current" + apm-dotnet-ref: "https://www.elastic.co/guide/en/apm/agent/dotnet/current" + apm-php-ref: "https://www.elastic.co/guide/en/apm/agent/php/current" + apm-ios-ref: "https://www.elastic.co/guide/en/apm/agent/swift/current" + apm-lambda-ref: "https://www.elastic.co/guide/en/apm/lambda/current" + apm-attacher-ref: "https://www.elastic.co/guide/en/apm/attacher/current" + docker-logging-ref: "https://www.elastic.co/guide/en/beats/loggingplugin/current" + esf-ref: "https://www.elastic.co/guide/en/esf/current" + kinesis-firehose-ref: "https://www.elastic.co/guide/en/kinesis/{{kinesis_version}}" + estc-welcome-current: "https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current" + estc-welcome: "https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current" + estc-welcome-all: "https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions" + hadoop-ref: "https://www.elastic.co/guide/en/elasticsearch/hadoop/current" + stack-ref: "https://www.elastic.co/guide/en/elastic-stack/current" + stack-ref-67: "https://www.elastic.co/guide/en/elastic-stack/6.7" + stack-ref-68: "https://www.elastic.co/guide/en/elastic-stack/6.8" + stack-ref-70: "https://www.elastic.co/guide/en/elastic-stack/7.0" + stack-ref-80: "https://www.elastic.co/guide/en/elastic-stack/8.0" + stack-ov: "https://www.elastic.co/guide/en/elastic-stack-overview/current" + stack-gs: "https://www.elastic.co/guide/en/elastic-stack-get-started/current" + stack-gs-current: "https://www.elastic.co/guide/en/elastic-stack-get-started/current" + javaclient: "https://www.elastic.co/guide/en/elasticsearch/client/java-api/current" + java-api-client: "https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current" + java-rest: "https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current" + jsclient: "https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current" + jsclient-current: "https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current" + es-ruby-client: "https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current" + es-dotnet-client: "https://www.elastic.co/guide/en/elasticsearch/client/net-api/current" + es-php-client: "https://www.elastic.co/guide/en/elasticsearch/client/php-api/current" + es-python-client: "https://www.elastic.co/guide/en/elasticsearch/client/python-api/current" + defguide: "https://www.elastic.co/guide/en/elasticsearch/guide/2.x" + painless: "https://www.elastic.co/guide/en/elasticsearch/painless/current" + plugins: "https://www.elastic.co/guide/en/elasticsearch/plugins/current" + plugins-8x: "https://www.elastic.co/guide/en/elasticsearch/plugins/8.1" + plugins-7x: "https://www.elastic.co/guide/en/elasticsearch/plugins/7.17" + plugins-6x: "https://www.elastic.co/guide/en/elasticsearch/plugins/6.8" + glossary: "https://www.elastic.co/guide/en/elastic-stack-glossary/current" + upgrade_guide: "https://www.elastic.co/products/upgrade_guide" + blog-ref: "https://www.elastic.co/blog/" + curator-ref: "https://www.elastic.co/guide/en/elasticsearch/client/curator/current" + curator-ref-current: "https://www.elastic.co/guide/en/elasticsearch/client/curator/current" + metrics-ref: "https://www.elastic.co/guide/en/metrics/current" + metrics-guide: "https://www.elastic.co/guide/en/metrics/guide/current" + logs-ref: "https://www.elastic.co/guide/en/logs/current" + logs-guide: "https://www.elastic.co/guide/en/logs/guide/current" + uptime-guide: "https://www.elastic.co/guide/en/uptime/current" + observability-guide: "https://www.elastic.co/guide/en/observability/current" + observability-guide-all: "https://www.elastic.co/guide/en/observability" + siem-guide: "https://www.elastic.co/guide/en/siem/guide/current" + security-guide: "https://www.elastic.co/guide/en/security/current" + security-guide-all: "https://www.elastic.co/guide/en/security" + endpoint-guide: "https://www.elastic.co/guide/en/endpoint/current" + sql-odbc: "https://www.elastic.co/guide/en/elasticsearch/sql-odbc/current" + ecs-ref: "https://www.elastic.co/guide/en/ecs/current" + ecs-logging-ref: "https://www.elastic.co/guide/en/ecs-logging/overview/current" + ecs-logging-go-logrus-ref: "https://www.elastic.co/guide/en/ecs-logging/go-logrus/current" + ecs-logging-go-zap-ref: "https://www.elastic.co/guide/en/ecs-logging/go-zap/current" + ecs-logging-go-zerolog-ref: "https://www.elastic.co/guide/en/ecs-logging/go-zap/current" + ecs-logging-java-ref: "https://www.elastic.co/guide/en/ecs-logging/java/current" + ecs-logging-dotnet-ref: "https://www.elastic.co/guide/en/ecs-logging/dotnet/current" + ecs-logging-nodejs-ref: "https://www.elastic.co/guide/en/ecs-logging/nodejs/current" + ecs-logging-php-ref: "https://www.elastic.co/guide/en/ecs-logging/php/current" + ecs-logging-python-ref: "https://www.elastic.co/guide/en/ecs-logging/python/current" + ecs-logging-ruby-ref: "https://www.elastic.co/guide/en/ecs-logging/ruby/current" + ml-docs: "https://www.elastic.co/guide/en/machine-learning/current" + eland-docs: "https://www.elastic.co/guide/en/elasticsearch/client/eland/current" + eql-ref: "https://eql.readthedocs.io/en/latest/query-guide" + extendtrial: "https://www.elastic.co/trialextension" + wikipedia: "https://en.wikipedia.org/wiki" + forum: "https://discuss.elastic.co/" + xpack-forum: "https://discuss.elastic.co/c/50-x-pack" + security-forum: "https://discuss.elastic.co/c/x-pack/shield" + watcher-forum: "https://discuss.elastic.co/c/x-pack/watcher" + monitoring-forum: "https://discuss.elastic.co/c/x-pack/marvel" + graph-forum: "https://discuss.elastic.co/c/x-pack/graph" + apm-forum: "https://discuss.elastic.co/c/apm" + enterprise-search-ref: "https://www.elastic.co/guide/en/enterprise-search/current" + app-search-ref: "https://www.elastic.co/guide/en/app-search/current" + workplace-search-ref: "https://www.elastic.co/guide/en/workplace-search/current" + enterprise-search-node-ref: "https://www.elastic.co/guide/en/enterprise-search-clients/enterprise-search-node/current" + enterprise-search-php-ref: "https://www.elastic.co/guide/en/enterprise-search-clients/php/current" + enterprise-search-python-ref: "https://www.elastic.co/guide/en/enterprise-search-clients/python/current" + enterprise-search-ruby-ref: "https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current" + elastic-maps-service: "https://maps.elastic.co" + integrations-docs: "https://docs.elastic.co/en/integrations" + integrations-devguide: "https://www.elastic.co/guide/en/integrations-developer/current" + time-units: "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#time-units" + byte-units: "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#byte-units" + apm-py-ref-v: "https://www.elastic.co/guide/en/apm/agent/python/current" + apm-node-ref-v: "https://www.elastic.co/guide/en/apm/agent/nodejs/current" + apm-rum-ref-v: "https://www.elastic.co/guide/en/apm/agent/rum-js/current" + apm-ruby-ref-v: "https://www.elastic.co/guide/en/apm/agent/ruby/current" + apm-java-ref-v: "https://www.elastic.co/guide/en/apm/agent/java/current" + apm-go-ref-v: "https://www.elastic.co/guide/en/apm/agent/go/current" + apm-ios-ref-v: "https://www.elastic.co/guide/en/apm/agent/swift/current" + apm-dotnet-ref-v: "https://www.elastic.co/guide/en/apm/agent/dotnet/current" + apm-php-ref-v: "https://www.elastic.co/guide/en/apm/agent/php/current" + ecloud: "Elastic Cloud" + esf: "Elastic Serverless Forwarder" + ess: "Elasticsearch Service" + ece: "Elastic Cloud Enterprise" + eck: "Elastic Cloud on Kubernetes" + serverless-full: "Elastic Cloud Serverless" + serverless-short: "Serverless" + es-serverless: "Elasticsearch Serverless" + es3: "Elasticsearch Serverless" + obs-serverless: "Elastic Observability Serverless" + sec-serverless: "Elastic Security Serverless" + serverless-docs: "https://docs.elastic.co/serverless" + cloud: "https://www.elastic.co/guide/en/cloud/current" + ess-utm-params: "?page=docs&placement=docs-body" + ess-baymax: "?page=docs&placement=docs-body" + ess-trial: "https://cloud.elastic.co/registration?page=docs&placement=docs-body" + ess-product: "https://www.elastic.co/cloud/elasticsearch-service?page=docs&placement=docs-body" + ess-console: "https://cloud.elastic.co?page=docs&placement=docs-body" + ess-console-name: "Elasticsearch Service Console" + ess-deployments: "https://cloud.elastic.co/deployments?page=docs&placement=docs-body" + ece-ref: "https://www.elastic.co/guide/en/cloud-enterprise/current" + eck-ref: "https://www.elastic.co/guide/en/cloud-on-k8s/current" + ess-leadin: "You can run Elasticsearch on your own hardware or use our hosted Elasticsearch Service that is available on AWS, GCP, and Azure. https://cloud.elastic.co/registration{ess-utm-params}[Try the Elasticsearch Service for free]." + ess-leadin-short: "Our hosted Elasticsearch Service is available on AWS, GCP, and Azure, and you can https://cloud.elastic.co/registration{ess-utm-params}[try it for free]." + ess-icon: "image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg[link=\"https://cloud.elastic.co/registration{ess-utm-params}\", title=\"Supported on Elasticsearch Service\"]" + ece-icon: "image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud_ece.svg[link=\"https://cloud.elastic.co/registration{ess-utm-params}\", title=\"Supported on Elastic Cloud Enterprise\"]" + cloud-only: "This feature is designed for indirect use by https://cloud.elastic.co/registration{ess-utm-params}[Elasticsearch Service], https://www.elastic.co/guide/en/cloud-enterprise/{ece-version-link}[Elastic Cloud Enterprise], and https://www.elastic.co/guide/en/cloud-on-k8s/current[Elastic Cloud on Kubernetes]. Direct use is not supported." + ess-setting-change: "image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg[link=\"{ess-trial}\", title=\"Supported on {ess}\"] indicates a change to a supported https://www.elastic.co/guide/en/cloud/current/ec-add-user-settings.html[user setting] for Elasticsearch Service." + ess-skip-section: "If you use Elasticsearch Service, skip this section. Elasticsearch Service handles these changes for you." + api-cloud: "https://www.elastic.co/docs/api/doc/cloud" + api-ece: "https://www.elastic.co/docs/api/doc/cloud-enterprise" + api-kibana-serverless: "https://www.elastic.co/docs/api/doc/serverless" + es-feature-flag: "This feature is in development and not yet available for use. This documentation is provided for informational purposes only." + es-ref-dir: "'{{elasticsearch-root}}/docs/reference'" + apm-app: "APM app" + uptime-app: "Uptime app" + synthetics-app: "Synthetics app" + logs-app: "Logs app" + metrics-app: "Metrics app" + infrastructure-app: "Infrastructure app" + siem-app: "SIEM app" + security-app: "Elastic Security app" + ml-app: "Machine Learning" + dev-tools-app: "Dev Tools" + ingest-manager-app: "Ingest Manager" + stack-manage-app: "Stack Management" + stack-monitor-app: "Stack Monitoring" + alerts-ui: "Alerts and Actions" + rules-ui: "Rules" + rac-ui: "Rules and Connectors" + connectors-ui: "Connectors" + connectors-feature: "Actions and Connectors" + stack-rules-feature: "Stack Rules" + user-experience: "User Experience" + ems: "Elastic Maps Service" + ems-init: "EMS" + hosted-ems: "Elastic Maps Server" + ipm-app: "Index Pattern Management" + ingest-pipelines: "ingest pipelines" + ingest-pipelines-app: "Ingest Pipelines" + ingest-pipelines-cap: "Ingest pipelines" + ls-pipelines: "Logstash pipelines" + ls-pipelines-app: "Logstash Pipelines" + maint-windows: "maintenance windows" + maint-windows-app: "Maintenance Windows" + maint-windows-cap: "Maintenance windows" + custom-roles-app: "Custom Roles" + data-source: "data view" + data-sources: "data views" + data-source-caps: "Data View" + data-sources-caps: "Data Views" + data-source-cap: "Data view" + data-sources-cap: "Data views" + project-settings: "Project settings" + manage-app: "Management" + index-manage-app: "Index Management" + data-views-app: "Data Views" + rules-app: "Rules" + saved-objects-app: "Saved Objects" + tags-app: "Tags" + api-keys-app: "API keys" + transforms-app: "Transforms" + connectors-app: "Connectors" + files-app: "Files" + reports-app: "Reports" + maps-app: "Maps" + alerts-app: "Alerts" + crawler: "Enterprise Search web crawler" + ents: "Enterprise Search" + app-search-crawler: "App Search web crawler" + agent: "Elastic Agent" + agents: "Elastic Agents" + fleet: "Fleet" + fleet-server: "Fleet Server" + integrations-server: "Integrations Server" + ingest-manager: "Ingest Manager" + ingest-management: "ingest management" + package-manager: "Elastic Package Manager" + integrations: "Integrations" + package-registry: "Elastic Package Registry" + artifact-registry: "Elastic Artifact Registry" + aws: "AWS" + stack: "Elastic Stack" + xpack: "X-Pack" + es: "Elasticsearch" + kib: "Kibana" + esms: "Elastic Stack Monitoring Service" + esms-init: "ESMS" + ls: "Logstash" + beats: "Beats" + auditbeat: "Auditbeat" + filebeat: "Filebeat" + heartbeat: "Heartbeat" + metricbeat: "Metricbeat" + packetbeat: "Packetbeat" + winlogbeat: "Winlogbeat" + functionbeat: "Functionbeat" + journalbeat: "Journalbeat" + es-sql: "Elasticsearch SQL" + esql: "ES|QL" + elastic-agent: "Elastic Agent" + k8s: "Kubernetes" + log-driver-long: "Elastic Logging Plugin for Docker" + security: "X-Pack security" + security-features: "security features" + operator-feature: "operator privileges feature" + es-security-features: "Elasticsearch security features" + stack-security-features: "Elastic Stack security features" + endpoint-sec: "Endpoint Security" + endpoint-cloud-sec: "Endpoint and Cloud Security" + elastic-defend: "Elastic Defend" + elastic-sec: "Elastic Security" + elastic-endpoint: "Elastic Endpoint" + swimlane: "Swimlane" + sn: "ServiceNow" + sn-itsm: "ServiceNow ITSM" + sn-itom: "ServiceNow ITOM" + sn-sir: "ServiceNow SecOps" + jira: "Jira" + ibm-r: "IBM Resilient" + webhook: "Webhook" + webhook-cm: "Webhook - Case Management" + opsgenie: "Opsgenie" + bedrock: "Amazon Bedrock" + gemini: "Google Gemini" + hive: "TheHive" + monitoring: "X-Pack monitoring" + monitor-features: "monitoring features" + stack-monitor-features: "Elastic Stack monitoring features" + watcher: "Watcher" + alert-features: "alerting features" + reporting: "X-Pack reporting" + report-features: "reporting features" + graph: "X-Pack graph" + graph-features: "graph analytics features" + searchprofiler: "Search Profiler" + xpackml: "X-Pack machine learning" + ml: "machine learning" + ml-cap: "Machine learning" + ml-init: "ML" + ml-features: "machine learning features" + stack-ml-features: "Elastic Stack machine learning features" + ccr: "cross-cluster replication" + ccr-cap: "Cross-cluster replication" + ccr-init: "CCR" + ccs: "cross-cluster search" + ccs-cap: "Cross-cluster search" + ccs-init: "CCS" + ilm: "index lifecycle management" + ilm-cap: "Index lifecycle management" + ilm-init: "ILM" + dlm: "data lifecycle management" + dlm-cap: "Data lifecycle management" + dlm-init: "DLM" + search-snap: "searchable snapshot" + search-snaps: "searchable snapshots" + search-snaps-cap: "Searchable snapshots" + slm: "snapshot lifecycle management" + slm-cap: "Snapshot lifecycle management" + slm-init: "SLM" + rollup-features: "data rollup features" + ipm: "index pattern management" + ipm-cap: "Index pattern" + rollup: "rollup" + rollup-cap: "Rollup" + rollups: "rollups" + rollups-cap: "Rollups" + rollup-job: "rollup job" + rollup-jobs: "rollup jobs" + rollup-jobs-cap: "Rollup jobs" + dfeed: "datafeed" + dfeeds: "datafeeds" + dfeed-cap: "Datafeed" + dfeeds-cap: "Datafeeds" + ml-jobs: "machine learning jobs" + ml-jobs-cap: "Machine learning jobs" + anomaly-detect: "anomaly detection" + anomaly-detect-cap: "Anomaly detection" + anomaly-job: "anomaly detection job" + anomaly-jobs: "anomaly detection jobs" + anomaly-jobs-cap: "Anomaly detection jobs" + dataframe: "data frame" + dataframes: "data frames" + dataframe-cap: "Data frame" + dataframes-cap: "Data frames" + watcher-transform: "payload transform" + watcher-transforms: "payload transforms" + watcher-transform-cap: "Payload transform" + watcher-transforms-cap: "Payload transforms" + transform: "transform" + transforms: "transforms" + transform-cap: "Transform" + transforms-cap: "Transforms" + dataframe-transform: "transform" + dataframe-transform-cap: "Transform" + dataframe-transforms: "transforms" + dataframe-transforms-cap: "Transforms" + dfanalytics-cap: "Data frame analytics" + dfanalytics: "data frame analytics" + dataframe-analytics-config: "'{dataframe} analytics config'" + dfanalytics-job: "'{dataframe} analytics job'" + dfanalytics-jobs: "'{dataframe} analytics jobs'" + dfanalytics-jobs-cap: "'{dataframe-cap} analytics jobs'" + cdataframe: "continuous data frame" + cdataframes: "continuous data frames" + cdataframe-cap: "Continuous data frame" + cdataframes-cap: "Continuous data frames" + cdataframe-transform: "continuous transform" + cdataframe-transforms: "continuous transforms" + cdataframe-transforms-cap: "Continuous transforms" + ctransform: "continuous transform" + ctransform-cap: "Continuous transform" + ctransforms: "continuous transforms" + ctransforms-cap: "Continuous transforms" + oldetection: "outlier detection" + oldetection-cap: "Outlier detection" + olscore: "outlier score" + olscores: "outlier scores" + fiscore: "feature influence score" + evaluatedf-api: "evaluate {dataframe} analytics API" + evaluatedf-api-cap: "Evaluate {dataframe} analytics API" + binarysc: "binary soft classification" + binarysc-cap: "Binary soft classification" + regression: "regression" + regression-cap: "Regression" + reganalysis: "regression analysis" + reganalysis-cap: "Regression analysis" + depvar: "dependent variable" + feature-var: "feature variable" + feature-vars: "feature variables" + feature-vars-cap: "Feature variables" + classification: "classification" + classification-cap: "Classification" + classanalysis: "classification analysis" + classanalysis-cap: "Classification analysis" + infer-cap: "Inference" + infer: "inference" + lang-ident-cap: "Language identification" + lang-ident: "language identification" + data-viz: "Data Visualizer" + file-data-viz: "File Data Visualizer" + feat-imp: "feature importance" + feat-imp-cap: "Feature importance" + nlp: "natural language processing" + nlp-cap: "Natural language processing" + apm-agent: "APM agent" + apm-go-agent: "Elastic APM Go agent" + apm-go-agents: "Elastic APM Go agents" + apm-ios-agent: "Elastic APM iOS agent" + apm-ios-agents: "Elastic APM iOS agents" + apm-java-agent: "Elastic APM Java agent" + apm-java-agents: "Elastic APM Java agents" + apm-dotnet-agent: "Elastic APM .NET agent" + apm-dotnet-agents: "Elastic APM .NET agents" + apm-node-agent: "Elastic APM Node.js agent" + apm-node-agents: "Elastic APM Node.js agents" + apm-php-agent: "Elastic APM PHP agent" + apm-php-agents: "Elastic APM PHP agents" + apm-py-agent: "Elastic APM Python agent" + apm-py-agents: "Elastic APM Python agents" + apm-ruby-agent: "Elastic APM Ruby agent" + apm-ruby-agents: "Elastic APM Ruby agents" + apm-rum-agent: "Elastic APM Real User Monitoring (RUM) JavaScript agent" + apm-rum-agents: "Elastic APM RUM JavaScript agents" + apm-lambda-ext: "Elastic APM AWS Lambda extension" + project-monitors: "project monitors" + project-monitors-cap: "Project monitors" + private-location: "Private Location" + private-locations: "Private Locations" + pwd: "YOUR_PASSWORD" + esh: "ES-Hadoop" + default-dist: "default distribution" + oss-dist: "OSS-only distribution" + observability: "Observability" + api-request-title: "Request" + api-prereq-title: "Prerequisites" + api-description-title: "Description" + api-path-parms-title: "Path parameters" + api-query-parms-title: "Query parameters" + api-request-body-title: "Request body" + api-response-codes-title: "Response codes" + api-response-body-title: "Response body" + api-example-title: "Example" + api-examples-title: "Examples" + api-definitions-title: "Properties" + multi-arg: "†footnoteref:[multi-arg,This parameter accepts multiple arguments.]" + multi-arg-ref: "†footnoteref:[multi-arg]" + yes-icon: "image:https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png[Yes,20,15]" + no-icon: "image:https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png[No,20,15]" + es-repo: "https://github.com/elastic/elasticsearch/" + es-issue: "https://github.com/elastic/elasticsearch/issues/" + es-pull: "https://github.com/elastic/elasticsearch/pull/" + es-commit: "https://github.com/elastic/elasticsearch/commit/" + kib-repo: "https://github.com/elastic/kibana/" + kib-issue: "https://github.com/elastic/kibana/issues/" + kibana-issue: "'{kib-repo}issues/'" + kib-pull: "https://github.com/elastic/kibana/pull/" + kibana-pull: "'{kib-repo}pull/'" + kib-commit: "https://github.com/elastic/kibana/commit/" + ml-repo: "https://github.com/elastic/ml-cpp/" + ml-issue: "https://github.com/elastic/ml-cpp/issues/" + ml-pull: "https://github.com/elastic/ml-cpp/pull/" + ml-commit: "https://github.com/elastic/ml-cpp/commit/" + apm-repo: "https://github.com/elastic/apm-server/" + apm-issue: "https://github.com/elastic/apm-server/issues/" + apm-pull: "https://github.com/elastic/apm-server/pull/" + kibana-blob: "https://github.com/elastic/kibana/blob/current/" + apm-get-started-ref: "https://www.elastic.co/guide/en/apm/get-started/current" + apm-server-ref: "https://www.elastic.co/guide/en/apm/server/current" + apm-server-ref-v: "https://www.elastic.co/guide/en/apm/server/current" + apm-server-ref-m: "https://www.elastic.co/guide/en/apm/server/master" + apm-server-ref-62: "https://www.elastic.co/guide/en/apm/server/6.2" + apm-server-ref-64: "https://www.elastic.co/guide/en/apm/server/6.4" + apm-server-ref-70: "https://www.elastic.co/guide/en/apm/server/7.0" + apm-overview-ref-v: "https://www.elastic.co/guide/en/apm/get-started/current" + apm-overview-ref-70: "https://www.elastic.co/guide/en/apm/get-started/7.0" + apm-overview-ref-m: "https://www.elastic.co/guide/en/apm/get-started/master" + infra-guide: "https://www.elastic.co/guide/en/infrastructure/guide/current" + a-data-source: "a data view" + icon-bug: "pass:[]" + icon-checkInCircleFilled: "pass:[]" + icon-warningFilled: "pass:[]" diff --git a/docs/reference/index.md b/docs/reference/index.md new file mode 100644 index 00000000..d074996d --- /dev/null +++ b/docs/reference/index.md @@ -0,0 +1,83 @@ +--- +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/client/rust-api/current/overview.html + - https://www.elastic.co/guide/en/elasticsearch/client/rust-api/current/index.html +navigation_title: Rust +--- + +# Elasticsearch Rust Client [overview] + +This is the official Rust client for {{es}}. Full documentation is hosted on [docs.rs](https://docs.rs/elasticsearch) — this page provides *only* an overview. + +Further resources: + +* [Source code](https://github.com/elastic/elasticsearch-rs) +* [API documentation](https://docs.rs/elasticsearch) + + +## Features [features] + +* Fluent builders for all {{es}} REST API endpoints +* Persistent keep-alive connections +* TLS support with system or custom certificates +* Proxy support with authentication +* Async support with Tokio + + +## {{es}} Version compatibility [_es_version_compatibility] + +The Elasticsearch Rust client is forward compatible; meaning that the client supports communicating with greater minor versions of Elasticsearch. Elasticsearch language clients are also backwards compatible with lesser supported minor Elasticsearch versions. + + +## Create a client [_create_a_client] + +To create a client to make API calls to Elasticsearch running on `\https://localhost:9200` + +```rust +let client = Elasticsearch::default(); +``` + +Alternatively, you can create a client to make API calls against Elasticsearch running on a specific `url::Url` + +```rust +let transport = Transport::single_node("https://example.com")?; +let client = Elasticsearch::new(transport); +``` + +If you’re running against an Elasticsearch deployment in [Elastic Cloud](https://www.elastic.co/cloud/), a client can be created using a [Cloud ID](docs-content://deploy-manage/deploy/elastic-cloud/find-cloud-id.md) and credentials retrieved from the Cloud web console + +```rust +let cloud_id = ""; +let credentials = Credentials::Basic("".into(), "".into()); +let transport = Transport::cloud(cloud_id, credentials)?; +let client = Elasticsearch::new(transport); +``` + + +## Making API calls [_making_api_calls] + +The following makes an API call to `tweets/_search` with the json body `{"query":{"match":{"message":"Elasticsearch"}}}` + +```rust +let response = client + .search(SearchParts::Index(&["tweets"])) + .from(0) + .size(10) + .body(json!({ + "query": { + "match": { + "message": "Elasticsearch rust" + } + } + })) + .send() + .await?; + +let response_body = response.json::().await?; +let took = response_body["took"].as_i64().unwrap(); +for hit in response_body["hits"]["hits"].as_array().unwrap() { + // print the source document + println!("{:?}", hit["_source"]); +} +``` + diff --git a/docs/reference/installation.md b/docs/reference/installation.md new file mode 100644 index 00000000..e75f51ed --- /dev/null +++ b/docs/reference/installation.md @@ -0,0 +1,21 @@ +--- +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/client/rust-api/current/installation.html +--- + +# Installation [installation] + +Add `elasticsearch` crate and version to Cargo.toml. Choose the version that is compatible with the version of {{es}} you are using: + +```toml +[dependencies] +elasticsearch = "8.7.0-alpha.1" +``` + +The following *optional* dependencies may also be useful to create requests and read responses: + +```toml +serde = "~1" +serde_json = "~1" +``` + diff --git a/docs/reference/toc.yml b/docs/reference/toc.yml new file mode 100644 index 00000000..17782dbd --- /dev/null +++ b/docs/reference/toc.yml @@ -0,0 +1,3 @@ +toc: + - file: index.md + - file: installation.md