realm-migrator-cli

Data migration tool for synced realms.

Grab your exported files from realm studio and import them into a fresh synced realm.

Caveats:

• Cicular relations are not supported
• Relations to objects with no primary key will try to reuse existing object but may create duplicates
• No tests yet I'm lazy 😁

• Usage
• Commands

Usage

$ npm install -g realm-migrator-cli
$ realm-migrator-cli COMMAND
running command...
$ realm-migrator-cli (-v|--version|version)
realm-migrator-cli/0.0.3 darwin-x64 node-v8.16.2
$ realm-migrator-cli --help [COMMAND]
USAGE
  $ realm-migrator-cli COMMAND
...

Commands

• realm-migrator-cli export [SCHEMA]
• realm-migrator-cli help [COMMAND]
• realm-migrator-cli import SCHEMA JSONFILE

realm-migrator-cli export [SCHEMA]

Export data to json format

USAGE
  $ realm-migrator-cli export [SCHEMA]

OPTIONS
  -c, --collections=collections  [default: *] comma separated list of Collections i.e: Dog,Person
  -h, --help                     show CLI help
  -o, --output=output            output file
  -p, --password=password        (required) password
  -q, --query=query              query to export supported form -> "class" where "filter"
  -r, --realmPath=realmPath      (required) source realm
  -s, --serverUrl=serverUrl      (required) realm object server url w/o protocol (test.us1a.cloud.realm.io)
  -u, --username=username        (required) realm user name

See code: src/commands/export.ts

realm-migrator-cli help [COMMAND]

display help for realm-migrator-cli

USAGE
  $ realm-migrator-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

realm-migrator-cli import SCHEMA JSONFILE

Import data into a synced realm

USAGE
  $ realm-migrator-cli import SCHEMA JSONFILE

OPTIONS
  -c, --clean                              delete realm files after
  -d, --duplicateRelations                 create duplicate objects for relations with no primary
  -h, --help                               show CLI help
  -p, --password=password                  (required) password
  -r, --realmPath=realmPath                (required) realm destination path (/path)
  -s, --serverUrl=serverUrl                (required) realm object server url w/o protocol (test.us1a.cloud.realm.io)

  -t, --transactionMode=(single|multiple)  [default: multiple] transaction mode single (import everything under 1
                                           transaction) multiple (make 1 transaction per entity)

  -u, --username=username                  (required) realm user name

See code: src/commands/import.ts