Skip to main content
The ingest-file command uploads a local file and submits a new data ingestion request.
nx1 ingest-file \
  --file <filename> \
  --schema <schema_name> \
  --table <table_name> \
  • --cast string optional: Converts a column to a different data type during ingestion COLUMN:TYPE.
  • --delimiter string optional: Character used to separate fields in the input file. Default: ,.
  • --domain string optional: DataHub logical category used to organize the ingestion job.
  • --encrypt string optional: Name of the column to encrypt.
  • --file string required: Path to a local file you want to upload and ingest.
  • --header boolean optional: Indicates whether the file contains a header row.
  • --max-wait integer optional: Maximum number of seconds to wait for job completion. Default: 300.
  • --merge-keys string optional: Comma-separated columns used to match and merge data when the mode is merge.
  • --mode string optional: How to write data to the table. Values: append, overwrite, or merge.
  • --name string optional: Name of the Airflow ingestion job.
  • --no-wait boolean optional: If set, the command exits immediately without waiting for the job to complete.
  • --rename string optional: Change a column name during ingestion using OLD:NEW.
  • --schema string required: Target schema name for the data.
  • --table string required: Target table name for the data.
  • --tags string optional: Comma-separated DataHub tags.
  • --api-key string optional: API key or the NX1_API_KEY variable.
  • --config-file string optional: YAML config file.
  • --help -h optional: Shows help messages and exit.
  • --host string optional: API host.
  • --no-verify-ssl optional: Disables SSL verification.
  • --output -o optional: Output format. Allowed values: json, yaml, or table.
  • --profile -p string optional: Profile name from ~/.nx1/profiles.
  • --timeout integer optional: Requests when to timeout. Default is 30.
  • --verbose -v optional: Verbose output.