From 7a174d7d05ecb7a011c06f05c82e5992846c2163 Mon Sep 17 00:00:00 2001 From: Marty Schoch Date: Thu, 31 Jul 2014 10:58:20 -0400 Subject: [PATCH] upaated README closes #16 --- README.md | 41 +++++++++++++++++++++++++++++++---- docs/bleve.png | Bin 0 -> 6727 bytes examples/bleve_query/main.go | 2 +- search.go | 6 ++++- 4 files changed, 43 insertions(+), 6 deletions(-) create mode 100644 docs/bleve.png diff --git a/README.md b/README.md index 4482ef61..15732476 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,39 @@ -# bleve +# ![bleve](docs/bleve.png) bleve + +modern text indexing in go + +## Features +* Index any go data structure (including JSON) +* Intelligent defaults backed up by powerful configuration +* Supported field types: + * Text +* Supported query types: + * Term, Phrase, Match, Match Phrase + * Conjunction, Disjunction, Boolean + * Simple query syntax for human entry +* Search result match highlighting + +## Indexing + + message := struct{ + From: "marty.schoch@gmail.com", + Body: "bleve indexing is easy", + } + + mapping := bleve.NewIndexMapping() + index, _ := bleve.Open("example.bleve", mapping) + index.IndexId(message) + +## Querying + + mapping := bleve.NewIndexMapping() + index, _ := bleve.Open("example.bleve", mapping) + query := bleve.NewSyntaxQuery("bleve") + searchRequest := bleve.NewSearchRequest(query) + searchResult, _ := index.Search(searchRequest) + + +## Status [![Build Status](https://drone.io/github.com/couchbaselabs/bleve/status.png)](https://drone.io/github.com/couchbaselabs/bleve/latest) -[![Coverage Status](https://coveralls.io/repos/couchbaselabs/bleve/badge.png?branch=master)](https://coveralls.io/r/couchbaselabs/bleve?branch=master) - -A modern text indexing library for go. +[![Coverage Status](https://coveralls.io/repos/couchbaselabs/bleve/badge.png?branch=master)](https://coveralls.io/r/couchbaselabs/bleve?branch=master) \ No newline at end of file diff --git a/docs/bleve.png b/docs/bleve.png new file mode 100644 index 0000000000000000000000000000000000000000..c2227aea27728a63536b64cfb2f57e0e7bd81040 GIT binary patch literal 6727 zcmZ{n2UHVV_qUT6rHV8`niL^`KoW`|y%R#Onjk&2(53e#AiWm>0qLM3C@2U50i=o2 zi;DE#dv70j@Be-M?z-=+H8W@S-p|?lx96N$Nw|g@;yNKMApiilj#QM>y0}YSp7_@; zt}n5V#{d9AX{@ZQ22xg*NyEv(0&8my04QG1OmWxI{z3J$yH2RChn$6pZHLy2fT>SZ z@g`U^92uYi3Jr$1$z4^TB;$Nwrh@|_p0Z%%DT$s0nGO?dk!rLyYRbvajz-xKte4)~ z9!o!MLy!NMuNwYgx$Zk$1JF1L0ynv!fB^zID9W|vMtyRM&d>XxTckh|6c9IQVF5-Q z$bkk<>crF1iWOTc_ST>QX0;>S4H^*Vp>zLu79m;IYXCy|K|wJ;2=y!|NxPzjhVLBw zWha@FFO-*$Du*EVHOutpGTXhPIj-7{XQ_~x99nc2%_o7Zs9KG&bhgR7C~%JcGqwrK zJRdysIvr#>V0NFQzyIL53II--X7qI)l4BdrCr?SU7QO`n;3s_+{^Udwc_?g^1@I`e zoQVL3BTWm*hM!?)7uqe3HY>CbO?kPJnpG#mJXE@ODv4v@)B$AMD9@&g!t?$M|hO?Njk~uVdX!$VzvXbW|34+;-(Ptd0t>$EugXP*I<(3#hcaCN(?x zT78`fuyqwsIre<}cBrjk!sjVscB06Y6QHk4MbMgZRsVU21eUb}-hK=#fRR(nY=kni#%QeMLL`cGD+ z@nz1jd|qesM~p=J5%!ZR(k$9@d&IG3PHef{G6Mf#P(=_{3j9u5;`_xClRE5b&d1lpY_^)HxyNaq~GIHEv{5 zshUcHq^gN}l5PXQ9b(j!h%eQSf2CIeg-^FBCliNa1(Gq_#IxjsO61eyNb>1EMk~fY zp1E@EX^zRWTU4zy(@)V+lco<$hD?>L}9;i^y30jcy2Ob6$m=3-zM6th?bR!TX z%ZTRr{J=QY_)&T4+biEqRz&GZ+Hf>e^p1YjxAgh!@4W$6-58Fl4OnizJ_*_M_;h!S zay{rqqw|KT4|6@CKfV9$@mR*z2KG1tJ+MvC4dxUkR$EpbQd<0Z{L^5vCIQXBVs#gm zP*Ts&`lg(3W4=p&LefLj5-E|PtkhbpoN1MTI!J341Bf`JjybVI#0=qd3oT`+{)RQ1 z$%ySnf}}&5m1sF%-bGWFE!sz#q!!Ej*b10wW%>&|`>HEdD@A^q|AaFjgz}I36Bk={ z7#Hex2+Y~cAI);i($CV)R(#RA)&w^`;Mbxlh)RsAjf&kCnETj0-8~{$hBZ9@#F>0} z*Z!_gGE1^WGB7#zrHZb@Amw1@OS_lq18{4IwTbl)>*GP_tLW~cZuhM2Oe2BwnUkkW zOM8hNhFSs72pT?2W8I8p`5jhPeStfatm^&}yU-jP2)5{ZWy^s0uIAT*` z`Vpi&JQJCKjP6j?{ys3KV_ef+*-dOSX9W>>b+5K9xBM3x{aRt@g>bW2yHB2H#vvDx zcqA$^lWLU8hMNRVP(Dgkt5(~+N3zFq3_0e-6MyRQw2ox|yNeq~ZLsek+4906k$CK6cPVrDPXq1tMW6pr?NbPM7Tt>1Vz1D{VQMC zfypW8)a__=dw661X!uwid>{OpV1Y0ntN?z1CqcwVKz`K~+}sFktPNs>^%=414^V+* zPGsFe#0c&Y8{9l{z6IqLcnw+ctk(7L^Kb|An99q^ey&xFZSQMGL`G97Q@Ja2AX?-H z5vuau@~QI5sVHuA#f(CfUKCTII29w^O>b5=r;`1?QRS!8D^rBiYfygul!}#~PVZ++ zI=kP*88xCG-@Q%8$S_WN9!}9zGOO}t$LOQ`EOgZfBtM7-sq2fRC70IteM=cUyik7vQzxA(W%fG zZB93CA2Bwd`9ib2-q@;QeXdpJqm1Tc9Z%OI65AHro3^W?78Rw|BdIKgy}PEJQxQ|@ zY`+qg$I-qI4@bZ51+Uf>>=hilPq^W`{~BGa*+!+Aq78rayqPd4o&CC%yH!>DaHal% z$)m@{H?Xm0v6Xzq@9LDwtPz7nOZiKIw6W=PbxYn=tC>IBMur>4?fmG~3 zeLMZQ&Ea%nSJs>2)uIM}-p2#*eP-d!skQ^g^(PFwuqiu!?ia(1+&yAQ$1mIuVnVs3mtc>9=71nqb6 zo07m$5$y~BK<`|hK#u}RHvj<4iq%26pj1^vFb;N56Eg=>bEt=%<3%(8Am$-*F|;#x zF=6tsv$b~?@epVE9U*ctzBI#Fn0|-2*od>BR5h4n9h}UW?m-2ha25$dCMG5^Co>BX zEjfk1@rx&M7AqGQM-dpz-Q6AP&JT5PvV`#p3k$>Gd@w#fo{I<`XHR<<6AvDH=R1E* z@_+NlnLA^gu#PTR2YaT=c}+|mTwTOjSS}O&=lH8m7p%p9Gub=;E$c!c?9v0{g~DO~ zhM9X{{|9#I`Jb2>=0B<&U7c)yYcj*Y%x%r>%w4J&U3;vH1h3d{LH{)Wwx+x|0(KE+dt#c|C-@X>mS5r^F=hU9_F?vIqXGCf9ntw z5QF`z|!m5s5+QoEj;B+T+Ai-;JgANa3K+XUM9Hk<>3B>+<(OUQNg80 z*2&z&#lcC(!NFGIw+g$ zzLGLUo)}0+25u^)X{!60@&Q|60--0VHjqqthMC?$%PLF^93$GKy%zIC)NOswf-&(t zdo(L^G;K8V<4E26S9=zPMMcNw^=HTDHQsad9HvJ%ee#NM26b1ol*ztvsP)4dg{&oC zs;xh12<(o;$j9rQ-UC7=*wu1n<`}b`4SByl-f_(%c3}})K8;&??yeSe8cH`IK0LGE z%TjmrVY3 zrW-v%)U${vW&gUCI2q>-@***e>#bs)Nd_=@q=;yX!*G##p~0Y6vSSz3bZZqUcmumu zc%@|m+4x`=l~_jYSu{pE(USKKFdOyH8B!PjU*B+-)w?R`KN-Vvw;2#FIR3jXq$>T$R z$(BpcF|yQmz&V@q=GV4E)!|9<^yq)Dms&lKygSCjID0&{xv$sH2;UIUOnXS|JOL zp=VFv&`4JbpN#vEB*+zyei|^gie7rH;(!4&ul4a=t;c=vy4iPbB-{mBV(y%c?>aGQtjfSgZcIG(HQ~WCF72`hnx9PBBjaU7nKG@I zB&LGDD_*m+7YbrrQ8-xfbUKFXCqL2Tdkpg7U(;+4OKf9JM+Sjy$gzq6B%f$Xlq=%B zf1$ObrOUXVj1I>FT1bh&*u7L2J9GkR-4IDee|UScATer-n|}6ml15xc6YP!UR9dT! z&YGRDf?ySyGQNQo7=WP@s`AG=S3b7MX48jQ>M&TJ??F}!VNz0dF=mN-er&}Cwb#z( zv+@nIBY-Y5GaTETFOEk&>0V|%lNCnxC4tcARs)S-0;El`7K2B>mZdFO>>|#4M00O& z@m8g&u>N~lD@E4y{2bDwgIh}LX;BHVQ9{f2Ms?I!yF5bkgL(0*!>U4ko?WO+i-6Ez zdh!x-oK{i&+m4#Rw4szWElB^gxWyd=Np|gvq++k5#{=9(&$(4Anr#}4B8PO#*tf|o zGk1?Qb{F*7sN~AFK6lvC_dH+=ed3peL&+mU0BeV}#BL6GDMI`l8@dmg#9cVzae8V% zSnsr0R~-hywfbcTDixzJ>1`|mh3P99zEk}!%ilsOhC!HYEORA)TEnmxQ*lwSzP~HN z3kiJ7X92|;T_5Ke*rq!T8xn@7hOTpoH9s1h&U}ulCVFDzO?FQ?RqDgYlzrLz@UDVT zNaZ<}0Xa0f5k(*VLFlYFrQG{hv5$}7eTi~YFp_1J1ZGPw`%I$~N&HloP_VTfMZ=G& zO04+Vj=f%Fuyg<)Exz81)9u^MEcWyxvmQR7D$p(}R_|o?qL2$8d~rz4Mf%Z&W^B_) z>cD?~kgo}I|BlN6K1kFpcdE8xf>tapTP3BlKg|~iLXb##Z4lD4=Xtwvt)c2XfVKq# zS5k5vez6#ixHBA;^?4^to=AMTot~3UE8;^L_-zEcIUVA%MyzM(aWh^$W0GD9*u(U` zY(xs^Bz8iSrBJy_n_ND|78Upw4!La|75{b(u`k=r?5I<+i3Z1Lw|?bv%#K=liI_OG zD>f7uj|00k*~YYkgXy}N`n=@vkTI=}yYBv>(GUFH)M?(7`VuvcdRxu8iN%Jn zHt(3pa1#o(M@6FGVODq)#tX$AcrKO%8^IyGyn?ML^@~nXKjeHb6Z9rCiCDCWCp&j} z0-*#|_qo6DIDx=;zN=1PIdNj+AzAUOB&_T(f^oW!Vms;3Kd!Lz?H);i&*DIbW5TjK z!vQI8+LM>bX2e;dM@0l1`WZ?9qgx5(_XjDeZ#eBf;YReFrTRN1$2FVidpQC1485+C zNAD`y5XEmZi@7#0LZh)>G(X>()X9X&bz)NFGuraRxX!>IR$d5dtK6*OqYoJ=+7o+1 zEe^Xq@C|-IbbZWe4kmbzclFF8(8yq$%hoS4qcyFVeYW`PFaSX}*`2){`_QtN93!l`#plCGW1 z<&V$>&i9Fc?)S$93s>|amDQYCd#F(N!`eSu>}21g7=w)kb(P{VXF9OrL**W&lSw!m zuIfU#Rr)wG9bOo}*Wm1SbF?s8Tq}Mah#1^%^m>B3qV>A7=yQ)bl=ynv z7k62o(akc|YWO}P%++o2%hu@tD{lLl(D3%u;cKuXGbC^vw?Ps~PC=;-R|f6safdFi z*Tq^nbA4evqgn;2Gi$jef>_-HJzp*}@Y2c-y)LW^bhbk8@j+o1pNNX889q%S3E?^P zQW%N+5*U?-fi`Gm^XhY^|74h&XsHE`I^Lj-*g}tMvg#+29Asoke zC%roP713MbJDBay>i6WGO^GE&o(+q=ex42qP+nG?h)&@4zWNF9?%|I52P6e^)|Cyl zxNozp(xlpt`0l)wn#yG9p_R!;A()yWSddtU3r?<*dbfZvk*8q1!_h7UOkj3a-P<`9dPy}i&PNru(S>&c1zC0(W!fW#yxXE@$&AH$v6Zwd z5^m(0>0)g2j7_WGlnp+#ddmSGTBQUJoQmGG>A8(o#w=e!r?RU zxv+EFN=A;Z=olZP!^fVrdV(eApiizP{NT9u6<*+p&pIn#26}P7a-vk(z{~FEvLPAn z<|ZPF(*{p@8(hkn))n1YF_6}KsPaDI#E=4alZFH@l8D1ZV~H1-RiIXpRh7G4vb$Ke zB?EZ)>P`;ct9G4jfeG)N?Go3evMmL`Lp#NwkgGa<<${7 z!`qRBH?mg0i2~D*@QMI(@ob|KOa@;;5GgMDEj#LwymjOJ!zI4J`I8_rTyjRLB4*<- zLF5CQ_FWF(uVNDw#dyW^wY$fAA&E6A6T%G>V8=Tm~NB)mlK^cKhLYj%xW+<|#FS@p)zOw^4~d9UQO