Package Exports

@travetto/model-elasticsearch

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@travetto/model-elasticsearch) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Elasticsearch Model Source

Elasticsearch backing for the travetto model module, with real-time modeling support for Elasticsearch mappings.

Install: @travetto/model-elasticsearch

npm install @travetto/model-elasticsearch

This module provides an elasticsearch-based implementation of ModelSource for the Data Modeling. This source allows the Data Modeling module to read, write and query against elasticsearch. In development mode, the ModelSource will also modify the elasticsearch schema in real time to minimize impact to development.

Out of the box, by installing the module, everything should be wired up by default. If you need to customize any aspect of the source or config, you can override and register it with the Dependency Injection module.

Code: Wiring up a custom Model Source

import { InjectableFactory } from '@travetto/di';
import { ElasticsearchModelConfig } from '@travetto/model-elasticsearch/src/config';
import { ElasticsearchModelSource } from '@travetto/model-elasticsearch/src/source';

export class Init {
  @InjectableFactory({
    primary: true
  })
  static getModelSource(conf: ElasticsearchModelConfig) {
    return new ElasticsearchModelSource(conf);
  }
}

where the ElasticsearchModelConfig is defined by:

Code: Structure of ElasticsearchModelConfig

import { EnvUtil } from '@travetto/boot';
import { Config } from '@travetto/config';
import { EsSchemaConfig } from './internal/types';

/**
 * Elasticsearch model config
 */
@Config('elasticsearch.model')
export class ElasticsearchModelConfig {
  /**
   * List of hosts to support
   */
  hosts = ['127.0.0.1'];
  /**
   * Port to listen on
   */
  port = 9200;
  /**
   * Raw elasticsearch options
   */
  options = {};
  /**
   * Index prefix
   */
  namespace = 'app';
  /**
   * Auto-create, disabled in prod by default
   */
  autoCreate = !EnvUtil.isReadonly();
  /**
   * Base schema config for elasticsearch
   */
  schemaConfig: EsSchemaConfig = {
    caseSensitive: false
  };

  /**
   * Base index create settings
   */
  indexCreate = {
    ['number_of_replicas']: 0,
    ['number_of_shards']: 1
  };

  /**
   * Build final hosts
   */
  postConstruct() {
    console.debug('Constructed', this);
    this.hosts = this.hosts
      .map(x => x.includes(':') ? x : `${x}:${this.port}`)
      .map(x => x.startsWith('http') ? x : `http://${x}`);
  }
}

and can be overridden via environment variables or config files, as defined in Configuration.

CLI - model:es-schema

The module provides the ability to generate the full elasticsearch schema from all the various @Models within the application. This is useful for being able to generate the appropriate JSON files to define your schemas in production.

Terminal: Running schema generate

$ travetto travetto model:es-schema --help

Usage:  model:es-schema [options]

Options:
  -a, --app [app]  Application to export, (default: .)
  -h, --help       display help for command