Skip to content

Commit

Permalink
Clean up docs (#29)
Browse files Browse the repository at this point in the history
* Clean up docs

* Update README.md
  • Loading branch information
SamMacy authored Aug 19, 2024
1 parent 3c39637 commit da88d26
Showing 1 changed file with 6 additions and 11 deletions.
17 changes: 6 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ For guidance on how to get an instance of ES and kibana running vist our doc on

### Run the indexer

#### Using a local sql project
#### Using a local sqlite Senzing database

1. We will mount the sqlite database; make sure the `CONNECTION` string in our config json points to where it is mounted. In this example the `CONNECTION` will need to point towards the `/db` dir. We also need to run the container as part of the network that the ELK-stack is running in. Example:

Expand All @@ -109,9 +109,9 @@ For guidance on how to get an instance of ES and kibana running vist our doc on
senzing/elasticsearch
```

#### Using a database in a docker container
* ⚠️ **This section represents an example of how to connect to a database within a dockerfile but is not demonstratable with the current state of senzing-tools** ⚠️
1. Here we won't need to mount a database, instead we can set our `CONNECTION` string in the config json to the exposed ports of the container with the database. Example;
#### Using an external Senzing database

1. Here we won't need to mount a database, instead we can set our `CONNECTION` string in the config json to where the external database is. Example:

```console
export SENZING_ENGINE_CONFIGURATION_JSON='{
Expand All @@ -125,12 +125,7 @@ For guidance on how to get an instance of ES and kibana running vist our doc on
}
}'
```
1. Next we will start up a docker stack to initialize and load data into a database.

```console
cd {GIT_REPOSITORY_DIR}/elasticsearch
docker-compose up
```
1. Now we can run the container as part of the network that the ELK-stack is running in so that it can "see" the elasticsearch container. Example:

```console
Expand Down Expand Up @@ -159,4 +154,4 @@ For guidance on how to get an instance of ES and kibana running vist our doc on
* The `Name` field can be set but is not required.

5. Press "Save data view to Kibana" at the bottom of the screen, now can view the created index and do searches. If fuzzy searches are needed click on "Saved Query" and switch the language to lucene. [Here](https://www.elastic.co/guide/en/elasticsearch/reference/8.8/query-dsl-query-string-query.html#query-string-fuzziness) you can view the lucene syntax and how to do fuzzy searches
<img width="246" alt="image" src="https://github.com/SamMacy/elasticsearch/assets/49598357/c77b8f8b-6877-4701-9677-511e5aafb81f">
<img width="246" alt="image" src="https://github.com/SamMacy/elasticsearch/assets/49598357/c77b8f8b-6877-4701-9677-511e5aafb81f">

0 comments on commit da88d26

Please sign in to comment.