Code samples for MarkLogic REST API

ex01.sh

curl -X GET \
  --anyauth --user rest-writer:x \
  'http://localhost:8011/v1/search?q=chicken&format=json'

ex02.sh

curl -v -X PUT \
  --digest --user rest-writer:x \
  -d'{"recipe":"Apple pie", "fromScratch":true, "ingredients":"The Universe"}' \
  -H "Content-type: application/json" \
  'http://localhost:8011/v1/documents?uri=/example/recipe.json'

ex03.sh

curl -v -X PUT \
  --digest --user rest-writer:x \
  -d'{"recipe":"Apple pie", "fromScratch":true, "ingredients":"The Universe"}' \
  'http://localhost:8011/v1/documents?uri=/example/recipe.json&format=json'

ex04.sh

curl -v -X PUT \
  --digest --user rest-writer:x \
  -d'<person><first>Carl</first><last>Sagan</last></person>' \
  'http://localhost:8011/v1/documents?uri=/example/person.xml'

ex05.sh

curl -v -X PUT \
  --digest --user rest-writer:x \
  -d'<person><first>Carl</first><last>Sagan</last></person>' \
  -H "Content-type: application/xml" \
  'http://localhost:8011/v1/documents?uri=/example/person.xml'

ex06.sh

curl -v -X PUT \
  --digest --user rest-writer:x \
  -d'This is a text file.' \
  -H "Content-type: text/plain" \
  'http://localhost:8011/v1/documents?uri=/foo.txt&collection=examples&collection=mine'

ex07.sh

curl http://developer.marklogic.com/media/learn/rest/mlfavicon.png >mlfavicon.png
curl -v -X PUT \
  --digest --user rest-writer:x \
  --data-binary '@mlfavicon.png' \
  -H "Content-type: image/png" \
  'http://localhost:8011/v1/documents?uri=/example/mlfavicon.png&extract=properties'

ex08.sh

curl -v -X DELETE \
  --digest --user rest-writer:x \
  'http://localhost:8011/v1/documents?uri=/foo.txt'

ex09.sh

curl -v -X POST \
  --digest --user rest-writer:x \
  -d'{"query":{"properties-query":{"term-query":{"text":"fish"}}}}' \
  -H "Content-type: application/json" \
  'http://localhost:8011/v1/search?format=json'

ex10.sh

curl -v -X POST \
  --digest --user rest-writer:x \
  -d'<query xmlns="http://marklogic.com/appservices/search"><properties-query><term-query><text>fish</text></term-query></properties-query></query>' \
  -H "Content-type: application/xml" \
  'http://localhost:8011/v1/search'

ex10.txt

"total":95,"start":1,"page-length":10

ex11.json

"results": [
  {
    "index": 1,
    "uri": "/guide/search-dev.xml",
    "path": "fn:doc(\"/guide/search-dev.xml\")",
    "score": 92032,
    "confidence": 0.672178,
    "fitness": 0.877356,
    "matches": [
      {
        "path": "fn:doc(\"/guide/search-dev.xml\")/*:guide/*:para[5]",
        "match-text": [
          "Lexicon and ",
          {
            "highlight": "Range Index"
          },
          "-Based APIs..."
      },
      {
        "path": "fn:doc(\"/guide/search-dev.xml\")/*:guide/*:para[20]",
        "match-text": [
          "no matter what the database size. As part of loading a document, full-text ",
          {
            "highlight": "indexes"
          },
          "are created making arbitrary searches fast. Searches automatically use the"
      }
    ]
  }
]

ex11.sh

"results": [
  {
    "index": 1,
    "uri": "/guide/search-dev.xml",
    "path": "fn:doc(\"/guide/search-dev.xml\")",
    "score": 92032,
    "confidence": 0.672178,
    "fitness": 0.877356,
    "matches": [
      {
        "path": "fn:doc(\"/guide/search-dev.xml\")/*:guide/*:para[5]",
        "match-text": [
          "Lexicon and ",
          {
            "highlight": "Range Index"
          },
          "-Based APIs..."
      },
      {
        "path": "fn:doc(\"/guide/search-dev.xml\")/*:guide/*:para[20]",
        "match-text": [
          "no matter what the database size. As part of loading a document, full-text ",
          {
            "highlight": "indexes"
          },
          "are created making arbitrary searches fast. Searches automatically use the"
      }
    ]
  }
]

ex11.txt

"total":95,"start":1,"page-length":10

ex12.json

"results": [
  {
    "index": 1,
    "uri": "/guide/search-dev.xml",
    "path": "fn:doc(\"/guide/search-dev.xml\")",
    "score": 92032,
    "confidence": 0.672178,
    "fitness": 0.877356,
    "matches": [
      {
        "path": "fn:doc(\"/guide/search-dev.xml\")/*:guide/*:para[5]",
        "match-text": [
          "Lexicon and ",
          {
            "highlight": "Range Index"
          },
          "-Based APIs..."
      },
      {
        "path": "fn:doc(\"/guide/search-dev.xml\")/*:guide/*:para[20]",
        "match-text": [
          "no matter what the database size. As part of loading a document, full-text ",
          {
            "highlight": "indexes"
          },
          "are created making arbitrary searches fast. Searches automatically use the"
      }
    ]
  }
]

ex12.sh

[{"name":"default","uri":"/v1/config/query/default"}]

ex12.xml

<!--...-->
<result index="1"
        uri="/guide/search-dev.xml"
        path="fn:doc(&quot;/guide/search-dev.xml&quot;)"
        score="92032"
        confidence="0.672178"
        fitness="0.877356">
  <snippet>
    <match path="fn:doc(&quot;/guide/search-dev.xml&quot;)/*:guide/*:para[5]"
      >Lexicon and <highlight>Range Index</highlight>-Based APIs...</match>
    <match path="fn:doc(&quot;/guide/search-dev.xml&quot;)/*:guide/*:para[20]"
      >no matter what the database size. As part of loading a document,
       full-text <highlight>indexes</highlight> are created making
       arbitrary searches fast. Searches automatically use the</match>
  </snippet>
</result>
<!--...-->

ex13.sh

curl -v -X PUT \
  --digest --user rest-admin:x \
  -d'{options:{constraint:[{name:"tag",collection:{prefix:""}}]}}' \
  -H "Content-type: application/json" \
  'http://localhost:8011/v1/config/query/tutorial'

ex13.xml

<!--...-->
<result index="1"
        uri="/guide/search-dev.xml"
        path="fn:doc(&quot;/guide/search-dev.xml&quot;)"
        score="92032"
        confidence="0.672178"
        fitness="0.877356">
  <snippet>
    <match path="fn:doc(&quot;/guide/search-dev.xml&quot;)/*:guide/*:para[5]"
      >Lexicon and <highlight>Range Index</highlight>-Based APIs...</match>
    <match path="fn:doc(&quot;/guide/search-dev.xml&quot;)/*:guide/*:para[20]"
      >no matter what the database size. As part of loading a document,
       full-text <highlight>indexes</highlight> are created making
       arbitrary searches fast. Searches automatically use the</match>
  </snippet>
</result>
<!--...-->

ex14.json

[{"name":"default","uri":"/v1/config/query/default"}]

ex14.sh

<options xmlns="http://marklogic.com/appservices/search">
  <constraint name="tag">
    <collection prefix=""/>
  </constraint>
</options>

ex14.xml

<rapi:query-options xmlns:rapi="http://marklogic.com/rest-api">
  <rapi:options>
    <rapi:name>default</rapi:name>
    <rapi:uri>/v1/config/query/default</rapi:uri>
  </rapi:options>
</rapi:query-options>

ex15.json

[{"name":"default","uri":"/v1/config/query/default"}]

ex15.sh

curl -v -X PUT \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"constraint":[{"name":"tag","collection":{"prefix":""}}]}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex16.json

{
    "options": {
        "constraint": [
            {
                "collection": {
                    "prefix": ""
                },
                "name": "tag"
            }
        ]
    }
}

ex16.sh

curl -v -X PUT \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"constraint":[{"name":"tag","collection":{"prefix":""}}]}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex17.json

{
    "options": {
        "constraint": [
            {
                "collection": {
                    "prefix": ""
                },
                "name": "tag"
            }
        ]
    }
}

ex17.sh

// create a search definition using the "tutorial" options
StringQueryDefinition query = queryMgr.newStringDefinition("tutorial");

ex17.xml

<options xmlns="http://marklogic.com/appservices/search">
  <constraint name="tag">
    <collection prefix=""/>
  </constraint>
</options>

ex18.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"constraint":[{"name":"company","value":{"json-key":"affiliation"}}]}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex18.xml

<options xmlns="http://marklogic.com/appservices/search">
  <constraint name="tag">
    <collection prefix=""/>
  </constraint>
</options>

ex19.json

{
    "options": {
        "constraint": [
            {
                "name": "company",
                "value": {
                    "json-key": "affiliation"
                }
            }
        ]
    }
}

ex19.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"constraint":[{"name":"company","value":{"json-property":"affiliation"}}]}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex20.json

{
    "options": {
        "constraint": [
            {
                "name": "company",
                "value": {
                    "json-property": "affiliation"
                }
            }
        ]
    }
}

ex20.sh

// find plays featuring the King of France
query.setCriteria("person:\"KING OF FRANCE\"");

ex20.xml

<options xmlns="http://marklogic.com/appservices/search">
  <constraint name="company">
    <value>
      <json-key>affiliation</json-key>
    </value>
  </constraint>
</options>

ex21.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"constraint":[{"name":"person","value":{"element":{"name":"SPEAKER","ns":""}}}]}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex21.xml

<options xmlns="http://marklogic.com/appservices/search">
  <constraint name="company">
    <value>
      <json-property>affiliation</json-property>
    </value>
  </constraint>
</options>

ex22.json

{
    "options": {
        "constraint": [
            {
                "name": "person",
                "value": {
                    "element": {
                        "name": "SPEAKER",
                        "ns": ""
                    }
                }
            }
        ]
    }
}

ex22.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"constraint":[{"name":"person","value":{"element":{"name":"PERSONA","ns":""}}}]}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex23.json

{
    "options": {
        "constraint": [
            {
                "name": "person",
                "value": {
                    "element": {
                        "name": "PERSONA",
                        "ns": ""
                    }
                }
            }
        ]
    }
}

ex23.sh

    tutorialOpts.addConstraint(
        qob.constraint("stagedir",
            qob.word(
                qob.elementTermIndex(new QName("STAGEDIR")))));

ex23.xml

<options xmlns="http://marklogic.com/appservices/search">
  <constraint name="person">
    <value>
      <element ns="" name="PERSONA"/>
    </value>
  </constraint>
</options>

ex24.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"constraint":[{"name":"bio","word":{"json-key":"bio"}}]}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex24.xml

<options xmlns="http://marklogic.com/appservices/search">
  <constraint name="person">
    <value>
      <element ns="" name="PERSONA"/>
    </value>
  </constraint>
</options>

ex25.json

{
    "options": {
        "constraint": [
            {
                "name": "bio",
                "word": {
                    "json-key": "bio"
                }
            }
        ]
    }
}

ex25.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"constraint":[{"name":"bio","word":{"json-property":"bio"}}]}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex26.json

{
    "options": {
        "constraint": [
            {
                "name": "bio",
                "word": {
                    "json-property": "bio"
                }
            }
        ]
    }
}

ex26.sh

// search for mentions of swords in the script itself
query.setCriteria("spoken:sword");

ex26.xml

<options xmlns="http://marklogic.com/appservices/search">
  <constraint name="bio">
    <word>
      <json-key>bio</json-key>
    </word>
  </constraint>
</options>

ex27.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"constraint":[{"name":"stagedir","word":{"element":{"name":"STAGEDIR","ns":""}}}]}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex27.xml

<options xmlns="http://marklogic.com/appservices/search">
  <constraint name="bio">
    <word>
      <json-property>bio</json-property>
    </word>
  </constraint>
</options>

ex28.json

{
    "options": {
        "constraint": [
            {
                "name": "stagedir",
                "word": {
                    "element": {
                        "name": "STAGEDIR",
                        "ns": ""
                    }
                }
            }
        ]
    }
}

ex28.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"constraint":[{"name":"stagedir","word":{"element":{"name":"STAGEDIR","ns":""}}}]}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex29.json

{
    "options": {
        "constraint": [
            {
                "name": "stagedir",
                "word": {
                    "element": {
                        "name": "STAGEDIR",
                        "ns": ""
                    }
                }
            }
        ]
    }
}

ex29.sh

// create a query builder using the "tutorial" options
StructuredQueryBuilder qb = new StructuredQueryBuilder("tutorial");

ex29.xml

<options xmlns="http://marklogic.com/appservices/search">
  <constraint name="stagedir">
    <word>
      <element ns="" name="STAGEDIR"/>
    </word>
  </constraint>
</options>

ex30.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"constraint":[{"name":"spoken","element-query":{"name":"SPEECH","ns":""}}]}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex30.xml

<options xmlns="http://marklogic.com/appservices/search">
  <constraint name="stagedir">
    <word>
      <element ns="" name="STAGEDIR"/>
    </word>
  </constraint>
</options>

ex31.json

{
    "options": {
        "constraint": [
            {
                "element-query": {
                    "name": "SPEECH",
                    "ns": ""
                },
                "name": "spoken"
            }
        ]
    }
}

ex31.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"constraint":[{"name":"spoken","element-query":{"name":"SPEECH","ns":""}}]}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex32.json

{
    "options": {
        "constraint": [
            {
                "element-query": {
                    "name": "SPEECH",
                    "ns": ""
                },
                "name": "spoken"
            }
        ]
    }
}

ex32.sh

// create a builder for constructing query options
QueryOptionsBuilder qob = new QueryOptionsBuilder();
 
// expose the collection lexicon as "tag" values
QueryOptionsHandle options = new QueryOptionsHandle().withValues(
    qob.values("tag",
        qob.collection("")));

ex32.xml

<options xmlns="http://marklogic.com/appservices/search">
  <constraint name="spoken">
    <element-query ns="" name="SPEECH"/>
  </constraint>
</options>

ex33.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"constraint":[{"name":"image","properties":null}]}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex33.xml

<options xmlns="http://marklogic.com/appservices/search">
  <constraint name="spoken">
    <element-query ns="" name="SPEECH"/>
  </constraint>
</options>

ex34.json

{
    "options": {
        "constraint": [
            {
                "name": "image",
                "properties": null
            }
        ]
    }
}

ex34.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"constraint":[{"name":"image","properties":null}]}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex35.json

{
    "options": {
        "constraint": [
            {
                "name": "image",
                "properties": null
            }
        ]
    }
}

ex35.sh

// retrieve the values
ValuesHandle valuesHandle = queryMgr.values(valuesDef, new ValuesHandle());

ex35.xml

<options xmlns="http://marklogic.com/appservices/search">
  <constraint name="image">
    <properties/>
  </constraint>
</options>

ex36.json

{"query":
  {"or-query":
    {"queries":[
      {"and-query":
        {"queries":[
          {"word-constraint-query":
            {"constraint-name":"bio",
             "text":["product"]}},
          {"value-constraint-query":
            {"constraint-name":"company",
             "text":["MarkLogic"]}}]}},
      {"and-query":
        {"queries":[
          {"element-constraint-query":
            {"constraint-name":"spoken",
             "and-query":
              {"queries":[
                {"term-query":
                  {"text":["fie"]}}]}}},
          {"word-constraint-query":
            {"constraint-name":"stagedir",
             "text":["fall"]}},
          {"value-constraint-query":
            {"constraint-name":"person",
             "text":["GRUMIO"]}}]}},
      {"and-query":
        {"queries":[
          {"properties-query":
            {"term-query":
              {"text":["fish"]}}},
          {"infinite":true,
           "directory-query":
            {"uri":["/images/2012/02/27/"]}}]}},
      {"and-query":
        {"queries":[
          {"collection-query":
            {"uri":["mlw2012"]}},
          {"term-query":
            {"text":["fun"]}}]}}]}}}

ex36.sh

// print out the values and their frequencies
for (CountedDistinctValue value : valuesHandle.getValues()) {
    System.out.println(
        value.get("xs:string",String.class) + ": " + value.getCount());
}

ex36.xml

<options xmlns="http://marklogic.com/appservices/search">
  <constraint name="image">
    <properties/>
  </constraint>
</options>

ex37.json

{"query":
  {"or-query":
    {"queries":[
      {"and-query":
        {"queries":[
          {"word-constraint-query":
            {"constraint-name":"bio",
             "text":["product"]}},
          {"value-constraint-query":
            {"constraint-name":"company",
             "text":["MarkLogic"]}}]}},
      {"and-query":
        {"queries":[
          {"element-constraint-query":
            {"constraint-name":"spoken",
             "and-query":
              {"queries":[
                {"term-query":
                  {"text":["fie"]}}]}}},
          {"word-constraint-query":
            {"constraint-name":"stagedir",
             "text":["fall"]}},
          {"value-constraint-query":
            {"constraint-name":"person",
             "text":["GRUMIO"]}}]}},
      {"and-query":
        {"queries":[
          {"properties-query":
            {"term-query":
              {"text":["fish"]}}},
          {"infinite":true,
           "directory-query":
            {"uri":["/images/2012/02/27/"]}}]}},
      {"and-query":
        {"queries":[
          {"collection-query":
            {"uri":["mlw2012"]}},
          {"term-query":
            {"text":["fun"]}}]}}]}}}

ex37.sh

// expose the URI lexicon as "uri" values
QueryOptionsHandle options = new QueryOptionsHandle().withValues(
    qob.values("uri",
        qob.uri()));

ex37.xml

<query xmlns="http://marklogic.com/appservices/search">
  <or-query>
    <and-query>
      <word-constraint-query>
        <constraint-name>bio</constraint-name>
        <text>product</text>
      </word-constraint-query>
      <value-constraint-query>
        <constraint-name>company</constraint-name>
        <text>MarkLogic</text>
      </value-constraint-query>
    </and-query>
    <and-query>
      <element-constraint-query>
        <constraint-name>spoken</constraint-name>
        <term-query>
          <text>fie</text>
        </term-query>
      </element-constraint-query>
      <word-constraint-query>
        <constraint-name>stagedir</constraint-name>
        <text>fall</text>
      </word-constraint-query>
      <value-constraint-query>
        <constraint-name>person</constraint-name>
        <text>GRUMIO</text>
      </value-constraint-query>
    </and-query>
    <and-query>
      <properties-query>
        <term-query>
          <text>fish</text>
        </term-query>
      </properties-query>
      <directory-query>
        <uri>/images/2012/02/27/</uri>
        <infinite>true</infinite>
      </directory-query>
    </and-query>
    <and-query>
      <collection-query>
        <uri>mlw2012</uri>
      </collection-query>
      <term-query>
        <text>fun</text>
      </term-query>
    </and-query>
  </or-query>
</query>

ex38.sh

curl -v -X POST \
  --digest --user rest-writer:x \
  -H "Content-type: application/json" \  -d'{"query":{"or-query":{"queries":[{"and-query":{"queries":[ {"word-constraint-query":{"constraint-name":"bio","text":["product"]}}, {"value-constraint-query":{"constraint-name":"company","text":["MarkLogic"]}} ]}}, {"and-query":{"queries":[ {"element-constraint-query":{"constraint-name":"spoken","and-query": {"queries":[{"term-query":{"text":["fie"]}}]} }}, {"word-constraint-query":{"constraint-name":"stagedir","text":["fall"]}}, {"value-constraint-query":{"constraint-name":"person","text":["GRUMIO"]}} ]}}, {"and-query":{"queries":[ {"properties-query":{"term-query":{"text":["fish"]}}}, {"directory-query":{"uri":["/images/2012/02/27/"]},"infinite":true} ]}}, {"and-query":{"queries":[ {"collection-query":{"uri":["mlw2012"]}}, {"term-query":{"text":["fun"]}} ]}}]}}}' \
  'http://localhost:8011/v1/search?options=tutorial'

ex38.xml

<query xmlns="http://marklogic.com/appservices/search">
  <or-query>
    <and-query>
      <word-constraint-query>
        <constraint-name>bio</constraint-name>
        <text>product</text>
      </word-constraint-query>
      <value-constraint-query>
        <constraint-name>company</constraint-name>
        <text>MarkLogic</text>
      </value-constraint-query>
    </and-query>
    <and-query>
      <element-constraint-query>
        <constraint-name>spoken</constraint-name>
        <term-query>
          <text>fie</text>
        </term-query>
      </element-constraint-query>
      <word-constraint-query>
        <constraint-name>stagedir</constraint-name>
        <text>fall</text>
      </word-constraint-query>
      <value-constraint-query>
        <constraint-name>person</constraint-name>
        <text>GRUMIO</text>
      </value-constraint-query>
    </and-query>
    <and-query>
      <properties-query>
        <term-query>
          <text>fish</text>
        </term-query>
      </properties-query>
      <directory-query>
        <uri>/images/2012/02/27/</uri>
        <infinite>true</infinite>
      </directory-query>
    </and-query>
    <and-query>
      <collection-query>
        <uri>mlw2012</uri>
      </collection-query>
      <term-query>
        <text>fun</text>
      </term-query>
    </and-query>
  </or-query>
</query>

ex39.sh

curl -v -X POST \
  --digest --user rest-writer:x \
  -H "Content-type: application/json" \  -d'{"query":{"or-query":{"queries":[{"and-query":{"queries":[ {"word-constraint-query":{"constraint-name":"bio","text":["product"]}}, {"value-constraint-query":{"constraint-name":"company","text":["MarkLogic"]}} ]}}, {"and-query":{"queries":[ {"element-constraint-query":{"constraint-name":"spoken","and-query": {"queries":[{"term-query":{"text":["fie"]}}]} }}, {"word-constraint-query":{"constraint-name":"stagedir","text":["fall"]}}, {"value-constraint-query":{"constraint-name":"person","text":["GRUMIO"]}} ]}}, {"and-query":{"queries":[ {"properties-query":{"term-query":{"text":["fish"]}}}, {"directory-query":{"uri":["/images/2012/02/27/"]},"infinite":true} ]}}, {"and-query":{"queries":[ {"collection-query":{"uri":["mlw2012"]}}, {"term-query":{"text":["fun"]}} ]}}]}}}' \
  'http://localhost:8011/v1/search?options=tutorial'

ex40.json

{
    "options": {
        "values": {
            "collection": {
                "prefix": ""
            },
            "name": "tag"
        }
    }
}

ex40.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"values":{"name":"tag","collection":{"prefix":""}}}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex41.json

{
    "options": {
        "values": {
            "collection": {
                "prefix": ""
            },
            "name": "tag"
        }
    }
}

ex41.sh

// expose the "contentRating" JSON key range index as "rating" values
QueryOptionsHandle options = new QueryOptionsHandle().withValues(
    qob.values("rating",
        qob.range(
            qob.jsonRangeIndex("contentRating",
                qob.rangeType("xs:int")))));

ex41.xml

<options xmlns="http://marklogic.com/appservices/search">
  <values name="tag">
    <collection prefix=""/>
  </values>
</options>

ex42.sh

// create a values definition
ValuesDefinition valuesDef = queryMgr.newValuesDefinition("rating", optionsName);

ex42.xml

<options xmlns="http://marklogic.com/appservices/search">
  <values name="tag">
    <collection prefix=""/>
  </values>
</options>

ex43.json

{
  "values-response": {
    "metrics": {
      "aggregate-resolution-time": "PT0.000017S",
      "total-time": "PT0.001675S",
      "values-resolution-time": "PT0.000189S"
    },
    "distinct-value": [
      {
        "_value": "mlw2012",
        "frequency": 88
      },
      {
        "_value": "photos",
        "frequency": 140
      },
      {
        "_value": "shakespeare",
        "frequency": 22
      }
    ],
    "type": "xs:string",
    "name": "tag"
  }
}

ex43.sh

// also retrieve the averages of all ratings
valuesDef.setAggregate("avg","median");

ex43.xml

<values-response name="tag" type="xs:string" xmlns="http://marklogic.com/appservices/search">
  <distinct-value frequency="88">mlw2012</distinct-value>
   <distinct-value frequency="140">photos</distinct-value>
   <distinct-value frequency="22">shakespeare</distinct-value>
   <metrics>
     <values-resolution-time>PT0.000195S</values-resolution-time>
      <aggregate-resolution-time>PT0.000017S</aggregate-resolution-time>
      <total-time>PT0.001873S</total-time>
   </metrics>
 </values-response>

ex44.json

{
  "values-response": {
    "metrics": {
      "aggregate-resolution-time": "PT0.000017S",
      "total-time": "PT0.001675S",
      "values-resolution-time": "PT0.000189S"
    },
    "distinct-value": [
      {
        "_value": "mlw2012",
        "frequency": 88
      },
      {
        "_value": "photos",
        "frequency": 140
      },
      {
        "_value": "shakespeare",
        "frequency": 22
      }
    ],
    "type": "xs:string",
    "name": "tag"
  }
}

ex44.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"values":{"name":"uri","uri":null}}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex45.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/xml" \
  -d'<options xmlns="http://marklogic.com/appservices/search"><values name="uri"><uri/></values></options>' \
  'http://localhost:8011/v1/config/query/tutorial'

ex46.sh

{
    "options": {
        "values": {
            "name": "uri",
            "uri": null
        }
    }
}

ex46.xml

<options xmlns="http://marklogic.com/appservices/search">
  <values name="uri">
    <uri/>
  </values>
</options>

ex47.json

{
    "options": {
        "values": {
            "name": "uri",
            "uri": null
        }
    }
}

ex47.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"values":{"name":"company","range":{"type":"xs:string","collation":"http://marklogic.com/collation/","json-key":"affiliation"},"values-option":["frequency-order"]}}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex47.xml

<options xmlns="http://marklogic.com/appservices/search">
  <values name="uri">
    <uri/>
  </values>
</options>

ex48.json

{
  "options": {
    "values": {
      "name": "company",
      "range": {
        "collation": "http://marklogic.com/collation/",
        "json-key": "affiliation",
        "type": "xs:string"
      },
      "values-option": [
        "frequency-order"
      ]
    }
  }
}

ex48.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"values":{"name":"company","range":{"type":"xs:string","collation":"http://marklogic.com/collation/","json-key":"affiliation"},"values-option":["frequency-order"]}}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex49.json

{
  "options": {
    "values": {
      "name": "company",
      "range": {
        "collation": "http://marklogic.com/collation/",
        "json-key": "affiliation",
        "type": "xs:string"
      },
      "values-option": [
        "frequency-order"
      ]
    }
  }
}

ex49.sh

// print out each size/exposure co-occurrence
for (Tuple tuple : tuplesHandle.getTuples()) {

ex49.xml

<options xmlns="http://marklogic.com/appservices/search">
  <values name="company">
    <range type="xs:string" collation="http://marklogic.com/collation/">
      <json-key>affiliation</json-key>
    </range>
    <values-option>frequency-order</values-option>
  </values>
</options>

ex50.json

{
  "options": {
    "values": {
      "range": {
        "collation": "http://marklogic.com/collation/",
        "type": "xs:string",
        "element": {
          "ns": "",
          "name": "SPEAKER"
        }
      },
      "name": "speaker",
      "values-option": [
        "frequency-order"
      ]
    }
  }
}

ex50.sh

}

ex50.xml

<options xmlns="http://marklogic.com/appservices/search">
  <values name="company">
    <range type="xs:string" collation="http://marklogic.com/collation/">
      <json-key>affiliation</json-key>
    </range>
    <values-option>frequency-order</values-option>
  </values>
</options>

ex51.json

{
  "options": {
    "values": {
      "range": {
        "collation": "http://marklogic.com/collation/",
        "type": "xs:string",
        "element": {
          "ns": "",
          "name": "SPEAKER"
        }
      },
      "name": "speaker",
      "values-option": [
        "frequency-order"
      ]
    }
  }
}

ex51.sh

QueryOptionsHandle options = new QueryOptionsHandle().withConstraints(
    // expose the "contentRating" JSON key range index as "rating" values
    qob.constraint("rating",
        qob.range(
            qob.jsonRangeIndex("contentRating",
                qob.rangeType("xs:int")),
            Facets.FACETED,
            FragmentScope.DOCUMENTS,
            qob.buckets(),
            "descending")), // highest ratings first
 
    // expose the "affiliation" JSON key range index as "company" values
    qob.constraint("company",
        qob.range(
            qob.jsonRangeIndex("affiliation",
                qob.stringRangeType(QueryOptions.DEFAULT_COLLATION)),
            Facets.FACETED,
            FragmentScope.DOCUMENTS,
            qob.buckets(),
            "frequency-order"))); // most common values first

ex51.xml

<options xmlns="http://marklogic.com/appservices/search">
  <values name="speaker">
    <values-option>frequency-order</values-option>
    <range type="xs:string" collation="http://marklogic.com/collation/">
      <element ns="" name="SPEAKER"/>
    </range>
  </values>
</options>

ex52.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"values":{"name":"speaker","range":{"type":"xs:string","collation":"http://marklogic.com/collation/","element":{"name":"SPEAKER","ns":""}},"values-option":["frequency-order"]}}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex52.xml

<options xmlns="http://marklogic.com/appservices/search">
  <values name="speaker">
    <values-option>frequency-order</values-option>
    <range type="xs:string" collation="http://marklogic.com/collation/">
      <element ns="" name="SPEAKER"/>
    </range>
  </values>
</options>

ex53.json

{
  "options": {
    "values": {
      "range": {
        "json-key": "contentRating",
        "type": "xs:int"
      },
      "name": "rating"
    }
  }
}

ex53.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"values":{"name":"speaker","range":{"type":"xs:string","collation":"http://marklogic.com/collation/","element":{"name":"SPEAKER","ns":""}},"values-option":["frequency-order"]}}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex54.json

{
  "options": {
    "values": {
      "range": {
        "json-key": "contentRating",
        "type": "xs:int"
      },
      "name": "rating"
    }
  }
}

ex54.xml

<options xmlns="http://marklogic.com/appservices/search">
  <values name="rating">
    <range type="xs:int">
      <json-key>contentRating</json-key>
    </range>
  </values>
</options>

ex55.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"values":{"name":"rating","range":{"type":"xs:int","json-key":"contentRating"}}}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex55.xml

<options xmlns="http://marklogic.com/appservices/search">
  <values name="rating">
    <range type="xs:int">
      <json-key>contentRating</json-key>
    </range>
  </values>
</options>

ex56.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"values":{"name":"rating","range":{"type":"xs:int","json-key":"contentRating"}}}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex56.xml

  <!--...-->
  <aggregate-result name="avg">3.71839080459770115</aggregate-result>
  <aggregate-result name="median">4</aggregate-result>
  <!--...-->

ex57.json

  "aggregate-result": [
    {
      "_value": "3.71839080459770115",
      "name": "avg"
    },
    {
      "_value": "4",
      "name": "median"
    }
  ]

ex57.xml

  <!--...-->
  <aggregate-result name="avg">3.71839080459770115</aggregate-result>
  <aggregate-result name="median">4</aggregate-result>
  <!--...-->

ex58.json

  "aggregate-result": [
    {
      "_value": "3.71839080459770115",
      "name": "avg"
    },
    {
      "_value": "4",
      "name": "median"
    }
  ]

ex59.json

{
  "options": {
    "values": {
      "range": {
        "json-key": "contentRating",
        "type": "xs:int"
      },
      "name": "rating"
    }
  }
}

ex59.xml

<options xmlns="http://marklogic.com/appservices/search">
  <values name="rating">
    <range type="xs:int">
      <json-key>contentRating</json-key>
    </range>
  </values>
</options>

ex60.sh

curl -v -X POST \  --digest --user rest-admin:x \  -H "Content-type: application/json" \
  -d'{"options":{"values":{"name":"rating","range":{"type":"xs:int","json-key":"contentRating"}}}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex60.xml

<options xmlns="http://marklogic.com/appservices/search">
  <values name="rating">
    <range type="xs:int">
      <json-key>contentRating</json-key>
    </range>
  </values>
</options>

ex61.json

{
  "options": {
    "tuples": {
      "range": [
        {
          "type": "xs:unsignedLong",
          "element": {
            "ns": "http://marklogic.com/filter",
            "name": "size"
          }
        },
        {
          "collation": "http://marklogic.com/collation/",
          "type": "xs:string",
          "element": {
            "ns": "http://marklogic.com/filter",
            "name": "Exposure_Time"
          }
        }
      ],
      "name": "size-exposure"
    }
  }
}

ex61.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"values":{"name":"rating","range":{"type":"xs:int","json-key":"contentRating"}}}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex62.json

{
  "options": {
    "tuples": {
      "range": [
        {
          "type": "xs:unsignedLong",
          "element": {
            "ns": "http://marklogic.com/filter",
            "name": "size"
          }
        },
        {
          "collation": "http://marklogic.com/collation/",
          "type": "xs:string",
          "element": {
            "ns": "http://marklogic.com/filter",
            "name": "Exposure_Time"
          }
        }
      ],
      "name": "size-exposure"
    }
  }
}

ex62.xml

<options xmlns="http://marklogic.com/appservices/search">
  <tuples name="size-exposure">
    <range type="xs:unsignedLong">
      <element ns="http://marklogic.com/filter" name="size"/>
    </range>
    <range type="xs:string" collation="http://marklogic.com/collation/">
      <element ns="http://marklogic.com/filter" name="Exposure_Time"/>
    </range>
  </tuples>
</options>

ex63.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \  -d'{"options":{"tuples":{"name":"size-exposure","range":[{"type":"xs:unsignedLong","element":{"name":"size","ns":"http://marklogic.com/filter"}}, {"type":"xs:string","collation":"http://marklogic.com/collation/", "element":{"name":"Exposure_Time","ns":"http://marklogic.com/filter"} } ]}}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex63.xml

<options xmlns="http://marklogic.com/appservices/search">
  <tuples name="size-exposure">
    <range type="xs:unsignedLong">
      <element ns="http://marklogic.com/filter" name="size"/>
    </range>
    <range type="xs:string" collation="http://marklogic.com/collation/">
      <element ns="http://marklogic.com/filter" name="Exposure_Time"/>
    </range>
  </tuples>
</options>

ex64.sh

curl -v -X POST \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"tuples":{"name":"size-exposure","range":[{"type":"xs:unsignedLong","element":{"name":"size","ns":"http://marklogic.com/filter"}}, {"type":"xs:string","collation":"http://marklogic.com/collation/", "element":{"name":"Exposure_Time","ns":"http://marklogic.com/filter"} } ]}}}' \
  'http://localhost:8011/v1/config/query/tutorial'

ex64.xml

  <!--...-->
  <tuple frequency="1">
     <distinct-value xsi:type="xs:unsignedLong" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">60641</distinct-value>
    <distinct-value xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1/100</distinct-value>
  </tuple>
  <!--...-->

ex65.json

"tuple": [
  {
    "distinct-value": [
      {
        "_value": "60641",
         "type": "xs:unsignedLong"
      },
       {
        "_value": "1/100",
         "type": "xs:string"
      }
    ],
    "frequency": 1
  }

ex65.xml

  <!--...-->
  <tuple frequency="1">
    <distinct-value xsi:type="xs:unsignedLong" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">60641</distinct-value>
    <distinct-value xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1/100</distinct-value>
  </tuple>
  <!--...-->

ex66.json

"tuple": [
  {
    "distinct-value": [
      {
        "_value": "60641",
         "type": "xs:unsignedLong"
      },
       {
        "_value": "1/100",
         "type": "xs:string"
      }
    ],
    "frequency": 1
  }

ex66.xml

<options xmlns="http://marklogic.com/appservices/search">
  <!-- expose the "contentRating" JSON key range index as "rating" values -->
  <constraint name="rating">
    <range type="xs:int" facet="true">
      <json-key>contentRating</json-key>
      <!-- highest ratings first -->
      <facet-option>descending</facet-option>
    </range>
  </constraint>
  <!-- expose the "affiliation" JSON key range index as "company" values -->
  <constraint name="company">
    <range type="xs:string" facet="true" collation="http://marklogic.com/collation/">
      <json-key>affiliation</json-key>
      <!-- most common values first -->
      <facet-option>frequency-order</facet-option>
    </range>
  </constraint>
</options>

ex67.json

{
  "options": {
    "constraint": [
      {
        "range": {
          "json-key": "contentRating",
          "type": "xs:int",
          "facet-option": "descending"
        },
        "name": "rating"
      },
      {
        "range": {
          "collation": "http://marklogic.com/collation/",
          "json-key": "affiliation",
          "type": "xs:string",
          "facet-option": "frequency-order"
        },
        "name": "company"
      }
    ]
  }
}

ex67.xml

<options xmlns="http://marklogic.com/appservices/search">
  <!-- expose the "contentRating" JSON key range index as "rating" values -->
  <constraint name="rating">
    <range type="xs:int" facet="true">
      <json-key>contentRating</json-key>
      <!-- highest ratings first -->
      <facet-option>descending</facet-option>
    </range>
  </constraint>
  <!-- expose the "affiliation" JSON key range index as "company" values -->
  <constraint name="company">
    <range type="xs:string" facet="true" collation="http://marklogic.com/collation/">
      <json-key>affiliation</json-key>
      <!-- most common values first -->
      <facet-option>frequency-order</facet-option>
    </range>
  </constraint>
</options>

ex68.json

{
  "options": {
    "constraint": [
      {
        "range": {
          "json-key": "contentRating",
          "type": "xs:int",
          "facet-option": "descending"
        },
        "name": "rating"
      },
      {
        "range": {
          "collation": "http://marklogic.com/collation/",
          "json-key": "affiliation",
          "type": "xs:string",
          "facet-option": "frequency-order"
        },
        "name": "company"
      }
    ]
  }
}

ex68.sh

curl -v -X PUT \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"constraint":[{"name":"rating","range":{"type":"xs:int","json-key":"contentRating","facet-option":"descending"}}, {"name":"company","range":{"type":"xs:string","collation":"http://marklogic.com/collation/","json-key":"affiliation","facet-option":"frequency-order"}} ]}}' \
  'http://localhost:8011/v1/config/query/tutorial2'

ex69.json

  "facets": {
    "rating": {
      "facetValues": [
        {
          "count": 61,
          "name": "5"
        },
        {
          "count": 54,
          "name": "4"
        },
        {
          "count": 34,
          "name": "3"
        },
        {
          "count": 11,
          "name": "2"
        },
        {
          "count": 2,
          "name": "1"
        },
        {
          "count": 12,
          "name": "0"
        }
      ],
      "type": "xs:int"
    },
    "company": {
      "facetValues": [
        {
          "count": 38,
          "name": "MarkLogic"
        },
        {
          "count": 2,
          "name": "Avalon Consulting, LLC"
        },
        {
          "count": 2,
          "name": "Overstory, Ltd."
        }
      ],
      "type": "xs:string"
    }
  }

ex69.sh

curl -v -X PUT \
  --digest --user rest-admin:x \
  -H "Content-type: application/json" \
  -d'{"options":{"constraint":[{"name":"rating","range":{"type":"xs:int","json-key":"contentRating","facet-option":"descending"}}, {"name":"company","range":{"type":"xs:string","collation":"http://marklogic.com/collation/","json-key":"affiliation","facet-option":"frequency-order"}} ]}}' \
  'http://localhost:8011/v1/config/query/tutorial2'

ex70.json

  "facets": {
    "rating": {
      "facetValues": [
        {
          "count": 61,
          "name": "5"
        },
        {
          "count": 54,
          "name": "4"
        },
        {
          "count": 34,
          "name": "3"
        },
        {
          "count": 11,
          "name": "2"
        },
        {
          "count": 2,
          "name": "1"
        },
        {
          "count": 12,
          "name": "0"
        }
      ],
      "type": "xs:int"
    },
    "company": {
      "facetValues": [
        {
          "count": 38,
          "name": "MarkLogic"
        },
        {
          "count": 2,
          "name": "Avalon Consulting, LLC"
        },
        {
          "count": 2,
          "name": "Overstory, Ltd."
        }
      ],
      "type": "xs:string"
    }
  }

ex70.xml