Loading TOC...

es functions

The table below lists all the es built-in functions (in this namespace: http://marklogic.com/entity-services).

You can also view these functions broken down by category:

This module contains the Entity Services API, which enables you to define logical entity-relationship models and instantiate them for use in your applications. For details, see the Entity Services Developer's Guide.

To use the es module in your JavaScript code, include a require statement similar to the following in your code:

const es = require('/MarkLogic/entity-services/entity-services');

The library namespace prefix es is not predefined in the server.

24 functions
Function name Description
es.addAttachments This function is deprecated and will be removed in a future release.
es.copyAttachments This function is deprecated and will be removed in a future release.
es.databasePropertiesGenerate This function is deprecated and will be removed in a future release.
es.extractArray This function is deprecated and will be removed in a future release.
es.extractionTemplateGenerate This function is deprecated and will be removed in a future release.
es.initInstance This function is deprecated and will be removed in a future release.
es.initSource This function is deprecated and will be removed in a future release.
es.initTranslationSource This function is deprecated and will be removed in a future release.
es.instanceConverterGenerate This function is deprecated and will be removed in a future release.
es.instanceFromDocument This function is deprecated and will be removed in a future release.
es.instanceGetAttachments This function is deprecated and will be removed in a future release.
es.instanceJsonFromDocument This function is deprecated and will be removed in a future release.
es.instanceXmlFromDocument This function is deprecated and will be removed in a future release.
es.modelFromXml This function is deprecated and will be removed in a future release.
es.modelGetTestInstances This function is deprecated and will be removed in a future release.
es.modelToXml This function is deprecated and will be removed in a future release.
es.modelValidate Validates an entity services model descriptor.
es.optional This function is deprecated and will be removed in a future release.
es.piiGenerate This function is deprecated and will be removed in a future release.
es.schemaGenerate This function is deprecated and will be removed in a future release.
es.searchOptionsGenerate This function is deprecated and will be removed in a future release.
es.serializeAttachments This function is deprecated and will be removed in a future release.
es.versionTranslatorGenerate This function is deprecated and will be removed in a future release.
es.withNamespace This function is deprecated and will be removed in a future release.