Skip to content

Commit d71a1ce

Browse files
committed
swap indexing instructions order
1 parent a42f196 commit d71a1ce

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -69,12 +69,22 @@ For a more detailed example with test data, please refer to the Confluence docum
6969

7070
This CLI provides a couple of ways to index records into a local Opensearch instance:
7171

72-
1. A step-by-step approach that mirrors the actions in the TIMDEX ETL StepFunction
73-
2. A single, convenience command that fully reindexes a source
72+
1. **[Easy]**: A single, convenience command that fully reindexes a source. Only the `source` is needed.
73+
2. **[Advanced]**: A step-by-step approach that mirrors the actions in the TIMDEX ETL StepFunction. While you have more control over the indexing process, you will need to know the `source`, `run_id`, and `run_date` of the records you want to index.
7474

7575
For both, first follow the instructions in either [Running Opensearch locally with Docker](#running-opensearch-locally-with-docker) or [Running Opensearch and OpenSearch Dashboards locally with Docker](#running-opensearch-and-opensearch-dashboards-locally-with-docker), and then open a new terminal for the following commands.
7676

77-
#### Option 1: Step-by-Step Bulk Index
77+
#### Option 1: Fully Reindex a Source (Easy)
78+
79+
1. Utilize the CLI command `reindex-source`:
80+
81+
```shell
82+
pipenv run tim --verbose reindex-source \
83+
--source <source-name> \
84+
<dataset-location>
85+
```
86+
87+
#### Option 2: Step-by-Step Bulk Index (Advanced)
7888

7989
1. Create a new index. Copy the name of the created index printed to the terminal's output.
8090

@@ -104,16 +114,6 @@ pipenv run tim bulk-index \
104114
pipenv run tim delete -i <index-name>
105115
```
106116

107-
#### Option 2: Fully Reindex a Source
108-
109-
1. Utilize the CLI command `reindex-source`:
110-
111-
```shell
112-
pipenv run tim --verbose reindex-source \
113-
--source <source-name> \
114-
<dataset-location>
115-
```
116-
117117
### Running OpenSearch on AWS
118118

119119
1. Ensure that you have the correct AWS credentials set for the Dev1 (or desired) account.

0 commit comments

Comments
 (0)