From b239800f460249e599fd1fd376aefee2668880c4 Mon Sep 17 00:00:00 2001 From: Willi Date: Fri, 29 Nov 2024 17:26:48 +0100 Subject: [PATCH] Add --no-index option documentation --- docs/docs/indices.md | 31 +++++++++++++++++++++---------- 1 file changed, 21 insertions(+), 10 deletions(-) diff --git a/docs/docs/indices.md b/docs/docs/indices.md index 413c5e7..17fc690 100644 --- a/docs/docs/indices.md +++ b/docs/docs/indices.md @@ -85,15 +85,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 @@ -135,7 +126,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. @@ -144,6 +135,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. @@ -269,6 +271,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.