appservices schema datamodels
On this page
Atlas Device Sync, Atlas Edge Server, Data API, and HTTPS Endpoints are deprecated. Refer to the deprecation page for details.
Atlas Device Sync, Atlas Edge Server, Data API, HTTPS Endpoints, GraphQL, and Static Hosting are deprecated. Commands related to these features are also deprecated.
Generate data models based on your Schema (alias: datamodel)
Translates your Schema’s objects into App Services data models. The data models define your data as native objects, which can be easily integrated into your own repo to use with Device Sync.
NOTE: You must have a valid JSON Schema before using this command.
- With this command, you can:
Specify the language with a "--language" flag
Filter which Schema objects you’d like to include in your output with "--name" flags
Combine your Schema objects into a single output with a "--flat" flag
Omit import groups from your model with a "--no-imports" flag
Syntax
Command Syntax
appservices schema datamodels [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
-a, --app | string | false | Specify the name or ID of an App Service to generate its data models |
--project | string | false | Specify the ID of a MongoDB Atlas project |
-l, --language | string | false | Specify the language to generate schema data models in (Default value: <none>) |
--flat | false | View generated data models (and associated imports) as a single code block | |
--no-imports | false | View generated data models without imports | |
--name | strings | false | Filter generated data models by name(s) |
-h, --help | false | help for datamodels |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
--profile | string | false | Specify your profile (Default value: "default") [Learn more] |
--telemetry | string | false | Enable/Disable CLI usage tracking for your current profile (Default value: "on"; Allowed values: "on", "off") |
-o, --output-target | string | false | Write CLI output to the specified filepath |
-f, --output-format | string | false | Set the CLI output format (Default value: <blank>; Allowed values: <blank>, "json") |
--disable-colors | false | Disable all CLI output styling (e.g. colors, font styles, etc.) | |
-y, --yes | false | Automatically proceed through CLI commands by agreeing to any required user prompts |