mlclient::utilities Namespace Reference

A non-required utilities namespace. Be aware that classes in this namespace may have external dependencies. These are documented in the class documentation. More...

Classes
class	AggregateInfo
class	CppRestJsonArrayNode
	Document Traversal API node for a JSON Array. More...
class	CppRestJsonContainerNode
	Document Traversal API generic JSON wrapper for a Document. More...
class	CppRestJsonDocumentContent
	An ITextDocumentContent instance that wraps a Microsoft cpprest JSON value object. More...
class	CppRestJsonDocumentNavigator
	Provides a navigator interface over a CppRestJsonDocumentContent's root web::json::value instance. More...
class	CppRestJsonDocumentNode
	Represents a Node within a CppRestJsonDocumentContent's root web::json::value instance. More...
class	CppRestJsonHelper
	This class provides utility functions to handle JSON data. More...
class	CppRestJsonObjectNode
	Document Traversal API node for a JSON Object. More...
class	DocumentBatchHelper
	Helper functions for common batch document operations. More...
class	DocumentBatchWriter
	Manages a batched document upload/write operation. More...
class	DocumentHelper
	Helper methods to work with Document and IDocumentContent instances. More...
class	GenericQuery
	A Generic Query concrete class for an IQuery. More...
class	IBatchNotifiable
	An abstract class that supports notification when a Document (batch) action is completed. More...
class	IContainerRef
	Represents a named container in the MarkLogic structured query API. More...
class	ILexiconRef
class	IQuery
	A high level abstract class representing a MarkLogic Structured Query. More...
class	ITypedValue
	A Tagging interface to represent a typed value within the structure query API. More...
class	JsonPropertyQuery
	A JSON property value query instance implementation of an IQuery. More...
class	JsonPropertyRef
	A specialisation of IContainerRef to represent a JSON property container. More...
struct	Progress
	The progress of the upload within DocumentBatchWriter. More...
class	PugiXmlArrayNode
	Document Traversal API array container for Pugi XML. More...
class	PugiXmlContainerNode
	Document Traversal API generic container for Pugi XML. More...
class	PugiXmlDocumentContent
	An ITextDocumentContent instance that wraps a pugixml xml_parse object. (Derived from pugi::xml_document) More...
class	PugiXmlDocumentNavigator
	Provides a navigator interface over a PugiXmlDocumentContent's root pugi::xml_document instance. More...
class	PugiXmlDocumentNode
	Represents a Node within a pugi::xml::document instance. More...
class	PugiXmlHelper
	Uses the pugixml library to provide convenience XML parsing functionality. More...
class	PugiXmlObjectNode
	Document Traversal API Object container for Pugi XML. More...
class	RangeLexiconRef
class	RangeOptions
class	ResponseHelper
	This class provides utility functions to ease the use of Response objects. More...
class	SearchBuilder
	This class helps create a MarkLogic complex search JSON object for use with SearchDescription. More...
class	SearchOptionsBuilder
	This class helps create a MarkLogic search options JSON object for use with SearchDescription. More...
class	ValuesInfo

Enumerations
enum	TransactionMode { PER_RECORD, PER_BATCH, ALL }
	Represents the Batch upload transaction mode used by DocumentBatchWriter. Defaults to PER_BATCH. More...
enum	RangeOperation : int {   UNKNOWN_TYPE = 0, GE = 1, GT = 2, LT = 3,   LE = 4, EQ = 5, NE = 6 }
enum	QueryBuilderMode { ALL, XML, JSON }
	The mode determines whether the QueryBuilder will generate JSON based queries, xml based queries, or an or query of all types (DEFAULT). More...
enum	RangeIndexType {   INT, UNSIGNED_INT, LONG, UNSIGNED_LONG,   FLOAT, DOUBLE, DECIMAL, DATE_TIME,   TIME, DATE, G_YEAR_MONTH, G_YEAR,   G_MONTH, G_DAY, YEAR_MONTH_DURATION, DAY_TIME_DURATION,   STRING, ANY_URI }
enum	AggregateBuiltIn {   SUM, AVG, MAX, MIN,   COUNT, STDDEV, STDDEV_POPULATION, VARIANCE,   VARIANCE_POPULATION }
enum	FragmentScope { CONTENT, PROPERTIES }
enum	FacetOption {   ASCENDING, DESCENDING, EMPTIES, ANY,   DOCUMENT, PROPERTIES, LOCKS, FREQUENCY_ORDER,   ITEM_ORDER, FRAGMENT_FREQUENCY, ITEM_FREQUENCY, SCORE_LOGTFIDF,   SCORE_LOGTF, SCORE_SIMPLE, SCORE_RANDOM, CHECKED,   UNCHECKED, CONCURRENT, MAP, TYPE,   TIMEZONE, LIMIT, SAMPLE, TRUNCATE,   SKIP }
enum	RangeOption {   CACHED, UNCACHED, SYNONYM, SCORE_FUNCTION_ZERO,   SCORE_FUNCTION_RECIPROCAL, SCORE_FUNCTION_LINEAR, SLOPE_FACTOR, MAX_OCCURS,   MIN_OCCURS }
enum	ValuesOption {   ASCENDING, DESCENDING, ANY, DOCUMENT,   PROPERTIES, LOCKS, FREQUENCY_ORDER, ITEM_ORDER,   FRAGMENT_FREQUENCY, ITEM_FREQUENCY, SCORE_LOGTFIDF, SCORE_LOGTF,   SCORE_SIMPLE, SCORE_RANDOM, SCORE_ZERO, CHECKED,   UNCHECKED, CONCURRENT, MAP, ORDERED,   PROXIMITY, TIMEZONE, LIMIT, SAMPLE,   TRUNCATE, SKIP }
enum	LexiconType {   RANGE, GEO_ELEMENT, GEO_ELEMENT_PAIR, GEO_ATTRIBUTE_PAIR,   GEO_JSON_PROPERTY, GEO_JSON_PROPERTY_PAIR, GEO_PATH, COLLECTION,   URI }

Functions
IDocumentNode *	createNode (pugi::xml_node &parent, const std::string &key)
	Helper method to create an IDocumentNode instance from a pugi xml document node instance, and the name of its child. More...
MLCLIENT_API std::ostream &	operator<< (std::ostream &os, const RangeOperation &rt)
MLCLIENT_API std::string &	operator+ (std::string &s, const RangeOperation &rt)
MLCLIENT_API const std::string	translate_rangeoperation (const RangeOperation &rt)
MLCLIENT_API std::ostream &	operator<< (std::ostream &os, const IQuery &rt)
MLCLIENT_API std::string &	operator+ (std::string &s, const IQuery &rt)
std::ostream &	operator<< (std::ostream &os, const IContainerRef &rt)
std::string &	operator+ (std::string &s, const IContainerRef &rt)
MLCLIENT_API std::ostream &	operator<< (std::ostream &os, const RangeIndexType &rt)
MLCLIENT_API std::string &	operator+ (std::string &s, const RangeIndexType &rt)
MLCLIENT_API const std::string	translate_rangeindextype (const RangeIndexType &rt)
MLCLIENT_API std::ostream &	operator<< (std::ostream &os, const AggregateBuiltIn &rt)
MLCLIENT_API std::string &	operator+ (std::string &s, const AggregateBuiltIn &rt)
MLCLIENT_API const std::string	translate_aggregatebuiltin (const AggregateBuiltIn &rt)
MLCLIENT_API std::ostream &	operator<< (std::ostream &os, const FragmentScope &rt)
MLCLIENT_API std::string &	operator+ (std::string &s, const FragmentScope &rt)
MLCLIENT_API const std::string	translate_fragmentscope (const FragmentScope &rt)
MLCLIENT_API std::ostream &	operator<< (std::ostream &os, const FacetOption &rt)
MLCLIENT_API std::string &	operator+ (std::string &s, const FacetOption &rt)
MLCLIENT_API const std::string	translate_facetoption (const FacetOption &rt)
MLCLIENT_API std::ostream &	operator<< (std::ostream &os, const RangeOption &rt)
MLCLIENT_API std::string &	operator+ (std::string &s, const RangeOption &rt)
MLCLIENT_API const std::string	translate_rangeoption (const RangeOption &rt)
MLCLIENT_API std::ostream &	operator<< (std::ostream &os, const ValuesOption &rt)
MLCLIENT_API std::string &	operator+ (std::string &s, const ValuesOption &rt)
MLCLIENT_API const std::string	translate_valuesoption (const ValuesOption &rt)
MLCLIENT_API std::ostream &	operator<< (std::ostream &os, const RangeOptions &rt)
MLCLIENT_API std::string &	operator+ (std::string &s, const RangeOptions &rt)
MLCLIENT_API const std::string	translate_rangeoptions (const RangeOptions &rt)
MLCLIENT_API std::ostream &	operator<< (std::ostream &os, const AggregateInfo &rt)
MLCLIENT_API std::string &	operator+ (std::string &s, const AggregateInfo &rt)
MLCLIENT_API const std::string	translate_aggregateinfo (const AggregateInfo &rt)
MLCLIENT_API std::ostream &	operator<< (std::ostream &os, const LexiconType &rt)
MLCLIENT_API std::string &	operator+ (std::string &s, const LexiconType &rt)
MLCLIENT_API const std::string	translate_lexicontype (const LexiconType &rt)
MLCLIENT_API std::ostream &	operator<< (std::ostream &os, const ILexiconRef &ref)
MLCLIENT_API std::string &	operator+ (std::string &s, const ILexiconRef &rt)
MLCLIENT_API std::ostream &	operator<< (std::ostream &os, const RangeLexiconRef &rt)
MLCLIENT_API std::string &	operator+ (std::string &s, const RangeLexiconRef &rt)
MLCLIENT_API const std::string	translate_rangelexiconref (const RangeLexiconRef &rt)
MLCLIENT_API std::ostream &	operator<< (std::ostream &os, const ValuesInfo &rt)
MLCLIENT_API std::string &	operator+ (std::string &s, const ValuesInfo &rt)
MLCLIENT_API const std::string	translate_valuesinfo (const ValuesInfo &rt)

Detailed Description

A non-required utilities namespace. Be aware that classes in this namespace may have external dependencies. These are documented in the class documentation.

Since

8.0.0

Date

2016-04-24

Enumeration Type Documentation

enum mlclient::utilities::QueryBuilderMode

strong

The mode determines whether the QueryBuilder will generate JSON based queries, xml based queries, or an or query of all types (DEFAULT).

Note

Useful when you have a mix of documents of both types. See also setDefaultXmlNamespace().

enum mlclient::utilities::RangeOperation : int

strong

The MarkLogic Search Range Query Operation - Unknown (means the API hasn't been told by your own function calls!).

enum mlclient::utilities::TransactionMode

strong

Represents the Batch upload transaction mode used by DocumentBatchWriter. Defaults to PER_BATCH.

Since

8.0.2

Function Documentation

IDocumentNode* mlclient::utilities::createNode	(	pugi::xml_node &	parent,
		const std::string &	key
	)

Helper method to create an IDocumentNode instance from a pugi xml document node instance, and the name of its child.

Parameters

parent	The parent PUGI XML node instance
key	The name of the child key underneath the node provided

Returns

The IDocumentNode pointer instance (caller OWNS and must delete this instance)