Initializing a Data Model

Using the CLI

To create a new Data Model in your Moose application, use the data-model init command. This will generate a file in the /datamodels directory of your Moose application and define your Data Model within it.

npx moose-cli data-model init --sample <PATH_TO_SAMPLE_DATA> <DATA_MODEL_NAME>

moose-cli data-model init --sample <PATH_TO_SAMPLE_DATA> <DATA_MODEL_NAME>

• <PATH_TO_SAMPLE_DATA>: The path to the sample data file.
• <DATA_MODEL_NAME>: The name of the Data Model.

Creating a new Data Model Manually

There are two additional ways to initialize a new Data Model in your Moose project:

• By creating a new .ts .py file in the /datamodels directory of your Moose application and defining a new Data Model inside this file.
• By appending a new Data Model to an existing .ts .py file in your /datamodels directory.

import { Key } from "moose-lib";
 
export interface MyNewDataModel {
  primaryKey: Key<string>;
  someString: string;
  someNumber: number;
  someBoolean: boolean;
  someDate: Date;
  someArray: string[];
  ...
}

from moose_lib import Key, moose_data_model
from dataclasses import dataclass
 
@moose_data_model
@dataclass
class NewDataModel:
    primary_key: Key[str]
    some_string: str
    some_number: int
    some_boolean: bool
    some_list: list[str]