Skip to content

Commit 5468cc6

Browse files
committed
update readme toc
1 parent 4e212e1 commit 5468cc6

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ This project is built on the following technologies: STAC, stac-fastapi, FastAPI
8585
- [Auth](#auth)
8686
- [Aggregation](#aggregation)
8787
- [Rate Limiting](#rate-limiting)
88+
- [Datetime-Based Index Management](#datetime-based-index-management)
8889

8990
## Documentation & Resources
9091

@@ -230,9 +231,9 @@ You can customize additional settings in your `.env` file:
230231
> [!NOTE]
231232
> The variables `ES_HOST`, `ES_PORT`, `ES_USE_SSL`, `ES_VERIFY_CERTS` and `ES_TIMEOUT` apply to both Elasticsearch and OpenSearch backends, so there is no need to rename the key names to `OS_` even if you're using OpenSearch.
232233
233-
# Datetime-Based Index Management
234+
## Datetime-Based Index Management
234235

235-
## Overview
236+
### Overview
236237

237238
SFEOS supports two indexing strategies for managing STAC items:
238239

@@ -241,7 +242,7 @@ SFEOS supports two indexing strategies for managing STAC items:
241242

242243
The datetime-based indexing strategy is particularly useful for large temporal datasets. When a user provides a datetime parameter in a query, the system knows exactly which index to search, providing **multiple times faster searches** and significantly **reducing database load**.
243244

244-
## When to Use
245+
### When to Use
245246

246247
**Recommended for:**
247248
- Systems with large collections containing millions of items
@@ -255,9 +256,9 @@ The datetime-based indexing strategy is particularly useful for large temporal d
255256
- Slightly longer item indexing time (automatic index management)
256257
- Greater management complexity
257258

258-
## Configuration
259+
### Configuration
259260

260-
### Enabling Datetime-Based Indexing
261+
#### Enabling Datetime-Based Indexing
261262

262263
Enable datetime-based indexing by setting the following environment variable:
263264

0 commit comments

Comments
 (0)