nodejs-documents-query-sort.js

/*
* Copyright (c) 2015-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
*/
var should = require('should');

var testconfig = require('../etc/test-config-qa.js');

var marklogic = require('../');
var q = marklogic.queryBuilder;

var db = marklogic.createDatabaseClient(testconfig.restReaderConnection);
var dbWriter = marklogic.createDatabaseClient(testconfig.restWriterConnection);
var dbAdmin = marklogic.createDatabaseClient(testconfig.restAdminConnection);

describe('document query sort test', function () {
    before(function (done) {
        this.timeout(10000);
        // NOTE: must create a string range index on rangeKey1 and rangeKey2
        dbWriter.documents.write({
            uri: '/test/query/sort/doc1.json',
            collections: ['matchCollection1'],
            contentType: 'application/json',
            content: {
                title: 'Vannevar Bush',
                popularity: 5,
                id: '0011',
                date: '2005-01-01',
                price: {
                    amt: 0.1
                },
                p: 'Vannevar Bush wrote an article for The Atlantic Monthly'
            }
        }, {
            uri: '/test/query/sort/doc2.json',
            collections: ['matchCollection1', 'matchCollection2'],
            contentType: 'application/json',
            content: {
                title: 'The Bush article',
                popularity: 4,
                id: '0012',
                date: '2006-02-02',
                price: {
                    amt: 0.12
                },
                p: 'The Bush article described a device called a Memex'
            }
        }, {
            uri: '/test/query/sort/doc3.json',
            collections: ['matchCollection2'],
            contentType: 'application/json',
            content: {
                title: 'For 1945',
                popularity: 3,
                id: '0013',
                date: '2007-03-03',
                price: {
                    amt: 1.23
                },
                p: 'For 1945, the thoughts expressed in the Atlantic Monthly were groundbreaking'
            }
        }, {
            uri: '/test/query/sort/doc4.json',
            collections: [],
            contentType: 'application/json',
            content: {
                title: 'Vannevar served',
                popularity: 5,
                id: '0024',
                date: '2008-04-04',
                price: {
                    amt: 12.34
                },
                p: 'Vannevar served as a prominent policymaker and public intellectual'
            }
        }, {
            uri: '/test/query/sort/doc5.json',
            collections: ['matchList'],
            contentType: 'application/json',
            content: {
                title: 'The memex',
                popularity: 5,
                id: '0026',
                date: '2009-05-05',
                price: {
                    amt: 123.45
                },
                p: 'The Memex, unfortunately, had no automated search feature'
            }
        }).
            result(function (response) {
                done();
            }, done);
    });

    it('should do document query with descending order', function (done) {
        db.documents.query(
            q.where(
                q.directory('/test/query/sort/')
            ).
                orderBy(q.sort('popularity', 'descending'))
        ).result(function (response) {
            var document = response[0];
            response.length.should.equal(5);
            //console.log(JSON.stringify(response, null, 4));
            document.content.popularity.should.equal(5);
            done();
        }, done);
    });

    it('should do document query with ascending order', function (done) {
        db.documents.query(
            q.where(
                q.directory('/test/query/sort/')
            ).
                orderBy(q.sort('popularity', 'ascending'))
        ).result(function (response) {
            var document = response[0];
            response.length.should.equal(5);
            //console.log(JSON.stringify(response, null, 4));
            document.content.popularity.should.equal(3);
            done();
        }, done);
    });

    it('should remove all documents', function (done) {
        dbAdmin.documents.removeAll({ all: true }).
            result(function (response) {
                response.should.be.ok;
                done();
            }, done);
    });

});