@harishreddym/baqend

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Baqend JavaScript SDK 2.14.1 - Source: lib/metamodel/Metamodel.js</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <link rel="shortcut icon" type="image/x-icon" href="img/favicon.ico"> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/bootstrap-baqend.min.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> <link type="text/css" rel="stylesheet" href="styles/font-awesome-4.7.0.css"> </head> <body> <nav class="navbar navbar-default navbar-fixed-top" role="navigation"> <div class="navbar-inner container">  <div class="navbar-header">  <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button>  <a class="navbar-brand" href="/"><img src="img/logo.png"></a> </div>  <div id="nav" class="navbar-collapse collapse">  <form class="navbar-right form-inline search-form"> <div class="form-group search-form-group"> <input type="search" class="form-control search-input" id="search-query" placeholder="Search Guide" name="q" autocomplete="off"> <div id="search-results" class="search-results"> <p class="search-no-results">Please enter a search query ...</p> </div> <i class="search-icon fa fa-search"></i> </div> </form>  <ul class="nav navbar-nav"> <li> <a href="https://dashboard.baqend.com/">Dashboard</a> </li>  <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Guide <b class="caret"></b></a> <ul class="dropdown-menu"> <li><a href="https://www.baqend.com/guide/">Home</a></li> <li><a href="https://www.baqend.com/guide/#speed-kit">Speed Kit</a></li> <li><a href="https://www.baqend.com/guide/#platform">Platform</a></li> <li><a href="https://www.baqend.com/guide/roadmap/">Roadmap</a></li> <li><a href="https://www.baqend.com/guide/topics/faq/">FAQ</a></li> </ul> </li>  <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Starter Kits <b class="caret"></b></a> <ul class="dropdown-menu"> <li><a href="https://www.baqend.com/guide/starter-kits/">Starter Kits Overview</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/angular2/">Angular 2 Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/react/">React and Redux Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/bootstrap/">Bootstrap Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/ionic2/">Ionic 2 Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/ionic/">Ionic Starter Kit</a></li> </ul> </li> <li class="active"> <a href="baqend.html">JS API</a> </li> <li> <a href="https://www.baqend.com/tutorial.html">Tutorial</a> </li> </ul> </div> </div> </nav> <div class="box gray pt-32 pb-32"> <div class="container"> <div class="row">  <div class="bs-sidebar hidden-print fixed affix" role="complementary"> <input class="filter form-control input-sm" type="text" placeholder="FILTER"/> <ul class="nav bs-sidenav"> <li class=""><a href="Acl.html" class="nav-name">Acl</a></li> <li class=""><a href="EntityManager.html" class="nav-name">EntityManager</a></li> <li class=""><a href="EntityManagerFactory.html" class="nav-name">EntityManagerFactory</a></li> <li class=""><a href="GeoPoint.html" class="nav-name">GeoPoint</a></li> <li class=""><a href="RealtimeEvent.html" class="nav-name">RealtimeEvent</a></li> <li class=""><a href="baqend.html" class="nav-name">baqend</a></li> <li class=""> <a href="binding.html" class="nav-name">binding</a> <ul class="nav"> <li class=""><a href="binding.Accessor.html" class="nav-name">Accessor</a></li> <li class=""><a href="binding.DeviceFactory.html" class="nav-name">DeviceFactory</a></li> <li class=""><a href="binding.Enhancer.html" class="nav-name">Enhancer</a></li> <li class=""><a href="binding.Entity.html" class="nav-name">Entity</a></li> <li class=""><a href="binding.EntityFactory.html" class="nav-name">EntityFactory</a></li> <li class=""><a href="binding.Factory.html" class="nav-name">Factory</a></li> <li class=""><a href="binding.File.html" class="nav-name">File</a></li> <li class=""><a href="binding.FileFactory.html" class="nav-name">FileFactory</a></li> <li class=""><a href="binding.Managed.html" class="nav-name">Managed</a></li> <li class=""><a href="binding.ManagedFactory.html" class="nav-name">ManagedFactory</a></li> <li class=""><a href="binding.Role.html" class="nav-name">Role</a></li> <li class=""><a href="binding.User.html" class="nav-name">User</a></li> <li class=""><a href="binding.UserFactory.html" class="nav-name">UserFactory</a></li> </ul> </li> <li class=""> <a href="caching.html" class="nav-name">caching</a> <ul class="nav"> <li class=""><a href="caching.BloomFilter.html" class="nav-name">BloomFilter</a></li> </ul> </li> <li class=""> <a href="connector.html" class="nav-name">connector</a> <ul class="nav"> <li class=""><a href="connector.Connector.html" class="nav-name">Connector</a></li> <li class=""><a href="connector.FetchConnector.html" class="nav-name">FetchConnector</a></li> <li class=""><a href="connector.IFrameConnector.html" class="nav-name">IFrameConnector</a></li> <li class=""><a href="connector.Message.html" class="nav-name">Message</a></li> <li class=""><a href="connector.NodeConnector.html" class="nav-name">NodeConnector</a></li> <li class=""><a href="connector.ObservableStream.html" class="nav-name">ObservableStream</a></li> <li class=""><a href="connector.WebSocketConnector.html" class="nav-name">WebSocketConnector</a></li> <li class=""><a href="connector.XMLHttpConnector.html" class="nav-name">XMLHttpConnector</a></li> <li class=""><a href="connector.ChannelMessage.html" class="nav-name">ChannelMessage</a></li> </ul> </li> <li class=""> <a href="error.html" class="nav-name">error</a> <ul class="nav"> <li class=""><a href="error.CommunicationError.html" class="nav-name">CommunicationError</a></li> <li class=""><a href="error.EntityExistsError.html" class="nav-name">EntityExistsError</a></li> <li class=""><a href="error.IllegalEntityError.html" class="nav-name">IllegalEntityError</a></li> <li class=""><a href="error.PersistentError.html" class="nav-name">PersistentError</a></li> <li class=""><a href="error.RollbackError.html" class="nav-name">RollbackError</a></li> </ul> </li> <li class=""> <a href="metamodel.html" class="nav-name">metamodel</a> <ul class="nav"> <li class=""><a href="metamodel.Attribute.html" class="nav-name">Attribute</a></li> <li class=""><a href="metamodel.BasicType.html" class="nav-name">BasicType</a></li> <li class=""><a href="metamodel.CollectionAttribute.html" class="nav-name">CollectionAttribute</a></li> <li class=""><a href="metamodel.DbIndex.html" class="nav-name">DbIndex</a></li> <li class=""><a href="metamodel.EmbeddableType.html" class="nav-name">EmbeddableType</a></li> <li class=""><a href="metamodel.EntityType.html" class="nav-name">EntityType</a></li> <li class=""><a href="metamodel.ListAttribute.html" class="nav-name">ListAttribute</a></li> <li class=""><a href="metamodel.ManagedType.html" class="nav-name">ManagedType</a></li> <li class=""><a href="metamodel.MapAttribute.html" class="nav-name">MapAttribute</a></li> <li class=""><a href="metamodel.Metamodel.html" class="nav-name">Metamodel</a></li> <li class=""><a href="metamodel.ModelBuilder.html" class="nav-name">ModelBuilder</a></li> <li class=""><a href="metamodel.PluralAttribute.html" class="nav-name">PluralAttribute</a></li> <li class=""><a href="metamodel.SetAttribute.html" class="nav-name">SetAttribute</a></li> <li class=""><a href="metamodel.SingularAttribute.html" class="nav-name">SingularAttribute</a></li> <li class=""><a href="metamodel.Type.html" class="nav-name">Type</a></li> </ul> </li> <li class=""> <a href="model.html" class="nav-name">model</a> <ul class="nav"> <li class=""><a href="model.Device.html" class="nav-name">Device</a></li> <li class=""><a href="model.Role.html" class="nav-name">Role</a></li> <li class=""><a href="model.User.html" class="nav-name">User</a></li> </ul> </li> <li class=""> <a href="partialupdate.html" class="nav-name">partialupdate</a> <ul class="nav"> <li class=""><a href="partialupdate.EntityPartialUpdateBuilder.html" class="nav-name">EntityPartialUpdateBuilder</a></li> <li class=""><a href="partialupdate.PartialUpdateBuilder.html" class="nav-name">PartialUpdateBuilder</a></li> <li class=""><a href="partialupdate.UpdateOperation.html" class="nav-name">UpdateOperation</a></li> </ul> </li> <li class=""> <a href="query.html" class="nav-name">query</a> <ul class="nav"> <li class=""><a href="query.Builder.html" class="nav-name">Builder</a></li> <li class=""><a href="query.Filter.html" class="nav-name">Filter</a></li> <li class=""><a href="query.Node.html" class="nav-name">Node</a></li> <li class=""><a href="query.Operator.html" class="nav-name">Operator</a></li> <li class=""><a href="query.Query.html" class="nav-name">Query</a></li> <li class=""><a href="query.Stream.html" class="nav-name">Stream</a></li> <li class=""><a href="query.Condition.html" class="nav-name">Condition</a></li> </ul> </li> <li class=""> <a href="util.html" class="nav-name">util</a> <ul class="nav"> <li class=""><a href="util.Code.html" class="nav-name">Code</a></li> <li class=""><a href="util.Lockable.html" class="nav-name">Lockable</a></li> <li class=""><a href="util.Logger.html" class="nav-name">Logger</a></li> <li class=""><a href="util.Metadata.html" class="nav-name">Metadata</a></li> <li class=""><a href="util.Modules.html" class="nav-name">Modules</a></li> <li class=""><a href="util.Permission.html" class="nav-name">Permission</a></li> <li class=""><a href="util.PushMessage.html" class="nav-name">PushMessage</a></li> <li class=""><a href="util.TokenStorage.html" class="nav-name">TokenStorage</a></li> <li class=""><a href="util.ValidationResult.html" class="nav-name">ValidationResult</a></li> <li class=""><a href="util.Validator.html" class="nav-name">Validator</a></li> <li class=""><a href="util.TokenStorageFactory.html" class="nav-name">TokenStorageFactory</a></li> </ul> </li> </ul> </div> <div class="col-md-12" id="main"> <div class="content"> <h1 class="page-title">Source: lib/metamodel/Metamodel.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>'use strict'; const ManagedType = require('./ManagedType'); const EntityType = require('./EntityType'); const Enhancer = require('../binding/Enhancer'); const ModelBuilder = require('./ModelBuilder'); const DbIndex = require('./DbIndex'); const Lockable = require('../util/Lockable'); const deprecated = require('../util/deprecated'); const StatusCode = require('../connector/Message').StatusCode; const message = require('../message'); /** * @alias metamodel.Metamodel * @extends util.Lockable */ class Metamodel extends Lockable { /** * Constructs a new metamodel instance which represents the complete schema of one baqend app * @param {EntityManagerFactory=} entityManagerFactory */ constructor(entityManagerFactory) { super(); /** * Defines if the Metamodel has been finalized * @type boolean */ this.isInitialized = false; /** * @type EntityManagerFactory */ this.entityManagerFactory = entityManagerFactory; /** * @type Object<string,metamodel.EntityType> */ this.entities = null; /** * @type Object<string,metamodel.EmbeddableType> */ this.embeddables = null; /** * @type Object<string,metamodel.BasicType> */ this.baseTypes = null; /** * @type {binding.Enhancer} */ this.enhancer = new Enhancer(); } /** * Prepare the Metamodel for custom schema creation * @param {Object=} jsonMetamodel initialize the metamodel with the serialized json schema * @return {void} */ init(jsonMetamodel) { if (this.isInitialized) { throw new Error('Metamodel is already initialized.'); } this.fromJSON(jsonMetamodel || []); this.isInitialized = true; } /** * @param {(Class<binding.Managed>|string)} arg * @return {string} */ getRef(arg) { let ref; if (Object(arg) instanceof String) { ref = arg; if (ref.indexOf('/db/') !== 0) { ref = '/db/' + arg; } } else { ref = Enhancer.getIdentifier(arg); } return ref; } /** * Return the metamodel entity type representing the entity. * * @param {(Class<binding.Entity>|string)} typeConstructor - the type of the represented entity * @return {metamodel.EntityType} the metamodel entity type */ entity(typeConstructor) { const ref = this.getRef(typeConstructor); return ref ? this.entities[ref] : null; } /** * Return the metamodel basic type representing the native class. * @param {(Class<*>|string)} typeConstructor - the type of the represented native class * @return {metamodel.BasicType} the metamodel basic type */ baseType(typeConstructor) { let ref = null; if (Object(typeConstructor) instanceof String) { ref = this.getRef(typeConstructor); } else { const baseTypesNames = Object.keys(this.baseTypes); for (let i = 0, len = baseTypesNames.length; i < len; i += 1) { const name = baseTypesNames[i]; const type = this.baseTypes[name]; if (!type.noResolving && type.typeConstructor === typeConstructor) { ref = name; break; } } } return ref ? this.baseTypes[ref] : null; } /** * Return the metamodel embeddable type representing the embeddable class. * @param {Class<binding.Managed>|string} typeConstructor - the type of the represented embeddable class * @return {metamodel.EmbeddableType} the metamodel embeddable type */ embeddable(typeConstructor) { const ref = this.getRef(typeConstructor); return ref ? this.embeddables[ref] : null; } /** * Return the metamodel managed type representing the entity, mapped superclass, or embeddable class. * * @param {(Class<binding.Managed>|string)} typeConstructor - the type of the represented managed class * @return {metamodel.Type} the metamodel managed type */ managedType(typeConstructor) { return this.baseType(typeConstructor) || this.entity(typeConstructor) || this.embeddable(typeConstructor); } /** * @param {metamodel.Type} type * @return {metamodel.Type} the added type */ addType(type) { let types; if (type.isBasic) { types = this.baseTypes; } else if (type.isEmbeddable) { type.init(this.enhancer); types = this.embeddables; } else if (type.isEntity) { type.init(this.enhancer); types = this.entities; if (type.superType === null && type.ref !== EntityType.Object.ref) { type.superType = this.entity(EntityType.Object.ref); } } if (types[type.ref]) { throw new Error('The type ' + type.ref + ' is already declared.'); } types[type.ref] = type; return type; } /** * Load all schema data from the server * @return {Promise<metamodel.Metamodel>} */ load() { if (!this.isInitialized) { return this.withLock(() => { const msg = new message.GetAllSchemas(); return this.entityManagerFactory.send(msg).then((response) => { this.init(response.entity); return this; }); }); } throw new Error('Metamodel is already initialized.'); } /** * Store all local schema data on the server, or the provided one * * Note: The schema must be initialized, by init or load * * @param {metamodel.ManagedType=} managedType The specific type to persist, if omitted the complete schema * will be updated * @return {Promise<metamodel.Metamodel>} */ save(managedType) { return this.sendUpdate(managedType || this.toJSON()).then(() => this); } /** * Update the metamodel with the schema * * The provided data object will be forwarded to the UpdateAllSchemas resource. * The underlying schema of this Metamodel object will be replaced by the result. * * @param {json} data The JSON which will be send to the UpdateAllSchemas resource. * @return {Promise<metamodel.Metamodel>} */ update(data) { return this.sendUpdate(data).then((response) => { this.fromJSON(response.entity); return this; }); } sendUpdate(data) { return this.withLock(() => { let msg; if (data instanceof ManagedType) { msg = new message.UpdateSchema(data.name, data.toJSON()); } else { msg = new message.UpdateAllSchemas(data); } return this.entityManagerFactory.send(msg); }); } /** * Get the current schema types as json * @return {json} the json data */ toJSON() { if (!this.isInitialized) { throw new Error('Metamodel is not initialized.'); } return [].concat( Object.keys(this.entities).map(ref => this.entities[ref].toJSON()), Object.keys(this.embeddables).map(ref => this.embeddables[ref].toJSON()) ); } /** * Replace the current schema by the provided one in json * @param {json} json The json schema data * @return {void} */ fromJSON(json) { const builder = new ModelBuilder(); const models = builder.buildModels(json); this.baseTypes = {}; this.embeddables = {}; this.entities = {}; Object.keys(models).forEach(ref => this.addType(models[ref])); } /** * Creates an index * * @param {string} bucket Name of the Bucket * @param {metamodel.DbIndex} index Will be applied for the given bucket * @return {Promise<*>} */ createIndex(bucket, index) { index.drop = false; const msg = new message.CreateDropIndex(bucket, index.toJSON()); return this.entityManagerFactory.send(msg); } /** * Drops an index * * @param {string} bucket Name of the Bucket * @param {metamodel.DbIndex} index Will be dropped for the given bucket * @return {Promise<*>} */ dropIndex(bucket, index) { index.drop = true; const msg = new message.CreateDropIndex(bucket, index.toJSON()); return this.entityManagerFactory.send(msg); } /** * Drops all indexes * * @param {string} bucket Indexes will be dropped for the given bucket * @return {Promise<*>} */ dropAllIndexes(bucket) { const msg = new message.DropAllIndexes(bucket); return this.entityManagerFactory.send(msg); } /** * Loads all indexes for the given bucket * * @param {string} bucket Current indexes will be loaded for the given bucket * @return {Promise<Array<metamodel.DbIndex>>} */ getIndexes(bucket) { const msg = new message.ListIndexes(bucket); return this.entityManagerFactory.send(msg) .then(response => response.entity.map(el => new DbIndex(el.keys, el.unique))) .catch((e) => { if (e.status === StatusCode.BUCKET_NOT_FOUND || e.status === StatusCode.OBJECT_NOT_FOUND) { return null; } throw e; }); } } deprecated(Metamodel.prototype, '_enhancer', 'enhancer'); deprecated(Metamodel.prototype, '_send', 'sendUpdate'); deprecated(Metamodel.prototype, '_getRef', 'getRef'); module.exports = Metamodel; </code></pre> </article> </section>  </div> </div> </div> </div> </div> <div id="footer" style="position:relative; z-index:1;"> <div class="container"> <div class="row"> <div class="col-xs-6 col-sm-3 sitemap"> <h4>Product</h4> <a href="https://www.baqend.com/platform.html">Platform</a> <a href="https://www.baqend.com/speedkit.html">Speed Kit</a> <a href="https://www.baqend.com/features.html">Features</a> <a href="https://www.baqend.com/pricing.html">Platform Pricing</a> <a href="https://www.baqend.com/pricing_speedkit.html">Speed Kit Pricing</a> <a href="https://www.baqend.com/agencies.html">Agencies</a> <a href="https://www.baqend.com/enterprise.html">Enterprise</a> <a href="https://www.baqend.com/features.html#download">Community Edition</a> <a href="https://www.baqend.com/support.html">Support</a> </div> <div class="col-xs-6 col-sm-3 sitemap"> <h4>Company</h4> <a href="https://www.baqend.com/about.html">About us</a> <a href="https://medium.baqend.com">Baqend Blog</a> <a href="https://www.baqend.com/hiring.html">Jobs</a> <a href="https://www.baqend.com/press.html">Press</a> <a href="https://thesis.app.baqend.com/">Bachelor/Master theses</a> <a href="https://www.weblabs.hamburg/">WebLabs.Hamburg</a> </div> <div class="col-xs-6 col-sm-3 sitemap"> <h4>Developer</h4> <a href="https://dashboard.baqend.com/login">Login</a> <a href="https://dashboard.baqend.com/register">Sign Up</a> <a href="https://www.baqend.com/guide">Developer Docs</a> <a href="https://www.baqend.com/guide/roadmap/">Roadmap</a> <a href="https://www.baqend.com/guide/starter-kits">Starter Kits</a> <a href="https://www.baqend.com/js-sdk/latest/baqend.html">JS SDK</a> <a href="https://stackoverflow.com/questions/tagged/baqend/">Stackoverflow</a> </div> <div class="col-xs-6 col-sm-3 contact"> <h4>Contact</h4> <p class="contact-information"> <span> Baqend GmbH<br /> Stresemannstr. 23<br /> 22769 Hamburg<br /> Germany </span> </p> <p class="contact-information"> Email: <a style="display: inline-block" href="mailto:support@baqend.com">support@baqend.com</a> </p> <p class="contact-information"> Tel: <a style="display: inline-block" href="tel:+494060940539">+49 40 60940539</a> </p> </div> </div> <div class="row"> <div class="col-md-12 text-center social"> <a href="https://twitter.com/baqendcom"><i class="fa fa-twitter fa-fw"></i></a> <a href="https://github.com/Baqend"><i class="fa fa-github fa-fw"></i></a> <a href="https://medium.baqend.com/"><i class="fa fa-medium fa-fw"></i></a> <a href="https://www.facebook.com/baqend"><i class="fa fa-facebook fa-fw"></i></a> <a href="https://www.youtube.com/channel/UCsImg6Ts8UEp6-7LE9CP2-Q"><i class="fa fa-youtube fa-fw"></i></a> </div> </div> </div> <footer> <div class="container"> <div class="legal text-center"> <div> <strong>Baqend JavaScript SDK 2.14.1</strong><br> &copy 2019 Baqend GmbH<br> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun, 06 Jan 2019 05:00:21 GMT </div> <a href="mailto:info@baqend.com">Contact</a> - <a href="https://dashboard.baqend.com/privacy">Privacy Policy</a> - <a href="https://dashboard.baqend.com/terms">Terms of Service</a> - <a href="https://dashboard.baqend.com/imprint">Imprint</a> </div> </div> </footer> </div> <script> prettyPrint(); </script> <script src="https://code.jquery.com/jquery-1.12.1.min.js"></script> <script src="scripts/bootstrap.min.js"> </script> <script src="scripts/linenumber.js"> </script> <script src="scripts/filter.js"> </script> <script data-main="scripts/search.js" src="scripts/require.js"></script> </body> </html>