Skip to content

Commit

Permalink
Fix some documentation bug
Browse files Browse the repository at this point in the history
  • Loading branch information
johtani committed Aug 27, 2020
1 parent f1ce7df commit 1d211f7
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,12 @@ Load new line delimited JSON(ndjson) files that looks like generated by [wikidat

## Usage

Sample setting yaml in sample directory
Sample setting yaml in sample directory. See [./sample](./sample) directory.

### Prepare

**Must to create index before run this command.**

For Elasticsearch, sample index settings/mappings in [./sample/elasticsearch_wiki_extractor_rs](sample/elasticsearch) directory.
For Elasticsearch, sample index settings/mappings in [./sample](sample) directory.
This sample mapping came from [wikidata-filter](https://github.com/johtani/wikidata-filter) json.

### Load command
Show help with the following command::
Expand All @@ -33,6 +32,6 @@ $ .target/release/bin/bulk2es -h
#### Options

```
$ ./bulk2es -c <SEARCH_ENGINE_CONFIG> -s <SEARCH_ENGINE_TYPE> <INPUT_DIR>
$ ./bulk2es -c <SEARCH_ENGINE_CONFIG> <INPUT_DIR>
```

4 changes: 4 additions & 0 deletions sample/es.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# url to elasticsearch cluster
url: "http://192.168.1.24:9200"
# bulk size
buffer_size: 3000
# index name
index_name: wikidata_test
# set absolute file path or relative file path from directory that command run.
schema_file: "./sample/sample_schema.json"
id_field_name: "id"
# if output Elastic Cloud Elasticsearch Service, need to set these 3 settings.
Expand Down

0 comments on commit 1d211f7

Please sign in to comment.