On this page

    Export Profiles

    The Dremio administration export-profiles command allows you to export Job profiles to the specified location.

    The export-profiles option supports 3 modes:

    • Default (requires dremio to be running)
    • Local-attach (requires dremio to be running)
    • Offline (dremio should not be running)

    Syntax

    Syntax for export-profiles command
    ./dremio-admin export-profiles --output <options>
    

    Options

    Parameter Description
    -h, –help Shows usage.
    –output (Required) Path to generate profile chunks. Example: /tmp/profiles/
    –write-mode Specifies how we should handle a case, when target file already exists. Valid values are [FAIL_IF_EXISTS (default), OVERWRITE and SKIP.
    –from Export profiles beginning from this date inclusively (job_end_time >= toDate). Example: 2011-12-03T10:15:30
    –to Export profiles ending by this date exclusively (job_end_time < toDate). Example: 2011-12-03T10:15:30
    -u, –user Username (administrator). Is required for online mode [–online].
    -p, –password Password. Required for online mode [–online].
    -a, –accept-all Accept all ssl certificates. Default value is false.
    –size Chunk size for each zip file. hidden = true
    –local-path Default local path to export. hidden = true
    –format Format in which profiles should be exported. .json and .zip (default) are supported.
    -l, –local-attach Attach locally to Dremio JVM to authenticate user. Not compatible with user/password options. Default value is false.
    -o, –offline Append this option to use offline export. Default value is false.

    Examples

    The following examples show default, local-attach, and offline mode usage.

    Default mode

    The default mode requires the following:

    • Dremio is running
    • user & password are required. If not provided in cli, will be prompted.
    Export profiles in default mode
    ./dremio-admin export-profiles --output /tmp/profiles -u user -p password
    

    output message
    The output message is available on console. If no jobs are processed, then the output path is not provided.

    The following output shows 50 jobs processed and the output path:

    Export profiles command output example for 50 jobs
    Export completed. Jobs processed: 50, profiles processed: 34, profiles skipped: 0
    Output path: /tmp/profiles/14581e7c-0302-474e-aaef-5667051e345b
    

    The following output shows 0 jobs process:

    Export profiles command output example for 0 jobs
    Export completed. Jobs processed: 0, profiles processed: 0, profiles skipped: 0
    

    Local-attach mode

    The local-attach mode requires the following:

    • Dremio is running. (the user & password are not required)
    • The -l or --local-attach option is required.
    • The command should be run by the same local user who started the Dremio cluster.
    Local-attach mode command
    ./dremio-admin export-profiles --output ~/tmp/profiles -l
    

    output message
    The output message is available in server.out since in local attach mode we attach to main process.

    Offline mode

    The offline mode requires the following:

    • Dremio is not running (the user & password are not required)
    • The -o or --offline option is required
    Offline mode command
    ./dremio-admin export-profiles --output ~/temp/profiles -o
    

    output message
    The output message is available on console.