Loading TOC...

MarkLogic 10 Product Documentation
es functions (Entity Services API)

The Entity Services API is a set of functions that enable you to define logical entity-relationship models and instantiate them for use in your application. Use these functions to create Entity Services models, generate supporting code and configuration artifacts, and manage entity instances. 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.

15 functions
Function name Description
es.databasePropertiesGenerate This function is deprecated and will not be supported in MarkLogic 11.
es.extractionTemplateGenerate This function is deprecated and will not be supported in MarkLogic 11.
es.instanceConverterGenerate This function is deprecated and will not be supported in MarkLogic 11.
es.instanceFromDocument This function is deprecated and will not be supported in MarkLogic 11.
es.instanceGetAttachments This function is deprecated and will not be supported in MarkLogic 11.
es.instanceJsonFromDocument This function is deprecated and will not be supported in MarkLogic 11.
es.instanceXmlFromDocument This function is deprecated and will not be supported in MarkLogic 11.
es.modelFromXml This function is deprecated and will not be supported in MarkLogic 11.
es.modelGetTestInstances This function is deprecated and will not be supported in MarkLogic 11.
es.modelToXml This function is deprecated and will not be supported in MarkLogic 11.
es.modelValidate Validates an entity services model descriptor.
es.piiGenerate This function is deprecated and will not be supported in MarkLogic 11.
es.schemaGenerate This function is deprecated and will not be supported in MarkLogic 11.
es.searchOptionsGenerate This function is deprecated and will not be supported in MarkLogic 11.
es.versionTranslatorGenerate This function is deprecated and will not be supported in MarkLogic 11.