nodejs-documents-values.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 t = marklogic.valuesBuilder;

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

describe('Document tuples test', function () {
    before(function (done) {
        this.timeout(10000);
        dbWriter.documents.write({
            uri: '/test/query/matchDir/doc1.json',
            collections: ['matchCollection1'],
            contentType: 'application/json',
            content: {
                title: 'Vannevar Bush',
                popularity: 5,
                id: '0011',
                date: '2005-01-01',
                price: {
                    amt: 0.1
                },
                values: [{ score: 56.7 }, { rate: 3 }],
                p: 'Vannevar Bush wrote an article for The Atlantic Monthly'
            }
        }, {
            uri: '/test/query/matchDir/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
                },
                values: [{ score: 92.45 }, { rate: 5 }],
                p: 'The Bush article described a device called a Memex'
            }
        }, {
            uri: '/test/query/matchDir/doc3.json',
            collections: ['matchCollection2'],
            contentType: 'application/json',
            content: {
                title: 'For 1945',
                popularity: 3,
                id: '0013',
                date: '2007-03-03',
                price: {
                    amt: 1.23
                },
                values: [{ score: 33.56 }, { rate: 1 }],
                p: 'For 1945, the thoughts expressed in the Atlantic Monthly were groundbreaking'
            }
        }, {
            uri: '/test/query/matchDir/doc4.json',
            collections: [],
            contentType: 'application/json',
            content: {
                title: 'Vannevar served',
                popularity: 5,
                id: '0024',
                date: '2008-04-04',
                price: {
                    amt: 12.34
                },
                values: [{ score: 12.34 }, { rate: 3 }],
                p: 'Vannevar served as a prominent policymaker and public intellectual'
            }
        }, {
            uri: '/test/query/matchList/doc5.json',
            collections: ['matchList'],
            contentType: 'application/json',
            content: {
                title: 'The memex',
                popularity: 5,
                id: '0026',
                date: '2009-05-05',
                price: {
                    amt: 123.45
                },
                values: [{ score: 77.678 }, { rate: 2 }],
                p: 'The Memex, unfortunately, had no automated search feature'
            }
        }, {
            uri: '/test/query/matchList/doc6.xml',
            collections: ['matchList'],
            contentType: 'application/xml',
            content: '<Employee><name>John</name></Employee>'
        }, {
            uri: '/test/query/matchList/doc7.xml',
            collections: ['matchList'],
            contentType: 'application/xml',
            content: '<Employee xmlns="http://aaa.com" ><firstname>John</firstname><id>0081</id></Employee>'
        }).
            result(function (response) {
                done();
            }, done);
    });
    /*it('should do values on pathindex Bug35160', function(done){
    this.timeout(10000);
    db.values.read(
      t.fromIndexes(
		t.range(t.pathIndex("/hi:Employee/hi:firstname",{hi:"http://aaa.com"}))
        )
      ).result(function(response) {
		//console.log(JSON.stringify(response, null, 4));
        var strData = JSON.stringify(response);
         strData.should.containEql('"frequency":1,"distinct-value":["John"]');
         // strData.should.containEql('"frequency":1,"distinct-value":["92.45"]');
       done();
       }, done);
      });*/
    it('should do values on score', function (done) {
        this.timeout(10000);
        db.values.read(
            t.fromIndexes(
                t.range('score', 'xs:double')
            ).
                where(
                    t.word('title', 'bush')
                )
        ).result(function (response) {
        //console.log(JSON.stringify(response, null, 4));
            var strData = JSON.stringify(response);
            strData.should.containEql('"frequency":1,"distinct-value":["56.7"]');
            strData.should.containEql('"frequency":1,"distinct-value":["92.45"]');
            done();
        }, done);
    });

    it('should do values on simple parse', function (done) {
        this.timeout(10000);
        db.values.read(
            t.fromIndexes(
                t.range('score', 'xs:double')
            ).
                where(
                    q.parsedFrom('intitle:"The memex"',
                        q.parseBindings(
                            q.value('title', q.bind('intitle'))
                        )
                    )
                )
        ).result(function (response) {
            //console.log(JSON.stringify(response, null, 2));
            response['values-response'].tuple.length.should.equal(1);
            done();
        }, done);
    });

    it('should do values on complex parse', function (done) {
        this.timeout(10000);
        db.values.read(
            t.fromIndexes(
                t.range('score', 'xs:double')
            ).
                where(
                    q.parsedFrom('"Vannevar" AND theId:0024 OR (pop LT 4)',
                        q.parseBindings(
                            q.word('title', q.bindDefault()),
                            q.value('id', q.bind('theId')),
                            q.range('popularity', q.datatype('int'), q.bind('pop'))
                        )
                    )
                )
        ).result(function (response) {
            //console.log(JSON.stringify(response, null, 2));
            response['values-response'].tuple.length.should.equal(2);
            done();
        }, done);
    });

    it('should do values aggregate on parse', function (done) {
        this.timeout(10000);
        db.values.read(
            t.fromIndexes(
                t.range('score', 'xs:double')
            ).
                where(
                    q.parsedFrom('intitle:bush',
                        q.parseBindings(
                            q.word('title', q.bind('intitle'))
                        )
                    )
                ).
                aggregates('sum')
        ).result(function (response) {
            //console.log(JSON.stringify(response, null, 2));
            var strData = JSON.stringify(response);
            strData.should.containEql('"aggregate-result":[{"name":"sum","_value":"149.15"}]');
            done();
        }, done);
    });

    it('should do values on path', function (done) {
        this.timeout(10000);
        db.values.read(
            t.fromIndexes(t.pathIndex('price/amt'))
        ).result(function (values) {
	  //console.log(JSON.stringify(values, null, 2));
	  values.should.have.property('values-response');
            values['values-response'].should.have.property('tuple');
            values['values-response'].tuple.length.should.equal(5);
            values['values-response'].tuple[0].should.have.property('frequency');
            values['values-response'].tuple[0].should.have.property('distinct-value');
	  values['values-response'].tuple[0].frequency.should.equal(1);
            done();
   	}, function (error) {
	  console.log(JSON.stringify(error, null, 2));
            done();
        }, done);
    });

    /*
//Issue with Index settings working on it
//Need to create a filed name : filed_for_valueread and a range index in it on title type string
   it('should do values on field', function(done){
    this.timeout(10000);
   db.values.read(
	t.fromIndexes(
		t.field('filed_for_valueread')
		).
		where(
			t.word('title', 'bush'))
        ).result(function (result) {
	//console.log(JSON.stringify(result, null, 2));
	result.should.have.property('values-response');
	done();
	}, function(error) {
	console.log(JSON.stringify(error, null, 2));
     done();
    }, done);
  }); */

    it('should do sum aggregates', function (done) {
        this.timeout(10000);
        db.values.read(
            t.fromIndexes(
                t.range('score', 'xs:double')
            ).
                where(
                    t.word('title', 'bush')
                ).
                aggregates('sum')
        ).result(function (response) {
        //console.log(JSON.stringify(response, null, 4));
            var strData = JSON.stringify(response);
            strData.should.containEql('"aggregate-result":[{"name":"sum","_value":"149.15"}]');
            done();
        }, done);
    });

    it('should do correlation and covariance aggregates', function (done) {
        this.timeout(10000);
        db.values.read(
            t.fromIndexes(
                t.range('rate', 'xs:int'),
                t.range(t.property('popularity'), t.datatype('int'))
            ).
                where(
                    t.word('id', '00*', q.termOptions('wildcarded'))
                ).
                aggregates('correlation', 'covariance')
        ).result(function (response) {
        //console.log(JSON.stringify(response, null, 4));
            var strData = JSON.stringify(response);
            //console.log(strData);
            strData.should.containEql('"name":"correlation","_value":"0.263822426505543"');
            strData.should.containEql(('"name":"covariance","_value":"0.35"') || ('"name":"covariance","_value":"0.349999999999998"'));
            done();
        }).catch(error=> done(error));
    });

    it('should do max, min, sum, average aggregates', function (done) {
        this.timeout(10000);
        db.values.read(
            t.fromIndexes(
                t.range(t.property('popularity'), t.datatype('int'))
            ).
                where(
                    t.word('id', '00*', q.termOptions('wildcarded'))
                ).
                aggregates('max', 'min', 'sum', 'avg')
        ).result(function (response) {
        //console.log(JSON.stringify(response, null, 4));
            var strData = JSON.stringify(response);
            strData.should.containEql('"aggregate-result":[{"name":"max","_value":"5"},{"name":"min","_value":"3"},{"name":"sum","_value":"22"},{"name":"avg","_value":"4.4"}]');
            done();
        }, done);
    });

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

});