Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Search improvements #85

Merged
merged 16 commits into from
Nov 4, 2024
Merged

Search improvements #85

merged 16 commits into from
Nov 4, 2024

Conversation

sgreenbury
Copy link
Contributor

@sgreenbury sgreenbury commented Sep 6, 2024

Closes #81 and #82.

This PR includes:

  • SearchConfig as a field on different search param fields (MetricId, GeometryLevel, etc) that enable search type (regex, exact, contains, startswith) and case sensitivity (sensitive or insensitive) of the search for that search param field to be set
  • Update to CLI to allow search type (exact or regex) and case sensitivity (sensitive or insensitive) arguments to be set
  • CLI flags to enable number of unique values for columns from search results (--summary) and displaying column data (--column COLUMN_NAME, --unique COLUMN_NAME) from search results. These have been added as part of the metrics subcommand. It might be an improvement to create a separate subcommand for these instead to keep functionality more distinct.
  • Additional table display functionality
  • Fix broken pipe #92

Remaining tasks:

  • Refactor display.rs to reduce repetition across different display functions
  • Review and consider refactoring/reducing the number of CLI options for metrics subcommand Refactored flags into arg groups. It may be better to introduce a summary subcommand distinct to metrics.
  • Update python bindings and examples

@sgreenbury sgreenbury force-pushed the 81-search-improvements branch from 429011f to 116f277 Compare September 10, 2024 10:41
Adds SearchConfig with `MatchType` (Exact, Regex, Contains, Startswith),
and `CaseSensitivity` (Insensitive or Sensitive), adds a test, and
incorporates into CLI with defaults for:
- `SearchText` when across all search contexts (regex)
- `MetricsId` (startswith, case insensitive)
@sgreenbury sgreenbury force-pushed the 81-search-improvements branch from 116f277 to 1978d57 Compare September 10, 2024 10:55
@sgreenbury sgreenbury marked this pull request as ready for review September 18, 2024 08:52
@sgreenbury sgreenbury self-assigned this Oct 16, 2024
@sgreenbury sgreenbury mentioned this pull request Nov 1, 2024
@sgreenbury sgreenbury force-pushed the 81-search-improvements branch from 97140b0 to 0998aa8 Compare November 4, 2024 17:13
@sgreenbury
Copy link
Contributor Author

sgreenbury commented Nov 4, 2024

Possible next steps/improvements for the next issues with user feedback:

  • Revisit if fixed width (currently 100) for table works well
  • Should the new summary/metadata column name commands be moved to subcommand
  • Revisit the defaults regarding regex or exact match types for different search fields
  • Add documentation/example of how to search given an example query (e.g. number of vehicles used by a household)

@sgreenbury sgreenbury merged commit a9b39cb into main Nov 4, 2024
9 checks passed
@sgreenbury sgreenbury deleted the 81-search-improvements branch November 4, 2024 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done:
Development

Successfully merging this pull request may close these issues.

Ideas: possibly improvements to the output of the metrics command
1 participant