Skip to content

Commit

Permalink
Merge pull request #51 from gisaia/doc/no_index_template
Browse files Browse the repository at this point in the history
Add --no-index option documentation in template
  • Loading branch information
WilliGautier authored Dec 5, 2024
2 parents 930ec31 + 417f812 commit 96d9d1d
Showing 1 changed file with 26 additions and 10 deletions.
36 changes: 26 additions & 10 deletions docs/docs/indices.md.template
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,6 @@ The values of the first lines of the files are used to infer the mapping for eac

Make sure to take enough rows to get all the fields with the option `--nb_lines`

!!! tip
The data can be split in different NDJSON files in a folder:
```
part-00000-[...].json
part-00001-[...].json
...
```
In practice, the `file` Argument can be filed with a **pattern** such as `path/to/data.json/part-0000*.json` to reference all the different files.


### Type identification

Expand Down Expand Up @@ -85,7 +76,7 @@ A **date** is identified as such if

By default, the keywords and text fields are searchable as fulltext to be accessible in the search bar.

!!! note "--no-fulltext "
!!! note "--no-fulltext"

If searching through a field value is not needed, it can be deactivated.
That would result in better performances for the fulltext search.
Expand All @@ -94,6 +85,17 @@ By default, the keywords and text fields are searchable as fulltext to be access

- `--no-fulltext field_keyword`

!!! note "--no-index"
If a field doesn't need to be explored in the dashboard, it should be removed before indexing the data.

Alternatively, you can explicitly exclude the field from being indexed using the `--no-index` option.

Example:

- `--no-index unused_field`

The field will remain in the data but will not be indexed.

### Created mapping

By default, the `arlas_cli indices mapping` directly returns the mapping in the command line.
Expand Down Expand Up @@ -144,6 +146,11 @@ The `indices create` sub-function create the index from a mapping json file.

The index name and the path to the mapping json file have to be used to create the ES index.

!!! warning
If the ARLAS deployment uses ARLAS IAM for authentication, the index must be associated with an organisation.

The `index_name` must follow the pattern `{organisation}@{data_index_name}` (e.g., `gisaia.com@ais_courses`).

The `indices create` sub-function create the index from a mapping json file.

Example:
Expand Down Expand Up @@ -180,6 +187,15 @@ Example:
data {index_name} {path/to/data.json}
```

!!! tip
The data can be split in different NDJSON files in a folder:
```
part-00000-[...].json
part-00001-[...].json
...
```
In practice, the `files` argument can be filed with a **pattern** such as `path/to/data.json/part-0000*.json` to reference all the different files.

!!! warning
If the index already contains data, the data is added to the index.

Expand Down

0 comments on commit 96d9d1d

Please sign in to comment.