Understanding the Article XML Format

Oct 13, 2025 by wbrum.org 93 views

Introduction

Marklogic Search API is a powerful tool for searching and retrieving data from Marklogic databases. It provides a flexible and efficient way to search and filter data based on various criteria. In this article, we will discuss how to perform a text search using Marklogic Search API on all elements except one.

Prerequisites

Before we dive into the details, let's make sure we have the necessary prerequisites:

Marklogic 9 or 10 installed
A Marklogic database with a collection of articles in XML format
Familiarity with Marklogic Search API and XQuery

Understanding the Article XML Format

The article XML format is as follows:

<article>
  <contg>.....</contg>
  <bibliog>.....</bibliog>
  <indexg>.....</indexg>
  <fundg>.....</fundg>
  <!-- other elements -->
</article>

As you can see, the article XML format contains multiple elements, including contg, bibliog, indexg, and fundg.

Performing a Text Search Using Marklogic Search API

To perform a text search using Marklogic Search API, we need to use the cts:search function. This function takes two arguments: the first is the collection of documents to search, and the second is the search query.

Here's an example of how to perform a text search on all elements except one:

xquery version "1.0-ml";
import module namespace search = "http://marklogic.com/search"
at "/MarkLogic/search.xqy";
let $collection := cts:collection-uri("articles")
let $search-query := cts:word-query(cts:tokenize("search query"))
let $exclude-element := cts:element-query(xs:QName("fundg"))
return
search:search(
$collection,
cts:and-query((
 $search-query, cts:not-query($ exclude-element)
))
)

In this example, we're searching the articles collection for documents that contain the search query, but excluding the fundg element.

Breaking Down the Code

Let's break down the code into smaller sections:

xquery version "1.0-ml";: This line specifies the version of XQuery to use.
import module namespace search = "http://marklogic.com/search" at "/MarkLogic/search.xqy";: This line imports the Marklogic Search API module.
let $collection := cts:collection-uri("articles"): This line specifies the collection of documents to search.
let $search-query := cts:word-query(cts:tokenize("search query")): This line specifies the search query.
let $exclude-element := cts:element-query(xs:QName("fundg")): This line specifies the element to exclude from the search.
return search:search($collection, cts:and-query(($search-query, cts:not-query($exclude-element)))): This line performs the search and returns the results.

Tips and Variations

Here are some tips and variations to keep in mind:

To search multiple collections, simply add more cts:collection-uri calls to the $collection variable.
To search multiple elements, simply add more cts:element-query calls to the $exclude-element variable.
To use a different search query, simply modify the $search-query variable.
To use a different element to exclude, simply modify the $exclude-element variable.

Conclusion

Introduction

In our previous article, we discussed how to perform a text search using Marklogic Search API on all elements except one. In this article, we will answer some frequently asked questions (FAQs) about Marklogic Search API text search.

Q: What is Marklogic Search API?

A: Marklogic Search API is a powerful tool for searching and retrieving data from Marklogic databases. It provides a flexible and efficient way to search and filter data based on various criteria.

Q: What is the difference between Marklogic Search API and XQuery?

A: Marklogic Search API is a module that provides a set of functions for searching and filtering data, while XQuery is a programming language used to query and transform data. Marklogic Search API is built on top of XQuery and provides a more convenient and efficient way to perform searches.

Q: How do I install Marklogic Search API?

A: Marklogic Search API is included with Marklogic 9 and 10. To install it, simply follow the installation instructions for Marklogic.

Q: What are the benefits of using Marklogic Search API?

A: Marklogic Search API provides several benefits, including:

Improved search performance: Marklogic Search API is optimized for search performance and can handle large volumes of data.
Flexible search criteria: Marklogic Search API allows you to specify complex search criteria, including multiple search terms and filters.
Efficient data retrieval: Marklogic Search API can retrieve data from Marklogic databases in a efficient and scalable manner.

Q: How do I perform a text search using Marklogic Search API?

A: To perform a text search using Marklogic Search API, you need to use the cts:search function. This function takes two arguments: the first is the collection of documents to search, and the second is the search query.

Here's an example of how to perform a text search on all elements except one:

xquery version "1.0-ml";
import module namespace search = "http://marklogic.com/search"
at "/MarkLogic/search.xqy";
let $collection := cts:collection-uri("articles")
let $search-query := cts:word-query(cts:tokenize("search query"))
let $exclude-element := cts:element-query(xs:QName("fundg"))
return
search:search(
$collection,
cts:and-query((
 $search-query, cts:not-query($ exclude-element)
))
)

Q: How do I exclude multiple elements from the search?

A: To exclude multiple elements from the search, simply add more cts:element-query calls to the $exclude-element variable.

Here's an example of how to exclude multiple elements:

let $exclude-element := cts:element-query(xs:QName("fundg")) || cts:element-query(xs:QName("other-element"))

Q: How do I search multiple collections?

A: To search multiple collections, simply add more cts:collection-uri calls to the $collection variable.

Here's an example of how to search multiple collections:

let $collection := cts:collection-uri("articles") || cts:collection-uri("other-collection")

Conclusion

In this article, we answered some frequently asked questions about Marklogic Search API text search. We covered the basics of Marklogic Search API, including its benefits and how to perform a text search. We also provided examples of how to exclude multiple elements from the search and search multiple collections. With this knowledge, you should be able to perform complex text searches using Marklogic Search API.