From c1ef1396247f8733081bae88fac7ec7b153dc8df Mon Sep 17 00:00:00 2001 From: Ryan Kingsbury Date: Tue, 8 Oct 2024 15:35:26 -0400 Subject: [PATCH] GroupBuilder: update doc --- docs/getting_started/group_builder.md | 1 + src/maggma/builders/group_builder.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/getting_started/group_builder.md b/docs/getting_started/group_builder.md index b088085d0..875201906 100644 --- a/docs/getting_started/group_builder.md +++ b/docs/getting_started/group_builder.md @@ -60,6 +60,7 @@ Note that unlike the previous `MapBuilder` example, we didn't call the source an `GroupBuilder` inherits from `MapBuilder` so it has the same configurational parameters. +- query: A query to apply to items in the source Store. - projection: list of the fields you want to project. This can reduce the data transfer load if you only need certain fields or sub-documents from the source documents - timeout: optional timeout on the process function - store_process_timeout: adds the process time into the target document for profiling diff --git a/src/maggma/builders/group_builder.py b/src/maggma/builders/group_builder.py index 64993a1f3..2595a0e4b 100644 --- a/src/maggma/builders/group_builder.py +++ b/src/maggma/builders/group_builder.py @@ -42,7 +42,7 @@ def __init__( Args: source: source store target: target store - query: optional query to filter source store + query: optional query to filter items from the source store. projection: list of keys to project from the source for processing. Limits data transfer to improve efficiency. delete_orphans: Whether to delete documents on target store