Skip to content

Commit

Permalink
Merge pull request #83 from getdozer/update-secondary
Browse files Browse the repository at this point in the history
update secondary index configuration format
  • Loading branch information
chubei authored Nov 28, 2023
2 parents dfa212a + ec83751 commit f87ce1f
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions docs/configuration/api-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ index:
- dropoff_location
secondary:
create:
- index: !SortedInverted
- !SortedInverted
fields:
- hvfhs_license_num
- trip_miles
Expand All @@ -42,8 +42,7 @@ index:
| Name | Type | Description |
|-------------------------------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `primary_key` | List of Strings | Defines the fields that compose the primary key for the endpoint. Essential for unique record identification. |
| `secondary.create` | List of Objects | An array of secondary index configurations. |
| ↳ `index` | Enum | Type of the secondary index. Examples: `!SortedInverted`, `!FullText`. Refer to the sections below for index specific configurations. |
| `secondary.create` | List of Enums | An array of secondary index configurations. Examples: `!SortedInverted`, `!FullText`. Refer to the sections below for index specific configurations. |
| `skip_default` | List of Strings | Skip the automatic secondary index creation for the listed fields. If not specified, Dozer creates `!SortedInverted` secondary index for every field. |

#### `SortedInverted` secondary index configuration
Expand Down

0 comments on commit f87ce1f

Please sign in to comment.