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

small change #2939

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

small change #2939

wants to merge 2 commits into from

Conversation

MartaBerman
Copy link
Contributor

@MartaBerman MartaBerman commented Apr 21, 2024

I lied - it wasn't a small change -
Gave the standard query builder way more prominence. Put it first.
This was from a doc bug day a while ago, somehow left it hanging.

Copy link
Contributor

@imnotashrimp imnotashrimp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some minor suggestions

2 types of query techniques are available in Velo. See your specific API to check which technique the query function supports.

* **With query builders**: Call query functions that build a query to retrieve a list of items. You can recognize these query functions because they have associated `<item>QueryBuilder` and `<item>QueryResult` class objects. This is the standard Velo querying technique.
Check the Velo Reference to see which technique is supported for querying a specific API.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Check the Velo Reference to see which technique is supported for querying a specific API.
Check a specific query function the Velo Reference to see which querying technique is supported.

+ Processes the query specified with the [`PlansQueryBuilder`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/plansquerybuilder/ascending) operators.
+ Presents the results using the [`PlansQueryResult`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/plansqueryresult/currentpage) specifications.

Alternatively, you can call the more generic yet robust Wix Data API to query any collection. The Wix Data API offers additional query functionality like aggregation and querying referenced items. Call the [`query()`](https://www.wix.com/velo/reference/wix-data/query) function with:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Alternatively, you can call the more generic yet robust Wix Data API to query any collection. The Wix Data API offers additional query functionality like aggregation and querying referenced items. Call the [`query()`](https://www.wix.com/velo/reference/wix-data/query) function with:
Alternatively, you can call the more generic yet robust Wix Data API to query any collection in your site's CMS. The Wix Data API offers additional query functionality like aggregation and querying referenced items. Call the [`query()`](https://www.wix.com/velo/reference/wix-data/query) function with:


## With the API Query Language

For querying without query builders, pass an object defining the query to the query function. Define the object with the API Query Language.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For querying without query builders, pass an object defining the query to the query function. Define the object with the API Query Language.
For querying without query builders, pass an object defining the query to the query function. Define the object with the API Query Language, shown in [The filter object](#the-filter-object) below.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants