Skip to content

fix(#227): clarify when a summary object appears in query results #369

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 16, 2017
Merged

fix(#227): clarify when a summary object appears in query results #369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5aad4a8
fix(#227): clarify when a summary object appears in query results
wooldridge Feb 14, 2017
b21b96b
Add to jsdocs about withOptions(), categories
wooldridge Mar 16, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/documents.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ function wipeOutputTransform(/*headers, data*/) {
/**
* Categories of information to read or write for documents.
* The possible values of the enumeration are
* content|collections|permissions|properties|quality|metadataValues|metadata where
* content|collections|metadataValues|permissions|properties|quality|metadata|none where
* metadata is an alias for all of the categories other than content.
* @typedef {enum} documents.categories
*/
Expand Down
8 changes: 6 additions & 2 deletions lib/query-builder.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4983,15 +4983,19 @@ function snippet() {
/**
* Sets the withOptions clause of a built query to configure the query;
* takes a configuration object with the following named parameters.
* This function may be called on the result of building a query.
* This function may be called on the result of building a query. When the
* 'debug', 'metrics', 'queryPlan', or 'similarDocs' parameter is set, a
* search summary object will be returned along with the result documents.
* When 'categories' is set to 'none', only a search summary is returned.
* @method
* @memberof queryBuilder#
* @param {documents.categories} [categories] - the categories of information
* to retrieve for the result documents
* @param {number} [concurrencyLevel] - the maximum number of threads to use to calculate facets
* @param {...string} [forestNames] - the names of forests providing documents
* for the result set
* @param {...string} [search] - options modifying the default behaviour of the query
* @param {...string} [search] - <a href="https://docs.marklogic.com/guide/search-dev/appendixa#id_77801">options</a>
* modifying the default behaviour of the query
* @param {string|transactions.Transaction} [txid] - a string
* transaction id or Transaction object identifying an open
* multi-statement transaction
Expand Down