Skip to content

Commit 81ea93b

Browse files
committed
TASK: Document available commands
1 parent c34d3c9 commit 81ea93b

1 file changed

Lines changed: 37 additions & 10 deletions

File tree

README.md

Lines changed: 37 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -54,23 +54,52 @@ There may be a need, to add specific configuration to your Elasticsearch Configu
5454

5555
- [Elasticsearch 5.x](Documentation/ElasticConfiguration-5.x.md)
5656

57-
## Building up the Index
57+
## Available Commands
58+
59+
### Building up the index
5860

5961
The node index is updated on the fly, but during development you need to update it frequently.
6062

6163
In case of a mapping update, you need to reindex all nodes. Don't worry to do that in production;
6264
the system transparently creates a new index, fills it completely, and when everything worked,
6365
changes the index alias.
6466

65-
```
66-
./flow nodeindex:build
67+
./flow nodeindex:build
68+
69+
if during development, you only want to index a few nodes, you can use "limit"
70+
71+
./flow nodeindex:build --limit 20
72+
73+
74+
### Cleanup old indices
75+
76+
In order to remove old, non-used indices, you should use this command from time to time:
77+
78+
./flow nodeindex:cleanup
79+
80+
### Debug commands
81+
82+
The following commands are meant to be used for debugging while configuring and developing your search:
83+
84+
./flow nodeindexmapping:indices
85+
86+
Shows the mapping between the projects dimensions presets and the resultig index name.
87+
88+
./flow nodeindexmapping:mapping
89+
90+
Shows the mapping created for the NodeTypes.
91+
92+
./flow search:viewnode <nodeIdentifier>
93+
94+
Shows all contents that are indexed fo a given node.
95+
96+
./flow search:fulltext
97+
98+
Performs a fulltext search and displays the results.
99+
100+
67101

68-
# if during development, you only want to index a few nodes, you can use "limit"
69-
./flow nodeindex:build --limit 20
70102

71-
# in order to remove old, non-used indices, you should use this command from time to time:
72-
./flow nodeindex:cleanup
73-
```
74103

75104
### Advanced Configuration
76105

@@ -788,5 +817,3 @@ In order to understand what's going on, the following might be helpful:
788817
`elasticSearchMapping`.
789818
3. Replace `ElasticSeach.fulltext` by `Indexing`
790819
4. Search for `ElasticSearch.` (inside the `indexing` expressions) and replace them by `Indexing.`
791-
792-
Created by [Sebastian Kurfürst; contributions by Karsten Dambekalns, Robert Lemke and others](https://github.com/Flowpack/Flowpack.ElasticSearch.ContentRepositoryAdaptor/graphs/contributors).

0 commit comments

Comments
 (0)