Omni Loader Docs
  • OVERVIEW
    • About
    • Getting Started
    • Databases
    • Performance considerations
    • Prerequisites
  • Project Wizard
    • General
    • Database List
    • Favorites
    • Review
  • Project types
    • Full Table Copy
    • Data Compare & Sync
    • Change Data Capture
    • Overview
  • Project Options
    • General
    • Performance
    • Databases
    • Mapping
    • Logging
    • Troubleshooting
  • Table Options
    • Columns
    • WHERE clause
    • Partitioning
    • Cut-off
    • Options Override
  • Global Settings
    • Overview
  • Automations
    • Overview
    • JSON job specification
  • Connections
    • Amazon RedShift
    • Analytics Platform System
    • Synapse Dedicated Pool
    • CockroachDB
    • CSV
    • Databricks
    • DB2 iSeries
    • DB2 LUW
    • DB2 zOS
    • Greenplum
    • Google AlloyDB
    • Google BigQuery
    • MariaDB
    • MySQL
    • Netezza
    • NuoDB
    • ODBC
    • Oracle
    • Parquet
    • PostgreSQL
    • Snowflake
    • Sybase ASE
    • Sybase IQ
    • SQL Server
    • Teradata
    • Vertica ODBC
    • Fabric Lakehouse
    • Fabric Warehouse
    • Azure SQL Database
    • V-ORDER Fabric Lakehouse Optimization
Powered by GitBook
On this page
  • Omni Loader console arguments
  • Agent console arguments
  1. Automations

Overview

PreviousOverviewNextJSON job specification

Last updated 8 months ago

Omni Loader can be invoked as a console application to execute a job and return. This is very useful for automated migrations and migrations as part of CI/CD workflows.

Omni Loader console arguments

--job {path-to-json-file}

OmniLoader.exe --job c:\jobs\sql2synapse.json

‍--cluster

Run Omni Loader in a distributed cluster mode. Omni Loader becomes a cluster orchestrator and awaits for agents to connect to it.

--urls {http(s)://ip-range:port}

Listen for incoming connections. A typical example would be:

OmniLoader.exe --urls http://0.0.0.0:5000

‍--listen-at {http(s)://ip:port}

In cluster mode, this is a public orchestrator IP:port combination that will be sent to agents when they connect. Agents will send data to the API on specified port.

OmniLoader.exe --cluster --urls http://0.0.0.0:5000 --listen-at http://192.168.1.100:5000

‍--activate {activation code}

In console mode and CI/CD workflows, you can activate Omni Loader even without firing up the GUI.

OmniLoader.exe --job c:\jobs\sql2synapse.json --activate 12345-6789-0000

Agent console arguments

--connectivity {source|target|both}

Locality information for specific agent, defaults to "both". In a cluster, we can have certain agents close to source databases (typically, on premises), and other agents close to the target database (typically, on the cloud).

--primary

For hashed replication, a single source agent should be marked as primary. This agent caches hashes for the source databases and determines delta to be pushed over the wire to the target.

--urls {http(s)://ip-range:port}

Listen for incoming connections, used to receive hashes from other source agents. Only needed for a primary source agent. A typical example would be:

OmniLoader.Agent.exe --primary --connectivity source --urls http://0.0.0.0:5000 --listen-at http://192.168.1.101:5000

‍--listen-at {http(s)://ip:port}

In cluster mode, this is a public agent IP:port combination that will be sent to all agents as they connect. Only needed for a primary source agent. Agents will send source hashing data to the API on specified port.

‍OmniLoader.Agent.exe --primary --connectivity source --urls http://0.0.0.0:5000 --listen-at http://192.168.1.101:5000

‍--name {name}

User-friendly agent name to display in the orchestrator GUI

{http(s)://ip:port}

Orchestrator public IP:port. An example:‍

OmniLoader.Agent.exe http://192.168.1.100:5000

A to use. A typical example would be:

JSON job specification