view functions

The views module is used to create and manage SQL schemas and views. This API only creates and manages Range Views, as described in Creating Range Views in the SQL Data Modeling Guide. The functions in this API will not work on Template Views, as described in Creating Template Views in the SQL Data Modeling Guide.

A schema defines a logical scoping for views. A schema has a unique ID, a name (which must also be unique), and a collection of views. During SQL execution, the schema provides the naming context for its views, which enables you have have multiple views of the same name in different schemas. The default schema is called "main". Even though it is a default, you must create the "main" schema before it can be used.

A view is an abstraction of a SQL "table." However, unlike in a relational database, a view in MarkLogic server is implemented on top of element range indexes. A view consists of a unique ID, a name (which must be unique in the context of a particular schema), a view scope, and a sequence of column specifications. Each column has a name and a range index reference. The range index for each column must be created before creating the view. The view scope is used to constrain the subset of the database to which the view applies. The view scope can either limit rows in the view to documents with a specific element (localname + namespace) or to documents in a particular collection.

The views function module is installed as the following file:

• install_dir/Modules/MarkLogic/views.xqy

where install_dir is the directory in which MarkLogic Server is installed.

To use the views.xqy module in your own XQuery modules, include the following line in your XQuery prolog:

import module namespace view="http://marklogic.com/xdmp/view" at "/MarkLogic/views.xqy";

You must have the view-admin role to execute the functions in the View library.