USE_DATETIME env var for filter behavior #443

YuriZmytrakov · 2025-09-15T15:44:25Z

Related Issue(s):

#403

Description:

This PR introduces a new env var USE_DATETIME to control the datetime filtering behavior in the search.

PR Checklist:

Code is formatted and linted (run pre-commit run --all-files)
Tests pass (run make test)
Documentation has been updated to reflect changes, if applicable
Changes are added to the changelog

jonhealy1

@YuriZmytrakov This is really useful. 1. changelog update. 2. we should probably have a test for this.

jonhealy1 · 2025-09-19T09:51:36Z

CHANGELOG.md

 - `STAC_INDEX_ASSETS` environment variable to allow asset serialization to be configurable. [#433](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/433)
 - Added the `ENV_MAX_LIMIT` environment variable to SFEOS, allowing overriding of the `MAX_LIMIT`, which controls the `?limit` parameter for returned items and STAC collections. [#434](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/434)
+- Updated the `format_datetime_range` function to support milliseconds. [#423](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/423)
+- Added `USE_DATETIME` environment variable behavior to set datetime filtering logic. [#443](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/443)


Hi. Any new changes need to be put under the Unreleased section as v6.3.0 has already been released.

@jonhealy1 I have moved my changes to Unrealeased section. Thank you!

YuriZmytrakov · 2025-09-19T10:13:16Z

@YuriZmytrakov This is really useful. 1. changelog update. 2. we should probably have a test for this.

Yes, we can do that.

jonhealy1 · 2025-09-19T10:51:24Z

CHANGELOG.md


 ## [Unreleased]

+- Added `USE_DATETIME` environment variable behavior to set datetime filtering logic. [#443](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/443)


Add a, ### Added, header above this entry.

Done, thank you!

jonhealy1 · 2025-09-19T10:52:07Z

README.md

 | `STAC_ITEM_LIMIT` | Sets the environment variable for result limiting to SFEOS for the number of returned items and STAC collections. | `10` | Optional |
 | `STAC_INDEX_ASSETS` | Controls if Assets are indexed when added to Elasticsearch/Opensearch. This allows asset fields to be included in search queries. | `false` | Optional |
 | `ENV_MAX_LIMIT` | Configures the environment variable in SFEOS to override the default `MAX_LIMIT`, which controls the limit parameter for returned items and STAC collections. | `10,000` | Optional |
+| `USE_DATETIME` | Configures the environment variable to control datetime filtering behavior. When `true`, searches by datetime field, and if datetime is `null` then by start/end datetime fields. When `false`, always searches only by start/end datetime fields. | true | Optional |


I think we need to have a test for this new functionality

I added tests for the use_datetime variable (true/false) to verify changes in filter behavior.

jonhealy1

Looks great. Tests are great, just the changelog issue to look at.

jonhealy1 · 2025-09-22T06:26:27Z

CHANGELOG.md


 ### Added

+- Added `USE_DATETIME` environment variable behavior to set datetime filtering logic. [#443](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/443)


Hi @YuriZmytrakov - this entry is still under the v6.3.0 section. It needs to be moved to the Unreleased section above. You will need to add an '### Added' header to the Unreleased section and move your pr entry there.

[Unreleased]

Changed

updated numReturned & numMatched fields in itemCollection return to numberReturned & numberMatched. #446

[v6.3.0] - 2025-09-16

Added

Added USE_DATETIME environment variable behavior to set datetime filtering logic. #443

Apologies, I was working on not the latest version, I have moved comment in changelog under Unreleased Added section: 3b36f72

jonhealy1 · 2025-09-22T11:17:50Z

@YuriZmytrakov Looks like errors with Opensearch?

- Added USE_DATETIME env var to control datetime filtering - USE_DATETIME=True (default): use existing logic that handles both datetime and start/end datetime fields - USE_DATETIME=False (default): use only start/end datetime fields for search

- test_use_datetime_true: Verify USE_DATETIME=true finds looks up by datetime, if null then by start/end datetime range - test_use_datetime_false: Verify USE_DATETIME=false only search items with start/end datetime values

YuriZmytrakov · 2025-09-23T14:48:31Z

@jonhealy1 I had to cherry-pick my commits into new branch, as this one keeps failing. Please take a look at the new PR:
#452

jonhealy1 · 2025-09-23T16:01:09Z

@YuriZmytrakov Do you know why it was failing? Did you change something in the new version?

YuriZmytrakov · 2025-09-23T16:10:36Z

@YuriZmytrakov Do you know why it was failing? Did you change something in the new version?

Yes, I was not able to rebase this branch on the latest main. There was no any changes in the code. @jonhealy1

YuriZmytrakov marked this pull request as draft September 15, 2025 15:44

YuriZmytrakov force-pushed the CAT-1413-2 branch from 8330771 to d5c98f0 Compare September 15, 2025 15:55

YuriZmytrakov changed the title ~~first commit~~ USE_DATETIME env var for filter behavior Sep 15, 2025

YuriZmytrakov force-pushed the CAT-1413-2 branch 5 times, most recently from dbb1831 to ad18cb9 Compare September 16, 2025 14:21

YuriZmytrakov marked this pull request as ready for review September 16, 2025 14:27

jonhealy1 requested changes Sep 19, 2025

View reviewed changes

YuriZmytrakov force-pushed the CAT-1413-2 branch 3 times, most recently from af1a390 to 969e7a8 Compare September 19, 2025 10:05

YuriZmytrakov requested a review from jonhealy1 September 19, 2025 10:11

jonhealy1 requested changes Sep 19, 2025

View reviewed changes

YuriZmytrakov force-pushed the CAT-1413-2 branch 9 times, most recently from e2b72de to 2132c43 Compare September 21, 2025 10:58

YuriZmytrakov requested a review from jonhealy1 September 21, 2025 11:03

jonhealy1 requested changes Sep 22, 2025

View reviewed changes

YuriZmytrakov force-pushed the CAT-1413-2 branch 2 times, most recently from d24d291 to 3b36f72 Compare September 22, 2025 07:35

YuriZmytrakov requested a review from jonhealy1 September 22, 2025 07:59

YuriZmytrakov force-pushed the CAT-1413-2 branch 2 times, most recently from 5d99d46 to 2528ea2 Compare September 23, 2025 13:46

Yuri Zmytrakov added 2 commits September 23, 2025 16:07

tests: add USE_DATETIME env var tests

804c52d

- test_use_datetime_true: Verify USE_DATETIME=true finds looks up by datetime, if null then by start/end datetime range - test_use_datetime_false: Verify USE_DATETIME=false only search items with start/end datetime values

YuriZmytrakov force-pushed the CAT-1413-2 branch from e835a01 to 804c52d Compare September 23, 2025 14:08

YuriZmytrakov closed this Sep 23, 2025


		## [Unreleased]

		- Added `USE_DATETIME` environment variable behavior to set datetime filtering logic. [#443](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/443)


		### Added

		- Added `USE_DATETIME` environment variable behavior to set datetime filtering logic. [#443](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/443)

USE_DATETIME env var for filter behavior #443

USE_DATETIME env var for filter behavior #443

Uh oh!

Conversation

YuriZmytrakov commented Sep 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jonhealy1 left a comment

Choose a reason for hiding this comment

Uh oh!

jonhealy1 Sep 19, 2025

Choose a reason for hiding this comment

Uh oh!

YuriZmytrakov Sep 19, 2025

Choose a reason for hiding this comment

Uh oh!

YuriZmytrakov commented Sep 19, 2025

Uh oh!

jonhealy1 Sep 19, 2025

Choose a reason for hiding this comment

Uh oh!

YuriZmytrakov Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

jonhealy1 Sep 19, 2025

Choose a reason for hiding this comment

Uh oh!

YuriZmytrakov Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

jonhealy1 left a comment

Choose a reason for hiding this comment

Uh oh!

jonhealy1 Sep 22, 2025

Choose a reason for hiding this comment

[Unreleased]

Changed

[v6.3.0] - 2025-09-16

Added

Uh oh!

YuriZmytrakov Sep 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jonhealy1 commented Sep 22, 2025

Uh oh!

YuriZmytrakov commented Sep 23, 2025

Uh oh!

jonhealy1 commented Sep 23, 2025

Uh oh!

YuriZmytrakov commented Sep 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

YuriZmytrakov commented Sep 15, 2025 •

edited

Loading

YuriZmytrakov Sep 22, 2025 •

edited

Loading