@travetto/model-elasticsearch

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

# or

yarn add @travetto/model-elasticsearch

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

Supported features:

• CRUD
• Bulk
• Expiry
• Indexed
• Query Crud
• Facet
• Query
• Suggest

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, ElasticsearchModelService } from '@travetto/model-elasticsearch';

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

where the ElasticsearchModelConfig is defined by:

Code: Structure of ElasticsearchModelConfig

@Config('model.elasticsearch')
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?: boolean;
  /**
   * Should we store the id as a string in the document
   */
  storeId?: boolean;

  /**
   * Base schema config for elasticsearch
   */
  @Field(Object)
  schemaConfig: EsSchemaConfig = {
    caseSensitive: false
  };

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

  /**
   * Frequency of culling for cullable content
   */
  cullRate?: number | TimeSpan;

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

Additionally, you can see that the class is registered with the @Config annotation, and so these values can be overridden using the standard Configuration resolution paths.