@trifinlabs/ramp-api

ramp-api

• Usage
• Commands

Usage

$ npm install -g @trifinlabs/ramp-api
$ @trifinlabs/ramp-api COMMAND
running command...
$ @trifinlabs/ramp-api (-v|--version|version)
@trifinlabs/ramp-api/2.13.4 linux-x64 node-v10.4.1
$ @trifinlabs/ramp-api --help [COMMAND]
USAGE
  $ @trifinlabs/ramp-api COMMAND
...

Commands

• @trifinlabs/ramp-api discover [MODEL]
• @trifinlabs/ramp-api help [COMMAND]
• @trifinlabs/ramp-api migrate MODEL
• @trifinlabs/ramp-api server
• @trifinlabs/ramp-api update [MODEL]
• @trifinlabs/ramp-api worker SCRIPT

@trifinlabs/ramp-api discover [MODEL]

Discover database schema to create model definition

USAGE
  $ @trifinlabs/ramp-api discover [MODEL]

ARGUMENTS
  MODEL  Name of a single model/table/collection to create (if not all models)

OPTIONS
  -a, --allNewModels           Discover and create all models not in modelDir
  -a, --allOwners              Include All Owners
  -d, --dataSource=dataSource  [default: herokuPostgres] Data source name
  -o, --owner=owner            [default: salesforce] Name of owner/schema/database for the models
  -r, --[no-]relations         Include relations

  -s, --skip=skip              [default: TriggerLastId,Hcmeta,SfEventLog,TriggerLog,TriggerLastId,TriggerLogArchive]
                               Comma separate model names to skip when discovering new models

  -v, --[no-]views             Include views

  --modelConfig=modelConfig    [default: model-config.json] Path to model-config.json (relative to CWD)

  --modelDir=modelDir          [default: models] Path to models folder (relative to CWD)

@trifinlabs/ramp-api help [COMMAND]

display help for @trifinlabs/ramp-api

USAGE
  $ @trifinlabs/ramp-api help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

@trifinlabs/ramp-api migrate MODEL

Migrate model schema to match model definition

USAGE
  $ @trifinlabs/ramp-api migrate MODEL

ARGUMENTS
  MODEL  Model to migrate

OPTIONS
  -d, --dataSource=dataSource  [default: herokuPostgres]
  -m, --models=models          Comma separate model names update
  -y, --yes                    Skip confirmation prompt

@trifinlabs/ramp-api server

Run http server

USAGE
  $ @trifinlabs/ramp-api server

@trifinlabs/ramp-api update [MODEL]

Update model schema to match model definition

USAGE
  $ @trifinlabs/ramp-api update [MODEL]

ARGUMENTS
  MODEL  Model to update

OPTIONS
  -d, --dataSource=dataSource  [default: herokuPostgres]
  -m, --models=models          Comma separate model names update

@trifinlabs/ramp-api worker SCRIPT

Run nodejs script

USAGE
  $ @trifinlabs/ramp-api worker SCRIPT

ARGUMENTS
  SCRIPT  Script to run

OPTIONS
  -r, --range=range  Repeat range in cron format