Skip to content

Commit 7fc43d9

Browse files
committed
added beta labels to search/dml
1 parent 3f996b1 commit 7fc43d9

4 files changed

Lines changed: 37 additions & 4 deletions

File tree

packages/google-cloud-firestore/google/cloud/firestore_v1/base_pipeline.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -402,6 +402,9 @@ def search(
402402
"""
403403
Adds a search stage to the pipeline.
404404
405+
.. note::
406+
This feature is currently in beta and is subject to change.
407+
405408
This stage filters documents based on the provided query expression.
406409
407410
Example:
@@ -712,6 +715,9 @@ def delete(self) -> "_BasePipeline":
712715
"""
713716
Deletes the documents from the current pipeline stage.
714717
718+
.. note::
719+
This feature is currently in beta and is subject to change.
720+
715721
Example:
716722
>>> from google.cloud.firestore_v1.pipeline_expressions import Field
717723
>>> pipeline = client.pipeline().collection("logs")
@@ -728,6 +734,9 @@ def update(self, *transformed_fields: "Selectable") -> "_BasePipeline":
728734
"""
729735
Performs an update operation using documents from previous stages.
730736
737+
.. note::
738+
This feature is currently in beta and is subject to change.
739+
731740
If called without `transformed_fields`, this method updates the documents in
732741
place based on the data flowing through the pipeline.
733742

packages/google-cloud-firestore/google/cloud/firestore_v1/pipeline_expressions.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -629,6 +629,8 @@ def geo_distance(
629629
"""Evaluates to the distance in meters between the location in the specified
630630
field and the query location.
631631
632+
.. note::
633+
This feature is currently in beta and is subject to change.
632634
Note: This Expression can only be used within a `Search` stage.
633635
634636
Example:
@@ -2840,6 +2842,9 @@ class Score(FunctionExpression):
28402842
in the search query. If `SearchOptions.query` is not set or does not contain
28412843
any text predicates, then this topicality score will always be `0`.
28422844
2845+
.. note::
2846+
This feature is currently in beta and is subject to change.
2847+
28432848
Note: This Expression can only be used within a `Search` stage.
28442849
28452850
Example:
@@ -2861,6 +2866,9 @@ def __init__(self):
28612866
class DocumentMatches(BooleanExpression):
28622867
"""Creates a boolean expression for a document match query.
28632868
2869+
.. note::
2870+
This feature is currently in beta and is subject to change.
2871+
28642872
Note: This Expression can only be used within a `Search` stage.
28652873
28662874
Example:

packages/google-cloud-firestore/google/cloud/firestore_v1/pipeline_stages.py

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,11 @@ def _pb_args(self):
343343

344344

345345
class Search(Stage):
346-
"""Search stage."""
346+
"""Search stage.
347+
348+
.. note::
349+
This feature is currently in beta and is subject to change.
350+
"""
347351

348352
def __init__(self, query_or_options: str | BooleanExpression | SearchOptions):
349353
super().__init__("search")
@@ -434,7 +438,11 @@ def _pb_args(self):
434438

435439

436440
class Delete(Stage):
437-
"""Deletes documents matching the pipeline criteria."""
441+
"""Deletes documents matching the pipeline criteria.
442+
443+
.. note::
444+
This feature is currently in beta and is subject to change.
445+
"""
438446

439447
def __init__(self):
440448
super().__init__("delete")
@@ -444,7 +452,11 @@ def _pb_args(self) -> list[Value]:
444452

445453

446454
class Update(Stage):
447-
"""Updates documents with transformed fields."""
455+
"""Updates documents with transformed fields.
456+
457+
.. note::
458+
This feature is currently in beta and is subject to change.
459+
"""
448460

449461
def __init__(self, *transformed_fields: Selectable):
450462
super().__init__("update")

packages/google-cloud-firestore/google/cloud/firestore_v1/pipeline_types.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,11 @@ def percentage(value: float):
228228

229229

230230
class SearchOptions:
231-
"""Options for configuring the `Search` pipeline stage."""
231+
"""Options for configuring the `Search` pipeline stage.
232+
233+
.. note::
234+
This feature is currently in beta and is subject to change.
235+
"""
232236

233237
def __init__(
234238
self,

0 commit comments

Comments
 (0)