dataflow Commands

Manage Analytics dataflows and dataflow jobs.

• analytics dataflow history list

  Lists history records for Analytics dataflows in the specified target org.

• analytics dataflow history revert

  Revert to a specified history record.

• analytics dataflow job display

  Display the status of an Analytics dataflow job.

• analytics dataflow job list

  Lists jobs for an Analytics dataflow.

• analytics dataflow job stop

  Stops an Analytics dataflow job.

• analytics dataflow list

  Lists Analytics dataflows in the specified target org.

• analytics dataflow start

  Starts an Analytics dataflow.

• analytics dataflow update

  Update an Analytics dataflow.

Lists history records for Analytics dataflows in the specified target org.

sf analytics dataflow history list

[--json]

[--api-version APIVERSION]

-o TARGETORG

-i DATAFLOWID

--json

Optional

Format output as JSON.

Type: boolean

--api-version APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-o TARGETORG

Required

Username or alias of the target org. Not required if the target-org configuration variable is set.

Type: string

-i | --dataflowid DATAFLOWID

Required

The ID of the dataflow to show history records.

Type: id

Revert to a specified history record.

sf analytics dataflow history revert

[--json]

[--api-version APIVERSION]

-o TARGETORG

-i DATAFLOWID

-y HISTORYID

[-l LABEL]

--json

Optional

Format output as JSON.

Type: boolean

--api-version APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-o TARGETORG

Required

Username or alias of the target org. Not required if the target-org configuration variable is set.

Type: string

-i | --dataflowid DATAFLOWID

Required

The ID of the dataflow to show history records.

Type: id

-y | --historyid HISTORYID

Required

The ID of the dataflow history record.

Type: id

-l | --label LABEL

Optional

Label for new reverted history record.

Type: string

Display the status of an Analytics dataflow job.

sf analytics dataflow job display

[--json]

[--api-version APIVERSION]

-o TARGETORG

[-i DATAFFLOWJOBID]

--json

Optional

Format output as JSON.

Type: boolean

--api-version APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-o TARGETORG

Required

Username or alias of the target org. Not required if the target-org configuration variable is set.

Type: string

-i | --dataflowjobid DATAFLOWJOBID

Required

ID of the dataflow job to display.

Type: id

Lists jobs for an Analytics dataflow.

sf analytics dataflow job list

[--json]

[--api-version APIVERSION]

-o TARGETORG

[-i DATAFFLOWID]

--json

Optional

Format output as JSON.

Type: boolean

--api-version APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-o TARGETORG

Required

Username or alias of the target org. Not required if the target-org configuration variable is set.

Type: string

-i | --dataflowid DATAFLOWID

Required

ID of the dataflow to list the jobs for.

Type: id

Stops an Analytics dataflow job.

sf analytics dataflow job stop

[--json]

[--api-version APIVERSION]

-o TARGETORG

[-i DATAFFLOWJOBID]

--json

Optional

Format output as JSON.

Type: boolean

--api-version APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-o TARGETORG

Required

Username or alias of the target org. Not required if the target-org configuration variable is set.

Type: string

-i | --dataflowjobid DATAFLOWJOBID

Required

ID of the dataflow job to stop.

Type: id

Lists Analytics dataflows in the specified target org.

sf analytics dataflow list

[--json]

[--api-version APIVERSION]

-o TARGETORG

--json

Optional

Format output as JSON.

Type: boolean

--api-version APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-o TARGETORG

Required

Username or alias of the target org. Not required if the target-org configuration variable is set.

Type: string

Starts an Analytics dataflow.

sf analytics dataflow start

[--json]

[--api-version APIVERSION]

-o TARGETORG

[-i DATAFFLOWID]

--json

Optional

Format output as JSON.

Type: boolean

--api-version APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-o TARGETORG

Required

Username or alias of the target org. Not required if the target-org configuration variable is set.

Type: string

-i | --dataflowid DATAFLOWID

Required

ID of the dataflow to start.

Type: id

Update an Analytics dataflow.

sf analytics dataflow update

[--json]

[--api-version APIVERSION]

-o TARGETORG

[-i DATAFFLOWID]

[-f DATAFFLOWFILE]

[-s DATAFFLOWSTR]

--json

Optional

Format output as JSON.

Type: boolean

--api-version APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-o TARGETORG

Required

Username or alias of the target org. Not required if the target-org configuration variable is set.

Type: string

-i | --dataflowid DATAFLOWID

Required

ID of the dataflow to start.

Type: id

-f | --dataflowfile DATAFLOWFILE

Optional

The dataflow JSON file to update the dataflow with.

Type: filepath

-s | --dataflowstr DATAFLOWSTR

Optional

The dataflow JSON string to update the dataflow with.

Type: string