• Home
  • History
  • Annotate
  • only in this directory
Name Date Size

..11-Feb-20204 KiB

.gitignoreH A D11-Feb-2020208

.travis.ymlH A D11-Feb-2020337

audit.goH A D11-Feb-20202 KiB

bindata_assetfs.goH A D11-Feb-2020200.9 KiB

bleve_config_default.goH A D11-Feb-2020866

bleve_metrics.goH A D11-Feb-2020669

cache.goH A D11-Feb-20205.3 KiB

cache_bleve.goH A D11-Feb-20205.3 KiB

cache_test.goH A D11-Feb-20205.9 KiB

CHANGES.mdH A D11-Feb-20206.3 KiB

CMakeLists.txtH A D11-Feb-20203 KiB

cmd/H11-Feb-20204 KiB

DESIGN-compaction.mdH A D11-Feb-20204.9 KiB

DESIGN.mdH A D11-Feb-202056.8 KiB

dist/H11-Feb-20204 KiB

docs/H11-Feb-20204 KiB

etc/H11-Feb-20204 KiB

extras.goH A D11-Feb-2020975

LICENSE-thirdparty.txtH A D11-Feb-202042.5 KiB

LICENSE.txtH A D11-Feb-202011.1 KiB

MakefileH A D11-Feb-20206.3 KiB

marshal.goH A D11-Feb-20205.5 KiB

missing.goH A D11-Feb-20203.3 KiB

mkdocs.ymlH A D11-Feb-20201.2 KiB

ns_server.goH A D11-Feb-202029.9 KiB

ns_server_static/fts/H11-Feb-20204 KiB

ns_server_test.goH A D11-Feb-20201.2 KiB

pindex_alias.goH A D11-Feb-20207 KiB

pindex_bleve.goH A D11-Feb-202061.3 KiB

pindex_bleve_doc.goH A D11-Feb-20205 KiB

pindex_bleve_doc_test.goH A D11-Feb-20202.4 KiB

pindex_bleve_moss_rollback.goH A D11-Feb-20204.9 KiB

pindex_bleve_rollback.goH A D11-Feb-20202.5 KiB

pindex_bleve_rollback_test.goH A D11-Feb-202010.4 KiB

pindex_bleve_scorch_rollback.goH A D11-Feb-20203.7 KiB

pindex_bleve_test.goH A D11-Feb-202017 KiB

pluggable-ui-fts.cluster_run.json.inH A D11-Feb-2020370

pluggable-ui-fts.json.inH A D11-Feb-2020218

query_event.goH A D11-Feb-20201.1 KiB

query_supervisor.goH A D11-Feb-20204.5 KiB

query_supervisor_test.goH A D11-Feb-20201.4 KiB

README-dev.mdH A D11-Feb-20203 KiB

README.mdH A D11-Feb-20201.3 KiB

remote.goH A D11-Feb-202010.3 KiB

remote_test.goH A D11-Feb-20203.8 KiB

rest.goH A D11-Feb-20204.6 KiB

rest_auth.goH A D11-Feb-20209.5 KiB

rest_auth_test.goH A D11-Feb-202016.6 KiB

rest_list.goH A D11-Feb-20202.9 KiB

rest_options.goH A D11-Feb-20204.3 KiB

rest_perm.goH A D11-Feb-20202.8 KiB

rest_test.goH A D11-Feb-202079.9 KiB

search.goH A D11-Feb-2020994

staticx/H11-Feb-20204 KiB

tmp/H11-Feb-20204 KiB

unmarshal.goH A D11-Feb-202014.3 KiB

version.goH A D11-Feb-20202.3 KiB

README-dev.md

1# For cbft developers
2
3## Dev environment setup
4
5    go get -u github.com/couchbase/cbft/...
6    cd $GOPATH/src/github.com/couchbase/cbft
7    make prereqs
8
9## Building cbft
10
11    make
12
13## Unit tests
14
15    make test
16
17## Coverage reports
18
19To get local coverage reports with heatmaps...
20
21    make coverage
22
23To get more coverage reports that include dependencies like the bleve library...
24
25    go test -coverpkg github.com/couchbase/cbft,github.com/blevesearch/bleve,github.com/blevesearch/bleve/index \
26        -coverprofile=coverage.out \
27        -covermode=count && \
28    go tool cover -html=coverage.out
29
30## Documentation
31
32Generating documentation...
33
34We use the [MkDocs](http://mkdocs.org) tool to help generate an HTML
35docs website from the markdown files in the ```./docs``` subdirectory.
36
37To generate the REST API markdown documentation...
38
39    make gen-docs
40
41For a local development testing web server that automatically
42re-generates the HTML website of ```./docs``` changes, run...
43
44    mkdocs serve
45
46Then browse to http://127.0.0.1:8000 to see the HTML docs website.
47
48To deploy the HTML docs website to github's gh-pages, run...
49
50    mkdocs gh-deploy
51
52## Coding conventions
53
54You must pass ```go fmt```.
55
56Error message conventions...
57
58In the cbft project, fmt.Errorf() and log.Printf() messages follow a
59rough formatting convention, like...
60
61    <source_file_base_name>: <short static msg string>, <arg0>: <val0>, <arg1>: <val1>
62
63The "short static msg string" should be unique enough so that ```git grep```
64works well.
65
66## Contributing fixes/improvements
67
68We require a contributor license agreement (CLA) to be signed before
69we can merge any pull requests.  To sign this agreement, please
70register at the [couchbase code review
71site](http://review.couchbase.org/). The cbft project currently does
72not use this code review app, but it is still used to track acceptance
73of the CLA.
74
75All types of contributions are welcome, but please keep the following
76in mind:
77
78Existing tests should continue to pass ("make test"), and new tests
79for contributions are quite nice to have.
80
81All code should have pass "go fmt ./..." and "go vet ./...".
82
83## Releasing
84
85To do a full release with a new (semver) tag, see the Makefile's
86"release" target.
87
88## For Couchbase Server developers
89
90For running using Couchbase Server's cluster_run (in watson and beyond)...
91
92    cd (your dev directory where you ran 'repo sync' for couchbase server watson.xml)
93    make -j 9
94    mkdir -p install/lib/fts
95    rm -rf install/lib/fts/static
96    rm -rf install/lib/fts/static-bleve-mapping
97    rm -rf install/lib/fts/staticx
98    ln -s ../../../goproj/src/github.com/couchbase/cbft/staticx/ install/lib/fts
99    ln -s ../../../goproj/src/github.com/couchbase/cbgt/rest/static/ install/lib/fts
100    ln -s ../../../godeps/src/github.com/blevesearch/bleve-mapping-ui/static-bleve-mapping/ install/lib/fts
101    cp goproj/src/github.com/couchbase/cbft/ns_server_static/fts/* install/lib/fts
102    cd ns_server
103    ./cluster_run --pluggable-config="../build/goproj/src/github.com/couchbase/cbft/pluggable-ui-fts.cluster_run.json"
104

README.md

1cbft
2====
3
4Couchbase Full Text server
5
6The cbft project integrates the bleve full-text search engine and Couchbase Server.
7
8[![GoDoc](https://godoc.org/github.com/couchbase/cbft?status.svg)](https://godoc.org/github.com/couchbase/cbft) [![Build Status](https://travis-ci.org/couchbase/cbft.svg)](https://travis-ci.org/couchbase/cbft) [![Coverage Status](https://coveralls.io/repos/couchbase/cbft/badge.png?branch=master)](https://coveralls.io/r/couchbase/cbft?branch=master)
9
10A cbft process creates and maintains full-text indexes using the
11[bleve full-text indexing engine](http://www.blevesearch.com/).
12
13Data sources for indexing include Couchbase 3.0+ and Couchbase 4.0+
14buckets.
15
16Full-text indexes can be optionally partitioned across multiple cbft
17processes.
18
19Queries on a cbft index will be scatter/gather'ed across the relevant,
20distributed cbft processes.
21
22# Licenses
23
24* Apache 2.0.
25* See also: [third party licenses](https://github.com/couchbase/cbft/blob/master/LICENSE-thirdparty.txt)
26
27# Getting started and documentation
28
29Please see the [getting started](http://labs.couchbase.com/cbft) guide
30for cbft, available at
31[http://labs.couchbase.com/cbft](http://labs.couchbase.com/cbft).
32
33# For developers / contributors
34
35Please see the [README for developers](https://github.com/couchbase/cbft/blob/master/README-dev.md)
36