Skip to content

Commit b5ba9e0

Browse files
committed
Update docs for valuesBuilder.BuiltQuery#slice
Now uses array slice mode by default, same as queryBuilder. Fixes #400
1 parent 812ee98 commit b5ba9e0

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

lib/values-builder.js

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -307,19 +307,27 @@ function udf() {
307307

308308
/**
309309
* Sets the slice clause of a built query to select the slice
310-
* of the result set based on the first tuple and the number
311-
* of tuples (aka rows).
310+
* of the result set based on the start tuple within the result set
311+
* and the number of tuples (aka rows) in the slice.
312312
* This function must be called on the builtQuery returned
313313
* by the {@link valuesBuilder#valuesFromIndexes} function
314314
* or another function specifying a values query clause.
315+
* By default, the slice uses array slice mode, but you can switch
316+
* to legacy slice mode with {@link marklogic.setSliceMode}. Legacy
317+
* slice mode is deprecated and will be removed in the next major release.
315318
* @method valuesBuilder.BuiltQuery#slice
316319
* @since 1.0
317-
* @param {number} start - the one-based position within the
318-
* result set of the first tuple.
319-
* @param {number} length - the number of tuples in the slice.
320+
* @param {number} start - in array slice mode, the zero-based position
321+
* within the result set of the first tuple; in legacy slice mode, the
322+
* one-based position within the result set of the first tuple or 0 to
323+
* suppress the tuples and return only the summary
324+
* @param {number} length - in array slice mode, the zero-based position
325+
* of the tuple after the last document in the slice or 0 to suppress
326+
* the documents and return only the summary; in legacy slice mode, the
327+
* number of tuples in the slice
320328
* @param {transform} [transform] - a transform to apply to the
321329
* slice on the server as specified by the {@link valuesBuilder#transform}
322-
* function.
330+
* function
323331
* @returns {valuesBuilder.BuiltQuery} a built query
324332
*/
325333
ValueBuilder.prototype.slice = function valuesSlice() {

0 commit comments

Comments
 (0)