You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-221Lines changed: 3 additions & 221 deletions
Original file line number
Diff line number
Diff line change
@@ -16,225 +16,7 @@ Bayard makes easy for programmers to develop search applications with advanced f
16
16
- Command line interface is available
17
17
18
18
19
-
## Building Bayard
19
+
## Documents
20
20
21
-
```text
22
-
$ make build
23
-
```
24
-
25
-
26
-
## Starting in standalone mode (single node cluster)
27
-
28
-
Running node in standalone mode is easy. See following command:
29
-
30
-
```text
31
-
$ ./bin/bayard serve
32
-
```
33
-
34
-
### Indexing document
35
-
36
-
Indexing a document is as following:
37
-
38
-
```text
39
-
$ ./bin/bayard set 1 '{"text":"Tantivy is a full-text search engine library inspired by Apache Lucene and written in Rust."}'
40
-
$ ./bin/bayard set 2 '{"text":"Apache Lucene is a high-performance, full-featured text search engine library written entirely in Java."}'
41
-
$ ./bin/bayard set 3 '{"text":"Bleve is a modern text indexing library for go."}'
42
-
$ ./bin/bayard set 4 '{"text":"Whoosh is a fast, pure Python search engine library."}'
43
-
$ ./bin/bayard set 5 '{"text":"Solr is highly reliable, scalable and fault tolerant, providing distributed indexing, replication and load-balanced querying, automated failover and recovery, centralized configuration and more."}'
44
-
$ ./bin/bayard set 6 '{"text":"Elasticsearch is a distributed, open source search and analytics engine for all types of data, including textual, numerical, geospatial, structured, and unstructured."}'
45
-
$ ./bin/bayard set 7 '{"text":"Riot is Go Open Source, Distributed, Simple and efficient full text search engine."}'
46
-
$ ./bin/bayard set 8 '{"text":"Blast is a full text search and indexing server, written in Go, built on top of Bleve."}'
47
-
$ ./bin/bayard set 9 '{"text":"Toshi is meant to be a full-text search engine similar to Elasticsearch. Toshi strives to be to Elasticsearch what Tantivy is to Lucene."}'
48
-
$ ./bin/bayard set 10 '{"text":"Sonic is a fast, lightweight and schema-less search backend."}'
49
-
$ ./bin/bayard set 11 '{"text":"Bayard is a full text search and indexing server, written in Rust, built on top of Tantivy."}'
50
-
```
51
-
52
-
### Getting document
53
-
54
-
Getting a document is as following:
55
-
56
-
```text
57
-
$ ./bin/bayard get 11 | jq .
58
-
```
59
-
60
-
You can see the result in JSON format. The result of the above command is:
61
-
62
-
```json
63
-
{
64
-
"id": [
65
-
"11"
66
-
],
67
-
"text": [
68
-
"Bayard is a full text search and indexing server, written in Rust, built on top of Tantivy."
69
-
]
70
-
}
71
-
```
72
-
73
-
### Searching documents
74
-
75
-
Searching documents is as like following:
76
-
77
-
```
78
-
$ ./bin/bayard search text:"search engine" | jq .
79
-
```
80
-
81
-
You can see the result in JSON format. The result of the above command is:
82
-
83
-
```json
84
-
[
85
-
{
86
-
"id": [
87
-
"4"
88
-
],
89
-
"text": [
90
-
"Whoosh is a fast, pure Python search engine library."
91
-
]
92
-
},
93
-
{
94
-
"id": [
95
-
"7"
96
-
],
97
-
"text": [
98
-
"Riot is Go Open Source, Distributed, Simple and efficient full text search engine."
99
-
]
100
-
},
101
-
{
102
-
"id": [
103
-
"1"
104
-
],
105
-
"text": [
106
-
"Tantivy is a full-text search engine library inspired by Apache Lucene and written in Rust."
107
-
]
108
-
},
109
-
{
110
-
"id": [
111
-
"2"
112
-
],
113
-
"text": [
114
-
"Apache Lucene is a high-performance, full-featured text search engine library written entirely in Java."
115
-
]
116
-
},
117
-
{
118
-
"id": [
119
-
"6"
120
-
],
121
-
"text": [
122
-
"Elasticsearch is a distributed, open source search and analytics engine for all types of data, including textual, numerical, geospatial, structured, and unstructured."
123
-
]
124
-
},
125
-
{
126
-
"id": [
127
-
"9"
128
-
],
129
-
"text": [
130
-
"Toshi is meant to be a full-text search engine similar to Elasticsearch. Toshi strives to be to Elasticsearch what Tantivy is to Lucene."
131
-
]
132
-
},
133
-
{
134
-
"id": [
135
-
"10"
136
-
],
137
-
"text": [
138
-
"Sonic is a fast, lightweight and schema-less search backend."
139
-
]
140
-
},
141
-
{
142
-
"id": [
143
-
"11"
144
-
],
145
-
"text": [
146
-
"Bayard is a full text search and indexing server, written in Rust, built on top of Tantivy."
147
-
]
148
-
},
149
-
{
150
-
"id": [
151
-
"8"
152
-
],
153
-
"text": [
154
-
"Blast is a full text search and indexing server, written in Go, built on top of Bleve."
155
-
]
156
-
}
157
-
]
158
-
```
159
-
160
-
### Deleting document
161
-
162
-
```
163
-
$ ./bin/bayard delete 11
164
-
```
165
-
166
-
167
-
## Starting in cluster mode (3-node cluster)
168
-
169
-
Bayard can easily bring up a cluster. Running in standalone is not fault tolerant. If you need to improve fault tolerance, start two more nodes as follows:
Above example shows each Bayard node running on the same host, so each node must listen on different ports. This would not be necessary if each node ran on a different host.
203
-
Recommend 3 or more odd number of nodes in the cluster. In failure scenarios, data loss is inevitable, so avoid deploying single nodes.
204
-
205
-
### Remove a node from a cluster
206
-
207
-
If one of the nodes in a cluster goes down due to a hardware failure and raft logs and metadata is lost, that node cannot join the cluster again.
208
-
209
-
```
210
-
$ ./bin/bayard leave \
211
-
--host=127.0.0.1 \
212
-
--port=5001 \
213
-
--id=3 \
214
-
--peers="1=0.0.0.0:5001,2=0.0.0.0:5002" \
215
-
--leader-id=1
216
-
```
217
-
218
-
219
-
## Bayard on Docker
220
-
221
-
### Pulling Docker container image from docker.io
222
-
223
-
You can pull the Docker container image already registered in docker.io like so:
0 commit comments