Add documentation for ppl #15401
Add documentation for ppl #15401
Conversation
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. |
wu-hui
force-pushed
the
wuandy/RealPpl_11
branch
from
972da3c to
a3e4b27
Compare
cherylEnkidu
changed the base branch from
wuandy/RealPpl_11
to
feat/pipeline/private-preview
| /// } | ||
| /// ``` | ||
| /// | ||
| /// - Returns: A `PipelineSource` that can be used to build and execute a pipeline. |
There was a problem hiding this comment.
FWIW, I have updated Android's comment to this:
/**
- Creates a new {@link PipelineSource} to build and execute a data pipeline.
-
A pipeline is composed of a sequence of stages. Each stage processes the
- output from the previous one, and the final stage's output is the result of the
- pipeline's execution.
-
Example usage:
-
{@code - Pipeline pipeline = firestore.pipeline()
- .collection("books")
- .where(Field("rating").isGreaterThan(4.5))
- .sort(Field("rating").descending())
- .limit(2);
- }
-
Note on Execution: The stages are conceptual. The Firestore backend may
- optimize execution (e.g., reordering or merging stages) as long as the
- final result remains the same.
-
Important Limitations:
-
- Pipelines operate on a request/response basis only.
- They do not utilize or update the local SDK cache.
- They do not support realtime snapshot listeners.
- @return A {@code PipelineSource} to begin defining the pipeline's stages.
*/
| /// | ||
| /// - Parameter others: An array of at least one `Expression` value to check against. | ||
| /// - Returns: A new `BooleanExpr` representing the "NOT IN" comparison (not_eq_any). | ||
| /// - Returns: A `BooleanExpression` that can be used in `where` clauses. |
There was a problem hiding this comment.
can be used in a where stage, among others.
?
| /// the field to set or update. | ||
| /// - Parameter value: The `Expression` representing the value to set for the field. | ||
| /// - Returns: A new `FunctionExpression` representing the map with the updated field. | ||
| func mapSet(key: Expression, value: Sendable) -> FunctionExpression |
| /// - Returns: A new "FunctionExpression" representing the bitwise AND operation. | ||
| func bitAnd(_ bitsExpression: Expression) -> FunctionExpression { | ||
| return FunctionExpression("bit_and", [self, bitsExpression]) | ||
| return FunctionExpression(functionName: "bit_and", args: [self, bitsExpression]) |
There was a problem hiding this comment.
bit* operations are not in scope.
There was a problem hiding this comment.
You can also delete the tests.
| /// - Returns: A new `FunctionExpression` representing the Manhattan distance. | ||
| func manhattanDistance(_ expression: Expression) -> FunctionExpression { | ||
| return FunctionExpression("manhattan_distance", [self, expression]) | ||
| return FunctionExpression(functionName: "manhattan_distance", args: [self, expression]) |
3 participants
#no-changelog