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
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -69,12 +69,22 @@ For a more detailed example with test data, please refer to the Confluence docum
69
69
70
70
This CLI provides a couple of ways to index records into a local Opensearch instance:
71
71
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.
74
74
75
75
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.
76
76
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)
78
88
79
89
1. Create a new index. Copy the name of the created index printed to the terminal's output.
80
90
@@ -104,16 +114,6 @@ pipenv run tim bulk-index \
104
114
pipenv run tim delete -i <index-name>
105
115
```
106
116
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
-
117
117
### Running OpenSearch on AWS
118
118
119
119
1. Ensure that you have the correct AWS credentials set for the Dev1 (or desired) account.
0 commit comments