MySQL Model Service

MySQL backing for the travetto model module, with real-time modeling support for SQL schemas.

Install: @travetto/model-mysql

1npm install @travetto/model-mysql
2
3# or
4
5yarn add @travetto/model-mysql

This module provides a MySQL-based implementation for the Data Modeling Support module. This source allows the Data Modeling Support module to read, write and query against SQL databases. In development mode, the SQLModelService will also modify the database schema in real time to minimize impact to development.

The schema generated will not generally map to existing tables as it is attempting to produce a document store like experience on top of a SQL database. Every table generated will have a path_id which determines it's location in the document hierarchy as well as sub tables will have a parent_path_id to associate records with the parent values.

Supported features:

• CRUD
• Bulk
• 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

1import { AsyncContext } from '@travetto/context';
2import { InjectableFactory } from '@travetto/di';
3
4import { SQLModelService, SQLModelConfig } from '@travetto/model-sql';
5import { MySQLDialect } from '@travetto/model-mysql';
6
7export class Init {
8  @InjectableFactory({ primary: true })
9  static getModelService(ctx: AsyncContext, conf: SQLModelConfig) {
10    return new SQLModelService(ctx, conf, new MySQLDialect(ctx, conf));
11  }
12}

where the SQLModelConfig is defined by:

Code: Structure of SQLModelConfig

1@Config('model.sql')
2export class SQLModelConfig<T extends {} = {}> {
3  /**
4   * Host to connect to
5   */
6  host = '127.0.0.1';
7  /**
8   * Default port
9   */
10  port = 0;
11  /**
12   * Username
13   */
14  user = '';
15  /**
16   * Password
17   */
18  password = '';
19  /**
20   * Table prefix
21   */
22  namespace = '';
23  /**
24   * Database name
25   */
26  database = 'app';
27  /**
28   * Auto schema creation
29   */
30  autoCreate?: boolean;
31  /**
32   * Db version
33   */
34  version = '';
35  /**
36   * Raw client options
37   */
38  options: T = asFull({});
39}

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.