Skip to content

Update docs for valuesBuilder.BuiltQuery#slice #404

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 1 commit into from
Jun 5, 2017
Merged

Update docs for valuesBuilder.BuiltQuery#slice #404

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 14 additions & 6 deletions lib/values-builder.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,19 +307,27 @@ function udf() {

/**
* Sets the slice clause of a built query to select the slice
* of the result set based on the first tuple and the number
* of tuples (aka rows).
* of the result set based on the start tuple within the result set
* and the number of tuples (aka rows) in the slice.
* This function must be called on the builtQuery returned
* by the {@link valuesBuilder#valuesFromIndexes} function
* or another function specifying a values query clause.
* By default, the slice uses array slice mode, but you can switch
* to legacy slice mode with {@link marklogic.setSliceMode}. Legacy
* slice mode is deprecated and will be removed in the next major release.
* @method valuesBuilder.BuiltQuery#slice
* @since 1.0
* @param {number} start - the one-based position within the
* result set of the first tuple.
* @param {number} length - the number of tuples in the slice.
* @param {number} start - in array slice mode, the zero-based position
* within the result set of the first tuple; in legacy slice mode, the
* one-based position within the result set of the first tuple or 0 to
* suppress the tuples and return only the summary
* @param {number} length - in array slice mode, the zero-based position
* of the tuple after the last document in the slice or 0 to suppress
* the documents and return only the summary; in legacy slice mode, the
* number of tuples in the slice
* @param {transform} [transform] - a transform to apply to the
* slice on the server as specified by the {@link valuesBuilder#transform}
* function.
* function
* @returns {valuesBuilder.BuiltQuery} a built query
*/
ValueBuilder.prototype.slice = function valuesSlice() {
Expand Down